actionKeysNamesArray: Difference between revisions

Latest revision as of 11:46, 5 May 2024

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. You can find the action names in config class ControllerSchemes or user action names.
Groups:: Interaction

Syntax

Syntax:: actionKeysNamesArray userAction
Parameters:: userAction: String - name of the action
Return Value:: Array of Strings

Alternative Syntax

Syntax:

actionKeysNamesArray [userAction, maxKeys, inputDevicePriority]

Parameters:

userAction: String - name of the action

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:

Array of Strings

Examples

Example 1:: _actionList = actionKeysNamesArray "ReloadMagazine";
Example 2:: _actionList = actionKeysNamesArray ["ReloadMagazine", 1];

Additional Information

See also:: actionKeys actionKeysImages actionKeysNames 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

@@ Line 1: / Line 1: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma2oa |= Game name
+|game1= arma2oa
+|version1= 1.50
-|1.51|= Game version
+|game2= tkoh
-____________________________________________________________________________________________
+|version2= 1.00
-| Returns a list of button names assigned to the given user action. A maximum of maxKeys keys is listed. You can find the action names in config class ControllerSchemes or [[Category:Key_Actions|user action names]]. |= Description
+|game3= arma3
-____________________________________________________________________________________________
+|version3= 0.50
-|'''actionKeysNamesArray''' userAction |= Syntax
+|gr1= Interaction
+|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]].
-|p1= userAction: [[String]] - name of the action |= Parameter 1
+|s1= [[actionKeysNamesArray]]  userAction
-| [[Array]] of [[String|Strings]] |= Return value
+|p1= userAction: [[String]] - name of the action
-____________________________________________________________________________________________
+|r1= [[Array]] of [[String]]s
-|s2= '''actionKeysNamesArray''' [userAction, maxKeys] |=
+|s2= [[actionKeysNamesArray]] [userAction, maxKeys, inputDevicePriority]
-|p21= [userAction, maxKeys]: [[Array]]|=
+|p21= userAction: [[String]] - name of the action
-|p22= userAction: [[String]] - name of the action|=
-|p23= maxKeys: [[Number]] - maximum number of listed keys|=
-|r2= [[Array]] of [[String|Strings]]|=
+|p22= maxKeys: [[Number]] - maximum number of keys to return
-____________________________________________________________________________________________
-|x1= <pre>list = actionKeysNamesArray "ReloadMagazine";</pre> |= Example 1
-|x2= <pre>list = actionKeysNamesArray ["ReloadMagazine", 1];</pre> |= Example 2
-____________________________________________________________________________________________
-| [[actionKeys]], [[actionKeysImages]], [[actionKeysNames]] |= See also
+|p23= inputDevicePriority: [[String]] - result sorted by {{hl|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
+|r2= [[Array]] of [[String]]s
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>_actionList = actionKeysNamesArray "ReloadMagazine";</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|x2= <sqf>_actionList = actionKeysNamesArray ["ReloadMagazine", 1];</sqf>
-[[Category:ArmA 2 OA: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
+|seealso= [[actionKeys]] [[actionKeysImages]] [[actionKeysNames]] [[actionName]] [[inputAction]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+}}
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]