commandGetOut: Difference between revisions

Latest revision as of 10:38, 6 May 2024

1.00

Hover & click on the images for description

Description

Description:

Orders one or multiple units to get out from the vehicle (via the radio). Same as doGetOut with latter being silent.

ⓘ

Works for both AI and player entities
AI unit gets back in - unless is under player command or combined with other sqf commands (orderGetIn false, allowGetIn false or leaveVehicle)
Ignores vehicle's lock state - unlike action "Eject" and moveOut
AI waits for execution until vehicle has stopped/is no longer flying (unclear if any timeout exists for order to be discarded) - unlike action "Eject" and moveOut
Plays the vehicle's position's get out animation (same as action "Eject") - unlike moveOut
When execute for multiple units, it waits till the action is completed, before the next to take his turn (same as action "Eject") - unlike moveOut
AI gets back into formation afterwards
Works only on alive units - unlike action "Eject" (one after another) or moveOut (instantly)
Does not work on unconscious units - unless the AI is under player command. Unlike moveOut or action "Eject" (but one after another)

Multiplayer:

This command is only effective when used on local units. When used on a remote unit, this command will create radio dialogue on the machine the unit is local to, but the unit will not leave the vehicle.

Groups:

Unit Control

Syntax

Syntax:: commandGetOut unit(s)
Parameters:: unit(s): Object or Array of Objects
Return Value:: Nothing

Examples

Example 1:: commandGetOut _unitOne;
Example 2:: commandGetOut [_unitOne,_unitTwo];

Additional Information

See also:: doGetOut moveOut leaveVehicle

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

@@ Line 1: / Line 1: @@
 {{RV|type=command
-| ofpe
+|game1= ofpe
-| 1.00
+|version1= 1.00
 |game2= arma1
@@ Line 26: / Line 26: @@
 |descr= Orders one or multiple units to get out from the vehicle (via the radio). Same as [[doGetOut]] with latter being silent.
-<br><br>
+{{Feature|informative|
-Notes:
 * Works for both AI and player entities
 * AI unit gets back in - unless is under player command or combined with other sqf commands ([[orderGetIn]] false, [[allowGetIn]] false or [[leaveVehicle]])
-* Ignores vehicle's lock state - unlike [[Arma_3_Actions#Eject|action "Eject"]] and [[moveOut]]
+* Ignores vehicle's lock state - unlike [[Arma 3: Actions#Eject|action "Eject"]] and [[moveOut]]
-* AI waits for execution until vehicle has stopped/is no longer flying (unclear if any timeout exists for order to be discarded) - unlike [[Arma_3_Actions#Eject|action "Eject"]] and [[moveOut]]
+* AI waits for execution until vehicle has stopped/is no longer flying (unclear if any timeout exists for order to be discarded) - unlike [[Arma 3: Actions#Eject|action "Eject"]] and [[moveOut]]
-* Plays the vehicle's position's get out animation (same as [[Arma_3_Actions#Eject|action "Eject"]]) - unlike [[moveOut]]
+* Plays the vehicle's position's get out animation (same as [[Arma 3: Actions#Eject|action "Eject"]]) - unlike [[moveOut]]
-* When execute for multiple units, it waits till the action is completed, before the next to take his turn (same as [[Arma_3_Actions#Eject|action "Eject"]]) - unlike [[moveOut]]
+* When execute for multiple units, it waits till the action is completed, before the next to take his turn (same as [[Arma 3: Actions#Eject|action "Eject"]]) - unlike [[moveOut]]
 * AI gets back into formation afterwards
-* Works only on alive units - unlike [[Arma_3_Actions#Eject|action "Eject"]] (one after another) or [[moveOut]] (instantly)
+* Works only on alive units - unlike [[Arma 3: Actions#Eject|action "Eject"]] (one after another) or [[moveOut]] (instantly)
-* Does not work on [[setUnconscious|unconscious]] - unless the AI is under player command. Unlike [[moveOut]] or [[Arma_3_Actions#Eject|action "Eject"]] (but one after another))
+* Does not work on [[setUnconscious|unconscious]] units - unless the AI is under player command. Unlike [[moveOut]] or [[Arma 3: Actions#Eject|action "Eject"]] (but one after another)
+}}
-|s1=  '''commandGetOut''' units(s)
+|s1= [[commandGetOut]] unit(s)
-|p1= unitName: [[Object]] or [[Array]] of [[Object]]s
+|p1= unit(s): [[Object]] or [[Array]] of [[Object]]s
-|r1=[[Nothing]]
+|r1= [[Nothing]]
-|x1= <code>[[commandGetOut]] _unitOne</code>
+|x1= <sqf>commandGetOut _unitOne;</sqf>
-|x2= <code>[[commandGetOut]] [_unitOne,_unitTwo]</code>
+|x2= <sqf>commandGetOut [_unitOne,_unitTwo];</sqf>
 |mp= This command is only effective when used on local units. When used on a remote unit, this command will create radio dialogue on the machine the unit is local to, but the unit will not leave the vehicle.
-|seealso= [[doGetOut]], [[moveOut]], [[leaveVehicle]]
+|seealso= [[doGetOut]] [[moveOut]] [[leaveVehicle]]
 }}
-{{GameCategory|ofpe|Scripting Commands}}
-{{GameCategory|arma1|Scripting Commands}}
-{{GameCategory|arma2|Scripting Commands}}
-{{GameCategory|arma3|Scripting Commands}}
-{{GameCategory|tkoh|Scripting Commands}}