net.raphimc.noteblocklib.util

Class MinecraftDefinitions

java.lang.Object

net.raphimc.noteblocklib.util.MinecraftDefinitions

public class MinecraftDefinitions
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	MC_HIGHEST_KEY
static int	MC_KEYS
static int	MC_LOWEST_KEY

Constructor Summary

Constructors

Constructor and Description
MinecraftDefinitions()

Method Summary

Modifier and Type	Method and Description
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 boolean	isOutsideOctaveRange(int nbsKey)
static float	mcKeyToMcPitch(int mcKey)
static int	mcKeyToNbsKey(int mcKey) Converts a key from the minecraft system to the NBS system
static int	mcPitchToMcKey(float mcPitch)
static int	nbsKeyToMcKey(int nbsKey) Converts a key from the NBS system to the minecraft system
static float	nbsPitchToMcPitch(int nbsPitch)
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

MC_LOWEST_KEY

public static final int MC_LOWEST_KEY

See Also:

Constant Field Values

MC_HIGHEST_KEY

public static final int MC_HIGHEST_KEY

See Also:

Constant Field Values

MC_KEYS

public static final int MC_KEYS

See Also:

Constant Field Values

Constructor Detail

MinecraftDefinitions

public MinecraftDefinitions()

Method Detail

mcKeyToMcPitch

public static float mcKeyToMcPitch(int mcKey)

Parameters:

mcKey - The key of the note in the minecraft id system

Returns:

The pitch of the note (Between 0 and 2 for input between 0 and 24)

mcPitchToMcKey

public static int mcPitchToMcKey(float mcPitch)

Parameters:

mcPitch - The pitch of the note (Between 0 and 2)

Returns:

The key of the note in the minecraft id system (Between 0 and 24 if input between 0 and 2)

nbsPitchToMcPitch

public static float nbsPitchToMcPitch(int nbsPitch)

Parameters:

nbsPitch - The pitch of the note (Between 0 and 2400)

Returns:

The pitch of the note (Between 0 and 2 for input between 0 and 2400)

nbsKeyToMcKey

public static int nbsKeyToMcKey(int nbsKey)

Converts a key from the NBS system to the minecraft system

Parameters:

nbsKey - The key of the note in the NBS system

Returns:

The key of the note in the minecraft id system

mcKeyToNbsKey

public static int mcKeyToNbsKey(int mcKey)

Converts a key from the minecraft system to the NBS system

Parameters:

mcKey - The key of the note in the minecraft id system

Returns:

The key of the note in the NBS system

isOutsideOctaveRange

public static boolean isOutsideOctaveRange(int nbsKey)

Parameters:

nbsKey - The key of the note in the NBS system

Returns:

If the note is outside the minecraft octave range

clampNoteKey

public static void clampNoteKey(Note note)

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

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 will be transposed up an octave, and any key above 57 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 will be transposed up by transposeAmount, and any key above 57 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