Merge pull request #6658 from pmmp/minor-next-release

Author: dktapps

changelogs/5.26.md

@@ -0,0 +1,71 @@
+# 5.26.0
+Released 22nd March 2025.
+
+This is a minor feature release focused on performance improvements.
+
+**Plugin compatibility:** Plugins for previous 5.x versions will run unchanged on this release, unless they use internal APIs, reflection, or packages like the `pocketmine\network\mcpe` or `pocketmine\data` namespace.
+Do not update plugin minimum API versions unless you need new features added in this release.
+
+**WARNING: If your plugin uses the `pocketmine\network\mcpe` namespace, you're not shielded by API change constraints.**
+Consider using the `mcpe-protocol` directive in `plugin.yml` as a constraint if you're using packets directly.
+
+## Performance
+- Significantly improved performance of entity movement. Load testing with item entities showed a 3x increase in the number of entities supported without lag.
+- Significantly improved performance of on-ground checks for player movement. This still needs further work, but optimisations implemented in this version should improve performance substantially.
+- Updated `pocketmine/nbt` dependency with performance improvements to `TAG_Compound` and `TAG_List` comparison. This should improve performance of inventory-related actions.
+- `InventoryTransaction` now avoids useless item clones when processing transactions, which should improve performance of inventory-related actions.
+
+## Dependencies
+- `pocketmine/bedrock-protocol` has been updated to `36.2.0`, which adds new functions to access some packet fields.
+- `pocketmine/nbt` has been updated to `1.1.0`, which improves performance when comparing NBT object trees.
+
+## Gameplay
+- Block breaking animation speed now takes into account the following: jumping, being in water, haste, mining fatigue
+
+## Tools
+- `blockstate-upgrade-schema-utils.php` now has a new `dump-table` command, which turns a `.bin` palette table file into human-readable text for debugging.
+
+## API
+### `pocketmine\block`
+- The following methods have been added:
+  - `public RuntimeBlockStateRegistry->hasStateId(int $stateId) : bool` - checks whether the given state ID is registered
+
+### `pocketmine\crafting`
+- The following methods have been deprecated:
+  - `CraftingManager::sort()` - this was implicitly internal anyway
+
+### `pocketmine\utils`
+- The following constants have been added:
+  - `TextFormat::MATERIAL_RESIN`
+- The following static properties have been added:
+  - `Terminal::$COLOR_MATERIAL_RESIN`
+
+### `pocketmine\data\bedrock\block`
+- `BlockStateToObjectDeserializer` now permits overriding **deserializers** for Bedrock IDs. This may be useful to implement custom state handling, or to implement missing block variants (such as snow cauldron).
+  - This was originally prohibited since 5.0.0. However, there is no technical reason to disallow overriding **deserializers**.
+  - Overriding **serializers** is still **not permitted**. Reusing type IDs doesn't make any sense and would break internal design contracts.
+  - If you want to make a custom version of a vanilla block, create a custom type ID for it, exactly as you would for a regular custom block.
+- The following methods have been added:
+  - `public BlockStateToObjectDeserializer->getDeserializerForId(string $id) : ?(\Closure(BlockStateReader) : Block)`
+
+### `pocketmine\data\bedrock\item`
+- `ItemDeserializer` now permits overriding **deserializers** for Bedrock IDs. As above, this may be useful to implement custom data handling, or to implement missing variants of existing items.
+  - This was originally prohibited since 5.0.0. However, there is no technical reason to disallow overriding **deserializers**.
+  - Overriding **serializers** is still **not permitted**. Reusing type IDs doesn't make any sense and would break internal design contracts.
+  - As above, if you want to make a custom version of a vanilla item, create a custom type ID for it, exactly as you would for a regular custom item.
+- The following methods have been added:
+  - `public ItemDeserializer->getDeserializerForId(string $id) : ?(\Closure(SavedItemData) : Item)`
+
+## Internals
+- `new $class` is now banned on new internals code by a PHPStan rule. Closures or factory objects should be used instead for greater flexibility and better static analysis.
+- `CraftingManager` now uses a more stable hash function for recipe output filtering.
+- `ChunkCache` now accepts `int $dimensionId` in the constructor. This may be useful for plugins which implement the nether.
+- `RuntimeBlockStateRegistry` now precomputes basic collision info about known states for fast paths.
+  - This permits specialization for common shapes like cubes and collisionless blocks, which allows skipping complex logic in entity movement calculation. This vastly improves performance.
+  - Any block whose class overrides `readStateFromWorld()` or `getModelPositionOffset()` will *not* be optimised.
+  - `Block->recalculateCollisionBoxes()` now has a hard requirement not to depend on anything other than available properties. It must not use `World` or its position.
+    - This change was problematic for `ChorusPlant`, which used nearby blocks to calculate its collision boxes.
+    - Blocks which need nearby blocks should override `readStateFromWorld()` and set dynamic state properties, similar to fences.
+    - This design flaw will be corrected with a major change to `Block` internals currently in planning for a future major version.
+- `Block->getCollisionBoxes()` may not be called at all during gameplay for blocks with shapes determined to be simple, like cubes and collisionless blocks.
+- `BlockStateToObjectDeserializer` now checks if the returned blockstate is registered in `RuntimeBlockStateRegistry` to promote earlier error detection (instead of crashing in random code paths).

composer.json

@@ -36,15 +36,15 @@
       "pocketmine/bedrock-block-upgrade-schema": "~5.1.0+bedrock-1.21.60",
       "pocketmine/bedrock-data": "~4.0.0+bedrock-1.21.60",
       "pocketmine/bedrock-item-upgrade-schema": "~1.14.0+bedrock-1.21.50",
-      "pocketmine/bedrock-protocol": "~36.0.0+bedrock-1.21.60",
+      "pocketmine/bedrock-protocol": "~36.2.0+bedrock-1.21.60",
       "pocketmine/binaryutils": "^0.2.1",
       "pocketmine/callback-validator": "^1.0.2",
       "pocketmine/color": "^0.3.0",
       "pocketmine/errorhandler": "^0.7.0",
       "pocketmine/locale-data": "~2.24.0",
       "pocketmine/log": "^0.4.0",
       "pocketmine/math": "~1.0.0",
-      "pocketmine/nbt": "~1.0.0",
+      "pocketmine/nbt": "~1.1.0",
       "pocketmine/raklib": "~1.1.0",
       "pocketmine/raklib-ipc": "~1.0.0",
       "pocketmine/snooze": "^0.5.0",

composer.lock

@@ -11,6 +11,7 @@ includes:
 
 rules:
 	- pocketmine\phpstan\rules\DeprecatedLegacyEnumAccessRule
+	- pocketmine\phpstan\rules\DisallowDynamicNewRule
 	- pocketmine\phpstan\rules\DisallowEnumComparisonRule
 	- pocketmine\phpstan\rules\DisallowForeachByReferenceRule
 	- pocketmine\phpstan\rules\ExplodeLimitRule

phpstan.neon.dist

@@ -31,8 +31,8 @@
 
 final class VersionInfo{
 	public const NAME = "PocketMine-MP";
-	public const BASE_VERSION = "5.25.3";
-	public const IS_DEVELOPMENT_BUILD = true;
+	public const BASE_VERSION = "5.26.0";
+	public const IS_DEVELOPMENT_BUILD = false;
 	public const BUILD_CHANNEL = "stable";
 
 	/**

src/VersionInfo.php

@@ -34,18 +34,43 @@
 final class ChorusPlant extends Flowable{
 	use StaticSupportTrait;
 
+	/**
+	 * @var true[]
+	 * @phpstan-var array<int, true>
+	 */
+	protected array $connections = [];
+
 	protected function recalculateCollisionBoxes() : array{
 		$bb = AxisAlignedBB::one();
-		foreach($this->getAllSides() as $facing => $block){
-			$id = $block->getTypeId();
-			if($id !== BlockTypeIds::END_STONE && $id !== BlockTypeIds::CHORUS_FLOWER && !$block->hasSameTypeId($this)){
+		foreach(Facing::ALL as $facing){
+			if(!isset($this->connections[$facing])){
 				$bb->trim($facing, 2 / 16);
 			}
 		}
 
 		return [$bb];
 	}
 
+	public function readStateFromWorld() : Block{
+		parent::readStateFromWorld();
+
+		$this->collisionBoxes = null;
+
+		foreach(Facing::ALL as $facing){
+			$block = $this->getSide($facing);
+			if(match($block->getTypeId()){
+				BlockTypeIds::END_STONE, BlockTypeIds::CHORUS_FLOWER, $this->getTypeId() => true,
+				default => false
+			}){
+				$this->connections[$facing] = true;
+			}else{
+				unset($this->connections[$facing]);
+			}
+		}
+
+		return $this;
+	}
+
 	private function canBeSupportedBy(Block $block) : bool{
 		return $block->hasSameTypeId($this) || $block->getTypeId() === BlockTypeIds::END_STONE;
 	}

src/block/ChorusPlant.php

@@ -28,6 +28,7 @@
 use pocketmine\utils\AssumptionFailedError;
 use pocketmine\utils\SingletonTrait;
 use pocketmine\world\light\LightUpdate;
+use function count;
 use function min;
 
 /**
@@ -40,6 +41,11 @@
 class RuntimeBlockStateRegistry{
 	use SingletonTrait;
 
+	public const COLLISION_CUSTOM = 0;
+	public const COLLISION_CUBE = 1;
+	public const COLLISION_NONE = 2;
+	public const COLLISION_MAY_OVERFLOW = 3;
+
 	/**
 	 * @var Block[]
 	 * @phpstan-var array<int, Block>
@@ -74,6 +80,13 @@ class RuntimeBlockStateRegistry{
 	 */
 	public array $blastResistance = [];
 
+	/**
+	 * Map of state ID -> useful AABB info to avoid unnecessary block allocations
+	 * @var int[]
+	 * @phpstan-var array<int, int>
+	 */
+	public array $collisionInfo = [];
+
 	public function __construct(){
 		foreach(VanillaBlocks::getAll() as $block){
 			$this->register($block);
@@ -100,6 +113,70 @@ public function register(Block $block) : void{
 		}
 	}
 
+	/**
+	 * Checks if the given class method overrides a method in Block.
+	 * Used to determine if a block might need to disable fast path optimizations.
+	 *
+	 * @phpstan-param anyClosure $closure
+	 */
+	private static function overridesBlockMethod(\Closure $closure) : bool{
+		$declarer = (new \ReflectionFunction($closure))->getClosureScopeClass();
+		return $declarer !== null && $declarer->getName() !== Block::class;
+	}
+
+	/**
+	 * A big ugly hack to set up fast paths for handling collisions on blocks with common shapes.
+	 * The information returned here is stored in RuntimeBlockStateRegistry->collisionInfo, and is used during entity
+	 * collision box calculations to avoid complex logic and unnecessary block object allocations.
+	 * This hack allows significant performance improvements.
+	 *
+	 * TODO: We'll want to redesign block collision box handling and block shapes in the future, but that's a job for a
+	 * major version. For now, this hack nets major performance wins.
+	 */
+	private static function calculateCollisionInfo(Block $block) : int{
+		if(
+			self::overridesBlockMethod($block->getModelPositionOffset(...)) ||
+			self::overridesBlockMethod($block->readStateFromWorld(...))
+		){
+			//getModelPositionOffset() might cause AABBs to shift outside the cell
+			//readStateFromWorld() might cause overflow in ways we can't predict just by looking at known states
+			//TODO: excluding overriders of readStateFromWorld() also excludes blocks with tiles that don't do anything
+			//weird with their AABBs, but for now this is the best we can do.
+			return self::COLLISION_MAY_OVERFLOW;
+		}
+
+		//TODO: this could blow up if any recalculateCollisionBoxes() uses the world
+		//it shouldn't, but that doesn't mean that custom blocks won't...
+		$boxes = $block->getCollisionBoxes();
+		if(count($boxes) === 0){
+			return self::COLLISION_NONE;
+		}
+
+		if(
+			count($boxes) === 1 &&
+			$boxes[0]->minX === 0.0 &&
+			$boxes[0]->minY === 0.0 &&
+			$boxes[0]->minZ === 0.0 &&
+			$boxes[0]->maxX === 1.0 &&
+			$boxes[0]->maxY === 1.0 &&
+			$boxes[0]->maxZ === 1.0
+		){
+			return self::COLLISION_CUBE;
+		}
+
+		foreach($boxes as $box){
+			if(
+				$box->minX < 0 || $box->maxX > 1 ||
+				$box->minY < 0 || $box->maxY > 1 ||
+				$box->minZ < 0 || $box->maxZ > 1
+			){
+				return self::COLLISION_MAY_OVERFLOW;
+			}
+		}
+
+		return self::COLLISION_CUSTOM;
+	}
+
 	private function fillStaticArrays(int $index, Block $block) : void{
 		$fullId = $block->getStateId();
 		if($index !== $fullId){
@@ -112,6 +189,8 @@ private function fillStaticArrays(int $index, Block $block) : void{
 			if($block->blocksDirectSkyLight()){
 				$this->blocksDirectSkyLight[$index] = true;
 			}
+
+			$this->collisionInfo[$index] = self::calculateCollisionInfo($block);
 		}
 	}
 
@@ -130,6 +209,10 @@ public function fromStateId(int $stateId) : Block{
 		return $block;
 	}
 
+	public function hasStateId(int $stateId) : bool{
+		return isset($this->fullList[$stateId]);
+	}
+
 	/**
 	 * @return Block[]
 	 * @phpstan-return array<int, Block>