@nativewrappers/fivem 0.0.1

package/lib/client/weapon/Mk2WeaponHash.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Mk2 weapon hash
+ *
+ */
+export declare enum Mk2WeaponHash {
+    PistolMk2 = 3219281620,
+    SNSPistolMk2 = 2285322324,
+    RevolverMk2 = 3415619887,
+    SMGMk2 = 2024373456,
+    PumpShotgunMk2 = 1432025498,
+    AssaultRifleMk2 = 961495388,
+    CarbineRifleMk2 = 4208062921,
+    SpecialCarbineMk2 = 2526821735,
+    BullpupRifleMk2 = 2228681469,
+    CombatMGMk2 = 3686625920,
+    HeavySniperMk2 = 177293209,
+    MarksmanRifleMk2 = 1785463520
+}

package/lib/client/weapon/Mk2WeaponHash.js

@@ -0,0 +1,25 @@
+/**
+ * Mk2 weapon hash
+ *
+ */
+export var Mk2WeaponHash;
+(function (Mk2WeaponHash) {
+    // handguns
+    Mk2WeaponHash[Mk2WeaponHash["PistolMk2"] = 3219281620] = "PistolMk2";
+    Mk2WeaponHash[Mk2WeaponHash["SNSPistolMk2"] = 2285322324] = "SNSPistolMk2";
+    Mk2WeaponHash[Mk2WeaponHash["RevolverMk2"] = 3415619887] = "RevolverMk2";
+    // smg
+    Mk2WeaponHash[Mk2WeaponHash["SMGMk2"] = 2024373456] = "SMGMk2";
+    // shotgun
+    Mk2WeaponHash[Mk2WeaponHash["PumpShotgunMk2"] = 1432025498] = "PumpShotgunMk2";
+    // assault_rifles
+    Mk2WeaponHash[Mk2WeaponHash["AssaultRifleMk2"] = 961495388] = "AssaultRifleMk2";
+    Mk2WeaponHash[Mk2WeaponHash["CarbineRifleMk2"] = 4208062921] = "CarbineRifleMk2";
+    Mk2WeaponHash[Mk2WeaponHash["SpecialCarbineMk2"] = 2526821735] = "SpecialCarbineMk2";
+    Mk2WeaponHash[Mk2WeaponHash["BullpupRifleMk2"] = 2228681469] = "BullpupRifleMk2";
+    // machine_guns
+    Mk2WeaponHash[Mk2WeaponHash["CombatMGMk2"] = 3686625920] = "CombatMGMk2";
+    // sniper_rifles
+    Mk2WeaponHash[Mk2WeaponHash["HeavySniperMk2"] = 177293209] = "HeavySniperMk2";
+    Mk2WeaponHash[Mk2WeaponHash["MarksmanRifleMk2"] = 1785463520] = "MarksmanRifleMk2";
+})(Mk2WeaponHash || (Mk2WeaponHash = {}));

package/lib/client/weapon/Weapon.d.ts

@@ -0,0 +1,169 @@
+import { WeaponComponentCollection } from '../weaponComponent/WeaponComponentCollection';
+import { Ped } from '../models';
+import { AmmoType, WeaponHash } from '../hashes';
+import { Model } from '../Model';
+import { WeaponTint } from './WeaponTint';
+import { WeaponGroup } from './WeaponGroup';
+import { WeaponLivery } from './WeaponLivery';
+import { WeaponLiveryColor } from './WeaponLiveryColor';
+import { WeaponHudStats } from './WeaponHudStats';
+import { WeaponComponentHash } from '../weaponComponent';
+/**
+ * ped weapon
+ *
+ */
+export declare class Weapon {
+    private readonly owner;
+    private readonly components;
+    private readonly hash;
+    constructor(owner: Ped, hash: WeaponHash);
+    /**
+     * weapon components
+     *
+     * @constructor
+     */
+    get Components(): WeaponComponentCollection;
+    /**
+     * weapon hash
+     *
+     * @constructor
+     */
+    get Hash(): WeaponHash;
+    /**
+     * check ped is unarmed or not
+     *
+     * @constructor
+     */
+    get IsUnarmed(): boolean;
+    /**
+     * Check if the ped has the current weapon.
+     *
+     * @constructor
+     */
+    get IsPresent(): boolean;
+    /**
+     * get weapon display name / label
+     *
+     * @constructor
+     */
+    get DisplayName(): string;
+    /**
+     * get weapon localized name
+     *
+     * @constructor
+     */
+    get LocalizedName(): string;
+    /**
+     * get weapon model
+     *
+     * @constructor
+     */
+    get Model(): Model;
+    /**
+     * get weapon tint
+     *
+     * @constructor
+     */
+    get Tint(): WeaponTint;
+    /**
+     * set weapon tint
+     *
+     * @param tint
+     * @constructor
+     */
+    set Tint(tint: WeaponTint);
+    /**
+     * get weapon group
+     *
+     * @constructor
+     */
+    get Group(): WeaponGroup;
+    /**
+     * get weapon ammo type
+     *
+     * @constructor
+     */
+    get AmmoType(): AmmoType;
+    /**
+     * get weapon ammo count
+     *
+     * @constructor
+     */
+    get Ammo(): number;
+    /**
+     * set weapon ammo count
+     *
+     * @param count
+     * @constructor
+     */
+    set Ammo(count: number);
+    /**
+     * get weapon max ammo
+     *
+     * @constructor
+     */
+    get MaxAmmo(): number;
+    /**
+     * get weapon max ammo in clip
+     *
+     * @constructor
+     */
+    get MaxAmmoInClip(): number;
+    /**
+     * get weapon default clip size
+     *
+     * @constructor
+     */
+    get DefaultClipSize(): number;
+    /**
+     * toggle weapon infinite ammo
+     *
+     * @param toggle
+     * @constructor
+     */
+    set InfiniteAmmo(toggle: boolean);
+    /**
+     * toggle ped infinite ammo clip on all weapons
+     *
+     * @param toggle
+     * @constructor
+     */
+    set InfiniteAmmoClip(toggle: boolean);
+    /**
+     * check weapon can use on parachute
+     *
+     * @constructor
+     */
+    get CanUseOnParachute(): boolean;
+    /**
+     * Check weapon is Mk2 or not
+     *
+     * @constructor
+     */
+    get IsMk2(): boolean;
+    /**
+     * set weapon livery, only work for Mk2 weapon
+     *
+     * @param liveryId
+     * @param colorId
+     */
+    setLivery(liveryId: WeaponLivery, colorId: WeaponLiveryColor): void;
+    /**
+     * get weapon hud stats
+     *
+     * @constructor
+     */
+    get HudStats(): WeaponHudStats | undefined;
+    /**
+     * get weapon display name / label by hash
+     *
+     * @param hash
+     */
+    static getDisplayNameFromHash(hash: WeaponHash): string;
+    /**
+     * get component hashes belongs to weapon
+     *
+     * @param hash
+     */
+    static getWeaponComponentHashes(hash: WeaponHash): WeaponComponentHash[];
+}

package/lib/client/weapon/Weapon.js

@@ -0,0 +1,267 @@
+import { WeaponComponentCollection } from '../weaponComponent/WeaponComponentCollection';
+import { WeaponHash } from '../hashes';
+import { WeaponDisplayNameByHash } from './WeaponDisplayNameByHash';
+import { Game } from '../Game';
+import { Model } from '../Model';
+import { WeaponHudStats } from './WeaponHudStats';
+import { enumValues } from '../utils';
+import { Mk2WeaponHash } from './Mk2WeaponHash';
+import { WeaponComponentHashesByWeaponHash } from '../weaponComponent/WeaponComponentHashesByWeaponHash';
+/**
+ * ped weapon
+ *
+ */
+export class Weapon {
+    constructor(owner, hash) {
+        this.owner = owner;
+        this.hash = hash;
+        this.components = new WeaponComponentCollection(this.owner, this);
+    }
+    /**
+     * weapon components
+     *
+     * @constructor
+     */
+    get Components() {
+        return this.components;
+    }
+    /**
+     * weapon hash
+     *
+     * @constructor
+     */
+    get Hash() {
+        return this.hash;
+    }
+    /**
+     * check ped is unarmed or not
+     *
+     * @constructor
+     */
+    get IsUnarmed() {
+        return this.hash === WeaponHash.Unarmed;
+    }
+    /**
+     * Check if the ped has the current weapon.
+     *
+     * @constructor
+     */
+    get IsPresent() {
+        if (this.IsUnarmed) {
+            return true;
+        }
+        return HasPedGotWeapon(this.owner.Handle, this.hash, false);
+    }
+    /**
+     * get weapon display name / label
+     *
+     * @constructor
+     */
+    get DisplayName() {
+        return Weapon.getDisplayNameFromHash(this.hash) ?? 'WCT_INVALID';
+    }
+    /**
+     * get weapon localized name
+     *
+     * @constructor
+     */
+    get LocalizedName() {
+        return Game.getGXTEntry(this.DisplayName);
+    }
+    /**
+     * get weapon model
+     *
+     * @constructor
+     */
+    get Model() {
+        return new Model(GetWeapontypeModel(this.hash));
+    }
+    /**
+     * get weapon tint
+     *
+     * @constructor
+     */
+    get Tint() {
+        return GetPedWeaponTintIndex(this.owner.Handle, this.hash);
+    }
+    /**
+     * set weapon tint
+     *
+     * @param tint
+     * @constructor
+     */
+    set Tint(tint) {
+        SetPedWeaponTintIndex(this.owner.Handle, this.hash, tint);
+    }
+    /**
+     * get weapon group
+     *
+     * @constructor
+     */
+    get Group() {
+        return GetWeapontypeGroup(this.hash);
+    }
+    /**
+     * get weapon ammo type
+     *
+     * @constructor
+     */
+    get AmmoType() {
+        return GetPedAmmoTypeFromWeapon(this.owner.Handle, this.hash);
+    }
+    /**
+     * get weapon ammo count
+     *
+     * @constructor
+     */
+    get Ammo() {
+        if (this.IsUnarmed) {
+            return 1;
+        }
+        if (!this.IsPresent) {
+            return GetPedAmmoByType(this.owner.Handle, this.AmmoType);
+        }
+        return GetAmmoInPedWeapon(this.owner.Handle, this.hash);
+    }
+    /**
+     * set weapon ammo count
+     *
+     * @param count
+     * @constructor
+     */
+    set Ammo(count) {
+        if (this.IsUnarmed) {
+            return;
+        }
+        if (this.IsPresent) {
+            SetPedAmmo(this.owner.Handle, this.hash, count);
+        }
+        else {
+            GiveWeaponToPed(this.owner.Handle, this.hash, count, false, true);
+        }
+    }
+    /**
+     * get weapon max ammo
+     *
+     * @constructor
+     */
+    get MaxAmmo() {
+        if (this.IsUnarmed) {
+            return 1;
+        }
+        // GetMaxAmmo
+        // https://docs.fivem.net/natives/?_0xDC16122C7A20C933
+        // noinspection UnnecessaryLocalVariableJS
+        const amount = Citizen.invokeNative('0xDC16122C7A20C933', this.owner.Handle, this.hash, Citizen.pointerValueInt(), Citizen.resultAsInteger());
+        return amount;
+    }
+    /**
+     * get weapon max ammo in clip
+     *
+     * @constructor
+     */
+    get MaxAmmoInClip() {
+        if (this.IsUnarmed) {
+            return 1;
+        }
+        if (!this.IsPresent) {
+            return 0;
+        }
+        return GetMaxAmmoInClip(this.owner.Handle, this.hash, true);
+    }
+    /**
+     * get weapon default clip size
+     *
+     * @constructor
+     */
+    get DefaultClipSize() {
+        return GetWeaponClipSize(this.hash);
+    }
+    /**
+     * toggle weapon infinite ammo
+     *
+     * @param toggle
+     * @constructor
+     */
+    set InfiniteAmmo(toggle) {
+        if (this.IsUnarmed) {
+            return;
+        }
+        SetPedInfiniteAmmo(this.owner.Handle, toggle, this.hash);
+    }
+    /**
+     * toggle ped infinite ammo clip on all weapons
+     *
+     * @param toggle
+     * @constructor
+     */
+    set InfiniteAmmoClip(toggle) {
+        SetPedInfiniteAmmoClip(this.owner.Handle, toggle);
+    }
+    /**
+     * check weapon can use on parachute
+     *
+     * @constructor
+     */
+    get CanUseOnParachute() {
+        return CanUseWeaponOnParachute(this.hash);
+    }
+    /**
+     * Check weapon is Mk2 or not
+     *
+     * @constructor
+     */
+    get IsMk2() {
+        return Array.from(enumValues(Mk2WeaponHash)).some(x => x === this.hash);
+    }
+    /**
+     * set weapon livery, only work for Mk2 weapon
+     *
+     * @param liveryId
+     * @param colorId
+     */
+    setLivery(liveryId, colorId) {
+        if (!this.IsMk2) {
+            console.log(`[ERROR]${this.setLivery.name} failed. Reason: non-Mk2 weapon`);
+            return;
+        }
+        const component = this.Components.getMk2CamoComponent(liveryId);
+        if (component.IsInvalid) {
+            console.log(`[ERROR]${this.setLivery.name} failed. Reason: invalid liveryId/Component`);
+            return;
+        }
+        component.Active = true;
+        SetPedWeaponLiveryColor(this.owner.Handle, this.hash, component.ComponentHash, colorId);
+    }
+    /**
+     * get weapon hud stats
+     *
+     * @constructor
+     */
+    get HudStats() {
+        return WeaponHudStats.get(this.hash);
+    }
+    /**
+     * get weapon display name / label by hash
+     *
+     * @param hash
+     */
+    static getDisplayNameFromHash(hash) {
+        if (!hash) {
+            return 'WT_INVALID';
+        }
+        return WeaponDisplayNameByHash.get(hash) ?? 'WCT_INVALID';
+    }
+    /**
+     * get component hashes belongs to weapon
+     *
+     * @param hash
+     */
+    static getWeaponComponentHashes(hash) {
+        const hashes = WeaponComponentHashesByWeaponHash.get(hash);
+        if (!hashes) {
+            return [];
+        }
+        return [...hashes];
+    }
+}

package/lib/client/weapon/WeaponAsset.d.ts

@@ -0,0 +1,55 @@
+import { WeaponHash } from '../hashes';
+/**
+ * weapon asset
+ *
+ */
+export declare class WeaponAsset {
+    private readonly hash;
+    constructor(hash: WeaponHash);
+    /**
+     * get weapon hash
+     *
+     * @constructor
+     */
+    get Hash(): WeaponHash;
+    /**
+     * check weapon is valid
+     *
+     * @constructor
+     */
+    get IsValid(): boolean;
+    /**
+     * check weapon assets is loaded
+     *
+     * @constructor
+     */
+    get IsLoaded(): boolean;
+    /**
+     * request weapon asset
+     *
+     */
+    request(): void;
+    /**
+     * request weapon asset async
+     *
+     * @param timeout
+     */
+    requestAsync(timeout: number): Promise<boolean>;
+    /**
+     * unload weapon asset
+     *
+     */
+    dismiss(): void;
+    /**
+     * get weapon display name / label
+     *
+     * @constructor
+     */
+    get DisplayName(): string;
+    /**
+     * get weapon localized name
+     *
+     * @constructor
+     */
+    get LocalizedName(): string;
+}

package/lib/client/weapon/WeaponAsset.js

@@ -0,0 +1,83 @@
+import { Weapon } from './Weapon';
+import { Game } from '../Game';
+import { Wait } from '../utils';
+/**
+ * weapon asset
+ *
+ */
+export class WeaponAsset {
+    constructor(hash) {
+        this.hash = hash;
+    }
+    /**
+     * get weapon hash
+     *
+     * @constructor
+     */
+    get Hash() {
+        return this.hash;
+    }
+    /**
+     * check weapon is valid
+     *
+     * @constructor
+     */
+    get IsValid() {
+        return IsWeaponValid(this.hash);
+    }
+    /**
+     * check weapon assets is loaded
+     *
+     * @constructor
+     */
+    get IsLoaded() {
+        return HasWeaponAssetLoaded(this.hash);
+    }
+    /**
+     * request weapon asset
+     *
+     */
+    request() {
+        RequestWeaponAsset(this.hash, 31, 0);
+    }
+    /**
+     * request weapon asset async
+     *
+     * @param timeout
+     */
+    async requestAsync(timeout) {
+        this.request();
+        const start = GetGameTimer();
+        while (!this.IsLoaded) {
+            await Wait(100);
+            const now = GetGameTimer();
+            if (now - start >= timeout) {
+                return false;
+            }
+        }
+        return true;
+    }
+    /**
+     * unload weapon asset
+     *
+     */
+    dismiss() {
+        RemoveWeaponAsset(this.hash);
+    }
+    /**
+     * get weapon display name / label
+     *
+     * @constructor
+     */
+    get DisplayName() {
+        return Weapon.getDisplayNameFromHash(this.hash);
+    }
+    /**
+     * get weapon localized name
+     *
+     * @constructor
+     */
+    get LocalizedName() {
+        return Game.getGXTEntry(this.DisplayName);
+    }
+}

package/lib/client/weapon/WeaponCollection.d.ts

@@ -0,0 +1,90 @@
+import { Weapon } from './Weapon';
+import { Ped, Prop } from '../models';
+import { WeaponHash } from '../hashes';
+/**
+ * ped weapons
+ *
+ */
+export declare class WeaponCollection implements Iterable<Weapon> {
+    private readonly owner;
+    private readonly weapons;
+    constructor(owner: Ped);
+    [Symbol.iterator](): Iterator<Weapon>;
+    /**
+     * get weapon by hash
+     *
+     * @param hash
+     */
+    get(hash: WeaponHash): Weapon | null;
+    /**
+     * get ped current weapon
+     *
+     * @constructor
+     */
+    get Current(): Weapon;
+    /**
+     * get ped current weapon object
+     *
+     * @constructor
+     */
+    get CurrentWeaponObject(): Prop | null;
+    /**
+     * get ped best weapon
+     *
+     * @constructor
+     */
+    get BestWeapon(): Weapon;
+    /**
+     * check ped has weapon
+     *
+     * @param hash
+     */
+    hasWeapon(hash: WeaponHash): boolean;
+    /**
+     * check weapon is valid
+     *
+     * @param hash
+     */
+    isWeaponValid(hash: WeaponHash): boolean;
+    /**
+     * give weapon to ped
+     *
+     * @param hash
+     * @param ammoCount
+     * @param equipNow
+     * @param isAmmoLoaded
+     */
+    give(hash: WeaponHash, ammoCount: number, equipNow: boolean, isAmmoLoaded: boolean): Weapon;
+    /**
+     * set ped current weapon on hand
+     *
+     * @param weapon
+     */
+    select(weapon: Weapon | WeaponHash): boolean;
+    /**
+     * remove weapon from ped
+     *
+     * @param weapon
+     */
+    remove(weapon: Weapon | WeaponHash): void;
+    /**
+     * remove all weapons from ped
+     *
+     */
+    removeAll(): void;
+    /**
+     * Drop ped current weapon?
+     * todo: this native seems does not work as expected, need to investigate
+     * refer1: https://docs.fivem.net/natives/?_0x6B7513D9966FBEC0
+     * refer2: https://forum.cfx.re/t/release-weapondrop/49856/8
+     *
+     */
+    drop(): void;
+    /**
+     * create weapon object and add to collection
+     *
+     * @param hash
+     * @private
+     */
+    private createAndAddWeapon;
+}