actionKeysNamesArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatting)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(20 intermediate revisions by 2 users not shown)
Line 2: Line 2:


|game1= arma2oa
|game1= arma2oa
 
|version1= 1.50
|version1= 1.51


|game2= tkoh
|game2= tkoh
|version2= 1.00
|version2= 1.00


|game3= arma3
|game3= arma3
|version3= 0.50
|version3= 0.50


Line 17: Line 14:
|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]].
|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]].


|s1= '''actionKeysNamesArray''' userAction
|s1= [[actionKeysNamesArray]]  userAction


|p1= userAction: [[String]] - Name of the action
|p1= userAction: [[String]] - name of the action


|r1= [[Array]] - An array of [[String|Strings]]
|r1= [[Array]] of [[String]]s


|s2= '''actionKeysNamesArray''' [userAction, maxKeys, inputDevicePriority]
|s2= [[actionKeysNamesArray]]  [userAction, maxKeys, inputDevicePriority]


|p21= userAction: [[String]] - Name of the action
|p21= userAction: [[String]] - name of the action


|p22= maxKeys: [[Number]] - Maximum number of keys to return
|p22= maxKeys: [[Number]] - maximum number of keys to return


|p23= inputDevicePriority: [[String]] - Result sorted by <tt>inputDevicePriority</tt> with values: {{Since|arma3|1.36|y}}
|p23= inputDevicePriority: [[String]] - result sorted by {{hl|inputDevicePriority}} with values:
* <tt>"Mouse"</tt>
* {{hl|"Mouse"}}
* <tt>"Keyboard"</tt>
* {{hl|"Keyboard"}}
* <tt>"Stick"</tt>
* {{hl|"Stick"}}
* <tt>"Gamepad"</tt>
* {{hl|"Gamepad"}}
* <tt>"Tracker"</tt>
* {{hl|"Tracker"}}
* <tt>"Combo"</tt> (mouse and keyboard combinations)
* {{hl|"Combo"}} (mouse and keyboard combinations)
* {{sic|<tt>"Controler"</tt>}} (any controller other than mouse or keyboard)
* {{sic|{{hl|"Controler"}}}} (any controller other than mouse or keyboard)
Other values are considered as:  
Other values are considered as:  
* <tt>"Unsorted"</tt>
* {{hl|"Unsorted"}}
 
|p23since= arma3 1.36
 
|r2= [[Array]] of [[String]]s


|r2= [[Array]] of [[String|Strings]]
|x1= <sqf>_actionList = actionKeysNamesArray "ReloadMagazine";</sqf>
 
|x1= <code>_actionList = [[actionKeysNamesArray]] "ReloadMagazine";</code>


|x2= <code>_actionList = [[actionKeysNamesArray]] ["ReloadMagazine", 1];</code>
|x2= <sqf>_actionList = actionKeysNamesArray ["ReloadMagazine", 1];</sqf>


|seealso= [[actionKeys]], [[actionKeysImages]], [[actionKeysNames]], [[actionName]], [[inputAction]]
|seealso= [[actionKeys]] [[actionKeysImages]] [[actionKeysNames]] [[actionName]] [[inputAction]]
}}
}}

Latest revision as of 16:47, 8 November 2023

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 Arma 3 logo black.png1.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