allowGetIn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
 
No edit summary
(22 intermediate revisions by 10 users not shown)
Line 1: Line 1:
back to [[Scripting_Reference#A|COMREF]]
{{Command|= Comments
____________________________________________________________________________________________


<h2 style="color:#000066">'''''unitArray'' allowGetIn ''allow'''''</h2>
| ofp |= Game name


|1.00|= Game version


'''Operand types:'''
|arg= global |= Arguments in MP


'''unitArray:''' [[Array]]
|eff= global |= Effects in MP
____________________________________________________________________________________________


'''allow:''' [[Boolean]]
| Set if the units given in the list are allowed to enter vehicles. |= Description
____________________________________________________________________________________________


'''Type of returned value:'''
| unitArray '''allowGetIn''' allow |= Syntax


[[Nothing]]
|p1= unitArray: [[Array]] of [[units]] |= Parameter 1


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


Allow getting in vehicles to all units in the list.
| [[Nothing]] |= Return value
____________________________________________________________________________________________
 
|x1= <code>[_soldier1, _soldier2] [[allowGetIn]] [[true]];</code> |= Example 1
____________________________________________________________________________________________


| [[orderGetIn]] |= See also


'''Example:'''
}}


[unitOne, unitTwo] '''allowGetIn''' false
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on 8 May, 2014 - 21:10
<dt class="note">'''[[User:ffur2007slx2_5|ffur2007slx2_5]]'''
<dd class="note">
(ArmA3 ver 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
 
|}
<!-- Note Section END -->
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|ALLOWGETIN]]
[[Category:Scripting Commands OFP 1.99|ALLOWGETIN]]
[[Category:Scripting Commands OFP 1.96|ALLOWGETIN]]
[[Category:Scripting Commands OFP 1.46|ALLOWGETIN]]
[[Category:Scripting Commands ArmA|ALLOWGETIN]]
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

Revision as of 23:56, 1 September 2016

Hover & click on the images for description

Description

Description:
Set if the units given in the list are allowed to enter vehicles.
Groups:
Uncategorised

Syntax

Syntax:
unitArray allowGetIn allow
Parameters:
unitArray: Array of units
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

Notes

Posted on 8 May, 2014 - 21:10
ffur2007slx2_5
(ArmA3 ver 1.18), here's a quick reference to unit's embarkation and disembarkation.
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

Bottom Section