View source

class NoteKindManager

package funkin.play.notes.notekind

@:directlyUsed

Available on all platforms

Static variables

@:value([])staticnoteKinds:Map<String, NoteKind> = []

A map of all note kinds, keyed by their name. This is used to retrieve note kinds by their name.

Static methods

staticcallEvent(event:ScriptEvent):Void

Calls the given event for note kind scripts

Parameters:

event

The event

staticclearNoteKindCache():Void

Clear the note kind cache. Be sure to register the note kinds again before trying to use them.

staticgetNoteKind(?noteKind:String):Null<NoteKind>

Retrieve a note kind by its name.

Parameters:

noteKind

The name of the note kind.

Returns:

The note kind, or null if it doesn't exist.

staticgetNoteStyle(noteKind:String, ?suffix:String):Null<NoteStyle>

Retrieve the note style from the given note kind

Parameters:

noteKind

note kind name

suffix

Used for song note styles

Returns:

NoteStyle

staticgetNoteStyleId(noteKind:String, ?suffix:String):Null<String>

Retrieve the note style id from the given note kind

Parameters:

noteKind

Note kind name

suffix

Used for song note styles

Returns:

Null

staticgetParams(noteKind:Null<String>):Array<NoteKindParam>

Retrive custom params of the given note kind

Parameters:

noteKind

Name of the note kind

Returns:

Array

staticinitialize():Void

Initialize custom behavior for note kinds.

staticlistNoteStylesByNoteData(songNoteDatas:Array<SongNoteData>):Array<NoteStyle>

Get a list of all the note styles used by the given notes. Great for preloading.

Parameters:

songNoteDatas

The notes to query for note styles.

Returns:

The note styles to load.

staticregisterBaseNoteKinds():Void

Register the hard-coded note kinds.

staticregisterScriptedNoteKinds():Void

Register the scripted note kinds provided by mods.