Package 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
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
ConstructorDescriptionNotePlayEvent
(@NotNull Block block, @NotNull Instrument instrument, @NotNull Note note) -
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull HandlerList
Gets theInstrument
to be used.getNote()
Gets theNote
to be played.boolean
Gets the cancellation state of this event.void
setCancelled
(boolean cancel) Sets the cancellation state of this event.void
setInstrument
(@NotNull Instrument instrument) Overrides theInstrument
to be used.void
Overrides theNote
to be played.Methods inherited from class org.bukkit.event.block.BlockEvent
getBlock
Methods inherited from class org.bukkit.event.Event
callEvent, getEventName, isAsynchronous
-
Constructor Details
-
NotePlayEvent
-
-
Method Details
-
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 interfaceCancellable
- 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 interfaceCancellable
- Parameters:
cancel
- true if you wish to cancel this event
-
getInstrument
Gets theInstrument
to be used.- Returns:
- the Instrument
-
getNote
Gets theNote
to be played.- Returns:
- the Note
-
setInstrument
Overrides theInstrument
to be used.Only works when the note block isn't under a player head. For this specific case the 'note_block_sound' property of the player head state takes the priority.
- Parameters:
instrument
- the Instrument. Has no effect if null.
-
setNote
Overrides theNote
to be played.- Parameters:
note
- the Note. Has no effect if null.
-
getHandlers
- Specified by:
getHandlers
in classEvent
-
getHandlerList
-