Spawnable.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\block\tile;
 
use pocketmine\block\Block;
use pocketmine\nbt\tag\ByteTag;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\nbt\tag\IntTag;
use pocketmine\nbt\tag\StringTag;
use pocketmine\network\mcpe\protocol\types\CacheableNbt;
use function get_class;
 
abstract class Spawnable extends Tile{
    private ?CacheableNbt $spawnCompoundCache = null;
 
    public function isDirty() : bool{
        return $this->spawnCompoundCache === null;
    }
 
    public function setDirty(bool $dirty = true) : void{
        $this->clearSpawnCompoundCache();
    }
 
    public function clearSpawnCompoundCache() : void{
        $this->spawnCompoundCache = null;
    }
 
    public function getRenderUpdateBugWorkaroundStateProperties(Block $block) : array{
        return [];
    }
 
    final public function getSerializedSpawnCompound() : CacheableNbt{
        if($this->spawnCompoundCache === null){
            $this->spawnCompoundCache = new CacheableNbt($this->getSpawnCompound());
        }
 
        return $this->spawnCompoundCache;
    }
 
    final public function getSpawnCompound() : CompoundTag{
        $nbt = CompoundTag::create()
            ->setString(self::TAG_ID, TileFactory::getInstance()->getSaveId(get_class($this))) //TODO: disassociate network ID from save ID
            ->setInt(self::TAG_X, $this->position->x)
            ->setInt(self::TAG_Y, $this->position->y)
            ->setInt(self::TAG_Z, $this->position->z);
        $this->addAdditionalSpawnData($nbt);
        return $nbt;
    }
 
    abstract protected function addAdditionalSpawnData(CompoundTag $nbt) : void;
}