View source

class SubStateScriptEvent

package funkin.modding.events

extends ScriptEvent

import funkin.modding.events.ScriptEvent

@:directlyUsed

Available on all platforms

An event that is fired when moving out of or into an FlxSubState.

Constructor

@:value({ cancelable : false })new(type:ScriptEventType, targetState:FlxSubState, cancelable:Bool = false)

Variables

read onlytargetState:FlxSubState

The state the game is moving into.

Methods

Inherited Variables

Defined by ScriptEvent

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.

read onlytype:ScriptEventType

The type associated with the event.

Inherited Methods

Defined by ScriptEvent

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.

stopPropagation():Void

Call this function to stop any other Scripteds from receiving the event.