Documentation

ShulkerBox extends Spawnable
in package
implements Container, Nameable Uses NameableTrait, ContainerTrait

Interfaces, Classes, Traits and Enums

Container
Nameable

Table of Contents

TAG_FACING  = "facing"
TAG_ID  = "id"
TAG_X  = "x"
TAG_Y  = "y"
TAG_Z  = "z"
$closed  : bool
$facing  : int
$inventory  : ShulkerBoxInventory
$position  : Position
$timings  : TimingsHandler
$customName  : string|null
$dirty  : bool
$lock  : string|null
$spawnCompoundCache  : CacheableNbt|null
__construct()  : mixed
__destruct()  : mixed
canOpenWith()  : bool
close()  : void
copyDataFromItem()  : void
getBlock()  : Block
getCleanedNBT()  : CompoundTag|null
getDefaultName()  : string
getFacing()  : int
getInventory()  : ShulkerBoxInventory
getName()  : string
getPosition()  : Position
getRealInventory()  : ShulkerBoxInventory
getSerializedSpawnCompound()  : CacheableNbt
Returns encoded NBT (varint, little-endian) used to spawn this tile to clients. Uses cache where possible, populates cache if it is null.
getSpawnCompound()  : CompoundTag
hasName()  : bool
isClosed()  : bool
isDirty()  : bool
Returns whether the tile needs to be respawned to viewers.
onBlockDestroyed()  : void
Called when the tile's block is destroyed.
readSaveData()  : void
saveNBT()  : CompoundTag
setDirty()  : void
setFacing()  : void
setName()  : void
addAdditionalSpawnData()  : void
An extension to getSpawnCompound() for further modifying the generic tile NBT.
loadItems()  : void
loadName()  : void
onBlockDestroyedHook()  : void
saveItems()  : void
saveName()  : void
writeSaveData()  : void

Constants

TAG_ID

public mixed TAG_ID = "id"

TAG_X

public mixed TAG_X = "x"

TAG_Y

public mixed TAG_Y = "y"

TAG_Z

public mixed TAG_Z = "z"

Properties

$closed

public bool $closed = false

$facing

protected int $facing = \pocketmine\math\Facing::NORTH

$spawnCompoundCache

private CacheableNbt|null $spawnCompoundCache = null
Tags
phpstan-var

CacheableNbt<\pocketmine\nbt\tag\CompoundTag>|null

Methods

__destruct()

public __destruct() : mixed
Return values
mixed —

close()

public close() : void
Return values
void —

copyDataFromItem()

public copyDataFromItem(Item $item) : void
Parameters
$item : Item
Return values
void —

getDefaultName()

public getDefaultName() : string
Return values
string —

getFacing()

public getFacing() : int
Return values
int —

getName()

public getName() : string
Return values
string —

getSerializedSpawnCompound()

Returns encoded NBT (varint, little-endian) used to spawn this tile to clients. Uses cache where possible, populates cache if it is null.

public final getSerializedSpawnCompound() : CacheableNbt
Tags
phpstan-return

CacheableNbt<\pocketmine\nbt\tag\CompoundTag>

Return values
CacheableNbt —

isClosed()

public isClosed() : bool
Return values
bool —

isDirty()

Returns whether the tile needs to be respawned to viewers.

public isDirty() : bool
Return values
bool —

onBlockDestroyed()

Called when the tile's block is destroyed.

public final onBlockDestroyed() : void
Return values
void —

setDirty()

public setDirty([bool $dirty = true ]) : void
Parameters
$dirty : bool = true
Return values
void —

setFacing()

public setFacing(int $facing) : void
Parameters
$facing : int
Return values
void —

setName()

public setName(string $name) : void
Parameters
$name : string
Return values
void —

addAdditionalSpawnData()

An extension to getSpawnCompound() for further modifying the generic tile NBT.

protected addAdditionalSpawnData(CompoundTag $nbt) : void
Parameters
$nbt : CompoundTag
Return values
void —

onBlockDestroyedHook()

protected onBlockDestroyedHook() : void
Return values
void —

Search results