actionKeysNamesArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <!-- (DIS)?CONTINUE Notes -->" to "")
m (formatting)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma2oa
|game1= arma2oa


|1.51
|version1= 1.51
 
|game2= tkoh
 
|version2= 1.00
 
|game3= arma3
 
|version3= 0.50


|gr1= Interaction
|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]].


| '''actionKeysNamesArray''' userAction
|s1= '''actionKeysNamesArray''' userAction


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


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


|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 inputDevicePriority with values: {{Since|arma3|1.35.127928|y}}
|p23= inputDevicePriority: [[String]] - Result sorted by <tt>inputDevicePriority</tt> with values: {{Since|arma3|1.36|y}}
* <tt>"Mouse"</tt>
* <tt>"Mouse"</tt>
* <tt>"Keyboard"</tt>
* <tt>"Keyboard"</tt>
Line 40: Line 48:
|seealso= [[actionKeys]], [[actionKeysImages]], [[actionKeysNames]], [[actionName]], [[inputAction]]
|seealso= [[actionKeys]], [[actionKeysImages]], [[actionKeysNames]], [[actionName]], [[inputAction]]
}}
}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}
<dl class="command_description">
<dt></dt>
<dd class="notedate">Posted on October 26, 2014 - 11:32 (UTC)</dd>
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<dd class="note">
inputDevicePriority 'Controler' is not a spelling mistake in description.
</dd>
</dl>

Revision as of 08:49, 16 April 2021

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 - An 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
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:
Array of Strings

Examples

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

Additional Information

See also:
actionKeysactionKeysImagesactionKeysNamesactionNameinputAction

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