Arma 3 Scripting

inputAction

  • Arma 3 v0.50
  • First in Arma 2 v1.00

Command · Markdown · JSON · original wiki page

Description

Return the state of input devices mapped to given input action.
For Arma 3 inputActions and its bindings see: inputAction/actions.
For earlier Arma editions see Category:Key Actions.

Syntax

inputAction name

Parameters:

Returns: Number

Examples

Example 1

inputAction "leanLeft";

Returns 1 if the button mapped to "leanLeft" is pressed currently else 0.

Example 2

0 spawn {
    waitUntil {inputAction "reloadMagazine" > 0};
    hint "Reload Key Pressed";
};

See also

inputMouse · inputController · actionKeys · actionKeysImages · actionKeysNames · actionIDs · actionParams · addAction · setUserActionText · inGameUISetEventHandler · showHUD · removeAction · removeAllActions · action

Community notes

Worldeater

This command also returns values other than 0 and 1 (like 0.02 or 1.3). Any value greater than zero usually signals that the key or button is pressed. inputAction does not work reliably when used in RscDisplayMission's onKeyDown event handler (the same is probably true for other input related event handlers).

FlannelMouth

inputAction does not return the actual state of the queried key when a dialog screen is open. Instead, it will always return 0.

Waffle SS.

inputAction is capable of returning the state of analog inputs. This includes mouse, joystick, and even TrackIR. A joystick axis will return a value from 0 to 1, while mouse movement returns the rate of change, which can be > 1.

Right mouse click is currently not supported, but right mouse hold is: https://feedback.bistudio.com/T83382