pocketmine\block\tile\ShulkerBox Class Reference

Inheritance diagram for pocketmine\block\tile\ShulkerBox:

Collaboration diagram for pocketmine\block\tile\ShulkerBox:

Public Member Functions
	__construct (World $world, Vector3 $pos)
	canOpenWith (string $key)
	clearSpawnCompoundCache ()
	close ()
	copyDataFromItem (Item $item)
	getBlock ()
	getCleanedNBT ()
	getDefaultName ()
	getFacing ()
	getInventory ()
	getName ()
	getPosition ()
	getRealInventory ()
	getRenderUpdateBugWorkaroundStateProperties (Block $block)
	getSerializedSpawnCompound ()
	getSpawnCompound ()
	hasName ()
	isClosed ()
	isDirty ()
	onBlockDestroyed ()
	readSaveData (CompoundTag $nbt)
	saveNBT ()
	setDirty (bool $dirty=true)
	setFacing (int $facing)
	setName (string $str)

Public Attributes
bool	$closed = false
const	TAG_CUSTOM_NAME = "CustomName"
const	TAG_FACING = "facing"
const	TAG_ID = "id"
const	TAG_ITEMS = "Items"
const	TAG_LOCK = "Lock"
const	TAG_X = "x"
const	TAG_Y = "y"
const	TAG_Z = "z"

Protected Member Functions
	addAdditionalSpawnData (CompoundTag $nbt)
	onBlockDestroyedHook ()
	writeSaveData (CompoundTag $nbt)

Protected Attributes
int	$facing = Facing::NORTH
ShulkerBoxInventory	$inventory
Position	$position
TimingsHandler	$timings

Detailed Description

Definition at line 33 of file tile/ShulkerBox.php.

Constructor & Destructor Documentation

__construct()

pocketmine\block\tile\ShulkerBox::__construct	(	World	$world,
		Vector3	$pos )

Reimplemented from pocketmine\block\tile\Tile.

Definition at line 45 of file tile/ShulkerBox.php.

Member Function Documentation

addAdditionalSpawnData()

pocketmine\block\tile\ShulkerBox::addAdditionalSpawnData ( CompoundTag $nbt )

protected

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

Reimplemented from pocketmine\block\tile\Spawnable.

Definition at line 108 of file tile/ShulkerBox.php.

canOpenWith()

pocketmine\block\tile\Container::canOpenWith ( string $key )

inherited

Returns whether this container can be opened by an item with the given custom name.

clearSpawnCompoundCache()

pocketmine\block\tile\Spawnable::clearSpawnCompoundCache ( )

inherited

Definition at line 52 of file Spawnable.php.

close()

pocketmine\block\tile\ShulkerBox::close

(

)

Reimplemented from pocketmine\block\tile\Tile.

Definition at line 69 of file tile/ShulkerBox.php.

copyDataFromItem()

pocketmine\block\tile\ShulkerBox::copyDataFromItem

(

Item

$item

)

Reimplemented from pocketmine\block\tile\Tile.

Definition at line 62 of file tile/ShulkerBox.php.

getBlock()

pocketmine\block\tile\Tile::getBlock ( )

inherited

Definition at line 98 of file Tile.php.

getCleanedNBT()

pocketmine\block\tile\ShulkerBox::getCleanedNBT

(

)

Reimplemented from pocketmine\block\tile\Tile.

Definition at line 80 of file tile/ShulkerBox.php.

getDefaultName()

pocketmine\block\tile\ShulkerBox::getDefaultName

(

)

Implements pocketmine\block\tile\Nameable.

Definition at line 104 of file tile/ShulkerBox.php.

getFacing()

pocketmine\block\tile\ShulkerBox::getFacing

(

)

Definition at line 88 of file tile/ShulkerBox.php.

getInventory()

pocketmine\block\tile\ShulkerBox::getInventory

(

)

Implements pocketmine\inventory\InventoryHolder.

Definition at line 96 of file tile/ShulkerBox.php.

getPosition()

pocketmine\block\tile\Tile::getPosition ( )

inherited

Definition at line 102 of file Tile.php.

getRealInventory()

pocketmine\block\tile\ShulkerBox::getRealInventory

(

)

Implements pocketmine\block\tile\Container.

Definition at line 100 of file tile/ShulkerBox.php.

getRenderUpdateBugWorkaroundStateProperties()

pocketmine\block\tile\Spawnable::getRenderUpdateBugWorkaroundStateProperties ( Block $block )

inherited

The Bedrock client won't re-render a block if the block's state properties didn't change. This is a problem when the tile may affect the block's appearance. For example, a cauldron's liquid changes colour based on the dye inside.

This is worked around in vanilla by modifying one of the block's state properties to a different value, and then changing it back again. Since we don't want to litter core implementation with hacks like this, we brush it under the rug into Tile.

Returns

ByteTag[]|IntTag[]|StringTag[] @phpstan-return array<string, IntTag|StringTag|ByteTag>

Reimplemented in pocketmine\block\tile\Cauldron, and pocketmine\block\tile\FlowerPot.

Definition at line 68 of file Spawnable.php.

getSerializedSpawnCompound()

pocketmine\block\tile\Spawnable::getSerializedSpawnCompound ( )

finalinherited

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>

Definition at line 78 of file Spawnable.php.

getSpawnCompound()

pocketmine\block\tile\Spawnable::getSpawnCompound ( )

finalinherited

Definition at line 86 of file Spawnable.php.

isClosed()

pocketmine\block\tile\Tile::isClosed ( )

inherited

Definition at line 106 of file Tile.php.

isDirty()

pocketmine\block\tile\Spawnable::isDirty ( )

inherited

Deprecated

Definition at line 41 of file Spawnable.php.

onBlockDestroyed()

pocketmine\block\tile\Tile::onBlockDestroyed ( )

finalinherited

Called when the tile's block is destroyed.

Definition at line 117 of file Tile.php.

References pocketmine\block\tile\onBlockDestroyedHook().

Here is the call graph for this function:

onBlockDestroyedHook()

pocketmine\block\tile\ShulkerBox::onBlockDestroyedHook ( )

protected

Override this method to do actions you need to do when this tile is destroyed due to block being broken.

Reimplemented from pocketmine\block\tile\Tile.

Definition at line 76 of file tile/ShulkerBox.php.

References pocketmine\nbt\tag\CompoundTag\removeTag().

Here is the call graph for this function:

readSaveData()

pocketmine\block\tile\ShulkerBox::readSaveData

(

CompoundTag

$nbt

)

Reimplemented from pocketmine\block\tile\Tile.

Definition at line 50 of file tile/ShulkerBox.php.

saveNBT()

pocketmine\block\tile\Tile::saveNBT ( )

inherited

Definition at line 70 of file Tile.php.

setDirty()

pocketmine\block\tile\Spawnable::setDirty ( bool $dirty = true )

inherited

Deprecated

Definition at line 48 of file Spawnable.php.

setFacing()

pocketmine\block\tile\ShulkerBox::setFacing

(

int

$facing

)

Definition at line 92 of file tile/ShulkerBox.php.

writeSaveData()

pocketmine\block\tile\ShulkerBox::writeSaveData ( CompoundTag $nbt )

protected

Writes additional save data to a CompoundTag, not including generic things like ID and coordinates.

Reimplemented from pocketmine\block\tile\Tile.

Definition at line 56 of file tile/ShulkerBox.php.

Member Data Documentation

$closed

bool pocketmine\block\tile\Tile::$closed = false

inherited

Definition at line 50 of file Tile.php.

$facing

int pocketmine\block\tile\ShulkerBox::$facing = Facing::NORTH

protected

Definition at line 41 of file tile/ShulkerBox.php.

$inventory

ShulkerBoxInventory pocketmine\block\tile\ShulkerBox::$inventory

protected

Definition at line 43 of file tile/ShulkerBox.php.

$position

Position pocketmine\block\tile\Tile::$position

protectedinherited

Definition at line 49 of file Tile.php.

$timings

TimingsHandler pocketmine\block\tile\Tile::$timings

protectedinherited

Definition at line 51 of file Tile.php.

TAG_CUSTOM_NAME

const pocketmine\block\tile\Nameable::TAG_CUSTOM_NAME = "CustomName"

inherited

Definition at line 27 of file Nameable.php.

TAG_FACING

const pocketmine\block\tile\ShulkerBox::TAG_FACING = "facing"

Definition at line 39 of file tile/ShulkerBox.php.

TAG_ID

const pocketmine\block\tile\Tile::TAG_ID = "id"

inherited

Definition at line 44 of file Tile.php.

TAG_ITEMS

const pocketmine\block\tile\Container::TAG_ITEMS = "Items"

inherited

Definition at line 30 of file Container.php.

TAG_LOCK

const pocketmine\block\tile\Container::TAG_LOCK = "Lock"

inherited

Definition at line 31 of file Container.php.

TAG_X

const pocketmine\block\tile\Tile::TAG_X = "x"

inherited

Definition at line 45 of file Tile.php.

TAG_Y

const pocketmine\block\tile\Tile::TAG_Y = "y"

inherited

Definition at line 46 of file Tile.php.

TAG_Z

const pocketmine\block\tile\Tile::TAG_Z = "z"

inherited

Definition at line 47 of file Tile.php.

---

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

• tile/ShulkerBox.php