Sign Class Reference

Public Member Functions
	__construct (Level $level, CompoundTag $nbt)
	saveNBT ()
	setText ($line1="", $line2="", $line3="", $line4="")
	getText ()
	getSpawnCompound ()
	updateCompoundTag (CompoundTag $nbt, Player $player)
Public Member Functions inherited from Spawnable
	spawnTo (Player $player)
	__construct (Level $level, CompoundTag $nbt)
	spawnToAll ()
	getSpawnCompound ()
	updateCompoundTag (CompoundTag $nbt, Player $player)
Public Member Functions inherited from Tile
	getSaveId ()
	__construct (Level $level, CompoundTag $nbt)
	getId ()
	saveNBT ()
	getBlock ()
	onUpdate ()
	scheduleUpdate ()
	__destruct ()
	close ()
	getName ()
Public Member Functions inherited from Position
	__construct ($x=0, $y=0, $z=0, Level $level=null)
	asPosition ()
	add ($x, $y=0, $z=0)
	getLevel ()
	setLevel (Level $level=null)
	isValid ()
	getSide ($side, $step=1)
	__toString ()
	setComponents ($x, $y, $z)
	fromObjectAdd (Vector3 $pos, $x, $y, $z)
Public Member Functions inherited from Vector3
	__construct ($x=0, $y=0, $z=0)
	getX ()
	getY ()
	getZ ()
	getFloorX ()
	getFloorY ()
	getFloorZ ()
	getRight ()
	getUp ()
	getForward ()
	getSouth ()
	getWest ()
	add ($x, $y=0, $z=0)
	subtract ($x=0, $y=0, $z=0)
	multiply ($number)
	divide ($number)
	ceil ()
	floor ()
	round ()
	abs ()
	getSide ($side, $step=1)
	asVector3 ()
	distance (Vector3 $pos)
	distanceSquared (Vector3 $pos)
	maxPlainDistance ($x=0, $z=0)
	length ()
	lengthSquared ()
	normalize ()
	dot (Vector3 $v)
	cross (Vector3 $v)
	equals (Vector3 $v)
	getIntermediateWithXValue (Vector3 $v, $x)
	getIntermediateWithYValue (Vector3 $v, $y)
	getIntermediateWithZValue (Vector3 $v, $z)
	setComponents ($x, $y, $z)
	fromObjectAdd (Vector3 $pos, $x, $y, $z)
	__toString ()

Additional Inherited Members
Static Public Member Functions inherited from Tile
static	init ()
static	createTile ($type, Level $level, CompoundTag $nbt,... $args)
static	registerTile ($className)
Static Public Member Functions inherited from Position
static	fromObject (Vector3 $pos, Level $level=null)
Static Public Member Functions inherited from Vector3
static	getOppositeSide ($side)
static	createRandomDirection (Random $random)
Data Fields inherited from Tile
const	BREWING_STAND = "BrewingStand"
const	CHEST = "Chest"
const	DL_DETECTOR = "DayLightDetector"
const	ENCHANT_TABLE = "EnchantTable"
const	FLOWER_POT = "FlowerPot"
const	FURNACE = "Furnace"
const	MOB_SPAWNER = "MobSpawner"
const	SIGN = "Sign"
const	SKULL = "Skull"
const	ITEM_FRAME = "ItemFrame"
const	DISPENSER = "Dispenser"
const	DROPPER = "Dropper"
const	CAULDRON = "Cauldron"
const	HOPPER = "Hopper"
const	BEACON = "Beacon"
const	ENDER_CHEST = "EnderChest"
const	BED = "Bed"
const	DAY_LIGHT_DETECTOR = "DLDetector"
	$chunk
	$name
	$id
	$x
	$y
	$z
	$attach
	$metadata
	$closed = false
	$namedtag
	$tickTimer
Data Fields inherited from Position
	$level = null
Data Fields inherited from Vector3
const	SIDE_DOWN = 0
const	SIDE_UP = 1
const	SIDE_NORTH = 2
const	SIDE_SOUTH = 3
const	SIDE_WEST = 4
const	SIDE_EAST = 5
	$x
	$y
	$z
Static Public Attributes inherited from Tile
static	$tileCount = 1
Protected Member Functions inherited from Spawnable
	onChanged ()
Protected Attributes inherited from Tile
	$lastUpdate
	$server
	$timings

Constructor & Destructor Documentation

__construct()

__construct	(	Level	$level,
		CompoundTag	$nbt
	)

Sign constructor.

Parameters

Level	$level
CompoundTag	$nbt

                                                               {
        if(!isset($nbt->Text1)){
            $nbt->Text1 = new StringTag("Text1", "");
        }
        if(!isset($nbt->Text2) or !($nbt->Text2 instanceof StringTag)){
            $nbt->Text2 = new StringTag("Text2", "");
        }
        if(!isset($nbt->Text3) or !($nbt->Text3 instanceof StringTag)){
            $nbt->Text3 = new StringTag("Text3", "");
        }
        if(!isset($nbt->Text4) or !($nbt->Text4 instanceof StringTag)){
            $nbt->Text4 = new StringTag("Text4", "");
        }

        parent::__construct($level, $nbt);
    }

Member Function Documentation

getSpawnCompound()

getSpawnCompound

(

)

Returns

CompoundTag

                                      {
        return new CompoundTag("", [
            new StringTag("id", Tile::SIGN),
            $this->namedtag->Text1,
            $this->namedtag->Text2,
            $this->namedtag->Text3,
            $this->namedtag->Text4,
            new IntTag("x", (int) $this->x),
            new IntTag("y", (int) $this->y),
            new IntTag("z", (int) $this->z)
        ]);
    }

getText()

getText

(

)

Returns

array

                             {
        return [
            $this->namedtag["Text1"],
            $this->namedtag["Text2"],
            $this->namedtag["Text3"],
            $this->namedtag["Text4"]
        ];
    }

saveNBT()

saveNBT

(

)

                             {
        parent::saveNBT();
        unset($this->namedtag->Creator);
    }

setText()

setText	(		$line1 = "",
			$line2 = "",
			$line3 = "",
			$line4 = ""
	)

Parameters

string	$line1
string	$line2
string	$line3
string	$line4

Returns

bool

                                                                               {
        $this->namedtag->Text1 = new StringTag("Text1", $line1);
        $this->namedtag->Text2 = new StringTag("Text2", $line2);
        $this->namedtag->Text3 = new StringTag("Text3", $line3);
        $this->namedtag->Text4 = new StringTag("Text4", $line4);
        $this->onChanged();

        return true;
    }

updateCompoundTag()

updateCompoundTag	(	CompoundTag	$nbt,
		Player	$player
	)

Parameters

CompoundTag	$nbt
Player	$player

Returns

bool

                                                                        : bool{
        if($nbt["id"] !== Tile::SIGN){
            return false;
        }

        $ev = new SignChangeEvent($this->getBlock(), $player, [
            TextFormat::clean($nbt["Text1"], ($removeFormat = $player->getRemoveFormat())),
            TextFormat::clean($nbt["Text2"], $removeFormat),
            TextFormat::clean($nbt["Text3"], $removeFormat),
            TextFormat::clean($nbt["Text4"], $removeFormat)
        ]);

        if(!isset($this->namedtag->Creator) or $this->namedtag["Creator"] !== $player->getRawUniqueId()){
            $ev->setCancelled();
        }

        $this->level->getServer()->getPluginManager()->callEvent($ev);

        if(!$ev->isCancelled()){
            $this->setText(...$ev->getLines());
            return true;
        }else{
            return false;
        }
    }

---

The documentation for this class was generated from the following file:

• src/pocketmine/tile/Sign.php