actionKeysNamesArray: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(alt syntax)
Line 7: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns a list of button 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
| 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
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 13: Line 13:




|p1= userAction: [[String]] - name of the action |= Parameter 1
|p1= userAction: [[String]] - Name of the action |= Parameter 1


| [[Array]] of [[String|Strings]] |= Return value
| [[Array]] of [[String|Strings]] |= Return value
Line 22: Line 22:


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


|r2= [[Array]] of [[String|Strings]]|=
|r2= [[Array]] of [[String|Strings]]|=
____________________________________________________________________________________________
|s3= '''actionKeysNamesArray''' [userAction, maxKeys, inputDevicePriority] |= Syntax 2
|p41= [userAction, maxKeys, inputDevicePriority]: [[Array]] |= Parameter 1
|p42= UserAction: [[String]] - Name of the action |= Parameter 2
|p43= maxKeys: [[Number]] - Maximum number of keys to return |= Parameter 3
|p44= inputDevicePriority: [[String]] - Result sorted by inputDevicePriority with values 'Mouse','Keyboard','Stick','Gamepad','Trackir','Combo' (mouse and keyboard combinations),'Controler' (any controller other then mouse or keyboard). Other values are considered as 'Unsorted'.
|r3= [[Array]] of [[String|Strings]]|=
____________________________________________________________________________________________
____________________________________________________________________________________________
   
   
|x1= <pre>list = actionKeysNamesArray "ReloadMagazine";</pre> |= Example 1
|x1= <code>list = [[actionKeysNamesArray]] "ReloadMagazine";</code> |= Example 1
|x2= <pre>list = actionKeysNamesArray ["ReloadMagazine", 1];</pre> |= Example 2
|x2= <code>list = [[actionKeysNamesArray]] ["ReloadMagazine", 1];</code> |= Example 2
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 13:32, 26 October 2014

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:
Uncategorised

Syntax 1

Syntax:
actionKeysNamesArray userAction
Parameters:
userAction: String - Name of the action
Return Value:
Array of Strings

Syntax 2

Syntax:
actionKeysNamesArray [userAction, maxKeys]
Parameters:
[userAction, maxKeys]: Array
userAction: String - Name of the action
maxKeys: Number - Maximum number of keys to return
Return Value:
Array of Strings

Syntax 3

Syntax:
actionKeysNamesArray [userAction, maxKeys, inputDevicePriority]
Parameters:
[userAction, maxKeys, inputDevicePriority]: Array
UserAction: String - Name of the action
maxKeys: Number - Maximum number of keys to return
inputDevicePriority: String - Result sorted by inputDevicePriority with values 'Mouse','Keyboard','Stick','Gamepad','Trackir','Combo' (mouse and keyboard combinations),'Controler' (any controller other then mouse or keyboard). Other values are considered as 'Unsorted'.
Return Value:
Array of Strings

Examples

Example 1:
list = actionKeysNamesArray "ReloadMagazine";
Example 2:
list = actionKeysNamesArray ["ReloadMagazine", 1];

Additional Information

See also:
actionKeysactionKeysImagesactionKeysNames

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

Notes

Bottom Section