@nativewrappers/fivem 0.0.1

package/lib/client/Model.d.ts

@@ -0,0 +1,134 @@
+import { Dimensions } from './interfaces/Dimensions';
+/**
+ * Class to create and manage entity models.
+ */
+export declare class Model {
+    /**
+     * Hash of this model.
+     */
+    private hash;
+    /**
+     * Creates a model object based on the hash key or model string.
+     *
+     * @param hash A number or string of the model's hash. Example: "mp_m_freemode_01"
+     */
+    constructor(hash: number | string);
+    /**
+     * Gets the hash of the model.
+     *
+     * @returns The hash key.
+     */
+    get Hash(): number;
+    /**
+     * Gets if the model is valid or not.
+     *
+     * @returns Whether this model is valid.
+     */
+    get IsValid(): boolean;
+    /**
+     * Gets if the model is in cd image or not.
+     *
+     * @returns Whether this model is in cd image.
+     */
+    get IsInCdImage(): boolean;
+    /**
+     * Gets if the model is loaded or not.
+     *
+     * @returns Whether this model is loaded.
+     */
+    get IsLoaded(): boolean;
+    /**
+     * Gets if the model collision is loaded or not.
+     *
+     * @returns Whether this model collision is loaded.
+     */
+    get IsCollisionLoaded(): boolean;
+    /**
+     * Gets if the model is a bicycle or not.
+     *
+     * @returns Whether this model is a bicycle.
+     */
+    get IsBicycle(): boolean;
+    /**
+     * Gets if the model is a motorbike or not.
+     *
+     * @returns Whether this model is a motorbike.
+     */
+    get IsBike(): boolean;
+    /**
+     * Gets if the model is a boat or not.
+     *
+     * @returns Whether this model is a boat.
+     */
+    get IsBoat(): boolean;
+    /**
+     * Gets if the model is a car or not.
+     *
+     * @returns Whether this model is a car.
+     */
+    get IsCar(): boolean;
+    /**
+     * Gets if the model is a cargobob or not.
+     *
+     * @returns Whether this model is a cargobob.
+     */
+    get IsCargobob(): boolean;
+    /**
+     * Gets if the model is a helicopter or not.
+     *
+     * @returns Whether this model is a helicopter.
+     */
+    get IsHelicopter(): boolean;
+    /**
+     * Gets if the model is a Ped or not.
+     *
+     * @returns Whether this model is a Ped.
+     */
+    get IsPed(): boolean;
+    /**
+     * Gets if the model is a plane or not.
+     *
+     * @returns Whether this model is a plane.
+     */
+    get IsPlane(): boolean;
+    /**
+     * Gets if the model is a prop or not.
+     *
+     * @returns Whether this model is a prop.
+     */
+    get IsProp(): boolean;
+    /**
+     * Gets if the model is a quadbike or not.
+     *
+     * @returns Whether this model is a quadbike.
+     */
+    get IsQuadbike(): boolean;
+    /**
+     * Gets if the model is a train or not.
+     *
+     * @returns Whether this model is a train.
+     */
+    get IsTrain(): boolean;
+    /**
+     * Gets if the model is a Vehicle or not.
+     *
+     * @returns Whether this model is a Vehicle.
+     */
+    get IsVehicle(): boolean;
+    /**
+     * Gets the model dimensions.
+     *
+     * @returns This model min & max dimensions.
+     */
+    get Dimensions(): Dimensions;
+    /**
+     * Request and load the model with a specified timeout. Default timeout is 1000 (recommended).
+     *
+     * @param timeout Maximum allowed time for model to load.
+     */
+    request(timeout?: number): Promise<boolean>;
+    /**
+     * Sets the model as no longer needed allowing the game engine to free memory.
+     */
+    markAsNoLongerNeeded(): void;
+}

package/lib/client/Model.js

@@ -0,0 +1,198 @@
+import { Game } from './Game';
+import { VehicleHash } from './hashes';
+import { Vector3 } from './utils';
+/**
+ * Class to create and manage entity models.
+ */
+export class Model {
+    /**
+     * Creates a model object based on the hash key or model string.
+     *
+     * @param hash A number or string of the model's hash. Example: "mp_m_freemode_01"
+     */
+    constructor(hash) {
+        if (typeof hash === 'string') {
+            this.hash = Game.generateHash(hash);
+        }
+        else {
+            this.hash = hash;
+        }
+    }
+    /**
+     * Gets the hash of the model.
+     *
+     * @returns The hash key.
+     */
+    get Hash() {
+        return this.hash;
+    }
+    /**
+     * Gets if the model is valid or not.
+     *
+     * @returns Whether this model is valid.
+     */
+    get IsValid() {
+        return IsModelValid(this.hash);
+    }
+    /**
+     * Gets if the model is in cd image or not.
+     *
+     * @returns Whether this model is in cd image.
+     */
+    get IsInCdImage() {
+        return IsModelInCdimage(this.hash);
+    }
+    /**
+     * Gets if the model is loaded or not.
+     *
+     * @returns Whether this model is loaded.
+     */
+    get IsLoaded() {
+        return HasModelLoaded(this.hash);
+    }
+    /**
+     * Gets if the model collision is loaded or not.
+     *
+     * @returns Whether this model collision is loaded.
+     */
+    get IsCollisionLoaded() {
+        return HasCollisionForModelLoaded(this.hash);
+    }
+    /**
+     * Gets if the model is a bicycle or not.
+     *
+     * @returns Whether this model is a bicycle.
+     */
+    get IsBicycle() {
+        return IsThisModelABicycle(this.hash);
+    }
+    /**
+     * Gets if the model is a motorbike or not.
+     *
+     * @returns Whether this model is a motorbike.
+     */
+    get IsBike() {
+        return IsThisModelABike(this.hash);
+    }
+    /**
+     * Gets if the model is a boat or not.
+     *
+     * @returns Whether this model is a boat.
+     */
+    get IsBoat() {
+        return IsThisModelABoat(this.hash);
+    }
+    /**
+     * Gets if the model is a car or not.
+     *
+     * @returns Whether this model is a car.
+     */
+    get IsCar() {
+        return IsThisModelACar(this.hash);
+    }
+    /**
+     * Gets if the model is a cargobob or not.
+     *
+     * @returns Whether this model is a cargobob.
+     */
+    get IsCargobob() {
+        return (this.hash === VehicleHash.Cargobob ||
+            this.hash === VehicleHash.Cargobob2 ||
+            this.hash === VehicleHash.Cargobob3 ||
+            this.hash === VehicleHash.Cargobob4);
+    }
+    /**
+     * Gets if the model is a helicopter or not.
+     *
+     * @returns Whether this model is a helicopter.
+     */
+    get IsHelicopter() {
+        return IsThisModelAHeli(this.hash);
+    }
+    /**
+     * Gets if the model is a Ped or not.
+     *
+     * @returns Whether this model is a Ped.
+     */
+    get IsPed() {
+        return IsModelAPed(this.hash);
+    }
+    /**
+     * Gets if the model is a plane or not.
+     *
+     * @returns Whether this model is a plane.
+     */
+    get IsPlane() {
+        return IsThisModelAPlane(this.hash);
+    }
+    /**
+     * Gets if the model is a prop or not.
+     *
+     * @returns Whether this model is a prop.
+     */
+    get IsProp() {
+        return this.IsValid && !this.IsPed && !this.IsVehicle && !IsWeaponValid(this.hash);
+    }
+    /**
+     * Gets if the model is a quadbike or not.
+     *
+     * @returns Whether this model is a quadbike.
+     */
+    get IsQuadbike() {
+        return IsThisModelAQuadbike(this.hash);
+    }
+    /**
+     * Gets if the model is a train or not.
+     *
+     * @returns Whether this model is a train.
+     */
+    get IsTrain() {
+        return IsThisModelATrain(this.hash);
+    }
+    /**
+     * Gets if the model is a Vehicle or not.
+     *
+     * @returns Whether this model is a Vehicle.
+     */
+    get IsVehicle() {
+        return IsModelAVehicle(this.hash);
+    }
+    /**
+     * Gets the model dimensions.
+     *
+     * @returns This model min & max dimensions.
+     */
+    get Dimensions() {
+        const [minArray, maxArray] = GetModelDimensions(this.hash);
+        const min = Vector3.fromArray(minArray);
+        const max = Vector3.fromArray(maxArray);
+        return { min, max };
+    }
+    /**
+     * Request and load the model with a specified timeout. Default timeout is 1000 (recommended).
+     *
+     * @param timeout Maximum allowed time for model to load.
+     */
+    request(timeout = 1000) {
+        return new Promise(resolve => {
+            if (!this.IsInCdImage && !this.IsValid && !IsWeaponValid(this.hash)) {
+                resolve(false);
+            }
+            RequestModel(this.hash);
+            const start = GetGameTimer();
+            const interval = setInterval(() => {
+                if (this.IsLoaded || GetGameTimer() - start >= timeout) {
+                    clearInterval(interval);
+                    this.markAsNoLongerNeeded();
+                    resolve(this.IsLoaded);
+                }
+            }, 0);
+        });
+    }
+    /**
+     * Sets the model as no longer needed allowing the game engine to free memory.
+     */
+    markAsNoLongerNeeded() {
+        SetModelAsNoLongerNeeded(this.hash);
+    }
+}

package/lib/client/NetworkedScene.d.ts

@@ -0,0 +1,10 @@
+import type { Ped, Vector3 } from '.';
+import type { BaseEntity } from './models/BaseEntity';
+export declare class NetworkedScene {
+    private scene;
+    constructor(pos: Vector3, rot: Vector3, rotationOrder: number, holdLastFrame: boolean, looped: boolean, sceneHash: number, animTime: number, animSpeed: number);
+    addPed(ped: Ped, animDict: string, animName: string, blendInSpeed: number, blendOutSpeed: number, duration: number, flag: number, playbackRate: number, p9: number): void;
+    addEntity(entity: BaseEntity, animDict: string, animName: string, speed: number, speedMultiplier: number, flag: number): void;
+    start(): void;
+    stop(): void;
+}

package/lib/client/NetworkedScene.js

@@ -0,0 +1,17 @@
+export class NetworkedScene {
+    constructor(pos, rot, rotationOrder, holdLastFrame, looped, sceneHash, animTime, animSpeed) {
+        this.scene = NetworkCreateSynchronisedScene(pos.x, pos.y, pos.z, rot.x, rot.y, rot.z, rotationOrder, holdLastFrame, looped, sceneHash, animTime + 0.0, animSpeed + 0.0);
+    }
+    addPed(ped, animDict, animName, blendInSpeed, blendOutSpeed, duration, flag, playbackRate, p9) {
+        NetworkAddPedToSynchronisedScene(ped.Handle, this.scene, animDict, animName, blendInSpeed, blendOutSpeed, duration, flag, playbackRate, p9);
+    }
+    addEntity(entity, animDict, animName, speed, speedMultiplier, flag) {
+        NetworkAddEntityToSynchronisedScene(entity.Handle, this.scene, animDict, animName, speed, speedMultiplier, flag);
+    }
+    start() {
+        NetworkStartSynchronisedScene(this.scene);
+    }
+    stop() {
+        NetworkStopSynchronisedScene(this.scene);
+    }
+}

package/lib/client/ParticleEffect.d.ts

@@ -0,0 +1,80 @@
+import { ParticleEffectAsset } from './';
+import { InvertAxis } from './enums';
+import { Color, Vector3 } from './utils';
+/**
+ * UNFINISHED! Class to manage particle effects.
+ */
+export declare abstract class ParticleEffect {
+    protected readonly asset: ParticleEffectAsset;
+    protected readonly effectName: string;
+    protected offset: Vector3;
+    protected rotation: Vector3;
+    protected color: Color;
+    protected scale: number;
+    protected range: number;
+    protected invertAxis: InvertAxis;
+    private handle;
+    /**
+     * Creates a particle effect.
+     *
+     * @param asset Particle effect asset.
+     * @param effectName Name of effect.
+     */
+    constructor(asset: ParticleEffectAsset, effectName: string);
+    /**
+     * Get the particle effect handle.
+     */
+    get Handle(): number;
+    /**
+     * Get whether particle effect is currently active.
+     */
+    get IsActive(): boolean;
+    abstract start(): boolean;
+    /**
+     * Stop a particle effect.
+     */
+    stop(): void;
+    /**
+     * Get the rotation of the particle effect.
+     */
+    get Rotation(): Vector3;
+    /**
+     * Set the rotation of the particle effect.
+     */
+    set Rotation(rotation: Vector3);
+    /**
+     * Get the range of the particle effect.
+     */
+    get Range(): number;
+    /**
+     * Set the range of the particle effect.
+     */
+    set Range(range: number);
+    /**
+     * Get the invert axis flag of the particle effect.
+     */
+    get InvertAxis(): InvertAxis;
+    /**
+     * Set the inverted axis of the particle effect.
+     */
+    set InvertAxis(invertAxis: InvertAxis);
+    /**
+     * Set a paramaeter of a particle effect.
+     *
+     * @param parameterName Name of parameter.
+     * @param value Value of parameter.
+     */
+    setParameter(parameterName: string, value: number): void;
+    /**
+     * Get the name of the particle effect asset. Same as ParticleEffect.AssetName.
+     */
+    get AssetName(): string;
+    /**
+     * Get the name of the particle effect.
+     */
+    get EffectName(): string;
+    /**
+     * Return the particle effect as string. `AssetName`\\`EffectName`.
+     */
+    toString(): string;
+}

package/lib/client/ParticleEffect.js

@@ -0,0 +1,120 @@
+import { InvertAxisFlags } from './enums';
+import { Color, Vector3 } from './utils';
+// TODO: Lots of Matrix stuff through memory access
+/**
+ * UNFINISHED! Class to manage particle effects.
+ */
+export class ParticleEffect {
+    /**
+     * Creates a particle effect.
+     *
+     * @param asset Particle effect asset.
+     * @param effectName Name of effect.
+     */
+    constructor(asset, effectName) {
+        this.offset = new Vector3(0, 0, 0);
+        this.rotation = new Vector3(0, 0, 0);
+        this.color = Color.empty;
+        this.scale = 1.0;
+        this.range = 1.0;
+        this.invertAxis = { flags: InvertAxisFlags.None };
+        this.handle = -1;
+        this.asset = asset;
+        this.effectName = effectName;
+    }
+    /**
+     * Get the particle effect handle.
+     */
+    get Handle() {
+        return this.handle;
+    }
+    /**
+     * Get whether particle effect is currently active.
+     */
+    get IsActive() {
+        return this.Handle !== -1 && DoesParticleFxLoopedExist(this.Handle);
+    }
+    /**
+     * Stop a particle effect.
+     */
+    stop() {
+        if (this.IsActive) {
+            RemoveParticleFx(this.Handle, false);
+        }
+        this.handle = -1;
+    }
+    /**
+     * Get the rotation of the particle effect.
+     */
+    get Rotation() {
+        return this.rotation;
+    }
+    /**
+     * Set the rotation of the particle effect.
+     */
+    set Rotation(rotation) {
+        this.rotation = rotation;
+        if (this.IsActive) {
+            const off = this.offset; // TODO Matrix stuff to access from memory
+            SetParticleFxLoopedOffsets(this.Handle, off.x, off.y, off.z, rotation.x, rotation.y, rotation.z);
+        }
+    }
+    /**
+     * Get the range of the particle effect.
+     */
+    get Range() {
+        return this.range;
+    }
+    /**
+     * Set the range of the particle effect.
+     */
+    set Range(range) {
+        this.range = range;
+        SetParticleFxLoopedRange(this.Handle, range);
+    }
+    /**
+     * Get the invert axis flag of the particle effect.
+     */
+    get InvertAxis() {
+        return this.invertAxis;
+    }
+    /**
+     * Set the inverted axis of the particle effect.
+     */
+    set InvertAxis(invertAxis) {
+        this.invertAxis = invertAxis;
+        if (this.IsActive) {
+            this.stop();
+            this.start();
+        }
+    }
+    /**
+     * Set a paramaeter of a particle effect.
+     *
+     * @param parameterName Name of parameter.
+     * @param value Value of parameter.
+     */
+    setParameter(parameterName, value) {
+        if (this.IsActive) {
+            SetParticleFxLoopedEvolution(this.Handle, parameterName, value, false);
+        }
+    }
+    /**
+     * Get the name of the particle effect asset. Same as ParticleEffect.AssetName.
+     */
+    get AssetName() {
+        return this.asset.AssetName;
+    }
+    /**
+     * Get the name of the particle effect.
+     */
+    get EffectName() {
+        return this.effectName;
+    }
+    /**
+     * Return the particle effect as string. `AssetName`\\`EffectName`.
+     */
+    toString() {
+        return `${this.AssetName}\\${this.EffectName}`;
+    }
+}

package/lib/client/ParticleEffectAsset.d.ts

@@ -0,0 +1,54 @@
+import { InvertAxis } from './enums';
+import type { BaseEntity } from './models/BaseEntity';
+import { Vector3 } from './utils';
+/**
+ * UNFINISHED! Class that represents a particle effect asset.
+ */
+export declare class ParticleEffectAsset {
+    /**
+     * Returns the name of the asset. Same as AssetName.
+     */
+    get Asset(): string;
+    private readonly assetName;
+    constructor(assetName: string);
+    /**
+     * Get the name of the particle effect.
+     */
+    get AssetName(): string;
+    /**
+     * Get whether the particle effect has loaded into game memory.
+     */
+    get IsLoaded(): boolean;
+    /**
+     * Start a particle effect at a world position.
+     *
+     * @param effectName Name of effect.
+     * @param rot Rotation from entity position.
+     * @param scale Size of the effect.
+     * @param invertAxis Which axis to invert (default none).
+     */
+    startNonLoopedAtCoord(effectName: string, pos: Vector3, rot?: Vector3, scale?: number, invertAxis?: InvertAxis): boolean;
+    /**
+     * Start a particle effect on an entity
+     *
+     * @param effectName Name of effect.
+     * @param entity Entity to use effect on.
+     * @param off Offset from entity position.
+     * @param rot Rotation from entity position.
+     * @param scale Size of the effect.
+     * @param invertAxis Which axis to invert (default none).
+     */
+    startNonLoopedOnEntity(effectName: string, entity: BaseEntity, off?: Vector3, rot?: Vector3, scale?: number, invertAxis?: InvertAxis): boolean;
+    /**
+     * Load a particle effect into the game memory.
+     *
+     * @param timeout Max time to load Particle Effect
+     */
+    request(timeout: number): Promise<boolean>;
+    /**
+     * Allow game engine to safely unload particle effect model from memory.
+     */
+    markAsNoLongerNeeded(): void;
+    toString(): string;
+    private setNextCall;
+}