assignedVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(improved description and examples)
No edit summary
 
(47 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma |Game name=
|game1= arma1
|version1= 1.05


|1.05|Game version=
|game2= arma2
|version2= 1.00


|arg= local |Multiplayer Arguments=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Returns the vehicle a unit is assigned to. If no vehicle is assigned [[objNull]] is returned.
|game4= tkoh
<br><br>
|version4= 1.00
Notes:
* 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.
* [[addVehicle]] indirectly may also add the vehicle, however only if an AI GL assigns [[assignedVehicleRole|vehicle roles]] (which depends on various things).
* [[vehicle]] returns the current vehicles an AI is in, while with [[assignedVehicle]] the AI may not (yet) be in the said vehicle (still in transit or held of by waypoints or other SQF commands).
* To make AI under AI GL enter a vehicle, use [[orderGetIn]] [[true]].
* While [[unassignVehicle]] works, if the group is under AI command, the AI GL may re-assign the vehicle immediately. To stop the AI from re-entering at least, use [[orderGetIn]] or [[allowGetIn]] [[false]], or permanently remove the assignment vi a [[leaveVehicle]].
* For player GL lead AI [[assignedVehicle]] seems not to be really reliable/behaves strange. Disembark radio command seems to [[unassignVehicle|unassign]] though.
|DESCRIPTION=
____________________________________________________________________________________________


| [[assignedVehicle]] unit |SYNTAX=
|game5= arma3
|version5= 0.50


|p1=  unit: [[Object]] |PARAMETER1=
|arg= local


| [[Object]] |RETURNVALUE=
|gr1= Object Manipulation
____________________________________________________________________________________________
 
|x1= <code>_vehicle = [[assignedVehicle]] [[player]];</code> |EXAMPLE1=
 
|x12= <code>_units [[apply]] {[[Magic Variables|_x]] [[leaveVehicle]] (assignedVehicle [[Magic Variables|_x]])};</code> |EXAMPLE2=
____________________________________________________________________________________________


| [[addVehicle]], [[assignAsDriver]], [[assignAsCargo]], [[assignAsCommander]], [[assignAsGunner]], [[unassignVehicle]], [[leaveVehicle]] |SEEALSO=
|descr= Returns the vehicle to which a unit is assigned, usually with ''assignAsXXX'' command. If no vehicle is assigned [[objNull]] is returned.
}}
{{Feature|informative|See [[AI Group Vehicle Management]] for more information.}}
 
|s1= [[assignedVehicle]] unit


<h3 style="display:none">Notes</h3>
|p1= unit: [[Object]]
<dl class="command_description">


<!-- Note Section BEGIN -->
|r1= [[Object]]


<!-- Note Section END -->
|x1= <sqf>_vehicle = assignedVehicle player;</sqf>
</dl>


<h3 style="display:none">Bottom Section</h3>
|x2= <sqf>_units apply { _x leaveVehicle (assignedVehicle _x) };</sqf>


[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
|seealso= [[assignedVehicleRole]] [[addVehicle]] [[assignAsDriver]] [[assignAsCargo]] [[assignAsCommander]] [[assignAsGunner]] [[assignAsTurret]] [[assignAsCargoIndex]] [[unassignVehicle]] [[leaveVehicle]] [[assignedVehicles]] [[assignedGroup]] [[fullCrew]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Object Information|{{uc:{{PAGENAME}}}}]]
[[Category:Command Group: Vehicle Assignment|{{uc:{{PAGENAME}}}}]]

Latest revision as of 17:20, 31 August 2022

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

Description

Description:
Returns the vehicle to which a unit is assigned, usually with assignAsXXX command. If no vehicle is assigned objNull is returned.
ⓘ
See AI Group Vehicle Management for more information.
Groups:
Object Manipulation

Syntax

Syntax:
assignedVehicle unit
Parameters:
unit: Object
Return Value:
Object

Examples

Example 1:
_vehicle = assignedVehicle player;
Example 2:
_units apply { _x leaveVehicle (assignedVehicle _x) };

Additional Information

See also:
assignedVehicleRole addVehicle assignAsDriver assignAsCargo assignAsCommander assignAsGunner assignAsTurret assignAsCargoIndex unassignVehicle 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=assignedVehicle&oldid=330331"