net.raphimc.noteblocklib.format.nbs.model

Class NbsNote

java.lang.Object

net.raphimc.noteblocklib.format.nbs.model.NbsNote

public class NbsNote
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
NbsNote()

Method Summary

Modifier and Type	Method and Description
NbsNote	copy()
boolean	equals(java.lang.Object o)
short	getInstrument()
byte	getKey()
short	getPanning()
short	getPitch() 100 = 1 key 1200 = 1 octave
byte	getVelocity()
int	hashCode()
NbsNote	setInstrument(short instrument)
NbsNote	setKey(byte key)
NbsNote	setPanning(short panning)
NbsNote	setPitch(short pitch) 100 = 1 key 1200 = 1 octave
NbsNote	setVelocity(byte velocity)

Methods inherited from class java.lang.Object

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

Constructor Detail

NbsNote

public NbsNote()

Method Detail

getInstrument

public short getInstrument()

Returns:

The instrument of the note block. This is 0-15, or higher if the song uses custom instruments.

Since:

v0

setInstrument

public NbsNote setInstrument(short instrument)

Parameters:

instrument - The instrument of the note block. This is 0-15, or higher if the song uses custom instruments.

Returns:

this

Since:

v0

getKey

public byte getKey()

Returns:

The key of the note block, from 0-87, where 0 is A0 and 87 is C8. 33-57 is within the 2-octave limit.

Since:

v0

setKey

public NbsNote setKey(byte key)

Parameters:

key - The key of the note block, from 0-87, where 0 is A0 and 87 is C8. 33-57 is within the 2-octave limit.

Returns:

this

Since:

v0

getVelocity

public byte getVelocity()

Returns:

The velocity/volume of the note block, from 0% to 100%.

Since:

v4

setVelocity

public NbsNote setVelocity(byte velocity)

Parameters:

velocity - The velocity/volume of the note block, from 0% to 100%.

Returns:

this

Since:

v4

getPanning

public short getPanning()

Returns:

The stereo position of the note block, from 0-200. 0 is 2 blocks right, 100 is center, 200 is 2 blocks left.

Since:

v4

setPanning

public NbsNote setPanning(short panning)

Parameters:

panning - The stereo position of the note block, from 0-200. 0 is 2 blocks right, 100 is center, 200 is 2 blocks left.

Returns:

this

Since:

v4

getPitch

public short getPitch()

100 = 1 key
1200 = 1 octave

Returns:

The fine pitch of the note block, from -32,768 to 32,767 cents (but the max in Note Block Studio is limited to -1200 and +1200). 0 is no fine-tuning. ±100 cents is a single semitone difference.

Since:

v4

setPitch

public NbsNote setPitch(short pitch)

100 = 1 key
1200 = 1 octave

Parameters:

pitch - The fine pitch of the note block, from -32,768 to 32,767 cents (but the max in Note Block Studio is limited to -1200 and +1200). 0 is no fine-tuning. ±100 cents is a single semitone difference.

Returns:

this

Since:

v4

copy

public NbsNote copy()

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