@nativewrappers/redm 0.0.78 → 0.0.80

package/index.d.ts

@@ -8,4 +8,5 @@ export * from "./world";
 export * from "./GameConstants";
 export * from "./RelationshipGroup";
 export * from "./Attribute";
+export * from "./Model";
 export * from "./common/index";

package/index.js

@@ -2867,6 +2867,154 @@ var RelationshipGroup = class {
   }
 };
 
+// src/redm/Model.ts
+var Model = class {
+  static {
+    __name(this, "Model");
+  }
+  /**
+   * Hash of this model.
+   */
+  hash;
+  requestedModel = false;
+  /**
+   * 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 = GetHashKey(hash);
+    } else {
+      this.hash = hash;
+    }
+  }
+  [Symbol.dispose]() {
+    if (this.requestedModel) {
+      this.markAsNoLongerNeeded();
+    }
+  }
+  /**
+   * 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 boat or not.
+   *
+   * @returns Whether this model is a boat.
+   */
+  get IsBoat() {
+    return IsThisModelABoat(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 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 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).
+   * This function will not automatically set the model as no longer needed when
+   * done.
+   *
+   * @param timeoutMs Maximum allowed time for model to load.
+   */
+  async request(timeoutMs = 1e3) {
+    if (!this.IsInCdImage && !this.IsValid && !IsWeaponValid(this.hash)) {
+      return false;
+    }
+    if (this.IsLoaded) {
+      return true;
+    }
+    RequestModel(this.hash, false);
+    const timeout = GetGameTimer() + timeoutMs;
+    while (!this.IsLoaded && GetGameTimer() < timeout) {
+      await Delay(0);
+    }
+    this.requestedModel = true;
+    return this.IsLoaded;
+  }
+  /**
+   * Sets the model as no longer needed allowing the game engine to free memory.
+   */
+  markAsNoLongerNeeded() {
+    SetModelAsNoLongerNeeded(this.hash);
+  }
+};
+
 // src/common/GlobalData.ts
 var GlobalData = class _GlobalData {
   static {
@@ -3577,6 +3725,7 @@ export {
   KnockOffVehicle,
   Kvp,
   Maths,
+  Model,
   NetEvent,
   NetworkedMap,
   NuiEvent,

package/package.json

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