actionKeysNames: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " \| *s([0-9]) *= ([^ ]+)? ?'''([a-zA-Z0-9_]+)''' ?([^ ]+)? " to " |s$1= $2 $3 $4 ")
m (Text replacement - "\] +\[" to "] [")
 
(19 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


|game1= arma1
|game1= ofpe
|version1= 1.00
|version1= 1.00
|game2= arma1
|version2= 1.00
|game3= arma2
|version3= 1.00
|game4= arma2oa
|version4= 1.50
|game5= tkoh
|version5= 1.00
|game6= arma3
|version6= 0.50


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


|s1= [[actionKeysNames]]  userAction
|s1= [[actionKeysNames]]  userAction


|p1= userAction: [[String]]
|p1= userAction: [[String]]
Line 14: Line 30:
|r1= [[String]]
|r1= [[String]]


|s2= [[actionKeysNames]] [userAction, maxKeys, inputDevicePriority]
|s2= [[actionKeysNames]] [userAction, maxKeys, inputDevicePriority]


|p21= userAction: [[String]]
|p21= userAction: [[String]]
Line 20: Line 36:
|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 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)
* <tt>"Controler"{{sic}}</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= [[String]]
|r2= [[String]]


|x1= <code>_list = [[actionKeysNames]] "ReloadMagazine"; {{cc|"R"}}</code>
|x1= <sqf>_list = actionKeysNames "ReloadMagazine"; // """R"" or ""XBox X"""</sqf>


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


<dl class="command_description">
{{Note
 
|user= WGL.Q
<dt><dt>
|timestamp= 20100120201400
<dd class="notedate">Posted on 20:14, 20 January 2010 (CET) </dd>
|text= The return type is a stacked string. A string inside a string. To compare use first single and inside double quotes:<br>
<dt class="note">[[User:WGL.Q|kju]]</dt>
<sqf>if (actionKeysNames "User1" == '"W"') then { /* ... */ };</sqf>
<dd class="note">The return type is a stacked string. A string inside a string. To compare use first single and inside double quotes:<br>
}}
<code>[[if]] ([[actionKeysNames]] "User1" == '"W"') [[then]] { ... };</code>
</dd>
 
</dl>
 
{{GameCategory|ofpe|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 11:46, 5 May 2024

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 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. 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 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:
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 { /* ... */ };
Retrieved from "https://community.bistudio.com/wiki?title=actionKeysNames&oldid=364173"