View source

class NoteKind

package funkin.play.notes.notekind

implements INoteScriptedClass

extended by NoAnimNoteKind, ScriptedNoteKind

Available on all platforms

Class for note scripts

Constructor

@:value({ description : "" })new(noteKind:String, description:String = "", ?noteStyleId:String, ?params:Array<NoteKindParam>, ?noanim:Bool, ?suffix:String)

Variables

description:String

Description used in chart editor

noanim:Bool

Whether or not the sing animation should play.

noteKind:String

The name of the note kind

noteStyleId:Null<String>

Custom note style

params:Array<NoteKindParam>

Custom parameters for the chart editor

@:value(true)scoreable:Bool = true

If this note kind is scoreable (ie, counted towards score and accuracy) Only accessible in scripts Defaults to true

suffix:String

The animation suffix to use.

Methods

onCreate(event:ScriptEvent):Void

onDestroy(event:ScriptEvent):Void

onNoteHit(event:HitNoteScriptEvent):Void

onNoteHoldDrop(event:HoldNoteScriptEvent):Void

onNoteIncoming(event:NoteScriptEvent):Void

onNoteMiss(event:NoteScriptEvent):Void

onScriptEvent(event:ScriptEvent):Void

onUpdate(event:UpdateScriptEvent):Void

toString():String