Implement emote support (#4523)

src/event/player/PlayerEmoteEvent.php

@@ -0,0 +1,51 @@
+<?php
+
+/*
+ *
+ *  ____            _        _   __  __ _                  __  __ ____
+ * |  _ \ ___   ___| | _____| |_|  \/  (_)_ __   ___      |  \/  |  _ \
+ * | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
+ * |  __/ (_) | (__|   <  __/ |_| |  | | | | | |  __/_____| |  | |  __/
+ * |_|   \___/ \___|_|\_\___|\__|_|  |_|_|_| |_|\___|     |_|  |_|_|
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * @author PocketMine Team
+ * @link http://www.pocketmine.net/
+ *
+ *
+*/
+
+declare(strict_types=1);
+
+namespace pocketmine\event\player;
+
+use pocketmine\event\Cancellable;
+use pocketmine\event\CancellableTrait;
+use pocketmine\player\Player;
+
+/**
+ * Called when a player uses an emote.
+ */
+class PlayerEmoteEvent extends PlayerEvent implements Cancellable{
+	use CancellableTrait;
+
+	public function __construct(
+		Player $player,
+		private string $emoteId
+	){
+		$this->player = $player;
+	}
+
+	public function getEmoteId() : string{
+		return $this->emoteId;
+	}
+
+	public function setEmoteId(string $emoteId) : void{
+		$this->emoteId = $emoteId;
+	}
+
+}

src/network/mcpe/NetworkSession.php

@@ -62,6 +62,7 @@ use pocketmine\network\mcpe\protocol\AvailableCommandsPacket;
 use pocketmine\network\mcpe\protocol\ChunkRadiusUpdatedPacket;
 use pocketmine\network\mcpe\protocol\ClientboundPacket;
 use pocketmine\network\mcpe\protocol\DisconnectPacket;
+use pocketmine\network\mcpe\protocol\EmotePacket;
 use pocketmine\network\mcpe\protocol\MobArmorEquipmentPacket;
 use pocketmine\network\mcpe\protocol\MobEffectPacket;
 use pocketmine\network\mcpe\protocol\MobEquipmentPacket;
@@ -1043,6 +1044,10 @@ class NetworkSession{
 		$this->sendDataPacket(SetTitlePacket::setAnimationTimes($fadeIn, $stay, $fadeOut));
 	}
 
+	public function onEmote(Player $from, string $emoteId) : void{
+		$this->sendDataPacket(EmotePacket::create($from->getId(), $emoteId, EmotePacket::FLAG_SERVER));
+	}
+
 	public function tick() : void{
 		if($this->info === null){
 			if(time() >= $this->connectTime + 10){

src/network/mcpe/handler/InGamePacketHandler.php

@@ -59,6 +59,7 @@ use pocketmine\network\mcpe\protocol\CommandRequestPacket;
 use pocketmine\network\mcpe\protocol\ContainerClosePacket;
 use pocketmine\network\mcpe\protocol\ContainerOpenPacket;
 use pocketmine\network\mcpe\protocol\CraftingEventPacket;
+use pocketmine\network\mcpe\protocol\EmotePacket;
 use pocketmine\network\mcpe\protocol\InteractPacket;
 use pocketmine\network\mcpe\protocol\InventoryTransactionPacket;
 use pocketmine\network\mcpe\protocol\ItemFrameDropItemPacket;
@@ -890,4 +891,9 @@ class InGamePacketHandler extends PacketHandler{
 		 */
 		return true;
 	}
+
+	public function handleEmote(EmotePacket $packet) : bool{
+		$this->player->emote($packet->getEmoteId());
+		return true;
+	}
 }

src/player/Player.php

@@ -53,6 +53,7 @@ use pocketmine\event\player\PlayerChatEvent;
 use pocketmine\event\player\PlayerCommandPreprocessEvent;
 use pocketmine\event\player\PlayerDeathEvent;
 use pocketmine\event\player\PlayerDisplayNameChangeEvent;
+use pocketmine\event\player\PlayerEmoteEvent;
 use pocketmine\event\player\PlayerEntityInteractEvent;
 use pocketmine\event\player\PlayerExhaustEvent;
 use pocketmine\event\player\PlayerGameModeChangeEvent;
@@ -234,6 +235,8 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
 	/** @var int[] ID => ticks map */
 	protected array $usedItemsCooldown = [];
 
+	private int $lastEmoteTick = 0;
+
 	protected int $formIdCounter = 0;
 	/** @var Form[] */
 	protected array $forms = [];
@@ -1727,6 +1730,17 @@ class Player extends Human implements CommandSender, ChunkListener, IPlayer{
 		return true;
 	}
 
+	public function emote(string $emoteId) : void{
+		$event = new PlayerEmoteEvent($this, $emoteId);
+		$event->call();
+		if(!$event->isCancelled() && $this->getServer()->getTick() - $this->lastEmoteTick > 5){
+			$this->lastEmoteTick = $this->getServer()->getTick();
+			foreach($this->getViewers() as $player){
+				$player->getNetworkSession()->onEmote($this, $emoteId);
+			}
+		}
+	}
+
 	/**
 	 * Drops an item on the ground in front of the player.
 	 */