@rpgjs/client 5.0.0-alpha.10 → 5.0.0-alpha.12

package/src/Gui/Gui.ts

@@ -1,13 +1,36 @@
 import { Context, inject } from "@signe/di";
-import { signal } from "canvasengine";
+import { signal, Signal, WritableSignal } from "canvasengine";
 import { AbstractWebsocket, WebSocketToken } from "../services/AbstractSocket";
-import { PrebuiltGui } from "../components/gui";
+import { DialogboxComponent } from "../components/gui";
+import { combineLatest, Subscription } from "rxjs";
 
 interface GuiOptions {
-  name: string;
+  name?: string;
+  id?: string;
   component: any;
   display?: boolean;
   data?: any;
+  /**
+   * Auto display the GUI when added to the system
+   * @default false
+   */
+  autoDisplay?: boolean;
+  /**
+   * Function that returns an array of Signal dependencies
+   * The GUI will only display when all dependencies are resolved (!= undefined)
+   * @returns Array of Signal dependencies
+   */
+  dependencies?: () => Signal[];
+}
+
+interface GuiInstance {
+  name: string;
+  component: any;
+  display: WritableSignal<boolean>;
+  data: WritableSignal<any>;
+  autoDisplay: boolean;
+  dependencies?: () => Signal[];
+  subscription?: Subscription;
 }
 
 const throwError = (id: string) => {
@@ -16,13 +39,15 @@ const throwError = (id: string) => {
 
 export class RpgGui {
   private webSocket: AbstractWebsocket;
-  gui = signal<any>({});
+  gui = signal<Record<string, GuiInstance>>({});
+  extraGuis: GuiInstance[] = [];
+  private vueGuiInstance: any = null; // Reference to VueGui instance
 
   constructor(private context: Context) {
     this.webSocket = inject(context, WebSocketToken);
     this.add({
       name: "rpg-dialog",
-      component: PrebuiltGui.Dialogbox,
+      component: DialogboxComponent,
     });
   }
 
@@ -36,6 +61,63 @@ export class RpgGui {
     });
   }
 
+  /**
+   * Set the VueGui instance reference for Vue component management
+   * This is called by VueGui when it's initialized
+   * 
+   * @param vueGuiInstance - The VueGui instance
+   */
+  _setVueGuiInstance(vueGuiInstance: any) {
+    this.vueGuiInstance = vueGuiInstance;
+  }
+
+  /**
+   * Notify VueGui about GUI state changes
+   * This synchronizes the Vue component display state
+   * 
+   * @param guiId - The GUI component ID
+   * @param display - Display state
+   * @param data - Component data
+   */
+  private _notifyVueGui(guiId: string, display: boolean, data: any = {}) {
+    if (this.vueGuiInstance && this.vueGuiInstance.vm) {
+      // Find the GUI in extraGuis
+      const extraGui = this.extraGuis.find(gui => gui.name === guiId);
+      if (extraGui) {
+        // Update the Vue component's display state and data
+        this.vueGuiInstance.vm.gui[guiId] = {
+          name: guiId,
+          display,
+          data,
+          attachToSprite: false // Default value, could be configurable
+        };
+        // Trigger Vue reactivity
+        this.vueGuiInstance.vm.gui = Object.assign({}, this.vueGuiInstance.vm.gui);
+      }
+    }
+  }
+
+  /**
+   * Initialize Vue components in the VueGui instance
+   * This should be called after VueGui is mounted
+   */
+  _initializeVueComponents() {
+    if (this.vueGuiInstance && this.vueGuiInstance.vm) {
+      // Initialize all extraGuis in the Vue instance
+      this.extraGuis.forEach(gui => {
+        this.vueGuiInstance.vm.gui[gui.name] = {
+          name: gui.name,
+          display: gui.display(),
+          data: gui.data(),
+          attachToSprite: false
+        };
+      });
+      
+      // Trigger Vue reactivity
+      this.vueGuiInstance.vm.gui = Object.assign({}, this.vueGuiInstance.vm.gui);
+    }
+  }
+
   guiInteraction(guiId: string, name: string, data: any) {
     this.webSocket.emit("gui.interaction", {
       guiId,
@@ -51,42 +133,243 @@ export class RpgGui {
     });
   }
 
+  /**
+   * Add a GUI component to the system
+   * 
+   * By default, only CanvasEngine components (.ce files) are accepted.
+   * Vue components should be handled by the @rpgjs/vue package.
+   * 
+   * @param gui - GUI configuration options
+   * @param gui.name - Name or ID of the GUI component
+   * @param gui.id - Alternative ID if name is not provided
+   * @param gui.component - The component to render (must be a CanvasEngine component)
+   * @param gui.display - Initial display state (default: false)
+   * @param gui.data - Initial data for the component
+   * @param gui.autoDisplay - Auto display when added (default: false)
+   * @param gui.dependencies - Function returning Signal dependencies
+   * 
+   * @example
+   * ```ts
+   * gui.add({
+   *   name: 'inventory',
+   *   component: InventoryComponent, // Must be a .ce component
+   *   autoDisplay: true,
+   *   dependencies: () => [playerSignal, inventorySignal]
+   * });
+   * ```
+   */
   add(gui: GuiOptions) {
-    this.gui()[gui.name] = {
-      name: gui.name,
+    const guiId = gui.name || gui.id;
+    if (!guiId) {
+      throw new Error("GUI must have a name or id");
+    }
+
+    const guiInstance: GuiInstance = {
+      name: guiId,
       component: gui.component,
       display: signal(gui.display || false),
       data: signal(gui.data || {}),
+      autoDisplay: gui.autoDisplay || false,
+      dependencies: gui.dependencies,
     };
+
+    // Accept both CanvasEngine components (.ce) and Vue components
+    // Vue components will be handled by VueGui if available
+    if (typeof gui.component !== 'function') {
+      guiInstance.component = gui;
+      this.extraGuis.push(guiInstance);
+      
+      // Auto display Vue components if enabled
+      if (guiInstance.autoDisplay) {
+        this._notifyVueGui(guiId, true, gui.data || {});
+      }
+      return;
+    }
+
+    this.gui()[guiId] = guiInstance;
+
+    // Auto display if enabled and it's a CanvasEngine component
+    if (guiInstance.autoDisplay && typeof gui.component === 'function') {
+      this.display(guiId);
+    }
   }
 
-  get(id: string | GuiOptions) {
-    if (typeof id != "string") {
-      id = id.name;
+  get(id: string): GuiInstance | undefined {
+    // Check CanvasEngine GUIs first
+    const canvasGui = this.gui()[id];
+    if (canvasGui) {
+      return canvasGui;
     }
-    return this.gui()[id];
+    
+    // Check Vue GUIs in extraGuis
+    return this.extraGuis.find(gui => gui.name === id);
   }
 
   exists(id: string): boolean {
     return !!this.get(id);
   }
 
-  getAll() {
-    return this.gui();
+  getAll(): Record<string, GuiInstance> {
+    const allGuis = { ...this.gui() };
+    
+    // Add extraGuis to the result
+    this.extraGuis.forEach(gui => {
+      allGuis[gui.name] = gui;
+    });
+    
+    return allGuis;
   }
 
-  display(id: string, data = {}) {
+  /**
+   * Display a GUI component
+   * 
+   * Displays the GUI immediately if no dependencies are configured,
+   * or waits for all dependencies to be resolved if dependencies are present.
+   * Automatically manages subscriptions to prevent memory leaks.
+   * Works with both CanvasEngine components and Vue components.
+   * 
+   * @param id - The GUI component ID
+   * @param data - Data to pass to the component
+   * @param dependencies - Optional runtime dependencies (overrides config dependencies)
+   * 
+   * @example
+   * ```ts
+   * // Display immediately
+   * gui.display('inventory', { items: [] });
+   * 
+   * // Display with runtime dependencies
+   * gui.display('shop', { shopId: 1 }, [playerSignal, shopSignal]);
+   * ```
+   */
+  display(id: string, data = {}, dependencies: Signal[] = []) {
     if (!this.exists(id)) {
       throw throwError(id);
     }
-    this.get(id).data.set(data);
-    this.get(id).display.set(true);
+
+    const guiInstance = this.get(id)!;
+    
+    // Check if it's a Vue component (in extraGuis)
+    const isVueComponent = this.extraGuis.some(gui => gui.name === id);
+    
+    if (isVueComponent) {
+      // Handle Vue component display
+      this._handleVueComponentDisplay(id, data, dependencies, guiInstance);
+    } else {
+      // Handle CanvasEngine component display
+      this._handleCanvasComponentDisplay(id, data, dependencies, guiInstance);
+    }
+  }
+
+  /**
+   * Handle Vue component display logic
+   * 
+   * @param id - GUI component ID
+   * @param data - Component data
+   * @param dependencies - Runtime dependencies
+   * @param guiInstance - GUI instance
+   */
+  private _handleVueComponentDisplay(id: string, data: any, dependencies: Signal[], guiInstance: GuiInstance) {
+    // Unsubscribe from previous subscription if exists
+    if (guiInstance.subscription) {
+      guiInstance.subscription.unsubscribe();
+      guiInstance.subscription = undefined;
+    }
+
+    // Use runtime dependencies or config dependencies
+    const deps = dependencies.length > 0 
+      ? dependencies 
+      : (guiInstance.dependencies ? guiInstance.dependencies() : []);
+
+    if (deps.length > 0) {
+      // Subscribe to dependencies
+      guiInstance.subscription = combineLatest(
+        deps.map(dependency => dependency.observable)
+      ).subscribe((values) => {
+        if (values.every(value => value !== undefined)) {
+          guiInstance.data.set(data);
+          guiInstance.display.set(true);
+          this._notifyVueGui(id, true, data);
+        }
+      });
+      return;
+    }
+
+    // No dependencies, display immediately
+    guiInstance.data.set(data);
+    guiInstance.display.set(true);
+    this._notifyVueGui(id, true, data);
+  }
+
+  /**
+   * Handle CanvasEngine component display logic
+   * 
+   * @param id - GUI component ID
+   * @param data - Component data
+   * @param dependencies - Runtime dependencies
+   * @param guiInstance - GUI instance
+   */
+  private _handleCanvasComponentDisplay(id: string, data: any, dependencies: Signal[], guiInstance: GuiInstance) {
+    // Unsubscribe from previous subscription if exists
+    if (guiInstance.subscription) {
+      guiInstance.subscription.unsubscribe();
+      guiInstance.subscription = undefined;
+    }
+
+    // Use runtime dependencies or config dependencies
+    const deps = dependencies.length > 0 
+      ? dependencies 
+      : (guiInstance.dependencies ? guiInstance.dependencies() : []);
+
+    if (deps.length > 0) {
+      // Subscribe to dependencies
+      guiInstance.subscription = combineLatest(
+        deps.map(dependency => dependency.observable)
+      ).subscribe((values) => {
+        if (values.every(value => value !== undefined)) {
+          guiInstance.data.set(data);
+          guiInstance.display.set(true);
+        }
+      });
+      return;
+    }
+
+    // No dependencies, display immediately
+    guiInstance.data.set(data);
+    guiInstance.display.set(true);
   }
 
+  /**
+   * Hide a GUI component
+   * 
+   * Hides the GUI and cleans up any active subscriptions.
+   * Works with both CanvasEngine components and Vue components.
+   * 
+   * @param id - The GUI component ID
+   * 
+   * @example
+   * ```ts
+   * gui.hide('inventory');
+   * ```
+   */
   hide(id: string) {
     if (!this.exists(id)) {
       throw throwError(id);
     }
-    this.get(id).display.set(false);
+
+    const guiInstance = this.get(id)!;
+    
+    // Unsubscribe if there's an active subscription
+    if (guiInstance.subscription) {
+      guiInstance.subscription.unsubscribe();
+      guiInstance.subscription = undefined;
+    }
+
+    guiInstance.display.set(false);
+    
+    // Check if it's a Vue component and notify VueGui
+    const isVueComponent = this.extraGuis.some(gui => gui.name === id);
+    if (isVueComponent) {
+      this._notifyVueGui(id, false);
+    }
   }
 }

package/src/RpgClient.ts

@@ -1,9 +1,10 @@
-import { ComponentFunction } from 'canvasengine'
+import { ComponentFunction, Signal } from 'canvasengine'
 import { RpgClientEngine } from './RpgClientEngine'
 import { Loader, Container } from 'pixi.js'
+import { RpgClientObject } from './Game/Object'
 
 type RpgClass<T = any> = new (...args: any[]) => T
-type RpgComponent = Container
+type RpgComponent = RpgClientObject
 type SceneMap = Container
 
 export interface RpgClientEngineHooks {
@@ -305,15 +306,43 @@ export interface RpgClient {
     spritesheets?: any[],
 
     /** 
-     * Array containing the list of VueJS components
+     * Array containing the list of GUI components
      * 
+     * ```ts
+     * import { defineModule, RpgClient } from '@rpgjs/client'
+     * import InventoryComponent from './inventory.ce'
+     * 
+     * defineModule<RpgClient>({
+     *      gui: [
+     *          {
+     *              id: 'inventory',
+     *              component: InventoryComponent,
+     *              autoDisplay: true,
+     *              dependencies: () => [playerSignal, inventorySignal]
+     *          }
+     *      ]
+     * })
+     * ```
      * 
      * [Guide: Create GUI](/guide/create-gui.html)
      * 
-     * @prop {Array<Component of CanvasEngine>} [gui]
+     * @prop {Array<GuiOptions>} [gui]
      * @memberof RpgClient
      * */
-    gui?: ComponentFunction[],
+    gui?: ({
+        id: string,
+        component: ComponentFunction,
+        /**
+         * Auto display the GUI when added to the system
+         * @default false
+         */
+        autoDisplay?: boolean,
+        /**
+         * Function that returns an array of Signal dependencies
+         * The GUI will only display when all dependencies are resolved (!= undefined)
+         */
+        dependencies?: () => Signal[]
+    } | any)[],
 
     /** 
      * Array containing the list of sounds
@@ -382,6 +411,8 @@ export interface RpgClient {
         map: RpgSceneMapHooks
     }
 
+    sceneMap?: RpgSceneMapHooks
+
     /** 
      * Array containing the list of component animations
      * Each element defines a temporary component to display for animations like hits, effects, etc.

package/src/RpgClientEngine.ts

@@ -18,7 +18,7 @@ export class RpgClientEngine<T = any> {
   private webSocket: AbstractWebsocket;
   private loadMapService: LoadMapService;
   private hooks: Hooks;
-  private sceneMap: RpgClientMap = new RpgClientMap();
+  private sceneMap: RpgClientMap
   private selector: HTMLElement;
   public globalConfig: T;
   public sceneComponent: any;
@@ -46,6 +46,19 @@ export class RpgClientEngine<T = any> {
     this.hooks = inject<Hooks>(context, ModulesToken);
     this.globalConfig = inject(context, GlobalConfigToken)
 
+    if (!this.globalConfig) {
+      this.globalConfig = {}
+    }
+    if (!this.globalConfig.box) {
+      this.globalConfig.box = {
+        styles: {
+          backgroundColor: "#1a1a2e",
+          backgroundOpacity: 0.9
+        },
+        sounds: {}
+      }
+    }
+
     this.addComponentAnimation({
       id: "animation",
       component: PrebuiltComponentAnimations.Animation
@@ -53,12 +66,21 @@ export class RpgClientEngine<T = any> {
   }
 
   async start() {
+    this.sceneMap = new RpgClientMap()
     this.selector = document.body.querySelector("#rpg") as HTMLElement;
 
     const { app, canvasElement } = await bootstrapCanvas(this.selector, Canvas);
     this.renderer = app.renderer as PIXI.Renderer;
     this.tick = canvasElement?.propObservables?.context['tick'].observable
 
+
+    this.hooks.callHooks("client-spritesheets-load", this).subscribe();
+    this.hooks.callHooks("client-sounds-load", this).subscribe();
+    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-sprite-load", this).subscribe();
+
     await lastValueFrom(this.hooks.callHooks("client-engine-onStart", this));
 
     // wondow is resize
@@ -70,14 +92,6 @@ export class RpgClientEngine<T = any> {
       this.hooks.callHooks("client-engine-onStep", this, tick).subscribe();
     })
 
-    this.hooks.callHooks("client-spritesheets-load", this).subscribe();
-    this.hooks.callHooks("client-sounds-load", this).subscribe();
-    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-sprite-load", this).subscribe();
-
-  
     await this.webSocket.connection(() => {
       this.initListeners()
       this.guiService._initialize()
@@ -124,6 +138,7 @@ export class RpgClientEngine<T = any> {
   }
   
   private async loadScene(mapId: string) {
+    this.hooks.callHooks("client-sceneMap-onBeforeLoading", this.sceneMap).subscribe();
     this.webSocket.updateProperties({ room: mapId })
     await this.webSocket.reconnect(() => {
       this.initListeners()
@@ -273,4 +288,12 @@ export class RpgClientEngine<T = any> {
   get playerId() {
     return this.playerIdSignal()
   }
+
+  get scene() {
+    return this.sceneMap
+  }
+
+  getCurrentPlayer() {
+    return this.sceneMap.getCurrentPlayer()
+  }
 }

package/src/components/character.ce

@@ -1,4 +1,4 @@
-<Container x y zIndex={y} viewportFollow={isMe} controls>
+<Container x y zIndex={y} viewportFollow={isMe} controls onBeforeDestroy>
   @for (component of componentsBehind) {
     <Container>
       <component object />
@@ -19,6 +19,7 @@
 
 <script>
   import { signal, effect, mount, computed, tick } from "canvasengine";
+  import { lastValueFrom } from "rxjs";
   import { Particle } from "@canvasengine/presets";
   import { GameEngineToken, ModulesToken } from "@rpgjs/common";
   import { RpgClientEngine } from "../RpgClientEngine";
@@ -127,19 +128,20 @@
     }
     
     previousAnimationName = currentAnimationName;
+    
   });
 
-  mount((element) => {
-    hooks.callHooks("client-sprite-onInit", element.componentInstance)
-    hooks.callHooks("client-sceneMap-onAddSprite", client.sceneMap, element.componentInstance)
+  const onBeforeDestroy = async () => {
+    await lastValueFrom(hooks.callHooks("client-sprite-onDestroy", object)) 
+    await lastValueFrom(hooks.callHooks("client-sceneMap-onRemoveSprite", client.sceneMap, object))
+  }
 
-    return () => {
-      hooks.callHooks("client-sprite-onDestroy", element.componentInstance)
-      hooks.callHooks("client-sceneMap-onRemoveSprite", client.sceneMap, element.componentInstance)
-    }
+  mount((element) => {
+    hooks.callHooks("client-sprite-onAdd", object).subscribe()
+    hooks.callHooks("client-sceneMap-onAddSprite", client.sceneMap, object).subscribe()
   })
 
   tick(() => {
-    hooks.callHooks("client-sprite-onUpdate")
+    hooks.callHooks("client-sprite-onUpdate").subscribe()
   })
 </script>

package/src/components/gui/box.ce

@@ -0,0 +1,17 @@
+<Container positionType="absolute" top={top} left={left}>
+    <Container
+      anchor={[0.5, 0.5]}
+    >
+    <Rect width height color={_color} />
+    <Container attach={child}></Container>
+  </Container>  
+</Container>
+
+<script>
+  import { RpgClientEngine, inject } from "../../index";
+
+  const { width, height, children, color, top, left } = defineProps();
+  const engine = inject(RpgClientEngine)
+  const child = children[0]
+  const _color = computed(() => engine.globalConfig.gui?.windowColor || color?.() || "#1a1a2e")
+</script>