funkin.backend.system.Controls - Codename Engine API

A list of actions that a player would invoke via some input device. Uses FlxActions to funnel various inputs to a single action.

Static methods

View on GitHub

`staticinlineaddButtons(action:FlxActionDigital, buttons:Array<FlxGamepadInputID>, state:FlxInputState, id:Int):Void`

View on GitHub

`staticinlineaddKeys(action:FlxActionDigital, keys:Array<FlxKey>, state:FlxInputState):Void`

View on GitHub

`staticinlineisGamepad(input:FlxActionInput, deviceID:Int):Bool`

View on GitHub

`staticremoveButtons(action:FlxActionDigital, gamepadID:Int, buttons:Array<FlxGamepadInputID>):Void`

View on GitHub

`staticremoveKeys(action:FlxActionDigital, keys:Array<FlxKey>):Void`

Constructor

View on GitHub

`new(name:String, scheme:KeyboardScheme = None)`

Variables

`ACCEPT:Bool`

`ACCEPT_HOLD:Bool`

`ACCEPT_R:Bool`

`BACK:Bool`

`BACK_HOLD:Bool`

`BACK_R:Bool`

`DEV_ACCESS:Bool`

`DEV_ACCESS_HOLD:Bool`

`DEV_ACCESS_R:Bool`

`DEV_CONSOLE:Bool`

`DEV_CONSOLE_HOLD:Bool`

`DEV_CONSOLE_R:Bool`

`DEV_RELOAD:Bool`

`DEV_RELOAD_HOLD:Bool`

`DEV_RELOAD_R:Bool`

`DOWN:Bool`

`DOWN_P:Bool`

`DOWN_R:Bool`

`LEFT:Bool`

`LEFT_P:Bool`

`LEFT_R:Bool`

`NOTE_DOWN:Bool`

`NOTE_DOWN_P:Bool`

`NOTE_DOWN_R:Bool`

`NOTE_LEFT:Bool`

`NOTE_LEFT_P:Bool`

`NOTE_LEFT_R:Bool`

`NOTE_RIGHT:Bool`

`NOTE_RIGHT_P:Bool`

`NOTE_RIGHT_R:Bool`

`NOTE_UP:Bool`

`NOTE_UP_P:Bool`

`NOTE_UP_R:Bool`

`PAUSE:Bool`

`PAUSE_HOLD:Bool`

`PAUSE_R:Bool`

`RESET:Bool`

`RESET_HOLD:Bool`

`RESET_R:Bool`

`RIGHT:Bool`

`RIGHT_P:Bool`

`RIGHT_R:Bool`

`SWITCHMOD:Bool`

`SWITCHMOD_HOLD:Bool`

`SWITCHMOD_R:Bool`

`UP:Bool`

`UP_P:Bool`

`UP_R:Bool`

`gamepadsAdded:Array<Int> = []`

`keyboardScheme:KeyboardScheme = None`

`inlinebindButtons(control:Control, id:Int, buttons:Array<FlxGamepadInputID>):Void`

Sets all actions that pertain to the binder to trigger when the supplied keys are used. If binder is a literal you can inline this

View on GitHub

`inlinebindKeys(control:Control, keys:Array<FlxKey>):Void`

Sets all actions that pertain to the binder to trigger when the supplied keys are used. If binder is a literal you can inline this

View on GitHub

`getActionFromControl(control:Control):FlxAction`

View on GitHub

`@:nullSafety(Off)inlinegetJustPressed(name:String):Bool`

View on GitHub

`@:nullSafety(Off)inlinegetJustReleased(name:String):Bool`

View on GitHub

`getKeyName(control:Control, idx:Int = 0):String`

View on GitHub

`@:nullSafety(Off)inlinegetPressed(name:String):Bool`

View on GitHub

`inlinemacro_addKeysToActions():Void`

View on GitHub

`removeGamepad(deviceID:Int = FlxInputDeviceID.ALL):Void`

View on GitHub

`replaceBindingGamepad(control:Control, deviceID:Int, ?toAdd:Int, ?toRemove:Int):Void`

View on GitHub

`replaceBindingKeyboard(control:Control, ?toAdd:Int, ?toRemove:Int):Void`

View on GitHub

`setKeyboardScheme(scheme:KeyboardScheme, reset:Bool = true):Void`

View on GitHub

`inlineunbindButtons(control:Control, gamepadID:Int, buttons:Array<FlxGamepadInputID>):Void`

Sets all actions that pertain to the binder to trigger when the supplied keys are used. If binder is a literal you can inline this

View on GitHub

`inlineunbindKeys(control:Control, keys:Array<FlxKey>):Void`

Sets all actions that pertain to the binder to trigger when the supplied keys are used. If binder is a literal you can inline this

class Controls

package funkin.backend.system

extends FlxActionSet

Static methods

staticinlineaddButtons(action:FlxActionDigital, buttons:Array<FlxGamepadInputID>, state:FlxInputState, id:Int):Void

staticinlineaddKeys(action:FlxActionDigital, keys:Array<FlxKey>, state:FlxInputState):Void

staticinlineisGamepad(input:FlxActionInput, deviceID:Int):Bool

staticremoveButtons(action:FlxActionDigital, gamepadID:Int, buttons:Array<FlxGamepadInputID>):Void

staticremoveKeys(action:FlxActionDigital, keys:Array<FlxKey>):Void

Constructor

new(name:String, scheme:KeyboardScheme = None)

Variables

ACCEPT:Bool

ACCEPT_HOLD:Bool

ACCEPT_R:Bool

BACK:Bool

BACK_HOLD:Bool

BACK_R:Bool

DEV_ACCESS:Bool

DEV_ACCESS_HOLD:Bool

DEV_ACCESS_R:Bool

DEV_CONSOLE:Bool

DEV_CONSOLE_HOLD:Bool

DEV_CONSOLE_R:Bool

DEV_RELOAD:Bool

DEV_RELOAD_HOLD:Bool

DEV_RELOAD_R:Bool

DOWN:Bool

DOWN_P:Bool

DOWN_R:Bool

LEFT:Bool

LEFT_P:Bool

LEFT_R:Bool

NOTE_DOWN:Bool

NOTE_DOWN_P:Bool

NOTE_DOWN_R:Bool

NOTE_LEFT:Bool

NOTE_LEFT_P:Bool

NOTE_LEFT_R:Bool

NOTE_RIGHT:Bool

NOTE_RIGHT_P:Bool

NOTE_RIGHT_R:Bool

NOTE_UP:Bool

NOTE_UP_P:Bool

NOTE_UP_R:Bool

PAUSE:Bool

PAUSE_HOLD:Bool

PAUSE_R:Bool

RESET:Bool

RESET_HOLD:Bool

RESET_R:Bool

RIGHT:Bool

RIGHT_P:Bool

RIGHT_R:Bool

SWITCHMOD:Bool

SWITCHMOD_HOLD:Bool

SWITCHMOD_R:Bool

UP:Bool

UP_P:Bool

UP_R:Bool

gamepadsAdded:Array<Int> = []

keyboardScheme:KeyboardScheme = None

Methods

addDefaultGamepad(id:Int):Void

addGamepad(id:Int, buttonMap:Map<Control, Array<FlxGamepadInputID>>):Void

inlinebindButtons(control:Control, id:Int, buttons:Array<FlxGamepadInputID>):Void

inlinebindKeys(control:Control, keys:Array<FlxKey>):Void

getActionFromControl(control:Control):FlxAction

@:nullSafety(Off)inlinegetJustPressed(name:String):Bool

@:nullSafety(Off)inlinegetJustReleased(name:String):Bool

getKeyName(control:Control, idx:Int = 0):String

@:nullSafety(Off)inlinegetPressed(name:String):Bool

inlinemacro_addKeysToActions():Void

removeGamepad(deviceID:Int = FlxInputDeviceID.ALL):Void

replaceBindingGamepad(control:Control, deviceID:Int, ?toAdd:Int, ?toRemove:Int):Void

replaceBindingKeyboard(control:Control, ?toAdd:Int, ?toRemove:Int):Void

setKeyboardScheme(scheme:KeyboardScheme, reset:Bool = true):Void

inlineunbindButtons(control:Control, gamepadID:Int, buttons:Array<FlxGamepadInputID>):Void

inlineunbindKeys(control:Control, keys:Array<FlxKey>):Void

`staticinlineaddButtons(action:FlxActionDigital, buttons:Array<FlxGamepadInputID>, state:FlxInputState, id:Int):Void`

`staticinlineaddKeys(action:FlxActionDigital, keys:Array<FlxKey>, state:FlxInputState):Void`

`staticinlineisGamepad(input:FlxActionInput, deviceID:Int):Bool`

`staticremoveButtons(action:FlxActionDigital, gamepadID:Int, buttons:Array<FlxGamepadInputID>):Void`

`staticremoveKeys(action:FlxActionDigital, keys:Array<FlxKey>):Void`

`new(name:String, scheme:KeyboardScheme = None)`

`ACCEPT:Bool`

`ACCEPT_HOLD:Bool`

`ACCEPT_R:Bool`

`BACK:Bool`

`BACK_HOLD:Bool`

`BACK_R:Bool`

`DEV_ACCESS:Bool`

`DEV_ACCESS_HOLD:Bool`

`DEV_ACCESS_R:Bool`

`DEV_CONSOLE:Bool`

`DEV_CONSOLE_HOLD:Bool`

`DEV_CONSOLE_R:Bool`

`DEV_RELOAD:Bool`

`DEV_RELOAD_HOLD:Bool`

`DEV_RELOAD_R:Bool`

`DOWN:Bool`

`DOWN_P:Bool`

`DOWN_R:Bool`

`LEFT:Bool`

`LEFT_P:Bool`

`LEFT_R:Bool`

`NOTE_DOWN:Bool`

`NOTE_DOWN_P:Bool`

`NOTE_DOWN_R:Bool`

`NOTE_LEFT:Bool`

`NOTE_LEFT_P:Bool`

`NOTE_LEFT_R:Bool`

`NOTE_RIGHT:Bool`

`NOTE_RIGHT_P:Bool`

`NOTE_RIGHT_R:Bool`

`NOTE_UP:Bool`

`NOTE_UP_P:Bool`

`NOTE_UP_R:Bool`

`PAUSE:Bool`

`PAUSE_HOLD:Bool`

`PAUSE_R:Bool`

`RESET:Bool`

`RESET_HOLD:Bool`

`RESET_R:Bool`

`RIGHT:Bool`

`RIGHT_P:Bool`

`RIGHT_R:Bool`

`SWITCHMOD:Bool`

`SWITCHMOD_HOLD:Bool`

`SWITCHMOD_R:Bool`

`UP:Bool`

`UP_P:Bool`

`UP_R:Bool`

`gamepadsAdded:Array<Int> = []`

`keyboardScheme:KeyboardScheme = None`

`addDefaultGamepad(id:Int):Void`

`addGamepad(id:Int, buttonMap:Map<Control, Array<FlxGamepadInputID>>):Void`

`inlinebindButtons(control:Control, id:Int, buttons:Array<FlxGamepadInputID>):Void`

`inlinebindKeys(control:Control, keys:Array<FlxKey>):Void`

`getActionFromControl(control:Control):FlxAction`

`@:nullSafety(Off)inlinegetJustPressed(name:String):Bool`

`@:nullSafety(Off)inlinegetJustReleased(name:String):Bool`

`getKeyName(control:Control, idx:Int = 0):String`

`@:nullSafety(Off)inlinegetPressed(name:String):Bool`

`inlinemacro_addKeysToActions():Void`

`removeGamepad(deviceID:Int = FlxInputDeviceID.ALL):Void`

`replaceBindingGamepad(control:Control, deviceID:Int, ?toAdd:Int, ?toRemove:Int):Void`

`replaceBindingKeyboard(control:Control, ?toAdd:Int, ?toRemove:Int):Void`

`setKeyboardScheme(scheme:KeyboardScheme, reset:Bool = true):Void`

`inlineunbindButtons(control:Control, gamepadID:Int, buttons:Array<FlxGamepadInputID>):Void`

`inlineunbindKeys(control:Control, keys:Array<FlxKey>):Void`