Banner
extends Spawnable
in package
Tags
Table of Contents
- TAG_BASE = "Base"
- TAG_ID = "id"
- TAG_PATTERN_COLOR = "Color"
- TAG_PATTERN_NAME = "Pattern"
- TAG_PATTERNS = "Patterns"
- TAG_X = "x"
- TAG_Y = "y"
- TAG_Z = "z"
- $closed : bool
- $position : Position
- $timings : TimingsHandler
- $baseColor : DyeColor
- $dirty : bool
- $patterns : array<string|int, BannerPatternLayer>
- $spawnCompoundCache : CacheableNbt|null
- __construct() : mixed
- __destruct() : mixed
- close() : void
- getBaseColor() : DyeColor
- Returns the color of the banner base.
- getBlock() : Block
- getCleanedNBT() : CompoundTag|null
- getDefaultName() : string
- getPatterns() : array<string|int, BannerPatternLayer>
- 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
- 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
- setBaseColor() : void
- Sets the color of the banner base.
- setDirty() : void
- setPatterns() : 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_BASE
public
mixed
TAG_BASE
= "Base"
TAG_ID
public
mixed
TAG_ID
= "id"
TAG_PATTERN_COLOR
public
mixed
TAG_PATTERN_COLOR
= "Color"
TAG_PATTERN_NAME
public
mixed
TAG_PATTERN_NAME
= "Pattern"
TAG_PATTERNS
public
mixed
TAG_PATTERNS
= "Patterns"
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
$baseColor
private
DyeColor
$baseColor
$dirty
private
bool
$dirty
= true
$patterns
private
array<string|int, BannerPatternLayer>
$patterns
= []
Tags
$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 —getBaseColor()
Returns the color of the banner base.
public
getBaseColor() : DyeColor
Return values
DyeColor —getBlock()
public
getBlock() : Block
Return values
Block —getCleanedNBT()
public
getCleanedNBT() : CompoundTag|null
Return values
CompoundTag|null —getDefaultName()
public
getDefaultName() : string
Return values
string —getPatterns()
public
getPatterns() : array<string|int, BannerPatternLayer>
Tags
Return values
array<string|int, BannerPatternLayer> —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 —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 —setBaseColor()
Sets the color of the banner base.
public
setBaseColor(DyeColor $color) : void
Parameters
- $color : DyeColor
Return values
void —setDirty()
public
setDirty([bool $dirty = true ]) : void
Parameters
- $dirty : bool = true
Return values
void —setPatterns()
public
setPatterns(array<string|int, BannerPatternLayer> $patterns) : void
Parameters
- $patterns : array<string|int, BannerPatternLayer>
Tags
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