actionParams: Difference between revisions
Jump to navigation
Jump to search
m (Update) |
Killzone Kid (talk | contribs) (fixed) |
||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 8: | Line 8: | ||
| Returns [[Array]] with params for given user action id (similar to [[addAction]] param array). The output array is of the following format: | | Returns [[Array]] with params for given user action id (similar to [[addAction]] param array). The output array is of the following format: | ||
<tt>[title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, textWindowBackground, textWindowForeground, selection]</tt>, where: | <tt>[title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, textWindowBackground, textWindowForeground, selection, memoryPoint]</tt>, where: | ||
* title: [[String]] - action title text | * title: [[String]] - action title text | ||
* script: [[String]] - script file or script expression assigned to the action | * script: [[String]] - script file or script expression assigned to the action | ||
| Line 22: | Line 22: | ||
* textWindowForeground: [[String]] - same as textWindowForeground in [[setUserActionText]] | * textWindowForeground: [[String]] - same as textWindowForeground in [[setUserActionText]] | ||
* selection: [[String]] - named selection in Geometry LOD to which the action is attached | * selection: [[String]] - named selection in Geometry LOD to which the action is attached | ||
* memoryPoint: [[String]] - memory point on the object to which the action is attached | |||
Since Arma 3 v1.93.145625 if object is null or the action doesn't exist, default array of params is returned:<br> | |||
<tt>["","",<null>,1.5,true,true,"","",50,false,"","","",""]</tt> |DESCRIPTION= | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| entity [[actionParams]] id |= | | entity [[actionParams]] id |SYNTAX= | ||
|p1= entity: [[Object]] - entity with added user actions |= | |p1= entity: [[Object]] - entity with added user actions |PARAMETER1= | ||
|p2= id: [[Number]] - id of existing user action (returned by [[addAction]] or [[actionIDs]]) |= | |p2= id: [[Number]] - id of existing user action (returned by [[addAction]] or [[actionIDs]]) |PARAMETER2= | ||
| [[Array]] | | [[Array]] (or, prior to Arma 3 v1.93.145625, [[Nothing]] if action doesn't exist) |RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
|x1= <code>_params = [[player]] [[actionParams]] 0;</code> |= | |x1= <code>_params = [[player]] [[actionParams]] 0;</code> |EXAMPLE1= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [[actionIDs]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]] |= | | [[actionIDs]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]] |SEEALSO= | ||
| |= | | |MPBEHAVIOUR= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
}} | }} | ||
Revision as of 12:35, 1 May 2019
Description
- Description:
- Returns Array with params for given user action id (similar to addAction param array). The output array is of the following format:
[title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, textWindowBackground, textWindowForeground, selection, memoryPoint], where:
- title: String - action title text
- script: String - script file or script expression assigned to the action
- arguments: Anything or nil - arguments passed to the action
- priority: Number - action priority on the action menu
- showWindow: Boolean - whether the action is shown in the center of the screen too
- hideOnUse: Boolean - whether the action menu should close after selecting the action
- shortcut: String - action bindings to some existing engine action if any
- condition: String - expression returning true or nil for action to appear on the action menu
- radius: Number - max distance to entity at which action becomes available. -1 means it is engine default (~15m)
- unconscious: Boolean - whether the action is available to unconscious person
- textWindowBackground: String - same as textWindowBackground in setUserActionText
- textWindowForeground: String - same as textWindowForeground in setUserActionText
- selection: String - named selection in Geometry LOD to which the action is attached
- memoryPoint: String - memory point on the object to which the action is attached
["","",<null>,1.5,true,true,"","",50,false,"","","",""] - Groups:
- Uncategorised
Syntax
- Syntax:
- entity actionParams id
- Parameters:
- entity: Object - entity with added user actions
- id: Number - id of existing user action (returned by addAction or actionIDs)
- Return Value:
- Array (or, prior to Arma 3 v1.93.145625, Nothing if action doesn't exist)
Examples
- Example 1:
_params = player actionParams 0;
Additional Information
- See also:
- actionIDsaddActionsetUserActionTextinGameUISetEventHandlershowHUDinputActionremoveActionremoveAllActionsaction
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