View source

interface IPlayStateScriptedClass

package funkin.modding

extends IBPMSyncedScriptedClass, INoteScriptedClass

import funkin.modding.IScriptedClass

extended by Module, Song, Bopper, Stage

@:directlyUsed

Available on all platforms

Defines a set of callbacks available to scripted classes that involve the lifecycle of the Play State.

Methods

onCountdownEnd(event:CountdownScriptEvent):Void

Called when the countdown of the song ends.

onCountdownStart(event:CountdownScriptEvent):Void

Called when the countdown of the song starts.

onCountdownStep(event:CountdownScriptEvent):Void

Called when the a part of the countdown happens.

onGameOver(event:ScriptEvent):Void

Called as the player runs out of health just before the game over substate is entered.

onNoteGhostMiss(event:GhostMissNoteScriptEvent):Void

Called when the player presses a key when no note is on the strumline.

onPause(event:PauseScriptEvent):Void

Called when the game is paused. Has properties to set whether the pause easter egg will happen, and can be cancelled by scripts.

onResume(event:ScriptEvent):Void

Called when the game is unpaused.

onSongEnd(event:ScriptEvent):Void

Called when the song ends and the song is about to be unloaded.

onSongEvent(event:SongEventScriptEvent):Void

Called when the song reaches an event.

onSongLoaded(event:SongLoadScriptEvent):Void

Called when the song has been parsed, before notes have been placed. Use this to mutate the chart.

onSongRetry(event:SongRetryEvent):Void

Called when the player restarts the song, either via pause menu or restarting after a game over.

onSongStart(event:ScriptEvent):Void

Called when the song starts (conductor time is 0 seconds).