class ScriptEvent
package funkin.modding.events
extended by CapsuleScriptEvent, CharacterSelectScriptEvent, CountdownScriptEvent, DialogueScriptEvent, FocusScriptEvent, FreeplayScriptEvent, GhostMissNoteScriptEvent, KeyboardInputScriptEvent, NoteScriptEvent, PauseScriptEvent, SongEventScriptEvent, SongLoadScriptEvent, SongRetryEvent, SongTimeScriptEvent, StateChangeScriptEvent, SubStateScriptEvent, UpdateScriptEvent
Available on all platforms
This is a base class for all events that are issued to scripted classes. It can be used to identify the type of event called, store data, and cancel event propagation.
Constructor
Variables
read onlycancelable:Bool
If true, the behavior associated with this event can be prevented. For example, cancelling COUNTDOWN_START should prevent the countdown from starting, until another script restarts it, or cancelling NOTE_HIT should cause the note to be missed.
read onlyeventCanceled:Bool
Whether the event has been canceled by one of the scripts that received it.
read onlyshouldPropagate:Bool
Whether the event should continue to be triggered on additional targets.
Methods
cancel():Void
Cancel this event. This is an alias for cancelEvent() but I make this typo all the time.
cancelEvent():Void
Call this function on a cancelable event to cancel the associated behavior. For example, cancelling COUNTDOWN_START will prevent the countdown from starting.