unassignVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
(improved description and examples)
Line 12: Line 12:


| Unassigns individual unit from a vehicle, i.e removes [[assignedVehicleRole]] of the unit.
| 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. |DESCRIPTION=
If the unit is currently in that vehicle, the group leader will issue an order to disembark.
<br><br>
Notes:
* 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 [[unassignVehicle]] is 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=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 24: Line 37:
|x1= <code>[[unassignVehicle]] [[player]];</code> |EXAMPLE1=  
|x1= <code>[[unassignVehicle]] [[player]];</code> |EXAMPLE1=  
   
   
|x2= <code>{ [[unassignVehicle]] [[Magic Variables|_x]] } [[forEach]] [[crew]] _vehiclename;</code> Will make all the occupants of a vehicle disembark |EXAMPLE2=  
|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 top them from getting back in|EXAMPLE3=  
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 33: Line 48:
<dl class="command_description">
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section BEGIN -->
<dd class="notedate">Posted on August 4, 2006 - 12:05
<dt class="note">[[User:Hardrock|hardrock]]
<dd class="note">''Notes from before the conversion:''
Even though:
{unassignVehicle _x} [[forEach]] [[crew]] vehiclename
will make all the occupants of a vehicle disembark, if they are the original crew of the vehicle then they will just get back in again.
To prevent this happening also use [[allowGetIn]] as in the example below:
{unassignVehicle _x} [[forEach]] [[crew]] vehiclename; [[crew]] vehiclename [[allowGetIn]] [[false]]


<!-- Note Section END -->
<!-- Note Section END -->

Revision as of 06:56, 8 August 2020

Logo A0.png1.00
LALocalGEGlobal
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 unassignVehicle is 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:
Uncategorised

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 top 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

Retrieved from "https://community.bistudio.com/wiki?title=unassignVehicle&oldid=156102"