assignedVehicle: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix wild comma in seeAlso)
(improved description and examples)
Line 9: Line 9:
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the vehicle a unit is assigned to. If no vehicle is assigned [[objNull]] is returned. |DESCRIPTION=
| Returns the vehicle a unit is assigned to. If no vehicle is assigned [[objNull]] is returned.
<br><br>
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=
____________________________________________________________________________________________
____________________________________________________________________________________________


Line 20: Line 29:
   
   
|x1= <code>_vehicle = [[assignedVehicle]] [[player]];</code> |EXAMPLE1=
|x1= <code>_vehicle = [[assignedVehicle]] [[player]];</code> |EXAMPLE1=
 
|x12= <code>_units [[apply]] {[[Magic Variables|_x]] [[leaveVehicle]] (assignedVehicle [[Magic Variables|_x]])};</code> |EXAMPLE2=
____________________________________________________________________________________________
____________________________________________________________________________________________



Revision as of 10:06, 8 August 2020

-wrong parameter ("Arma") defined!-1.05
Hover & click on the images for description

Description

Description:
Returns the vehicle a unit is assigned to. If no vehicle is assigned objNull is returned.

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 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 unassign though.
Groups:
Uncategorised

Syntax

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

Examples

Example 1:
_vehicle = assignedVehicle player;

Additional Information

See also:
addVehicleassignAsDriverassignAsCargoassignAsCommanderassignAsGunnerunassignVehicleleaveVehicle

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

Notes

Bottom Section