@rpgjs/client 5.0.0-alpha.21 → 5.0.0-alpha.23

package/dist/index2.js

@@ -1,20 +1,20 @@
-import component from './index21.js';
-import { inject } from './index19.js';
-import { signal, bootstrapCanvas, Howl } from 'canvasengine';
-import { WebSocketToken } from './index22.js';
+import component from './index26.js';
+import { inject } from './index6.js';
+import { signal, trigger, bootstrapCanvas, Howl } from 'canvasengine';
+import { WebSocketToken } from './index27.js';
 import { LoadMapToken } from './index7.js';
-import { RpgSound } from './index17.js';
-import { RpgResource } from './index18.js';
+import { RpgSound } from './index18.js';
+import { RpgResource } from './index19.js';
 import { Direction, PredictionController, ModulesToken } from '@rpgjs/common';
-import { load } from './index23.js';
-import { RpgClientMap } from './index24.js';
+import { load } from './index28.js';
+import { RpgClientMap } from './index29.js';
 import { RpgGui } from './index9.js';
-import { AnimationManager } from './index25.js';
+import { AnimationManager } from './index30.js';
+import { TransitionManager } from './index31.js';
 import { lastValueFrom } from 'rxjs';
 import { GlobalConfigToken } from './index8.js';
 import * as PIXI from 'pixi.js';
 import { PrebuiltComponentAnimations } from './index12.js';
-import { KeyboardControls } from './index20.js';
 
 class RpgClientEngine {
   constructor(context) {
@@ -25,12 +25,17 @@ class RpgClientEngine {
     this.spritesheets = /* @__PURE__ */ new Map();
     this.sounds = /* @__PURE__ */ new Map();
     this.componentAnimations = [];
+    this.transitions = [];
     this.particleSettings = {
       emitters: []
     };
     this.playerIdSignal = signal(null);
     this.spriteComponentsBehind = signal([]);
     this.spriteComponentsInFront = signal([]);
+    /** ID of the sprite that the camera should follow. null means follow the current player */
+    this.cameraFollowTargetId = signal(null);
+    /** Trigger for map shake animation */
+    this.mapShakeTrigger = trigger();
     this.predictionEnabled = false;
     this.SERVER_CORRECTION_THRESHOLD = 30;
     this.inputFrameCounter = 0;
@@ -42,11 +47,11 @@ class RpgClientEngine {
     this.PING_INTERVAL_MS = 5e3;
     // Send ping every 5 seconds
     this.lastInputTime = 0;
-    this.webSocket = inject(context, WebSocketToken);
-    this.guiService = inject(context, RpgGui);
-    this.loadMapService = inject(context, LoadMapToken);
-    this.hooks = inject(context, ModulesToken);
-    this.globalConfig = inject(context, GlobalConfigToken);
+    this.webSocket = inject(WebSocketToken);
+    this.guiService = inject(RpgGui);
+    this.loadMapService = inject(LoadMapToken);
+    this.hooks = inject(ModulesToken);
+    this.globalConfig = inject(GlobalConfigToken);
     if (!this.globalConfig) {
       this.globalConfig = {};
     }
@@ -100,8 +105,8 @@ class RpgClientEngine {
    * ```
    */
   setKeyboardControls(controlInstance) {
-    const currentValues = this.context.values["inject:" + KeyboardControls];
-    this.context.values["inject:" + KeyboardControls] = {
+    const currentValues = this.context.values["inject:KeyboardControls"];
+    this.context.values["inject:KeyboardControls"] = {
       ...currentValues,
       values: /* @__PURE__ */ new Map([["__default__", controlInstance]])
     };
@@ -128,6 +133,7 @@ class RpgClientEngine {
     this.hooks.callHooks("client-gui-load", this).subscribe();
     this.hooks.callHooks("client-particles-load", this).subscribe();
     this.hooks.callHooks("client-componentAnimations-load", this).subscribe();
+    this.hooks.callHooks("client-transitions-load", this).subscribe();
     this.hooks.callHooks("client-sprite-load", this).subscribe();
     await lastValueFrom(this.hooks.callHooks("client-engine-onStart", this));
     window.addEventListener("resize", () => {
@@ -164,6 +170,7 @@ class RpgClientEngine {
     });
     this.webSocket.on("changeMap", (data) => {
       this.sceneMap.reset();
+      this.cameraFollowTargetId.set(null);
       this.loadScene(data.mapId);
     });
     this.webSocket.on("showComponentAnimation", (data) => {
@@ -187,6 +194,29 @@ class RpgClientEngine {
       const { soundId } = data;
       this.stopSound(soundId);
     });
+    this.webSocket.on("stopAllSounds", () => {
+      this.stopAllSounds();
+    });
+    this.webSocket.on("cameraFollow", (data) => {
+      const { targetId, smoothMove } = data;
+      this.setCameraFollow(targetId, smoothMove);
+    });
+    this.webSocket.on("flash", (data) => {
+      const { object, type, duration, cycles, alpha, tint } = data;
+      const sprite = object ? this.sceneMap.getObjectById(object) : void 0;
+      if (sprite && typeof sprite.flash === "function") {
+        sprite.flash({ type, duration, cycles, alpha, tint });
+      }
+    });
+    this.webSocket.on("shakeMap", (data) => {
+      const { intensity, duration, frequency, direction } = data || {};
+      this.mapShakeTrigger.start({
+        intensity,
+        duration,
+        frequency,
+        direction
+      });
+    });
     this.webSocket.on("open", () => {
       this.hooks.callHooks("client-engine-onConnected", this, this.socket).subscribe();
     });
@@ -552,6 +582,64 @@ class RpgClientEngine {
       console.warn(`Sound with id "${soundId}" not found or cannot be stopped`);
     }
   }
+  /**
+   * Stop all currently playing sounds
+   * 
+   * This method stops all sounds that are currently playing.
+   * Useful when changing maps to prevent sound overlap.
+   * 
+   * @example
+   * ```ts
+   * // Stop all sounds
+   * engine.stopAllSounds();
+   * ```
+   */
+  stopAllSounds() {
+    this.sounds.forEach((sound) => {
+      if (sound && sound.stop) {
+        sound.stop();
+      }
+    });
+  }
+  /**
+   * Set the camera to follow a specific sprite
+   * 
+   * This method changes which sprite the camera viewport should follow.
+   * The camera will smoothly animate to the target sprite if smoothMove options are provided.
+   * 
+   * ## Design
+   * 
+   * The camera follow target is stored in a signal that is read by sprite components.
+   * Each sprite checks if it should be followed by comparing its ID with the target ID.
+   * When smoothMove options are provided, the viewport animation is handled by CanvasEngine's
+   * viewport system.
+   * 
+   * @param targetId - The ID of the sprite to follow. Set to null to follow the current player
+   * @param smoothMove - Animation options. Can be a boolean (default: true) or an object with time and ease
+   * @param smoothMove.time - Duration of the animation in milliseconds (optional)
+   * @param smoothMove.ease - Easing function name from https://easings.net (optional)
+   * 
+   * @example
+   * ```ts
+   * // Follow another player with default smooth animation
+   * engine.setCameraFollow(otherPlayerId, true);
+   * 
+   * // Follow an event with custom smooth animation
+   * engine.setCameraFollow(eventId, {
+   *   time: 1000,
+   *   ease: "easeInOutQuad"
+   * });
+   * 
+   * // Follow without animation (instant)
+   * engine.setCameraFollow(targetId, false);
+   * 
+   * // Return to following current player
+   * engine.setCameraFollow(null);
+   * ```
+   */
+  setCameraFollow(targetId, smoothMove) {
+    this.cameraFollowTargetId.set(targetId);
+  }
   addParticle(particle) {
     this.particleSettings.emitters.push(particle);
     return particle;
@@ -560,13 +648,38 @@ class RpgClientEngine {
    * Add a component to render behind sprites
    * Components added with this method will be displayed with a lower z-index than the sprite
    * 
-   * @param component - The component to add behind sprites
-   * @returns The added component
+   * Supports multiple formats:
+   * 1. Direct component: `ShadowComponent`
+   * 2. Configuration object: `{ component: LightHalo, props: {...} }`
+   * 3. With dynamic props: `{ component: LightHalo, props: (object) => {...} }`
+   * 4. With dependencies: `{ component: HealthBar, dependencies: (object) => [object.hp, object.param.maxHp] }`
+   * 
+   * Components with dependencies will only be displayed when all dependencies are resolved (!= undefined).
+   * The object (sprite) is passed to the dependencies function to allow sprite-specific dependency resolution.
+   * 
+   * @param component - The component to add behind sprites, or a configuration object
+   * @param component.component - The component function to render
+   * @param component.props - Static props object or function that receives the sprite object and returns props
+   * @param component.dependencies - Function that receives the sprite object and returns an array of Signals
+   * @returns The added component or configuration
    * 
    * @example
    * ```ts
    * // Add a shadow component behind all sprites
    * engine.addSpriteComponentBehind(ShadowComponent);
+   * 
+   * // Add a component with static props
+   * engine.addSpriteComponentBehind({ 
+   *   component: LightHalo, 
+   *   props: { radius: 30 } 
+   * });
+   * 
+   * // Add a component with dynamic props and dependencies
+   * engine.addSpriteComponentBehind({ 
+   *   component: HealthBar, 
+   *   props: (object) => ({ hp: object.hp(), maxHp: object.param.maxHp() }),
+   *   dependencies: (object) => [object.hp, object.param.maxHp]
+   * });
    * ```
    */
   addSpriteComponentBehind(component) {
@@ -577,13 +690,38 @@ class RpgClientEngine {
    * Add a component to render in front of sprites
    * Components added with this method will be displayed with a higher z-index than the sprite
    * 
-   * @param component - The component to add in front of sprites
-   * @returns The added component
+   * Supports multiple formats:
+   * 1. Direct component: `HealthBarComponent`
+   * 2. Configuration object: `{ component: StatusIndicator, props: {...} }`
+   * 3. With dynamic props: `{ component: HealthBar, props: (object) => {...} }`
+   * 4. With dependencies: `{ component: HealthBar, dependencies: (object) => [object.hp, object.param.maxHp] }`
+   * 
+   * Components with dependencies will only be displayed when all dependencies are resolved (!= undefined).
+   * The object (sprite) is passed to the dependencies function to allow sprite-specific dependency resolution.
+   * 
+   * @param component - The component to add in front of sprites, or a configuration object
+   * @param component.component - The component function to render
+   * @param component.props - Static props object or function that receives the sprite object and returns props
+   * @param component.dependencies - Function that receives the sprite object and returns an array of Signals
+   * @returns The added component or configuration
    * 
    * @example
    * ```ts
    * // Add a health bar component in front of all sprites
    * engine.addSpriteComponentInFront(HealthBarComponent);
+   * 
+   * // Add a component with static props
+   * engine.addSpriteComponentInFront({ 
+   *   component: StatusIndicator, 
+   *   props: { type: 'poison' } 
+   * });
+   * 
+   * // Add a component with dynamic props and dependencies
+   * engine.addSpriteComponentInFront({ 
+   *   component: HealthBar, 
+   *   props: (object) => ({ hp: object.hp(), maxHp: object.param.maxHp() }),
+   *   dependencies: (object) => [object.hp, object.param.maxHp]
+   * });
    * ```
    */
   addSpriteComponentInFront(component) {
@@ -650,6 +788,179 @@ class RpgClientEngine {
     }
     return componentAnimation.instance;
   }
+  /**
+   * Add a transition to the engine
+   * 
+   * Transitions are screen effects that can be displayed during scene changes,
+   * map loading, or any other moment where a visual transition is needed.
+   * They are displayed on top of the entire canvas and can have custom props
+   * that can be functions (similar to ComponentAnimation).
+   * 
+   * @param transition - The transition configuration
+   * @param transition.id - Unique identifier for the transition
+   * @param transition.component - The component function to render
+   * @param transition.props - Optional props to pass to the component (can be a function)
+   * @returns The added transition configuration
+   * 
+   * @example
+   * ```ts
+   * // Add a fade transition
+   * engine.addTransition({
+   *   id: 'fade',
+   *   component: FadeComponent
+   * });
+   * 
+   * // Add a transition with props
+   * engine.addTransition({
+   *   id: 'slide',
+   *   component: SlideComponent,
+   *   props: { direction: 'left', duration: 500 }
+   * });
+   * 
+   * // Add a transition with function props
+   * engine.addTransition({
+   *   id: 'custom',
+   *   component: CustomTransition,
+   *   props: (engine) => ({ width: engine.width(), height: engine.height() })
+   * });
+   * ```
+   */
+  addTransition(transition) {
+    const instance = new TransitionManager();
+    this.transitions.push({
+      id: transition.id,
+      component: transition.component,
+      props: transition.props,
+      instance,
+      current: instance.current
+    });
+    return transition;
+  }
+  /**
+   * Remove a transition from the engine
+   * 
+   * Removes a transition by its ID. This will not affect any currently
+   * running transitions, only prevent new ones from being started.
+   * 
+   * @param id - The unique identifier of the transition to remove
+   * @returns true if the transition was found and removed, false otherwise
+   * 
+   * @example
+   * ```ts
+   * // Remove a transition
+   * engine.removeTransition('fade');
+   * ```
+   */
+  removeTransition(id) {
+    const index = this.transitions.findIndex((transition) => transition.id === id);
+    if (index !== -1) {
+      this.transitions.splice(index, 1);
+      return true;
+    }
+    return false;
+  }
+  /**
+   * Modify an existing transition
+   * 
+   * Updates the component or props of an existing transition. This will
+   * not affect any currently running transitions, only future ones.
+   * 
+   * @param id - The unique identifier of the transition to modify
+   * @param updates - The updates to apply (component and/or props)
+   * @returns true if the transition was found and modified, false otherwise
+   * 
+   * @example
+   * ```ts
+   * // Update transition props
+   * engine.modifyTransition('fade', {
+   *   props: { duration: 2000, color: 'white' }
+   * });
+   * 
+   * // Update transition component
+   * engine.modifyTransition('fade', {
+   *   component: NewFadeComponent
+   * });
+   * ```
+   */
+  modifyTransition(id, updates) {
+    const transition = this.transitions.find((transition2) => transition2.id === id);
+    if (!transition) {
+      return false;
+    }
+    if (updates.component !== void 0) {
+      transition.component = updates.component;
+    }
+    if (updates.props !== void 0) {
+      transition.props = updates.props;
+    }
+    return true;
+  }
+  /**
+   * Get a transition by its ID
+   * 
+   * Retrieves the TransitionManager instance for a specific transition,
+   * which can be used to start the transition.
+   * 
+   * @param id - The unique identifier of the transition
+   * @returns The TransitionManager instance for the transition
+   * @throws Error if the transition is not found
+   * 
+   * @example
+   * ```ts
+   * // Get a transition and start it
+   * const fadeTransition = engine.getTransition('fade');
+   * fadeTransition.start({ duration: 1000 });
+   * ```
+   */
+  getTransition(id) {
+    const transition = this.transitions.find((transition2) => transition2.id === id);
+    if (!transition) {
+      throw new Error(`Transition with id ${id} not found`);
+    }
+    return transition.instance;
+  }
+  /**
+   * Start a transition
+   * 
+   * Convenience method to start a transition by its ID. This combines
+   * getTransition and start into a single call. The transition will
+   * automatically receive an onFinish callback to remove itself when done.
+   * 
+   * @param id - The unique identifier of the transition to start
+   * @param props - Additional props to pass to the transition component
+   * @returns The created transition object
+   * 
+   * @example
+   * ```ts
+   * // Start a fade transition
+   * engine.startTransition('fade', { duration: 1000, color: 'black' });
+   * 
+   * // Start with onFinish callback
+   * engine.startTransition('fade', {
+   *   duration: 1000,
+   *   onFinish: () => console.log('Fade complete')
+   * });
+   * ```
+   */
+  startTransition(id, props = {}) {
+    const transition = this.transitions.find((t) => t.id === id);
+    if (!transition) {
+      throw new Error(`Transition with id ${id} not found`);
+    }
+    let baseProps = {};
+    if (transition.props) {
+      if (typeof transition.props === "function") {
+        baseProps = transition.props(this);
+      } else {
+        baseProps = transition.props;
+      }
+    }
+    const finalProps = {
+      ...baseProps,
+      ...props
+    };
+    return transition.instance.start(finalProps);
+  }
   async processInput({ input }) {
     const timestamp = Date.now();
     let frame;
@@ -756,6 +1067,61 @@ class RpgClientEngine {
     this.frameOffset = 0;
     this.inputFrameCounter = 0;
   }
+  /**
+   * Trigger a flash animation on a sprite
+   * 
+   * This method allows you to trigger a flash effect on any sprite from client-side code.
+   * The flash can be configured with various options including type (alpha, tint, or both),
+   * duration, cycles, and color.
+   * 
+   * ## Design
+   * 
+   * The flash is applied directly to the sprite object using its flash trigger.
+   * This is useful for client-side visual feedback, UI interactions, or local effects
+   * that don't need to be synchronized with the server.
+   * 
+   * @param spriteId - The ID of the sprite to flash. If not provided, flashes the current player
+   * @param options - Flash configuration options
+   * @param options.type - Type of flash effect: 'alpha' (opacity), 'tint' (color), or 'both' (default: 'alpha')
+   * @param options.duration - Duration of the flash animation in milliseconds (default: 300)
+   * @param options.cycles - Number of flash cycles (flash on/off) (default: 1)
+   * @param options.alpha - Alpha value when flashing, from 0 to 1 (default: 0.3)
+   * @param options.tint - Tint color when flashing as hex value or color name (default: 0xffffff - white)
+   * 
+   * @example
+   * ```ts
+   * // Flash the current player with default settings
+   * engine.flash();
+   * 
+   * // Flash a specific sprite with red tint
+   * engine.flash('sprite-id', { type: 'tint', tint: 0xff0000 });
+   * 
+   * // Flash with both alpha and tint for dramatic effect
+   * engine.flash(undefined, { 
+   *   type: 'both', 
+   *   alpha: 0.5, 
+   *   tint: 0xff0000,
+   *   duration: 200,
+   *   cycles: 2
+   * });
+   * 
+   * // Quick damage flash on current player
+   * engine.flash(undefined, { 
+   *   type: 'tint', 
+   *   tint: 'red', 
+   *   duration: 150,
+   *   cycles: 1
+   * });
+   * ```
+   */
+  flash(spriteId, options) {
+    const targetId = spriteId || this.playerId;
+    if (!targetId) return;
+    const sprite = this.sceneMap.getObjectById(targetId);
+    if (sprite && typeof sprite.flash === "function") {
+      sprite.flash(options);
+    }
+  }
   applyServerAck(ack) {
     if (this.predictionEnabled && this.prediction) {
       this.prediction.applyServerAck({