org.bukkit.event.block
Class NotePlayEvent

java.lang.Object
  org.bukkit.event.Event
      org.bukkit.event.block.BlockEvent
          org.bukkit.event.block.NotePlayEvent

All Implemented Interfaces:

Cancellable

public class NotePlayEvent
extends BlockEvent
implements Cancellable

Called when a note block is being played through player interaction or a redstone current.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Field Summary

Fields inherited from class org.bukkit.event.block.BlockEvent

block

Constructor Summary

NotePlayEvent(Block block, Instrument instrument, Note note)

Method Summary

static HandlerList	getHandlerList()
HandlerList	getHandlers()
Instrument	getInstrument() Gets the Instrument to be used.
Note	getNote() Gets the Note to be played.
boolean	isCancelled() Gets the cancellation state of this event.
void	setCancelled(boolean cancel) Sets the cancellation state of this event.
void	setInstrument(Instrument instrument) Overrides the Instrument to be used.
void	setNote(Note note) Overrides the Note to be played.

Methods inherited from class org.bukkit.event.block.BlockEvent

getBlock

Methods inherited from class org.bukkit.event.Event

getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Detail

NotePlayEvent

public NotePlayEvent(Block block,
                     Instrument instrument,
                     Note note)

Method Detail

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Gets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins

Specified by:

isCancelled in interface Cancellable

Returns:

true if this event is cancelled

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Sets the cancellation state of this event. A cancelled event will not be executed in the server, but will still pass to other plugins.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - true if you wish to cancel this event

getInstrument

public Instrument getInstrument()

Gets the Instrument to be used.

Returns:

the Instrument;

getNote

public Note getNote()

Gets the Note to be played.

Returns:

the Note.

setInstrument

public void setInstrument(Instrument instrument)

Overrides the Instrument to be used.

Parameters:

instrument - the Instrument. Has no effect if null.

setNote

public void setNote(Note note)

Overrides the Note to be played.

Parameters:

note - the Note. Has no effect if null.

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()