BlockStateToObjectDeserializer.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 pocketmine\block\Block;
use pocketmine\block\RuntimeBlockStateRegistry;
use pocketmine\data\bedrock\block\BlockStateData;
use pocketmine\data\bedrock\block\BlockStateDeserializeException;
use pocketmine\data\bedrock\block\BlockStateDeserializer;
use pocketmine\data\bedrock\block\convert\BlockStateReader as Reader;
use function array_key_exists;
use function count;
 
final class BlockStateToObjectDeserializer implements BlockStateDeserializer{
 
    private array $deserializeFuncs = [];
 
    private array $simpleCache = [];
 
    public function deserialize(BlockStateData $stateData) : int{
        if(count($stateData->getStates()) === 0){
            //if a block has zero properties, we can keep a map of string ID -> internal blockstate ID
            return $this->simpleCache[$stateData->getName()] ??= $this->deserializeToStateId($stateData);
        }
 
        //we can't cache blocks that have properties - go ahead and deserialize the slow way
        return $this->deserializeToStateId($stateData);
    }
 
    private function deserializeToStateId(BlockStateData $stateData) : int{
        $stateId = $this->deserializeBlock($stateData)->getStateId();
        //plugin devs seem to keep missing this and causing core crashes, so we need to verify this at the earliest
        //available opportunity
        if(!RuntimeBlockStateRegistry::getInstance()->hasStateId($stateId)){
            throw new \LogicException("State ID $stateId returned by deserializer for " . $stateData->getName() . " is not registered in RuntimeBlockStateRegistry");
        }
        return $stateId;
    }
 
    public function map(string $id, \Closure $c) : void{
        $this->deserializeFuncs[$id] = $c;
        $this->simpleCache = [];
    }
 
    public function getDeserializerForId(string $id) : ?\Closure{
        return $this->deserializeFuncs[$id] ?? null;
    }
 
    public function deserializeBlock(BlockStateData $blockStateData) : Block{
        $id = $blockStateData->getName();
        if(!array_key_exists($id, $this->deserializeFuncs)){
            throw new UnsupportedBlockStateException("Unknown block ID \"$id\"");
        }
        $reader = new Reader($blockStateData);
        $block = $this->deserializeFuncs[$id]($reader);
        $reader->checkUnreadProperties();
        return $block;
    }
}