Difference between revisions of "unassignVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\: ?Command[ _]Group\:.*\|\{\{uc\:\{\{PAGENAME\}\}\}\}\]\] " to "")
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(35 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Command|Comments=
+
{{RV|type=command
____________________________________________________________________________________________
 
  
| ofp |Game name=
+
|game1= ofp
 +
|version1= 1.00
  
|1.00|Game version=
+
|game2= ofpe
 +
|version2= 1.00
  
|arg= local |Multiplayer Arguments=
+
|game3= arma1
 +
|version3= 1.00
  
|eff= global |Multiplayer Effects=
+
|game4= arma2
 +
|version4= 1.00
  
|gr1= Object Manipulation |GROUP1=
+
|game5= arma2oa
 +
|version5= 1.50
  
|gr2= Unit Control |GROUP2=
+
|game6= tkoh
____________________________________________________________________________________________
+
|version6= 1.00
  
| Unassigns individual unit from a vehicle, i.e removes [[assignedVehicleRole]] of the unit.
+
|game7= arma3
If the unit is currently in that vehicle, the group leader will issue an order to disembark.
+
|version7= 0.50
<br><br>
+
 
Notes:
+
|arg= local
* Important is to understand the basic system first:
 
# [[addVehicle]] creates a vehicle pool for the AI group to use.
 
# [[leaveVehicle]] removes a vehicle from the pool (and makes AI disembark when in that vehicle).
 
# However there is also [[assignedVehicle]]. This is about the ''current vehicle in use'' essentially. The assignment happens via the various assignAsXXX/moveInXXX commands, or player/AI GL getIn radio commands, getIn waypoint, or when units start in vehicles or get moved in to a vehicle by Zeus/via Eden.
 
# So the idea of [[unassignVehicle]] is to remove the ''current vehicle in use''.
 
# However as long as the vehicle is still part of the vehicle pool of the group the AI GL may order the AI to re-enter the vehicle immediately.
 
# To stop this from happening, one can use [[orderGetIn]]/[[allowGetIn]] [[false]] to (temporarily) disallow the AI from entering any vehicle.
 
* If you use [[leaveVehicle]] on an AI group not in the vehicle, only the AI GL will get the vehicle removed from [[assignedVehicle]]. However when you now apply [[unassignVehicle]] on the whole group, it will stick/the AI GL not order to re-enter immediately - as the AI GL no longer has the vehicle in his pool for the group.
 
* For player GL lead AI, the command removes the assignment. However it won't make the AI disembark the vehicle.
 
  
|DESCRIPTION=
+
|eff= global
____________________________________________________________________________________________
 
  
| [[unassignVehicle]] unitName |SYNTAX=
+
|gr1= Object Manipulation
  
|p1= unitName: [[Object]] |PARAMETER1=
+
|gr2= Unit Control
  
| [[Nothing]] |RETURNVALUE=
+
|descr= Unassigns individual unit from a vehicle, i.e removes [[assignedVehicleRole]] of the unit.
____________________________________________________________________________________________
+
If the unit is currently in that vehicle, the group leader will issue an order to disembark.
 +
{{Feature|informative|See [[AI Group Vehicle Management]] for more information.}}
  
|x1= <code>[[unassignVehicle]] [[player]];</code> |EXAMPLE1=
+
|s1= [[unassignVehicle]] unitName
 
|x2= <code>{ [[unassignVehicle]] [[Magic Variables|_x]] } [[forEach]] [[crew]] _vehiclenNme;</code> Will make all the occupants of a vehicle disembark |EXAMPLE2=
 
  
|x3= <code>{ [[unassignVehicle]] [[Magic Variables|_x]] } [[forEach]] [[crew]] _vehicleName; [[crew]] _vehiclename [[allowGetIn]] [[false]];</code> Will make all the occupants of a vehicle disembark and stop them from getting back in|EXAMPLE3=
+
|p1= unitName: [[Object]]
____________________________________________________________________________________________
 
  
| [[assignAsCargo]], [[assignAsCommander]], [[assignAsDriver]], [[assignAsGunner]], [[assignAsTurret]], [[assignedVehicle]], [[leaveVehicle]] |SEEALSO=
+
|r1= [[Nothing]]
}}
 
  
<h3 style="display:none">Notes</h3>
+
|x1= <sqf>unassignVehicle player;</sqf>
<dl class="command_description">
+
<!-- Note Section BEGIN -->
+
|x2= <sqf>{ unassignVehicle _x } forEach crew _vehiclenNme;</sqf> Will make all the occupants of a vehicle disembark
  
<!-- Note Section END -->
+
|x3= <sqf>{ unassignVehicle _x } forEach crew _vehicleName; crew _vehiclename allowGetIn false;</sqf> Will make all the occupants of a vehicle disembark and stop them from getting back in
</dl>
 
  
<h3 style="display:none">Bottom Section</h3>
+
|seealso= [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]] [[assignAsTurret]] [[assignedVehicle]] [[leaveVehicle]]
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
+
}}
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command Group: Vehicle Assignment|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 11:25, 13 May 2022

Hover & click on the images for description

Description

Description:
Unassigns individual unit from a vehicle, i.e removes assignedVehicleRole of the unit. If the unit is currently in that vehicle, the group leader will issue an order to disembark.
See AI Group Vehicle Management for more information.
Groups:
Object ManipulationUnit Control

Syntax

Syntax:
unassignVehicle unitName
Parameters:
unitName: Object
Return Value:
Nothing

Examples

Example 1:
Example 2:
{ unassignVehicle _x } forEach crew _vehiclenNme;
Will make all the occupants of a vehicle disembark
Example 3:
{ unassignVehicle _x } forEach crew _vehicleName; crew _vehiclename allowGetIn false;
Will make all the occupants of a vehicle disembark and stop them from getting back in

Additional Information

See also:
assignAsCargo assignAsCommander assignAsDriver assignAsGunner assignAsTurret assignedVehicle 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