com.sk89q.worldedit.blocks

Class SignBlock

java.lang.Object

com.sk89q.worldedit.foundation.Block

com.sk89q.worldedit.blocks.BaseBlock

com.sk89q.worldedit.blocks.SignBlock

All Implemented Interfaces:

TileEntityBlock, NbtValued

public class SignBlock
extends BaseBlock
implements TileEntityBlock

Represents a sign block.

Author:

sk89q

Field Summary

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

MAX_DATA, MAX_ID

Constructor Summary

Constructors

Constructor and Description
SignBlock(int type, int data) Construct the sign without text.
SignBlock(int type, int data, String[] text) Construct the sign with text.

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.
String[]	getText() Get the text.
boolean	hasNbtData() Returns whether the block contains NBT data.
void	setNbtData(CompoundTag rootTag) Set the object's NBT data (tile entity data).
void	setText(String[] text) Set the text.

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

SignBlock

public SignBlock(int type,
         int data)

Construct the sign without text.

Parameters:

type - type ID

data - data value (orientation)

SignBlock

public SignBlock(int type,
         int data,
         String[] text)

Construct the sign with text.

Parameters:

type - type ID

data - data value (orientation)

text - lines of text

Method Detail

getText

public String[] getText()

Get the text.

Returns:

the text

setText

public void setText(String[] text)

Set the text.

Parameters:

text - the text to set

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

Overrides:

hasNbtData in class Block

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

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