net.raphimc.noteblocklib.model.note

Class Note

java.lang.Object

net.raphimc.noteblocklib.model.note.Note

public class Note
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Note()

Method Summary

Modifier and Type	Method and Description
Note	copy()
boolean	equals(java.lang.Object o)
float	getFractionalKeyPart()
int	getGroupId()
Instrument	getInstrument()
int	getMcKey() Calling this has the same effect as calling getMidiKey().
float	getMidiKey()
int	getNbsKey() Calling this has the same effect as calling getMidiKey().
float	getPanning()
float	getPitch() Calling this has the same effect as calling getMidiKey().
float	getVolume()
int	hashCode()
boolean	isOutsideMinecraftOctaveRange()
Note	setGroupId(int groupId)
Note	setInstrument(Instrument instrument)
Note	setMcKey(int mcKey) Calling this has the same effect as calling setMidiKey(float).
Note	setMidiKey(float midiKey)
Note	setNbsKey(float nbsKey) Calling this has the same effect as calling setMidiKey(float).
Note	setPanning(float panning)
Note	setPitch(float pitch) Calling this has the same effect as calling setMidiKey(float).
Note	setVolume(float volume)

Methods inherited from class java.lang.Object

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

Constructor Detail

Note

public Note()

Method Detail

getGroupId

public int getGroupId()

Returns:

The group ID of the note. Groups are used in events to determine which notes are affected by an event. -1 means that the note is not in any group.

setGroupId

public Note setGroupId(int groupId)

Parameters:

groupId - The group ID of the note. Groups are used in events to determine which notes are affected by an event. -1 means that the note is not in any group.

Returns:

this

getInstrument

public Instrument getInstrument()

Returns:

The instrument of the note. Default Minecraft instruments are stored in MinecraftInstrument.

setInstrument

public Note setInstrument(Instrument instrument)

Parameters:

instrument - The instrument of the note. Default Minecraft instruments are stored in MinecraftInstrument.

Returns:

this

getMidiKey

public float getMidiKey()

Returns:

The MIDI key of the note (21 = A0, 108 = C8). Fractional part is the fine-pitch.

setMidiKey

public Note setMidiKey(float midiKey)

Parameters:

midiKey - The MIDI key of the note (21 = A0, 108 = C8). Fractional part is the fine-pitch.

Returns:

this

getMcKey

public int getMcKey()

Calling this has the same effect as calling getMidiKey().

Returns:

The key of the note in the Minecraft Note Block range (0-24). The center key (F#4) is 12. May be out of range, if the note has not been transposed.

setMcKey

public Note setMcKey(int mcKey)

Calling this has the same effect as calling setMidiKey(float).

Parameters:

mcKey - The key of the note in the Minecraft Note Block range (0-24). The center key (F#4) is 12.

Returns:

this

getNbsKey

public int getNbsKey()

Calling this has the same effect as calling getMidiKey().

Returns:

The key of the note in the Minecraft Note Block Studio range (0-87). The center key (F#4) is 45. May be out of range, if the note has not been transposed.

setNbsKey

public Note setNbsKey(float nbsKey)

Calling this has the same effect as calling setMidiKey(float).

Parameters:

nbsKey - The key of the note in the Minecraft Note Block Studio range (0-87). The center key (F#4) is 45.

Returns:

this

getFractionalKeyPart

public float getFractionalKeyPart()

Returns:

The fractional part of the note key (-0.5F = 50% lower, 0.0F = normal, 0.5F = 50% higher). Only useful if you need the key as an integer and the fine-pitch separately.

getPitch

public float getPitch()

Calling this has the same effect as calling getMidiKey().

Returns:

The pitch of the note to use when playing the sample. (1.0F = normal speed, 2.0F = double speed, 0.5F = half speed). The center key (F#4) is 1.0F.

setPitch

public Note setPitch(float pitch)

Calling this has the same effect as calling setMidiKey(float).

Parameters:

pitch - The pitch of the note to use when playing the sample. (1.0F = normal speed, 2.0F = double speed, 0.5F = half speed). The center key (F#4) is 1.0F.

Returns:

this

getVolume

public float getVolume()

Returns:

The volume of the note. (0.0F = 0%, 1.0F = 100%)

setVolume

public Note setVolume(float volume)

Parameters:

volume - The volume of the note. (0.0F = 0%, 1.0F = 100%)

Returns:

this

getPanning

public float getPanning()

Returns:

The panning of the note. (-1.0F = 100% left, 0.0F = 0% center, 1.0F = 100% right)

setPanning

public Note setPanning(float panning)

Parameters:

panning - The panning of the note. (-1.0F = 100% left, 0.0F = 0% center, 1.0F = 100% right)

Returns:

this

isOutsideMinecraftOctaveRange

public boolean isOutsideMinecraftOctaveRange()

Returns:

If the note is outside the vanilla Minecraft octave range.

copy

public Note 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