Bukkit  1.4.7-R1.0
 All Classes Namespaces Files Functions Variables Enumerator Pages
org.bukkit.block.NoteBlock Interface Reference

Represents a note. More...

+ Inheritance diagram for org.bukkit.block.NoteBlock:
+ Collaboration diagram for org.bukkit.block.NoteBlock:

Public Member Functions

Note getNote ()
 Gets the note.
 
byte getRawNote ()
 Gets the note.
 
void setNote (Note note)
 Set the note.
 
void setRawNote (byte note)
 Set the note.
 
boolean play ()
 Attempts to play the note at block.
 
boolean play (byte instrument, byte note)
 Plays an arbitrary note with an arbitrary instrument.
 
boolean play (Instrument instrument, Note note)
 Plays an arbitrary note with an arbitrary instrument.
 
- Public Member Functions inherited from org.bukkit.block.BlockState
Block getBlock ()
 Gets the block represented by this BlockState.
 
MaterialData getData ()
 Gets the metadata for this block.
 
Material getType ()
 Gets the type of this block.
 
int getTypeId ()
 Gets the type-id of this block.
 
byte getLightLevel ()
 Gets the light level between 0-15.
 
World getWorld ()
 Gets the world which contains this Block.
 
int getX ()
 Gets the x-coordinate of this block.
 
int getY ()
 Gets the y-coordinate of this block.
 
int getZ ()
 Gets the z-coordinate of this block.
 
Location getLocation ()
 Gets the location of this block.
 
Location getLocation (Location loc)
 Stores the location of this block in the provided Location object.
 
Chunk getChunk ()
 Gets the chunk which contains this block.
 
void setData (MaterialData data)
 Sets the metadata for this block.
 
void setType (Material type)
 Sets the type of this block.
 
boolean setTypeId (int type)
 Sets the type-id of this block.
 
boolean update ()
 Attempts to update the block represented by this state, setting it to the new values as defined by this state.
 
boolean update (boolean force)
 Attempts to update the block represented by this state, setting it to the new values as defined by this state.
 
byte getRawData ()
 
void setRawData (byte data)
 

Detailed Description

Represents a note.

Definition at line 9 of file NoteBlock.java.

Member Function Documentation

Note org.bukkit.block.NoteBlock.getNote ( )

Gets the note.

Returns
The note.
byte org.bukkit.block.NoteBlock.getRawNote ( )

Gets the note.

Returns
The note ID.
boolean org.bukkit.block.NoteBlock.play ( )

Attempts to play the note at block.

If the block is no longer a note block, this will return false

Returns
true if successful, otherwise false
boolean org.bukkit.block.NoteBlock.play ( byte  instrument,
byte  note 
)

Plays an arbitrary note with an arbitrary instrument.

Parameters
instrumentInstrument ID
noteNote ID
Returns
true if successful, otherwise false
boolean org.bukkit.block.NoteBlock.play ( Instrument  instrument,
Note  note 
)

Plays an arbitrary note with an arbitrary instrument.

Parameters
instrumentThe instrument
noteThe note
Returns
true if successful, otherwise false
See Also
Instrument Note
void org.bukkit.block.NoteBlock.setNote ( Note  note)

Set the note.

Parameters
noteThe note.
void org.bukkit.block.NoteBlock.setRawNote ( byte  note)

Set the note.

Parameters
noteThe note ID.

The documentation for this interface was generated from the following file: