orderGetIn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<dl class="command_description"> <dt></dt>" to "<dl class="command_description"> <dt></dt>")
m (Text replacement - "\|x([0-9])= <sqf>([^\/: ]+)([^;])<\/sqf>" to "|x$1= <sqf>$2$3;</sqf>")
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|arg= local
|arg= local
Line 11: Line 28:
|gr1= Unit Control
|gr1= Unit Control


| Force all units in the array to get in or out of their assigned vehicles. Units must be assigned to a vehicle before this command will do anything.
|descr= Force all units in the array to get in or out of their assigned vehicles. Units must be assigned to a vehicle before this command will do anything.
<br><br>
{{Feature|informative|See [[AI Group Vehicle Management]] for more information.}}
Notes:
* The command has no affect on AI lead by a player Group Leader (GL)
* A vehicle needs be assigned via [[addVehicle]] or assignAsXXX or moveInXXX first for the command to have any effect. [[orderGetIn]] [[true]] makes the AI to board the vehicle. Or the AI GL orders them due to other means (ie getIn, guard waypoints).
* However one can initially set [[orderGetIn]] [[false]], add one or more vehicles and only once/when the AI is to enter, you set [[orderGetIn]] [[true]]  for AI to start moving to the vehicle(s) or getting in the vehicle(s).
* [[orderGetIn]] [[false]] makes AI also leave a vehicle when inside already. However it does not affect [[assignedVehicleRole]] nor [[assignedVehicle]]. Only [[leaveVehicle]] will remove both
* [[orderGetIn]] [[false]] even makes AI eject while the vehicle positions are locked (([[lockDriver]], [[lockTurret]], [[lockCargo]] - however [[orderGetIn]] [[true]] will not override the position lock to make them enter
* AI units on the way to enter the vehicle won't stop on the way if [[orderGetIn]] [[false]] set but continue to the vehicle and just stop short without entering - [[allowGetIn]] false instead will make the AI stop instantly (same as [[unassignVehicle]] when combined with [[orderGetIn]] [[false]])
* One can combine [[orderGetIn]] [[false]] and [[allowGetIn]] [[false]] to manage when exactly AI is to enter vehicles
* [[orderGetIn]] is persistent/a general group behavior setting - don't forget previous changes with future vehicle use!
* If you want to make a vehicle no longer used by a group, you need to remove the vehicle from the group's vehicle pool via [[leaveVehicle]].


| unitArray '''orderGetIn''' order
|s1= unitArray [[orderGetIn]] order


|p1= unitArray: [[Array]]
|p1= unitArray: [[Array]]
|p2= order: [[Boolean]]
|p2= order: [[Boolean]]


|r1=[[Nothing]]
|r1= [[Nothing]]


|x1= <code>[_unitOne, _unitTwo] '''orderGetIn''' [[true]]</code>
|x1= <sqf>[_unitOne, _unitTwo] orderGetIn true;</sqf>


|x2= <code>[_unitOne, _unitTwo] '''orderGetIn''' [[false]]</code>
|x2= <sqf>[_unitOne, _unitTwo] orderGetIn false;</sqf>


|seealso= [[allowGetIn]], [[addVehicle]], [[assignAsCargo]], [[assignAsCommander]], [[assignAsDriver]], [[assignAsGunner]]
|seealso= [[allowGetIn]] [[addVehicle]] [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]]
}}
}}
<dl class="command_description">
<dt></dt>
<dd class="notedate">Posted on 8 May, 2014 - 18:59</dd>
<dt class="note">[[User:ffur2007slx2_5|ffur2007slx2_5]]</dt>
<dd class="note">
{{GVI|arma3|1.18}} Here's a quick reference to unit's embarkation and disembarkation.
{| class="wikitable sortable"
! Command
! Remote Control
! Behavior
! Role Unassigning
|-
| [[orderGetIn]]
| false
| [[orderGetIn]] won't take effect on [[player]] controlled AI units. It needs to be used together with assignAsXXX command family. Generally speaking, [[orderGetIn]] is a Role Executor.
| When [[orderGetIn]] is set false, it won't unassign unit's vehicle role but will force the unit to get out of the vehicle and stop him re-entering until set true again. [[orderGetIn]] [[false]] won't stop short an unit on the way to enter the vehicle in the but [[unassignVehicle]] will do. [[orderGetIn]] [[false]] will wait to fire until the unit enter a vehicle.
|-
| [[allowGetIn]]
| false
| [[allowGetIn]] won't take effect on [[player]] controlled AI units. Different from [[orderGetIn]], this command is a Role Holder, it can control the unit's movement in the half way set by [[orderGetIn]] but not by [[setWaypointType]], unit will be forced to get out from a vehicle by [[allowGetIn]] [[false]] and won't automatically re-enter the vehicle until [[allowGetIn]] [[true]]
| [[allowGetIn]] won't do anything with unit's vehicle role
|-
| [[doGetOut]]
| true
| Works on player controlled ai silently, unit will automatically get back to the vehicle after disembarkation. (Unit won't get out until vehicle is stopped or landed)
| false
|-
| [[commandGetOut]]
| true
| Same as [[doGetOut]] with radio message. (Unit won't get out until vehicle is stopped or landed)
| false
|-
| [[leaveVehicle]]
| false
| [[leaveVehicle]] can't force a player controlled AI disembark
| true
|-
| action ["GetOut",_veh]
| true
| Eject immediately without parachute
| false
|-
| action ["Eject",_veh]
| true
| Eject immediately with parachute if needed
| false
|-
| [[setWaypointType]] "GETIN"
| false
| Waypoint won't be affected by [[orderGetIn]] [[false]] or [[allowGetIn]] [[false]] until the unit is on the vehicle.
| N/A
|}
</dl>
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 22:43, 28 June 2022

Hover & click on the images for description

Description

Description:
Force all units in the array to get in or out of their assigned vehicles. Units must be assigned to a vehicle before this command will do anything.
See AI Group Vehicle Management for more information.
Groups:
Unit Control

Syntax

Syntax:
unitArray orderGetIn order
Parameters:
unitArray: Array
order: Boolean
Return Value:
Nothing

Examples

Example 1:
[_unitOne, _unitTwo] orderGetIn true;
Example 2:
[_unitOne, _unitTwo] orderGetIn false;

Additional Information

See also:
allowGetIn addVehicle assignAsCargo assignAsCommander assignAsDriver assignAsGunner

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