Vehicle
Defined in: client/api.d.ts:1012
Client handle for a streamed M2O vehicle.
Extends
Section titled “Extends”Entity
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Vehicle(
id):Vehicle
Defined in: client/api.d.ts:1017
Creates a script wrapper for an existing streamed vehicle with this ID; it does not spawn a vehicle.
Parameters
Section titled “Parameters”number
Network entity identifier.
Returns
Section titled “Returns”Vehicle
Methods
Section titled “Methods”getPartTransform()
Section titled “getPartTransform()”getPartTransform(
partId):BoneTransform|null
Defined in: client/api.d.ts:1030
Resolves the current world-space transform of a named vehicle part.
Parameters
Section titled “Parameters”partId
Section titled “partId”number
Numeric part identifier, typically obtained from the global VehiclePart table.
Returns
Section titled “Returns”BoneTransform | null
The part transform, or null when the vehicle or requested part is unavailable.
setVirtualWorld()
Section titled “setVirtualWorld()”setVirtualWorld(
world):void
Defined in: shared.d.ts:83
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setVisibleTo()
Section titled “setVisibleTo()”setVisibleTo(
player):void
Defined in: shared.d.ts:84
Parameters
Section titled “Parameters”player
Section titled “player”Entity | null
Returns
Section titled “Returns”void
toString()
Section titled “toString()”toString():
string
Defined in: client/api.d.ts:1023
Returns a readable representation of this vehicle handle.
Returns
Section titled “Returns”string
The vehicle ID formatted for logging or debugging.
Properties
Section titled “Properties”
readonlyid:number
Defined in: shared.d.ts:79
position
Section titled “position”position:
Vector3
Defined in: shared.d.ts:81
rotation
Section titled “rotation”rotation:
Vector3|Quaternion
Defined in: shared.d.ts:82
virtualWorld
Section titled “virtualWorld”
readonlyvirtualWorld:number
Defined in: shared.d.ts:80