Page tree
Skip to end of metadata
Go to start of metadata




Introduced in

Version:1.30

Description

Description:Returns the vehicle position occupied by the given unit (driver, cargo, or gunner), and the path to that position.

Syntax

Syntax:[unit, vehicle] call fn_vbs_getVehiclePos
Parameters:
  • unit: Object - Unit to check.
  • vehicle: Object - Vehicle you think the unit is in (optional: if omitted, the unit vehicle is detected automatically).
Return Value:[position, path]: Array - Has the following format:
  • position: String - "CARGO", "GUNNER", or "DRIVER".
  • path: Array - The path is either the cargo index, the turret path, or an empty array, depending on the position type. If the unit is not in the vehicle, or is on foot, an empty array is returned.

Warning

When using functions in VBS versions older than 3.4, certain limitations and requirements should be kept in mind - the main ones being that capitalization of the function name is crucial, and that #include "\vbs2\headers\function_library.hpp" has to be included in every script that utilizes it. More Category VBS Scripting Functions.

Examples

Examples:
_path = [player, vehicle player] call fn_vbs_getVehiclePos

Example return values:

["GUNNER", [0,1]]
["CARGO", 2]
["DRIVER", []]
[]

Additional Information

See also: 
Multiplayer: 
Problems: 

Notes