@pma-network/redm-server 0.0.14 → 0.0.16

package/PMA.d.ts

@@ -32,6 +32,10 @@ export declare class PMA {
      * Gets all of the players that habe the specified job(s), and the specified {@param job_rank} if specified.
      */
     static get_players_with_job(job_names: string | string[], job_rank?: number): PMAPlayerWrapper[];
+    /**
+     * Returns all of the players currently registered in the core.
+     */
+    static get_players(): PMAPlayerWrapper[];
     /**
      * Generic logging
      * TODO: Setup a clickhouse wrapper

package/PMA.js

@@ -10,7 +10,7 @@ class PMA {
    * @returns the item data for {@param item_name}, or `null` if the item doesn't exist
    */
   static get_item(item_name) {
-    return exports["pma"].get_item(item_name);
+    return exports["pma-inventory"].get_item(item_name);
   }
   /**
    * Registers the {@param item_name} to be used as a usable item
@@ -23,7 +23,7 @@ class PMA {
     }, "usable_item_wrapper");
     const resource_wrapper = GetResourceWrapper();
     resource_wrapper.add_to_resource_start("pma", () => {
-      exports["pma"].register_usable_item(item_name, usable_item_wrapper);
+      exports["pma-inventory"].register_usable_item(item_name, usable_item_wrapper);
     });
   }
   /**
@@ -51,6 +51,13 @@ class PMA {
     const players = exports["pma"].get_players_with_job(job_names, job_rank);
     return players.map((v) => PMAPlayerWrapper.from_raw(v));
   }
+  /**
+   * Returns all of the players currently registered in the core.
+   */
+  static get_players() {
+    const players = exports["pma"].get_players();
+    return players.map((v) => PMAPlayerWrapper.from_raw(v));
+  }
   /**
    * Generic logging
    * TODO: Setup a clickhouse wrapper

package/PMAInventory.d.ts

@@ -0,0 +1,18 @@
+import type { BaseInventory } from "@pma-network/redm-types/BaseInventory";
+import type { InventoryId, ItemName } from "@pma-network/redm-types/Inventory";
+import type { PlayerUID, Source } from "@pma-network/redm-types/PMAPlayer";
+export declare class PMAInventory {
+    #private;
+    static HaveItemsLoaded: Promise<boolean>;
+    private static init_has_loaded;
+    protected static _resolve(): void;
+    static on_resource_stop(): void;
+    static on_resource_start(): Promise<void>;
+    /**
+    * Initializes the player, this will internally await for items to be loaded
+    */
+    static init_player(source: Source, inventory_id: InventoryId, uid: PlayerUID): Promise<BaseInventory>;
+    protected static get_inventory_internal(inventory_id: InventoryId): any;
+    static get_inventory(inventory_id: InventoryId): BaseInventory;
+    static does_item_exist(item_name: ItemName): boolean;
+}

package/PMAInventory.js

@@ -0,0 +1,49 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import { Delay, OnResourceStart, OnResourceStop } from "@nativewrappers/common";
+class PMAInventory {
+  static {
+    __name(this, "PMAInventory");
+  }
+  static #has_loaded_resolve;
+  static HaveItemsLoaded;
+  static async init_has_loaded() {
+    PMAInventory.HaveItemsLoaded = new Promise((res) => {
+      PMAInventory.#has_loaded_resolve = res;
+    });
+  }
+  static _resolve() {
+    PMAInventory.#has_loaded_resolve(true);
+  }
+  static {
+    PMAInventory.init_has_loaded();
+  }
+  @OnResourceStop("pma-inventory")
+  static on_resource_stop() {
+    PMAInventory.init_has_loaded();
+  }
+  @OnResourceStart("pma-inventory")
+  static async on_resource_start() {
+    await Delay(0);
+    await exports["pma-inventory"].wait_for_item_manager_init();
+    PMAInventory._resolve();
+  }
+  /**
+  * Initializes the player, this will internally await for items to be loaded
+  */
+  static async init_player(source, inventory_id, uid) {
+    return exports["pma-inventory"].init_player(source, inventory_id, uid);
+  }
+  static get_inventory_internal(inventory_id) {
+    return exports["pma-inventory"].get_inventory(inventory_id);
+  }
+  static get_inventory(inventory_id) {
+    return PMAInventory.get_inventory_internal(inventory_id);
+  }
+  static does_item_exist(item_name) {
+    return exports["pma-inventory"].does_item_exist(item_name);
+  }
+}
+export {
+  PMAInventory
+};

package/class/PMAPlayer.d.ts

@@ -1,4 +1,4 @@
-import type { ItemName, OptionalItem } from "@pma-network/redm-types/Inventory";
+import type { InventoryAddItemFailReason, InventoryRemoveItemFailReason, ItemName, OptionalItem } from "@pma-network/redm-types/Inventory";
 import type { NotificationVariant, PMAPartialNotification } from "@pma-network/redm-types/Notifications";
 import { CommonPMAPlayer } from "../shared-server/class/CommonPMAPlayer";
 import type { CommonAbstractPMAPlayer } from "../shared-server/types/CommonAbstractPMAPlayer";
@@ -18,8 +18,10 @@ export declare class PMAPlayerWrapper extends CommonPMAPlayer {
     static from_source_unchecked(source: number): CommonPMAPlayer;
     constructor(source: number);
     constructor(pma_player: CommonAbstractPMAPlayer);
+    ensure_inventory_init(): void;
     send_notification(title?: string, description?: string, variant?: NotificationVariant, duration?: number): void;
     send_notification_object(partial: PMAPartialNotification): void;
     get_item(item_name: ItemName): OptionalItem;
-    add_item(item_name: ItemName, quantity: number): OptionalItem;
+    add_item(item_name: ItemName, quantity: number): InventoryAddItemFailReason;
+    remove_item(item_name: ItemName, quantity: number): InventoryRemoveItemFailReason;
 }

package/class/PMAPlayer.js

@@ -1,14 +1,12 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 import { CommonPMAPlayer } from "../shared-server/class/CommonPMAPlayer";
+import { pma_get_inventory_from_id } from "../shared-server/utils/GlobalOverrides";
 class PMAPlayerWrapper extends CommonPMAPlayer {
   static {
     __name(this, "PMAPlayerWrapper");
   }
-  // This will get lazy-initialized whenever we actually call a function that needs it,
-  // this will make sure we don't pay the un-needed serialize cost if we're only using this for
-  // basic nativewrappers types
-  #pma_player;
+  #inventory;
   /**
    * Creates the player from the ScRT msgpack'd class
    */
@@ -34,11 +32,22 @@ class PMAPlayerWrapper extends CommonPMAPlayer {
     if (typeof source !== "number") {
       const ply = source;
       super(ply.source);
-      this.#pma_player = ply;
+      this.pma_player = ply;
     } else {
       super(source);
     }
   }
+  ensure_inventory_init() {
+    this.ensure_init();
+    const fn = (
+      // @ts-ignore
+      typeof globalThis.pma_get_inventory_from_id === "function" ? (
+        // @ts-ignore
+        globalThis.pma_get_inventory_from_id
+      ) : pma_get_inventory_from_id
+    );
+    this.#inventory ??= fn(`player:${this.get_unique_id()}`);
+  }
   send_notification(title, description, variant = "default", duration = 5e3) {
     const noti = {
       body: description,
@@ -51,12 +60,16 @@ class PMAPlayerWrapper extends CommonPMAPlayer {
     this.emit("pma:add_notification", partial);
   }
   get_item(item_name) {
-    this.ensure_init();
-    return this.#pma_player.get_item(item_name);
+    this.ensure_inventory_init();
+    return this.#inventory.get_item(item_name);
   }
   add_item(item_name, quantity) {
-    this.ensure_init();
-    return this.#pma_player.add_item(item_name, quantity);
+    this.ensure_inventory_init();
+    return this.#inventory.add_item(item_name, quantity);
+  }
+  remove_item(item_name, quantity) {
+    this.ensure_inventory_init();
+    return this.#inventory.remove_item(item_name, quantity);
   }
 }
 export {

package/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./PMA";
+export * from "./PMAInventory";
 export * from "./types/Inventory";
 export * from "./shared-server/CommonPMA";
 export * from "./shared-server/utils/CooldownTracker";

package/index.js

@@ -1,4 +1,5 @@
 export * from "./PMA";
+export * from "./PMAInventory";
 export * from "./types/Inventory";
 export * from "./shared-server/CommonPMA";
 export * from "./shared-server/utils/CooldownTracker";

package/package.json

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

package/shared-server/class/CommonPMAPlayer.d.ts

@@ -3,7 +3,7 @@ import type { CommonAbstractPMAPlayer } from "../types/CommonAbstractPMAPlayer";
 import type { CommonNotificationVariant, CommonPMAPartialNotification } from "../types/CommonNotifications";
 import type { CallSign, ItemName, PlayerJob, PlayerUID } from "../types/SharedTypes";
 export declare class CommonPMAPlayer extends Player implements CommonAbstractPMAPlayer {
-    #private;
+    protected pma_player: CommonAbstractPMAPlayer | null;
     /**
      * Creates the player from the ScRT msgpack'd class
      */
@@ -31,7 +31,7 @@ export declare class CommonPMAPlayer extends Player implements CommonAbstractPMA
     get_log_name(): string;
     get_item(item_name: ItemName): unknown;
     add_item(item_name: ItemName, quantity: number): unknown;
-    remove_item(item_name: ItemName, quantity: number): void;
+    remove_item(item_name: ItemName, quantity: number): unknown;
     has_enough_of_item(item_name: ItemName, quantity: number): boolean;
     get_job(): PlayerJob;
     set_job(job_name: string, rank: number): void;

package/shared-server/class/CommonPMAPlayer.js

@@ -1,7 +1,6 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
 import { Player } from "@nativewrappers/server";
-import { framework_name } from "../utils/FrameworkName";
 import { pma_get_player_from_id } from "../utils/GlobalOverrides";
 class CommonPMAPlayer extends Player {
   static {
@@ -10,7 +9,7 @@ class CommonPMAPlayer extends Player {
   // This will get lazy-initialized whenever we actually call a function that needs it,
   // this will make sure we don't pay the un-needed serialize cost if we're only using this for
   // basic nativewrappers types
-  #pma_player = null;
+  pma_player = null;
   /**
    * Creates the player from the ScRT msgpack'd class
    */
@@ -36,15 +35,15 @@ class CommonPMAPlayer extends Player {
     if (typeof source !== "number") {
       const ply = source;
       super(ply.source);
-      this.#pma_player = ply;
+      this.pma_player = ply;
     } else {
       super(source);
     }
   }
   // Ensure we initialize the player whenever we're doing something that needs it.
   ensure_init() {
-    if (!this.#pma_player) {
-      this.#pma_player = globalThis.pma_get_player_from_id ? (
+    if (!this.pma_player) {
+      this.pma_player = globalThis.pma_get_player_from_id ? (
         // @ts-ignore: we override this in GlobalOverrides
         globalThis.pma_get_player_from_id(this.Source)
       ) : pma_get_player_from_id(this.Source);
@@ -56,7 +55,7 @@ class CommonPMAPlayer extends Player {
    */
   is_player_valid() {
     this.ensure_init();
-    return this.#pma_player !== null;
+    return this.pma_player !== null;
   }
   send_notification(title, description, variant = "default", duration = 5e3) {
     const noti = {
@@ -71,71 +70,71 @@ class CommonPMAPlayer extends Player {
   }
   get_sex() {
     this.ensure_init();
-    return this.#pma_player.get_sex();
+    return this.pma_player.get_sex();
   }
   get_height() {
     this.ensure_init();
-    return this.#pma_player.get_height();
+    return this.pma_player.get_height();
   }
   get_dob() {
     this.ensure_init();
-    return this.#pma_player.get_dob();
+    return this.pma_player.get_dob();
   }
   get_unique_id() {
     this.ensure_init();
-    return this.#pma_player.get_unique_id();
+    return this.pma_player.get_unique_id();
   }
   get_call_sign() {
     this.ensure_init();
-    return this.#pma_player.get_call_sign();
+    return this.pma_player.get_call_sign();
   }
   get_character_name() {
     this.ensure_init();
-    return this.#pma_player.get_character_name();
+    return this.pma_player.get_character_name();
   }
   get_log_name() {
     this.ensure_init();
-    return this.#pma_player.get_character_name();
+    return this.pma_player.get_character_name();
   }
   get_item(item_name) {
     this.ensure_init();
-    return this.#pma_player.get_item(item_name);
+    return this.pma_player.get_item(item_name);
   }
   add_item(item_name, quantity) {
     this.ensure_init();
-    return this.#pma_player.add_item(item_name, quantity);
+    return this.pma_player.add_item(item_name, quantity);
   }
   remove_item(item_name, quantity) {
     this.ensure_init();
-    return this.#pma_player.remove_item(item_name, quantity);
+    return this.pma_player.remove_item(item_name, quantity);
   }
   has_enough_of_item(item_name, quantity) {
     this.ensure_init();
-    return this.#pma_player.has_enough_of_item(item_name, quantity);
+    return this.pma_player.has_enough_of_item(item_name, quantity);
   }
   get_job() {
     this.ensure_init();
-    return this.#pma_player.get_job();
+    return this.pma_player.get_job();
   }
   set_job(job_name, rank) {
     this.ensure_init();
-    return this.#pma_player.set_job(job_name, rank);
+    return this.pma_player.set_job(job_name, rank);
   }
   get_bank() {
     this.ensure_init();
-    return this.#pma_player.get_bank();
+    return this.pma_player.get_bank();
   }
   add_to_bank(positive_amount) {
     this.ensure_init();
-    return this.#pma_player.add_to_bank(positive_amount);
+    return this.pma_player.add_to_bank(positive_amount);
   }
   remove_from_bank(negative_amount) {
     this.ensure_init();
-    return this.#pma_player.remove_from_bank(negative_amount);
+    return this.pma_player.remove_from_bank(negative_amount);
   }
   save() {
     this.ensure_init();
-    return this.#pma_player.save();
+    return this.pma_player.save();
   }
 }
 export {

package/shared-server/types/CommonAbstractPMAPlayer.d.ts

@@ -21,7 +21,7 @@ export declare abstract class CommonAbstractPMAPlayer {
      * Removes the item with {@param item_name} from the players inventory
      * @throws This will throw an error if there wasn't enough {@param quantity} in the players inventory, you should use use has_enough_of_item to check before calling
      */
-    abstract remove_item(item_name: ItemName, quantity: number): void;
+    abstract remove_item(item_name: ItemName, quantity: number): unknown;
     /**
      * Checks if the player has enough of {@param item_name}
      * @returns `true` if they had enough {@param quantity}, `false` otherwise

package/shared-server/utils/GlobalOverrides.d.ts

@@ -1,3 +1,4 @@
 import type { CommonPMAPlayer } from "../class/CommonPMAPlayer";
 import type { Source } from "../types/SharedTypes";
 export declare function pma_get_player_from_id(source: Source): CommonPMAPlayer;
+export declare function pma_get_inventory_from_id(source: Source): CommonPMAPlayer;

package/shared-server/utils/GlobalOverrides.js

@@ -6,6 +6,12 @@ function pma_get_player_from_id(source) {
 }
 __name(pma_get_player_from_id, "pma_get_player_from_id");
 globalThis.pma_get_player_from_id = pma_get_player_from_id;
+function pma_get_inventory_from_id(source) {
+  return exports[framework_name].get_inventory(source);
+}
+__name(pma_get_inventory_from_id, "pma_get_inventory_from_id");
+globalThis.pma_get_inventory_from_id = pma_get_inventory_from_id;
 export {
+  pma_get_inventory_from_id,
   pma_get_player_from_id
 };

package/types/Inventory.d.ts

@@ -1,4 +1,5 @@
-import type { BaseInventory, InventoryItem } from "@pma-network/redm-types/Inventory";
+import type { BaseInventory } from "@pma-network/redm-types/BaseInventory";
+import type { InventoryItem } from "@pma-network/redm-types/Inventory";
 import type { AbstractPMAPlayer } from "../class/AbstractPMAPlayer";
 import type { PMAPlayerWrapper } from "../class/PMAPlayer";
 export type UsableItemCall = (ply: PMAPlayerWrapper, inventory: BaseInventory, item: InventoryItem) => void;