Difference between revisions of "unassignVehicle"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|x([0-9])= *<code>([^<]*)<\/code>" to "|x$1= <sqf>$2</sqf>")
 
(81 intermediate revisions by 21 users not shown)
Line 1: Line 1:
[[Category:Scripting Commands|UNASSIGNVEHICLE]]
+
{{RV|type=command
[[Category:Scripting Commands OFP 1.97|UNASSIGNVEHICLE]]
 
[[Category:Scripting Commands OFP 1.46|UNASSIGNVEHICLE]]
 
[[Category:Scripting Commands ArmA|UNASSIGNVEHICLE]]
 
  
 +
|game1= ofp
 +
|version1= 1.00
  
<h2 style="color:#000066">'''unassignVehicle ''unit'''''</h2>
+
|game2= ofpe
 +
|version2= 1.00
  
 +
|game3= arma1
 +
|version3= 1.00
  
'''Operand types:'''
+
|game4= arma2
 +
|version4= 1.00
  
'''unit:''' [[Object]]
+
|game5= arma2oa
 +
|version5= 1.50
  
'''Type of returned value:'''
+
|game6= tkoh
 +
|version6= 1.00
  
[[Nothing]]
+
|game7= arma3
 +
|version7= 0.50
  
'''Description:'''
+
|arg= local
  
Unit is unassigned from the vehicle.
+
|eff= global
  
If he is currently in, group leader will issue order to disembark.
+
|gr1= Object Manipulation
  
 +
|gr2= Unit Control
  
'''Examples:'''
+
|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.}}
  
'''unassignVehicle''' [[player]]
+
|s1= [[unassignVehicle]] unitName
  
will make the player disembark
+
|p1= unitName: [[Object]]
  
{'''unassignVehicle''' _x} [[forEach]] [[crew]] ''vehiclename''
+
|r1= [[Nothing]]
  
will make all the occupants of a vehicle disembark
+
|x1= <sqf>unassignVehicle player;</sqf>
 +
 +
|x2= <sqf>{ unassignVehicle _x } forEach crew _vehiclenNme;</sqf> Will make all the occupants of a vehicle disembark
  
 +
|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
  
'''Comments:'''
+
|seealso= [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]] [[assignAsTurret]] [[assignedVehicle]] [[leaveVehicle]]
 
+
}}
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 use also [[allowGetIn]] as in the example below:
 
 
 
{'''unassignVehicle''' _x} [[forEach]] [[crew]] ''vehiclename''
 
 
 
[[crew]] ''vehiclename'' [[allowGetIn]] [[false]]
 

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