@rpgjs/client 4.2.2 → 5.0.0-alpha.0

package/src/Gui/Gui.ts

@@ -1,546 +1,92 @@
-import { InjectContext, RpgCommonPlayer, Utils } from '@rpgjs/common'
-import { RpgSound } from '../Sound/RpgSound'
-import { RpgClientEngine, RpgResource } from '../index'
-import { RpgRenderer } from '../Renderer'
-import { GameEngineClient } from '../GameEngine'
-import { SceneMap } from '../Scene/Map'
-import { VueGui } from './Vue'
-import { Scene } from '../Scene/Scene'
-import { map, tap, combineLatest, Subject, filter, Observable } from 'rxjs';
-
-const { elementToPositionAbsolute } = Utils
+import { Context, inject } from "@signe/di";
+import { signal } from "canvasengine";
+import { AbstractWebsocket, WebSocketToken } from "../services/AbstractSocket";
+import { PrebuiltGui } from "../components/gui";
 
 interface GuiOptions {
-    data: any,
-    attachToSprite: boolean
-    display: boolean,
-    name: string
-    isFunction: boolean,
-    gui: any
-}
-
-interface GuiList {
-    [guiName: string]: GuiOptions
+  name: string;
+  component: any;
+  display?: boolean;
+  data?: any;
 }
 
-const COMPONENT_LIBRARIES: any = [
-    VueGui
-]
-
-export class Gui {
-    private renderer: RpgRenderer
-    private gameEngine: GameEngineClient
-    public clientEngine: RpgClientEngine
-    private socket
-    public gui: GuiList = {}
-    public currentScene: Scene | null = null
-    private librariesInstances: any[] = []
-
-    async _initialize(context: InjectContext, guiEl: HTMLDivElement) {
-        this.clientEngine = context.inject(RpgClientEngine)
-        this.renderer =  context.inject(RpgRenderer)
-        this.gameEngine =  context.inject(GameEngineClient)
-        const { gui } = this.renderer.options
-
-        for (let ui of gui) {
-            let name = ui.name
-            if (Utils.isFunction(ui)) {
-                name = Utils.camelToKebab(name)
-            }
-            this.gui[name] = {
-                data: ui.data,
-                attachToSprite: ui.rpgAttachToSprite,
-                display: false,
-                name: name,
-                isFunction: Utils.isFunction(ui),
-                gui: ui
-            }
-        }
-
-        if (this.clientEngine.envs?.['VITE_REACT']) {
-            console.warn('[RPGJS] React GUI is experimental feature. So, its use may change over time. Not yet in production')
-            COMPONENT_LIBRARIES.push(await import('./React').then(m => m.ReactGui))
-        }
-
-        for (let componentClass of COMPONENT_LIBRARIES) {
-            const el = document.createElement('div')
-            elementToPositionAbsolute(el)
-            el.style['pointer-events'] = 'none'
-            guiEl.appendChild(el)
-            this.librariesInstances.push(new componentClass(el, this))
-        }
-
-        guiEl.style['pointer-events'] = 'none'
-    }
-
-    _setSceneReady(scene: Scene) {
-        this.currentScene = scene
-        this.librariesInstances.forEach(instance => {
-            if (instance._setSceneReady) instance._setSceneReady(scene)
-        })
+const throwError = (id: string) => {
+  throw `The GUI named ${id} is non-existent. Please add the component in the gui property of the decorator @RpgClient`;
+};
+
+export class RpgGui {
+  private webSocket: AbstractWebsocket;
+  gui = signal<any>({});
+
+  constructor(private context: Context) {
+    this.webSocket = inject(context, WebSocketToken);
+    this.add({
+      name: "rpg-dialog",
+      component: PrebuiltGui.Dialogbox,
+    });
+  }
+
+  async _initialize() {
+    this.webSocket.on("gui.open", (data: { guiId: string; data: any }) => {
+      this.display(data.guiId, data.data);
+    });
+
+    this.webSocket.on("gui.exit", (guiId: string) => {
+      this.hide(guiId);
+    });
+  }
+
+  guiInteraction(guiId: string, name: string, data: any) {
+    this.webSocket.emit("gui.interaction", {
+      guiId,
+      name,
+      data,
+    });
+  }
+
+  guiClose(guiId: string, data?: any) {
+    this.webSocket.emit("gui.exit", {
+      guiId,
+      data,
+    });
+  }
+
+  add(gui: GuiOptions) {
+    this.gui()[gui.name] = {
+      name: gui.name,
+      component: gui.component,
+      display: signal(gui.display || false),
+      data: signal(gui.data || {}),
+    };
+  }
+
+  get(id: string | GuiOptions) {
+    if (typeof id != "string") {
+      id = id.name;
     }
+    return this.gui()[id];
+  }
 
-    getInjectObject(): any {
-        const self = this
-        return {
-            /** 
-             * Recovery of the current scene
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgScene'],
-             *      mounted() {
-             *          const scene = this.rpgScene()
-             *          scene.stopInputs()
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop {Function returns RpgScene} [rpgScene]
-             * @memberof VueInject
-             * */
-            rpgScene: this.renderer.getScene.bind(this.renderer),
+  exists(id: string): boolean {
+    return !!this.get(id);
+  }
 
-            /** 
-            * Retrieve the main container of the game
-            * 
-            * ```js
-            * export default {
-            *      inject: ['rpgStage'],
-            *      mounted() {
-            *          const blur = new PIXI.BlurFilter()
-                       this.rpgStage.filters = [blur]
-            *      }
-            * }
-            * ``` 
-            * 
-            * @prop {PIXI.Container} [rpgStage]
-            * @memberof VueInject
-            * */
-            rpgStage: this.renderer.stage,
+  getAll() {
+    return this.gui();
+  }
 
-            /** 
-             * Listen to all the objects present in the room (events and players)
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgObjects'],
-             *      mounted() {
-             *          this.obs = this.rpgObjects.subscribe((objects) => {
-             *              for (let id in objects) {
-             *                  const obj = objects[id]
-             *                  console.log(obj.object, obj.paramsChanged)
-             *              }
-             *          })
-             *      },
-             *      unmounted() {
-             *          this.obs.unsubscribe()
-             *      }
-             * }
-             * ``` 
-             * 
-             * > remember to unsubscribe for memory leaks
-             * 
-             * It is an observable that returns an object: 
-             * 
-             * * the key is the object identifier
-             * * The value is an object comprising:
-             *      * `object`: The entire object
-             *      * `paramsChanged`: Only the representation of the properties that have been changed on this object
-             * 
-             * @prop {Observable<{ [objectId]: { object: object, paramsChanged: object } }>} [rpgObjects]
-             * @memberof VueInject
-             * */
-            rpgObjects: this.clientEngine.objects,
-
-            /** 
-             * Recovers and listens to the current player
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgCurrentPlayer'],
-             *      mounted() {
-             *          this.obs = this.rpgCurrentPlayer.subscribe((obj) => {
-             *              console.log(obj.object, obj.paramsChanged)
-             *          })
-             *      },
-             *      unmounted() {
-             *          this.obs.unsubscribe()
-             *      }
-             * }
-             * ``` 
-             * 
-             * * `object`: The whole player
-             * * `paramsChanged`: Only the representation of the properties that have been changed on this player
-             * 
-             * @prop {Observable<{ object: object, paramsChanged: object }>} [rpgCurrentPlayer]
-             * @memberof VueInject
-             * */
-            rpgCurrentPlayer: this.clientEngine.objects
-                .pipe(
-                    map((objects: any) => objects[this.gameEngine.playerId]),
-                    filter(player => !!player)
-                ),
-            rpgGameEngine: this.gameEngine,
-
-            /** 
-             * Tell the server to close the GUI. 
-             * 
-             * It is a function with 2 parameters:
-             * * `name`: The name of the component
-             * * `data`: The data you want to pass to the server
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgGuiClose'],
-             *      methods: {
-             *          close() {
-             *              this.rpgGuiClose('gui-name', {
-             *                  amount: 1000
-             *              })
-             *          }
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop {Function(name, data)} [rpgGuiClose]
-             * @memberof VueInject
-             * */
-            rpgGuiClose(name: string, data?) {
-                const guiId = name || this.$options?.name
-                self.socket.emit('gui.exit', {
-                    guiId,
-                    data
-                })
-            },
-
-            /** 
-             * Perform an interaction with the open GUI
-             * 
-             * It is a function with 2 parameters:
-             * * `guiId`: The name of the component/Gui
-             * * `name`: The name of the interaction (defined on the server side)
-             * * `data`: Data to be sent
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgGuiInteraction'],
-             *      methods: {
-             *          changeGold() {
-             *              this.rpgGuiInteraction('gui-name', 'change-gold', {
-             *                  amount: 100
-             *              })
-             *          }
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop {Function(guiId, name, data = {})} [rpgGuiInteraction]
-             * @memberof VueInject
-             * */
-            rpgGuiInteraction: (guiId: string, name: string, data: any = {}) => {
-                this.socket.emit('gui.interaction', {
-                    guiId,
-                    name,
-                    data
-                })
-            },
-
-            /** 
-             * Listen to the keys that are pressed on the keyboard
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgKeypress'],
-             *      mounted() {
-             *          this.obs = this.rpgKeypress.subscribe(({ inputName, control }) => {
-             *              console.log(inputName) // "escape"
-             *              console.log(control.actionName) // "back"
-             *          })
-             *      },
-             *      unmounted() {
-             *          this.obs.unsubscribe()
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop {Observable<{ inputName: string, control: { actionName: string, options: any } }>} [rpgKeypress]
-             * @memberof VueInject
-             * */
-            rpgKeypress: this.clientEngine.keyChange
-                .pipe(
-                    map(name => {
-                        const control = this.clientEngine.controls.getControl(name)
-                        return {
-                            inputName: name,
-                            control
-                        }
-                    })
-                ),
-
-            /** 
-             * Recovers the socket.
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgSocket'],
-             *      mounted() {
-             *          const socket = this.rpgSocket()
-             *          socket.emit('foo', 'bar')
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop {Function returns RpgScene} [rpgSocket]
-             * @memberof VueInject
-             * */
-            rpgSocket: () => this.socket,
-
-            /** 
-             * The RpgGui object to control GUIs
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgGui'],
-             *      mounted() {
-             *         const guis = this.rpgGui.getAll()
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop {RpgGui} [rpgGui]
-             * @memberof VueInject
-             * */
-            rpgGui: this,
-
-            /** 
-             * Equivalent to RpgSound
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgSound'],
-             *      mounted() {
-             *         this.rpgSound.get('my-sound-id').play()
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop {RpgSound} [rpgSound]
-             * @memberof VueInject
-             * */
-            rpgSound: RpgSound,
-
-            /** 
-             * Find the game's image and sound library
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgResource'],
-             *      mounted() {
-             *         const resourceImage = this.rpgResource.spritesheets.get('image_id')
-             *         const resourceSound = this.rpgResource.sounds.get('sound_id')
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop { { spritesheets: Map, sounds: Map } } [rpgResource]
-             * @memberof VueInject
-             * */
-            rpgResource: RpgResource,
-
-            /** 
-             * Get RpgClientEngine instance
-             * 
-             * ```js
-             * export default {
-             *      inject: ['rpgEngine'],
-             *      mounted() {
-             *         const vueInstance = this.rpgEngine.vueInstance
-             *      }
-             * }
-             * ``` 
-             * 
-             * @prop {RpgClientEngine} [rpgEngine]
-             * @memberof VueInject
-             * */
-            rpgEngine: this.clientEngine
-        }
+  display(id: string, data = {}) {
+    if (!this.exists(id)) {
+      throw throwError(id);
     }
+    this.get(id).data.set(data);
+    this.get(id).display.set(true);
+  }
 
-    /** @internal */
-    _setSocket(socket) {
-        this.socket = socket
-        this.socket.on('gui.open', ({ guiId, data }) => {
-            this.display(guiId, data)
-        })
-        this.socket.on('gui.tooltip', ({ players, display }) => {
-            for (let playerId of players) {
-                const sprite = this.renderer.getScene<SceneMap>()?.getSprite(playerId)
-                if (sprite) sprite.guiDisplay = display
-            }
-        })
-        this.socket.on('gui.exit', (guiId) => {
-            this.hide(guiId)
-        })
-    }
-
-    /** @internal */
-    _setGui(id, obj) {
-        const guiObj = this.get(id)
-        if (!guiObj) {
-            throw `The GUI named ${id} is non-existent. Please add the component in the gui property of the decorator @RpgClient`
-        }
-        for (let key in obj) {
-            guiObj[key] = obj[key]
-        }
-        this.librariesInstances.forEach(instance => {
-            instance.gui = Object.assign({}, this.gui)
-        })
-    }
-
-    /**
-   * Get a GUI. You retrieve GUI data and information whether it is displayed or not
-   * 
-   * ```ts
-   * import { RpgGui } from '@rpgjs/client'
-   * 
-   * const gui = RpgGui.get('my-gui') 
-   * console.log(gui.display) // false
-   * ```
-   * 
-   * @title Get a GUI
-   * @method RpgGui.get(id)
-   * @param {string} id 
-   * @returns { { data: any, display: boolean } }
-   * @memberof RpgGui
-   */
-    get(id) {
-        if (typeof id != 'string') {
-            id = id.name
-        }
-        return this.gui[id]
-    }
-
-    /**
-     * Get all GUI. You retrieve GUI data and information whether it is displayed or not
-     * 
-     * ```ts
-     * import { RpgGui } from '@rpgjs/client'
-     * 
-     * const gui = RpgGui.getAll() 
-     * console.log(gui) // { 'rpg-dialog': { data: {}, display: true } }
-     * ```
-     * 
-     * @title Get all GUI
-     * @method RpgGui.getAll()
-     * @returns { { [guiName]: { data: any, display: boolean }  }}
-     * @memberof RpgGui
-     */
-    getAll() {
-        return this.gui
-    }
-
-    /**
-     * Checks if the GUI exists RpgClient's gui array
-     * 
-     * ```ts
-     * import { RpgGui } from '@rpgjs/client'
-     * 
-     * RpgGui.exists('my-gui') // true
-     * ```
-     * 
-     * @title GUI Exists ?
-     * @method RpgGui.exists(id)
-     * @param {string} id 
-     * @returns {boolean}
-     * @memberof RpgGui
-     */
-    exists(id: string): boolean {
-        return !!this.get(id)
-    }
-
-    /**
-     * Calls a GUI according to identifier. You can send retrievable data in the component
-     * 
-     * ```ts
-     * import { RpgGui } from '@rpgjs/client'
-     * 
-     * RpgGui.display('my-gui')
-     * ```
-     * 
-     * @title Display GUI
-     * @method RpgGui.display(id,data)
-     * @param {string} id 
-     * @param {object} [data]
-     * @returns {void}
-     * @memberof RpgGui
-     */
-    display(id: string, data = {}) {
-        this._setGui(id, {
-            display: true,
-            data
-        })
-    }
-
-    /**
-     * Hide a GUI according to its identifier
-     * 
-     * ```ts
-     * import { RpgGui } from '@rpgjs/client'
-     * 
-     * RpgGui.hide('my-gui')
-     * ```
-     * 
-     * @title Hide GUI
-     * @method RpgGui.hide(id)
-     * @param {string} id 
-     * @returns {void}
-     * @memberof RpgGui
-     */
-    hide(id: string) {
-        this._setGui(id, {
-            display: false
-        })
-    }
-
-    /** @internal */
-    clear() {
-        this.gui = {}
-    }
-
-    /** @internal */
-    tooltipPosition(position: { x: number, y: number }) {
-        const scene = this.renderer.getScene<SceneMap>()
-        const viewport = scene?.viewport
-        if (viewport) {
-            const currentZoom = viewport.scale.x
-            const left = (position.x - viewport.left) * currentZoom
-            const top = (position.y - viewport.top) * currentZoom
-            return {
-                transform: `translate(${left}px,${top}px)`
-            }
-        }
-        return {}
-    }
-
-    /** @internal */
-    tooltipFilter(sprites: RpgCommonPlayer[]): RpgCommonPlayer[] {
-        return sprites.filter(tooltip => tooltip.guiDisplay)
-    }
-
-    /** @internal */
-    get listenTooltipObjects(): Observable<RpgCommonPlayer[]> {
-        return combineLatest(
-            [
-                this.clientEngine.gameEngine.all,
-                this.currentScene?.objectsMoving as Subject<any>
-            ]
-        ).pipe(
-            map(([objects]) => {
-                return Object.values(objects).map((obj: any) => obj.object)
-            })
-        )
+  hide(id: string) {
+    if (!this.exists(id)) {
+      throw throwError(id);
     }
+    this.get(id).display.set(false);
+  }
 }
-
-export const RpgGui = new Gui()

package/src/RpgClient.ts

@@ -1,10 +1,9 @@
-import { ModuleType } from '@rpgjs/common'
-import { SceneMap } from './Scene/Map'
 import { RpgClientEngine } from './RpgClientEngine'
-import { RpgComponent } from './Components/Component'
 import { Loader } from 'pixi.js'
 
 type RpgClass<T = any> = new (...args: any[]) => T
+type RpgComponent = any
+type SceneMap = any
 
 export interface RpgClientEngineHooks {
     /**
@@ -219,7 +218,7 @@ export interface RpgClient {
      * @prop { { client: null | Function, server: null | Function }[]} [imports]
      * @memberof RpgClient
      */
-    imports?: ModuleType[]
+    imports?: any
 
     /**
      * Object containing the hooks concerning the engine
@@ -271,7 +270,7 @@ export interface RpgClient {
      * @prop {Array<Class>} [spritesheets]
      * @memberof RpgClient
      * */
-    spritesheets?: RpgClass[],
+    spritesheets?: any[],
 
     /** 
      * Array containing the list of VueJS components
@@ -374,4 +373,9 @@ export interface RpgClient {
     scenes?: {
         map: RpgSceneMapHooks
     }
+
+    effects?: {
+        id: string,
+        component: any
+    }[]
 }