Codename LogoCodename Logo

funkin.backend.scripting.events.MenuChangeEvent

APIWiki
View source

final class MenuChangeEvent

package funkin.backend.scripting.events

extends CancellableEvent

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

Constructor

View in GitHub

new()

Variables

change:Int

Amount of change

oldValue:Int

Value before the change

@:value(true)playMenuSFX:Bool = true

Whenever the menu SFX should be played.

value:Int

Value after the change

Methods

View in GitHub

@:value({ playMenuSFX : true })recycle(oldValue:Int, value:Int, change:Int, playMenuSFX:Bool = true):MenuChangeEvent

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