@rpgjs/server 5.0.0-alpha.5 → 5.0.0-alpha.7

package/src/Player/ElementManager.ts

@@ -1,17 +1,47 @@
-import { arrayUniq, RpgCommonPlayer } from "@rpgjs/common";
+import { arrayUniq, PlayerCtor, RpgCommonPlayer } from "@rpgjs/common";
 import { Constructor } from "@rpgjs/common";
 import { RpgPlayer } from "./Player";
 
-export function WithElementManager<TBase extends Constructor<RpgCommonPlayer>>(
-  Base: TBase
-) {
-  return class extends Base implements IWithElementManager {
+/**
+ * Element Manager Mixin
+ * 
+ * Provides elemental management capabilities to any class. This mixin handles
+ * elemental resistances, vulnerabilities, and attack elements. It manages both
+ * defensive capabilities (elementsDefense) and offensive elements from equipment,
+ * as well as player-specific elemental efficiency modifiers.
+ * 
+ * @param Base - The base class to extend with element management
+ * @returns Extended class with element management methods
+ * 
+ * @example
+ * ```ts
+ * class MyPlayer extends WithElementManager(BasePlayer) {
+ *   constructor() {
+ *     super();
+ *     this.elementsEfficiency = [{ rate: 0.5, element: 'fire' }];
+ *   }
+ * }
+ * 
+ * const player = new MyPlayer();
+ * const fireResistance = player.elementsDefense.find(e => e.element === 'fire');
+ * ```
+ */
+export function WithElementManager<TBase extends PlayerCtor>(Base: TBase) {
+  return class extends Base {
     _elementsEfficiency: { rate: number; element: any }[] = [];
 
     /**
      * Recovers the player's elements defense on inventory.  This list is generated from the `elementsDefense` property defined on the weapons or armors equipped.
      * If several items have the same element, only the highest rate will be taken into account.
      *
+     * Gets the defensive capabilities against various elements from equipped items.
+     * The system automatically consolidates multiple defensive items, keeping only
+     * the highest protection rate for each element type. This provides a comprehensive
+     * view of the player's elemental resistances from all equipped gear.
+     * 
+     * @returns Array of element defense objects with rate and element properties
+     * 
+     * @example
      * ```ts
      * import { Armor } from '@rpgjs/server'
      *
@@ -37,19 +67,29 @@ export function WithElementManager<TBase extends Constructor<RpgCommonPlayer>>(
      * player.equip(FireShield)
      *
      * console.log(player.elementsDefense) // [{ rate: 1, element: 'fire' }]
+     * 
+     * // Check specific element defense
+     * const fireDefense = player.elementsDefense.find(def => def.element === 'fire');
+     * if (fireDefense) {
+     *   console.log(`Fire defense rate: ${fireDefense.rate}`);
+     * }
      * ```
-     * @title Get Elements Defense
-     * @prop {Array<{ rate: number, element: Element}>} player.elementsDefense
-     * @readonly
-     * @memberof ElementManager
-     * */
+     */
     get elementsDefense(): { rate: number; element: any }[] {
-      return this.getFeature("elementsDefense", "element");
+      return (this as any).getFeature("elementsDefense", "element");
     }
 
     /**
      * Set or retrieves all the elements where the player is vulnerable or not.
      *
+     * Manages the player's elemental efficiency modifiers, which determine how
+     * effective different elements are against this player. Values greater than 1
+     * indicate vulnerability, while values less than 1 indicate resistance.
+     * This combines both class-based efficiency and player-specific modifiers.
+     * 
+     * @returns Array of element efficiency objects with rate and element properties
+     * 
+     * @example
      * ```ts
      * import { Class } from '@rpgjs/server'
      *
@@ -71,13 +111,18 @@ export function WithElementManager<TBase extends Constructor<RpgCommonPlayer>>(
      * player.elementsEfficiency = [{ rate: 2, element: Elements.Ice }]
      *
      * console.log(player.elementsEfficiency) // [{ rate: 1, element: 'fire' }, { rate: 2, element: 'ice' }]
+     * 
+     * // Check for vulnerabilities
+     * const vulnerabilities = player.elementsEfficiency.filter(eff => eff.rate > 1);
+     * console.log('Vulnerable to:', vulnerabilities.map(v => v.element));
+     * 
+     * // Check for resistances
+     * const resistances = player.elementsEfficiency.filter(eff => eff.rate < 1);
+     * console.log('Resistant to:', resistances.map(r => r.element));
      * ```
-     * @title Set/Get Elements Efficiency
-     * @prop {Array<{ rate: number, element: Element}>} player.elementsEfficiency
-     * @memberof ElementManager
-     * */
+     */
     get elementsEfficiency(): { rate: number; element: any }[] {
-      if (this._class) {
+      if (this._class()) {
         return <any>[
           ...this._elementsEfficiency,
           ...(this._class()?.elementsEfficiency || []),
@@ -93,14 +138,30 @@ export function WithElementManager<TBase extends Constructor<RpgCommonPlayer>>(
     /**
      * Retrieves a array of elements assigned to the player and the elements of the weapons / armor equipped
      *
+     * Gets all offensive elements available to the player from equipped weapons and armor.
+     * This determines what elemental damage types the player can deal in combat.
+     * The system automatically combines elements from all equipped items and removes duplicates.
+     * 
+     * @returns Array of element objects with rate and element properties for offensive capabilities
+     * 
+     * @example
      * ```ts
-     * console.log(player.elements)
+     * // Get all offensive elements
+     * console.log(player.elements); // [{ rate: 1.5, element: 'fire' }, { rate: 1.2, element: 'ice' }]
+     * 
+     * // Check if player can deal fire damage
+     * const hasFireElement = player.elements.some(el => el.element === 'fire');
+     * if (hasFireElement) {
+     *   console.log('Player can deal fire damage');
+     * }
+     * 
+     * // Get strongest element
+     * const strongestElement = player.elements.reduce((max, current) => 
+     *   current.rate > max.rate ? current : max
+     * );
+     * console.log(`Strongest element: ${strongestElement.element} (${strongestElement.rate})`);
      * ```
-     * @title Get Elements
-     * @prop {Array<Element>} player.elements
-     * @readonly
-     * @memberof ElementManager
-     * */
+     */
     get elements(): {
       rate: number;
       element: string;
@@ -114,8 +175,42 @@ export function WithElementManager<TBase extends Constructor<RpgCommonPlayer>>(
       return arrayUniq(elements);
     }
 
+    /**
+     * Calculate elemental damage coefficient against another player
+     * 
+     * Determines the damage multiplier when this player attacks another player,
+     * taking into account the attacker's offensive elements, the defender's
+     * elemental efficiency, and elemental defense from equipment. This is used
+     * in the battle system to calculate elemental damage modifiers.
+     * 
+     * @param otherPlayer - The target player to calculate coefficient against
+     * @returns Numerical coefficient to multiply base damage by
+     * 
+     * @example
+     * ```ts
+     * // Calculate elemental damage coefficient
+     * const firePlayer = new MyPlayer();
+     * const icePlayer = new MyPlayer();
+     * 
+     * // Fire player attacks ice player (assuming ice is weak to fire)
+     * const coefficient = icePlayer.coefficientElements(firePlayer);
+     * console.log(`Damage multiplier: ${coefficient}`); // e.g., 2.0 for double damage
+     * 
+     * // Use in damage calculation
+     * const baseDamage = 100;
+     * const finalDamage = baseDamage * coefficient;
+     * console.log(`Final damage: ${finalDamage}`);
+     * 
+     * // Check for elemental advantage
+     * if (coefficient > 1) {
+     *   console.log('Attacker has elemental advantage!');
+     * } else if (coefficient < 1) {
+     *   console.log('Defender resists this element');
+     * }
+     * ```
+     */
     coefficientElements(otherPlayer: RpgPlayer): number {
-      const atkPlayerElements: any = otherPlayer.elements;
+      const atkPlayerElements: any = (otherPlayer as any).elements;
       const playerElements: any = this.elementsEfficiency;
       let coefficient = 1;
 
@@ -127,7 +222,7 @@ export function WithElementManager<TBase extends Constructor<RpgCommonPlayer>>(
           (el) => el.element == atkElement.element
         );
         if (!elementPlayer) continue;
-        const fn = this.getFormulas("coefficientElements");
+        const fn = (this as any).getFormulas("coefficientElements");
         if (!fn) {
           return coefficient;
         }
@@ -139,5 +234,11 @@ export function WithElementManager<TBase extends Constructor<RpgCommonPlayer>>(
       }
       return coefficient;
     }
-  };
+  } as unknown as TBase;
 }
+
+/**
+ * Type helper to extract the interface from the WithElementManager mixin
+ * This provides the type without duplicating method signatures
+ */
+export type IElementManager = InstanceType<ReturnType<typeof WithElementManager>>;

package/src/Player/GoldManager.ts

@@ -1,44 +1,41 @@
-import { type Constructor } from "@rpgjs/common";
-import { RpgCommonPlayer } from "@rpgjs/common";
+import { PlayerCtor } from "@rpgjs/common";
 
-/**
- * Interface defining what MoveManager adds to a class
- */
-export interface IGoldManager {
-  
+export interface GoldManager {
+  /**
+   * You can change the game money
+   *
+   * ```ts
+   * player.gold += 100
+   * ```
+   *
+   * @title Change Gold
+   * @prop {number} player.gold
+   * @default 0
+   * @memberof GoldManager
+   * */
+  gold: number;
 }
 
-/**
- * Move Manager mixin
- * 
- * Adds methods to manage player gold
- * 
- * @param Base - The base class to extend
- * @returns A new class with gold management capabilities
- */
-export function WithGoldManager<TBase extends Constructor<RpgCommonPlayer>>(Base: TBase) {
-  return class extends Base implements IGoldManager {
-    /** 
-     * You can change the game money
-     * 
-     * ```ts
-     * player.gold += 100
-     * ```
-     * 
-     * @title Change Gold
-     * @prop {number} player.gold
-     * @default 0
-     * @memberof GoldManager
-     * */
+export function WithGoldManager<TBase extends PlayerCtor>(
+  Base: TBase
+): new (...args: ConstructorParameters<TBase>) => InstanceType<TBase> &
+  GoldManager {
+  return class extends Base {
     set gold(val: number) {
-        if (val < 0) {
-            val = 0
-        }
-        this._gold.set(val)
+      if (val < 0) {
+        val = 0;
+      }
+      this._gold.set(val);
     }
 
     get gold(): number {
-        return this._gold()
+      return this._gold();
     }
-  };
+  } as unknown as any;
 }
+
+/**
+ * Type helper to extract the interface from the WithGoldManager mixin
+ * This provides the type without duplicating method signatures
+ */
+export type IGoldManager = InstanceType<ReturnType<typeof WithGoldManager>>;

package/src/Player/GuiManager.ts

@@ -1,17 +1,34 @@
 import { RpgPlayer } from "./Player";
 import { Gui, DialogGui, MenuGui, ShopGui, NotificationGui } from "../Gui";
 import { DialogOptions, Choice } from "../Gui/DialogGui";
-import { Constructor, RpgCommonPlayer } from "@rpgjs/common";
+import { PlayerCtor } from "@rpgjs/common";
 
-export interface IGuiManager {
-    emit: any;
-    removeGui: (guiId: string, data?: any) => void;
-  }
-
-export function WithGuiManager<TBase extends Constructor<RpgCommonPlayer>>(
-  Base: TBase
-) {
-  return class extends Base implements IGuiManager {
+/**
+ * GUI Manager Mixin
+ * 
+ * Provides graphical user interface management capabilities to any class. This mixin handles
+ * dialog boxes, menus, notifications, shops, and custom GUI components. It manages the
+ * complete GUI system including opening, closing, and data passing between client and server.
+ * 
+ * @param Base - The base class to extend with GUI management
+ * @returns Extended class with GUI management methods
+ * 
+ * @example
+ * ```ts
+ * class MyPlayer extends WithGuiManager(BasePlayer) {
+ *   constructor() {
+ *     super();
+ *     // GUI system is automatically initialized
+ *   }
+ * }
+ * 
+ * const player = new MyPlayer();
+ * await player.showText('Hello World!');
+ * player.callMainMenu();
+ * ```
+ */
+export function WithGuiManager<TBase extends PlayerCtor>(Base: TBase) {
+  return class extends Base {
     _gui: { [id: string]: Gui } = {};
 
     /**
@@ -253,11 +270,11 @@ export function WithGuiManager<TBase extends Constructor<RpgCommonPlayer>>(
       }
     }
 
-    private _attachedGui(players: RpgPlayer[] | RpgPlayer, display: boolean) {
+    _attachedGui(players: RpgPlayer[] | RpgPlayer, display: boolean) {
       if (!Array.isArray(players)) {
         players = [players] as RpgPlayer[];
       }
-      this.emit("gui.tooltip", {
+      (this as any).emit("gui.tooltip", {
         players: (players as RpgPlayer[]).map((player) => player.id),
         display,
       });
@@ -313,5 +330,11 @@ export function WithGuiManager<TBase extends Constructor<RpgCommonPlayer>>(
       const _players = players || this;
       this._attachedGui(_players as RpgPlayer[], false);
     }
-  };
+  } as unknown as TBase;
 }
+
+/**
+ * Type helper to extract the interface from the WithGuiManager mixin
+ * This provides the type without duplicating method signatures
+ */
+export type IGuiManager = InstanceType<ReturnType<typeof WithGuiManager>>;

package/src/Player/ItemFixture.ts

@@ -1,11 +1,10 @@
 import { ItemInstance } from "@rpgjs/database";
-import { RpgCommonPlayer, type Constructor } from "@rpgjs/common";
-export class ItemFixture {}
+import { PlayerCtor } from "@rpgjs/common";
 
-export function WithItemFixture<TBase extends Constructor<RpgCommonPlayer>>(
+export function WithItemFixture<TBase extends PlayerCtor>(
   Base: TBase
 ) {
-  return class extends Base implements IItemFixture {
+  return class extends Base {
     protected getFeature(name, prop): any {
       const array = {};
       for (let item of this.equipments()) {
@@ -21,7 +20,7 @@ export function WithItemFixture<TBase extends Constructor<RpgCommonPlayer>>(
       }
       return Object.values(array);
     }
-  };
+  } as unknown as TBase;
 }
 
 export interface ItemFixture {

package/src/Player/ItemManager.ts

@@ -1,4 +1,4 @@
-import { isInstanceOf, isString, Item, type Constructor } from "@rpgjs/common";
+import { isInstanceOf, isString, Item, PlayerCtor, type Constructor } from "@rpgjs/common";
 import { RpgCommonPlayer, Matter } from "@rpgjs/common";
 import { ATK, PDEF, SDEF } from "../presets";
 import { ItemLog } from "../logs";
@@ -13,27 +13,34 @@ enum ClassHooks {
   canEquip = 'canEquip'
 }
 
-/**
- * Interface defining what MoveManager adds to a class
- */
-export interface IItemManager {
-  databaseById(id: string): ItemClass;
-}
-
 type Inventory = { nb: number; item: ItemInstance };
 
 /**
- * Move Manager mixin
+ * Item Manager Mixin
  *
- * Adds methods to manage player movement
+ * Provides comprehensive item management capabilities to any class. This mixin handles
+ * inventory management, item usage, equipment, buying/selling, and item effects.
+ * It manages the complete item system including restrictions, transactions, and equipment.
  *
- * @param Base - The base class to extend
- * @returns A new class with move management capabilities
+ * @param Base - The base class to extend with item management
+ * @returns Extended class with item management methods
+ * 
+ * @example
+ * ```ts
+ * class MyPlayer extends WithItemManager(BasePlayer) {
+ *   constructor() {
+ *     super();
+ *     // Item system is automatically initialized
+ *   }
+ * }
+ * 
+ * const player = new MyPlayer();
+ * player.addItem('potion', 5);
+ * player.useItem('potion');
+ * ```
  */
-export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
-  Base: TBase
-): Constructor<IItemManager> & TBase {
-  return class extends Base implements IItemManager {
+export function WithItemManager<TBase extends PlayerCtor>(Base: TBase) {
+  return class extends Base {
 
     /**
      * Retrieves the information of an object: the number and the instance
@@ -54,7 +61,7 @@ export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
      */
     getItem(itemClass: ItemClass | string): Item {
       const index: number = this._getItemIndex(itemClass);
-      return this.items()[index];
+      return (this as any).items()[index];
     }
 
     /**
@@ -77,7 +84,7 @@ export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
     }
 
     _getItemIndex(itemClass: ItemClass | string): number {
-      return this.items().findIndex((it: Item): boolean => {
+      return (this as any).items().findIndex((it: Item): boolean => {
         if (isString(itemClass)) {
           return it.id() == itemClass;
         }
@@ -103,8 +110,8 @@ export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
      *  ```
      */
     addItem(itemId: string, nb: number = 1): Item {
-      const data = this.databaseById(itemId);
-      const item = this.items().find((it) => it.id() == itemId);
+      const data = (this as any).databaseById(itemId);
+      const item = (this as any).items().find((it) => it.id() == itemId);
       let instance: Item;
       if (item) {
         instance = item;
@@ -112,9 +119,9 @@ export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
       } else {
         instance = new Item(data);
         instance.id.set(itemId);
-        this.items().push(instance);
+        (this as any).items().push(instance);
       }
-      this["execMethod"]("onAdd", [this], instance);
+      (this as any)["execMethod"]("onAdd", [this], instance);
       return instance;
     }
 
@@ -210,7 +217,7 @@ export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
      * ```
      */
     buyItem(itemId: string, nb = 1): Item {
-      const data = this.databaseById(itemId);
+      const data = (this as any).databaseById(itemId);
       if (!data.price) {
         throw ItemLog.haveNotPrice(itemId);
       }
@@ -272,7 +279,7 @@ export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
      * ```
      */
     sellItem(itemId: string, nbToSell = 1): Item {
-      const data = this.databaseById(itemId);
+      const data = (this as any).databaseById(itemId);
       const inventory = this.getItem(itemId);
       if (!inventory) {
         throw ItemLog.notInInventory(itemId);
@@ -478,7 +485,7 @@ export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
       if (!inventory) {
         throw ItemLog.notInInventory(itemId);
       }
-      const data = this.databaseById(itemId);
+      const data = (this as any).databaseById(itemId);
       if (data._type == "item") {
         throw ItemLog.invalidToEquiped(itemId);
       }
@@ -508,5 +515,11 @@ export function WithItemManager<TBase extends Constructor<RpgCommonPlayer>>(
       }
       this["execMethod"]("onEquip", [this, equip], item);
     }
-  };
+  } as unknown as TBase;
 }
+
+/**
+ * Type helper to extract the interface from the WithItemManager mixin
+ * This provides the type without duplicating method signatures
+ */
+export type IItemManager = InstanceType<ReturnType<typeof WithItemManager>>;

package/src/Player/MoveManager.ts

@@ -1,4 +1,4 @@
-import { type Constructor } from "@rpgjs/common";
+import { PlayerCtor, type Constructor } from "@rpgjs/common";
 import { RpgCommonPlayer, Matter, Direction } from "@rpgjs/common";
 import { 
   MovementManager, 
@@ -34,26 +34,7 @@ interface PlayerWithMixins extends RpgCommonPlayer {
   changeDirection: (direction: Direction) => boolean;
 }
 
-export interface IMoveManager {
-  addMovement(strategy: MovementStrategy): void;
-  removeMovement(strategy: MovementStrategy): boolean;
-  clearMovements(): void;
-  hasActiveMovements(): boolean;
-  getActiveMovements(): MovementStrategy[];
-  
-  moveTo(target: RpgCommonPlayer | { x: number, y: number }): void;
-  stopMoveTo(): void;
-  dash(direction: { x: number, y: number }, speed?: number, duration?: number): void;
-  knockback(direction: { x: number, y: number }, force?: number, duration?: number): void;
-  followPath(waypoints: Array<{ x: number, y: number }>, speed?: number, loop?: boolean): void;
-  oscillate(direction: { x: number, y: number }, amplitude?: number, period?: number): void;
-  applyIceMovement(direction: { x: number, y: number }, maxSpeed?: number): void;
-  shootProjectile(type: ProjectileType, direction: { x: number, y: number }, speed?: number): void;
-  moveRoutes(routes: Routes): Promise<boolean>;
-  infiniteMoveRoute(routes: Routes): void;
-  breakRoutes(force?: boolean): void;
-  replayRoutes(): void;
-}
+
 
 
 function wait(sec: number) {
@@ -475,15 +456,37 @@ export const Move = new MoveList();
  * }
  * ```
  */
-export function WithMoveManager<TBase extends Constructor<RpgCommonPlayer>>(
-  Base: TBase
-): Constructor<IMoveManager> & TBase {
-  return class extends Base implements IMoveManager {
+/**
+ * Move Manager Mixin
+ * 
+ * Provides comprehensive movement management capabilities to any class. This mixin handles
+ * various types of movement including pathfinding, physics-based movement, route following,
+ * and advanced movement strategies like dashing, knockback, and projectile movement.
+ * 
+ * @param Base - The base class to extend with movement management
+ * @returns Extended class with movement management methods
+ * 
+ * @example
+ * ```ts
+ * class MyPlayer extends WithMoveManager(BasePlayer) {
+ *   constructor() {
+ *     super();
+ *     this.frequency = Frequency.High;
+ *   }
+ * }
+ * 
+ * const player = new MyPlayer();
+ * player.moveTo({ x: 100, y: 100 });
+ * player.dash({ x: 1, y: 0 }, 8, 200);
+ * ```
+ */
+export function WithMoveManager<TBase extends PlayerCtor>(Base: TBase) {
+  return class extends Base {
     
-    // Private properties for infinite route management
-    private _infiniteRoutes: Routes | null = null;
-    private _finishRoute: ((value: boolean) => void) | null = null;
-    private _isInfiniteRouteActive: boolean = false;
+    // Properties for infinite route management
+    _infiniteRoutes: Routes | null = null;
+    _finishRoute: ((value: boolean) => void) | null = null;
+    _isInfiniteRouteActive: boolean = false;
 
     /** 
     * The player passes through the other players (or vice versa). But the player does not go through the events.
@@ -1097,7 +1100,7 @@ export function WithMoveManager<TBase extends Constructor<RpgCommonPlayer>>(
      * @param routes - Routes array that may contain nested arrays
      * @returns Flattened array of routes
      */
-    private flattenRoutes(routes: any[]): any[] {
+    flattenRoutes(routes: any[]): any[] {
       const result: any[] = [];
       
       for (const route of routes) {
@@ -1241,5 +1244,11 @@ export function WithMoveManager<TBase extends Constructor<RpgCommonPlayer>>(
         this.infiniteMoveRoute(this._infiniteRoutes);
       }
     }
-  };
+  } as unknown as TBase;
 }
+
+/**
+ * Type helper to extract the interface from the WithMoveManager mixin
+ * This provides the type without duplicating method signatures
+ */
+export type IMoveManager = InstanceType<ReturnType<typeof WithMoveManager>>;