REVO / API version 0.0.10
Vehicle
Position and rotation getters return copies. Assign a new value to apply changes.
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Vehicle(
model,position,rotation?):Vehicle
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
model |
string | number |
Model name (ASCII case-insensitive) or unsigned 32-bit hash. |
position |
IVector3 |
- |
rotation? |
number | IVector3 | IQuaternion |
Heading or XYZ Euler angles in radians, or a unit quaternion. Defaults to zero heading. |
Returns
Section titled “Returns”Vehicle
Overrides
Section titled “Overrides”Physical.constructor
Properties
Section titled “Properties”| Property | Type | Details |
|---|---|---|
bodyHealth |
number |
— |
collisionEnabled |
boolean |
|
dimension |
number |
Dimension: 0..4294967294, default 0. globalDimension shows entities and spatial audio in every dimension. Players cannot use globalDimension. Global entities share movement, damage and seats across dimensions. A vehicle’s trailer follows its dimension. Occupants follow unless the new dimension is global. |
dirtLevel |
number |
— |
engineHealth |
number |
— |
engineRunning |
boolean |
— |
frontBumperState |
IVehicleBumperState |
— |
health |
number |
|
highBeamsOn |
boolean |
— |
id |
number |
|
lightsOn |
boolean |
— |
livery |
number |
— |
modKit |
number |
Model-specific mod kit index. Defaults to 0. |
netOwner |
Player | null |
— |
networkId |
number | null |
Network ID shared with clients. null after destruction. |
parent |
Vehicle | null |
— |
petrolTankHealth |
number |
— |
primaryColor |
number | IRGB |
GTA color ID (0..160) or custom RGB (each component 0..255). Assigning an ID clears custom RGB. |
radioStation |
number |
— |
rearBumperState |
IVehicleBumperState |
— |
secondaryColor |
number | IRGB |
GTA color ID (0..160) or custom RGB (each component 0..255). Assigning an ID clears custom RGB. |
trailer |
Vehicle | null |
— |
type |
BaseType |
|
valid |
boolean |
|
visible |
boolean |
|
wheelType |
VehicleWheelType |
Wheel family used by the front and rear wheel mods. |
windowTint |
VehicleWindowTint |
— |
xenonColor |
number |
Xenon color index (0..12), or -1 for the default. Enable the Xenon toggle mod to use it. |
all |
readonly Vehicle[] |
|
count |
number |
Accessors
Section titled “Accessors”| Accessor | Type | Details |
|---|---|---|
angVelocity |
Read: Vector3Write: IVector3 |
|
modelHash |
Read: numberWrite: string | number |
Accepts a model name or nonzero uint32 hash. Clients load the new model asynchronously. |
neonColor |
Read: IRGB | nullWrite: IRGB |
null until set. Each RGB component is 0..255. Enable the desired neon sides separately. |
numberPlate |
Read: string | nullWrite: string |
null until set by the server. GTA supplies the original plate. Up to 8 ASCII letters, digits or spaces. Letters become uppercase. An empty string blanks the plate. |
pos |
Read: Vector3Write: IVector3 |
|
quaternion |
Read: QuaternionWrite: IQuaternion |
|
rot |
Read: Vector3Write: IVector3 |
Euler angles in radians, applied X, then Y, then Z. |
tyreSmokeColor |
Read: IRGB | nullWrite: IRGB |
null until set. Each RGB component is 0..255. Enable the TyreSmoke toggle mod to use it. |
velocity |
Read: Vector3Write: IVector3 |
Methods
Section titled “Methods”deleteSyncedMeta()
Section titled “deleteSyncedMeta()”deleteSyncedMeta(
key):void
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”destroy()
Section titled “destroy()”destroy():
void
Deletes the entity. Throws for players and already destroyed entities.
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”getExtra()
Section titled “getExtra()”getExtra(
id):boolean|null
Returns the server’s setting, or null if the extra still uses its model default. IDs are 1..16.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”boolean | null
getMod()
Section titled “getMod()”getMod(
type):number
Returns the server’s selected mod index, or -1 for stock.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
type |
VehicleModType |
Returns
Section titled “Returns”number
getModVariation()
Section titled “getModVariation()”getModVariation(
type):boolean
Whether this wheel mod uses custom tyres.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
type |
VehicleModType |
Returns
Section titled “Returns”boolean
getObservers()
Section titled “getObservers()”getObservers(): readonly
Player[]
Returns
Section titled “Returns”readonly Player[]
Inherited from
Section titled “Inherited from”getSeatOccupant()
Section titled “getSeatOccupant()”getSeatOccupant(
seat):number
Returns the player’s ID, or 65535 for an empty seat.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
seat |
number |
1 for the driver. |
Returns
Section titled “Returns”number
getSyncedMeta()
Section titled “getSyncedMeta()”Call Signature
Section titled “Call Signature”getSyncedMeta<
K>(key):ICustomBaseSyncedMeta[K] |undefined
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends never |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
Returns
Section titled “Returns”ICustomBaseSyncedMeta[K] | undefined
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”getSyncedMeta<
T>(key):T|undefined
Type Parameters
Section titled “Type Parameters”| Type Parameter | Default type |
|---|---|
T |
TransportValue |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”T | undefined
Inherited from
Section titled “Inherited from”getSyncedMetaKeys()
Section titled “getSyncedMetaKeys()”getSyncedMetaKeys():
string[]
Returns
Section titled “Returns”string[]
Inherited from
Section titled “Inherited from”hasSyncedMeta()
Section titled “hasSyncedMeta()”hasSyncedMeta(
key):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
string |
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”isLightDamaged()
Section titled “isLightDamaged()”isLightDamaged(
light):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
light |
number |
Returns
Section titled “Returns”boolean
isNeonEnabled()
Section titled “isNeonEnabled()”isNeonEnabled(
side):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
side |
VehicleNeonSide |
Returns
Section titled “Returns”boolean
isToggleModOn()
Section titled “isToggleModOn()”isToggleModOn(
type):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
type |
VehicleToggleModType |
Returns
Section titled “Returns”boolean
isWheelBurst()
Section titled “isWheelBurst()”isWheelBurst(
wheel):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
wheel |
number |
Returns
Section titled “Returns”boolean
isWheelOnRim()
Section titled “isWheelOnRim()”isWheelOnRim(
wheel):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
wheel |
number |
Returns
Section titled “Returns”boolean
repair()
Section titled “repair()”repair():
boolean
Returns
Section titled “Returns”boolean
setExtra()
Section titled “setExtra()”setExtra(
id,enabled):boolean
Sets extra 1..16 when present on the model. Enabling an extra can also repair the vehicle in GTA.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
enabled |
boolean |
Returns
Section titled “Returns”boolean
setLightDamaged()
Section titled “setLightDamaged()”setLightDamaged(
light,damaged):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
light |
number |
damaged |
boolean |
Returns
Section titled “Returns”boolean
setLights()
Section titled “setLights()”setLights(
enabled,highBeams?):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
enabled |
boolean |
highBeams? |
boolean |
Returns
Section titled “Returns”boolean
setLivery()
Section titled “setLivery()”setLivery(
livery):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
livery |
number |
Returns
Section titled “Returns”boolean
setMod()
Section titled “setMod()”setMod(
type,index,customTyres?):boolean
Part index: 0..254, or -1 for stock. customTyres applies to installed wheel mods. Returns false for invalid arguments. Unsupported parts use stock on the client. The server keeps the requested index.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
type |
VehicleModType |
index |
number |
customTyres? |
boolean |
Returns
Section titled “Returns”boolean
setNeonEnabled()
Section titled “setNeonEnabled()”setNeonEnabled(
side,enabled):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
side |
VehicleNeonSide |
enabled |
boolean |
Returns
Section titled “Returns”boolean
setSyncedMeta()
Section titled “setSyncedMeta()”Call Signature
Section titled “Call Signature”setSyncedMeta<
K>(key,value):void
Copies and replicates the value to the object’s audience. Player metadata also goes to that player.
Type Parameters
Section titled “Type Parameters”| Type Parameter |
|---|
K extends string |
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key |
K |
value |
K extends never ? ICustomBaseSyncedMeta[K] : TransportValue |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”Call Signature
Section titled “Call Signature”setSyncedMeta(
values):void
Atomically merges own enumerable fields. Unsupported values reject the entire batch.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
values |
Partial<ICustomBaseSyncedMeta> & Record<string, TransportValue> |
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”setToggleMod()
Section titled “setToggleMod()”setToggleMod(
type,enabled):boolean
Enables an upgrade when supported by the model. Returns false for an invalid type.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
type |
VehicleToggleModType |
enabled |
boolean |
Returns
Section titled “Returns”boolean
setWheelBurst()
Section titled “setWheelBurst()”setWheelBurst(
wheel,burst,onRim?):boolean
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
wheel |
number |
Wheel index, from 0 to 5. |
burst |
boolean |
- |
onRim? |
boolean |
- |
Returns
Section titled “Returns”boolean
setWheelFixed()
Section titled “setWheelFixed()”setWheelFixed(
wheel):boolean
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
wheel |
number |
Returns
Section titled “Returns”boolean
getById()
Section titled “getById()”
staticgetById(id):Vehicle|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
id |
number |
Returns
Section titled “Returns”Vehicle | null
Overrides
Section titled “Overrides”getByNetworkId()
Section titled “getByNetworkId()”
staticgetByNetworkId(networkId):Vehicle|null
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
networkId |
number |
Returns
Section titled “Returns”Vehicle | null
Overrides
Section titled “Overrides”getInRadius()
Section titled “getInRadius()”
staticgetInRadius(position,radius,dimension?): readonlyVehicle[]
Includes global entities alongside the selected dimension. globalDimension selects only global entities. Omit it to search all worlds.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
position |
IVector3 |
radius |
number |
dimension? |
number |
Returns
Section titled “Returns”readonly Vehicle[]