action: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(95 intermediate revisions by 23 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands]]
{{RV|type=command
[[Category:Scripting Commands OFP 1.97]]
[[Category:Scripting Commands OFP 1.46]]
[[Category:Scripting Commands ArmA]]


back to [[Scripting_Reference#A|COMREF]]
|game1= ofp
|version1= 1.00


<h2 style="color:#000066">'''''unit'' action ''action'''''</h2>
|game2= ofpe
|version2= 1.00


'''Operand types:'''
|game3= arma1
|version3= 1.00


'''unit:''' [[Object]]
|game4= arma2
|version4= 1.00


'''action:''' [[Array]]
|game5= arma2oa
|version5= 1.50


'''Type of returned value:'''
|game6= tkoh
|version6= 1.00


Nothing
|game7= arma3
|version7= 0.50


'''Description:'''
|eff= global


Make unit peform an action.
|gr1= Interaction


Format of action may be '''''[type, target, param1, param2, param3]'''''.
|descr= Make a unit perform an action. See [[:Category:Actions]] for action names and syntaxes.
{{Feature|arma3|
Since {{arma3}} 2.18 it is possible to use [[actionNow]] to perform some actions immediately without any animation.
However, note that some actions do require animations (for example, opening inventory while on foot), otherwise they will get cancelled.
}}
{{Feature|informative|
* in singleplayer, when user Alt-Tabs the simulation is paused and so the action will also halt until user returns to the game. For example, <sqf inline>player action ["GetInDriver", car];</sqf> executed while user is Alt-Tabbed will result in the user seeing the action happening when he returns to the game screen. This does not happen in Multiplayer.
* the alternative syntax creates a temporary Logic entity in place of ''unit''.
}}


Only type is required, target defaults to unit, '''''param1''''', '''''param2''''', '''''param3''''' are type specific.
|mp= {{Feature|important|
The argument's [[Multiplayer Scripting#Locality|locality]] is '''usually''' local, but some actions can take a global argument (e.g "Eject", "GetOut", "GetInXXXX", "MoveToXXXX").
See [[:Category:Actions]] for more details.
}}


|s1= unit [[action]] actionArray


'''Example:'''
|p1= unit: [[Object]]


soldierOne '''action''' ["eject", [[vehicle]] soldierOne]
|p2= actionArray: [[Array]]
 
|r1= [[Nothing]]
 
|s2= [[action]] actionArray
 
|s2since= arma3 2.10
 
|p21= actionArray: [[Array]]
 
|r2= [[Nothing]]
 
|x1= <sqf>player action ["SitDown", player];</sqf>
 
|x2= <sqf>_soldier action ["Eject", vehicle _soldier];</sqf>
 
|x3= <sqf>
player action ["UseWeapon", player, player, 7]; // plays pick up animation before throwing grenade
action ["UseWeapon", player, player, 7]; // normal grenade throw
</sqf>
 
|seealso= [[actionNow]] [[actionIDs]] [[actionParams]] [[addAction]] [[setUserActionText]] [[inGameUISetEventHandler]] [[showHUD]] [[inputAction]] [[removeAction]] [[removeAllActions]] [[weaponsInfo]]
}}
 
{{Note
|user= Tom_48_97
|timestamp= 20090828092600
|text= In {{arma2}}, you can place a unique unit (for example a boat, far of all combats) and use it for all command lines with action.
}}
 
{{Note
|user= DreadedEntity
|timestamp= 20150327175700
|text= This command has no effect when a dead unit is used as input.
}}
 
{{Note
|user= DrSova
|timestamp= 20170627021500
|text= <sqf>player action ["SWITCHWEAPON", player, player, -1]</sqf>
Switching weapon to the back.
}}
 
{{Note
|user= Yuval
|timestamp= 20170720122200
|text= Some of the actions (such as "DropWeapon") do not always execute, and there should be a set of conditions for them to run.
The unit must be able to perform the dropping animation in order for the action to properly execute.
So, if for example we spawn a unit at [0,0,0] and make it perform a "DropWeapon" action - it won't work if [0,0,0] is water (which it is, if the current map is an island) because the unit will be swimming.<br>
<br>
Also, you cannot stack up actions right after the other. If you run a "DropWeapon" action when the current action animation is still going - it will not perform.
There are a few more conditions for an action to perform, but relying on a hundred percent success of the action is not a good practice.
}}

Latest revision as of 16:56, 23 March 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GEGlobal
Hover & click on the images for description

Description

Description:
Make a unit perform an action. See Category:Actions for action names and syntaxes.
Arma 3
Since Arma 3 2.18 it is possible to use actionNow to perform some actions immediately without any animation. However, note that some actions do require animations (for example, opening inventory while on foot), otherwise they will get cancelled.
ⓘ
  • in singleplayer, when user Alt-Tabs the simulation is paused and so the action will also halt until user returns to the game. For example, player action ["GetInDriver", car]; executed while user is Alt-Tabbed will result in the user seeing the action happening when he returns to the game screen. This does not happen in Multiplayer.
  • the alternative syntax creates a temporary Logic entity in place of unit.
Multiplayer:
⚠
The argument's locality is usually local, but some actions can take a global argument (e.g "Eject", "GetOut", "GetInXXXX", "MoveToXXXX"). See Category:Actions for more details.
Groups:
Interaction

Syntax

Syntax:
unit action actionArray
Parameters:
unit: Object
actionArray: Array
Return Value:
Nothing

Alternative Syntax

Syntax:
action actionArray
Parameters:
actionArray: Array
Return Value:
Nothing

Examples

Example 1:
player action ["SitDown", player];
Example 2:
_soldier action ["Eject", vehicle _soldier];
Example 3:
player action ["UseWeapon", player, player, 7]; // plays pick up animation before throwing grenade action ["UseWeapon", player, player, 7]; // normal grenade throw

Additional Information

See also:
actionNow actionIDs actionParams addAction setUserActionText inGameUISetEventHandler showHUD inputAction removeAction removeAllActions weaponsInfo

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
Tom_48_97 - c
Posted on Aug 28, 2009 - 09:26 (UTC)
In Arma 2, you can place a unique unit (for example a boat, far of all combats) and use it for all command lines with action.
DreadedEntity - c
Posted on Mar 27, 2015 - 17:57 (UTC)
This command has no effect when a dead unit is used as input.
DrSova - c
Posted on Jun 27, 2017 - 02:15 (UTC)
player action ["SWITCHWEAPON", player, player, -1]
Switching weapon to the back.
Yuval - c
Posted on Jul 20, 2017 - 12:22 (UTC)
Some of the actions (such as "DropWeapon") do not always execute, and there should be a set of conditions for them to run. The unit must be able to perform the dropping animation in order for the action to properly execute. So, if for example we spawn a unit at [0,0,0] and make it perform a "DropWeapon" action - it won't work if [0,0,0] is water (which it is, if the current map is an island) because the unit will be swimming.

Also, you cannot stack up actions right after the other. If you run a "DropWeapon" action when the current action animation is still going - it will not perform. There are a few more conditions for an action to perform, but relying on a hundred percent success of the action is not a good practice.
Retrieved from "https://community.bistudio.com/wiki?title=action&oldid=353773"