doGetOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(improved description and examples)
Line 11: Line 11:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Orders a unit or units to get out from the vehicle (silently). |DESCRIPTION=
| Orders a unit or 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)
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| '''doGetOut''' unit(s) |SYNTAX=
| '''doGetOut''' unit(s) |SYNTAX=


|p1= unit(s): [[Object]] or [[Array]] |PARAMETER1=
|p1= unitName: [[Object]] or [[Array]] of [[Object]]s |PARAMETER1=


| [[Nothing]] |RETURNVALUE=
| [[Nothing]] |RETURNVALUE=
Line 22: Line 33:
   
   
|x1= <code>[[doGetOut]] _unitOne</code> |EXAMPLE1=
|x1= <code>[[doGetOut]] _unitOne</code> |EXAMPLE1=
|x2= <code>[[doGetOut]] [_unitOne,_unitTwo]</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________
| 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. |=


| [[commandGetOut]], [[moveOut]], [[leaveVehicle]] |SEEALSO=
| [[commandGetOut]], [[moveOut]], [[leaveVehicle]] |SEEALSO=

Revision as of 08:27, 7 August 2020

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Orders a unit or 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)
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:
Uncategorised

Syntax

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

Examples

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

Additional Information

See also:
commandGetOutmoveOutleaveVehicle

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

Notes

Bottom Section