net.raphimc.noteblocklib.format.nbs.model.event

Class NbsSoundStopperEvent

java.lang.Object

net.raphimc.noteblocklib.format.nbs.model.event.NbsSoundStopperEvent

All Implemented Interfaces:

NbsEvent, Event

public class NbsSoundStopperEvent
extends java.lang.Object
implements NbsEvent

Event, which stops all sounds originating from the specified layers.

Constructor Summary

Constructors

Constructor and Description
NbsSoundStopperEvent(short startLayer, short endLayer)

Method Summary

Modifier and Type	Method and Description
NbsSoundStopperEvent	copy()
boolean	equals(java.lang.Object o)
short	getEndLayer()
short	getStartLayer()
int	hashCode()
void	setEndLayer(short endLayer)
void	setStartLayer(short startLayer)
boolean	shouldStop(Note note) Checks if the specified note should be stopped by this event.

Methods inherited from class java.lang.Object

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

Constructor Detail

NbsSoundStopperEvent

public NbsSoundStopperEvent(short startLayer,
                            short endLayer)

Method Detail

getStartLayer

public short getStartLayer()

Returns:

The start layer (1 indexed, inclusive) of the layer range whose sounds will be stopped. 0 = stop all layers

setStartLayer

public void setStartLayer(short startLayer)

Parameters:

startLayer - The start layer (1 indexed, inclusive) of the layer range whose sounds will be stopped. 0 = stop all layers

getEndLayer

public short getEndLayer()

Returns:

The end layer (1 indexed, inclusive) of the layer range whose sounds will be stopped.

setEndLayer

public void setEndLayer(short endLayer)

Parameters:

endLayer - The end layer (1 indexed, inclusive) of the layer range whose sounds will be stopped.

shouldStop

public boolean shouldStop(Note note)

Checks if the specified note should be stopped by this event.

Parameters:

note - The note to check.

Returns:

True if the note should be stopped by this event, false otherwise.

copy

public NbsSoundStopperEvent copy()

Specified by:

copy in interface NbsEvent

Specified by:

copy in interface Event

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object