Codename LogoCodename Logo

funkin.backend.scripting.events.DynamicEvent

APIWiki
View source

final class DynamicEvent

package funkin.backend.scripting.events

extends CancellableEvent

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

Event with random dynamic values useful for making your own custom events

Constructor

View in GitHub

new()

Variables

@:value(null)value1:Dynamic = null

@:value(null)value2:Dynamic = null

@:value(null)value3:Dynamic = null

@:value(null)value4:Dynamic = null

@:value(null)value5:Dynamic = null

Methods

View in GitHub

@:value({ value5 : null, value4 : null, value3 : null, value2 : null, value1 : null })recycle(?value1:Dynamic, ?value2:Dynamic, ?value3:Dynamic, ?value4:Dynamic, ?value5:Dynamic):DynamicEvent

Inherited Variables

Defined by CancellableEvent

@:value({ })data:Dynamic = { }

Additional data if used in scripts

Inherited Methods

Defined by CancellableEvent

View in GitHub

destroy():Void

View in GitHub

@:value({ c : false })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