@nativewrappers/redm 0.0.89 → 0.0.92

package/common/decors/Events.js

@@ -123,11 +123,13 @@ function ConVar(name, is_floating_point, deserialize) {
         }
       } else if (default_type === "boolean") {
         con_var_type = 3 /* Boolean */;
-      } else if (default_value === "string") {
+      } else if (default_type === "string") {
         con_var_type = 0 /* String */;
       }
       if (!deserialize && con_var_type === null) {
-        throw new Error("You should provide a deserialize function if you want to convert this to an object type");
+        throw new Error(
+          `Failed to determine what to use to deserialize '${name}' was for var had type '${default_type}' which can't be deserialized without providing your own deserialize function.`
+        );
       }
       if (con_var_type === null) {
         con_var_type = 0 /* String */;

package/entities/BaseEntity.d.ts

@@ -1,6 +1,6 @@
 import { Vector3 } from "../common/utils/Vector";
 export declare class BaseEntity {
-    private handle;
+    protected handle: number;
     constructor(entHandle: number);
     /**
       * Replaces the current handle for the entity used on, this hsould be used sparringly, mainly
@@ -24,7 +24,7 @@ export declare class BaseEntity {
       */
     replaceHandle(newHandle: number): void;
     /**
-     * @returns the network for the specified entity, this doesn't check if the entity is networked, you should use {@link BaseEntity.IsNetworked}
+     * @returns the network for the specified entity, this doesn't check if the entity is networked, you should use {@link IsNetworked}
      */
     get NetworkId(): number;
     /**

package/entities/BaseEntity.js

@@ -33,22 +33,22 @@ class BaseEntity {
     this.handle = newHandle;
   }
   /**
-   * @returns the network for the specified entity, this doesn't check if the entity is networked, you should use {@link BaseEntity.IsNetworked}
+   * @returns the network for the specified entity, this doesn't check if the entity is networked, you should use {@link IsNetworked}
    */
   get NetworkId() {
-    return NetworkGetNetworkIdFromEntity(this.Handle);
+    return NetworkGetNetworkIdFromEntity(this.handle);
   }
   /**
    * @returns `true` if the current entity is networked, false otherwise
    */
   get IsNetworked() {
-    return NetworkGetEntityIsNetworked(this.Handle);
+    return NetworkGetEntityIsNetworked(this.handle);
   }
   /**
    * @returns Returns true if the entity handle is not 0 and exists in the game engine
    */
   get Exists() {
-    return this.handle !== 0 && DoesEntityExist(this.Handle);
+    return this.handle !== 0 && DoesEntityExist(this.handle);
   }
   /**
    * @returns Returns true if the entity is dead
@@ -66,25 +66,25 @@ class BaseEntity {
    * @param amount the health to set the health to, setting to `0` will kill the entity, if using on a {@link Ped} you should check the MaxHealth before setting.
    */
   set Health(amount) {
-    SetEntityHealth(this.Handle, amount, 0);
+    SetEntityHealth(this.handle, amount, 0);
   }
   /**
    * @returns the amount of health the current {@link BaseEntity} has
    */
   get Health() {
-    return GetEntityHealth(this.Handle);
+    return GetEntityHealth(this.handle);
   }
   /**
    * @returns the heading of the current {@link BaseEntity}
    */
   get Heading() {
-    return GetEntityHeading(this.Handle);
+    return GetEntityHeading(this.handle);
   }
   /**
    * @param heading sets the entitys heading to the specified heading, this can be in the range of 0..360
    */
   set Heading(heading) {
-    SetEntityHeading(this.Handle, heading);
+    SetEntityHeading(this.handle, heading);
   }
   /**
    * @returns the position of the current Entity

package/entities/Ped.d.ts

@@ -9,6 +9,17 @@ import { Vehicle } from "./Vehicle";
 export declare class Ped extends BaseEntity {
     private attributes;
     private tasks;
+    /**
+     * Gets the entity from the handle given, if the entity doesn't exist it will return
+     * null.
+     */
+    static fromHandle(handle: number): Ped | null;
+    /**
+     * Gets the ped from the current network id, this doesn't check that
+     * the entity is actually a ped
+     */
+    static fromNetworkId(netId: number): Ped | null;
+    static fromStateBagName(bagName: string): Ped | null;
     constructor(handle: number);
     /**
      * Blocks scenarios inbetween the specified vectors
@@ -159,4 +170,20 @@ export declare class Ped extends BaseEntity {
      */
     applyDamagePack(damagePack: string, damage: number, mult: number): void;
     get CurrentVehicle(): Vehicle | null;
+    giveHashCommand(commandHash: number, activationDuration: number): void;
+    /**
+     * Adds or removes the ped stamina, depending on of the amount is positive or negative.
+     * @param amount the amount of stamina to add/remove
+     */
+    changeStamina(amount: number): void;
+    get MaxStamina(): number;
+    /**
+     * Returns the amount of stamina the ped has
+     */
+    get Stamina(): number;
+    /**
+     * returns the normalized stamina for the player, taking into account their unlocked stamina
+     */
+    get StaminaNormalized(): number;
+    resetStamina(): void;
 }

package/entities/Ped.js

@@ -11,6 +11,33 @@ class Ped extends BaseEntity {
   }
   attributes;
   tasks;
+  /**
+   * Gets the entity from the handle given, if the entity doesn't exist it will return
+   * null.
+   */
+  static fromHandle(handle) {
+    if (handle === 0 || !DoesEntityExist(handle)) {
+      return null;
+    }
+    return new Ped(handle);
+  }
+  /**
+   * Gets the ped from the current network id, this doesn't check that
+   * the entity is actually a ped
+   */
+  static fromNetworkId(netId) {
+    if (netId === 0 || !NetworkDoesEntityExistWithNetworkId(netId)) {
+      return null;
+    }
+    return new Ped(NetToPed(netId));
+  }
+  static fromStateBagName(bagName) {
+    const ent = GetEntityFromStateBagName(bagName);
+    if (ent === 0) {
+      return null;
+    }
+    return new Ped(ent);
+  }
   constructor(handle) {
     super(handle);
   }
@@ -52,13 +79,13 @@ class Ped extends BaseEntity {
    * While this increases the peds max health, if used on a player it wont increase the max core value on the hud
    */
   set MaxHealth(amount) {
-    SetPedMaxHealth(this.Handle, amount);
+    SetPedMaxHealth(this.handle, amount);
   }
   /**
    * @returns the maximum health of the ped
    */
   get MaxHealth() {
-    return GetPedMaxHealth(this.Handle);
+    return GetPedMaxHealth(this.handle);
   }
   /**
    * @returns the {@link Attributes} for the current ped
@@ -68,158 +95,154 @@ class Ped extends BaseEntity {
     return this.attributes = new Attributes(this);
   }
   get InVehicle() {
-    return IsPedInAnyVehicle(this.Handle, true);
+    return IsPedInAnyVehicle(this.handle, true);
   }
   get IsInjured() {
-    return IsPedInjured(this.Handle);
+    return IsPedInjured(this.handle);
   }
   get IsFatallyInjured() {
-    return IsPedFatallyInjured(this.Handle);
+    return IsPedFatallyInjured(this.handle);
   }
   get IsPlayer() {
-    return IsPedAPlayer(this.Handle);
+    return IsPedAPlayer(this.handle);
   }
   get IsShooting() {
-    return IsPedShooting(this.Handle);
+    return IsPedShooting(this.handle);
   }
   get Accuracy() {
-    return GetPedAccuracy(this.Handle);
+    return GetPedAccuracy(this.handle);
   }
   set Accuracy(accuracy) {
-    SetPedAccuracy(this.Handle, accuracy);
+    SetPedAccuracy(this.handle, accuracy);
   }
   get CanBeKnockedOffVehicle() {
-    return CanKnockPedOffVehicle(this.Handle);
+    return CanKnockPedOffVehicle(this.handle);
   }
   get IsMale() {
-    return IsPedMale(this.Handle);
+    return IsPedMale(this.handle);
   }
   get IsHuman() {
-    return IsPedHuman(this.Handle);
+    return IsPedHuman(this.handle);
   }
   get IsOnTopOfVehicle() {
-    return IsPedOnVehicle(this.Handle, false);
+    return IsPedOnVehicle(this.handle, false);
   }
   get Vehicle() {
-    const vehicle = GetVehiclePedIsIn(this.Handle, false);
-    if (vehicle === 0) {
-      return null;
-    }
-    return new Vehicle(vehicle);
+    return Vehicle.fromHandle(GetVehiclePedIsIn(this.handle, false));
   }
   /**
    * @returns the last mount that this ped was on, or null if it doesn't exist
    */
   get Mount() {
-    const pedId = _N("0x4C8B59171957BCF7", this.Handle, Citizen.resultAsInteger());
-    return pedId ? new Ped(pedId) : null;
+    const pedId = _N("0x4C8B59171957BCF7", this.handle, Citizen.resultAsInteger());
+    return Ped.fromHandle(pedId);
   }
   /**
    * returns the horse that this ped is leading
    */
   get LeadingHorse() {
-    const pedId = _N("0x693126B5D0457D0D", this.Handle, Citizen.resultAsInteger());
-    return pedId ? new Ped(pedId) : null;
+    const pedId = _N("0x693126B5D0457D0D", this.handle, Citizen.resultAsInteger());
+    return Ped.fromHandle(pedId);
   }
   /**
    * returns the owner of the current animal
    */
   get Owner() {
-    const pedId = _N("0xF103823FFE72BB49", this.Handle, Citizen.resultAsInteger());
-    return pedId ? new Ped(pedId) : null;
+    const pedId = _N("0xF103823FFE72BB49", this.handle, Citizen.resultAsInteger());
+    return Ped.fromHandle(pedId);
   }
   get TamingState() {
-    return _N("0x454AD4DA6C41B5BD", this.Handle, Citizen.resultAsInteger());
+    return _N("0x454AD4DA6C41B5BD", this.handle, Citizen.resultAsInteger());
   }
   get IsInteractingWithAnimal() {
-    return _N("0x7FC84E85D98F063D", this.Handle, Citizen.resultAsInteger());
+    return _N("0x7FC84E85D98F063D", this.handle, Citizen.resultAsInteger());
   }
   get IsSittingInAnyVehicle() {
-    return IsPedSittingInAnyVehicle(this.Handle);
+    return IsPedSittingInAnyVehicle(this.handle);
   }
   get IsPlantingBomb() {
-    return IsPedPlantingBomb(this.Handle);
+    return IsPedPlantingBomb(this.handle);
   }
   get IsInAnyBoat() {
-    return IsPedInAnyBoat(this.Handle);
+    return IsPedInAnyBoat(this.handle);
   }
   get IsInAnyHeli() {
-    return IsPedInAnyHeli(this.Handle);
+    return IsPedInAnyHeli(this.handle);
   }
   get IsInAnyPlane() {
-    return IsPedInAnyPlane(this.Handle);
+    return IsPedInAnyPlane(this.handle);
   }
   get IsInFlyingVehicle() {
-    return IsPedInFlyingVehicle(this.Handle);
+    return IsPedInFlyingVehicle(this.handle);
   }
   get IsFalling() {
-    return IsPedFalling(this.Handle);
+    return IsPedFalling(this.handle);
   }
   get IsSliding() {
-    return _N("0xD6740E14E4CEFC0B", this.Handle, Citizen.resultAsInteger());
+    return _N("0xD6740E14E4CEFC0B", this.handle, Citizen.resultAsInteger());
   }
   get IsJumping() {
-    return IsPedJumping(this.Handle);
+    return IsPedJumping(this.handle);
   }
   get IsClimbing() {
-    return IsPedClimbing(this.Handle);
+    return IsPedClimbing(this.handle);
   }
   get IsClimbingLadder() {
-    return _N("0x59643424B68D52B5", this.Handle, Citizen.resultAsInteger());
+    return _N("0x59643424B68D52B5", this.handle, Citizen.resultAsInteger());
   }
   get IsVaulting() {
-    return IsPedVaulting(this.Handle);
+    return IsPedVaulting(this.handle);
   }
   get IsDiving() {
-    return IsPedDiving(this.Handle);
+    return IsPedDiving(this.handle);
   }
   get IsOpeningADoor() {
-    return IsPedOpeningADoor(this.Handle);
+    return IsPedOpeningADoor(this.handle);
   }
   set SeeingRange(value) {
-    SetPedSeeingRange(this.Handle, value);
+    SetPedSeeingRange(this.handle, value);
   }
   set HearingRange(value) {
-    SetPedHearingRange(this.Handle, value);
+    SetPedHearingRange(this.handle, value);
   }
   get IsStealthed() {
-    return GetPedStealthMovement(this.Handle);
+    return GetPedStealthMovement(this.handle);
   }
   get IsJacking() {
-    return IsPedJacking(this.Handle);
+    return IsPedJacking(this.handle);
   }
   get IsStunned() {
-    return IsPedBeingStunned(this.Handle, 0);
+    return IsPedBeingStunned(this.handle, 0);
   }
   get IsBeingJacked() {
-    return IsPedBeingJacked(this.Handle);
+    return IsPedBeingJacked(this.handle);
   }
   get IsInCombatRoll() {
-    return _N("0xC48A9EB0D499B3E5", this.Handle, Citizen.resultAsInteger());
+    return _N("0xC48A9EB0D499B3E5", this.handle, Citizen.resultAsInteger());
   }
   get CrouchMovement() {
-    return _N("0xD5FE956C70FF370B", this.Handle, Citizen.resultAsInteger());
+    return _N("0xD5FE956C70FF370B", this.handle, Citizen.resultAsInteger());
   }
   /**
    * returns true if {@link DamageCleanliness} was ever lower than {@link eDamageCleanliness.Good}
    */
   get IsDamaged() {
-    return _N("0x6CFC373008A1EDAF", this.Handle, Citizen.resultAsInteger());
+    return _N("0x6CFC373008A1EDAF", this.handle, Citizen.resultAsInteger());
   }
   set IsDamaged(damaged) {
-    _N("0xDACE03C65C6666DB", this.Handle, damaged);
+    _N("0xDACE03C65C6666DB", this.handle, damaged);
   }
   get DamageCleanliness() {
-    return _N("0x88EFFED5FE8B0B4A", this.Handle, Citizen.resultAsInteger());
+    return _N("0x88EFFED5FE8B0B4A", this.handle, Citizen.resultAsInteger());
   }
   set DamageCleanliness(cleanliness) {
-    _N("0x7528720101A807A5", this.Handle, cleanliness);
+    _N("0x7528720101A807A5", this.handle, cleanliness);
   }
   set DefenseModifier(amount) {
-    _N("0x9B6808EC46BE849B", this.Handle, amount);
+    _N("0x9B6808EC46BE849B", this.handle, amount);
   }
   set CanBeTargeted(toggle) {
-    SetPedCanBeTargetted(this.Handle, toggle);
+    SetPedCanBeTargetted(this.handle, toggle);
   }
   // TODO: Team class wrapper
   // TODO: Bone wrapper `GET_PED_LAST_DAMAGE_BONE`
@@ -227,31 +250,31 @@ class Ped extends BaseEntity {
    * returns the ped who jacked this ped
    */
   getJacker() {
-    return new Ped(GetPedsJacker(this.Handle));
+    return new Ped(GetPedsJacker(this.handle));
   }
   setCrouchMovement(state, immediately = false) {
-    _N("0x7DE9692C6F64CFE8", this.Handle, state, 0, immediately);
+    _N("0x7DE9692C6F64CFE8", this.handle, state, 0, immediately);
   }
   canBeTargetedByPlayer(player, toggle) {
-    SetPedCanBeTargettedByPlayer(this.Handle, player.Handle, toggle);
+    SetPedCanBeTargettedByPlayer(this.handle, player.Handle, toggle);
   }
   clearLastBoneDamage() {
-    ClearPedLastDamageBone(this.Handle);
+    ClearPedLastDamageBone(this.handle);
   }
   set OwnsAnimal(animal) {
-    _N("0x931B241409216C1F", this.Handle, animal.Handle, false);
+    _N("0x931B241409216C1F", this.handle, animal.Handle, false);
   }
   isInteractionPossible(animal) {
-    return _N("0xD543D3A8FDE4F185", this.Handle, animal.Handle, Citizen.resultAsInteger());
+    return _N("0xD543D3A8FDE4F185", this.handle, animal.Handle, Citizen.resultAsInteger());
   }
   isOnVehicle(vehicle) {
-    return IsPedOnSpecificVehicle(this.Handle, vehicle.Handle);
+    return IsPedOnSpecificVehicle(this.handle, vehicle.Handle);
   }
   isSittingInVehicle(vehicle) {
-    return IsPedSittingInVehicle(this.Handle, vehicle.Handle);
+    return IsPedSittingInVehicle(this.handle, vehicle.Handle);
   }
   warpOutOfVehicle() {
-    _N("0xE0B61ED8BB37712F", this.Handle);
+    _N("0xE0B61ED8BB37712F", this.handle);
   }
   /**
    * puts the ped onto the specified mount
@@ -259,10 +282,10 @@ class Ped extends BaseEntity {
    * @param seatIndex the seat index to put the ped on
    */
   setOntoMount(targetPed, seatIndex) {
-    _N("0x028F76B6E78246EB", this.Handle, targetPed.Handle, seatIndex, true);
+    _N("0x028F76B6E78246EB", this.handle, targetPed.Handle, seatIndex, true);
   }
   removeFromMount() {
-    _N("0x5337B721C51883A9", this.Handle, true, true);
+    _N("0x5337B721C51883A9", this.handle, true, true);
   }
   /**
    * Sets the ped into the specified vehicle
@@ -270,31 +293,31 @@ class Ped extends BaseEntity {
    * @param seatIndex the seat index to put the ped into
    */
   setIntoVehicle(vehicle, seatIndex) {
-    SetPedIntoVehicle(this.Handle, vehicle.Handle, seatIndex);
+    SetPedIntoVehicle(this.handle, vehicle.Handle, seatIndex);
   }
   /**
    * kills the ped and optionally sets the killer
    * @param killer the entity that killed the ped
    */
   killPed(killer) {
-    SetEntityHealth(this.Handle, 0, killer ? killer.Handle : 0);
+    SetEntityHealth(this.handle, 0, killer ? killer.Handle : 0);
   }
   damage(amount, boneId = 0, killer) {
-    ApplyDamageToPed(this.Handle, amount, 0, boneId, killer ? killer.Handle : 0);
+    ApplyDamageToPed(this.handle, amount, 0, boneId, killer ? killer.Handle : 0);
   }
   /**
    * this returns a different type then the getter so we can't use set, maybe ts will fix soon (tm)
    * @param state how hard it will be to knock a ped off their vehicle
    */
   setCanBeKnockedOffVehicle(state) {
-    SetPedCanBeKnockedOffVehicle(this.Handle, state);
+    SetPedCanBeKnockedOffVehicle(this.handle, state);
   }
   /**
    * Removes the specified ped if its not a player entity
    */
   delete() {
-    SetEntityAsMissionEntity(this.Handle, true, true);
-    DeletePed(this.Handle);
+    SetEntityAsMissionEntity(this.handle, true, true);
+    DeletePed(this.handle);
   }
   /**
    * creates a clone of the ped
@@ -304,23 +327,23 @@ class Ped extends BaseEntity {
    * @returns the cloned ped
    */
   clone(network, bScriptHostPed, copyHeadBlend) {
-    return new Ped(ClonePed(this.Handle, network, bScriptHostPed, copyHeadBlend));
+    return new Ped(ClonePed(this.handle, network, bScriptHostPed, copyHeadBlend));
   }
   /**
    * clones the ped onto the target ped
    * @param targetPed the ped to clone onto
    */
   cloneTo(targetPed) {
-    ClonePedToTarget(this.Handle, targetPed.Handle);
+    ClonePedToTarget(this.handle, targetPed.Handle);
   }
   /**
    * @param amount - the amount of armour to add to the ped
    */
   addArmour(amount) {
-    AddArmourToPed(this.Handle, amount);
+    AddArmourToPed(this.handle, amount);
   }
   applyDamage(damageAmount, boneId = 0, pedKiller = null) {
-    ApplyDamageToPed(this.Handle, damageAmount, 0, boneId, pedKiller ? pedKiller.Handle : 0);
+    ApplyDamageToPed(this.handle, damageAmount, 0, boneId, pedKiller ? pedKiller.Handle : 0);
   }
   /**
    * @param damagePack - the damage decal to apply see [here](https://github.com/femga/rdr3_discoveries/blob/master/peds_customization/ped_decals.lua) for more documentation
@@ -328,10 +351,10 @@ class Ped extends BaseEntity {
    * @param mult - the multiplier?
    */
   applyDamagePack(damagePack, damage, mult) {
-    ApplyPedDamagePack(this.Handle, damagePack, damage, mult);
+    ApplyPedDamagePack(this.handle, damagePack, damage, mult);
   }
   get CurrentVehicle() {
-    const veh = GetVehiclePedIsIn(this.Handle, false);
+    const veh = GetVehiclePedIsIn(this.handle, false);
     if (veh === 0) return null;
     return new Vehicle(veh);
   }
@@ -339,6 +362,34 @@ class Ped extends BaseEntity {
   // applyBloodSpecific() {
   // 	ApplyPedBloodSpecific
   // }
+  giveHashCommand(commandHash, activationDuration) {
+    Citizen.invokeNative("0xD65FDC686A031C83", this.handle, commandHash, activationDuration);
+  }
+  /**
+   * Adds or removes the ped stamina, depending on of the amount is positive or negative.
+   * @param amount the amount of stamina to add/remove
+   */
+  changeStamina(amount) {
+    _N("0xC3D4B754C0E86B9E", this.handle, amount);
+  }
+  get MaxStamina() {
+    return _N("0xCB42AFE2B613EE55", this.handle);
+  }
+  /**
+   * Returns the amount of stamina the ped has
+   */
+  get Stamina() {
+    return _N("0x775A1CA7893AA8B5", this.handle);
+  }
+  /**
+   * returns the normalized stamina for the player, taking into account their unlocked stamina
+   */
+  get StaminaNormalized() {
+    return _N("0x22F2A386D43048A9", this.handle);
+  }
+  resetStamina() {
+    _N("0x36513AFFC703C60D", this.handle);
+  }
 }
 export {
   Ped

package/entities/Vehicle.d.ts

@@ -2,6 +2,17 @@ import type { VehicleSeat } from "../enums/VehicleSeat";
 import { BaseEntity } from "./BaseEntity";
 export declare class Vehicle extends BaseEntity {
     constructor(handle: number);
+    /**
+     * Gets the entity from the handle given, if the entity doesn't exist it will return
+     * null.
+     */
+    static fromHandle(handle: number): Vehicle | null;
+    /**
+     * Gets the ped from the current network id, this doesn't check that
+     * the entity is actually a ped
+     */
+    static fromNetworkId(netId: number): Vehicle | null;
+    static fromStateBagName(bagName: string): Vehicle | null;
     /**
      *
      * @param seatIndex the seat index to check

package/entities/Vehicle.js

@@ -9,6 +9,33 @@ class Vehicle extends BaseEntity {
   constructor(handle) {
     super(handle);
   }
+  /**
+   * Gets the entity from the handle given, if the entity doesn't exist it will return
+   * null.
+   */
+  static fromHandle(handle) {
+    if (handle === 0 || !DoesEntityExist(handle)) {
+      return null;
+    }
+    return new Vehicle(handle);
+  }
+  /**
+   * Gets the ped from the current network id, this doesn't check that
+   * the entity is actually a ped
+   */
+  static fromNetworkId(netId) {
+    if (netId === 0 || !NetworkDoesEntityExistWithNetworkId(netId)) {
+      return null;
+    }
+    return new Vehicle(NetToPed(netId));
+  }
+  static fromStateBagName(bagName) {
+    const ent = GetEntityFromStateBagName(bagName);
+    if (ent === 0) {
+      return null;
+    }
+    return new Vehicle(ent);
+  }
   /**
    *
    * @param seatIndex the seat index to check

package/package.json

@@ -8,7 +8,7 @@
   ],
   "license": "MIT",
   "type": "module",
-  "version": "0.0.89",
+  "version": "0.0.92",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/nativewrappers.git"