Vehicle

@vimp-mp/types 2.0.1

Interface · Server API

Server-spawned vehicle handle returned by vimp.vehicles.create.

Mutating world, appearance, lock and health properties updates the authoritative server state and broadcasts the change to every player currently streaming the vehicle.

interface Vehicle extends StreamSyncedMeta

Members

bodyHealth

bodyHealth: number

Body health, clamped by runtime to 0-1000.

dimension

dimension: number

Virtual world (dimension). The vehicle is visible only to players in the same dimension. Changing it also changes every occupant's dimension without removing them from the vehicle; each player receives a playerDimensionChange event. Defaults to 0.

dirtLevel

dirtLevel: number

Dirt level, clamped by runtime to 0-15.

driver

readonly driver: Player | null

Player in the driver seat (-1 / seat -1 server-side), or null.

engineHealth

engineHealth: number

Engine health, clamped by runtime to -4000..1000.

engineOn

engineOn: boolean

Whether the engine is running.

id

readonly id: number

Server-assigned vehicle identifier.

isExists

readonly isExists: boolean

Whether the vehicle is still registered with the server runtime.

livery

livery: number

Livery index, clamped by runtime to -1..255.

lockState

lockState: number

Door lock state, clamped by runtime to 0-10.

model

model: number

Vehicle model hash.

numberPlate

numberPlate: string

Number plate text, truncated by runtime to 8 characters.

numberPlateType

numberPlateType: number

Number plate style, clamped by runtime to 0-5.

passengers

readonly passengers: Array<Player>

All players currently seated in the vehicle, including the driver.

position

position: Vec3

Authoritative world position.

primaryColor

primaryColor: number

GTA primary paint id, clamped by runtime to 0-255.

rotation

rotation: Vec3

Authoritative world rotation in degrees.

secondaryColor

secondaryColor: number

GTA secondary paint id, clamped by runtime to 0-255.

deleteStreamSyncedMeta

deleteStreamSyncedMeta(key: string): void

Deletes key and propagates the removal to streaming clients.

destroy

destroy(): boolean

Destroy the vehicle and unregister it from vimp.vehicles.

getStreamSyncedMeta

getStreamSyncedMeta<T = unknown>(key: string): T | undefined

Returns undefined if the key is unset.

getStreamSyncedMetaKeys

getStreamSyncedMetaKeys(): Array<string>

Returns all stream-synced metadata keys stored on the entity.

hasStreamSyncedMeta

hasStreamSyncedMeta(key: string): boolean

Returns whether the entity has a value for key.

setStreamSyncedMeta

setStreamSyncedMeta(key: string, value: unknown): void

Set or replace one key. The value is forwarded to every player currently streaming this entity, plus included in the snapshot for any future stream-in. Use deleteStreamSyncedMeta rather than undefined when the key must be removed.