Difference between revisions of "unassignVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]2(\|.*)?\]\]" to "{{GameCategory|arma2|Scripting Commands}}")
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Take[ _]On[ _]Helicopters(\|.*)?\]\]" to "{{GameCategory|tkoh|Scripting Commands}}")
Line 64: Line 64:
 
{{GameCategory|arma2|Scripting Commands}}
 
{{GameCategory|arma2|Scripting Commands}}
 
{{GameCategory|arma3|Scripting Commands}}
 
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|tkoh|Scripting Commands}}

Revision as of 20:47, 10 January 2021

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.

Notes:
  • Important is to understand the basic system first:
  1. addVehicle creates a vehicle pool for the AI group to use.
  2. leaveVehicle removes a vehicle from the pool (and makes AI disembark when in that vehicle).
  3. 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.
  4. So the idea of unassignVehicle is to remove the current vehicle in use.
  5. 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.
  6. 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.
Groups:
Object ManipulationUnit Control

Syntax

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

Examples

Example 1:
unassignVehicle player;
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:
assignAsCargoassignAsCommanderassignAsDriverassignAsGunnerassignAsTurretassignedVehicleleaveVehicle

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

Bottom Section