org.cloudburstmc.server.blockentity.impl

Class BaseBlockEntity

java.lang.Object

org.cloudburstmc.server.blockentity.impl.BaseBlockEntity

All Implemented Interfaces:

BlockEntity

Direct Known Subclasses:

BannerBlockEntity, BarrelBlockEntity, BeaconBlockEntity, BedBlockEntity, BrewingStandBlockEntity, CampfireBlockEntity, CauldronBlockEntity, ChestBlockEntity, ComparatorBlockEntity, DaylightDetectorBlockEntity, EnchantingTableBlockEntity, FlowerPotBlockEntity, FurnaceBlockEntity, HopperBlockEntity, ItemFrameBlockEntity, JukeboxBlockEntity, LecternBlockEntity, MovingBlockEntity, MusicBlockEntity, PistonBlockEntity, ShulkerBoxBlockEntity, SignBlockEntity, SkullBlockEntity, UnknownBlockEntity

public abstract class BaseBlockEntity
extends Object
implements BlockEntity

Author:

MagicDroidX

Field Summary

Fields

Modifier and Type	Field and Description
boolean	closed
long	id
static AtomicLong	ID_ALLOCATOR
protected long	lastUpdate
boolean	movable
protected Server	server
protected Timing	timing

Constructor Summary

Constructors

Constructor and Description
BaseBlockEntity(BlockEntityType<?> type, Chunk chunk, com.nukkitx.math.vector.Vector3i position)

Method Summary

Modifier and Type	Method and Description
void	close()
Block	getBlock()
BlockState	getBlockState()
Chunk	getChunk()
com.nukkitx.nbt.NbtMap	getChunkTag() Gets the block entity NBT that is sent in a chunk packet Contains no server side NBT
com.nukkitx.nbt.NbtMap	getClientTag() Get the NBT for saving sending to the client in BlockEntityDataPacket Contains all server side NBT with ID but no position
String	getCustomName() Gets the name of this object.
long	getId()
com.nukkitx.nbt.NbtMap	getItemTag() Gets the NBT for items with block entity data Contains all server side NBT without ID and position
Level	getLevel()
com.nukkitx.math.vector.Vector3i	getPosition()
com.nukkitx.nbt.NbtMap	getServerTag() Get the NBT for saving the block entity to disk Contains all server side NBT with ID and position
com.nukkitx.nbt.NbtMap	getTag()
BlockEntityType<?>	getType()
boolean	hasCustomName() Whether this object has a name.
protected void	init()
boolean	isClosed()
boolean	isMovable()
boolean	isSpawnable()
abstract boolean	isValid()
void	loadAdditionalData(com.nukkitx.nbt.NbtMap tag)
void	onBreak()
boolean	onUpdate()
void	saveAdditionalData(com.nukkitx.nbt.NbtMapBuilder tag)
protected void	saveClientData(com.nukkitx.nbt.NbtMapBuilder tag) NBT data that is specifically sent to the client
void	scheduleUpdate()
void	setCustomName(String customName) Changes the name of this object, or names it.
void	setDirty()
void	setMovable(boolean moveble)
void	spawnTo(Player player)
void	spawnToAll()
boolean	updateFromClient(com.nukkitx.nbt.NbtMap tag, Player player)
protected boolean	updateNbtMap(com.nukkitx.nbt.NbtMap nbt, Player player) Called when a player updates a block entity's NBT data for example when writing on a sign.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID_ALLOCATOR

public static AtomicLong ID_ALLOCATOR

id

public final long id

movable

public boolean movable

closed

public boolean closed

lastUpdate

protected long lastUpdate

server

protected Server server

timing

protected Timing timing

Constructor Detail

BaseBlockEntity

public BaseBlockEntity(BlockEntityType<?> type,
                       Chunk chunk,
                       com.nukkitx.math.vector.Vector3i position)

Method Detail

getTag

public com.nukkitx.nbt.NbtMap getTag()

getType

public BlockEntityType<?> getType()

Specified by:

getType in interface BlockEntity

init

protected void init()

getId

public long getId()

loadAdditionalData

public void loadAdditionalData(com.nukkitx.nbt.NbtMap tag)

Specified by:

loadAdditionalData in interface BlockEntity

saveAdditionalData

public void saveAdditionalData(com.nukkitx.nbt.NbtMapBuilder tag)

Specified by:

saveAdditionalData in interface BlockEntity

saveClientData

protected void saveClientData(com.nukkitx.nbt.NbtMapBuilder tag)

NBT data that is specifically sent to the client

Parameters:

tag - tag to write data to

getItemTag

public final com.nukkitx.nbt.NbtMap getItemTag()

Description copied from interface: BlockEntity

Gets the NBT for items with block entity data Contains all server side NBT without ID and position

Specified by:

getItemTag in interface BlockEntity

Returns:

block entity tag

getServerTag

public final com.nukkitx.nbt.NbtMap getServerTag()

Description copied from interface: BlockEntity

Get the NBT for saving the block entity to disk Contains all server side NBT with ID and position

Specified by:

getServerTag in interface BlockEntity

Returns:

block entity tag

getClientTag

public final com.nukkitx.nbt.NbtMap getClientTag()

Description copied from interface: BlockEntity

Get the NBT for saving sending to the client in BlockEntityDataPacket Contains all server side NBT with ID but no position

Specified by:

getClientTag in interface BlockEntity

Returns:

block entity tag

getChunkTag

public final com.nukkitx.nbt.NbtMap getChunkTag()

Description copied from interface: BlockEntity

Gets the block entity NBT that is sent in a chunk packet Contains no server side NBT

Specified by:

getChunkTag in interface BlockEntity

Returns:

block entity tag

isValid

public abstract boolean isValid()

Specified by:

isValid in interface BlockEntity

onUpdate

public boolean onUpdate()

Specified by:

onUpdate in interface BlockEntity

scheduleUpdate

public final void scheduleUpdate()

Specified by:

scheduleUpdate in interface BlockEntity

close

public void close()

Specified by:

close in interface BlockEntity

isClosed

public boolean isClosed()

Specified by:

isClosed in interface BlockEntity

onBreak

public void onBreak()

Specified by:

onBreak in interface BlockEntity

setDirty

public void setDirty()

Specified by:

setDirty in interface BlockEntity

isMovable

public boolean isMovable()

Specified by:

isMovable in interface BlockEntity

setMovable

public void setMovable(boolean moveble)

Specified by:

setMovable in interface BlockEntity

getCustomName

@Nullable
public final String getCustomName()

Gets the name of this object.

Specified by:

getCustomName in interface BlockEntity

Returns:

The name of this object.

Since:

Nukkit 1.0 | Nukkit API 1.0.0

setCustomName

public final void setCustomName(@Nullable
                                String customName)

Changes the name of this object, or names it.

Specified by:

setCustomName in interface BlockEntity

Parameters:

customName - The new name of this object.

Since:

Nukkit 1.0 | Nukkit API 1.0.0

hasCustomName

public final boolean hasCustomName()

Whether this object has a name.

Specified by:

hasCustomName in interface BlockEntity

Returns:

true for this object has a name.

Since:

Nukkit 1.0 | Nukkit API 1.0.0

spawnTo

public void spawnTo(Player player)

Specified by:

spawnTo in interface BlockEntity

spawnToAll

public void spawnToAll()

Specified by:

spawnToAll in interface BlockEntity

updateFromClient

public final boolean updateFromClient(com.nukkitx.nbt.NbtMap tag,
                                      Player player)

Specified by:

updateFromClient in interface BlockEntity

updateNbtMap

protected boolean updateNbtMap(com.nukkitx.nbt.NbtMap nbt,
                               Player player)

Called when a player updates a block entity's NBT data for example when writing on a sign.

Parameters:

nbt - tag

player - player

Returns:

bool indication of success, will respawn the tile to the player if false.

isSpawnable

public boolean isSpawnable()

Specified by:

isSpawnable in interface BlockEntity

getPosition

public com.nukkitx.math.vector.Vector3i getPosition()

Specified by:

getPosition in interface BlockEntity

getLevel

public Level getLevel()

Specified by:

getLevel in interface BlockEntity

getChunk

public Chunk getChunk()

getBlock

public Block getBlock()

Specified by:

getBlock in interface BlockEntity

getBlockState

public BlockState getBlockState()

Specified by:

getBlockState in interface BlockEntity