NameableTrait.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\item\Item;
use pocketmine\nbt\tag\CompoundTag;
use pocketmine\nbt\tag\StringTag;
 
trait NameableTrait{
    private $customName = null;
 
    abstract public function getDefaultName() : string;
 
    public function getName() : string{
        return $this->customName ?? $this->getDefaultName();
    }
 
    public function setName(string $name) : void{
        if($name === ""){
            $this->customName = null;
        }else{
            $this->customName = $name;
        }
    }
 
    public function hasName() : bool{
        return $this->customName !== null;
    }
 
    public function addAdditionalSpawnData(CompoundTag $nbt) : void{
        if($this->customName !== null){
            $nbt->setString(Nameable::TAG_CUSTOM_NAME, $this->customName);
        }
    }
 
    protected function loadName(CompoundTag $tag) : void{
        if(($customNameTag = $tag->getTag(Nameable::TAG_CUSTOM_NAME)) instanceof StringTag){
            $this->customName = $customNameTag->getValue();
        }
    }
 
    protected function saveName(CompoundTag $tag) : void{
        if($this->customName !== null){
            $tag->setString(Nameable::TAG_CUSTOM_NAME, $this->customName);
        }
    }
 
    public function copyDataFromItem(Item $item) : void{
        parent::copyDataFromItem($item);
        if($item->hasCustomName()){ //this should take precedence over saved NBT
            $this->setName($item->getCustomName());
        }
    }
}