BlockEntity (Cloudburst 1.0.0-SNAPSHOT API)

All Known Subinterfaces:

Banner, Barrel, Beacon, Bed, Bell, BlastFurnace, BrewingStand, Campfire, Cauldron, Chest, CommandBlock, Comparator, DaylightDetector, Dispenser, Dropper, EnchantingTable, EnderChest, EndGateway, EndPortal, FlowerPot, Furnace, Hopper, ItemFrame, Jigsaw, Jukebox, Lectern, MobSpawner, MovingBlock, NetherReactor, Noteblock, Piston, ShulkerBox, Sign, Skull, Smoker, StructureBlock

All Known Implementing Classes:

BannerBlockEntity, BarrelBlockEntity, BaseBlockEntity, BeaconBlockEntity, BedBlockEntity, BlastFurnaceBlockEntity, BrewingStandBlockEntity, CampfireBlockEntity, CauldronBlockEntity, ChestBlockEntity, ComparatorBlockEntity, DaylightDetectorBlockEntity, EnchantingTableBlockEntity, EnderChestBlockEntity, FlowerPotBlockEntity, FurnaceBlockEntity, HopperBlockEntity, ItemFrameBlockEntity, JukeboxBlockEntity, LecternBlockEntity, MovingBlockEntity, MusicBlockEntity, PistonBlockEntity, ShulkerBoxBlockEntity, SignBlockEntity, SkullBlockEntity, SmokerBlockEntity
```
public interface BlockEntity
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()`
`Block`	`getBlock()`
`BlockState`	`getBlockState()`
`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()`
`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
`BlockEntityType<?>`	`getType()`
`boolean`	`hasCustomName()`
`boolean`	`isClosed()`
`boolean`	`isMovable()`
`boolean`	`isSpawnable()`
`boolean`	`isValid()`
`void`	`loadAdditionalData(com.nukkitx.nbt.NbtMap tag)`
`void`	`onBreak()`
`boolean`	`onUpdate()`
`void`	`saveAdditionalData(com.nukkitx.nbt.NbtMapBuilder tag)`
`void`	`scheduleUpdate()`
`void`	`setCustomName(String customName)`
`void`	`setDirty()`
`void`	`setMovable(boolean movable)`
`void`	`spawnTo(Player player)`
`void`	`spawnToAll()`
`boolean`	`updateFromClient(com.nukkitx.nbt.NbtMap tag, Player player)`

Method Detail

getType
```
BlockEntityType<?> getType()
```

getPosition

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

getLevel
```
Level getLevel()
```

loadAdditionalData

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

saveAdditionalData

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

getItemTag
```
com.nukkitx.nbt.NbtMap getItemTag()
```
Gets the NBT for items with block entity data Contains all server side NBT without ID and position

Returns:

block entity tag

getServerTag
```
com.nukkitx.nbt.NbtMap getServerTag()
```
Get the NBT for saving the block entity to disk Contains all server side NBT with ID and position

Returns:

block entity tag

getClientTag
```
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

Returns:

block entity tag

getChunkTag
```
com.nukkitx.nbt.NbtMap getChunkTag()
```
Gets the block entity NBT that is sent in a chunk packet Contains no server side NBT

Returns:

block entity tag

isValid
```
boolean isValid()
```

isClosed
```
boolean isClosed()
```

close
```
void close()
```

isMovable
```
boolean isMovable()
```

setMovable
```
void setMovable(boolean movable)
```

getCustomName
```
@Nullable
String getCustomName()
```

setCustomName

void setCustomName(@Nullable
                   String customName)

hasCustomName
```
boolean hasCustomName()
```

isSpawnable
```
boolean isSpawnable()
```

updateFromClient

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

getBlock
```
Block getBlock()
```

getBlockState
```
BlockState getBlockState()
```

spawnToAll
```
void spawnToAll()
```

spawnTo
```
void spawnTo(Player player)
```

scheduleUpdate
```
void scheduleUpdate()
```

setDirty
```
void setDirty()
```

onUpdate
```
boolean onUpdate()
```

onBreak
```
void onBreak()
```

Interface BlockEntity

Method Summary

Method Detail

getType

getPosition

getLevel

loadAdditionalData

saveAdditionalData

getItemTag

getServerTag

getClientTag

getChunkTag

isValid

isClosed

close

isMovable

setMovable

getCustomName

setCustomName

hasCustomName

isSpawnable

updateFromClient

getBlock

getBlockState

spawnToAll

spawnTo

scheduleUpdate

setDirty

onUpdate

onBreak