net.tridentsdk.event.block

Class NotePlayEvent

java.lang.Object

net.tridentsdk.event.Event

net.tridentsdk.event.block.BlockEvent

net.tridentsdk.event.block.NotePlayEvent

All Implemented Interfaces:

Cancellable

public class NotePlayEvent
extends BlockEvent
implements Cancellable

Called when a note is played, has a list of players that will hear this note

Since:

0.3-alpha-DP

Author:

The TridentSDK Team

Constructor Summary

Constructors

Constructor and Description
NotePlayEvent(Block block, List<Player> players, Note note, Instrument instrument)

Method Summary

Modifier and Type	Method and Description
void	cancel(boolean cancelled)
Instrument	instrument() Get the Instrument being used to play the Note
boolean	isIgnored()
Note	note() Returns the Note being played
List<Player>	players() Returns a list of players that will hear the Note being played
void	setInstrument(Instrument instrument) Set the Instrument to play the Note
void	setNote(Note note) Set the Note that is being played

Methods inherited from class net.tridentsdk.event.block.BlockEvent

block

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,
                     List<Player> players,
                     Note note,
                     Instrument instrument)

Parameters:

block - Block playing the Note

players - List of Players who can hear the Note

note - Note representing the sound being played

instrument - Instrument of the Note

Method Detail

note

public Note note()

Returns the Note being played

Returns:

Note representing the sound that is being played

setNote

public void setNote(Note note)

Set the Note that is being played

Parameters:

note - Note that is being played

instrument

public Instrument instrument()

Get the Instrument being used to play the Note

Returns:

Instrument being used to play the Note

setInstrument

public void setInstrument(Instrument instrument)

Set the Instrument to play the Note

Parameters:

instrument - Instrument to play the note

players

public List<Player> players()

Returns a list of players that will hear the Note being played

Returns:

List of Players who can hear the Note

isIgnored

public boolean isIgnored()

Specified by:

isIgnored in interface Cancellable

Returns:

return true if event is set to cancelled

cancel

public void cancel(boolean cancelled)

Specified by:

cancel in interface Cancellable

Parameters:

cancelled - set the cancellation state of the event