actionKeysNames: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
(Return value in example)
(42 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma |Game name=
|game1= ofpe
|version1= 1.00


|1.00|Game version=
|game2= arma1
|version2= 1.00


|gr1= Interaction |GROUP1=
|game3= arma2
____________________________________________________________________________________________
|version3= 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=
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


| '''actionKeysNames''' userAction |SYNTAX=
|game5= tkoh
|version5= 1.00


|p1= userAction: [[String]] |PARAMETER1=
|game6= arma3
|version6= 0.50


| [[String]] |RETURNVALUE=
|gr1= Interaction
____________________________________________________________________________________________


|s2= '''actionKeysNames''' [userAction, maxKeys] |SYNTAX2=
|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]].


|p21= [userAction, maxKeys]: [[Array]] |PARAMETER21=
|s1= [[actionKeysNames]] userAction


|p22= UserAction: [[String]] |PARAMETER22=
|p1= userAction: [[String]]


|p23= maxKeys: [[Number]] - Maximum number of keys to return |PARAMETER23=
|r1= [[String]]


|r2= [[String]] |RETURNVALUE2=
|s2= [[actionKeysNames]] [userAction, maxKeys, inputDevicePriority]
____________________________________________________________________________________________


|s3= '''actionKeysNames''' [userAction, maxKeys, inputDevicePriority]            ''(Since Arma 3 v1.35.127928)''|SYNTAX3=
|p21= userAction: [[String]]


|p31= [userAction, maxKeys, inputDevicePriority]: [[Array]] |PARAMETER31=
|p22= maxKeys: [[Number]] - maximum number of keys to return


|p32= UserAction: [[String]] |PARAMETER32=
|p23= inputDevicePriority: [[String]] - result sorted by inputDevicePriority with values:
 
* {{hl|"Mouse"}}
|p33= maxKeys: [[Number]] - Maximum number of keys to return |PARAMETER33=
* {{hl|"Keyboard"}}
 
* {{hl|"Stick"}}
|p34= inputDevicePriority: [[String]] - Result sorted by inputDevicePriority with values:
* {{hl|"Gamepad"}}
* <tt>"Mouse"</tt>
* {{hl|"Tracker"}}
* <tt>"Keyboard"</tt>
* {{hl|"Combo"}} (mouse and keyboard combinations)
* <tt>"Stick"</tt>
* {{sic|{{hl|"Controler"}}}} (any controller other than mouse or keyboard)
* <tt>"Gamepad"</tt>
* <tt>"Tracker"</tt>
* <tt>"Combo"</tt> (mouse and keyboard combinations)
* <tt>"Controler"{{sic}}</tt> (any controller other than mouse or keyboard)
Other values are considered as:  
Other values are considered as:  
* <tt>"Unsorted"</tt> |PARAMETER34=
* {{hl|"Unsorted"}}
|p23since= arma3 1.36


|r3= [[String]] |RETURNVALUE3=
|r2= [[String]]
____________________________________________________________________________________________
 
|x1= <code>_list = [[actionKeysNames]] "ReloadMagazine"; //"R"</code> |EXAMPLE1=
____________________________________________________________________________________________


| [[actionKeys]], [[actionKeysImages]], [[actionKeysNamesArray]], [[actionName]], [[inputAction]] |SEEALSO=
|x1= <sqf>_list = actionKeysNames "ReloadMagazine"; // """R"" or ""XBox X"""</sqf>


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


<h3 style="display:none">Notes</h3>
{{Note
<dl class="command_description">
|user= WGL.Q
<!-- Note Section BEGIN -->
|timestamp= 20100120201400
 
|text= The return type is a stacked string. A string inside a string. To compare use first single and inside double quotes:<br>
<dd class="notedate">Posted on 20:14, 20 January 2010 (CET)
<sqf>if (actionKeysNames "User1" == '"W"') then { /* ... */ };</sqf>
<dt class="note">[[User:WGL.Q|kju]]
}}
<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>
if ((actionKeysNames "User1") == '"W"') then ...
 
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|ACTIONKEYSNAMES]]
[[Category:Scripting Commands OFP Elite |ACTIONKEYSNAMES]]
[[Category:Scripting Commands Armed Assault|ACTIONKEYSNAMES]]
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 02:20, 4 August 2023

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=346746"