net.raphimc.noteblocklib.parser.nbs.data

Class NBSv0CustomInstrument

java.lang.Object

net.raphimc.noteblocklib.parser.nbs.data.NBSv0CustomInstrument

public class NBSv0CustomInstrument
extends java.lang.Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName()
byte	getPitch()
java.lang.String	getSoundFileName()
boolean	isPressKey()
void	setName(java.lang.String name)
void	setPitch(byte pitch)
void	setPressKey(boolean pressKey)
void	setSoundFileName(java.lang.String soundFileName)

Methods inherited from class java.lang.Object

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

Constructor Detail

NBSv0CustomInstrument

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

Throws:

java.io.IOException

NBSv0CustomInstrument

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

Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

Returns:

The name of the instrument.

setSoundFileName

public void setSoundFileName(java.lang.String soundFileName)

getSoundFileName

public java.lang.String getSoundFileName()

Returns:

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

setPitch

public void setPitch(byte pitch)

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

setPressKey

public void setPressKey(boolean pressKey)

isPressKey

public boolean isPressKey()

Returns:

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