com.sk89q.worldedit.foundation

Class Block

java.lang.Object

com.sk89q.worldedit.foundation.Block

All Implemented Interfaces:

TileEntityBlock, NbtValued

Direct Known Subclasses:

BaseBlock

public class Block
extends Object
implements TileEntityBlock

Represents a mutable copy of a block that is not tied to any 'real' block in a world. A single instance of this can be set to multiple locations and each location would have a copy of this instance's data.

Implementations can and should extend this class to allow native implementations of NBT data handling, primarily for performance reasons. Subclasses can only convert from and to WorldEdit-native NBT structures when absolutely necessary (a.k.a. when getNbtData() and setNbtData(CompoundTag) are called). When overriding the NBT methods, getNbtId() should be overridden too, otherwise the default implementation will invoke getNbtData(), a potentially costly operation when it is not needed. Implementations may want to cache converted NBT data structures if possible.

Currently, BaseBlock is used throughout WorldEdit and implementations, but eventually an API-breaking transition will occur to switch to this object instead. As-is, the definition of this class is complete, but may need changes in MC 1.4 because data values may be eradicated.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_DATA Indicates the maximum data value (inclusive) that can be used.
static int	MAX_ID Indicates the highest possible block ID (inclusive) that can be used.

Constructor Summary

Constructors

Constructor and Description
Block(int id) Construct a block with the given ID and a data value of 0.
Block(int id, int data) Construct a block with the given ID and data value.
Block(int id, int data, CompoundTag nbtData) Construct a block with the given ID, data value, and NBT data structure.

Method Summary

Methods

Modifier and Type	Method and Description
int	getData() Get the block's data value.
int	getId() Get the ID of the block.
CompoundTag	getNbtData() Get the object's NBT data (tile entity data).
String	getNbtId() Return the name of the title entity ID.
int	hashCode()
boolean	hasNbtData() Returns whether the block contains NBT data.
boolean	hasWildcardData() Returns whether the data value is -1, indicating that this block is to be used as a wildcard matching block.
void	setData(int data) Set the block's data value.
void	setId(int id) Set the block ID.
void	setIdAndData(int id, int data) Set both the block's ID and data value.
void	setNbtData(CompoundTag nbtData) Set the object's NBT data (tile entity data).
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ID

public static final int MAX_ID

Indicates the highest possible block ID (inclusive) that can be used. This value is subject to change depending on the implementation, but internally this class only supports a range of 4096 IDs (for space reasons), which coincides with the number of possible IDs that official Minecraft supports as of version 1.3.

See Also:

Constant Field Values

MAX_DATA

public static final int MAX_DATA

Indicates the maximum data value (inclusive) that can be used. Minecraft 1.4 may abolish usage of data values and this value may be removed in the future.

See Also:

Constant Field Values

Constructor Detail

Block

public Block(int id)

Construct a block with the given ID and a data value of 0.

Parameters:

id - ID value

See Also:

setId(int)

Block

public Block(int id,
     int data)

Construct a block with the given ID and data value.

Parameters:

id - ID value

data - data value

See Also:

setId(int), setData(int)

Block

public Block(int id,
     int data,
     CompoundTag nbtData)
      throws DataException

Construct a block with the given ID, data value, and NBT data structure.

Parameters:

id - ID value

data - data value

nbtData - NBT data

Throws:

DataException - if possibly the data is invalid

See Also:

setId(int), setData(int), setNbtData(CompoundTag)

Method Detail

getId

public int getId()

Get the ID of the block.

Returns:

ID (between 0 and MAX_ID)

setId

public void setId(int id)

Set the block ID.

Parameters:

id - block id (between 0 and MAX_ID).

getData

public int getData()

Get the block's data value.

Returns:

data value (0-15)

setData

public void setData(int data)

Set the block's data value.

Parameters:

data - block data value (between 0 and MAX_DATA).

setIdAndData

public void setIdAndData(int id,
                int data)

Set both the block's ID and data value.

Parameters:

id - ID value

data - data value

See Also:

setId(int), setData(int)

hasWildcardData

public boolean hasWildcardData()

Returns whether the data value is -1, indicating that this block is to be used as a wildcard matching block.

Returns:

true if the data value is -1

hasNbtData

public boolean hasNbtData()

Description copied from interface: NbtValued

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

Specified by:

hasNbtData in interface NbtValued

Returns:

true if there is NBT data

getNbtId

public String getNbtId()

Description copied from interface: TileEntityBlock

Return the name of the title entity ID.

Specified by:

getNbtId in interface TileEntityBlock

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

Returns:

compound tag, or null

setNbtData

public void setNbtData(CompoundTag nbtData)
                throws DataException

Description copied from interface: NbtValued

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

Specified by:

setNbtData in interface NbtValued

Parameters:

nbtData - NBT data, or null if no data

Throws:

DataException - if possibly the data is invalid

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object