com.sk89q.worldedit.blocks

Class NoteBlock

java.lang.Object

com.sk89q.worldedit.foundation.Block

com.sk89q.worldedit.blocks.BaseBlock

com.sk89q.worldedit.blocks.NoteBlock

All Implemented Interfaces:

TileEntityBlock, NbtValued

public class NoteBlock
extends BaseBlock
implements TileEntityBlock

A note block.

Author:

sk89q

Field Summary

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

MAX_DATA, MAX_ID

Constructor Summary

Constructors

Constructor and Description
NoteBlock() Construct the note block with a data value of 0.
NoteBlock(int data) Construct the note block with a given data value.
NoteBlock(int data, byte note) Construct the note block with a given data value and note.

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.
byte	getNote() Get the note.
boolean	hasNbtData() Returns whether the block contains NBT data.
void	setNbtData(CompoundTag rootTag) Set the object's NBT data (tile entity data).
void	setNote(byte note) Set the note.

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

NoteBlock

public NoteBlock()

Construct the note block with a data value of 0.

NoteBlock

public NoteBlock(int data)

Construct the note block with a given data value.

Parameters:

data - data value

NoteBlock

public NoteBlock(int data,
         byte note)

Construct the note block with a given data value and note.

Parameters:

data - data value

note - note

Method Detail

getNote

public byte getNote()

Get the note.

Returns:

the note

setNote

public void setNote(byte note)

Set the note.

Parameters:

note - the note 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