leaveVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(populated)
mNo edit summary
 
(78 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma2 |= Game name
|game1= arma2
|version1= 1.00


|1.00|= Game version
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


| Ceases the using of the vehicle in the group. It unassigns all grouped units from the vehicle.  |= Description
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| group '''leaveVehicle''' vehicle |= Syntax
|game4= arma3
|version4= 0.50


|p1= group: [[Object]] or [[Group]] |= PARAMETER1
|arg= local


|p2= vehicle: [[Object]] |= PARAMETER2
|eff= local


|p3= |= PARAMETER3
|gr1= Unit Control


| [[Nothing]] |= RETURNVALUE
|gr2= Groups


|descr= Ceases the using of the vehicle by a group and unassigns vehicle from the group.
If the argument is a single unit, the vehicle will be unassigned from unit's group.
After vehicle is unassigned from the group, each individual crew member then unassigned from the vehicle.<br>
<br>
In short the command could be hypothetically presented as:<br>
<sqf>leaveVehicle = un-addVehicle + unassignVehicle forEach crew</sqf>


|x1= <code>soldierOne leaveVehicle jeepOne</code>|= EXAMPLE1
However, to make it more reliable, it is best to move unit out of the vehicle manually with [[moveOut]] and force unassign the vehicle with [[unassignVehicle]].
{{Feature|informative|See [[AI Group Vehicle Management]] for more information.}}


|x2= <code>groupOne leaveVehicle jeepOne</code>|= EXAMPLE2
|s1= group [[leaveVehicle]] vehicle


____________________________________________________________________________________________
|p1= group: [[Group]] or [[Object]] - object's [[Group]] is used


| |= SEEALSO
|p2= vehicle: [[Object]]


| |= MPBEHAVIOUR
|r1= [[Nothing]]
____________________________________________________________________________________________
 
}}
|x1= <sqf>_unit leaveVehicle _vehicle;</sqf>


<h3 style='display:none'>Notes</h3>
|x2= <sqf>_grp leaveVehicle _vehicle;</sqf>
<dl class='command_description'>
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|seealso= [[addVehicle]] [[assignAsCargo]] [[assignAsCommander]] [[assignAsDriver]] [[assignAsGunner]] [[assignedVehicle]] [[unassignVehicle]] [[doGetOut]] [[commandGetOut]] [[createVehicleCrew]] [[assignedVehicles]] [[assignedGroup]] [[fullCrew]]
</dl>
}}


<h3 style='display:none'>Bottom Section</h3>
{{Note
[[Category:ArmA 2: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|user= Killzone_Kid
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
|timestamp= 20130831160800
|text= In {{arma3}} this command will not force a player to exit from a vehicle. It will unassign vehicle role for this player. AI crew however will also disembark.
}}

Latest revision as of 06:26, 7 November 2023

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

Description

Description:
Ceases the using of the vehicle by a group and unassigns vehicle from the group. If the argument is a single unit, the vehicle will be unassigned from unit's group. After vehicle is unassigned from the group, each individual crew member then unassigned from the vehicle.

In short the command could be hypothetically presented as:
leaveVehicle = un-addVehicle + unassignVehicle forEach crew
However, to make it more reliable, it is best to move unit out of the vehicle manually with moveOut and force unassign the vehicle with unassignVehicle.
ⓘ
See AI Group Vehicle Management for more information.
Groups:
Unit ControlGroups

Syntax

Syntax:
group leaveVehicle vehicle
Parameters:
group: Group or Object - object's Group is used
vehicle: Object
Return Value:
Nothing

Examples

Example 1:
_unit leaveVehicle _vehicle;
Example 2:
_grp leaveVehicle _vehicle;

Additional Information

See also:
addVehicle assignAsCargo assignAsCommander assignAsDriver assignAsGunner assignedVehicle unassignVehicle doGetOut commandGetOut createVehicleCrew 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
Killzone_Kid - c
Posted on Aug 31, 2013 - 16:08 (UTC)
In Arma 3 this command will not force a player to exit from a vehicle. It will unassign vehicle role for this player. AI crew however will also disembark.
Retrieved from "https://community.bistudio.com/wiki?title=leaveVehicle&oldid=347946"