actionKeysImages: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (VBS2 scripting category removal)
m (Some wiki formatting)
 
(48 intermediate revisions by 6 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


| 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
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| [[Structured Text]] <nowiki>=</nowiki> '''actionKeysImages''' userAction |= Syntax
|game4= arma2oa
|version4= 1.50


|p1= userAction: [[String]] |= Parameter 1
|game5= tkoh
|version5= 1.00


| [[Structured Text]] |= Return value
|game6= arma3
____________________________________________________________________________________________
|version6= 0.50


|s2= [[Structured Text]] <nowiki>=</nowiki> '''actionKeysImages''' [userAction, maxKeys] |= Syntax
|gr1= Interaction


|p21= [userAction, maxKeys]: [[Array]] |= Parameter 2
|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]].


|p22= userAction: [[String]] |= Parameter 2
|s1= [[actionKeysImages]] userAction


|p23= maxKeys: [[Number]] |= Parameter 3
|p1= userAction: [[String]]


|r2= [[Structured Text]] |= Return value
|r1= [[Structured Text]]
____________________________________________________________________________________________
 
|x1= <pre>_text = actionKeysImages "ReloadMagazine"</pre> |= Example 1
|x2= <pre>_reload = actionKeysImages ["ReloadMagazine",1]</pre>will return '''"R"''' (incl. the quotation marks!) |= Example 2
____________________________________________________________________________________________


| [[actionKeys]], [[actionKeysNames]], [[actionKeysNamesArray]] |= See also
|s2= [[actionKeysImages]] [userAction, maxKeys]


}}
|p21= userAction: [[String]]
 
|p22= maxKeys: [[Number]]
 
|r2= [[Structured Text]]


<h3 style="display:none">Notes</h3>
|x1= <sqf>_text = actionKeysImages "ReloadMagazine";</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->
You can find a list of all available actions [[key_actions_(VBS2)|here]]. The list is for VBS2, so there are a few actions that are not available in Arma.
--[[User:General Barron|General Barron]] 06:08, 3 June 2008 (CEST)
<!-- Note Section END -->
</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]]
[[Category:Scripting Commands OFP Elite |ACTIONKEYSIMAGES]]
}}
[[Category:Scripting Commands ArmA|ACTIONKEYSIMAGES]]
[[Category:Command_Group:_Interaction|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]

Latest revision as of 23:13, 27 September 2024

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