net.raphimc.noteblocklib.format.nbs.model

Class NbsCustomInstrument

java.lang.Object

net.raphimc.noteblocklib.format.nbs.model.NbsCustomInstrument

All Implemented Interfaces:

Instrument

public class NbsCustomInstrument
extends java.lang.Object
implements Instrument

Constructor Summary

Constructors

Constructor and Description
NbsCustomInstrument()

Method Summary

Modifier and Type	Method and Description
NbsCustomInstrument	copy()
boolean	equals(java.lang.Object o)
java.lang.String	getName()
java.lang.String	getNameOr(java.lang.String fallback)
byte	getPitch()
java.lang.String	getSoundFilePath()
java.lang.String	getSoundFilePathOr(java.lang.String fallback)
int	hashCode()
boolean	isPressKey()
NbsCustomInstrument	setName(java.lang.String name)
NbsCustomInstrument	setPitch(byte pitch)
NbsCustomInstrument	setPressKey(boolean pressKey)
NbsCustomInstrument	setSoundFilePath(java.lang.String soundFilePath)

Methods inherited from class java.lang.Object

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

Constructor Detail

NbsCustomInstrument

public NbsCustomInstrument()

Method Detail

getName

public java.lang.String getName()

Returns:

The name of the instrument.

Since:

v0

getNameOr

public java.lang.String getNameOr(java.lang.String fallback)

Parameters:

fallback - The fallback value if the name is not set.

Returns:

The name of the instrument.

Since:

v0

setName

public NbsCustomInstrument setName(java.lang.String name)

Parameters:

name - The name of the instrument.

Returns:

this

Since:

v0

getSoundFilePath

public java.lang.String getSoundFilePath()

Returns:

The sound file of the instrument.

Since:

v0

getSoundFilePathOr

public java.lang.String getSoundFilePathOr(java.lang.String fallback)

Parameters:

fallback - The fallback value if the sound file path is not set.

Returns:

The sound file of the instrument.

Since:

v0

setSoundFilePath

public NbsCustomInstrument setSoundFilePath(java.lang.String soundFilePath)

Parameters:

soundFilePath - The sound file of the instrument.

Returns:

this

Since:

v0

getPitch

public byte getPitch()

Returns:

The pitch of the sound file. Just like the note blocks, this ranges from 0-87. Default is 45 (F#4).

Since:

v0

setPitch

public NbsCustomInstrument setPitch(byte pitch)

Parameters:

pitch - The pitch of the sound file. Just like the note blocks, this ranges from 0-87. Default is 45 (F#4).

Returns:

this

Since:

v0

isPressKey

public boolean isPressKey()

Returns:

Whether the piano should automatically press keys with this instrument when the marker passes them.

Since:

v0

setPressKey

public NbsCustomInstrument setPressKey(boolean pressKey)

Parameters:

pressKey - Whether the piano should automatically press keys with this instrument when the marker passes them.

Returns:

this

Since:

v0

copy

public NbsCustomInstrument copy()

Specified by:

copy in interface Instrument

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