Added entity middle-click feature

src/entity/Entity.php

@@ -35,6 +35,8 @@
 use pocketmine\event\entity\EntityRegainHealthEvent;
 use pocketmine\event\entity\EntitySpawnEvent;
 use pocketmine\event\entity\EntityTeleportEvent;
+use pocketmine\item\Item;
+use pocketmine\item\VanillaItems;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
 use pocketmine\math\Vector2;
@@ -497,6 +499,12 @@ public function saveNBT() : CompoundTag{
 		return $nbt;
 	}
 
+	public function getCleanedNBT() : CompoundTag{
+		$nbt = $this->saveNBT();
+		$nbt->removeTag("identifier", "Pos", "Motion", "Rotation", "FallDistance", "OnGround");
+		return $nbt;
+	}
+
 	protected function initEntity(CompoundTag $nbt) : void{
 		$this->fireTicks = $nbt->getShort("Fire", 0);
 
@@ -516,6 +524,18 @@ protected function initEntity(CompoundTag $nbt) : void{
 		}
 	}
 
+	/**
+	 * @internal
+	 */
+	public function copyDataFromItem(Item $item) : void{
+		if(($entityNbt = $item->getCustomEntityData()) !== null){
+			$this->initEntity($entityNbt);
+		}
+		if($item->hasCustomName()){ //this should take precedence over saved NBT
+			$this->setNameTag($item->getCustomName());
+		}
+	}
+
 	protected function addAttributes() : void{
 
 	}
@@ -1535,6 +1555,26 @@ public function despawnFromAll() : void{
 		}
 	}
 
+	/**
+	 * Returns the item that can be used to spawn this entity, by default it returns air if there isn't one
+	 */
+	public function getSpawnItem() : Item{
+		return VanillaItems::AIR();
+	}
+
+	/**
+	 * Returns the item that players will equip when middle-clicking on this entity.
+	 * If addUserData is true, additional data may be added, such as name tag, fire ticks, etc.
+	 */
+	public function getPickedItem(bool $addUserData) : Item{
+		$item = $this->getSpawnItem();
+		if($addUserData){
+			$item->setCustomEntityData($this->getCleanedNBT());
+			$item->setLore(["+(DATA)"]);
+		}
+		return $item;
+	}
+
 	/**
 	 * Flags the entity to be removed from the world on the next tick.
 	 */

src/entity/Squid.php

@@ -26,6 +26,7 @@
 use pocketmine\entity\animation\SquidInkCloudAnimation;
 use pocketmine\event\entity\EntityDamageByEntityEvent;
 use pocketmine\event\entity\EntityDamageEvent;
+use pocketmine\item\Item;
 use pocketmine\item\VanillaItems;
 use pocketmine\math\Vector3;
 use pocketmine\nbt\tag\CompoundTag;
@@ -126,4 +127,8 @@ public function getDrops() : array{
 			VanillaItems::INK_SAC()->setCount(mt_rand(1, 3))
 		];
 	}
+
+	public function getSpawnItem() : Item{
+		return VanillaItems::SQUID_SPAWN_EGG();
+	}
 }

src/entity/Villager.php

@@ -23,6 +23,8 @@
 
 namespace pocketmine\entity;
 
+use pocketmine\item\Item;
+use pocketmine\item\VanillaItems;
 use pocketmine\nbt\tag\CompoundTag;
 use pocketmine\network\mcpe\protocol\types\entity\EntityIds;
 use pocketmine\network\mcpe\protocol\types\entity\EntityMetadataCollection;
@@ -85,6 +87,10 @@ public function isBaby() : bool{
 		return $this->baby;
 	}
 
+	public function getSpawnItem() : Item{
+		return VanillaItems::VILLAGER_SPAWN_EGG();
+	}
+
 	protected function syncNetworkData(EntityMetadataCollection $properties) : void{
 		parent::syncNetworkData($properties);
 		$properties->setGenericFlag(EntityMetadataFlags::BABY, $this->baby);

src/entity/Zombie.php

@@ -23,6 +23,7 @@
 
 namespace pocketmine\entity;
 
+use pocketmine\item\Item;
 use pocketmine\item\VanillaItems;
 use pocketmine\network\mcpe\protocol\types\entity\EntityIds;
 use function mt_rand;
@@ -65,4 +66,8 @@ public function getXpDropAmount() : int{
 		//TODO: check for equipment and whether it's a baby
 		return 5;
 	}
+
+	public function getSpawnItem() : Item{
+		return VanillaItems::ZOMBIE_SPAWN_EGG();
+	}
 }

src/entity/object/FallingBlock.php

@@ -32,6 +32,7 @@
 use pocketmine\entity\Location;
 use pocketmine\event\entity\EntityBlockChangeEvent;
 use pocketmine\event\entity\EntityDamageEvent;
+use pocketmine\item\Item;
 use pocketmine\math\Vector3;
 use pocketmine\nbt\tag\ByteTag;
 use pocketmine\nbt\tag\CompoundTag;
@@ -144,6 +145,10 @@ public function saveNBT() : CompoundTag{
 		return $nbt;
 	}
 
+	public function getPickedItem(bool $addUserData) : Item{
+		return $this->block->asItem();
+	}
+
 	protected function syncNetworkData(EntityMetadataCollection $properties) : void{
 		parent::syncNetworkData($properties);
 

src/entity/object/Painting.php

@@ -28,6 +28,7 @@
 use pocketmine\entity\EntitySizeInfo;
 use pocketmine\entity\Location;
 use pocketmine\event\entity\EntityDamageByEntityEvent;
+use pocketmine\item\Item;
 use pocketmine\item\VanillaItems;
 use pocketmine\math\AxisAlignedBB;
 use pocketmine\math\Facing;
@@ -162,6 +163,14 @@ protected function sendSpawnPacket(Player $player) : void{
 		));
 	}
 
+	public function getSpawnItem() : Item{
+		return VanillaItems::PAINTING();
+	}
+
+	public function getPickedItem(bool $addUserData) : Item{
+		return $this->getSpawnItem();
+	}
+
 	/**
 	 * Returns the painting motive (which image is displayed on the painting)
 	 */

src/entity/object/PrimedTNT.php

@@ -23,11 +23,13 @@
 
 namespace pocketmine\entity\object;
 
+use pocketmine\block\VanillaBlocks;
 use pocketmine\entity\Entity;
 use pocketmine\entity\EntitySizeInfo;
 use pocketmine\entity\Explosive;
 use pocketmine\event\entity\EntityDamageEvent;
 use pocketmine\event\entity\ExplosionPrimeEvent;
+use pocketmine\item\Item;
 use pocketmine\math\Vector3;
 use pocketmine\nbt\tag\CompoundTag;
 use pocketmine\network\mcpe\protocol\types\entity\EntityIds;
@@ -128,6 +130,14 @@ public function explode() : void{
 		}
 	}
 
+	public function getSpawnItem() : Item{
+		return VanillaBlocks::TNT()->setWorksUnderwater($this->worksUnderwater)->asItem();
+	}
+
+	public function getPickedItem(bool $addUserData) : Item{
+		return $this->getSpawnItem();
+	}
+
 	protected function syncNetworkData(EntityMetadataCollection $properties) : void{
 		parent::syncNetworkData($properties);
 

src/event/player/PlayerEntityPickEvent.php

@@ -0,0 +1,53 @@
+<?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\entity\Entity;
+use pocketmine\event\Cancellable;
+use pocketmine\event\CancellableTrait;
+use pocketmine\item\Item;
+use pocketmine\player\Player;
+
+/**
+ * Called when a player middle-clicks on a entity to get an item in creative mode.
+ */
+class PlayerEntityPickEvent extends PlayerEvent implements Cancellable{
+	use CancellableTrait;
+
+	public function __construct(
+		Player $player,
+		private Entity $entityClicked,
+		private Item $resultItem
+	){
+		$this->player = $player;
+	}
+
+	public function getEntity() : Entity{
+		return $this->entityClicked;
+	}
+
+	public function getResultItem() : Item{
+		return $this->resultItem;
+	}
+}

src/item/Item.php

@@ -61,6 +61,7 @@ class Item implements \JsonSerializable{
 	public const TAG_ENCH = "ench";
 	public const TAG_DISPLAY = "display";
 	public const TAG_BLOCK_ENTITY_TAG = "BlockEntityTag";
+	public const TAG_ENTITY_TAG = "EntityTag";
 
 	public const TAG_DISPLAY_NAME = "Name";
 	public const TAG_DISPLAY_LORE = "Lore";
@@ -84,6 +85,7 @@ class Item implements \JsonSerializable{
 	 * @var CompoundTag|null
 	 */
 	protected $blockEntityTag = null;
+	protected ?CompoundTag $entityTag = null;
 
 	/**
 	 * @var string[]
@@ -138,6 +140,28 @@ public function getCustomBlockData() : ?CompoundTag{
 		return $this->blockEntityTag;
 	}
 
+	/**
+	 * @return $this
+	 */
+	public function clearCustomEntityData() : Item{
+		$this->entityTag = null;
+
+		return $this;
+	}
+
+	/**
+	 * @return $this
+	 */
+	public function setCustomEntityData(CompoundTag $compound) : Item{
+		$this->entityTag = clone $compound;
+
+		return $this;
+	}
+
+	public function getCustomEntityData() : ?CompoundTag{
+		return $this->entityTag;
+	}
+
 	public function hasCustomName() : bool{
 		return $this->customName !== "";
 	}
@@ -304,6 +328,8 @@ protected function deserializeCompoundTag(CompoundTag $tag) : void{
 
 		$this->blockEntityTag = $tag->getCompoundTag(self::TAG_BLOCK_ENTITY_TAG);
 
+		$this->entityTag = $tag->getCompoundTag(self::TAG_ENTITY_TAG);
+
 		$this->canPlaceOn = [];
 		$canPlaceOn = $tag->getListTag("CanPlaceOn");
 		if($canPlaceOn !== null && $canPlaceOn->getTagType() === NBT::TAG_String){
@@ -359,6 +385,10 @@ protected function serializeCompoundTag(CompoundTag $tag) : void{
 			$tag->setTag(self::TAG_BLOCK_ENTITY_TAG, clone $blockData) :
 			$tag->removeTag(self::TAG_BLOCK_ENTITY_TAG);
 
+		($entityData = $this->getCustomEntityData()) !== null ?
+			$tag->setTag(self::TAG_ENTITY_TAG, clone $entityData) :
+			$tag->removeTag(self::TAG_ENTITY_TAG);
+
 		if(count($this->canPlaceOn) > 0){
 			$canPlaceOn = new ListTag();
 			foreach($this->canPlaceOn as $item){

src/item/SpawnEgg.php

@@ -36,10 +36,8 @@ abstract protected function createEntity(World $world, Vector3 $pos, float $yaw,
 
 	public function onInteractBlock(Player $player, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector) : ItemUseResult{
 		$entity = $this->createEntity($player->getWorld(), $blockReplace->getPosition()->add(0.5, 0, 0.5), lcg_value() * 360, 0);
+		$entity->copyDataFromItem($this);
 
-		if($this->hasCustomName()){
-			$entity->setNameTag($this->getCustomName());
-		}
 		$this->pop();
 		$entity->spawnToAll();
 		//TODO: what if the entity was marked for deletion?

src/network/mcpe/handler/InGamePacketHandler.php

@@ -590,7 +590,7 @@ public function handleBlockPickRequest(BlockPickRequestPacket $packet) : bool{
 	}
 
 	public function handleActorPickRequest(ActorPickRequestPacket $packet) : bool{
-		return false; //TODO
+		return $this->player->pickEntity($packet->actorUniqueId, $packet->addUserData);
 	}
 
 	public function handlePlayerAction(PlayerActionPacket $packet) : bool{