Vehicle

@vimp-mp/types 2.0.1

Interface · Client API

Server-known vehicle. It may be known before/after streaming into a local GTA entity.

interface Vehicle

Members

alpha

readonly alpha: number

Current entity opacity.

bodyHealth

readonly bodyHealth: number

Current body health reported by GTA.

customPrimaryColour

readonly customPrimaryColour: Rgb

Current custom primary RGB color.

customSecondaryColour

readonly customSecondaryColour: Rgb

Current custom secondary RGB color.

dimension

readonly dimension: number

Current virtual world dimension.

engineHealth

readonly engineHealth: number

Current engine health reported by GTA.

forwardVector

readonly forwardVector: Vec3

Current forward direction vector.

gear

readonly gear: number

Current transmission gear.

handle

readonly handle: number

GTA entity handle, or 0 while known but not streamed.

heading

readonly heading: number

Current heading in degrees.

id

readonly id: number

Client-local 0-based wrapper id, unique per entity type and reused after destroy. Use remoteId for server/network state.

isAlive

readonly isAlive: boolean

True while the remote vehicle exists in multiplayer state. Use handle !== 0 for local streamed visibility.

isDead

readonly isDead: boolean

Whether GTA reports the vehicle as destroyed.

isEngineRunning

readonly isEngineRunning: boolean

Whether the engine is currently running.

isExists

readonly isExists: boolean

Alias of isAlive for vehicle lifecycle existence.

isLocked

readonly isLocked: boolean

Whether the vehicle doors are locked.

isRemote

readonly isRemote: boolean

Whether the vehicle is owned by the server rather than this client.

lightsState

readonly lightsState: VehicleLightState

Current low-beam and high-beam state.

maxNumberOfPassengers

readonly maxNumberOfPassengers: number

Maximum number of passenger seats.

model

readonly model: number

Current vehicle model hash.

numberPlate

readonly numberPlate: string

Authoritative cached network plate text for remote vehicles.

numberPlateType

readonly numberPlateType: number

Cached network plate type for remote vehicles.

position

readonly position: Vec3

Current world position.

remoteId

readonly remoteId: number | null

Server vehicle id for remote vehicles; null for local-only vehicles. Zero is a valid remote id.

rotation

readonly rotation: Vec3

Current world rotation in degrees.

speed

readonly speed: number

Current speed reported by GTA.

wheelType

readonly wheelType: number

Current GTA wheel-type index.

windowTint

readonly windowTint: number

Current GTA window-tint index.

attachToEntity

attachToEntity(target: { handle: number }, boneIndex: number, offset: Vec3, rotation: Vec3, p9: boolean, useSoftPinning: boolean, collision: boolean, isPed: boolean, vertexIndex: number, fixedRot: boolean): void

Attaches the vehicle to another GTA entity.

destroy

destroy(): boolean

Destroys local-only vehicles. Returns false for remote vehicles or already-destroyed wrappers.

detach

detach(useDetachVelocity: boolean, collision: boolean): void

Detaches the vehicle from its current parent entity.

explode

explode(audible?: boolean, invisible?: boolean): void

Explodes the local GTA vehicle.

freezePosition

freezePosition(freeze: boolean): void

Freezes or unfreezes the vehicle's current position.

getAcceleration

getAcceleration(): number

Returns the model's acceleration capability.

getBoneIndexByName

getBoneIndexByName(boneName: string): number

Resolves a named bone on the native vehicle, or returns -1.

getHandling

getHandling(field: string): number

Returns a numeric handling field from this vehicle instance.

getMaxBraking

getMaxBraking(): number

Returns the model's maximum braking capability.

getMaxTraction

getMaxTraction(): number

Returns the model's maximum traction capability.

getMod

getMod(modType: number): number

Returns the installed mod index for a GTA vehicle-mod slot.

getModelMaxSpeed

getModelMaxSpeed(): number

Returns the model's estimated maximum speed.

getNumMods

getNumMods(modType: number): number

Returns the number of mods available for a GTA vehicle-mod slot.

getOffsetFromInWorldCoords

getOffsetFromInWorldCoords(offsetX: number, offsetY: number, offsetZ: number): Vec3

Converts a vehicle-local offset into world coordinates.

getPedInSeat

getPedInSeat(seat: number): number

Returns the GTA ped handle occupying seat, or 0 when it is empty.

getSpeed

getSpeed(): number

Returns the vehicle's current speed in metres per second.

getWorldPositionOfBone

getWorldPositionOfBone(boneIndex: number): Vec3

Returns the world position of a native vehicle bone.

isPlayingAnim

isPlayingAnim(dictionary: string, name: string, taskFlag: number): boolean

Reports whether the vehicle entity is playing the requested animation.

modifyTopSpeed

modifyTopSpeed(value: number): void

Adjusts the vehicle's top-speed modifier.

resetAlpha

resetAlpha(): void

Restores the vehicle's default opacity.

setAlpha

setAlpha(alpha: number): void

Sets opacity, clamped to 0–255, and caches it across stream-in.

setBodyHealth

setBodyHealth(value: number): void

Changes the native vehicle's body-health value.

setCheatPowerIncrease

setCheatPowerIncrease(value: number): void

Applies GTA's vehicle cheat-power multiplier.

setCollision

setCollision(collision: boolean, keepPhysics: boolean): void

Enables or disables collision on the native vehicle when streamed.

setCoords

setCoords(xPos: number, yPos: number, zPos: number, xAxis: boolean, yAxis: boolean, zAxis: boolean, clearArea: boolean): void

Moves the native vehicle using GTA's axis and area-clear flags.

setCustomPrimaryColour

setCustomPrimaryColour(color: Rgb): void

Applies a custom RGB primary paint colour.

setCustomSecondaryColour

setCustomSecondaryColour(color: Rgb): void

Applies a custom RGB secondary paint colour.

setDashboardColor

setDashboardColor(colorIndex: number): void

Applies a dashboard colour index.

setDimension

setDimension(dimension: number): void

Changes the client-side dimension value associated with this wrapper.

setDoorOpen

setDoorOpen(doorIndex: number, loose: boolean, openInstantly: boolean): void

Opens one native vehicle door.

setDoorShut

setDoorShut(doorIndex: number, instantly: boolean): void

Closes one native vehicle door.

setEngineHealth

setEngineHealth(value: number): void

Changes the native vehicle's engine-health value.

setEngineOn

setEngineOn(toggle: boolean, instantly?: boolean, otherwise?: boolean): void

Starts or stops the native vehicle engine.

setEnginePowerMultiplier

setEnginePowerMultiplier(value: number): void

Applies GTA's per-frame engine-power multiplier.

setEngineTorqueMultiplier

setEngineTorqueMultiplier(value: number): void

Applies GTA's per-frame engine-torque multiplier.

setExtraColours

setExtraColours(pearlescentColor: number, wheelColor: number): void

Applies pearlescent and wheel palette colours.

setHandling

setHandling(field: string, value: number): void

Overrides a numeric handling field on this vehicle instance.

setHeading

setHeading(heading: number): void

Updates the cached heading and the native vehicle when streamed.

setHeadlightColor

setHeadlightColor(colorIndex: number): void

Applies a xenon-headlight colour index.

setInteriorColor

setInteriorColor(colorIndex: number): void

Applies an interior colour index.

setInvincible

setInvincible(invincible: boolean): void

Enables or disables damage on the native vehicle when streamed.

setIsLocked

setIsLocked(value: boolean): void

Locks or unlocks all vehicle doors using GTA lock states 2 and 1.

setMod

setMod(modType: number, modIndex: number): void

Installs a mod index in a GTA vehicle-mod slot.

setModColor1

setModColor1(paintType: number, color: number, p3: number): void

Applies the primary vehicle-mod paint type and palette colour.

setModel

setModel(model: string | number): void

Reserved model setter; the current runtime leaves the vehicle unchanged.

setNeonLightEnabled

setNeonLightEnabled(index: number, toggle: boolean): void

Enables or disables one neon-light position.

setNeonLightsColour

setNeonLightsColour(color: Rgb): void

Applies the RGB colour shared by the vehicle's neon lights.

setNumberPlate

setNumberPlate(value: string): void

Changes the cached and native plate text, truncated to eight characters.

setNumberPlateType

setNumberPlateType(index: number): void

Applies a GTA number-plate style index.

setPosition

setPosition(position: Vec3): void

Updates the cached position and moves the native vehicle when streamed.

setRotation

setRotation(rotation: Vec3): void

Updates the cached rotation and the native vehicle when streamed.

setTyreSmokeColor

setTyreSmokeColor(r: number, g: number, b: number): void

Applies an RGB tyre-smoke colour.

setUndriveable

setUndriveable(toggle: boolean): void

Enables or disables the native vehicle's undriveable flag.

setVisible

setVisible(visible: boolean): void

Shows or hides the native vehicle when streamed.

setWheelType

setWheelType(wheelType: number): void

Applies a GTA wheel-type index.

setWindowTint

setWindowTint(tintType: number): void

Applies a GTA window-tint index.

toggleMod

toggleMod(modType: number, toggle: boolean): void

Enables or disables a toggle-style vehicle mod.