@vpmedia/phaser 1.123.0 → 1.125.0

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;
@@ -71,7 +81,7 @@ export class Sound {
    */
   public constructor(game: Game, key: string, volume = 1, loop = false, connect: boolean | null = null) {
     // https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Migrating_from_webkitAudioContext
-    connect ??= game.sound.connectToMaster;
+    const connectToMaster = connect ?? game.sound.connectToMaster;
     this.game = game;
     this.name = key;
     this.key = key;
@@ -101,10 +111,12 @@ 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) {
+    if (connectToMaster && this.masterGainNode !== null) {
       gainNode.connect(this.masterGainNode);
     }
     this.onPlay = new Signal();
@@ -181,7 +193,7 @@ export class Sound {
     }
     if (this.externalNode) {
       this._sound.disconnect(this.externalNode);
-    } else if (this.gainNode) {
+    } else if (this.gainNode as GainNode | undefined) {
       this._sound.disconnect(this.gainNode);
     }
     if (this._removeFromSoundManager) {
@@ -258,37 +270,35 @@ export class Sound {
    * @returns {Sound} This Sound instance for chaining.
    */
   public play(marker: string | false | null = '', position = 0, volume = 1, loop = false, forceRestart = true): this {
-    if (marker === undefined || marker === false || marker === null) {
-      marker = '';
-    }
-    forceRestart ??= true;
+    const markerName = marker === undefined || marker === false || marker === null ? '' : marker;
 
     if (this.isPlaying && !this.allowMultiple && !forceRestart && !this.override) {
       //  Use Restart instead
       return this;
     }
-    if (this._sound && this.isPlaying && !this.allowMultiple && (this.override || forceRestart)) {
+    const source = this._sound as AudioBufferSourceNode | undefined;
+    if (source && 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);
       }
       if (this.externalNode) {
         this._sound.disconnect(this.externalNode);
-      } else if (this.gainNode) {
+      } else if (this.gainNode as GainNode | undefined) {
         this._sound.disconnect(this.gainNode);
       }
       this.isPlaying = false;
     }
-    if (marker === '' && Object.keys(this.markers).length > 0) {
+    if (markerName === '' && Object.keys(this.markers).length > 0) {
       //  If they didn't specify a marker but this is an audio sprite,
       //  We should never play the entire thing
       return this;
     }
-    const markerData = marker === '' ? undefined : this.markers[marker];
-    if (marker !== '') {
+    const markerData = markerName === '' ? undefined : this.markers[markerName];
+    if (markerName !== '') {
       if (markerData) {
-        this.currentMarker = marker;
+        this.currentMarker = markerName;
         //  Playing a marker? Then we default to the marker values
         this.position = markerData.start;
         this.volume = markerData.volume;
@@ -301,32 +311,27 @@ export class Sound {
         if (loop !== undefined) {
           this.loop = loop;
         }
-        this._tempMarker = marker;
+        this._tempMarker = markerName;
         this._tempPosition = this.position;
         this._tempVolume = this.volume;
         this._tempLoop = this.loop;
       } else {
-        this.game.logger.warn(`Sound.play: audio marker ${marker} does not exist`);
+        this.game.logger.warn(`Sound.play: audio marker ${markerName} does not exist`);
         return this;
       }
     } else {
-      position ??= 0;
-      volume ??= this._volume;
-      if (loop === undefined) {
-        ({ loop } = this);
-      }
-      this.position = Math.max(0, position);
-      this.volume = volume;
-      this.loop = loop;
+      this.position = Math.max(0, position ?? 0);
+      this.volume = volume ?? this._volume;
+      this.loop = loop ?? this.loop;
       this.duration = 0;
       this.durationMS = 0;
-      this._tempMarker = marker;
+      this._tempMarker = markerName;
       this._tempPosition = position;
       this._tempVolume = volume;
       this._tempLoop = loop;
     }
     //  Does the sound need decoding?
-    if (this.game.cache.isSoundDecoded(this.key)) {
+    if (this.game.cache.isSoundDecoded(this.key) === true) {
       this._sound = this.context!.createBufferSource();
       if (this.externalNode) {
         this._sound.connect(this.externalNode);
@@ -335,10 +340,10 @@ export class Sound {
       }
       this._buffer = this.game.cache.getSoundData(this.key) as AudioBuffer | null;
       this._sound.buffer = this._buffer;
-      if (this.loop && marker === '') {
+      if (this.loop && markerName === '') {
         this._sound.loop = true;
       }
-      if (!this.loop && marker === '') {
+      if (!this.loop && markerName === '') {
         this._sound.addEventListener('ended', this.onEndedHandler, { once: true });
       }
       this.totalDuration = this._sound.buffer?.duration ?? 0;
@@ -348,8 +353,8 @@ export class Sound {
       }
       //  Useful to cache this somewhere perhaps?
       if (this._sound.start === undefined) {
-        (this._sound as any).noteGrainOn(0, this.position, this.duration);
-      } else if (this.loop && marker === '') {
+        (this._sound as unknown as LegacyBufferSource).noteGrainOn(0, this.position, this.duration);
+      } else if (this.loop && markerName === '') {
         this._sound.start(0, 0);
       } else {
         this._sound.start(0, this.position, this.duration);
@@ -383,11 +388,11 @@ export class Sound {
    * Pauses the sound.
    */
   public pause(): void {
-    if (this.isPlaying && this._sound) {
+    if (this.isPlaying && (this._sound as AudioBufferSourceNode | undefined)) {
       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();
     }
@@ -397,7 +402,7 @@ export class Sound {
    * Resumes the sound.
    */
   public resume(): void {
-    if (this.paused && this._sound) {
+    if (this.paused && (this._sound as AudioBufferSourceNode | undefined)) {
       const p = Math.max(0, this.position + this.pausedPosition / 1000);
       this._sound = this.context!.createBufferSource();
       this._sound.buffer = this._buffer;
@@ -414,7 +419,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);
       }
@@ -429,15 +434,15 @@ export class Sound {
    * Stops the sound.
    */
   public stop(): void {
-    if (this.isPlaying && this._sound) {
+    if (this.isPlaying && (this._sound as AudioBufferSourceNode | undefined)) {
       if (this._sound.stop === undefined) {
-        (this._sound as any).noteOff(0);
+        (this._sound as unknown as LegacyBufferSource).noteOff(0);
       } else {
         this._sound.stop(0);
       }
       if (this.externalNode) {
         this._sound.disconnect(this.externalNode);
-      } else if (this.gainNode) {
+      } else if (this.gainNode as GainNode | undefined) {
         this._sound.disconnect(this.gainNode);
       }
     }
@@ -531,7 +536,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 +570,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;
@@ -73,7 +73,7 @@ export class SoundManager {
       setAudioDisabledState();
       return;
     }
-    if (globalThis.AudioContext) {
+    if (globalThis.AudioContext as typeof AudioContext | undefined) {
       try {
         this.game.logger.info('initAudioContext');
         this.context = new globalThis.AudioContext();
@@ -240,7 +240,7 @@ export class SoundManager {
       return;
     }
     for (const sound of this._sounds) {
-      if (sound) {
+      if (sound !== null) {
         sound.stop();
       }
     }
@@ -254,7 +254,7 @@ export class SoundManager {
       return;
     }
     for (const sound of this._sounds) {
-      if (sound) {
+      if (sound !== null) {
         sound.pause();
       }
     }
@@ -268,7 +268,7 @@ export class SoundManager {
       return;
     }
     for (const sound of this._sounds) {
-      if (sound) {
+      if (sound !== null) {
         sound.resume();
       }
     }
@@ -317,7 +317,7 @@ export class SoundManager {
     this._watchList.reset();
     for (const file of candidates) {
       const key = file instanceof Sound ? file.key : file;
-      if (!this.game.cache.isSoundDecoded(key)) {
+      if (this.game.cache.isSoundDecoded(key) !== true) {
         this._watchList.add(key);
       }
     }
@@ -344,8 +344,8 @@ export class SoundManager {
     }
     if (this._watching) {
       let key = this._watchList.first;
-      while (key) {
-        if (this.game.cache.isSoundDecoded(key)) {
+      while (key !== null) {
+        if (this.game.cache.isSoundDecoded(key) === true) {
           this._watchList.remove(key);
         }
         key = this._watchList.next;
@@ -469,7 +469,7 @@ export class SoundManager {
   public destroy(): void {
     this.stopAll();
     for (const sound of this._sounds) {
-      if (sound) {
+      if (sound !== null) {
         sound.destroy();
       }
     }
@@ -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,23 +511,19 @@ 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) {
-    if (value < 0) {
-      value = 0;
-    } else if (value > 1) {
-      value = 1;
-    }
-    if (this._volume !== value) {
-      this._volume = value;
+  public set volume(value: number) {
+    const level = Math.min(1, Math.max(0, value));
+    if (this._volume !== level) {
+      this._volume = level;
       if (!this.noAudio) {
-        this.masterGain.gain.value = value;
+        this.masterGain.gain.value = level;
       }
     }
   }

package/src/phaser/core/sound_sprite.ts

@@ -38,7 +38,7 @@ export class SoundSprite {
       sound.addMarker(markerKey, marker.start, marker.end - marker.start, undefined, marker.loop);
       this.sounds[markerKey] = sound;
     }
-    if (this.config.autoplay) {
+    if (this.config.autoplay !== undefined) {
       this.autoplayKey = this.config.autoplay;
       this.play(this.autoplayKey);
       this.autoplay = this.sounds[this.autoplayKey]!;

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.
@@ -27,11 +37,11 @@ export class Stage extends DisplayObject {
       color: 0,
       rgba: '#000000',
     };
-    if (!game.config.transparent) {
+    if (game.config.transparent === false) {
       // transparent = 0,0,0,0 - otherwise r,g,b,1
       this._bgColor.a = 1;
     }
-    if (game.config.backgroundColor && !this.game.config.transparent) {
+    if (game.config.backgroundColor !== 0 && this.game.config.transparent === false) {
       this.setBackgroundColor(game.config.backgroundColor);
     }
   }
@@ -41,7 +51,7 @@ export class Stage extends DisplayObject {
    * @param {number} color - The color to set as the background.
    */
   public setBackgroundColor(color: number): void {
-    if (this.game.config.transparent) {
+    if (this.game.config.transparent !== false) {
       return;
     }
     valueToColor(color, this._bgColor);
@@ -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;
@@ -215,7 +215,7 @@ export class Timer {
     this._i = this.events.length;
     while (this._i) {
       this._i -= 1;
-      if (this.events[this._i]?.pendingDelete) {
+      if (this.events[this._i]?.pendingDelete === true) {
         this.events.splice(this._i, 1);
       }
     }