actionParams: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)]]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Some wiki formatting)
 
(33 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.64


|1.64|Game version=
|gr1= Interaction


|gr1= Interaction |GROUP1=
|descr= Returns [[Array]] with params for given user action id (similar to [[addAction]] param array).
____________________________________________________________________________________________


| Returns [[Array]] with params for given user action id (similar to [[addAction]] param array). The output array is of the following format:
|s1= entity [[actionParams]] id
<tt>[title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, textWindowBackground, textWindowForeground, selection, memoryPoint]</tt>,  where:
 
|p1= entity: [[Object]] - entity with added user actions
 
|p2= id: [[Number]] - id of existing user action (returned by [[addAction]] or [[actionIDs]])
 
|r1= [[Array]] in format [title, script, arguments, priority, showWindow, hideOnUse, shortcut, condition, radius, unconscious, textWindowBackground, textWindowForeground, selection, memoryPoint]:
{{Columns|2|
* 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 25: Line 30:
* 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
* memoryPoint: [[String]] - memory point on the object 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:
<sqf>["", "", nil, 1.5, true, true, "", "", 50, false, "", "", "", ""]</sqf>


Since Arma 3 v1.93.145625 if object is null or the action doesn't exist, default array of params is returned:<br>
(returned [[Nothing]] until {{arma3}} v1.94)
<tt>["","",<null>,1.5,true,true,"","",50,false,"","","",""]</tt> |DESCRIPTION=
____________________________________________________________________________________________
 
| entity [[actionParams]] id |SYNTAX=
 
|p1= entity: [[Object]] - entity with added user actions |PARAMETER1=
|p2= id: [[Number]] - id of existing user action (returned by [[addAction]] or [[actionIDs]]) |PARAMETER2=


| [[Array]] (or, prior to Arma 3 v1.93.145625, [[Nothing]] if action doesn't exist) |RETURNVALUE=
|x1= <sqf>_params = player actionParams 0;</sqf>
____________________________________________________________________________________________
|x1= <code>_params = [[player]] [[actionParams]] 0;</code> |EXAMPLE1=
____________________________________________________________________________________________
| [[actionIDs]], [[addAction]], [[setUserActionText]], [[inGameUISetEventHandler]], [[showHUD]], [[inputAction]], [[removeAction]], [[removeAllActions]], [[action]] |SEEALSO=


| |MPBEHAVIOUR=  
|seealso= [[actionIDs]] [[addAction]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]] [[removeAction]] [[removeAllActions]] [[action]]
____________________________________________________________________________________________
}}
}}
<h3 style='display:none'>Notes</h3>
<dl class='command_description'>
</dl>
<h3 style='display:none'>Bottom Section</h3>
{{GameCategory|arma3|New_Scripting_Commands_List}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Latest revision as of 12:00, 14 May 2022

Arma 3 logo black.png1.64
Hover & click on the images for description

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:

["", "", nil, 1.5, true, true, "", "", 50, false, "", "", "", ""]

(returned Nothing until Arma 3 v1.94)

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
Retrieved from "https://community.bistudio.com/wiki?title=actionParams&oldid=321376"