mirror of
https://github.com/pmmp/PocketMine-MP.git
synced 2025-08-30 23:11:06 +00:00
7c521b456e
This has several advantages:
Easier to implement new blocks (one less file to modify)
Easier to adjust serialization of existing blocks
Guaranteed consistency between serializers and deserializers
Potentially, exposes more metadata for programmatic analysis, instead of having everything baked inside opaque Closures
There are some exceptions which still use the old approach: big dripleaf, cauldrons, mushroom stems, and pitcher crops. These all have multiple PM block types for a single ID, with relatively complex logic to select which to use. These weren't worth the effort to unify due to their small number. I may revisit this in the future, but I already spent a lot of brainpower on it.
90 lines
3.8 KiB
PHP
90 lines
3.8 KiB
PHP
<?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\data\bedrock\block\convert;
|
|
|
|
use PHPUnit\Framework\TestCase;
|
|
use pocketmine\block\BaseBanner;
|
|
use pocketmine\block\Bed;
|
|
use pocketmine\block\BlockTypeIds;
|
|
use pocketmine\block\CaveVines;
|
|
use pocketmine\block\Farmland;
|
|
use pocketmine\block\MobHead;
|
|
use pocketmine\block\RuntimeBlockStateRegistry;
|
|
use pocketmine\data\bedrock\block\BlockStateDeserializeException;
|
|
use pocketmine\data\bedrock\block\BlockStateSerializeException;
|
|
use function print_r;
|
|
|
|
final class BlockSerializerDeserializerTest extends TestCase{
|
|
private BlockStateToObjectDeserializer $deserializer;
|
|
private BlockObjectToStateSerializer $serializer;
|
|
|
|
public function setUp() : void{
|
|
$this->deserializer = new BlockStateToObjectDeserializer();
|
|
$this->serializer = new BlockObjectToStateSerializer();
|
|
$registrar = new BlockSerializerDeserializerRegistrar($this->deserializer, $this->serializer);
|
|
VanillaBlockMappings::init($registrar);
|
|
}
|
|
|
|
public function testAllKnownBlockStatesSerializableAndDeserializable() : void{
|
|
foreach(RuntimeBlockStateRegistry::getInstance()->getAllKnownStates() as $block){
|
|
try{
|
|
$blockStateData = $this->serializer->serializeBlock($block);
|
|
}catch(BlockStateSerializeException $e){
|
|
self::fail("Failed to serialize " . $block->getName() . ": " . $e->getMessage());
|
|
}
|
|
try{
|
|
$newBlock = $this->deserializer->deserializeBlock($blockStateData);
|
|
}catch(BlockStateDeserializeException $e){
|
|
self::fail("Failed to deserialize " . $blockStateData->getName() . ": " . $e->getMessage() . " with data " . $blockStateData->toNbt());
|
|
}
|
|
|
|
if($block->getTypeId() === BlockTypeIds::POTION_CAULDRON){
|
|
//this pretends to be a water cauldron in the blockstate, and stores its actual data in the blockentity
|
|
continue;
|
|
}
|
|
|
|
//The following are workarounds for differences in blockstate representation in Bedrock vs PM
|
|
//In some cases, some properties are not stored in the blockstate (but rather in the block entity NBT), but
|
|
//they do form part of the internal blockstate hash in PM. In other cases, PM allows representing states
|
|
//that don't exist in Bedrock, such as the cave vines head without berries, which is a state that visually
|
|
//exists in Bedrock, but doesn't have its own ID.
|
|
//This leads to inconsistencies when serializing and deserializing blockstates which we need to correct for.
|
|
if(
|
|
($block instanceof BaseBanner && $newBlock instanceof BaseBanner) ||
|
|
($block instanceof Bed && $newBlock instanceof Bed)
|
|
){
|
|
$newBlock->setColor($block->getColor());
|
|
}elseif($block instanceof MobHead && $newBlock instanceof MobHead){
|
|
$newBlock->setMobHeadType($block->getMobHeadType());
|
|
}elseif($block instanceof CaveVines && $newBlock instanceof CaveVines && !$block->hasBerries()){
|
|
$newBlock->setHead($block->isHead());
|
|
}elseif($block instanceof Farmland && $newBlock instanceof Farmland){
|
|
$block->setWaterPositionIndex($newBlock->getWaterPositionIndex());
|
|
}
|
|
|
|
self::assertSame($block->getStateId(), $newBlock->getStateId(), "Mismatch of blockstate for " . $block->getName() . ", " . print_r($block, true) . " vs " . print_r($newBlock, true));
|
|
}
|
|
}
|
|
}
|