unassignVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Fix example)
 
(88 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, usually previously assigned with ''assignAsXXX'' command, 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= Make all the occupants of a vehicle disembark:
<sqf>{ unassignVehicle _x } forEach crew _vehicle;</sqf>


|x3= Make all the occupants of a vehicle disembark and unable to get back in:
<sqf>
private _crew = crew _vehicle;
{ unassignVehicle _x } forEach _crew;
_crew allowGetIn false;
</sqf>


'''Comments:'''
|seealso= [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]] [[assignAsTurret]] [[assignedVehicle]] [[leaveVehicle]] [[assignedVehicles]] [[assignedGroup]] [[fullCrew]]
 
}}
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 20:52, 28 March 2024

Logo A0.png1.00ofpe logo.png1.00Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
Hover & click on the images for description

Description

Description:
Unassigns individual unit from a vehicle, usually previously assigned with assignAsXXX command, 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:
unassignVehicle player;
Example 2:
Make all the occupants of a vehicle disembark:
{ unassignVehicle _x } forEach crew _vehicle;
Example 3:
Make all the occupants of a vehicle disembark and unable to get back in:
private _crew = crew _vehicle; { unassignVehicle _x } forEach _crew; _crew allowGetIn false;

Additional Information

See also:
assignAsCargo assignAsCommander assignAsDriver assignAsGunner assignAsTurret assignedVehicle leaveVehicle assignedVehicles assignedGroup fullCrew

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
Retrieved from "https://community.bistudio.com/wiki?title=unassignVehicle&oldid=363373"