@vpmedia/phaser 1.123.0 → 1.124.0

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

@@ -1,9 +1,9 @@
 import { describe, expect, it, vi } from 'vitest';
 import { Signal } from './signal.js';
 
-describe('Signal binding management', () => {
-  describe('add', () => {
-    it('registers a listener and reports it', () => {
+describe('Signal binding management', (): void => {
+  describe('add', (): void => {
+    it('registers a listener and reports it', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.add(listener);
@@ -11,7 +11,7 @@ describe('Signal binding management', () => {
       expect(signal.has(listener)).toBe(true);
     });
 
-    it('returns the existing binding when the same listener is added twice', () => {
+    it('returns the existing binding when the same listener is added twice', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       const first = signal.add(listener);
@@ -20,7 +20,7 @@ describe('Signal binding management', () => {
       expect(signal.getNumListeners()).toBe(1);
     });
 
-    it('treats the same listener under a different context as a separate binding', () => {
+    it('treats the same listener under a different context as a separate binding', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.add(listener, { id: 1 });
@@ -28,7 +28,7 @@ describe('Signal binding management', () => {
       expect(signal.getNumListeners()).toBe(2);
     });
 
-    it('refuses to switch a listener between add and addOnce', () => {
+    it('refuses to switch a listener between add and addOnce', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.add(listener);
@@ -36,18 +36,18 @@ describe('Signal binding management', () => {
     });
   });
 
-  describe('dispatch', () => {
-    it('calls listeners in priority order, highest first', () => {
+  describe('dispatch', (): void => {
+    it('calls listeners in priority order, highest first', (): void => {
       const signal = new Signal();
       const order: string[] = [];
-      signal.add(() => order.push('low'), null, 0);
-      signal.add(() => order.push('high'), null, 10);
-      signal.add(() => order.push('mid'), null, 5);
+      signal.add((): number => order.push('low'), null, 0);
+      signal.add((): number => order.push('high'), null, 10);
+      signal.add((): number => order.push('mid'), null, 5);
       signal.dispatch();
       expect(order).toStrictEqual(['high', 'mid', 'low']);
     });
 
-    it('forwards its arguments', () => {
+    it('forwards its arguments', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.add(listener);
@@ -55,7 +55,7 @@ describe('Signal binding management', () => {
       expect(listener).toHaveBeenCalledWith(1, 'two');
     });
 
-    it('removes an addOnce listener after it fires', () => {
+    it('removes an addOnce listener after it fires', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       signal.addOnce(listener);
@@ -65,20 +65,20 @@ describe('Signal binding management', () => {
       expect(signal.getNumListeners()).toBe(0);
     });
 
-    it('stops propagating once a listener returns false', () => {
+    it('stops propagating once a listener returns false', (): void => {
       const signal = new Signal();
       const later = vi.fn();
-      signal.add(() => false, null, 10);
+      signal.add((): boolean => false, null, 10);
       signal.add(later, null, 0);
       signal.dispatch();
       expect(later).not.toHaveBeenCalled();
     });
 
-    it('stops propagating once halt is called', () => {
+    it('stops propagating once halt is called', (): void => {
       const signal = new Signal();
       const later = vi.fn();
       signal.add(
-        () => {
+        (): void => {
           signal.halt();
         },
         null,
@@ -89,25 +89,25 @@ describe('Signal binding management', () => {
       expect(later).not.toHaveBeenCalled();
     });
 
-    it('survives a listener that removes every listener mid-dispatch', () => {
+    it('survives a listener that removes every listener mid-dispatch', (): void => {
       const signal = new Signal();
       const later = vi.fn();
       signal.add(
-        () => {
+        (): void => {
           signal.removeAll();
         },
         null,
         10
       );
       signal.add(later, null, 0);
-      expect(() => {
+      expect((): void => {
         signal.dispatch();
       }).not.toThrow();
     });
   });
 
-  describe('remove', () => {
-    it('drops the matching binding', () => {
+  describe('remove', (): void => {
+    it('drops the matching binding', (): void => {
       const signal = new Signal();
       const listener = vi.fn();
       const other = vi.fn();
@@ -119,7 +119,7 @@ describe('Signal binding management', () => {
       expect(signal.has(other)).toBe(true);
     });
 
-    it('leaves the list alone for an unregistered listener', () => {
+    it('leaves the list alone for an unregistered listener', (): void => {
       const signal = new Signal();
       signal.add(vi.fn());
       signal.remove(vi.fn());
@@ -127,8 +127,8 @@ describe('Signal binding management', () => {
     });
   });
 
-  describe('removeAll', () => {
-    it('clears every listener when given no context', () => {
+  describe('removeAll', (): void => {
+    it('clears every listener when given no context', (): void => {
       const signal = new Signal();
       signal.add(vi.fn(), { id: 1 });
       signal.add(vi.fn(), { id: 2 });
@@ -136,7 +136,7 @@ describe('Signal binding management', () => {
       expect(signal.getNumListeners()).toBe(0);
     });
 
-    it('clears only the listeners bound to the given context', () => {
+    it('clears only the listeners bound to the given context', (): void => {
       const signal = new Signal();
       const context = { id: 1 };
       signal.add(vi.fn(), context);
@@ -146,8 +146,8 @@ describe('Signal binding management', () => {
     });
   });
 
-  describe('memorize', () => {
-    it('replays the last dispatch to a listener added afterwards', () => {
+  describe('memorize', (): void => {
+    it('replays the last dispatch to a listener added afterwards', (): void => {
       const signal = new Signal();
       signal.memorize = true;
       signal.add(vi.fn());
@@ -157,7 +157,7 @@ describe('Signal binding management', () => {
       expect(listener).toHaveBeenCalledWith('remembered');
     });
 
-    it('records nothing while the signal has never had a binding', () => {
+    it('records nothing while the signal has never had a binding', (): void => {
       const signal = new Signal();
       signal.memorize = true;
       signal.dispatch('dropped');
@@ -166,7 +166,7 @@ describe('Signal binding management', () => {
       expect(listener).not.toHaveBeenCalled();
     });
 
-    it('stops replaying once forgotten', () => {
+    it('stops replaying once forgotten', (): void => {
       const signal = new Signal();
       signal.memorize = true;
       signal.add(vi.fn());

package/src/phaser/core/sound.ts

@@ -13,6 +13,16 @@ export type SoundMarker = {
   loop: boolean;
 };
 
+/** The pre-standard Web Audio names, still the only ones some older engines expose. */
+type LegacyAudioContext = { createGainNode: () => GainNode };
+
+/** The pre-standard source-node names, alongside the playback position those engines reported. */
+type LegacyBufferSource = {
+  noteOff: (when: number) => void;
+  noteGrainOn: (when: number, offset: number, duration: number) => void;
+  currentTime: number;
+};
+
 export class Sound {
   public _paused!: boolean;
   public game!: Game;
@@ -101,7 +111,9 @@ export class Sound {
     this.context = this.game.sound.context;
     this.masterGainNode = this.game.sound.masterGain;
     const gainNode: GainNode =
-      this.context!.createGain === undefined ? (this.context as any).createGainNode() : this.context!.createGain();
+      this.context!.createGain === undefined
+        ? (this.context as unknown as LegacyAudioContext).createGainNode()
+        : this.context!.createGain();
     this.gainNode = gainNode;
     gainNode.gain.value = volume * this.game.sound.volume;
     if (connect && this.masterGainNode) {
@@ -269,7 +281,7 @@ export class Sound {
     }
     if (this._sound && this.isPlaying && !this.allowMultiple && (this.override || forceRestart)) {
       if (this._sound.stop === undefined) {
-        (this._sound as any).noteOff(0);
+        (this._sound as unknown as LegacyBufferSource).noteOff(0);
       } else {
         this._sound.stop(0);
       }
@@ -348,7 +360,7 @@ export class Sound {
       }
       //  Useful to cache this somewhere perhaps?
       if (this._sound.start === undefined) {
-        (this._sound as any).noteGrainOn(0, this.position, this.duration);
+        (this._sound as unknown as LegacyBufferSource).noteGrainOn(0, this.position, this.duration);
       } else if (this.loop && marker === '') {
         this._sound.start(0, 0);
       } else {
@@ -387,7 +399,7 @@ export class Sound {
       this.paused = true;
       this.pausedPosition = this.currentTime;
       this.pausedTime = this.game.time.time;
-      this._tempPause = (this._sound as any).currentTime;
+      this._tempPause = (this._sound as unknown as LegacyBufferSource).currentTime;
       this.onPause.dispatch(this);
       this.stop();
     }
@@ -414,7 +426,7 @@ export class Sound {
       }
       const duration = this.duration - this.pausedPosition / 1000;
       if (this._sound.start === undefined) {
-        (this._sound as any).noteGrainOn(0, p, duration);
+        (this._sound as unknown as LegacyBufferSource).noteGrainOn(0, p, duration);
       } else {
         this._sound.start(0, p, duration);
       }
@@ -431,7 +443,7 @@ export class Sound {
   public stop(): void {
     if (this.isPlaying && this._sound) {
       if (this._sound.stop === undefined) {
-        (this._sound as any).noteOff(0);
+        (this._sound as unknown as LegacyBufferSource).noteOff(0);
       } else {
         this._sound.stop(0);
       }
@@ -531,7 +543,7 @@ export class Sound {
    * Gets the muted state of the sound.
    * @returns {boolean} True if the sound is muted, false otherwise.
    */
-  public get mute() {
+  public get mute(): boolean | null {
     return this._muted || this.game.sound.mute;
   }
 
@@ -565,7 +577,7 @@ export class Sound {
   /**
    * Sets the volume of the sound.
    */
-  public set volume(value) {
+  public set volume(value: number) {
     if (this._muted) {
       this._muteVolume = value;
       return;

package/src/phaser/core/sound_manager.ts

@@ -27,7 +27,7 @@ export class SoundManager {
   public _unlockSource!: AudioBufferSourceNode | null;
   public _volume!: number;
   public _sounds!: Sound[];
-  public _watchList!: ArraySet;
+  public _watchList!: ArraySet<string>;
   public _watching!: boolean;
   public _watchCallback!: Callback | null;
   public _watchContext!: unknown;
@@ -54,7 +54,7 @@ export class SoundManager {
     this._volume = 1;
     /** @type {Sound[]} */
     this._sounds = [];
-    this._watchList = new ArraySet();
+    this._watchList = new ArraySet<string>();
     this._watching = false;
     this._watchCallback = null;
     this._watchContext = null;
@@ -484,14 +484,14 @@ export class SoundManager {
    * Gets the muted state of the sound manager.
    * @returns {boolean} True if the manager is muted, false otherwise.
    */
-  public get mute() {
+  public get mute(): boolean {
     return this._muted;
   }
 
   /**
    * Sets the muted state of the sound manager.
    */
-  public set mute(value) {
+  public set mute(value: boolean) {
     if (value || false) {
       if (this._muted) {
         return;
@@ -511,14 +511,14 @@ export class SoundManager {
    * Gets the volume level of the sound manager.
    * @returns {number} The volume level (0.0 to 1.0).
    */
-  public get volume() {
+  public get volume(): number {
     return this._volume;
   }
 
   /**
    * Sets the volume level of the sound manager.
    */
-  public set volume(value) {
+  public set volume(value: number) {
     if (value < 0) {
       value = 0;
     } else if (value > 1) {

package/src/phaser/core/stage.ts

@@ -5,11 +5,21 @@ import { valueToColor } from '../util/math.js';
 import { SCALE_LINEAR, SCALE_NEAREST } from './const.js';
 import type { Game } from './game.js';
 
+/** The stage clear colour, kept in every form the two renderers need. */
+export type StageBackgroundColor = {
+  r: number;
+  g: number;
+  b: number;
+  a: number;
+  color: number;
+  rgba: string;
+};
+
 export class Stage extends DisplayObject {
-  declare public name: any;
-  declare public worldTransform: any;
-  public currentRenderOrderID!: any;
-  public _bgColor!: any;
+  declare public name: string;
+  declare public worldTransform: Matrix;
+  public currentRenderOrderID!: number;
+  public _bgColor!: StageBackgroundColor;
   /**
    * Creates a new Stage instance.
    * @param {Game} game - The game instance.
@@ -109,22 +119,22 @@ export class Stage extends DisplayObject {
   public override destroy(): void {
     this.exists = false;
     this.game = null!;
-    this.worldTransform = null;
-    this._bgColor = null;
+    this.worldTransform = null!;
+    this._bgColor = null!;
   }
 
   /**
    * Gets the background color of the stage.
    * @returns {number} The background color.
    */
-  public get backgroundColor() {
+  public get backgroundColor(): number {
     return this._bgColor.color;
   }
 
   /**
    * Sets the background color of the stage.
    */
-  public set backgroundColor(value) {
+  public set backgroundColor(value: number) {
     this.setBackgroundColor(value);
   }
 
@@ -139,7 +149,7 @@ export class Stage extends DisplayObject {
   /**
    * Sets whether texture smoothing is enabled.
    */
-  public set smoothed(value) {
+  public set smoothed(value: boolean) {
     globalThis.PhaserRegistry.TEXTURE_SCALE_MODE = value ? SCALE_LINEAR : SCALE_NEAREST;
   }
 }

package/src/phaser/core/time.ts

@@ -268,7 +268,7 @@ export class Time {
   /**
    * Sets the desired frames per second.
    */
-  public set desiredFps(value) {
+  public set desiredFps(value: number) {
     this._desiredFps = value;
     this.desiredFpsMult = 1 / value;
   }

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

@@ -10,37 +10,37 @@ const createTimer = (startTime = 0): Timer => {
   return timer;
 };
 
-describe('Timer', () => {
-  describe('start', () => {
-    it('rebases every queued event onto the start time', () => {
+describe('Timer', (): void => {
+  describe('start', (): void => {
+    it('rebases every queued event onto the start time', (): void => {
       const timer = createTimer(1000);
-      timer.add(100, () => undefined);
-      timer.add(300, () => undefined);
+      timer.add(100, (): undefined => undefined);
+      timer.add(300, (): undefined => undefined);
       timer.start();
-      expect(timer.events.map((event) => event.tick)).toStrictEqual([1100, 1300]);
+      expect(timer.events.map((event): number => event.tick)).toStrictEqual([1100, 1300]);
     });
 
-    it('is a no-op once already running', () => {
+    it('is a no-op once already running', (): void => {
       const timer = createTimer(1000);
-      timer.add(100, () => undefined);
+      timer.add(100, (): undefined => undefined);
       timer.start();
-      const ticks = timer.events.map((event) => event.tick);
+      const ticks = timer.events.map((event): number => event.tick);
       timer.start(500);
-      expect(timer.events.map((event) => event.tick)).toStrictEqual(ticks);
+      expect(timer.events.map((event): number => event.tick)).toStrictEqual(ticks);
     });
   });
 
-  describe('order', () => {
-    it('sorts events by tick and exposes the earliest as nextTick', () => {
+  describe('order', (): void => {
+    it('sorts events by tick and exposes the earliest as nextTick', (): void => {
       const timer = createTimer(0);
-      timer.add(500, () => undefined);
-      timer.add(100, () => undefined);
-      timer.add(300, () => undefined);
-      expect(timer.events.map((event) => event.delay)).toStrictEqual([100, 300, 500]);
+      timer.add(500, (): undefined => undefined);
+      timer.add(100, (): undefined => undefined);
+      timer.add(300, (): undefined => undefined);
+      expect(timer.events.map((event): number => event.delay)).toStrictEqual([100, 300, 500]);
       expect(timer.nextTick).toBe(100);
     });
 
-    it('leaves nextTick untouched when there are no events', () => {
+    it('leaves nextTick untouched when there are no events', (): void => {
       const timer = createTimer(0);
       timer.nextTick = 42;
       timer.order();
@@ -48,33 +48,33 @@ describe('Timer', () => {
     });
   });
 
-  describe('remove', () => {
-    it('marks a matching event for deletion and reports success', () => {
+  describe('remove', (): void => {
+    it('marks a matching event for deletion and reports success', (): void => {
       const timer = createTimer(0);
-      const event = timer.add(100, () => undefined);
+      const event = timer.add(100, (): undefined => undefined);
       expect(timer.remove(event)).toBe(true);
       expect(event.pendingDelete).toBe(true);
     });
 
-    it('reports failure for an event it does not hold', () => {
+    it('reports failure for an event it does not hold', (): void => {
       const timer = createTimer(0);
-      timer.add(100, () => undefined);
-      const other = createTimer(0).add(100, () => undefined);
+      timer.add(100, (): undefined => undefined);
+      const other = createTimer(0).add(100, (): undefined => undefined);
       expect(timer.remove(other)).toBe(false);
     });
 
-    it('reports failure for null without throwing', () => {
+    it('reports failure for null without throwing', (): void => {
       const timer = createTimer(0);
-      timer.add(100, () => undefined);
+      timer.add(100, (): undefined => undefined);
       expect(timer.remove(null)).toBe(false);
     });
   });
 
-  describe('clearPendingEvents', () => {
-    it('drops only the events marked for deletion', () => {
+  describe('clearPendingEvents', (): void => {
+    it('drops only the events marked for deletion', (): void => {
       const timer = createTimer(0);
-      const first = timer.add(100, () => undefined);
-      const second = timer.add(200, () => undefined);
+      const first = timer.add(100, (): undefined => undefined);
+      const second = timer.add(200, (): undefined => undefined);
       timer.remove(first);
       timer.clearPendingEvents();
       expect(timer.events).toStrictEqual([second]);
@@ -82,8 +82,8 @@ describe('Timer', () => {
     });
   });
 
-  describe('update', () => {
-    it('fires a one-shot event once its tick is reached and marks it spent', () => {
+  describe('update', (): void => {
+    it('fires a one-shot event once its tick is reached and marks it spent', (): void => {
       const timer = createTimer(0);
       const callback = vi.fn();
       timer.add(100, callback);
@@ -95,7 +95,7 @@ describe('Timer', () => {
       expect(timer.events[0]?.pendingDelete).toBe(true);
     });
 
-    it('keeps firing a looping event and reschedules its tick', () => {
+    it('keeps firing a looping event and reschedules its tick', (): void => {
       const timer = createTimer(0);
       const callback = vi.fn();
       timer.loop(100, callback);
@@ -107,7 +107,7 @@ describe('Timer', () => {
       expect(timer.events[0]?.pendingDelete).toBe(false);
     });
 
-    it('fires a repeating event exactly repeatCount times', () => {
+    it('fires a repeating event exactly repeatCount times', (): void => {
       const timer = createTimer(0);
       const callback = vi.fn();
       timer.repeat(100, 2, callback);
@@ -120,10 +120,10 @@ describe('Timer', () => {
       expect(timer.expired).toBe(true);
     });
 
-    it('passes the configured context and arguments to the callback', () => {
+    it('passes the configured context and arguments to the callback', (): void => {
       const timer = createTimer(0);
       const context = { seen: null as unknown };
-      const callback = vi.fn(function callbackImpl(this: typeof context, value: string) {
+      const callback = vi.fn(function callbackImpl(this: typeof context, value: string): void {
         this.seen = value;
       });
       timer.add(100, callback, context, 'payload');
@@ -133,49 +133,49 @@ describe('Timer', () => {
       expect(context.seen).toBe('payload');
     });
 
-    it('completes and dispatches onComplete once every event is spent', () => {
+    it('completes and dispatches onComplete once every event is spent', (): void => {
       const timer = createTimer(0);
       const onComplete = vi.fn();
       timer.onComplete.add(onComplete);
-      timer.add(100, () => undefined);
+      timer.add(100, (): undefined => undefined);
       timer.start();
       timer.update(100);
       expect(timer.expired).toBe(true);
       expect(onComplete).toHaveBeenCalledTimes(1);
     });
 
-    it('survives a callback that removes every event mid-tick', () => {
+    it('survives a callback that removes every event mid-tick', (): void => {
       const timer = createTimer(0);
-      timer.add(100, () => {
+      timer.add(100, (): void => {
         timer.events.length = 0;
       });
       timer.start();
-      expect(() => timer.update(100)).not.toThrow();
+      expect((): boolean => timer.update(100)).not.toThrow();
     });
   });
 
-  describe('adjustEvents', () => {
-    it('shifts pending events forward by the time they missed', () => {
+  describe('adjustEvents', (): void => {
+    it('shifts pending events forward by the time they missed', (): void => {
       const timer = createTimer(0);
-      const event = timer.add(100, () => undefined);
+      const event = timer.add(100, (): undefined => undefined);
       timer.start();
       timer._now = 5000;
       timer.adjustEvents(0);
       expect(event.tick).toBe(5100);
     });
 
-    it('clamps events whose tick already passed to the current time', () => {
+    it('clamps events whose tick already passed to the current time', (): void => {
       const timer = createTimer(0);
-      const event = timer.add(100, () => undefined);
+      const event = timer.add(100, (): undefined => undefined);
       timer.start();
       timer._now = 5000;
       timer.adjustEvents(500);
       expect(event.tick).toBe(5000);
     });
 
-    it('leaves events marked for deletion alone', () => {
+    it('leaves events marked for deletion alone', (): void => {
       const timer = createTimer(0);
-      const event = timer.add(100, () => undefined);
+      const event = timer.add(100, (): undefined => undefined);
       timer.start();
       timer.remove(event);
       const { tick } = event;

package/src/phaser/core/timer.ts

@@ -68,7 +68,7 @@ export class Timer {
     repeatCount: number,
     callback: Callback,
     callbackContext: unknown = null,
-    args: any = []
+    args: unknown[] = []
   ): TimerEvent {
     const roundedDelay = Math.round(delay);
     let tick = roundedDelay;