@rpgjs/server 5.0.0-alpha.28 → 5.0.0-alpha.29

package/dist/Player/Player.d.ts

@@ -129,35 +129,50 @@ export declare class RpgPlayer extends RpgPlayer_base {
     save(): Promise<string>;
     load(snapshot: string): Promise<void>;
     /**
-     * Set the current animation of the player's sprite
+     * @deprecated Use setGraphicAnimation instead.
+     * @param animationName - The name of the animation to play (e.g., 'attack', 'skill', 'walk')
+     * @param nbTimes - Number of times to repeat the animation (default: Infinity for continuous)
+     */
+    setAnimation(animationName: string, nbTimes?: number): void;
+    /**
+     * @deprecated Use setGraphicAnimation instead.
+     * @param graphic - The graphic to use for the animation (e.g., 'attack', 'skill', 'walk')
+     * @param animationName - The name of the animation to play (e.g., 'attack', 'skill', 'walk')
+     * @param replaceGraphic - Whether to replace the player's graphic (default: false)
+     */
+    showAnimation(graphic: string, animationName: string, replaceGraphic?: boolean): void;
+    /**
+    * Set the current animation of the player's sprite
+    *
+    * This method changes the animation state of the player's current sprite.
+    * It's used to trigger character animations like attack, skill, or custom movements.
+    * When `nbTimes` is set to a finite number, the animation will play that many times
+    * before returning to the previous animation state.
+    *
+    * If `animationFixed` is true, this method will not change the animation.
+    *
+    * @param animationName - The name of the animation to play (e.g., 'attack', 'skill', 'walk')
+    * @param nbTimes - Number of times to repeat the animation (default: Infinity for continuous)
+    */
+    setGraphicAnimation(animationName: string, nbTimes: number): void;
+    /**
+     * Set the current animation of the player's sprite with a temporary graphic change
+     *
+     * This method changes the animation state of the player's current sprite and temporarily
+     * changes the player's graphic (sprite sheet) during the animation. The graphic is
+     * automatically reset when the animation finishes.
      *
-     * This method changes the animation state of the player's current sprite.
-     * It's used to trigger character animations like attack, skill, or custom movements.
      * When `nbTimes` is set to a finite number, the animation will play that many times
-     * before returning to the previous animation state.
+     * before returning to the previous animation state and graphic.
      *
      * If `animationFixed` is true, this method will not change the animation.
      *
      * @param animationName - The name of the animation to play (e.g., 'attack', 'skill', 'walk')
+     * @param graphic - The graphic(s) to temporarily use during the animation
      * @param nbTimes - Number of times to repeat the animation (default: Infinity for continuous)
-     *
-     * @example
-     * ```ts
-     * // Set continuous walk animation
-     * player.setAnimation('walk');
-     *
-     * // Play attack animation 3 times then return to previous state
-     * player.setAnimation('attack', 3);
-     *
-     * // Lock animation to prevent automatic changes
-     * player.animationFixed = true;
-     * player.setAnimation('skill'); // This will be ignored
-     *
-     * // Set idle/stand animation
-     * player.setAnimation('stand');
-     * ```
      */
-    setAnimation(animationName: string, nbTimes?: number): void;
+    setGraphicAnimation(animationName: string, graphic: string | string[], nbTimes: number): void;
+    setGraphicAnimation(animationName: string, graphic: string | string[]): void;
     /**
      * Run the change detection cycle. Normally, as soon as a hook is called in a class, the cycle is started. But you can start it manually
      * The method calls the `onChanges` method on events and synchronizes all map data with the client.

package/dist/index.js

@@ -21712,48 +21712,56 @@ const _RpgPlayer = class _RpgPlayer extends BasicPlayerMixins(RpgCommonPlayer) {
     return dataLoaded;
   }
   /**
-   * Set the current animation of the player's sprite
-   * 
-   * This method changes the animation state of the player's current sprite.
-   * It's used to trigger character animations like attack, skill, or custom movements.
-   * When `nbTimes` is set to a finite number, the animation will play that many times
-   * before returning to the previous animation state.
-   * 
-   * If `animationFixed` is true, this method will not change the animation.
-   * 
+   * @deprecated Use setGraphicAnimation instead.
    * @param animationName - The name of the animation to play (e.g., 'attack', 'skill', 'walk')
    * @param nbTimes - Number of times to repeat the animation (default: Infinity for continuous)
-   * 
-   * @example
-   * ```ts
-   * // Set continuous walk animation
-   * player.setAnimation('walk');
-   * 
-   * // Play attack animation 3 times then return to previous state
-   * player.setAnimation('attack', 3);
-   * 
-   * // Lock animation to prevent automatic changes
-   * player.animationFixed = true;
-   * player.setAnimation('skill'); // This will be ignored
-   * 
-   * // Set idle/stand animation
-   * player.setAnimation('stand');
-   * ```
    */
   setAnimation(animationName, nbTimes = Infinity) {
+    console.warn("setAnimation is deprecated. Use setGraphicAnimation instead.");
+    this.setGraphicAnimation(animationName, nbTimes);
+  }
+  /**
+   * @deprecated Use setGraphicAnimation instead.
+   * @param graphic - The graphic to use for the animation (e.g., 'attack', 'skill', 'walk')
+   * @param animationName - The name of the animation to play (e.g., 'attack', 'skill', 'walk')
+   * @param replaceGraphic - Whether to replace the player's graphic (default: false)
+   */
+  showAnimation(graphic, animationName, replaceGraphic = false) {
+    if (replaceGraphic) {
+      console.warn("showAnimation is deprecated. Use player.setGraphicAnimation instead.");
+      this.setGraphicAnimation(animationName, graphic);
+    } else {
+      console.warn("showAnimation is deprecated. Use map.showAnimation instead.");
+      const map2 = this.getCurrentMap();
+      map2?.showAnimation({ x: this.x(), y: this.y() }, graphic, animationName);
+    }
+  }
+  setGraphicAnimation(animationName, graphicOrNbTimes, nbTimes = 1) {
     if (this.animationFixed) {
       return;
     }
+    let graphic;
+    let finalNbTimes = Infinity;
+    if (typeof graphicOrNbTimes === "number") {
+      finalNbTimes = graphicOrNbTimes;
+    } else if (graphicOrNbTimes !== void 0) {
+      graphic = graphicOrNbTimes;
+      finalNbTimes = nbTimes ?? Infinity;
+    } else {
+      finalNbTimes = Infinity;
+    }
     const map2 = this.getCurrentMap();
     if (!map2) return;
-    if (nbTimes === Infinity) {
+    if (finalNbTimes === Infinity) {
+      if (graphic) this.setGraphic(graphic);
       this.animationName.set(animationName);
     } else {
       map2.$broadcast({
         type: "setAnimation",
         value: {
           animationName,
-          nbTimes,
+          graphic,
+          nbTimes: finalNbTimes,
           object: this.id
         }
       });
@@ -23511,7 +23519,7 @@ class Doc {
 const version = {
     major: 4,
     minor: 2,
-    patch: 0,
+    patch: 1,
 };
 
 const $ZodType = /*@__PURE__*/ $constructor("$ZodType", (inst, def) => {