actionKeysNames: Difference between revisions

Revision as of 23:28, 16 February 2021

1.00

Hover & click on the images for description

Description

Description:: Returns a list of button names assigned to the given user action. You can find the action names in config class ControllerSchemes or user action names.
Groups:: Interaction

Syntax

Syntax:: actionKeysNames userAction
Parameters:: userAction: String
Return Value:: String

Alternative Syntax

Syntax:

actionKeysNames [userAction, maxKeys, inputDevicePriority]

Parameters:

userAction: String

maxKeys: Number - maximum number of keys to return

inputDevicePriority: String - result sorted by inputDevicePriority with values: Template:Since

"Mouse"
"Keyboard"
"Stick"
"Gamepad"
"Tracker"
"Combo" (mouse and keyboard combinations)
"Controler"^sic (any controller other than mouse or keyboard)

Other values are considered as:

"Unsorted"

Return Value:

String

Examples

Example 1:: _list = actionKeysNames "ReloadMagazine"; // "R"

Additional Information

See also:: actionKeys actionKeysImages actionKeysNamesArray actionName inputAction

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

Posted on 20:14, 20 January 2010 (CET)
kju: The return type is a stacked string. A string inside a string. To compare use first single and inside double quotes:
if (actionKeysNames "User1" == '"W"') then { ... };

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| arma1
+|game1= arma1
-|1.00
+|version1= 1.00
 |gr1= Interaction
-| Returns a list of button names assigned to the given user action. You can find the action names in config class ControllerSchemes or [[:Category:Key Actions|user action names]].
+|descr= Returns a list of button names assigned to the given user action. You can find the action names in config class ControllerSchemes or [[:Category:Key Actions|user action names]].
-| '''actionKeysNames''' userAction
+|s1= '''actionKeysNames''' userAction
 |p1= userAction: [[String]]
-| [[String]]
+|r1= [[String]]
-|s2= '''actionKeysNames''' [userAction, maxKeys]
+|s2= '''actionKeysNames''' [userAction, maxKeys, inputDevicePriority]
-|p21= [userAction, maxKeys]: [[Array]]
+|p21= userAction: [[String]]
-|p22= UserAction: [[String]]
+|p22= maxKeys: [[Number]] - maximum number of keys to return
-|p23= maxKeys: [[Number]] - Maximum number of keys to return
+|p23= inputDevicePriority: [[String]] - result sorted by inputDevicePriority with values: {{Since|arma3|1.35.127928|y}}
-|r2= [[String]]
-|s3= '''actionKeysNames''' [userAction, maxKeys, inputDevicePriority] {{Since|arma3|1.35.127928|y}}
-|p31= [userAction, maxKeys, inputDevicePriority]: [[Array]]
-|p32= UserAction: [[String]]
-|p33= maxKeys: [[Number]] - Maximum number of keys to return
-|p34= inputDevicePriority: [[String]] - Result sorted by inputDevicePriority with values:
 * <tt>"Mouse"</tt>
 * <tt>"Keyboard"</tt>
@@ Line 44: / Line 32: @@
 * <tt>"Unsorted"</tt>
-|r3= [[String]]
+|r2= [[String]]
-|x1= <code>_list = [[actionKeysNames]] "ReloadMagazine"; //"R"</code>
+|x1= <code>_list = [[actionKeysNames]] "ReloadMagazine"; {{cc|"R"}}</code>
 |seealso= [[actionKeys]], [[actionKeysImages]], [[actionKeysNamesArray]], [[actionName]], [[inputAction]]
@@ Line 57: / Line 45: @@
 <dt class="note">[[User:WGL.Q|kju]]</dt>
 <dd class="note">The return type is a stacked string. A string inside a string. To compare use first single and inside double quotes:<br>
-if ((actionKeysNames "User1") == '"W"') then ...
+<code>[[if]] ([[actionKeysNames]] "User1" == '"W"') [[then]] { ... };</code>
+</dd>
 <!-- Note Section END -->
 </dl>
 {{GameCategory|ofpe|Scripting Commands}}