actionKeysNamesArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:ArmA 2 OA: New Scripting Commands List" to "[[Category:Arma 2: Operation Arrowhead: New Scripting Commands List")
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *R([a-z ])" to "$1 - r$2")
 
(40 intermediate revisions by 3 users not shown)
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. 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 |PARAMETER1=
|s1= [[actionKeysNamesArray]] userAction


| [[Array]] of [[String|Strings]] |RETURNVALUE=
|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]]|PARAMETER21=
|p21= userAction: [[String]] - name of the action


|p22= userAction: [[String]] - Name of the action |=
|p22= maxKeys: [[Number]] - maximum number of keys to return
|p23= maxKeys: [[Number]] - Maximum number of keys to return |=


|r2= [[Array]] of [[String|Strings]]|=
|p23= inputDevicePriority: [[String]] - result sorted by {{hl|inputDevicePriority}} with values:
____________________________________________________________________________________________
* {{hl|"Mouse"}}
 
* {{hl|"Keyboard"}}
|s3= '''actionKeysNamesArray''' [userAction, maxKeys, inputDevicePriority]            ''(Since Arma 3 v1.35.127928)''|SYNTAX2=
* {{hl|"Stick"}}
 
* {{hl|"Gamepad"}}
|p41= [userAction, maxKeys, inputDevicePriority]: [[Array]] |PARAMETER1=
* {{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"}}


|p42= UserAction: [[String]] - Name of the action |PARAMETER2=
|p23since= arma3 1.36


|p43= maxKeys: [[Number]] - Maximum number of keys to return |PARAMETER3=
|r2= [[Array]] of [[String]]s


|p44= inputDevicePriority: [[String]] - Result sorted by inputDevicePriority with values:
|x1= <sqf>_actionList = actionKeysNamesArray "ReloadMagazine";</sqf>
* <tt>"Mouse"</tt>
* <tt>"Keyboard"</tt>
* <tt>"Stick"</tt>
* <tt>"Gamepad"</tt>
* <tt>"Tracker"</tt>
* <tt>"Combo"</tt> (mouse and keyboard combinations)
* <tt>"Controler"</tt> (any controller other than mouse or keyboard)
Other values are considered as:
* <tt>"Unsorted"</tt>
|r3= [[Array]] of [[String|Strings]]|=
____________________________________________________________________________________________
 
|x1= <code>list = [[actionKeysNamesArray]] "ReloadMagazine";</code> |EXAMPLE1=
|x2= <code>list = [[actionKeysNamesArray]] ["ReloadMagazine", 1];</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[actionKeys]], [[actionKeysImages]], [[actionKeysNames]], [[actionName]], [[inputAction]] |SEEALSO=
|x2= <sqf>_actionList = actionKeysNamesArray ["ReloadMagazine", 1];</sqf>


|seealso= [[actionKeys]] [[actionKeysImages]] [[actionKeysNames]] [[actionName]] [[inputAction]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Arma 2: Operation Arrowhead: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
<!-- CONTINUE Notes -->
<dl class="command_description">
<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>
<!-- DISCONTINUE Notes -->

Latest revision as of 16:47, 8 November 2023

A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.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 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
Retrieved from "https://community.bistudio.com/wiki?title=actionKeysNamesArray&oldid=349089"