@pma-network/redm-types 0.0.13 → 0.0.15

package/BaseInventory.d.ts

@@ -0,0 +1,26 @@
+import type { InventoryAddItemFailReason, InventoryRemoveItemFailReason, ItemName, OptionalItem } from "./Inventory";
+export declare abstract class BaseInventory {
+    /**
+     * Gets the item with {@link item_name}
+     * @returns the {@link InventoryItem} or undefined if the player doesn't have that item in their inventory.
+     */
+    abstract get_item(item_name: ItemName): OptionalItem;
+    /**
+     * Adds the item with {@link item_name} to the players next free slot
+     * @throws This will throw an error if {@link item_name} is invalid, or if {@link quantity} is negative
+     * @returns the {@link InventoryItem} that was created, or undefined if there wasn't a free slot to put the item into.
+     */
+    abstract add_item(item_name: ItemName, quantity: number): InventoryAddItemFailReason;
+    /**
+     * Removes the item with {@link item_name} from the players inventory
+     * @throws This will throw an error if there wasn't enough {@link quantity} in the players inventory, you should use use {@link has_enough_of_item} to check before calling
+     * @param item_name the item to remove
+     * @param quantity the amount of the item to remove
+     */
+    abstract remove_item(item_name: ItemName, quantity: number): InventoryRemoveItemFailReason;
+    /**
+     * Checks if the player has enough of {@link item_name}
+     * @returns `true` if they had enough {@link quantity}, `false` otherwise
+     */
+    abstract has_enough_of_item(item_name: ItemName, quantity: number): boolean;
+}

package/BaseInventory.js

@@ -0,0 +1,10 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class BaseInventory {
+  static {
+    __name(this, "BaseInventory");
+  }
+}
+export {
+  BaseInventory
+};

package/Inventory.d.ts

@@ -8,8 +8,12 @@ export declare enum ItemFlags {
     IsAmmo = 8,
     Stackable = 32
 }
+export type InventoryEntityTypes = "localHorse" | "localVehicle" | "horse" | "player" | "vehicle" | "chest" | "shop" | "invalid";
+export type InventoryId = `${InventoryEntityTypes}:${number}`;
 export type ItemName = string;
+export type SlotId = number;
 export type ItemId = number;
+export type SlotAndItemId = [SlotId] | [SlotId, ItemId | undefined];
 export interface ItemData {
     item_id: ItemId;
     name: ItemName;
@@ -24,28 +28,45 @@ export interface InventoryItem {
     quantity: number;
 }
 export type OptionalItem = InventoryItem | null | undefined;
-export declare abstract class BaseInventory {
-    /**
-     * Gets the item with {@link item_name}
-     * @returns the {@link InventoryItem} or undefined if the player doesn't have that item in their inventory.
-     */
-    abstract get_item(item_name: ItemName): OptionalItem;
+export declare enum InventoryAddItemFailReason {
+    SUCCESS = 0,
+    TooHeavy = 1,
+    NoFreeSlot = 2
+}
+export declare enum InventoryRemoveItemFailReason {
+    SUCCESS = 0,
+    NotEnoughOfItem = 1,
+    NoItem = 2
+}
+export declare class ItemWrapper {
+    #private;
+    private static item_data_ref;
     /**
-     * Adds the item with {@link item_name} to the players next free slot
-     * @throws This will throw an error if {@link item_name} is invalid, or if {@link quantity} is negative
-     * @returns the {@link InventoryItem} that was created, or undefined if there wasn't a free slot to put the item into.
+     *
      */
-    abstract add_item(item_name: ItemName, quantity: number): OptionalItem;
+    static get UnsafeRef(): ItemWrapper;
+    constructor(item_data: ItemData);
+    replace_ref(ref: ItemData): this;
+    clone(): ItemWrapper;
+    get ItemData(): ItemData;
+    get ItemId(): number;
+    get Name(): ItemName;
+    get Weight(): number;
+    get Flags(): Bitwise<ItemFlags>;
     /**
-     * Removes the item with {@link item_name} from the players inventory
-     * @throws This will throw an error if there wasn't enough {@link quantity} in the players inventory, you should use use {@link has_enough_of_item} to check before calling
-     * @param item_name the item to remove
-     * @param quantity the amount of the item to remove
+     * If the item is a weapon it will just return the weapons weight, as ammo has
+     * no actual weight, otherwise it will return the weight of the item * quantity
      */
-    abstract remove_item(item_name: ItemName, quantity: number): boolean;
+    calculate_weight(quantity: number): number;
+    private can_item_stack;
+    private is_item_stackable;
+    get IsWeapon(): boolean;
+    get IsStackable(): boolean;
     /**
-     * Checks if the player has enough of {@link item_name}
-     * @returns `true` if they had enough {@link quantity}, `false` otherwise
+     * Returns the amount of items that can be stacked into this item, by default
+     * this is 100
      */
-    abstract has_enough_of_item(item_name: ItemName, quantity: number): boolean;
+    get StackLimit(): number;
+    get Label(): string;
+    get Description(): string;
 }

package/Inventory.js

@@ -9,12 +9,94 @@ var ItemFlags = /* @__PURE__ */ ((ItemFlags2) => {
   ItemFlags2[ItemFlags2["Stackable"] = 32] = "Stackable";
   return ItemFlags2;
 })(ItemFlags || {});
-class BaseInventory {
+var InventoryAddItemFailReason = /* @__PURE__ */ ((InventoryAddItemFailReason2) => {
+  InventoryAddItemFailReason2[InventoryAddItemFailReason2["SUCCESS"] = 0] = "SUCCESS";
+  InventoryAddItemFailReason2[InventoryAddItemFailReason2["TooHeavy"] = 1] = "TooHeavy";
+  InventoryAddItemFailReason2[InventoryAddItemFailReason2["NoFreeSlot"] = 2] = "NoFreeSlot";
+  return InventoryAddItemFailReason2;
+})(InventoryAddItemFailReason || {});
+var InventoryRemoveItemFailReason = /* @__PURE__ */ ((InventoryRemoveItemFailReason2) => {
+  InventoryRemoveItemFailReason2[InventoryRemoveItemFailReason2["SUCCESS"] = 0] = "SUCCESS";
+  InventoryRemoveItemFailReason2[InventoryRemoveItemFailReason2["NotEnoughOfItem"] = 1] = "NotEnoughOfItem";
+  InventoryRemoveItemFailReason2[InventoryRemoveItemFailReason2["NoItem"] = 2] = "NoItem";
+  return InventoryRemoveItemFailReason2;
+})(InventoryRemoveItemFailReason || {});
+class ItemWrapper {
   static {
-    __name(this, "BaseInventory");
+    __name(this, "ItemWrapper");
+  }
+  #ref;
+  static item_data_ref = new ItemWrapper(void 0);
+  /**
+   *
+   */
+  static get UnsafeRef() {
+    return ItemWrapper.item_data_ref;
+  }
+  constructor(item_data) {
+    this.#ref = item_data;
+  }
+  replace_ref(ref) {
+    this.#ref = ref;
+    return this;
+  }
+  clone() {
+    return new ItemWrapper(this.#ref);
+  }
+  get ItemData() {
+    return this.#ref;
+  }
+  get ItemId() {
+    return this.#ref.item_id;
+  }
+  get Name() {
+    return this.#ref.name;
+  }
+  get Weight() {
+    return this.#ref.weight;
+  }
+  get Flags() {
+    return this.#ref.flags;
+  }
+  /**
+   * If the item is a weapon it will just return the weapons weight, as ammo has
+   * no actual weight, otherwise it will return the weight of the item * quantity
+   */
+  calculate_weight(quantity) {
+    if (this.IsWeapon) {
+      return this.Weight;
+    }
+    return this.#ref.weight * quantity;
+  }
+  can_item_stack() {
+    return this.is_item_stackable() || this.IsWeapon;
+  }
+  is_item_stackable() {
+    return (this.#ref.flags & 32 /* Stackable */) !== 0;
+  }
+  get IsWeapon() {
+    return (this.#ref.flags & 8 /* IsWeapon */) !== 0;
+  }
+  get IsStackable() {
+    return this.can_item_stack();
+  }
+  /**
+   * Returns the amount of items that can be stacked into this item, by default
+   * this is 100
+   */
+  get StackLimit() {
+    return this.#ref.stack_limit;
+  }
+  get Label() {
+    return this.#ref.label;
+  }
+  get Description() {
+    return this.#ref.description;
   }
 }
 export {
-  BaseInventory,
-  ItemFlags
+  InventoryAddItemFailReason,
+  InventoryRemoveItemFailReason,
+  ItemFlags,
+  ItemWrapper
 };

package/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./BaseInventory";
 export * from "./Inventory";
 export * from "./Notifications";
 export * from "./PMAPlayer";

package/index.js

@@ -1,3 +1,4 @@
+export * from "./BaseInventory";
 export * from "./Inventory";
 export * from "./Notifications";
 export * from "./PMAPlayer";

package/package.json

@@ -5,7 +5,7 @@
     "Dillon Skaggs <AvarianKnight>"
   ],
   "type": "module",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "files": [
     "./**/*.js",
     "./**/*.d.ts"