Protocol changes for 1.17.0

src/pocketmine/Player.php

@@ -215,6 +215,7 @@ use function min;
 use function preg_match;
 use function round;
 use function spl_object_hash;
+use function sprintf;
 use function sqrt;
 use function strlen;
 use function strpos;
@@ -2279,6 +2280,7 @@ class Player extends Human implements CommandSender, ChunkLoader, IPlayer{
 		$pk->experiments = new Experiments([], false);
 		$pk->itemTable = ItemTypeDictionary::getInstance()->getEntries();
 		$pk->playerMovementSettings = new PlayerMovementSettings(PlayerMovementType::LEGACY, 0, false);
+		$pk->serverSoftwareVersion = sprintf("%s %s", \pocketmine\NAME, \pocketmine\VERSION);
 		$this->dataPacket($pk);
 
 		$this->sendDataPacket(new AvailableActorIdentifiersPacket());

src/pocketmine/network/mcpe/NetworkBinaryStream.php

@@ -671,14 +671,15 @@ class NetworkBinaryStream extends BinaryStream{
 	 * Reads gamerules
 	 * TODO: implement this properly
 	 *
-	 * @return mixed[][], members are in the structure [name => [type, value]]
-	 * @phpstan-return array<string, array{0: int, 1: bool|int|float}>
+	 * @return mixed[][], members are in the structure [name => [type, value, isPlayerModifiable]]
+	 * @phpstan-return array<string, array{0: int, 1: bool|int|float, 2: bool}>
 	 */
 	public function getGameRules() : array{
 		$count = $this->getUnsignedVarInt();
 		$rules = [];
 		for($i = 0; $i < $count; ++$i){
 			$name = $this->getString();
+			$isPlayerModifiable = $this->getBool();
 			$type = $this->getUnsignedVarInt();
 			$value = null;
 			switch($type){
@@ -693,23 +694,24 @@ class NetworkBinaryStream extends BinaryStream{
 					break;
 			}
 
-			$rules[$name] = [$type, $value];
+			$rules[$name] = [$type, $value, $isPlayerModifiable];
 		}
 
 		return $rules;
 	}
 
 	/**
-	 * Writes a gamerule array, members should be in the structure [name => [type, value]]
+	 * Writes a gamerule array, members should be in the structure [name => [type, value, isPlayerModifiable]]
 	 * TODO: implement this properly
 	 *
 	 * @param mixed[][] $rules
-	 * @phpstan-param array<string, array{0: int, 1: bool|int|float}> $rules
+	 * @phpstan-param array<string, array{0: int, 1: bool|int|float, 2: bool}> $rules
 	 */
 	public function putGameRules(array $rules) : void{
 		$this->putUnsignedVarInt(count($rules));
 		foreach($rules as $name => $rule){
 			$this->putString($name);
+			$this->putBool($rule[2]);
 			$this->putUnsignedVarInt($rule[0]);
 			switch($rule[0]){
 				case GameRuleType::BOOL:

src/pocketmine/network/mcpe/NetworkSession.php

@@ -31,6 +31,7 @@ use pocketmine\network\mcpe\protocol\AddEntityPacket;
 use pocketmine\network\mcpe\protocol\AddItemActorPacket;
 use pocketmine\network\mcpe\protocol\AddPaintingPacket;
 use pocketmine\network\mcpe\protocol\AddPlayerPacket;
+use pocketmine\network\mcpe\protocol\AddVolumeEntityPacket;
 use pocketmine\network\mcpe\protocol\AdventureSettingsPacket;
 use pocketmine\network\mcpe\protocol\AnimateEntityPacket;
 use pocketmine\network\mcpe\protocol\AnimatePacket;
@@ -130,6 +131,7 @@ use pocketmine\network\mcpe\protocol\PurchaseReceiptPacket;
 use pocketmine\network\mcpe\protocol\RemoveActorPacket;
 use pocketmine\network\mcpe\protocol\RemoveEntityPacket;
 use pocketmine\network\mcpe\protocol\RemoveObjectivePacket;
+use pocketmine\network\mcpe\protocol\RemoveVolumeEntityPacket;
 use pocketmine\network\mcpe\protocol\RequestChunkRadiusPacket;
 use pocketmine\network\mcpe\protocol\ResourcePackChunkDataPacket;
 use pocketmine\network\mcpe\protocol\ResourcePackChunkRequestPacket;
@@ -172,6 +174,7 @@ use pocketmine\network\mcpe\protocol\StructureBlockUpdatePacket;
 use pocketmine\network\mcpe\protocol\StructureTemplateDataRequestPacket;
 use pocketmine\network\mcpe\protocol\StructureTemplateDataResponsePacket;
 use pocketmine\network\mcpe\protocol\SubClientLoginPacket;
+use pocketmine\network\mcpe\protocol\SyncActorPropertyPacket;
 use pocketmine\network\mcpe\protocol\TakeItemActorPacket;
 use pocketmine\network\mcpe\protocol\TextPacket;
 use pocketmine\network\mcpe\protocol\TickSyncPacket;
@@ -826,4 +829,16 @@ abstract class NetworkSession{
 	public function handleClientboundDebugRenderer(ClientboundDebugRendererPacket $packet) : bool{
 		return false;
 	}
+
+	public function handleSyncActorProperty(SyncActorPropertyPacket $packet) : bool{
+		return false;
+	}
+
+	public function handleAddVolumeEntity(AddVolumeEntityPacket $packet) : bool{
+		return false;
+	}
+
+	public function handleRemoveVolumeEntity(RemoveVolumeEntityPacket $packet) : bool{
+		return false;
+	}
 }

src/pocketmine/network/mcpe/convert/ItemTranslator.php

@@ -85,6 +85,10 @@ final class ItemTranslator{
 			if(!is_string($oldId) || !is_string($newId)){
 				throw new AssumptionFailedError("Invalid item table format");
 			}
+			if(!isset($legacyStringToIntMap[$oldId])){
+				//new item without a fixed legacy ID - we can't handle this right now
+				continue;
+			}
 			$simpleMappings[$newId] = $legacyStringToIntMap[$oldId];
 		}
 		foreach($legacyStringToIntMap as $stringId => $intId){
@@ -128,8 +132,9 @@ final class ItemTranslator{
 			}elseif(isset($simpleMappings[$stringId])){
 				$this->simpleCoreToNetMapping[$simpleMappings[$stringId]] = $netId;
 				$this->simpleNetToCoreMapping[$netId] = $simpleMappings[$stringId];
-			}elseif($stringId !== "minecraft:unknown"){
-				throw new \InvalidArgumentException("Unmapped entry " . $stringId);
+			}else{
+				//not all items have a legacy mapping - for now, we only support the ones that do
+				continue;
 			}
 		}
 	}

src/pocketmine/network/mcpe/protocol/AddVolumeEntityPacket.php

@@ -0,0 +1,64 @@
+<?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\network\mcpe\protocol;
+
+#include <rules/DataPacket.h>
+
+use pocketmine\nbt\NetworkLittleEndianNBTStream;
+use pocketmine\nbt\tag\CompoundTag;
+use pocketmine\network\mcpe\NetworkSession;
+
+class AddVolumeEntityPacket extends DataPacket{
+	public const NETWORK_ID = ProtocolInfo::ADD_VOLUME_ENTITY_PACKET;
+
+	/** @var int */
+	private $entityNetId;
+	/** @var CompoundTag */
+	private $data;
+
+	public static function create(int $entityNetId, CompoundTag $data) : self{
+		$result = new self;
+		$result->entityNetId = $entityNetId;
+		$result->data = $data;
+		return $result;
+	}
+
+	public function getEntityNetId() : int{ return $this->entityNetId; }
+
+	public function getData() : CompoundTag{ return $this->data; }
+
+	protected function decodePayload() : void{
+		$this->entityNetId = $this->getUnsignedVarInt();
+		$this->data = $this->getNbtCompoundRoot();
+	}
+
+	protected function encodePayload() : void{
+		$this->putUnsignedVarInt($this->entityNetId);
+		$this->put((new NetworkLittleEndianNBTStream())->write($this->data));
+	}
+
+	public function handle(NetworkSession $handler) : bool{
+		return $handler->handleAddVolumeEntity($this);
+	}
+}

src/pocketmine/network/mcpe/protocol/GameRulesChangedPacket.php

@@ -32,7 +32,7 @@ class GameRulesChangedPacket extends DataPacket{
 
 	/**
 	 * @var mixed[][]
-	 * @phpstan-var array<string, array{0: int, 1: bool|int|float}>
+	 * @phpstan-var array<string, array{0: int, 1: bool|int|float, 2: bool}>
 	 */
 	public $gameRules = [];
 

src/pocketmine/network/mcpe/protocol/PacketPool.php

@@ -195,6 +195,9 @@ class PacketPool{
 		static::registerPacket(new ItemComponentPacket());
 		static::registerPacket(new FilterTextPacket());
 		static::registerPacket(new ClientboundDebugRendererPacket());
+		static::registerPacket(new SyncActorPropertyPacket());
+		static::registerPacket(new AddVolumeEntityPacket());
+		static::registerPacket(new RemoveVolumeEntityPacket());
 	}
 
 	/**

src/pocketmine/network/mcpe/protocol/ProtocolInfo.php

@@ -37,11 +37,11 @@ interface ProtocolInfo{
 	 */
 
 	/** Actual Minecraft: PE protocol version */
-	public const CURRENT_PROTOCOL = 431;
+	public const CURRENT_PROTOCOL = 440;
 	/** Current Minecraft PE version reported by the server. This is usually the earliest currently supported version. */
-	public const MINECRAFT_VERSION = 'v1.16.220';
+	public const MINECRAFT_VERSION = 'v1.17.0';
 	/** Version number sent to clients in ping responses. */
-	public const MINECRAFT_VERSION_NETWORK = '1.16.220';
+	public const MINECRAFT_VERSION_NETWORK = '1.17.0';
 
 	public const LOGIN_PACKET = 0x01;
 	public const PLAY_STATUS_PACKET = 0x02;
@@ -207,5 +207,8 @@ interface ProtocolInfo{
 	public const ITEM_COMPONENT_PACKET = 0xa2;
 	public const FILTER_TEXT_PACKET = 0xa3;
 	public const CLIENTBOUND_DEBUG_RENDERER_PACKET = 0xa4;
+	public const SYNC_ACTOR_PROPERTY_PACKET = 0xa5;
+	public const ADD_VOLUME_ENTITY_PACKET = 0xa6;
+	public const REMOVE_VOLUME_ENTITY_PACKET = 0xa7;
 
 }

src/pocketmine/network/mcpe/protocol/RemoveVolumeEntityPacket.php

@@ -0,0 +1,55 @@
+<?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\network\mcpe\protocol;
+
+#include <rules/DataPacket.h>
+
+use pocketmine\network\mcpe\NetworkSession;
+
+class RemoveVolumeEntityPacket extends DataPacket{
+	public const NETWORK_ID = ProtocolInfo::REMOVE_VOLUME_ENTITY_PACKET;
+
+	/** @var int */
+	private $entityNetId;
+
+	public static function create(int $entityNetId) : self{
+		$result = new self;
+		$result->entityNetId = $entityNetId;
+		return $result;
+	}
+
+	public function getEntityNetId() : int{ return $this->entityNetId; }
+
+	protected function decodePayload() : void{
+		$this->entityNetId = $this->getUnsignedVarInt();
+	}
+
+	protected function encodePayload() : void{
+		$this->putUnsignedVarInt($this->entityNetId);
+	}
+
+	public function handle(NetworkSession $handler) : bool{
+		return $handler->handleRemoveVolumeEntity($this);
+	}
+}

src/pocketmine/network/mcpe/protocol/StartGamePacket.php

@@ -104,10 +104,10 @@ class StartGamePacket extends DataPacket{
 	public $isTexturePacksRequired = true;
 	/**
 	 * @var mixed[][]
-	 * @phpstan-var array<string, array{0: int, 1: bool|int|float}>
+	 * @phpstan-var array<string, array{0: int, 1: bool|int|float, 2: bool}>
 	 */
 	public $gameRules = [ //TODO: implement this
-		"naturalregeneration" => [GameRuleType::BOOL, false] //Hack for client side regeneration
+		"naturalregeneration" => [GameRuleType::BOOL, false, false] //Hack for client side regeneration
 	];
 	/** @var Experiments */
 	public $experiments;
@@ -176,6 +176,8 @@ class StartGamePacket extends DataPacket{
 	public $itemTable;
 	/** @var bool */
 	public $enableNewInventorySystem = false; //TODO
+	/** @var string */
+	public $serverSoftwareVersion;
 
 	protected function decodePayload(){
 		$this->entityUniqueId = $this->getEntityUniqueId();
@@ -258,6 +260,7 @@ class StartGamePacket extends DataPacket{
 
 		$this->multiplayerCorrelationId = $this->getString();
 		$this->enableNewInventorySystem = $this->getBool();
+		$this->serverSoftwareVersion = $this->getString();
 	}
 
 	protected function encodePayload(){
@@ -337,6 +340,7 @@ class StartGamePacket extends DataPacket{
 
 		$this->putString($this->multiplayerCorrelationId);
 		$this->putBool($this->enableNewInventorySystem);
+		$this->putString($this->serverSoftwareVersion);
 	}
 
 	public function handle(NetworkSession $session) : bool{

src/pocketmine/network/mcpe/protocol/SyncActorPropertyPacket.php

@@ -0,0 +1,57 @@
+<?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\network\mcpe\protocol;
+
+#include <rules/DataPacket.h>
+
+use pocketmine\nbt\NetworkLittleEndianNBTStream;
+use pocketmine\nbt\tag\CompoundTag;
+use pocketmine\network\mcpe\NetworkSession;
+
+class SyncActorPropertyPacket extends DataPacket{
+	public const NETWORK_ID = ProtocolInfo::SYNC_ACTOR_PROPERTY_PACKET;
+
+	/** @var CompoundTag */
+	private $data;
+
+	public static function create(CompoundTag $data) : self{
+		$result = new self;
+		$result->data = $data;
+		return $result;
+	}
+
+	public function getData() : CompoundTag{ return $this->data; }
+
+	protected function decodePayload() : void{
+		$this->data = $this->getNbtCompoundRoot();
+	}
+
+	protected function encodePayload() : void{
+		$this->put((new NetworkLittleEndianNBTStream())->write($this->data));
+	}
+
+	public function handle(NetworkSession $handler) : bool{
+		return $handler->handleSyncActorProperty($this);
+	}
+}

src/pocketmine/resources/vanilla

@@ -1 +1 @@
-Subproject commit 989e02a6318b1278fda8526dd136749b9b7b34b4
+Subproject commit 04c846c5f95a7bb9ae111f699f2ba08c9ec838aa

tests/phpstan/configs/l7-baseline.neon

@@ -581,7 +581,7 @@ parameters:
 			path: ../../../src/pocketmine/level/generator/object/TallGrass.php
 
 		-
-			message: "#^Method pocketmine\\\\network\\\\mcpe\\\\NetworkBinaryStream\\:\\:getGameRules\\(\\) should return array\\<string, array\\(int, bool\\|float\\|int\\)\\> but returns array\\<string, array\\(int, bool\\|float\\|int\\|null\\)\\>\\.$#"
+			message: "#^Method pocketmine\\\\network\\\\mcpe\\\\NetworkBinaryStream\\:\\:getGameRules\\(\\) should return array\\<string, array\\(int, bool\\|float\\|int, bool\\)\\> but returns array\\<string, array\\(int, bool\\|float\\|int\\|null, bool\\)\\>\\.$#"
 			count: 1
 			path: ../../../src/pocketmine/network/mcpe/NetworkBinaryStream.php
 
@@ -635,6 +635,11 @@ parameters:
 			count: 1
 			path: ../../../src/pocketmine/network/mcpe/convert/RuntimeBlockMapping.php
 
+		-
+			message: "#^Parameter \\#1 \\$str of method pocketmine\\\\utils\\\\BinaryStream\\:\\:put\\(\\) expects string, string\\|false given\\.$#"
+			count: 1
+			path: ../../../src/pocketmine/network/mcpe/protocol/AddVolumeEntityPacket.php
+
 		-
 			message: "#^Parameter \\#1 \\$str of method pocketmine\\\\utils\\\\BinaryStream\\:\\:put\\(\\) expects string, string\\|false given\\.$#"
 			count: 1
@@ -680,6 +685,11 @@ parameters:
 			count: 1
 			path: ../../../src/pocketmine/network/mcpe/protocol/StartGamePacket.php
 
+		-
+			message: "#^Parameter \\#1 \\$str of method pocketmine\\\\utils\\\\BinaryStream\\:\\:put\\(\\) expects string, string\\|false given\\.$#"
+			count: 1
+			path: ../../../src/pocketmine/network/mcpe/protocol/SyncActorPropertyPacket.php
+
 		-
 			message: "#^Parameter \\#3 \\$resourcePatch of class pocketmine\\\\network\\\\mcpe\\\\protocol\\\\types\\\\SkinData constructor expects string, string\\|false given\\.$#"
 			count: 1