Difference between revisions of "actionParams"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
(missing memorypoint)
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
New array element ''selection'' is available since Arma 3 v1.69.140846|DESCRIPTION=
+
* memoryPoint: [[String]] - memory point on the object to which the action is attached|DESCRIPTION=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  

Revision as of 13:01, 23 April 2019

Introduced with Arma 3 version1.64
  

Click on the images for descriptions

Introduced in

Game:
Arma 3
Version:
1.64

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

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 Nothing - Array of action params or nil if doesn't exist

Examples

Example 1:
_params = player actionParams 0;

Additional Information

Multiplayer:
-
See also:
actionIDsaddActionsetUserActionTextinGameUISetEventHandlershowHUDinputActionremoveActionremoveAllActionsaction

Notes

Only post proven facts here. Report bugs on the feedback tracker. Use the talk page or the forums for discussions.
Add New Note | How To

Notes

Bottom Section