@vpmedia/phaser 1.112.0 → 1.113.0

package/src/phaser/core/scene.ts

@@ -1,19 +1,15 @@
 export class Scene {
-  game!: any;
-  key!: any;
+  public game: any = null;
+  public key: any = '';
   /**
    * Creates a new Scene instance.
    */
-  constructor() {
-    this.game = null;
-    this.key = '';
-  }
 
   /**
    * Initialize the scene.
    * This method is called before preload() and create().
    */
-  init() {
+  public init() {
     // inherit
   }
 
@@ -21,7 +17,7 @@ export class Scene {
    * Load assets for the scene.
    * This method is called after init() and before create().
    */
-  preload() {
+  public preload() {
     // inherit
   }
 
@@ -29,7 +25,7 @@ export class Scene {
    * Create the scene.
    * This method is called after preload() and is where you create your game objects.
    */
-  create() {
+  public create() {
     // inherit
   }
 
@@ -37,7 +33,7 @@ export class Scene {
    * Update the scene.
    * This method is called every frame while the scene is active.
    */
-  update() {
+  public update() {
     // inherit
   }
 
@@ -46,7 +42,7 @@ export class Scene {
    * @param {number} _width - The new width of the scene.
    * @param {number} _height - The new height of the scene.
    */
-  resize(_width: number, _height: number) {
+  public resize(_width: number, _height: number) {
     // inherit
   }
 
@@ -54,7 +50,7 @@ export class Scene {
    * Update the scene while paused.
    * This method is called every frame while the scene is paused.
    */
-  pauseUpdate() {
+  public pauseUpdate() {
     // inherit
   }
 
@@ -62,7 +58,7 @@ export class Scene {
    * Shutdown the scene.
    * This method is called when the scene is about to be destroyed.
    */
-  shutdown() {
+  public shutdown() {
     // inherit
   }
 }

package/src/phaser/core/scene_manager.ts

@@ -2,32 +2,32 @@ import type { Game } from './game.js';
 import { Scene } from './scene.js';
 
 export class SceneManager {
-  game!: any;
-  states!: any;
-  _pendingState!: any;
-  _clearWorld!: any;
-  _clearCache!: any;
-  _created!: any;
-  _args!: any;
-  current!: string;
-  onInitCallback!: any;
-  onPreloadCallback!: any;
-  onCreateCallback!: any;
-  onUpdateCallback!: any;
-  onResizeCallback!: any;
-  onPauseUpdateCallback!: any;
-  onShutDownCallback!: any;
-  callbackContext!: any;
+  public game!: any;
+  public states!: any;
+  public _pendingState!: any;
+  public _clearWorld!: any;
+  public _clearCache!: any;
+  public _created!: any;
+  public _args!: any;
+  public current!: string;
+  public onInitCallback!: any;
+  public onPreloadCallback!: any;
+  public onCreateCallback!: any;
+  public onUpdateCallback!: any;
+  public onResizeCallback!: any;
+  public onPauseUpdateCallback!: any;
+  public onShutDownCallback!: any;
+  public callbackContext!: any;
   /**
    * Creates a new SceneManager instance.
-   * @param {import('./game.js').Game} game - The game instance this manager belongs to.
+   * @param {Game} game - The game instance this manager belongs to.
    * @param {string} pendingState - The state to load when the game boots.
    */
-  constructor(game: Game, pendingState: string) {
+  public constructor(game: Game, pendingState: string) {
     this.game = game;
     this.states = {};
     this._pendingState = null;
-    if (typeof pendingState !== 'undefined' && pendingState !== null) {
+    if (pendingState !== undefined && pendingState !== null) {
       this._pendingState = pendingState;
     }
     this._clearWorld = false;
@@ -48,7 +48,7 @@ export class SceneManager {
    * Initialize the scene manager.
    * This method is called when the game boots and sets up the initial state.
    */
-  boot() {
+  public boot() {
     if (this._pendingState !== null && typeof this._pendingState !== 'string') {
       this.add('default', this._pendingState, true);
     }
@@ -61,7 +61,7 @@ export class SceneManager {
    * @param {boolean} autoStart - Whether to start this state immediately.
    * @returns {Scene|object} The created scene or state object.
    */
-  add(key: string, state: any, autoStart: boolean = false) {
+  public add(key: string, state: any, autoStart = false) {
     let newState = null;
     if (state instanceof Scene) {
       newState = state;
@@ -86,7 +86,7 @@ export class SceneManager {
    * Remove a scene state from the manager.
    * @param {string} key - The unique key for the state to remove.
    */
-  remove(key: string) {
+  public remove(key: string) {
     if (this.current === key) {
       this.callbackContext = null;
       this.onInitCallback = null;
@@ -107,14 +107,14 @@ export class SceneManager {
    * @param {boolean} clearCache - Whether to clear the cache before starting.
    * @param {...any} args - Additional arguments to pass to the state.
    */
-  start(key: string, clearWorld: boolean = true, clearCache: boolean = false, ...args: any[]) {
+  public start(key: string, clearWorld = true, clearCache = false, ...args: any[]) {
     if (this.checkState(key)) {
       //  Place the state in the queue. It will be started the next time the game loop begins.
       this._pendingState = key;
       this._clearWorld = clearWorld;
       this._clearCache = clearCache;
       if (args && args.length > 0) {
-        this._args = args.slice();
+        this._args = [...args];
       }
     }
   }
@@ -125,12 +125,12 @@ export class SceneManager {
    * @param {boolean} clearCache - Whether to clear the cache before restarting.
    * @param {...any} args - Additional arguments to pass to the state.
    */
-  restart(clearWorld: boolean = true, clearCache: boolean = false, ...args: any[]) {
+  public restart(clearWorld = true, clearCache = false, ...args: any[]) {
     this._pendingState = this.current;
     this._clearWorld = clearWorld;
     this._clearCache = clearCache;
     if (args && args.length > 0) {
-      this._args = args.slice();
+      this._args = [...args];
     }
   }
 
@@ -138,7 +138,7 @@ export class SceneManager {
    * Pre-update the scene manager.
    * This method is called before the game loop updates.
    */
-  preUpdate() {
+  public preUpdate() {
     if (this._pendingState && this.game.isBooted) {
       // var previousStateKey = this.current;
       //  Already got a state running?
@@ -173,7 +173,7 @@ export class SceneManager {
    * Clear the current scene state.
    * This method is called when switching scenes to clean up the previous scene.
    */
-  clearCurrentState() {
+  public clearCurrentState() {
     if (this.current) {
       if (this.onShutDownCallback) {
         this.onShutDownCallback.call(this.callbackContext, this.game);
@@ -196,7 +196,7 @@ export class SceneManager {
    * @param {string} key - The unique key for the state to check.
    * @returns {boolean} True if the scene exists, false otherwise.
    */
-  checkState(key: string) {
+  public checkState(key: string) {
     if (this.states[key]) {
       if (this.states[key].preload || this.states[key].create || this.states[key].update || this.states[key].render) {
         return true;
@@ -210,7 +210,7 @@ export class SceneManager {
    * Link a scene state to the manager.
    * @param {string} key - The unique key for the state to link.
    */
-  link(key: string) {
+  public link(key: string) {
     this.states[key].game = this.game;
     this.states[key].key = key;
   }
@@ -219,7 +219,7 @@ export class SceneManager {
    * Unlink a scene state from the manager.
    * @param {string} key - The unique key for the state to unlink.
    */
-  unlink(key: string) {
+  public unlink(key: string) {
     if (this.states[key]) {
       this.states[key].game = null;
     }
@@ -229,17 +229,17 @@ export class SceneManager {
    * Set the current scene state.
    * @param {string} key - The unique key for the state to set as current.
    */
-  setCurrentState(key: string) {
+  public setCurrentState(key: string) {
     this.callbackContext = this.states[key];
     this.link(key);
     //  Used when the state is set as being the current active state
-    this.onInitCallback = this.callbackContext.init || this.dummy;
-    this.onPreloadCallback = this.callbackContext.preload || null;
-    this.onCreateCallback = this.callbackContext.create || null;
-    this.onUpdateCallback = this.callbackContext.update || null;
-    this.onResizeCallback = this.callbackContext.resize || null;
-    this.onPauseUpdateCallback = this.callbackContext.pauseUpdate || null;
-    this.onShutDownCallback = this.callbackContext.shutdown || this.dummy;
+    this.onInitCallback = this.callbackContext.init ?? this.dummy;
+    this.onPreloadCallback = this.callbackContext.preload ?? null;
+    this.onCreateCallback = this.callbackContext.create ?? null;
+    this.onUpdateCallback = this.callbackContext.update ?? null;
+    this.onResizeCallback = this.callbackContext.resize ?? null;
+    this.onPauseUpdateCallback = this.callbackContext.pauseUpdate ?? null;
+    this.onShutDownCallback = this.callbackContext.shutdown ?? this.dummy;
     this.current = key;
     this._created = false;
     this.onInitCallback.apply(this.callbackContext, this._args);
@@ -254,7 +254,7 @@ export class SceneManager {
    * @template T
    * @returns {T} The current scene state.
    */
-  getCurrentState<T = Partial<Scene>>(): T {
+  public getCurrentState<T = Partial<Scene>>(): T {
     return this.states[this.current];
   }
 
@@ -262,7 +262,7 @@ export class SceneManager {
    * Handle loading completion.
    * This method is called when scene loading is complete.
    */
-  loadComplete() {
+  public loadComplete() {
     if (this._created === false && this.onCreateCallback) {
       this._created = true;
       this.onCreateCallback.call(this.callbackContext, this.game);
@@ -275,7 +275,7 @@ export class SceneManager {
    * Update the scene manager.
    * This method is called every frame while the game is running.
    */
-  update() {
+  public update() {
     if (this._created && this.onUpdateCallback) {
       this.onUpdateCallback.call(this.callbackContext, this.game);
     }
@@ -285,7 +285,7 @@ export class SceneManager {
    * Pause the scene manager updates.
    * This method is called when the game is paused.
    */
-  pauseUpdate() {
+  public pauseUpdate() {
     if (this._created && this.onPauseUpdateCallback) {
       this.onPauseUpdateCallback.call(this.callbackContext, this.game);
     }
@@ -296,7 +296,7 @@ export class SceneManager {
    * @param {number} width - The new width of the scene.
    * @param {number} height - The new height of the scene.
    */
-  resize(width: number, height: number) {
+  public resize(width: number, height: number) {
     if (this.onResizeCallback) {
       this.onResizeCallback.call(this.callbackContext, width, height);
     }
@@ -306,7 +306,7 @@ export class SceneManager {
    * Destroy the scene manager.
    * This method is called when the scene manager is about to be destroyed.
    */
-  destroy() {
+  public destroy() {
     this._clearWorld = true;
     this._clearCache = true;
     this.clearCurrentState();
@@ -327,7 +327,7 @@ export class SceneManager {
    * Dummy function for callbacks.
    * This is a placeholder function used when no callback is defined.
    */
-  dummy() {
+  public dummy() {
     // pass
   }
 
@@ -335,7 +335,7 @@ export class SceneManager {
    * Get whether the scene has been created.
    * @returns {boolean} True if the scene has been created, false otherwise.
    */
-  get created() {
+  public get created() {
     return this._created;
   }
 }

package/src/phaser/core/signal.test.ts

@@ -1,14 +1,14 @@
-import { expect } from 'vitest';
+import { expect, describe, it } from 'vitest';
 import { Signal } from './signal.js';
 
 describe('Signal', () => {
   describe('core', () => {
-    it('', () => {
+    it('adds, dispatches to and removes listeners', () => {
       const signal = new Signal();
-      const listener = (arg) => {
+      const listener = (arg: number) => {
         expect(arg).toBe(1);
       };
-      const listenerOnce = (arg) => {
+      const listenerOnce = (arg: number) => {
         expect(arg).toBe(1);
       };
       signal.add(listener);

package/src/phaser/core/signal.ts

@@ -1,25 +1,17 @@
 import { SignalBinding } from './signal_binding.js';
 
 export class Signal {
-  _bindings: SignalBinding[] | null;
-  _prevParams: unknown[] | null;
-  memorize: boolean;
-  _shouldPropagate: boolean;
-  active: boolean;
-  _boundDispatch: ((...args: unknown[]) => void) | null;
+  public _bindings: SignalBinding[] | null = null;
+  public _prevParams: unknown[] | null = null;
+  public memorize = false;
+  public _shouldPropagate = true;
+  public active = true;
+  public _boundDispatch: ((...args: unknown[]) => void) | null = null;
 
   /**
    * Creates a new Signal instance.
    * A Signal is a simple event system that allows you to dispatch events and listen for them.
    */
-  constructor() {
-    this._bindings = null;
-    this._prevParams = null;
-    this.memorize = false;
-    this._shouldPropagate = true;
-    this.active = true;
-    this._boundDispatch = null;
-  }
 
   /**
    * Validates that a listener is a function.
@@ -27,7 +19,7 @@ export class Signal {
    * @param {string} fnName - The name of the function this validation is for.
    * @throws {Error} If the listener is not a function.
    */
-  validateListener(listener: Function, fnName: string) {
+  public validateListener(listener: Function, fnName: string) {
     if (typeof listener !== 'function') {
       throw new TypeError(
         'Signal: listener is a required param of {fn}() and should be a Function.'.replace('{fn}', fnName)
@@ -45,17 +37,18 @@ export class Signal {
    * @returns {SignalBinding} The binding for this listener.
    * @throws {Error} If the listener is already registered with a different once setting.
    */
-  _registerListener(
+  public _registerListener(
     listener: Function,
-    isOnce: boolean = false,
+    isOnce = false,
     listenerContext: any | null = null,
-    priority: number = 0,
+    priority = 0,
     args: any = null
   ) {
     const prevIndex = this._indexOfListener(listener, listenerContext);
     let binding;
-    if (prevIndex !== -1 && this._bindings) {
-      binding = this._bindings[prevIndex];
+    const existing = prevIndex !== -1 && this._bindings ? this._bindings[prevIndex] : undefined;
+    if (existing) {
+      binding = existing;
       if (binding.isOnce() !== isOnce) {
         throw new Error(
           `You cannot add${isOnce ? '' : 'Once'}() then add${
@@ -77,15 +70,13 @@ export class Signal {
    * Add a binding to the list of listeners.
    * @param {SignalBinding} binding - The binding to add.
    */
-  _addBinding(binding: SignalBinding) {
-    if (!this._bindings) {
-      this._bindings = [];
-    }
+  public _addBinding(binding: SignalBinding) {
+    this._bindings ??= [];
     //  Simplified insertion sort
     let n = this._bindings.length;
     do {
       n -= 1;
-    } while (this._bindings[n] && binding._priority <= this._bindings[n]._priority);
+    } while (this._bindings[n] && binding._priority <= this._bindings[n]!._priority);
     this._bindings.splice(n + 1, 0, binding);
   }
 
@@ -95,7 +86,7 @@ export class Signal {
    * @param {object} context - The context of the listener.
    * @returns {number} The index of the listener in the bindings array, or -1 if not found.
    */
-  _indexOfListener(listener: Function, context: any | null = null) {
+  public _indexOfListener(listener: Function, context: any | null = null) {
     if (!this._bindings) {
       return -1;
     }
@@ -103,7 +94,7 @@ export class Signal {
     let cur;
     while (n) {
       n -= 1;
-      cur = this._bindings[n];
+      cur = this._bindings[n]!;
       if (cur._listener === listener && cur.context === context) {
         return n;
       }
@@ -117,7 +108,7 @@ export class Signal {
    * @param {object} context - The context of the listener.
    * @returns {boolean} True if the listener is registered, false otherwise.
    */
-  has(listener: Function, context: any | null = null) {
+  public has(listener: Function, context: any | null = null) {
     return this._indexOfListener(listener, context) !== -1;
   }
 
@@ -129,7 +120,7 @@ export class Signal {
    * @param {...any} args - Additional arguments to pass to the listener.
    * @returns {SignalBinding} The binding for this listener.
    */
-  add(listener: Function, listenerContext: any | null = null, priority: number = 0, ...args: any[]) {
+  public add(listener: Function, listenerContext: any | null = null, priority = 0, ...args: any[]) {
     this.validateListener(listener, 'add');
     return this._registerListener(listener, false, listenerContext, priority, args);
   }
@@ -142,7 +133,7 @@ export class Signal {
    * @param {...any} args - Additional arguments to pass to the listener.
    * @returns {SignalBinding} The binding for this listener.
    */
-  addOnce(listener: Function, listenerContext: any | null = null, priority: number = 0, ...args: any[]) {
+  public addOnce(listener: Function, listenerContext: any | null = null, priority = 0, ...args: any[]) {
     this.validateListener(listener, 'addOnce');
     return this._registerListener(listener, true, listenerContext, priority, args);
   }
@@ -153,12 +144,12 @@ export class Signal {
    * @param {object} context - The context of the listener.
    * @returns {Function} The removed listener function.
    */
-  remove(listener: Function, context: any | null = null) {
+  public remove(listener: Function, context: any | null = null) {
     this.validateListener(listener, 'remove');
     const i = this._indexOfListener(listener, context);
     if (i !== -1 && this._bindings) {
       // no reason to a SignalBinding exist if it isn't attached to a signal
-      this._bindings[i]._destroy();
+      this._bindings[i]!._destroy();
       this._bindings.splice(i, 1);
     }
     return listener;
@@ -168,7 +159,7 @@ export class Signal {
    * Remove all listeners from the signal, or only those in a specific context.
    * @param {object} context - The context to filter listeners by, or null to remove all.
    */
-  removeAll(context: any | null = null) {
+  public removeAll(context: any | null = null) {
     if (!this._bindings) {
       return;
     }
@@ -176,12 +167,12 @@ export class Signal {
     while (n) {
       n -= 1;
       if (context) {
-        if (this._bindings[n].context === context) {
-          this._bindings[n]._destroy();
+        if (this._bindings[n]!.context === context) {
+          this._bindings[n]!._destroy();
           this._bindings.splice(n, 1);
         }
       } else {
-        this._bindings[n]._destroy();
+        this._bindings[n]!._destroy();
       }
     }
     if (!context) {
@@ -193,7 +184,7 @@ export class Signal {
    * Get the number of listeners registered with the signal.
    * @returns {number} The number of registered listeners.
    */
-  getNumListeners() {
+  public getNumListeners() {
     return this._bindings ? this._bindings.length : 0;
   }
 
@@ -201,7 +192,7 @@ export class Signal {
    * Stop the signal from propagating to other listeners.
    * This method prevents any remaining listeners from being called.
    */
-  halt() {
+  public halt() {
     this._shouldPropagate = false;
   }
 
@@ -209,11 +200,11 @@ export class Signal {
    * Dispatch the signal to all registered listeners.
    * @param {...any} args - Arguments to pass to the listeners.
    */
-  dispatch(...args: any[]) {
+  public dispatch(...args: any[]) {
     if (!this.active || !this._bindings) {
       return;
     }
-    const paramsArr = args.slice();
+    const paramsArr = [...args];
     let n = this._bindings.length;
 
     if (this.memorize) {
@@ -223,21 +214,21 @@ export class Signal {
       // Should come after memorize
       return;
     }
-    const bindings = this._bindings.slice(); // clone array in case add/remove items during dispatch
+    const bindings = [...this._bindings]; // clone array in case add/remove items during dispatch
     this._shouldPropagate = true; // in case `halt` was called before dispatch or during the previous dispatch.
 
     // execute all callbacks until end of the list or until a callback returns `false` or stops propagation
     // reverse loop since listeners with higher priority will be added at the end of the list
     do {
       n -= 1;
-    } while (bindings[n] && this._shouldPropagate && bindings[n].execute(paramsArr) !== false);
+    } while (bindings[n] && this._shouldPropagate && bindings[n]!.execute(paramsArr) !== false);
   }
 
   /**
    * Clear any previously memorized arguments.
    * This removes the stored arguments from a previous dispatch.
    */
-  forget() {
+  public forget() {
     if (this._prevParams) {
       this._prevParams = null;
     }
@@ -247,7 +238,7 @@ export class Signal {
    * Dispose of the signal and clean up all resources.
    * This method removes all listeners and clears internal state.
    */
-  dispose() {
+  public dispose() {
     this.removeAll();
     this.forget();
     this._bindings = null;
@@ -257,7 +248,7 @@ export class Signal {
    * Get a string representation of the signal.
    * @returns {string} A string representation of the signal.
    */
-  toString() {
+  public toString() {
     return `[Signal active:${this.active} numListeners:${this.getNumListeners()}]`;
   }
 
@@ -265,13 +256,11 @@ export class Signal {
    * Get a bound version of the dispatch function.
    * @returns {Function} A function that will dispatch the signal with the correct context.
    */
-  get boundDispatch() {
+  public get boundDispatch() {
     const _this = this;
-    if (!this._boundDispatch) {
-      this._boundDispatch = (...rest: unknown[]) => {
-        _this.dispatch(...rest);
-      };
-    }
+    this._boundDispatch ??= (...rest: unknown[]) => {
+      _this.dispatch(...rest);
+    };
     return this._boundDispatch;
   }
 
@@ -279,7 +268,7 @@ export class Signal {
    * Promisify the Signal.
    * @returns {Promise<any>} The resolved result.
    */
-  toPromise() {
+  public toPromise() {
     return new Promise((resolve) => {
       this.addOnce((...args: unknown[]) => {
         resolve(args.length <= 1 ? args[0] : args);