actionKeysImages: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]OFP[ _]Elite *(\|.*)?\]\]" to "{{GameCategory|ofpe|Scripting Commands}}")
m (Some wiki formatting)
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |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 images or names assigned to the given user action. A maximum of maxKeys keys is listed. You can find the action names in config class ControllerSchemes or [[:Category:Key Actions|user action names]]. |DESCRIPTION=
|game4= arma2oa
____________________________________________________________________________________________
|version4= 1.50


| [[Structured Text]] <nowiki>=</nowiki> '''actionKeysImages''' userAction |SYNTAX=
|game5= tkoh
|version5= 1.00


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


| [[Structured Text]] |RETURNVALUE=
|gr1= Interaction
____________________________________________________________________________________________


|s2= [[Structured Text]] <nowiki>=</nowiki> '''actionKeysImages''' [userAction, maxKeys] |SYNTAX2=
|descr= Returns a list of button images or names assigned to the given user action.
A maximum of ''maxKeys'' keys is listed.
You can find the action names in the ControllerSchemes config class or [[:Category:Key Actions|user action names]].


|p21= [userAction, maxKeys]: [[Array]] |PARAMETER2=
|s1= [[actionKeysImages]] userAction


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


|p23= maxKeys: [[Number]] |PARAMETER23=
|r1= [[Structured Text]]


|r2= [[Structured Text]] |RETURNVALUE2=
|s2= [[actionKeysImages]] [userAction, maxKeys]
____________________________________________________________________________________________
 
|x1= <pre>_text = actionKeysImages "ReloadMagazine"</pre> |EXAMPLE1=
|x2= <pre>_reload = actionKeysImages ["ReloadMagazine",1]</pre>will return '''"R"''' (incl. the quotation marks!) |EXAMPLE2=
____________________________________________________________________________________________


| [[actionKeys]], [[actionKeysNames]], [[actionKeysNamesArray]], [[actionName]], [[inputAction]]  |SEEALSO=
|p21= userAction: [[String]]


}}
|p22= maxKeys: [[Number]]


<h3 style="display:none">Notes</h3>
|r2= [[Structured Text]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x1= <sqf>_text = actionKeysImages "ReloadMagazine";</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>_reload = actionKeysImages ["ReloadMagazine", 1] // returns "R" (including the quotation marks!)</sqf>


[[Category:Scripting Commands|ACTIONKEYSIMAGES]]
|seealso= [[actionKeys]] [[actionKeysNames]] [[actionKeysNamesArray]] [[actionName]] [[inputAction]]
{{GameCategory|ofpe|Scripting Commands}}
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 23:13, 27 September 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 images or names assigned to the given user action. A maximum of maxKeys keys is listed. You can find the action names in the ControllerSchemes config class or user action names.
Groups:
Interaction

Syntax

Syntax:
actionKeysImages userAction
Parameters:
userAction: String
Return Value:
Structured Text

Alternative Syntax

Syntax:
actionKeysImages [userAction, maxKeys]
Parameters:
userAction: String
maxKeys: Number
Return Value:
Structured Text

Examples

Example 1:
_text = actionKeysImages "ReloadMagazine";
Example 2:
_reload = actionKeysImages ["ReloadMagazine", 1] // returns "R" (including the quotation marks!)

Additional Information

See also:
actionKeys actionKeysNames 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
Retrieved from "https://community.bistudio.com/wiki?title=actionKeysImages&oldid=369623"