Codename LogoCodename Logo

funkin.backend.scripting.events.StateEvent

APIWiki
View source

final class StateEvent

package funkin.backend.scripting.events

extends CancellableEvent

@:build(funkin.backend.system.macros.EventMacro.build())@:autoBuild(funkin.backend.system.macros.EventMacro.build())

Constructor

View in GitHub

new()

Variables

substate:FlxState

Substate that is about to be opened/closed

Methods

View in GitHub

recycle(substate:FlxState):StateEvent

Inherited Variables

Defined by CancellableEvent

data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

View in GitHub

destroy():Void

View in GitHub

preventDefault(c:Bool = false):Void

Prevents default action from occurring.

Parameters:

c

Whenever the scripts following this one should be called or not. (Defaults to true)

View in GitHub

recycleBase():Void

View in GitHub

toString():String

Returns a string representation of the event, in this format: [CancellableEvent] [CancellableEvent (Cancelled)]

Returns:

String