actionParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Created page with "{{Command|= Comments ____________________________________________________________________________________________ | arma3dev |= Game name |1.63|= Game version _______________...")
 
(see also)
Line 31: Line 31:
|x1= <code>_params = [[player]] [[actionParams]] 0;</code> |= Example 1
|x1= <code>_params = [[player]] [[actionParams]] 0;</code> |= Example 1
____________________________________________________________________________________________
____________________________________________________________________________________________
| [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]] |= See Also
| [[actionIDs]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]] |= See Also


|  |= MPBEHAVIOUR  
|  |= MPBEHAVIOUR  

Revision as of 18:59, 8 August 2016

-wrong parameter ("arma3dev") defined!-[[:Category:Introduced with arma3dev version 1.63|1.63]]
Hover & click on the images for description

Description

Description:
Returns Array with params for given 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], 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
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]]

Notes

Bottom Section