commandGetOut: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fixed syntax)
m (Text replacement - "[[Arma 3 " to "[[Arma 3: ")
 
(67 intermediate revisions by 15 users not shown)
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


| Orders the unit to get out from the vehicle (via the radio). |= Description
|game3= arma2
____________________________________________________________________________________________
|version3= 1.00


| '''commandGetOut''' unit |= Syntax
|game4= arma2oa
|version4= 1.50


|p1= unit: [[Object]] or [[Array]] |= Parameter 1
|game5= tkoh
|version5= 1.00


| [[Nothing]] |= Return value
|game6= arma3
____________________________________________________________________________________________
|version6= 0.50
 
|x1= <pre>commandGetOut unitOne</pre> |= Example 1
____________________________________________________________________________________________


| |= See also
|gr1= Unit Control


|arg= local
|eff= global
|descr= Orders one or multiple units to get out from the vehicle (via the radio). Same as [[doGetOut]] with latter being silent.
{{Feature|informative|
* 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]] units - unless the AI is under player command. Unlike [[moveOut]] or [[Arma 3: Actions#Eject|action "Eject"]] (but one after another)
}}
}}


<h3 style="display:none">Notes</h3>
|s1= [[commandGetOut]] unit(s)
<dl class="command_description">
 
<!-- Note Section BEGIN -->
|p1= unit(s): [[Object]] or [[Array]] of [[Object]]s
 
|r1= [[Nothing]]


<!-- Note Section END -->
|x1= <sqf>commandGetOut _unitOne;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>commandGetOut [_unitOne,_unitTwo];</sqf>


[[Category:Scripting Commands|COMMANDGETOUT]]
|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 OFP Elite |COMMANDGETOUT]]
 
[[Category:Scripting Commands ArmA|COMMANDGETOUT]]
|seealso= [[doGetOut]] [[moveOut]] [[leaveVehicle]]
}}

Latest revision as of 10:38, 6 May 2024

ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=commandGetOut&oldid=364242"