com.sk89q.worldedit.blocks

Class ChestBlock

java.lang.Object

com.sk89q.worldedit.foundation.Block

com.sk89q.worldedit.blocks.BaseBlock

com.sk89q.worldedit.blocks.ContainerBlock

com.sk89q.worldedit.blocks.ChestBlock

All Implemented Interfaces:

TileEntityBlock, NbtValued

public class ChestBlock
extends ContainerBlock

Represents a chest block.

Author:

sk89q

Field Summary

Fields inherited from class com.sk89q.worldedit.foundation.Block

MAX_DATA, MAX_ID

Constructor Summary

Constructors

Constructor and Description
ChestBlock() Construct an empty chest block with the default orientation (data value).
ChestBlock(int data) Construct an empty chest block with a custom data value.
ChestBlock(int data, BaseItemStack[] items) Construct the chest block with a custom data value and a list of items.

Method Summary

Methods

Modifier and Type	Method and Description
CompoundTag	getNbtData() Get the object's NBT data (tile entity data).
String	getNbtId() Return the name of the title entity ID.
void	setNbtData(CompoundTag rootTag) Set the object's NBT data (tile entity data).

Methods inherited from class com.sk89q.worldedit.blocks.ContainerBlock

deserializeInventory, deserializeItem, getItems, hasNbtData, serializeInventory, serializeItem, setItems

Methods inherited from class com.sk89q.worldedit.blocks.BaseBlock

containsFuzzy, cycleData, equals, equalsFuzzy, flip, flip, getType, inIterable, isAir, rotate90, rotate90Reverse, setType

Methods inherited from class com.sk89q.worldedit.foundation.Block

getData, getId, hashCode, hasWildcardData, setData, setId, setIdAndData, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChestBlock

public ChestBlock()

Construct an empty chest block with the default orientation (data value).

ChestBlock

public ChestBlock(int data)

Construct an empty chest block with a custom data value.

Parameters:

data - data indicating the position of the chest

ChestBlock

public ChestBlock(int data,
          BaseItemStack[] items)

Construct the chest block with a custom data value and a list of items.

Parameters:

data - data indicating the position of the chest

items - array of items

Method Detail

getNbtId

public String getNbtId()

Description copied from interface: TileEntityBlock

Return the name of the title entity ID.

Specified by:

getNbtId in interface TileEntityBlock

Overrides:

getNbtId in class Block

Returns:

tile entity ID, non-null string

getNbtData

public CompoundTag getNbtData()

Description copied from interface: NbtValued

Get the object's NBT data (tile entity data). The returned tag, if modified in any way, should be sent to NbtValued.setNbtData(CompoundTag) so that the instance knows of the changes. Making changes without calling NbtValued.setNbtData(CompoundTag) could have unintended consequences.

NbtValued.hasNbtData() must return true if and only if method does not return null.

Specified by:

getNbtData in interface NbtValued

Overrides:

getNbtData in class Block

Returns:

compound tag, or null

setNbtData

public void setNbtData(CompoundTag rootTag)
                throws DataException

Description copied from interface: NbtValued

Set the object's NBT data (tile entity data).

Specified by:

setNbtData in interface NbtValued

Overrides:

setNbtData in class Block

Parameters:

rootTag - NBT data, or null if no data

Throws:

DataException - if possibly the data is invalid