ItemFrame
extends Spawnable
in package
Tags
Table of Contents
- TAG_ID = "id"
- TAG_ITEM = "Item"
- TAG_ITEM_DROP_CHANCE = "ItemDropChance"
- TAG_ITEM_ROTATION = "ItemRotation"
- TAG_X = "x"
- TAG_Y = "y"
- TAG_Z = "z"
- $closed : bool
- $position : Position
- $timings : TimingsHandler
- $dirty : bool
- $item : Item
- $itemDropChance : float
- $itemRotation : int
- $spawnCompoundCache : CacheableNbt|null
- __construct() : mixed
- __destruct() : mixed
- close() : void
- getBlock() : Block
- getCleanedNBT() : CompoundTag|null
- getItem() : Item
- getItemDropChance() : float
- getItemRotation() : int
- getPosition() : Position
- 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
- hasItem() : 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
- setItem() : void
- setItemDropChance() : void
- setItemRotation() : void
- addAdditionalSpawnData() : void
- An extension to getSpawnCompound() for further modifying the generic tile NBT.
- onBlockDestroyedHook() : void
- Override this method to do actions you need to do when this tile is destroyed due to block being broken.
- writeSaveData() : void
Constants
TAG_ID
public
mixed
TAG_ID
= "id"
TAG_ITEM
public
mixed
TAG_ITEM
= "Item"
TAG_ITEM_DROP_CHANCE
public
mixed
TAG_ITEM_DROP_CHANCE
= "ItemDropChance"
TAG_ITEM_ROTATION
public
mixed
TAG_ITEM_ROTATION
= "ItemRotation"
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
$position
protected
Position
$position
$timings
protected
TimingsHandler
$timings
$dirty
private
bool
$dirty
= true
$item
private
Item
$item
$itemDropChance
private
float
$itemDropChance
= 1.0
$itemRotation
private
int
$itemRotation
= 0
$spawnCompoundCache
private
CacheableNbt|null
$spawnCompoundCache
= null
Tags
Methods
__construct()
public
__construct(World $world, Vector3 $pos) : mixed
Parameters
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —close()
public
close() : void
Return values
void —getBlock()
public
getBlock() : Block
Return values
Block —getCleanedNBT()
public
getCleanedNBT() : CompoundTag|null
Return values
CompoundTag|null —getItem()
public
getItem() : Item
Return values
Item —getItemDropChance()
public
getItemDropChance() : float
Return values
float —getItemRotation()
public
getItemRotation() : int
Return values
int —getPosition()
public
getPosition() : Position
Return values
Position —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
Return values
CacheableNbt —getSpawnCompound()
public
final getSpawnCompound() : CompoundTag
Return values
CompoundTag —hasItem()
public
hasItem() : bool
Return values
bool —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 —readSaveData()
public
readSaveData(CompoundTag $nbt) : void
Parameters
- $nbt : CompoundTag
Return values
void —saveNBT()
public
saveNBT() : CompoundTag
Return values
CompoundTag —setDirty()
public
setDirty([bool $dirty = true ]) : void
Parameters
- $dirty : bool = true
Return values
void —setItem()
public
setItem(Item|null $item) : void
Parameters
- $item : Item|null
Return values
void —setItemDropChance()
public
setItemDropChance(float $chance) : void
Parameters
- $chance : float
Return values
void —setItemRotation()
public
setItemRotation(int $rotation) : void
Parameters
- $rotation : int
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()
Override this method to do actions you need to do when this tile is destroyed due to block being broken.
protected
onBlockDestroyedHook() : void
Return values
void —writeSaveData()
protected
writeSaveData(CompoundTag $nbt) : void
Parameters
- $nbt : CompoundTag