Funkin/source/funkin/play/notes/notekind/NoteKind.hx

package funkin.play.notes.notekind;

import funkin.modding.IScriptedClass.INoteScriptedClass;
import funkin.modding.events.ScriptEvent;

/**
 * Class for note scripts
 */
class NoteKind implements INoteScriptedClass
{
  /**
   * the name of the note kind
   */
  public var noteKind:String;

  /**
   * description used in chart editor
   */
  public var description:String = "";

  public function new(noteKind:String, description:String = "")
  {
    this.noteKind = noteKind;
    this.description = description;
  }

  public function toString():String
  {
    return noteKind;
  }

  public function onScriptEvent(event:ScriptEvent):Void {}

  public function onCreate(event:ScriptEvent):Void {}

  public function onDestroy(event:ScriptEvent):Void {}

  public function onUpdate(event:UpdateScriptEvent):Void {}

  public function onNoteIncoming(event:NoteScriptEvent):Void {}

  public function onNoteHit(event:HitNoteScriptEvent):Void {}

  public function onNoteMiss(event:NoteScriptEvent):Void {}
}