com.sk89q.worldedit.foundation

Interface NbtValued

All Known Subinterfaces:

TileEntityBlock

All Known Implementing Classes:

BaseBlock, Block, ChestBlock, ContainerBlock, DefaultNmsBlock, DispenserBlock, FurnaceBlock, MobSpawnerBlock, NmsBlock, NoteBlock, SignBlock, SkullBlock

public interface NbtValued

Indicates an object that contains extra data identified as an NBT structure. This interface is used when saving and loading objects to a serialized format, but may be used in other cases.

Method Summary

Methods

Modifier and Type	Method and Description
CompoundTag	getNbtData() Get the object's NBT data (tile entity data).
boolean	hasNbtData() Returns whether the block contains NBT data.
void	setNbtData(CompoundTag nbtData) Set the object's NBT data (tile entity data).

Method Detail

hasNbtData

boolean hasNbtData()

Returns whether the block contains NBT data. getNbtData() must not return null if this method returns true.

Returns:

true if there is NBT data

getNbtData

CompoundTag getNbtData()

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

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

Returns:

compound tag, or null

setNbtData

void setNbtData(CompoundTag nbtData)
                throws DataException

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

Parameters:

nbtData - NBT data, or null if no data

Throws:

DataException - if possibly the data is invalid