@nativewrappers/fivem/models/Vehicle.d.ts

Native wrappers and utilities for use with FiveM.

import { ClassTypes } from "../common/utils/ClassTypes";
import { Vector3 } from "../common/utils/Vector";
import type { Model } from "../Model";
import type { RadioStation } from "../enums/RadioStation";
import { type VehicleClass, type VehicleLandingGearState, type VehicleLockStatus, VehicleRoofState, VehicleSeat } from "../enums/Vehicle";
import { BaseEntity } from "./BaseEntity";
import type { Entity } from "./Entity";
import { EntityBoneCollection } from "./EntityBoneCollection";
import { Ped } from "./Ped";
import { VehicleDoorCollection } from "./VehicleDoorCollection";
import { VehicleModCollection } from "./VehicleModCollection";
import { VehicleWheelCollection } from "./VehicleWheelCollection";
import { VehicleWindowCollection } from "./VehicleWindowCollection";
export declare class Vehicle extends BaseEntity {
    static getModelDisplayName(vehicleModel: Model): string;
    static getModelClass(vehicleModel: Model): VehicleClass;
    static getClassDisplayName(vehicleClass: VehicleClass): string;
    static exists(vehicle: Vehicle): boolean;
    static fromHandle(handle: number): Vehicle | null;
    static fromNetworkId(networkId: number): Vehicle | null;
    private _doors?;
    private _mods?;
    private _wheels?;
    private _windows?;
    protected type: ClassTypes;
    protected bones?: EntityBoneCollection;
    constructor(handle: number);
    get Bones(): EntityBoneCollection;
    exists(): boolean;
    get DisplayName(): string;
    get ClassDisplayName(): string;
    get NumberPlate(): string;
    set NumberPlate(value: string);
    get ClassType(): VehicleClass;
    get BodyHealth(): number;
    set BodyHealth(value: number);
    get EngineHealth(): number;
    set EngineHealth(value: number);
    get PetrolTankHealth(): number;
    set PetrolTankHealth(value: number);
    get FuelLevel(): number;
    set FuelLevel(value: number);
    get OilLevel(): number;
    set OilLevel(value: number);
    get Gravity(): number;
    set Gravity(value: number);
    get IsEngineRunning(): boolean;
    set IsEngineRunning(value: boolean);
    get IsEngineStarting(): boolean;
    set IsEngineStarting(value: boolean);
    get IsRadioEnabled(): boolean;
    set IsRadioEnabled(value: boolean);
    set RadioStation(value: RadioStation);
    set Speed(value: number);
    get WheelSpeed(): number;
    get EstimatedMaxSpeed(): number;
    get Acceleration(): number;
    get CurrentRPM(): number;
    set CurrentRPM(value: number);
    get HighGear(): number;
    set HighGear(value: number);
    get CurrentGear(): number;
    get SteeringAngle(): number;
    set SteeringAngle(value: number);
    get SteeringScale(): number;
    set SteeringScale(value: number);
    get IsAlarmSet(): boolean;
    set IsAlarmSet(value: boolean);
    get IsAlarmSounding(): boolean;
    get AlarmTimeLeft(): number;
    set AlarmTimeLeft(value: number);
    startAlarm(): void;
    get IsSirenActive(): boolean;
    set IsSirenActive(value: boolean);
    set HasMutedSirens(value: boolean);
    soundHorn(duration: number, mode?: number): void;
    get IsWanted(): boolean;
    set IsWanted(value: boolean);
    set ProvidesCover(value: boolean);
    set DropsMoneyOnExplosion(value: boolean);
    get PreviouslyOwnedByPlayer(): boolean;
    set PreviouslyOwnedByPlayer(value: boolean);
    get NeedsToBeHotwired(): boolean;
    set NeedsToBeHotwired(value: boolean);
    get AreLightsOn(): boolean;
    set AreLightsOn(value: boolean);
    get AreHighBeamsOn(): boolean;
    set AreHighBeamsOn(value: boolean);
    get IsInteriorLightOn(): boolean;
    set IsInteriorLightOn(value: boolean);
    get IsSearchLightOn(): boolean;
    set IsSearchLightOn(value: boolean);
    get IsTaxiLightOn(): boolean;
    set IsTaxiLightOn(value: boolean);
    get IsLeftIndicatorLightOn(): boolean;
    set IsLeftIndicatorLightOn(value: boolean);
    get IsRightIndicatorLightOn(): boolean;
    set IsRightIndicatorLightOn(value: boolean);
    get IsHandbrakeForcedOn(): boolean;
    set IsHandbrakeForcedOn(value: boolean);
    set AreBrakeLightsOn(value: boolean);
    set LightsMultiplier(value: number);
    set CanBeVisiblyDamaged(value: boolean);
    set Strong(toggle: boolean);
    set CanBreak(toggle: boolean);
    get IsDamaged(): boolean;
    get IsDriveable(): boolean;
    set IsDriveable(value: boolean);
    get IsEngineOnFire(): boolean;
    get HasRoof(): boolean;
    get IsLeftHeadLightBroken(): boolean;
    get IsRightHeadLightBroken(): boolean;
    get IsRearBumperBrokenOff(): boolean;
    get IsFrontBumperBrokenOff(): boolean;
    set IsAxlesStrong(value: boolean);
    set CanEngineDegrade(value: boolean);
    set EnginePowerMultiplier(value: number);
    set EngineTorqueMultiplier(value: number);
    get LandingGearState(): VehicleLandingGearState;
    set LandingGearState(value: VehicleLandingGearState);
    get RoofState(): VehicleRoofState;
    set RoofState(value: VehicleRoofState);
    get LockStatus(): VehicleLockStatus;
    set LockStatus(value: VehicleLockStatus);
    get MaxBraking(): number;
    get MaxTraction(): number;
    get IsOnAllWheels(): boolean;
    get IsStopped(): boolean;
    get IsStoppedAtTrafficLights(): boolean;
    get IsStolen(): boolean;
    set IsStolen(value: boolean);
    get IsConvertible(): boolean;
    set IsBurnoutForced(value: boolean);
    get IsInBurnout(): boolean;
    get Driver(): Ped | null;
    get Ghosted(): boolean;
    set GhostedForGhostPlayers(isGhostedForGhostPlayers: boolean);
    set Ghosted(isGhosted: boolean);
    static set GhostAlpha(alpha: number);
    get IsInGhostCollision(): boolean;
    static resetGhostAlpha(): void;
    get Occupants(): (Ped | null)[];
    get Passengers(): (Ped | null)[];
    get Doors(): VehicleDoorCollection;
    get Mods(): VehicleModCollection;
    get Wheels(): VehicleWheelCollection;
    get Windows(): VehicleWindowCollection;
    extraExists(extra: number): boolean;
    isExtraOn(extra: number): boolean;
    toggleExtra(extra: number, toggle: boolean): void;
    getPedOnSeat(seat: VehicleSeat): Ped | null;
    isSeatFree(seat: VehicleSeat): boolean;
    wash(): void;
    get DirtLevel(): number;
    set DirtLevel(value: number);
    placeOnGround(): void;
    repair(): void;
    explode(): void;
    explodeNetworked(): void;
    get CanTiresBurst(): boolean;
    set CanTiresBurst(value: boolean);
    set CanWheelsBreak(value: boolean);
    set CanDeformWheels(value: boolean);
    get HasBombBay(): boolean;
    openBombBay(): void;
    closeBombBay(): void;
    setHeliYawPitchRollMult(mult: number): void;
    set TowingCraneRaisedAmount(value: number);
    get TowedVehicle(): Vehicle;
    towVehicle(vehicle: Vehicle, rear: boolean): void;
    detachFromTowTruck(): void;
    detachTowedVehicle(): void;
    deform(position: Vector3, damageAmount: number, radius: number): void;
    get PassengerCapacity(): number;
    get PassengerCount(): number;
    set RespotTimer(time: number);
    getHandlingFloat(fieldName: string): number;
    setHandlingFloat(fieldName: string, value: number): void;
    getHandlingInt(fieldName: string): number;
    setHandlingInt(fieldName: string, value: number): void;
    getHandlingVector(fieldName: string): Vector3;
    getEntityAttachedTo(): Entity;
}