Funkin/source/funkin/modding/IScriptedClass.hx

package funkin.modding;

import funkin.modding.events.ScriptEvent;

/**
 * Defines a set of callbacks available to all scripted classes.
 * 
 * Includes events handling basic life cycle relevant to all scripted classes.
 */
interface IScriptedClass
{
	public function onScriptEvent(event:ScriptEvent):Void;

	public function onCreate(event:ScriptEvent):Void;
	public function onDestroy(event:ScriptEvent):Void;
	public function onUpdate(event:UpdateScriptEvent):Void;
}

/**
 * Defines a set of callbacks available to scripted classes that involve player input.
 */
interface IInputScriptedClass extends IScriptedClass
{
	public function onKeyDown(event:KeyboardInputScriptEvent):Void;
	public function onKeyUp(event:KeyboardInputScriptEvent):Void;
	// TODO: OnMouseDown, OnMouseUp, OnMouseMove
}

/**
 * Defines a set of callbacks available to scripted classes that involve the lifecycle of the Play State.
 */
interface IPlayStateScriptedClass extends IScriptedClass
{
	public function onPause(event:ScriptEvent):Void;
	public function onResume(event:ScriptEvent):Void;

	public function onSongLoaded(eent:SongLoadScriptEvent):Void;
	public function onSongStart(event:ScriptEvent):Void;
	public function onSongEnd(event:ScriptEvent):Void;
	public function onSongReset(event:ScriptEvent):Void;
	public function onGameOver(event:ScriptEvent):Void;
	public function onGameRetry(event:ScriptEvent):Void;

	public function onNoteHit(event:NoteScriptEvent):Void;
	public function onNoteMiss(event:NoteScriptEvent):Void;

	public function onStepHit(event:SongTimeScriptEvent):Void;
	public function onBeatHit(event:SongTimeScriptEvent):Void;

	public function onCountdownStart(event:CountdownScriptEvent):Void;
	public function onCountdownStep(event:CountdownScriptEvent):Void;
	public function onCountdownEnd(event:CountdownScriptEvent):Void;
}