actionKeysNames: Difference between revisions

Latest revision as of 12:46, 5 May 2024

1.00

1.50

1.00

0.50

Hover & click on the images for description

Description

Description:: Returns a list of button names assigned to the given user action. Action names can be found 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

since 1.36

inputDevicePriority: String - result sorted by inputDevicePriority with values:

"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"" or ""XBox X"""

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

WGL.Q - c: Posted on Jan 20, 2010 - 20:14 (UTC)
: 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: @@
-[[Category:Scripting Commands|ACTIONKEYSNAMES]]
+{{RV|type=command
-[[Category:Scripting Commands OFP Elite |ACTIONKEYSNAMES]]
-[[Category:Scripting Commands ArmA|ACTIONKEYSNAMES]]
+|game1= ofpe
+|version1= 1.00
-<h2 style="color:#000066">''' actionKeysNames ''action or [action, maxKeys]'''''</h2>
+|game2= arma1
+|version2= 1.00
+|game3= arma2
+|version3= 1.00
-'''Operand types:'''
+|game4= arma2oa
+|version4= 1.50
-'''action or [action, maxKeys]:''' [[String]] or [[Array]]
+|game5= tkoh
+|version5= 1.00
-'''Type of returned value:'''
+|game6= arma3
+|version6= 0.50
-[[String]]
+|gr1= Interaction
-'''Compatibility:'''
+|descr= Returns a list of button names assigned to the given user action.
+Action names can be found in config class {{hl|ControllerSchemes}} or [[:Category:Key Actions|user action names]].
-Version 2.01 required.
+|s1= [[actionKeysNames]]  userAction
-'''Description:'''
+|p1= userAction: [[String]]
-Returns a list of button names assigned to the given user '''action'''.
+|r1= [[String]]
-A maximum of '''maxKeys''' keys is listed.
+|s2= [[actionKeysNames]] [userAction, maxKeys, inputDevicePriority]
-You can find the action names in config class ControllerSchemes.
+|p21= userAction: [[String]]
+|p22= maxKeys: [[Number]] - maximum number of keys to return
-'''Example:'''
+|p23= inputDevicePriority: [[String]] - result sorted by inputDevicePriority with values:
+* {{hl|"Mouse"}}
+* {{hl|"Keyboard"}}
+* {{hl|"Stick"}}
+* {{hl|"Gamepad"}}
+* {{hl|"Tracker"}}
+* {{hl|"Combo"}} (mouse and keyboard combinations)
+* {{sic|{{hl|"Controler"}}}} (any controller other than mouse or keyboard)
+Other values are considered as:
+* {{hl|"Unsorted"}}
+|p23since= arma3 1.36
-list = '''actionKeysNames''' "ReloadMagazine"
+|r2= [[String]]
+|x1= <sqf>_list = actionKeysNames "ReloadMagazine"; // """R"" or ""XBox X"""</sqf>
+|seealso= [[actionKeys]] [[actionKeysImages]] [[actionKeysNamesArray]] [[actionName]] [[inputAction]]
+}}
+{{Note
+|user= WGL.Q
+|timestamp= 20100120201400
+|text= The return type is a stacked string. A string inside a string. To compare use first single and inside double quotes:<br>
+<sqf>if (actionKeysNames "User1" == '"W"') then { /* ... */ };</sqf>
+}}