utilities.Controls - Leather Engine Documentation

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

Constructor

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

Variables

`read onlyACCEPT:Bool`

`read onlyBACK:Bool`

`read onlyCHEAT:Bool`

`read onlyDOWN:Bool`

`read onlyDOWN_P:Bool`

`read onlyDOWN_R:Bool`

`read onlyLEFT:Bool`

`read onlyLEFT_P:Bool`

`read onlyLEFT_R:Bool`

`read onlyPAUSE:Bool`

`read onlyRESET:Bool`

`read onlyRIGHT:Bool`

`read onlyRIGHT_P:Bool`

`read onlyRIGHT_R:Bool`

`read onlyUP:Bool`

`read onlyUP_P:Bool`

`read onlyUP_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`

`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

`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

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

`loadKeyBinds():Void`

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

`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

`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

Inherited Variables

Defined by FlxActionSet

Inherited Methods

Defined by FlxActionSet

`Handle`	steam controller handle from FlxSteam.getConnectedControllers(), or FlxInputDeviceID.FIRST_ACTIVE / ALL
`Attach`	true: adds inputs, false: removes inputs

`Action`	a FlxAction
`Destroy`	whether to destroy it as well

class Controls

package utilities

extends FlxActionSet

Constructor

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

Variables

read onlyACCEPT:Bool

read onlyBACK:Bool

read onlyCHEAT:Bool

read onlyDOWN:Bool

read onlyDOWN_P:Bool

read onlyDOWN_R:Bool

read onlyLEFT:Bool

read onlyLEFT_P:Bool

read onlyLEFT_R:Bool

read onlyPAUSE:Bool

read onlyRESET:Bool

read onlyRIGHT:Bool

read onlyRIGHT_P:Bool

read onlyRIGHT_R:Bool

read onlyUP:Bool

read onlyUP_P:Bool

read onlyUP_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

inlinebindButtons(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>

loadKeyBinds():Void

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

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

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

Inherited Variables

Defined by FlxActionSet

@:value(true)active:Bool = true

read onlyanalogActions:Array<FlxActionAnalog>

read onlydigitalActions:Array<FlxActionDigital>

@:value("")read onlyname:String = ""

Inherited Methods

Defined by FlxActionSet

add(Action:FlxAction):Bool

@:value({ Attach : true })attachSteamController(Handle:Int, Attach:Bool = true):Void

destroy():Void

@:value({ Destroy : true })remove(Action:FlxAction, Destroy:Bool = true):Bool

toJson():String

update():Void

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

`read onlyACCEPT:Bool`

`read onlyBACK:Bool`

`read onlyCHEAT:Bool`

`read onlyDOWN:Bool`

`read onlyDOWN_P:Bool`

`read onlyDOWN_R:Bool`

`read onlyLEFT:Bool`

`read onlyLEFT_P:Bool`

`read onlyLEFT_R:Bool`

`read onlyPAUSE:Bool`

`read onlyRESET:Bool`

`read onlyRIGHT:Bool`

`read onlyRIGHT_P:Bool`

`read onlyRIGHT_R:Bool`

`read onlyUP:Bool`

`read onlyUP_P:Bool`

`read onlyUP_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`

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

`loadKeyBinds():Void`

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

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

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

`@:value(true)active:Bool = true`

`read onlyanalogActions:Array<FlxActionAnalog>`

`read onlydigitalActions:Array<FlxActionDigital>`

`@:value("")read onlyname:String = ""`

`add(Action:FlxAction):Bool`

`@:value({ Attach : true })attachSteamController(Handle:Int, Attach:Bool = true):Void`

`destroy():Void`

`@:value({ Destroy : true })remove(Action:FlxAction, Destroy:Bool = true):Bool`

`toJson():String`

`update():Void`