mirrors/PocketMine-MP
1
0
Fork 0
mirror of https://github.com/pmmp/PocketMine-MP.git synced 2025-06-11 05:55:33 +00:00
Code Issues Projects Releases Wiki Activity

Introduce TileFactory

Browse Source
This commit is contained in:
Dylan K. Taylor 2019-01-07 00:20:24 +00:00
parent 7d827a1c65
commit 78cb6445a5
26 changed files with 220 additions and 176 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/pocketmine/Server.php
View File

@ -101,7 +101,7 @@ use pocketmine\scheduler\AsyncPool;
use pocketmine\scheduler\SendUsageTask;
use pocketmine\snooze\SleeperHandler;
use pocketmine\snooze\SleeperNotifier;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
use pocketmine\timings\Timings;
use pocketmine\timings\TimingsHandler;
use pocketmine\updater\AutoUpdater;
@ -1697,7 +1697,7 @@ class Server{
$this->commandMap = new SimpleCommandMap($this);
EntityFactory::init();
Tile::init();
TileFactory::init();
BlockFactory::init();
BlockFactory::registerStaticRuntimeIdMappings();
Enchantment::init();

4
src/pocketmine/block/Bed.php
View File

@ -35,7 +35,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\Bed as TileBed;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
use pocketmine\utils\TextFormat;
class Bed extends Transparent{
@ -88,7 +88,7 @@ class Bed extends Transparent{
parent::writeStateToWorld();
//extra block properties storage hack
/** @var TileBed $tile */
$tile = Tile::create(TileBed::class, $this->getLevel(), $this->asVector3());
$tile = TileFactory::create(TileBed::class, $this->getLevel(), $this->asVector3());
$tile->setColor($this->color);
$this->level->addTile($tile);
}

4
src/pocketmine/block/Chest.php
View File

@ -30,7 +30,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\Chest as TileChest;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
class Chest extends Transparent{
@ -95,7 +95,7 @@ class Chest extends Transparent{
if(parent::place($item, $blockReplace, $blockClicked, $face, $clickVector, $player)){
/** @var TileChest $tile */
$tile = Tile::createFromItem(TileChest::class, $this->getLevel(), $this->asVector3(), $item);
$tile = TileFactory::createFromItem(TileChest::class, $this->getLevel(), $this->asVector3(), $item);
$this->level->addTile($tile);
if($pair instanceof TileChest){

4
src/pocketmine/block/EnchantingTable.php
View File

@ -31,7 +31,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\EnchantTable as TileEnchantingTable;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
class EnchantingTable extends Transparent{
@ -43,7 +43,7 @@ class EnchantingTable extends Transparent{
public function place(Item $item, Block $blockReplace, Block $blockClicked, int $face, Vector3 $clickVector, Player $player = null) : bool{
if(parent::place($item, $blockReplace, $blockClicked, $face, $clickVector, $player)){
$this->level->addTile(Tile::createFromItem(TileEnchantingTable::class, $this->getLevel(), $this->asVector3(), $item));
$this->level->addTile(TileFactory::createFromItem(TileEnchantingTable::class, $this->getLevel(), $this->asVector3(), $item));
return true;
}

4
src/pocketmine/block/EnderChest.php
View File

@ -30,7 +30,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\EnderChest as TileEnderChest;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
class EnderChest extends Chest{
@ -66,7 +66,7 @@ class EnderChest extends Chest{
}
if(Block::place($item, $blockReplace, $blockClicked, $face, $clickVector, $player)){
$this->level->addTile(Tile::createFromItem(TileEnderChest::class, $this->getLevel(), $this->asVector3(), $item));
$this->level->addTile(TileFactory::createFromItem(TileEnderChest::class, $this->getLevel(), $this->asVector3(), $item));
return true;
}

4
src/pocketmine/block/FlowerPot.php
View File

@ -29,7 +29,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\FlowerPot as TileFlowerPot;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
class FlowerPot extends Flowable{
@ -69,7 +69,7 @@ class FlowerPot extends Flowable{
}
if(parent::place($item, $blockReplace, $blockClicked, $face, $clickVector, $player)){
$this->level->addTile(Tile::createFromItem(TileFlowerPot::class, $this->getLevel(), $this->asVector3(), $item));
$this->level->addTile(TileFactory::createFromItem(TileFlowerPot::class, $this->getLevel(), $this->asVector3(), $item));
return true;
}

4
src/pocketmine/block/Furnace.php
View File

@ -30,7 +30,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\Furnace as TileFurnace;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
class Furnace extends Solid{
@ -100,7 +100,7 @@ class Furnace extends Solid{
$this->facing = Facing::opposite($player->getHorizontalFacing());
}
if(parent::place($item, $blockReplace, $blockClicked, $face, $clickVector, $player)){
$this->level->addTile(Tile::createFromItem(TileFurnace::class, $this->getLevel(), $this->asVector3(), $item));
$this->level->addTile(TileFactory::createFromItem(TileFurnace::class, $this->getLevel(), $this->asVector3(), $item));
return true;
}

4
src/pocketmine/block/ItemFrame.php
View File

@ -29,7 +29,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\ItemFrame as TileItemFrame;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
use function lcg_value;
class ItemFrame extends Flowable{
@ -87,7 +87,7 @@ class ItemFrame extends Flowable{
$this->facing = $face;
if(parent::place($item, $blockReplace, $blockClicked, $face, $clickVector, $player)){
$this->level->addTile(Tile::createFromItem(TileItemFrame::class, $this->getLevel(), $this->asVector3(), $item));
$this->level->addTile(TileFactory::createFromItem(TileItemFrame::class, $this->getLevel(), $this->asVector3(), $item));
return true;
}

4
src/pocketmine/block/SignPost.php
View File

@ -29,7 +29,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\Sign as TileSign;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
use function floor;
class SignPost extends Transparent{
@ -84,7 +84,7 @@ class SignPost extends Transparent{
}
if($ret){
$this->level->addTile(Tile::createFromItem(TileSign::class, $this->getLevel(), $this->asVector3(), $item));
$this->level->addTile(TileFactory::createFromItem(TileSign::class, $this->getLevel(), $this->asVector3(), $item));
return true;
}
}

4
src/pocketmine/block/Skull.php
View File

@ -31,7 +31,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\Skull as TileSkull;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
use function floor;
class Skull extends Flowable{
@ -73,7 +73,7 @@ class Skull extends Flowable{
public function writeStateToWorld() : void{
parent::writeStateToWorld();
/** @var TileSkull $tile */
$tile = Tile::create(TileSkull::class, $this->getLevel(), $this->asVector3());
$tile = TileFactory::create(TileSkull::class, $this->getLevel(), $this->asVector3());
$tile->setRotation($this->rotation);
$tile->setType($this->type);
$this->level->addTile($tile);

4
src/pocketmine/block/StandingBanner.php
View File

@ -31,7 +31,7 @@ use pocketmine\math\Facing;
use pocketmine\math\Vector3;
use pocketmine\Player;
use pocketmine\tile\Banner as TileBanner;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
use function floor;
class StandingBanner extends Transparent{
@ -85,7 +85,7 @@ class StandingBanner extends Transparent{
}
if($ret){
$this->level->addTile(Tile::createFromItem(TileBanner::class, $this->getLevel(), $this->asVector3(), $item));
$this->level->addTile(TileFactory::createFromItem(TileBanner::class, $this->getLevel(), $this->asVector3(), $item));
return true;
}
}

3
src/pocketmine/level/format/Chunk.php
View File

@ -34,6 +34,7 @@ use pocketmine\nbt\tag\CompoundTag;
use pocketmine\Player;
use pocketmine\tile\Spawnable;
use pocketmine\tile\Tile;
use pocketmine\tile\TileFactory;
use pocketmine\utils\BinaryStream;
use function array_fill;
use function array_filter;
@ -619,7 +620,7 @@ class Chunk{
$level->timings->syncChunkLoadTileEntitiesTimer->startTiming();
foreach($this->NBTtiles as $nbt){
if($nbt instanceof CompoundTag){
if(($tile = Tile::createFromData($level, $nbt)) !== null){
if(($tile = TileFactory::createFromData($level, $nbt)) !== null){
$level->addTile($tile);
}else{
$changed = true;

4
src/pocketmine/tile/Banner.php
View File

@ -113,7 +113,7 @@ class Banner extends Spawnable implements Nameable{
parent::__construct($level, $pos);
}
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
$this->baseColor = $nbt->getInt(self::TAG_BASE, $this->baseColor, true);
$this->patterns = $nbt->getListTag(self::TAG_PATTERNS) ?? $this->patterns;
$this->loadName($nbt);
@ -131,7 +131,7 @@ class Banner extends Spawnable implements Nameable{
$this->addNameSpawnData($nbt);
}
protected function copyDataFromItem(Item $item) : void{
public function copyDataFromItem(Item $item) : void{
parent::copyDataFromItem($item);
$this->copyNameFromItem($item);
if($item instanceof ItemBanner){

2
src/pocketmine/tile/Bed.php
View File

@ -39,7 +39,7 @@ class Bed extends Spawnable{
$this->onChanged();
}
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
$this->color = $nbt->getByte(self::TAG_COLOR, 14, true);
}

2
src/pocketmine/tile/Chest.php
View File

@ -56,7 +56,7 @@ class Chest extends Spawnable implements InventoryHolder, Container, Nameable{
parent::__construct($level, $pos);
}
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
if($nbt->hasTag(self::TAG_PAIRX, IntTag::class) and $nbt->hasTag(self::TAG_PAIRZ, IntTag::class)){
$this->pairX = $nbt->getInt(self::TAG_PAIRX);
$this->pairZ = $nbt->getInt(self::TAG_PAIRZ);

2
src/pocketmine/tile/EnchantTable.php
View File

@ -25,7 +25,7 @@ namespace pocketmine\tile;
class EnchantTable extends Spawnable implements Nameable{
use NameableTrait{
loadName as readSaveData;
loadName as public readSaveData;
saveName as writeSaveData;
}

2
src/pocketmine/tile/EnderChest.php
View File

@ -27,7 +27,7 @@ use pocketmine\nbt\tag\CompoundTag;
class EnderChest extends Spawnable{
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
}

2
src/pocketmine/tile/FlowerPot.php
View File

@ -43,7 +43,7 @@ class FlowerPot extends Spawnable{
parent::__construct($level, $pos);
}
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
if($nbt->hasTag(self::TAG_ITEM, ShortTag::class) and $nbt->hasTag(self::TAG_ITEM_DATA, IntTag::class)){
$this->item = ItemFactory::get($nbt->getShort(self::TAG_ITEM, 0), $nbt->getInt(self::TAG_ITEM_DATA, 0), 1);
}

2
src/pocketmine/tile/Furnace.php
View File

@ -68,7 +68,7 @@ class Furnace extends Spawnable implements InventoryHolder, Container, Nameable{
parent::__construct($level, $pos);
}
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
$this->burnTime = max(0, $nbt->getShort(self::TAG_BURN_TIME, $this->burnTime, true));
$this->cookTime = $nbt->getShort(self::TAG_COOK_TIME, $this->cookTime, true);

2
src/pocketmine/tile/ItemFrame.php
View File

@ -46,7 +46,7 @@ class ItemFrame extends Spawnable{
parent::__construct($level, $pos);
}
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
if(($itemTag = $nbt->getCompoundTag(self::TAG_ITEM)) !== null){
$this->item = Item::nbtDeserialize($itemTag);
}

2
src/pocketmine/tile/NameableTrait.php
View File

@ -86,7 +86,7 @@ trait NameableTrait{
* @param Item $item
* @see Tile::copyDataFromItem()
*/
protected function copyDataFromItem(Item $item) : void{
public function copyDataFromItem(Item $item) : void{
parent::copyDataFromItem($item);
if($item->hasCustomName()){ //this should take precedence over saved NBT
$this->setName($item->getCustomName());

2
src/pocketmine/tile/Sign.php
View File

@ -44,7 +44,7 @@ class Sign extends Spawnable{
/** @var string[] */
protected $text = ["", "", "", ""];
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
if($nbt->hasTag(self::TAG_TEXT_BLOB, StringTag::class)){ //MCPE 1.2 save format
$this->text = array_pad(explode("\n", $nbt->getString(self::TAG_TEXT_BLOB)), 4, "");
assert(count($this->text) === 4, "Too many lines!");

2
src/pocketmine/tile/Skull.php
View File

@ -43,7 +43,7 @@ class Skull extends Spawnable{
/** @var int */
private $skullRotation = 0;
protected function readSaveData(CompoundTag $nbt) : void{
public function readSaveData(CompoundTag $nbt) : void{
$this->skullType = $nbt->getByte(self::TAG_SKULL_TYPE, $this->skullType, true);
$this->skullRotation = $nbt->getByte(self::TAG_ROT, $this->skullRotation, true);
}

3
src/pocketmine/tile/Spawnable.php
View File

@ -29,6 +29,7 @@ use pocketmine\nbt\tag\StringTag;
use pocketmine\network\mcpe\NetworkLittleEndianNBTStream;
use pocketmine\network\mcpe\protocol\BlockEntityDataPacket;
use pocketmine\Player;
use function get_class;
abstract class Spawnable extends Tile{
/** @var string|null */
@ -108,7 +109,7 @@ abstract class Spawnable extends Tile{
*/
final public function getSpawnCompound() : CompoundTag{
$nbt = new CompoundTag("", [
new StringTag(self::TAG_ID, static::getSaveId()),
new StringTag(self::TAG_ID, TileFactory::getSaveId(get_class($this))), //TODO: disassociate network ID from save ID
new IntTag(self::TAG_X, $this->x),
new IntTag(self::TAG_Y, $this->y),
new IntTag(self::TAG_Z, $this->z)

151
src/pocketmine/tile/Tile.php
View File

@ -35,13 +35,7 @@ use pocketmine\math\Vector3;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\timings\Timings;
use pocketmine\timings\TimingsHandler;
use pocketmine\utils\Utils;
use function assert;
use function current;
use function get_class;
use function in_array;
use function is_a;
use function reset;
abstract class Tile extends Position{
@ -50,14 +44,6 @@ abstract class Tile extends Position{
public const TAG_Y = "y";
public const TAG_Z = "z";
/** @var string[] classes that extend Tile */
private static $knownTiles = [];
/** @var string[][] */
private static $saveNames = [];
/** @var string[] base class => overridden class */
private static $classMapping = [];
/** @var string */
public $name = "";
/** @var bool */
@ -65,140 +51,18 @@ abstract class Tile extends Position{
/** @var TimingsHandler */
protected $timings;
public static function init(){
self::register(Banner::class, ["Banner", "minecraft:banner"]);
self::register(Bed::class, ["Bed", "minecraft:bed"]);
self::register(Chest::class, ["Chest", "minecraft:chest"]);
self::register(EnchantTable::class, ["EnchantTable", "minecraft:enchanting_table"]);
self::register(EnderChest::class, ["EnderChest", "minecraft:ender_chest"]);
self::register(FlowerPot::class, ["FlowerPot", "minecraft:flower_pot"]);
self::register(Furnace::class, ["Furnace", "minecraft:furnace"]);
self::register(ItemFrame::class, ["ItemFrame"]); //this is an entity in PC
self::register(Sign::class, ["Sign", "minecraft:sign"]);
self::register(Skull::class, ["Skull", "minecraft:skull"]);
}
/**
* @param Level $level
* @param CompoundTag $nbt
*
* @return Tile|null
*/
public static function createFromData(Level $level, CompoundTag $nbt) : ?Tile{
$type = $nbt->getString(self::TAG_ID, "", true);
if(!isset(self::$knownTiles[$type])){
return null;
}
$class = self::$knownTiles[$type];
assert(is_a($class, Tile::class, true));
/**
* @var Tile $tile
* @see Tile::__construct()
*/
$tile = new $class($level, new Vector3($nbt->getInt(self::TAG_X), $nbt->getInt(self::TAG_Y), $nbt->getInt(self::TAG_Z)));
$tile->readSaveData($nbt);
return $tile;
}
/**
* @param string $baseClass
* @param Level $level
* @param Vector3 $pos
* @param Item $item
*
* @return Tile (instanceof $baseClass)
* @throws \InvalidArgumentException if the base class is not a registered tile
*/
public static function createFromItem(string $baseClass, Level $level, Vector3 $pos, Item $item) : Tile{
$tile = self::create($baseClass, $level, $pos);
$tile->copyDataFromItem($item);
return $tile;
}
/**
* @param string $className
* @param string[] $saveNames
*/
public static function register(string $className, array $saveNames = []) : void{
Utils::testValidInstance($className, Tile::class);
self::$classMapping[$className] = $className;
$shortName = (new \ReflectionClass($className))->getShortName();
if(!in_array($shortName, $saveNames, true)){
$saveNames[] = $shortName;
}
foreach($saveNames as $name){
self::$knownTiles[$name] = $className;
}
self::$saveNames[$className] = $saveNames;
}
/**
* @param string $baseClass Already-registered tile class to override
* @param string $newClass Class which extends the base class
*
* @throws \InvalidArgumentException if the base class is not a registered tile
*/
public static function override(string $baseClass, string $newClass) : void{
if(!isset(self::$classMapping[$baseClass])){
throw new \InvalidArgumentException("Class $baseClass is not a registered tile");
}
Utils::testValidInstance($newClass, $baseClass);
self::$classMapping[$baseClass] = $newClass;
}
/**
* @param string $baseClass
* @param Level $level
* @param Vector3 $pos
*
* @return Tile (will be an instanceof $baseClass)
* @throws \InvalidArgumentException if the specified class is not a registered tile
*/
public static function create(string $baseClass, Level $level, Vector3 $pos) : Tile{
if(isset(self::$classMapping[$baseClass])){
$class = self::$classMapping[$baseClass];
assert(is_a($class, $baseClass, true));
/**
* @var Tile $tile
* @see Tile::__construct()
*/
$tile = new $class($level, $pos);
return $tile;
}
throw new \InvalidArgumentException("Class $baseClass is not a registered tile");
}
/**
* Returns the short save name
* @return string
*/
public static function getSaveId() : string{
if(!isset(self::$saveNames[static::class])){
throw new \InvalidStateException("Tile is not registered");
}
reset(self::$saveNames[static::class]);
return current(self::$saveNames[static::class]);
}
public function __construct(Level $level, Vector3 $pos){
$this->timings = Timings::getTileEntityTimings($this);
parent::__construct($pos->getFloorX(), $pos->getFloorY(), $pos->getFloorZ(), $level);
}
/**
* @internal
* Reads additional data from the CompoundTag on tile creation.
*
* @param CompoundTag $nbt
*/
abstract protected function readSaveData(CompoundTag $nbt) : void;
abstract public function readSaveData(CompoundTag $nbt) : void;
/**
* Writes additional save data to a CompoundTag, not including generic things like ID and coordinates.
@ -209,7 +73,7 @@ abstract class Tile extends Position{
public function saveNBT() : CompoundTag{
$nbt = new CompoundTag();
$nbt->setString(self::TAG_ID, static::getSaveId());
$nbt->setString(self::TAG_ID, TileFactory::getSaveId(get_class($this)));
$nbt->setInt(self::TAG_X, $this->x);
$nbt->setInt(self::TAG_Y, $this->y);
$nbt->setInt(self::TAG_Z, $this->z);
@ -223,7 +87,14 @@ abstract class Tile extends Position{
return $tag->getCount() > 0 ? $tag : null;
}
protected function copyDataFromItem(Item $item) : void{
/**
* @internal
*
* @param Item $item
*
* @throws \RuntimeException
*/
public function copyDataFromItem(Item $item) : void{
if($item->hasCustomBlockData()){ //TODO: check item root tag (MCPE doesn't use BlockEntityTag)
$this->readSaveData($item->getCustomBlockData());
}

171
src/pocketmine/tile/TileFactory.php Normal file
View File

@ -0,0 +1,171 @@
<?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\tile;
use pocketmine\item\Item;
use pocketmine\level\Level;
use pocketmine\math\Vector3;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\utils\Utils;
use function assert;
use function in_array;
use function is_a;
use function reset;
final class TileFactory{
/** @var string[] classes that extend Tile */
private static $knownTiles = [];
/** @var string[][] */
private static $saveNames = [];
/** @var string[] base class => overridden class */
private static $classMapping = [];
private function __construct(){
//NOOP
}
public static function init(){
self::register(Banner::class, ["Banner", "minecraft:banner"]);
self::register(Bed::class, ["Bed", "minecraft:bed"]);
self::register(Chest::class, ["Chest", "minecraft:chest"]);
self::register(EnchantTable::class, ["EnchantTable", "minecraft:enchanting_table"]);
self::register(EnderChest::class, ["EnderChest", "minecraft:ender_chest"]);
self::register(FlowerPot::class, ["FlowerPot", "minecraft:flower_pot"]);
self::register(Furnace::class, ["Furnace", "minecraft:furnace"]);
self::register(ItemFrame::class, ["ItemFrame"]); //this is an entity in PC
self::register(Sign::class, ["Sign", "minecraft:sign"]);
self::register(Skull::class, ["Skull", "minecraft:skull"]);
}
/**
* @param string $className
* @param string[] $saveNames
*/
public static function register(string $className, array $saveNames = []) : void{
Utils::testValidInstance($className, Tile::class);
self::$classMapping[$className] = $className;
$shortName = (new \ReflectionClass($className))->getShortName();
if(!in_array($shortName, $saveNames, true)){
$saveNames[] = $shortName;
}
foreach($saveNames as $name){
self::$knownTiles[$name] = $className;
}
self::$saveNames[$className] = $saveNames;
}
/**
* @param string $baseClass Already-registered tile class to override
* @param string $newClass Class which extends the base class
*
* @throws \InvalidArgumentException if the base class is not a registered tile
*/
public static function override(string $baseClass, string $newClass) : void{
if(!isset(self::$classMapping[$baseClass])){
throw new \InvalidArgumentException("Class $baseClass is not a registered tile");
}
Utils::testValidInstance($newClass, $baseClass);
self::$classMapping[$baseClass] = $newClass;
}
/**
* @param string $baseClass
* @param Level $level
* @param Vector3 $pos
*
* @return Tile (will be an instanceof $baseClass)
* @throws \InvalidArgumentException if the specified class is not a registered tile
*/
public static function create(string $baseClass, Level $level, Vector3 $pos) : Tile{
if(isset(self::$classMapping[$baseClass])){
$class = self::$classMapping[$baseClass];
assert(is_a($class, $baseClass, true));
/**
* @var Tile $tile
* @see Tile::__construct()
*/
$tile = new $class($level, $pos);
return $tile;
}
throw new \InvalidArgumentException("Class $baseClass is not a registered tile");
}
/**
* @internal
*
* @param string $baseClass
* @param Level $level
* @param Vector3 $pos
* @param Item $item
*
* @return Tile (instanceof $baseClass)
* @throws \InvalidArgumentException if the base class is not a registered tile
*/
public static function createFromItem(string $baseClass, Level $level, Vector3 $pos, Item $item) : Tile{
$tile = self::create($baseClass, $level, $pos);
$tile->copyDataFromItem($item);
return $tile;
}
/**
* @internal
*
* @param Level $level
* @param CompoundTag $nbt
*
* @return Tile|null
*/
public static function createFromData(Level $level, CompoundTag $nbt) : ?Tile{
$type = $nbt->getString(Tile::TAG_ID, "", true);
if(!isset(self::$knownTiles[$type])){
return null;
}
$class = self::$knownTiles[$type];
assert(is_a($class, Tile::class, true));
/**
* @var Tile $tile
* @see Tile::__construct()
*/
$tile = new $class($level, new Vector3($nbt->getInt(Tile::TAG_X), $nbt->getInt(Tile::TAG_Y), $nbt->getInt(Tile::TAG_Z)));
$tile->readSaveData($nbt);
return $tile;
}
public static function getSaveId(string $class) : string{
if(isset(self::$saveNames[$class])){
return reset(self::$saveNames[$class]);
}
throw new \InvalidArgumentException("Tile $class is not registered");
}
}