mirror of
https://github.com/pmmp/PocketMine-MP.git
synced 2025-09-07 18:32:55 +00:00
83 lines
2.4 KiB
PHP
83 lines
2.4 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\block\tile;
|
|
|
|
use pocketmine\nbt\tag\CompoundTag;
|
|
use pocketmine\network\mcpe\protocol\types\CacheableNbt;
|
|
use function get_class;
|
|
|
|
abstract class Spawnable extends Tile{
|
|
/**
|
|
* @var CacheableNbt|null
|
|
* @phpstan-var CacheableNbt<\pocketmine\nbt\tag\CompoundTag>|null
|
|
*/
|
|
private $spawnCompoundCache = null;
|
|
/** @var bool */
|
|
private $dirty = true; //default dirty, until it's been spawned appropriately on the world
|
|
|
|
/**
|
|
* Returns whether the tile needs to be respawned to viewers.
|
|
*/
|
|
public function isDirty() : bool{
|
|
return $this->dirty;
|
|
}
|
|
|
|
public function setDirty(bool $dirty = true) : void{
|
|
if($dirty){
|
|
$this->spawnCompoundCache = null;
|
|
}
|
|
$this->dirty = $dirty;
|
|
}
|
|
|
|
/**
|
|
* Returns encoded NBT (varint, little-endian) used to spawn this tile to clients. Uses cache where possible,
|
|
* populates cache if it is null.
|
|
*
|
|
* @phpstan-return CacheableNbt<\pocketmine\nbt\tag\CompoundTag>
|
|
*/
|
|
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->pos->x)
|
|
->setInt(self::TAG_Y, $this->pos->y)
|
|
->setInt(self::TAG_Z, $this->pos->z);
|
|
$this->addAdditionalSpawnData($nbt);
|
|
return $nbt;
|
|
}
|
|
|
|
/**
|
|
* An extension to getSpawnCompound() for
|
|
* further modifying the generic tile NBT.
|
|
*/
|
|
abstract protected function addAdditionalSpawnData(CompoundTag $nbt) : void;
|
|
}
|