net.raphimc.noteblocklib.format.nbs.model

Class NbsCustomInstrument

java.lang.Object

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

public class NbsCustomInstrument
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
NbsCustomInstrument(com.google.common.io.LittleEndianDataInputStream dis)
NbsCustomInstrument(java.lang.String name, java.lang.String soundFileName, byte pitch, boolean pressKey)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getName()
byte	getPitch()
java.lang.String	getSoundFileName()
int	hashCode()
boolean	isPressKey()
void	setName(java.lang.String name)
void	setPitch(byte pitch)
void	setPressKey(boolean pressKey)
void	setSoundFileName(java.lang.String soundFileName)
void	write(com.google.common.io.LittleEndianDataOutputStream dos)

Methods inherited from class java.lang.Object

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

Constructor Detail

NbsCustomInstrument

public NbsCustomInstrument(com.google.common.io.LittleEndianDataInputStream dis)
                    throws java.io.IOException

Throws:

java.io.IOException

NbsCustomInstrument

public NbsCustomInstrument(java.lang.String name,
                           java.lang.String soundFileName,
                           byte pitch,
                           boolean pressKey)

Method Detail

write

public void write(com.google.common.io.LittleEndianDataOutputStream dos)
           throws java.io.IOException

Throws:

java.io.IOException

getName

public java.lang.String getName()

Returns:

The name of the instrument.

Since:

v0

setName

public void setName(java.lang.String name)

Parameters:

name - The name of the instrument.

Since:

v0

getSoundFileName

public java.lang.String getSoundFileName()

Returns:

The sound file of the instrument (just the file name, not the path).

Since:

v0

setSoundFileName

public void setSoundFileName(java.lang.String soundFileName)

Parameters:

soundFileName - The sound file of the instrument (just the file name, not the path).

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 void 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).

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 void setPressKey(boolean pressKey)

Parameters:

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

Since:

v0

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