allowGetIn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " +" to " ")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(7 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= global
|arg= global
Line 13: Line 30:
|gr2= Unit Control
|gr2= Unit Control


| Set if the units given in the list are allowed to enter vehicles.
|descr= Set if the units given in the list are allowed to enter vehicles.
{{Feature|informative|See [[AI Group Vehicle Management]] for more information.}}


| unitArray '''allowGetIn''' allow
|s1= unitArray [[allowGetIn]] allow


|p1= unitArray: [[Array]] of [[units]]
|p1= unitArray: [[Array]] of [[Object]]s


|p2= allow: [[Boolean]] - true allows the [[units]] to enter, false denies them
|p2= allow: [[Boolean]] - [[true]] allows the [[units]] to enter, [[false]] denies them


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


|x1= <code>[_soldier1, _soldier2] [[allowGetIn]] [[true]];</code>
|x1= <sqf>[_soldier1, _soldier2] allowGetIn true;</sqf>


|seealso= [[orderGetIn]]
|seealso= [[orderGetIn]]
}}
}}
<dl class="command_description">
<dt></dt>
<dd class="notedate">Posted on 8 May, 2014 - 21:10</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, and which needs to be used together with assaignAs command family. Generally speaking, [[orderGetIn]] is a Role Excuator.
| When [[orderGetIn]] was disabled it won't automatically unassign unit's vehicle role but will force the unit get out of the vehicle and stop him re-entering until it was enabled again. [[orderGetIn]] [[false]] won't stop a unit when he is embarking a vehicle in the half way 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 10:21, 13 May 2022

Hover & click on the images for description

Description

Description:
Set if the units given in the list are allowed to enter vehicles.
See AI Group Vehicle Management for more information.
Groups:
Object ManipulationUnit Control

Syntax

Syntax:
unitArray allowGetIn allow
Parameters:
unitArray: Array of Objects
allow: Boolean - true allows the units to enter, false denies them
Return Value:
Nothing

Examples

Example 1:
[_soldier1, _soldier2] allowGetIn true;

Additional Information

See also:
orderGetIn

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