net.raphimc.noteblocklib.format.minecraft

Class MinecraftDefinitions

java.lang.Object

net.raphimc.noteblocklib.format.minecraft.MinecraftDefinitions

public class MinecraftDefinitions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	HIGHEST_KEY
static int	HIGHEST_MIDI_KEY
static int	KEY_COUNT
static int	LOWEST_KEY
static int	LOWEST_MIDI_KEY

Constructor Summary

Constructors

Constructor and Description
MinecraftDefinitions()

Method Summary

Modifier and Type	Method and Description
static void	applyExtendedNotesResourcePack(Note note) Modifies the note to be compatible with the Extended Octave Range Notes resource pack.
static int	applyExtendedNotesResourcePackOld(Note note) Deprecated. Replaced by applyExtendedNotesResourcePack(Note) which also sets the correct instrument automatically.
static void	clampNoteKey(Note note) Clamps the key of the note to fall within minecraft octave range.
static void	instrumentShiftNote(Note note) "Transposes" the key of the note by shifting the instrument to a higher or lower sounding one.
static void	transposeNoteKey(Note note) Transposes the key of the note to fall within minecraft octave range.
static void	transposeNoteKey(Note note, int transposeAmount) Transposes the key of the note to fall within minecraft octave range.

Methods inherited from class java.lang.Object

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

Field Detail

LOWEST_MIDI_KEY

public static final int LOWEST_MIDI_KEY

See Also:

Constant Field Values

HIGHEST_MIDI_KEY

public static final int HIGHEST_MIDI_KEY

See Also:

Constant Field Values

LOWEST_KEY

public static final int LOWEST_KEY

See Also:

Constant Field Values

HIGHEST_KEY

public static final int HIGHEST_KEY

See Also:

Constant Field Values

KEY_COUNT

public static final int KEY_COUNT

See Also:

Constant Field Values

Constructor Detail

MinecraftDefinitions

public MinecraftDefinitions()

Method Detail

clampNoteKey

public static void clampNoteKey(Note note)

Clamps the key of the note to fall within minecraft octave range.
Any key below 33 (NBS) will be set to 33 (NBS), and any key above 57 (NBS) will be set to 57 (NBS).

Parameters:

note - The note to clamp

transposeNoteKey

public static void transposeNoteKey(Note note)

Transposes the key of the note to fall within minecraft octave range.
Any key below 33 (NBS) will be transposed up an octave, and any key above 57 (NBS) will be transposed down an octave.

Parameters:

note - The note to transpose

transposeNoteKey

public static void transposeNoteKey(Note note,
                                    int transposeAmount)

Transposes the key of the note to fall within minecraft octave range.
Any key below 33 (NBS) will be transposed up by transposeAmount, and any key above 57 (NBS) will be transposed down by transposeAmount.

Parameters:

note - The note to transpose

transposeAmount - The amount of keys to transpose by

instrumentShiftNote

public static void instrumentShiftNote(Note note)

"Transposes" the key of the note by shifting the instrument to a higher or lower sounding one.
This often sounds the best of the three methods as it keeps the musical key the same and only changes the instrument.
The note might still be slightly outside of the minecraft octave range. Use one of the other methods to fix this. Clamp is recommended.

Parameters:

note - The note to transpose

applyExtendedNotesResourcePack

public static void applyExtendedNotesResourcePack(Note note)

Modifies the note to be compatible with the Extended Octave Range Notes resource pack.
This includes shifting the note key to be within the Minecraft octave range and changing its instrument to a ShiftedMinecraftInstrument with the correct octaves shift.
The octaves shift value has to be appended to the sound name to play the note at the correct pitch. (For example: "block.note_block.harp_" + octavesShift)
ShiftedMinecraftInstrument.mcSoundName() can be used to get the correct sound name with the suffix already appended.
Link to the resource pack: Extended Notes

Parameters:

note - The note to modify

applyExtendedNotesResourcePackOld

@Deprecated
public static int applyExtendedNotesResourcePackOld(Note note)

Deprecated. Replaced by applyExtendedNotesResourcePack(Note) which also sets the correct instrument automatically.

Returns the octave delta to use as a suffix for the sound name and modifies the note key to be within the Minecraft octave range.
The octave delta value has to be appended to the sound name to play the note at the correct pitch. (For example: "block.note_block.harp_" + octaveDelta)
Link to the resource pack: Extended Notes

Parameters:

note - The note to modify

Returns:

The octave delta to use as a suffix for the sound name