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.

Constructor

View in GitHub

`@:value({ scheme : None })new(name:String, scheme:KeyboardScheme = None)`

Variables

`ACCEPT:Bool`

`BACK:Bool`

`CHEAT: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`

`RESET:Bool`

`RIGHT:Bool`

`RIGHT_P:Bool`

`RIGHT_R:Bool`

`SWITCHMOD:Bool`

`UP:Bool`

`UP_P:Bool`

`UP_R:Bool`

`@:value([])gamepadsAdded:Array<Int> = []`

`@:value(KeyboardScheme.None)keyboardScheme:KeyboardScheme = KeyboardScheme.None`

`bindButtons(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 in GitHub

`bindKeys(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 in GitHub

`checkByName(name:Action):Bool`

View in GitHub

`copyFrom(controls:Controls, ?device:Device):Void`

View in GitHub

`inlinecopyTo(controls:Controls, ?device:Device):Void`

View in GitHub

`getDialogueName(action:FlxActionDigital):String`

View in GitHub

`getDialogueNameFromToken(token:String):String`

View in GitHub

`getInputsFor(control:Control, device:Device, ?list:Array<Int>):Array<Int>`

View in GitHub

`getKeyName(control:Control):String`

View in GitHub

`removeDevice(device:Device):Void`

View in GitHub

`@:value({ deviceID : FlxInputDeviceID.ALL })removeGamepad(deviceID:Int = FlxInputDeviceID.ALL):Void`

View in GitHub

`replaceBinding(control:Control, device:Device, ?toAdd:Int, ?toRemove:Int):Void`

View in GitHub

`@:value({ reset : true })setKeyboardScheme(scheme:KeyboardScheme, reset:Bool = true):Void`

View in GitHub

`unbindButtons(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 in GitHub

`unbindKeys(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

Constructor

@:value({ scheme : None })new(name:String, scheme:KeyboardScheme = None)

Variables

ACCEPT:Bool

BACK:Bool

CHEAT: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

RESET:Bool

RIGHT:Bool

RIGHT_P:Bool

RIGHT_R:Bool

SWITCHMOD:Bool

UP:Bool

UP_P:Bool

UP_R:Bool

@:value([])gamepadsAdded:Array<Int> = []

@:value(KeyboardScheme.None)keyboardScheme:KeyboardScheme = KeyboardScheme.None

Methods

addDefaultGamepad(id:Int):Void

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

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

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

checkByName(name:Action):Bool

copyFrom(controls:Controls, ?device:Device):Void

inlinecopyTo(controls:Controls, ?device:Device):Void

getDialogueName(action:FlxActionDigital):String

getDialogueNameFromToken(token:String):String

getInputsFor(control:Control, device:Device, ?list:Array<Int>):Array<Int>

getKeyName(control:Control):String

removeDevice(device:Device):Void

@:value({ deviceID : FlxInputDeviceID.ALL })removeGamepad(deviceID:Int = FlxInputDeviceID.ALL):Void

replaceBinding(control:Control, device:Device, ?toAdd:Int, ?toRemove:Int):Void

@:value({ reset : true })setKeyboardScheme(scheme:KeyboardScheme, reset:Bool = true):Void

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

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

`@:value({ scheme : None })new(name:String, scheme:KeyboardScheme = None)`

`ACCEPT:Bool`

`BACK:Bool`

`CHEAT: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`

`RESET:Bool`

`RIGHT:Bool`

`RIGHT_P:Bool`

`RIGHT_R:Bool`

`SWITCHMOD:Bool`

`UP:Bool`

`UP_P:Bool`

`UP_R:Bool`

`@:value([])gamepadsAdded:Array<Int> = []`

`@:value(KeyboardScheme.None)keyboardScheme:KeyboardScheme = KeyboardScheme.None`

`addDefaultGamepad(id:Int):Void`

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

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

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

`checkByName(name:Action):Bool`

`copyFrom(controls:Controls, ?device:Device):Void`

`inlinecopyTo(controls:Controls, ?device:Device):Void`

`getDialogueName(action:FlxActionDigital):String`

`getDialogueNameFromToken(token:String):String`

`getInputsFor(control:Control, device:Device, ?list:Array<Int>):Array<Int>`

`getKeyName(control:Control):String`

`removeDevice(device:Device):Void`

`@:value({ deviceID : FlxInputDeviceID.ALL })removeGamepad(deviceID:Int = FlxInputDeviceID.ALL):Void`

`replaceBinding(control:Control, device:Device, ?toAdd:Int, ?toRemove:Int):Void`

`@:value({ reset : true })setKeyboardScheme(scheme:KeyboardScheme, reset:Bool = true):Void`

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

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