@nativewrappers/fivem 0.0.1

package/lib/server/entities/Vehicle.d.ts

@@ -0,0 +1,230 @@
+import { ClassTypes } from '../enum/ClassTypes';
+import { VehicleLockStatus } from '../enum/VehicleLockStatus';
+import { VehicleType } from '../enum/VehicleType';
+import { Hash } from '../type/Hash';
+import { Color } from '../utils';
+import { BaseEntity } from './BaseEntity';
+/** @extends BaseEntity */
+export declare class Vehicle extends BaseEntity {
+    /**
+     * @protected
+     * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Vehicle
+     */
+    protected type: ClassTypes;
+    constructor(handle: number);
+    /**
+     * Get an interable list of vehicles currently on the server
+     * @public
+     * @static
+     * @returns {IterableIterator<Vehicle>} Iterable list of Vehicles.
+     */
+    static AllVehicles(): IterableIterator<Vehicle>;
+    /**
+     * @public
+     * @static
+     * @param {number} netId
+     * @returns {Vehicle}
+     */
+    static fromNetworkId(netId: number): Vehicle;
+    /**
+     * @public
+     * @static
+     * @param {number} handle
+     * @returns {Vehicle}
+     */
+    static fromHandle(handle: number): Vehicle;
+    /**
+     * @public
+     */
+    get IsEngineRunning(): boolean;
+    /**
+     * @public
+     */
+    get IsPrimaryColourCustom(): boolean;
+    /**
+     * @public
+     */
+    get IsSecondaryColourCustom(): boolean;
+    /**
+     * @public
+     */
+    get BodyHealth(): number;
+    /**
+     * @public
+     */
+    get VehicleColours(): [number, number];
+    /**
+     * @public
+     */
+    get CustomPrimaryColour(): Color;
+    /**
+     * @public
+     */
+    get CustomSecondaryColour(): Color;
+    /**
+     * @public
+     */
+    get DashboardColour(): number;
+    /**
+     * @public
+     */
+    get DirtLevel(): number;
+    /**
+     * @public
+     */
+    get LockStatus(): VehicleLockStatus;
+    /**
+     * @public
+     */
+    get DoorStatus(): number;
+    /**
+     * @public
+     */
+    get DoorsLockedForPlayer(): number;
+    /**
+     * @public
+     */
+    get EngineHealth(): number;
+    /**
+     * @public
+     */
+    get ExtraColours(): [number, number];
+    /**
+     * @public
+     */
+    get FlightNozzlePosition(): number;
+    /**
+     * @public
+     */
+    get Handbrake(): boolean;
+    /**
+     * @public
+     */
+    get HeadlightsColour(): number;
+    /**
+     * @public
+     */
+    get HomingLockonState(): number;
+    /**
+     * @public
+     */
+    get InteriorColour(): number;
+    /**
+     * @public
+     */
+    get LightsState(): [boolean, boolean];
+    /**
+     * @public
+     */
+    get Livery(): number;
+    /**
+     * @public
+     */
+    get LockOnTarget(): Vehicle;
+    /**
+     * @public
+     */
+    get Plate(): string;
+    /**
+     * @public
+     */
+    get PlateIndex(): number;
+    /**
+     * @public
+     */
+    get PetrolTankHealth(): number;
+    /**
+     * @public
+     */
+    get RadioStation(): number;
+    /**
+     * @public
+     */
+    get RoofLivery(): number;
+    /**
+     * @public
+     */
+    get SteeringAngle(): number;
+    /**
+     * @public
+     */
+    get VehicleType(): VehicleType;
+    /**
+     * @public
+     */
+    get TyreSmokeColour(): Color;
+    /**
+     * @public
+     */
+    get WheelType(): number;
+    /**
+     * @public
+     */
+    get WindowTint(): number;
+    /**
+     * @public
+     */
+    get HasBeenOwnedByPlayer(): boolean;
+    /**
+     * @public
+     */
+    get IsEngineStarting(): boolean;
+    /**
+     * @public
+     */
+    get IsSirenOn(): boolean;
+    /**
+     * @public
+     */
+    get MaxHealth(): number;
+    /**
+     * @public
+     */
+    get ScriptTaskCommand(): Hash;
+    /**
+     * @public
+     */
+    get ScriptTaskStage(): Hash;
+    /**
+     * @public
+     */
+    get MainRotorHealth(): number;
+    /**
+     * @public
+     */
+    get TailRotorHealth(): number;
+    /**
+     * This might supposed to be TrainEngineHealth?
+     * @public
+     */
+    get TrainCarriageEngine(): number;
+    /**
+     * @public
+     */
+    get TrainCarriageIndex(): number;
+    /**
+     * @public
+     * @param {number} wheelId
+     * @param {boolean} completely
+     * @returns {boolean}
+     */
+    isTyreBurst(wheelId: number, completely: boolean): boolean;
+    /**
+     * @public
+     * @param {number} extraId
+     * @returns {boolean}
+     */
+    isExtraTurnedOn(extraId: number): boolean;
+    /**
+     * @public
+     * @param {number} seatIndex
+     * @returns {number}
+     */
+    getPedInSeat(seatIndex: number): number;
+    /**
+     * @public
+     * @param {number} seatIndex
+     * @returns {number}
+     */
+    getLastPedInSeat(seatIndex: number): number;
+}

package/lib/server/entities/Vehicle.js

@@ -0,0 +1,331 @@
+import { ClassTypes } from '../enum/ClassTypes';
+import { Color } from '../utils';
+import { BaseEntity } from './BaseEntity';
+/** @extends BaseEntity */
+export class Vehicle extends BaseEntity {
+    constructor(handle) {
+        super(handle);
+        /**
+         * @protected
+         * @default import("/home/skaggs/projects/fivem/server/src/enum/ClassTypes").ClassTypes.Vehicle
+         */
+        this.type = ClassTypes.Vehicle;
+    }
+    /**
+     * Get an interable list of vehicles currently on the server
+     * @public
+     * @static
+     * @returns {IterableIterator<Vehicle>} Iterable list of Vehicles.
+     */
+    static *AllVehicles() {
+        for (const veh of GetAllVehicles()) {
+            yield new Vehicle(veh);
+        }
+    }
+    /**
+     * @public
+     * @static
+     * @param {number} netId
+     * @returns {Vehicle}
+     */
+    static fromNetworkId(netId) {
+        return new Vehicle(NetworkGetEntityFromNetworkId(netId));
+    }
+    /**
+     * @public
+     * @static
+     * @param {number} handle
+     * @returns {Vehicle}
+     */
+    static fromHandle(handle) {
+        return new Vehicle(handle);
+    }
+    /**
+     * @public
+     */
+    get IsEngineRunning() {
+        return GetIsVehicleEngineRunning(this.handle);
+    }
+    /**
+     * @public
+     */
+    get IsPrimaryColourCustom() {
+        return GetIsVehiclePrimaryColourCustom(this.handle);
+    }
+    /**
+     * @public
+     */
+    get IsSecondaryColourCustom() {
+        return GetIsVehicleSecondaryColourCustom(this.handle);
+    }
+    /**
+     * @public
+     */
+    get BodyHealth() {
+        return GetVehicleBodyHealth(this.handle);
+    }
+    /**
+     * @public
+     */
+    get VehicleColours() {
+        return GetVehicleColours(this.handle);
+    }
+    /**
+     * @public
+     */
+    get CustomPrimaryColour() {
+        return Color.fromArray(GetVehicleCustomPrimaryColour(this.handle));
+    }
+    /**
+     * @public
+     */
+    get CustomSecondaryColour() {
+        return Color.fromArray(GetVehicleCustomSecondaryColour(this.handle));
+    }
+    /**
+     * @public
+     */
+    get DashboardColour() {
+        return GetVehicleDashboardColour(this.handle);
+    }
+    /**
+     * @public
+     */
+    get DirtLevel() {
+        return GetVehicleDirtLevel(this.handle);
+    }
+    /**
+     * @public
+     */
+    get LockStatus() {
+        return GetVehicleDoorLockStatus(this.handle);
+    }
+    /**
+     * @public
+     */
+    get DoorStatus() {
+        return GetVehicleDoorStatus(this.handle);
+    }
+    /**
+     * @public
+     */
+    get DoorsLockedForPlayer() {
+        return GetVehicleDoorsLockedForPlayer(this.handle);
+    }
+    /**
+     * @public
+     */
+    get EngineHealth() {
+        return GetVehicleEngineHealth(this.handle);
+    }
+    /**
+     * @public
+     */
+    get ExtraColours() {
+        return GetVehicleExtraColours(this.handle);
+    }
+    /**
+     * @public
+     */
+    get FlightNozzlePosition() {
+        return GetVehicleFlightNozzlePosition(this.handle);
+    }
+    /**
+     * @public
+     */
+    get Handbrake() {
+        return GetVehicleHandbrake(this.handle);
+    }
+    /**
+     * @public
+     */
+    get HeadlightsColour() {
+        return GetVehicleHeadlightsColour(this.handle);
+    }
+    /**
+     * @public
+     */
+    get HomingLockonState() {
+        return GetVehicleHomingLockonState(this.handle);
+    }
+    /**
+     * @public
+     */
+    get InteriorColour() {
+        return GetVehicleInteriorColour(this.handle);
+    }
+    /**
+     * @public
+     */
+    get LightsState() {
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        const [_, lightsOn, highbeansOn] = GetVehicleLightsState(this.handle);
+        return [lightsOn, highbeansOn];
+    }
+    /**
+     * @public
+     */
+    get Livery() {
+        return GetVehicleLivery(this.handle);
+    }
+    /**
+     * @public
+     */
+    get LockOnTarget() {
+        return new Vehicle(GetVehicleLockOnTarget(this.handle));
+    }
+    /**
+     * @public
+     */
+    get Plate() {
+        return GetVehicleNumberPlateText(this.handle);
+    }
+    /**
+     * @public
+     */
+    get PlateIndex() {
+        return GetVehicleNumberPlateTextIndex(this.handle);
+    }
+    /**
+     * @public
+     */
+    get PetrolTankHealth() {
+        return GetVehiclePetrolTankHealth(this.handle);
+    }
+    /**
+     * @public
+     */
+    get RadioStation() {
+        return GetVehicleRadioStationIndex(this.handle);
+    }
+    /**
+     * @public
+     */
+    get RoofLivery() {
+        return GetVehicleRoofLivery(this.handle);
+    }
+    /**
+     * @public
+     */
+    get SteeringAngle() {
+        return GetVehicleSteeringAngle(this.handle);
+    }
+    /**
+     * @public
+     */
+    get VehicleType() {
+        return GetVehicleType(this.handle);
+    }
+    /**
+     * @public
+     */
+    get TyreSmokeColour() {
+        return Color.fromArray(GetVehicleTyreSmokeColor(this.handle));
+    }
+    /**
+     * @public
+     */
+    get WheelType() {
+        return GetVehicleWheelType(this.handle);
+    }
+    /**
+     * @public
+     */
+    get WindowTint() {
+        return GetVehicleWindowTint(this.handle);
+    }
+    /**
+     * @public
+     */
+    get HasBeenOwnedByPlayer() {
+        return HasVehicleBeenOwnedByPlayer(this.handle);
+    }
+    /**
+     * @public
+     */
+    get IsEngineStarting() {
+        return IsVehicleEngineStarting(this.handle);
+    }
+    /**
+     * @public
+     */
+    get IsSirenOn() {
+        return IsVehicleSirenOn(this.handle);
+    }
+    /**
+     * @public
+     */
+    get MaxHealth() {
+        return GetPedMaxHealth(this.handle);
+    }
+    /**
+     * @public
+     */
+    get ScriptTaskCommand() {
+        return GetPedScriptTaskCommand(this.handle);
+    }
+    /**
+     * @public
+     */
+    get ScriptTaskStage() {
+        return GetPedScriptTaskStage(this.handle);
+    }
+    /**
+     * @public
+     */
+    get MainRotorHealth() {
+        return GetHeliMainRotorHealth(this.handle);
+    }
+    /**
+     * @public
+     */
+    get TailRotorHealth() {
+        return GetHeliTailRotorHealth(this.handle);
+    }
+    /**
+     * This might supposed to be TrainEngineHealth?
+     * @public
+     */
+    get TrainCarriageEngine() {
+        return GetTrainCarriageEngine(this.handle);
+    }
+    /**
+     * @public
+     */
+    get TrainCarriageIndex() {
+        return GetTrainCarriageIndex(this.handle);
+    }
+    /**
+     * @public
+     * @param {number} wheelId
+     * @param {boolean} completely
+     * @returns {boolean}
+     */
+    isTyreBurst(wheelId, completely) {
+        return IsVehicleTyreBurst(this.handle, wheelId, completely);
+    }
+    /**
+     * @public
+     * @param {number} extraId
+     * @returns {boolean}
+     */
+    isExtraTurnedOn(extraId) {
+        return IsVehicleExtraTurnedOn(this.handle, extraId);
+    }
+    /**
+     * @public
+     * @param {number} seatIndex
+     * @returns {number}
+     */
+    getPedInSeat(seatIndex) {
+        return GetPedInVehicleSeat(this.handle, seatIndex);
+    }
+    /**
+     * @public
+     * @param {number} seatIndex
+     * @returns {number}
+     */
+    getLastPedInSeat(seatIndex) {
+        return GetLastPedInVehicleSeat(this.handle, seatIndex);
+    }
+}

package/lib/server/entities/index.d.ts

@@ -0,0 +1,5 @@
+export { Entity } from './Entity';
+export { Ped } from './Ped';
+export { Player } from './Player';
+export { Prop } from './Prop';
+export { Vehicle } from './Vehicle';

package/lib/server/entities/index.js

@@ -0,0 +1,5 @@
+export { Entity } from './Entity';
+export { Ped } from './Ped';
+export { Player } from './Player';
+export { Prop } from './Prop';
+export { Vehicle } from './Vehicle';

package/lib/server/enum/ClassTypes.d.ts

@@ -0,0 +1,11 @@
+export declare enum ClassTypes {
+    Ped = 0,
+    Prop = 1,
+    Vehicle = 2,
+    Entity = 3,
+    Player = 4,
+    Vector2 = 5,
+    Vector3 = 6,
+    Vector4 = 7,
+    Quanterion = 8
+}

package/lib/server/enum/ClassTypes.js

@@ -0,0 +1,12 @@
+export var ClassTypes;
+(function (ClassTypes) {
+    ClassTypes[ClassTypes["Ped"] = 0] = "Ped";
+    ClassTypes[ClassTypes["Prop"] = 1] = "Prop";
+    ClassTypes[ClassTypes["Vehicle"] = 2] = "Vehicle";
+    ClassTypes[ClassTypes["Entity"] = 3] = "Entity";
+    ClassTypes[ClassTypes["Player"] = 4] = "Player";
+    ClassTypes[ClassTypes["Vector2"] = 5] = "Vector2";
+    ClassTypes[ClassTypes["Vector3"] = 6] = "Vector3";
+    ClassTypes[ClassTypes["Vector4"] = 7] = "Vector4";
+    ClassTypes[ClassTypes["Quanterion"] = 8] = "Quanterion";
+})(ClassTypes || (ClassTypes = {}));

package/lib/server/enum/PopulationType.d.ts

@@ -0,0 +1,13 @@
+export declare enum PopulationType {
+    Unknown = 0,
+    RandomPermanent = 1,
+    RandomParked = 2,
+    Randompatrol = 3,
+    RandomScenario = 4,
+    RandomAmbient = 5,
+    Permanent = 6,
+    Mission = 7,
+    Replay = 8,
+    Cache = 9,
+    Tool = 10
+}

package/lib/server/enum/PopulationType.js

@@ -0,0 +1,14 @@
+export var PopulationType;
+(function (PopulationType) {
+    PopulationType[PopulationType["Unknown"] = 0] = "Unknown";
+    PopulationType[PopulationType["RandomPermanent"] = 1] = "RandomPermanent";
+    PopulationType[PopulationType["RandomParked"] = 2] = "RandomParked";
+    PopulationType[PopulationType["Randompatrol"] = 3] = "Randompatrol";
+    PopulationType[PopulationType["RandomScenario"] = 4] = "RandomScenario";
+    PopulationType[PopulationType["RandomAmbient"] = 5] = "RandomAmbient";
+    PopulationType[PopulationType["Permanent"] = 6] = "Permanent";
+    PopulationType[PopulationType["Mission"] = 7] = "Mission";
+    PopulationType[PopulationType["Replay"] = 8] = "Replay";
+    PopulationType[PopulationType["Cache"] = 9] = "Cache";
+    PopulationType[PopulationType["Tool"] = 10] = "Tool";
+})(PopulationType || (PopulationType = {}));

package/lib/server/enum/VehicleLockStatus.d.ts

@@ -0,0 +1,9 @@
+export declare enum VehicleLockStatus {
+    None = 0,
+    Locked = 2,
+    LockedForPlayer = 3,
+    StickPlayerInside = 4,
+    CanBeBrokenInto = 7,
+    CanBeBrokenIntoPersist = 8,
+    CannotBeTriedToEnter = 10
+}

package/lib/server/enum/VehicleLockStatus.js

@@ -0,0 +1,10 @@
+export var VehicleLockStatus;
+(function (VehicleLockStatus) {
+    VehicleLockStatus[VehicleLockStatus["None"] = 0] = "None";
+    VehicleLockStatus[VehicleLockStatus["Locked"] = 2] = "Locked";
+    VehicleLockStatus[VehicleLockStatus["LockedForPlayer"] = 3] = "LockedForPlayer";
+    VehicleLockStatus[VehicleLockStatus["StickPlayerInside"] = 4] = "StickPlayerInside";
+    VehicleLockStatus[VehicleLockStatus["CanBeBrokenInto"] = 7] = "CanBeBrokenInto";
+    VehicleLockStatus[VehicleLockStatus["CanBeBrokenIntoPersist"] = 8] = "CanBeBrokenIntoPersist";
+    VehicleLockStatus[VehicleLockStatus["CannotBeTriedToEnter"] = 10] = "CannotBeTriedToEnter";
+})(VehicleLockStatus || (VehicleLockStatus = {}));

package/lib/server/enum/VehicleType.d.ts

@@ -0,0 +1,10 @@
+export declare enum VehicleType {
+    Automobile = "automobile",
+    Bike = "bike",
+    Boat = "boat",
+    Heli = "heli",
+    Plane = "plane",
+    Submarine = "submarine",
+    Trailer = "trailer",
+    Train = "train"
+}

package/lib/server/enum/VehicleType.js

@@ -0,0 +1,11 @@
+export var VehicleType;
+(function (VehicleType) {
+    VehicleType["Automobile"] = "automobile";
+    VehicleType["Bike"] = "bike";
+    VehicleType["Boat"] = "boat";
+    VehicleType["Heli"] = "heli";
+    VehicleType["Plane"] = "plane";
+    VehicleType["Submarine"] = "submarine";
+    VehicleType["Trailer"] = "trailer";
+    VehicleType["Train"] = "train";
+})(VehicleType || (VehicleType = {}));

package/lib/server/enum/eEntityType.d.ts

@@ -0,0 +1,5 @@
+export declare enum eEntityType {
+    Ped = 1,
+    Automobile = 2,
+    Prop = 3
+}

package/lib/server/enum/eEntityType.js

@@ -0,0 +1,6 @@
+export var eEntityType;
+(function (eEntityType) {
+    eEntityType[eEntityType["Ped"] = 1] = "Ped";
+    eEntityType[eEntityType["Automobile"] = 2] = "Automobile";
+    eEntityType[eEntityType["Prop"] = 3] = "Prop";
+})(eEntityType || (eEntityType = {}));

package/lib/server/enum/index.d.ts

@@ -0,0 +1,5 @@
+export { ClassTypes } from './ClassTypes';
+export { eEntityType } from './eEntityType';
+export { PopulationType } from './PopulationType';
+export { VehicleLockStatus } from './VehicleLockStatus';
+export { VehicleType } from './VehicleType';

package/lib/server/enum/index.js

@@ -0,0 +1,5 @@
+export { ClassTypes } from './ClassTypes';
+export { eEntityType } from './eEntityType';
+export { PopulationType } from './PopulationType';
+export { VehicleLockStatus } from './VehicleLockStatus';
+export { VehicleType } from './VehicleType';