doGetOut: Difference between revisions

Latest revision as of 13:20, 5 May 2022

1.00

Hover & click on the images for description

Description

Description:

Orders one or multiple units to get out from the vehicle (silently). Same as commandGetOut with latter being shown via radio chat.

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 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 - 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:: doGetOut units
Parameters:: units: Object or Array of Objects
Return Value:: Nothing

Examples

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

Additional Information

See also:: commandGetOut 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: @@
-{{Command|= Comments
+{{RV|type=command
-____________________________________________________________________________________________
-| arma |= Game name
+|game1= ofpe
+|version1= 1.00
-|1.00|= Game version
+|game2= arma1
+|version2= 1.00
-|arg= local |= Arguments in MP
+|game3= arma2
+|version3= 1.00
-|eff= global |= Effects in MP
+|game4= arma2oa
-____________________________________________________________________________________________
+|version4= 1.50
-| Orders a unit or units to get out from the vehicle (silently). |= Description
+|game5= tkoh
-____________________________________________________________________________________________
+|version5= 1.00
-| '''doGetOut''' unit(s) |= Syntax
+|game6= arma3
+|version6= 0.50
-|p1= unit(s): [[Object]] or [[Array]] |= Parameter 1
+|arg= local
-| [[Nothing]] |= Return value
+|eff= global
-____________________________________________________________________________________________
-|x1= <pre>doGetOut _unitOne</pre> |= Example 1
-____________________________________________________________________________________________
-| [[commandGetOut]] |= See also
+|gr1= Unit Control
-}}
+|descr= Orders one or multiple units to get out from the vehicle (silently). Same as [[commandGetOut]] with latter being shown via radio chat.
+<br><br>
+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]]
+* 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]]
+* 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)
+* 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))
+|s1= [[doGetOut]] units
+|p1= units: [[Object]] or [[Array]] of [[Object]]s
+|r1= [[Nothing]]
-<h3 style="display:none">Notes</h3>
+|x1= <sqf>doGetOut _unitOne;</sqf>
-<dl class="command_description">
-<!-- Note Section BEGIN -->
-<!-- Note Section END -->
+|x2= <sqf>doGetOut [_unitOne,_unitTwo];</sqf>
-</dl>
-<h3 style="display:none">Bottom Section</h3>
+|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.
-[[Category:Scripting Commands|DOGETOUT]]
+|seealso= [[commandGetOut]] [[moveOut]] [[leaveVehicle]]
-[[Category:Scripting Commands OFP Elite |DOGETOUT]]
+}}
-[[Category:Scripting Commands ArmA|DOGETOUT]]
-[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
-[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
-[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]