actionParams: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "<code>$1$2$3</code>") |
Lou Montana (talk | contribs) m (Text replacement - "<code>([^ ]*)\[\[([a-zA-Z0-9_]+)\]\]([^ ]*)<\/code>" to "<code>$1$2$3</code>") |
||
| Line 32: | Line 32: | ||
}} | }} | ||
If ''entity'' is [[objNull]], the following array is returned: | If ''entity'' is [[objNull]], the following array is returned: | ||
<code>["", "", nil, 1.5, | <code>["", "", nil, 1.5, true, [[true]], "", "", 50, [[false]], "", "", "", ""]</code> | ||
(returned [[Nothing]] until {{arma3}} v1.94) | (returned [[Nothing]] until {{arma3}} v1.94) | ||
|x1= <code>_params = player | |x1= <code>_params = player actionParams 0;</code> | ||
|seealso= [[actionIDs]] [[addAction]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]] [[removeAction]] [[removeAllActions]] [[action]] | |seealso= [[actionIDs]] [[addAction]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]] [[removeAction]] [[removeAllActions]] [[action]] | ||
}} | }} | ||
Revision as of 11:01, 12 May 2022
Description
- Description:
- Returns Array with params for given user action id (similar to addAction param array).
- Groups:
- Interaction
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 in format [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, textWindowBackground, textWindowForeground, selection, memoryPoint]:
- 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
If entity is objNull, the following array is returned:
(returned Nothing until Arma 3 v1.94)["", "", nil, 1.5, true, true, "", "", 50, false, "", "", "", ""]
Examples
- Example 1:
_params = player actionParams 0;
Additional Information
- See also:
- actionIDs addAction setUserActionText inGameUISetEventHandler showHUD inputAction removeAction removeAllActions action
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