Difference between revisions of "actionParams"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
Line 1: Line 1:
{{Command|= Comments

Revision as of 23:43, 30 August 2019

Introduced with Arma 3 version 1.641.64
Hover & click on the images for descriptions


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
Since Arma 3 v1.93.145625 if object is null or the action doesn't exist, default array of params is returned:


entity actionParams id
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)


Example 1:
_params = player actionParams 0;

Additional Information

See also:


Only post proven facts here. Report bugs on the Feedback Tracker and discuss on the Arma Discord or on the Forums.


Bottom Section