actionKeysEx

From Bohemia Interactive Community
Jump to navigation Jump to search
Hover & click on the images for description
Only available in Development branch(es) until its release with Arma 3 patch v2.10.

Description

Description:
Gives a broken down version of actionKeys return. Returns an Array containing the breakdowns of the dikCodes of keys, buttons and combos assigned to the given user action. Action names can be found in config class ControllerSchemes or user action names or user profile (see Example 1). In addition, some of the actions are also listed here: inputAction/actions The Key Device can be one of several types:
  • "KEYBOARD"
  • "MOUSE_BUTTON"
  • "MOUSE_AXIS"
  • "JOYSTICK_BUTTON"
  • "JOYSTICK_AXIS"
  • "JOYSTICK_POV"
  • "XINPUT" - (Xbox) Controller Input
  • "TRACKER" - Motion Tracking (TrackIR, Tobii etc)
Groups:
Interaction

Syntax

Syntax:
actionKeysEx userAction
Parameters:
userAction: String - user action name (see inputAction/actions)
Return Value:
The action key array format is subject to change as development for Arma 3 logo black.png2.10 is ongoing.

Array of Arrays in format [mainKeyArray, comboKeyArray, isDoubleTap]:

  • mainKeyArray: Array in format [dikCode, device, deviceId]:
    • dikCode: Number
    • device: String
    • deviceId: Number - only given if the device is a Joystick type
  • comboKeyArray: Array identical to mainKeyArray - filled only if the action key is a key combination
    • dikCode: Number
    • device: String
    • deviceId: Number - identical to mainKeyArray's deviceId as it is impossible to use two different Joystick devices in a key combination
  • isDoubleTap: Boolean - is the action key a double-tap. Only possible when there is just the Main Key, as key combinations cannot have a double-tap flag

Examples

Example 1:
To retrieve the following key's data, use the property name without 'key':
keyWatch[] = { 24 };
actionKeysEx "Watch"; // [[[24, "KEYBOARD"], [], false]]
Example 2:
private _result = actionKeysEx "OpticsMode"; // [[[129,"MOUSE_BUTTON"],[29,"KEYBOARD"],false],[[181,"KEYBOARD"],[],false]]

Additional Information

See also:
actionKeys actionKeysNames actionKeysNamesArray

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note