PocketMine-MP 5.15.1 git-fb9a74e8799c71ed8292cfa53abe7a4c9204629d
pocketmine\block\tile\Cauldron Class Reference
+ Inheritance diagram for pocketmine\block\tile\Cauldron:
+ Collaboration diagram for pocketmine\block\tile\Cauldron:

Public Member Functions

 clearSpawnCompoundCache ()
 
 close ()
 
 copyDataFromItem (Item $item)
 
 getBlock ()
 
 getCleanedNBT ()
 
 getCustomWaterColor ()
 
 getPosition ()
 
 getPotionItem ()
 
 getRenderUpdateBugWorkaroundStateProperties (Block $block)
 
 getSerializedSpawnCompound ()
 
 getSpawnCompound ()
 
 isClosed ()
 
 isDirty ()
 
 onBlockDestroyed ()
 
 readSaveData (CompoundTag $nbt)
 
 saveNBT ()
 
 setCustomWaterColor (?Color $customWaterColor)
 
 setDirty (bool $dirty=true)
 
 setPotionItem (?Item $potionItem)
 

Public Attributes

bool $closed = false
 
const TAG_ID = "id"
 
const TAG_X = "x"
 
const TAG_Y = "y"
 
const TAG_Z = "z"
 

Protected Member Functions

 addAdditionalSpawnData (CompoundTag $nbt)
 
 onBlockDestroyedHook ()
 
 writeSaveData (CompoundTag $nbt)
 

Protected Attributes

Position $position
 
TimingsHandler $timings
 

Detailed Description

Definition at line 42 of file tile/Cauldron.php.

Member Function Documentation

◆ addAdditionalSpawnData()

pocketmine\block\tile\Cauldron::addAdditionalSpawnData ( CompoundTag  $nbt)
protected

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

Reimplemented from pocketmine\block\tile\Spawnable.

Definition at line 70 of file tile/Cauldron.php.

◆ clearSpawnCompoundCache()

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

Definition at line 52 of file Spawnable.php.

◆ close()

pocketmine\block\tile\Tile::close ( )
inherited

Definition at line 129 of file Tile.php.

◆ copyDataFromItem()

pocketmine\block\tile\Tile::copyDataFromItem ( Item  $item)
inherited

Definition at line 92 of file Tile.php.

◆ getBlock()

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

Definition at line 98 of file Tile.php.

◆ getCleanedNBT()

pocketmine\block\tile\Tile::getCleanedNBT ( )
inherited

Definition at line 82 of file Tile.php.

◆ getCustomWaterColor()

pocketmine\block\tile\Cauldron::getCustomWaterColor ( )

Definition at line 64 of file tile/Cauldron.php.

◆ getPosition()

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

Definition at line 102 of file Tile.php.

◆ getPotionItem()

pocketmine\block\tile\Cauldron::getPotionItem ( )

Definition at line 58 of file tile/Cauldron.php.

◆ getRenderUpdateBugWorkaroundStateProperties()

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

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 from pocketmine\block\tile\Spawnable.

Definition at line 127 of file tile/Cauldron.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\Tile::onBlockDestroyedHook ( )
protectedinherited

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

Reimplemented in pocketmine\block\tile\Chest, pocketmine\block\tile\Jukebox, and pocketmine\block\tile\ShulkerBox.

Definition at line 125 of file Tile.php.

◆ readSaveData()

pocketmine\block\tile\Cauldron::readSaveData ( CompoundTag  $nbt)

Reimplemented from pocketmine\block\tile\Tile.

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

◆ saveNBT()

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

Definition at line 70 of file Tile.php.

◆ setCustomWaterColor()

pocketmine\block\tile\Cauldron::setCustomWaterColor ( ?Color  $customWaterColor)

Definition at line 66 of file tile/Cauldron.php.

◆ setDirty()

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

Definition at line 48 of file Spawnable.php.

◆ setPotionItem()

pocketmine\block\tile\Cauldron::setPotionItem ( ?Item  $potionItem)

Definition at line 60 of file tile/Cauldron.php.

◆ writeSaveData()

pocketmine\block\tile\Cauldron::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 109 of file tile/Cauldron.php.

Member Data Documentation

◆ $closed

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

Definition at line 50 of file Tile.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_ID

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

Definition at line 44 of file Tile.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: