actionParams: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) mNo edit summary |
Killzone Kid (talk | contribs) (selection) |
||
| Line 7: | Line 7: | ||
| 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]</tt>, where: | <tt>[title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, textWindowBackground, textWindowForeground, selection]</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 19: | Line 19: | ||
* unconscious: [[Boolean]] - whether the action is available to [[setUnconscious|unconscious]] person | * unconscious: [[Boolean]] - whether the action is available to [[setUnconscious|unconscious]] person | ||
* textWindowBackground: [[String]] - same as textWindowBackground in [[setUserActionText]] | * textWindowBackground: [[String]] - same as textWindowBackground in [[setUserActionText]] | ||
* textWindowForeground: [[String]] - same as textWindowForeground in [[setUserActionText]]|= Description | * textWindowForeground: [[String]] - same as textWindowForeground in [[setUserActionText]] | ||
* selection: [[String]] - named selection in Geometry LOD to which the action is attached | |||
New array element ''selection'' is available since Arma 3 v1.69.140846|= Description | |||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
Revision as of 00:36, 14 March 2017
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], 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
- 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 - Array of action params
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
[[Category:Introduced with arma3dev version 1.63]][[ Category: arma3dev: New Scripting Commands | ACTIONPARAMS]][[ Category: arma3dev: Scripting Commands | ACTIONPARAMS]]