Codename LogoCodename Logo

funkin.backend.scripting.events.InputSystemEvent

APIWiki
View source

final class InputSystemEvent

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

justPressed:Array<Bool>

Array containing whenever a specific control was pressed (not hold) this frame or not. For example, justPressed[0] will return whenever the left strum was just pressed.

justReleased:Array<Bool>

Array containing whenever a specific control was released this frame or not. For example, justReleased[0] will return whenever the left strum was just released.

pressed:Array<Bool>

Array containing whenever a specific control is pressed or not. For example, pressed[0] will return whenever the left strum was pressed.

strumLine:StrumLine

Strumline which input is being processed.

strumLineID:Int

ID of the Strumline.

Methods

View in GitHub

recycle(pressed:Array<Bool>, justPressed:Array<Bool>, justReleased:Array<Bool>, strumLine:StrumLine, strumLineID:Int):InputSystemEvent

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