unassignVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (add See Also assignAsTurret)
m (Fix example)
 
(58 intermediate revisions by 8 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 |= Arguments in MP
|game3= arma1
____________________________________________________________________________________________
|version3= 1.00


| Unassigns a unit from whichever vehicle that unit is currently assigned to. If the unit is currently in that vehicle, the group leader will issue an order to disembark. |= Description
|game4= arma2
____________________________________________________________________________________________
|version4= 1.00


| '''unassignVehicle''' unitName |= Syntax
|game5= arma2oa
|version5= 1.50


|p1= unitName: [[Object]] |= Parameter 1
|game6= tkoh
|version6= 1.00


| [[Nothing]] |= Return value
|game7= arma3
____________________________________________________________________________________________
|version7= 0.50


|x1= <code>unassignVehicle [[player]]</code> |= Example 1
|arg= local
|x2= <code>{unassignVehicle _x} [[forEach]] [[crew]] _vehiclename</code> Will make all the occupants of a vehicle disembark |= Example 2
____________________________________________________________________________________________


| [[assignAsCargo]], [[assignAsCommander]], [[assignAsDriver]], [[assignAsGunner]], [[assignAsTurret]], [[assignedVehicle]], [[leaveVehicle]] |= See also
|eff= global


}}
|gr1= Object Manipulation


<h3 style="display:none">Notes</h3>
|gr2= Unit Control
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on August 4, 2006 - 12:05
|descr= Unassigns individual unit from a vehicle, usually previously assigned with ''assignAsXXX'' command, i.e removes [[assignedVehicleRole]] of the unit.
<dt class="note">'''[[User:Hardrock|hardrock]]'''<dd class="note">''Notes from before the conversion:''
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.}}


Even though:
|s1= [[unassignVehicle]] unitName


{unassignVehicle _x} [[forEach]] [[crew]] vehiclename
|p1= unitName: [[Object]]


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.
|r1= [[Nothing]]


To prevent this happening also use [[allowGetIn]] as in the example below:
|x1= <sqf>unassignVehicle player;</sqf>
|x2= Make all the occupants of a vehicle disembark:
<sqf>{ unassignVehicle _x } forEach crew _vehicle;</sqf>


{unassignVehicle _x} [[forEach]] [[crew]] vehiclename; [[crew]] vehiclename [[allowGetIn]] [[false]]
|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>


 
|seealso= [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]] [[assignAsTurret]] [[assignedVehicle]] [[leaveVehicle]] [[assignedVehicles]] [[assignedGroup]] [[fullCrew]]
<!-- Note Section END -->
}}
</dl>
 
<h3 style="display:none">Bottom Section</h3>
 
[[Category:Scripting Commands|UNASSIGNVEHICLE]]
[[Category:Scripting Commands OFP 1.96|UNASSIGNVEHICLE]]
[[Category:Scripting Commands OFP 1.46|UNASSIGNVEHICLE]]
[[Category:Scripting Commands ArmA|UNASSIGNVEHICLE]]
[[Category:Scripting Commands ArmA2|UNASSIGNVEHICLE]]
[[Category:Command_Group:_Unit_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Vehicle_Assignment|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]

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"