@vpmedia/phaser 1.119.0 → 1.121.0

package/src/phaser/core/scale_manager.ts

@@ -1,9 +1,10 @@
 import { Point } from '../geom/point.js';
 import { Rectangle } from '../geom/rectangle.js';
 import { RENDER_CANVAS, SCALE_EXACT_FIT, SCALE_OFF, SCALE_RESIZE, SCALE_SHOW_ALL, SCALE_USER } from './const.js';
-import type { Game } from './game.js';
+import type { Game, GameConfig } from './game.js';
 import { DOM } from './dom.js';
 import { Signal } from './signal.js';
+import type { AppliedCallback, Callback } from './callback.js';
 
 /** The gap the canvas leaves around itself inside its parent. */
 export type ScaleMargin = { left: number; top: number; right: number; bottom: number; x: number; y: number };
@@ -61,7 +62,7 @@ export class ScaleManager {
   public parentScaleFactor!: Point;
   public trackParentInterval!: number;
   public onSizeChange!: Signal;
-  public onResize!: Function | null;
+  public onResize!: Callback | null;
   public onResizeContext!: unknown;
   public _pendingScaleMode!: number | null;
   public _fullScreenRestore!: { targetWidth: string; targetHeight: string } | null;
@@ -179,22 +180,21 @@ export class ScaleManager {
       compat.clickTrampoline = '';
     }
     // Configure event listeners
-    const scope = this;
     this._orientationChange = (event): void => {
-      scope.orientationChange(event);
+      this.orientationChange(event);
     };
     this._windowResize = (event): void => {
-      scope.windowResize(event);
+      this.windowResize(event);
     };
     // This does not appear to be on the standards track
     globalThis.addEventListener('orientationchange', this._orientationChange, false);
     window.addEventListener('resize', this._windowResize, false);
     if (this.compatibility.supportsFullScreen) {
       this._fullScreenChange = (event): void => {
-        scope.fullScreenChange(event);
+        this.fullScreenChange(event);
       };
       this._fullScreenError = (event): void => {
-        scope.fullScreenError(event);
+        this.fullScreenError(event);
       };
       document.addEventListener('webkitfullscreenchange', this._fullScreenChange, false);
       document.addEventListener('mozfullscreenchange', this._fullScreenChange, false);
@@ -223,7 +223,7 @@ export class ScaleManager {
    * TBD.
    * @param {object} config - TBD.
    */
-  public parseConfig(config: any): void {
+  public parseConfig(config: GameConfig): void {
     if (config.scaleMode !== undefined) {
       if (this._booted) {
         this.scaleMode = config.scaleMode;
@@ -234,11 +234,7 @@ export class ScaleManager {
     if (config.fullScreenScaleMode !== undefined) {
       this.fullScreenScaleMode = config.fullScreenScaleMode;
     }
-    if (config.fullScreenTarget) {
-      this.fullScreenTarget = config.fullScreenTarget;
-    } else {
-      this.fullScreenTarget = document.documentElement;
-    }
+    this.fullScreenTarget = config.fullScreenTarget ?? document.documentElement;
   }
 
   /**
@@ -252,7 +248,7 @@ export class ScaleManager {
     if (this.game.parent !== '') {
       if (typeof this.game.parent === 'string') {
         // hopefully an element ID
-        target = document.getElementById(this.game.parent);
+        target = document.querySelector<HTMLElement>(`#${CSS.escape(this.game.parent)}`);
       } else if (this.game.parent && this.game.parent.nodeType === 1) {
         // quick test for a HTMLelement
         target = this.game.parent;
@@ -334,7 +330,7 @@ export class ScaleManager {
    * @param {Function} callback - TBD.
    * @param {object} context - TBD.
    */
-  public setResizeCallback(callback: Function, context: unknown): void {
+  public setResizeCallback(callback: Callback, context: unknown): void {
     this.onResize = callback;
     this.onResizeContext = context;
   }
@@ -398,7 +394,7 @@ export class ScaleManager {
     const orientationChanged = this.updateOrientationState();
     if (boundsChanged || orientationChanged) {
       if (this.onResize) {
-        this.onResize.call(this.onResizeContext, this, bounds);
+        (this.onResize as AppliedCallback).call(this.onResizeContext, this, bounds);
       }
       this.updateLayout();
       this.signalSizeChange();
@@ -572,8 +568,8 @@ export class ScaleManager {
       this.height = Math.min(this.height, bounds.height);
     }
     // Always truncate / force to integer
-    this.width |= 0;
-    this.height |= 0;
+    this.width = Math.trunc(this.width);
+    this.height = Math.trunc(this.height);
     this.reflowCanvas();
   }
 
@@ -743,12 +739,9 @@ export class ScaleManager {
     const bounds = this.getParentBounds(this._tempBounds);
     const { width } = bounds;
     const { height } = bounds;
-    let multiplier;
-    if (expanding) {
-      multiplier = Math.max(height / this.game.height, width / this.game.width);
-    } else {
-      multiplier = Math.min(height / this.game.height, width / this.game.width);
-    }
+    const multiplier = expanding
+      ? Math.max(height / this.game.height, width / this.game.width)
+      : Math.min(height / this.game.height, width / this.game.width);
     this.width = Math.round(this.game.width * multiplier);
     this.height = Math.round(this.game.height * multiplier);
   }
@@ -796,9 +789,8 @@ export class ScaleManager {
     }
     if (!this.compatibility.supportsFullScreen) {
       // Error is called in timeout to emulate the real fullscreenerror event better
-      const scope = this;
       setTimeout((): void => {
-        scope.fullScreenError({} as any);
+        this.fullScreenError(new Event('fullscreenerror'));
       }, 10);
       return false;
     }
@@ -863,9 +855,8 @@ export class ScaleManager {
     if (fsTarget && fsTarget.parentNode) {
       // Make sure to cleanup synthetic target for sure;
       // swap the canvas back to the parent.
-      const parent = fsTarget.parentNode;
-      parent.insertBefore(this.game.canvas, fsTarget);
-      parent.removeChild(fsTarget);
+      fsTarget.before(this.game.canvas);
+      fsTarget.remove();
     }
     this._createdFullScreenTarget = null;
   }
@@ -880,16 +871,17 @@ export class ScaleManager {
       return;
     }
     if (enteringFullscreen) {
-      if (this._createdFullScreenTarget || this.fullScreenScaleMode === SCALE_EXACT_FIT) {
-        // Resize target, as long as it's not the canvas
-        if (fsTarget !== this.game.canvas) {
-          this._fullScreenRestore = {
-            targetWidth: fsTarget.style.width,
-            targetHeight: fsTarget.style.height,
-          };
-          fsTarget.style.width = '100%';
-          fsTarget.style.height = '100%';
-        }
+      // Resize target, as long as it's not the canvas
+      if (
+        (this._createdFullScreenTarget || this.fullScreenScaleMode === SCALE_EXACT_FIT) &&
+        fsTarget !== this.game.canvas
+      ) {
+        this._fullScreenRestore = {
+          targetWidth: fsTarget.style.width,
+          targetHeight: fsTarget.style.height,
+        };
+        fsTarget.style.width = '100%';
+        fsTarget.style.height = '100%';
       }
     } else {
       // Have restore information
@@ -1044,9 +1036,9 @@ export class ScaleManager {
   public get isFullScreen(): boolean {
     return Boolean(
       document.fullscreenElement ??
-      (document as any).webkitFullscreenElement ??
-      (document as any).mozFullScreenElement ??
-      (document as any).msFullscreenElement
+      document.webkitFullscreenElement ??
+      document.mozFullScreenElement ??
+      document.msFullscreenElement
     );
   }
 

package/src/phaser/core/scene_manager.ts

@@ -88,7 +88,8 @@ export class SceneManager {
   public add(key: string, state: SceneDefinition, autoStart = false): SceneState {
     let newState: SceneState;
     if (typeof state === 'function') {
-      newState = new state(this.game);
+      const SceneClass = state;
+      newState = new SceneClass(this.game);
     } else {
       newState = state;
       if (!(state instanceof Scene)) {

package/src/phaser/core/signal.ts

@@ -1,5 +1,14 @@
 import { SignalBinding } from './signal_binding.js';
 
+/**
+ * A signal listener. The rest parameter is `never[]` so a handler with concrete parameters is
+ * assignable; the dispatcher widens it before applying the arguments.
+ */
+export type SignalListener = (...args: never[]) => unknown;
+
+/** The listener as the dispatcher calls it, once the concrete parameter types are behind us. */
+export type DispatchedListener = (...args: unknown[]) => unknown;
+
 export class Signal {
   public _bindings: SignalBinding[] | null = null;
   public _prevParams: unknown[] | null = null;
@@ -19,7 +28,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.
    */
-  public validateListener(listener: Function, fnName: string): void {
+  public validateListener(listener: SignalListener, fnName: string): void {
     if (typeof listener !== 'function') {
       throw new TypeError(
         'Signal: listener is a required param of {fn}() and should be a Function.'.replace('{fn}', fnName)
@@ -38,11 +47,11 @@ export class Signal {
    * @throws {Error} If the listener is already registered with a different once setting.
    */
   public _registerListener(
-    listener: Function,
+    listener: SignalListener,
     isOnce = false,
-    listenerContext: unknown | null = null,
+    listenerContext: unknown = null,
     priority = 0,
-    args: any = null
+    args: unknown[] | null = null
   ): SignalBinding {
     const prevIndex = this._indexOfListener(listener, listenerContext);
     let binding;
@@ -86,7 +95,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.
    */
-  public _indexOfListener(listener: Function, context: unknown = null): number {
+  public _indexOfListener(listener: SignalListener, context: unknown = null): number {
     if (!this._bindings) {
       return -1;
     }
@@ -108,7 +117,7 @@ export class Signal {
    * @param {object} context - The context of the listener.
    * @returns {boolean} True if the listener is registered, false otherwise.
    */
-  public has(listener: Function, context: unknown = null): boolean {
+  public has(listener: SignalListener, context: unknown = null): boolean {
     return this._indexOfListener(listener, context) !== -1;
   }
 
@@ -121,8 +130,8 @@ export class Signal {
    * @returns {SignalBinding} The binding for this listener.
    */
   public add(
-    listener: Function,
-    listenerContext: unknown | null = null,
+    listener: SignalListener,
+    listenerContext: unknown = null,
     priority = 0,
     ...args: unknown[]
   ): SignalBinding {
@@ -139,8 +148,8 @@ export class Signal {
    * @returns {SignalBinding} The binding for this listener.
    */
   public addOnce(
-    listener: Function,
-    listenerContext: unknown | null = null,
+    listener: SignalListener,
+    listenerContext: unknown = null,
     priority = 0,
     ...args: unknown[]
   ): SignalBinding {
@@ -154,7 +163,7 @@ export class Signal {
    * @param {object} context - The context of the listener.
    * @returns {Function} The removed listener function.
    */
-  public remove(listener: Function, context: unknown = null): Function {
+  public remove(listener: SignalListener, context: unknown = null): SignalListener {
     this.validateListener(listener, 'remove');
     const i = this._indexOfListener(listener, context);
     if (i !== -1 && this._bindings) {
@@ -267,9 +276,8 @@ export class Signal {
    * @returns {Function} A function that will dispatch the signal with the correct context.
    */
   public get boundDispatch() {
-    const _this = this;
     this._boundDispatch ??= (...rest: unknown[]): void => {
-      _this.dispatch(...rest);
+      this.dispatch(...rest);
     };
     return this._boundDispatch;
   }

package/src/phaser/core/signal_binding.ts

@@ -1,14 +1,14 @@
-import type { Signal } from './signal.js';
+import type { DispatchedListener, Signal, SignalListener } from './signal.js';
 export class SignalBinding {
-  public _signal: any;
-  public _listener: any;
-  public _args: any;
+  public _signal: Signal | null;
+  public _listener: SignalListener | null;
+  public _args: unknown[] | null;
   public _priority: number;
   public _isOnce: boolean;
   public context: unknown;
   public callCount: number;
   public active: boolean;
-  public params: any;
+  public params: unknown[] | null;
 
   /**
    * TBD.
@@ -21,11 +21,11 @@ export class SignalBinding {
    */
   public constructor(
     signal: Signal,
-    listener: Function,
+    listener: SignalListener,
     isOnce = false,
-    listenerContext: unknown | null = null,
+    listenerContext: unknown = null,
     priority = 0,
-    args: any = null
+    args: unknown[] | null = null
   ) {
     this._signal = signal;
     this._listener = listener;
@@ -43,15 +43,14 @@ export class SignalBinding {
    * @param {any[]} paramsArr - TBD.
    * @returns {Function} TBD.
    */
-  public execute(paramsArr: any[]) {
+  public execute(paramsArr: unknown[]): unknown {
     let handlerReturn;
-    let params;
-    if (this.active && Boolean(this._listener)) {
-      params = this.params ? this.params.concat(paramsArr) : paramsArr;
+    if (this.active && this._listener) {
+      let params = this.params ? [...this.params, ...paramsArr] : paramsArr;
       if (this._args) {
-        params = params.concat(this._args);
+        params = [...params, ...this._args];
       }
-      handlerReturn = this._listener.apply(this.context, params);
+      handlerReturn = (this._listener as DispatchedListener).apply(this.context, params);
       this.callCount += 1;
       if (this._isOnce) {
         this.detach();
@@ -64,8 +63,8 @@ export class SignalBinding {
    * TBD.
    * @returns {Function} TBD.
    */
-  public detach() {
-    return this.isBound() ? this._signal.remove(this._listener, this.context) : null;
+  public detach(): SignalListener | null {
+    return this.isBound() ? this._signal!.remove(this._listener!, this.context) : null;
   }
 
   /**
@@ -88,7 +87,7 @@ export class SignalBinding {
    * TBD.
    * @returns {Function} TBD.
    */
-  public getListener() {
+  public getListener(): SignalListener | null {
     return this._listener;
   }
 
@@ -96,7 +95,7 @@ export class SignalBinding {
    * TBD.
    * @returns {Signal} TBD.
    */
-  public getSignal() {
+  public getSignal(): Signal | null {
     return this._signal;
   }
 
@@ -104,9 +103,9 @@ export class SignalBinding {
    * TBD.
    */
   public _destroy(): void {
-    delete this._signal;
-    delete this._listener;
-    delete this.context;
+    this._signal = null;
+    this._listener = null;
+    this.context = null;
   }
 
   /**

package/src/phaser/core/sound.ts

@@ -70,7 +70,6 @@ export class Sound {
    * @param {boolean} connect - Whether to connect to the master gain node.
    */
   public constructor(game: Game, key: string, volume = 1, loop = false, connect: boolean | null = null) {
-    // TODO
     // https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API/Migrating_from_webkitAudioContext
     connect ??= game.sound.connectToMaster;
     this.game = game;
@@ -173,8 +172,7 @@ export class Sound {
   /**
    * Handler for when the sound ends.
    */
-  public onEndedHandler(): void {
-    this._sound.onended = null;
+  public onEndedHandler = (): void => {
     this.isPlaying = false;
     this.currentTime = this.durationMS;
     this.stop();
@@ -202,7 +200,7 @@ export class Sound {
       this.onMarkerComplete.dispose();
       this.onFadeComplete.dispose();
     }
-  }
+  };
 
   /**
    * Updates the sound state.
@@ -341,7 +339,7 @@ export class Sound {
         this._sound.loop = true;
       }
       if (!this.loop && marker === '') {
-        this._sound.onended = this.onEndedHandler.bind(this);
+        this._sound.addEventListener('ended', this.onEndedHandler, { once: true });
       }
       this.totalDuration = this._sound.buffer?.duration ?? 0;
       if (this.duration === 0) {
@@ -364,7 +362,7 @@ export class Sound {
     } else {
       this.pendingPlayback = true;
       if (this.game.cache.getSound(this.key)?.isDecoding === false) {
-        this.game.sound.decode(this.key);
+        void this.game.sound.decode(this.key);
       }
     }
     return this;
@@ -412,7 +410,7 @@ export class Sound {
         this._sound.loop = true;
       }
       if (!this.loop && this.currentMarker === '') {
-        this._sound.onended = this.onEndedHandler.bind(this);
+        this._sound.addEventListener('ended', this.onEndedHandler, { once: true });
       }
       const duration = this.duration - this.pausedPosition / 1000;
       if (this._sound.start === undefined) {
@@ -540,12 +538,12 @@ export class Sound {
   /**
    * Sets the muted state of the sound.
    */
-  public set mute(value) {
-    value = value ?? false;
-    if (value === this._muted) {
+  public set mute(value: boolean | null) {
+    const muted = value ?? false;
+    if (muted === this._muted) {
       return;
     }
-    if (value) {
+    if (muted) {
       this._muted = true;
       this._muteVolume = this._tempVolume;
       this.gainNode.gain.value = 0;

package/src/phaser/core/sound_manager.ts

@@ -11,6 +11,7 @@ import { ENGINE_ERROR_CREATING_AUDIO_CONTEXT } from './error_code.js';
 import { Signal } from './signal.js';
 import { Sound } from './sound.js';
 import { SoundSprite } from './sound_sprite.js';
+import type { Callback } from './callback.js';
 
 export class SoundManager {
   public game!: Game;
@@ -28,7 +29,7 @@ export class SoundManager {
   public _sounds!: Sound[];
   public _watchList!: ArraySet;
   public _watching!: boolean;
-  public _watchCallback!: Function | null;
+  public _watchCallback!: Callback | null;
   public _watchContext!: unknown;
   public masterGain!: GainNode;
   public _muteVolume!: number;
@@ -83,10 +84,11 @@ export class SoundManager {
         const typedError = error instanceof Error ? error : new Error(String(error));
         this.game.logger.fatal('SoundManager', { error: typedError });
       }
-    } else if ((globalThis as any).webkitAudioContext) {
+    } else if (globalThis.webkitAudioContext) {
       try {
         this.game.logger.info('initWebkitAudioContext');
-        this.context = new (globalThis as any).webkitAudioContext();
+        const WebkitAudioContext = globalThis.webkitAudioContext;
+        this.context = new WebkitAudioContext();
         this.type = AUDIO_WEBKIT;
       } catch (error) {
         this.context = null;
@@ -101,11 +103,10 @@ export class SoundManager {
       return;
     }
     this.baseLatency = this.context.baseLatency ?? 256 / (this.context.sampleRate ?? 44_100);
-    if (this.context.createGain === undefined) {
-      this.masterGain = (this.context as unknown as { createGainNode: () => GainNode }).createGainNode();
-    } else {
-      this.masterGain = this.context.createGain();
-    }
+    this.masterGain =
+      this.context.createGain === undefined
+        ? (this.context as unknown as { createGainNode: () => GainNode }).createGainNode()
+        : this.context.createGain();
     this.masterGain.gain.value = 1;
     this.masterGain.connect(this.context.destination);
     // handle audio state unlock
@@ -185,6 +186,14 @@ export class SoundManager {
    * @param {Event} event - The DOM event that triggered the unlock.
    */
   public onUnlockEvent = (event: Event): void => {
+    void this.resumeContext(event);
+  };
+
+  /**
+   * Resumes the audio context a user gesture has just unlocked.
+   * @param {Event} event - The DOM event that triggered the unlock.
+   */
+  public async resumeContext(event: Event): Promise<void> {
     const initialState = this.context!.state;
     if (initialState !== 'suspended' && initialState !== 'interrupted') {
       this.game.logger.info('onUnlockResumeDenied', {
@@ -200,29 +209,28 @@ export class SoundManager {
       isLocked: this.isLocked,
       event,
     });
-    this.context!.resume()
-      .then((): void => {
-        this.game.logger.info('onContextResumeResult', {
-          initialState,
-          state: this.context!.state,
-          isLocked: this.isLocked,
-        });
-        this.removeUnlockHandlers();
-      })
-      .catch((error: unknown): void => {
-        this.game.logger.info('onContextResumeReject', {
-          initialState,
-          state: this.context!.state,
-          isLocked: this.isLocked,
-          error,
-        });
-        this.removeUnlockHandlers();
-        this.game.logger.fatal('SoundManager', {
-          error,
-          tags: { 'audio.initialState': initialState, 'audio.state': this.context!.state },
-        });
+    try {
+      await this.context!.resume();
+      this.game.logger.info('onContextResumeResult', {
+        initialState,
+        state: this.context!.state,
+        isLocked: this.isLocked,
       });
-  };
+      this.removeUnlockHandlers();
+    } catch (error: unknown) {
+      this.game.logger.info('onContextResumeReject', {
+        initialState,
+        state: this.context!.state,
+        isLocked: this.isLocked,
+        error,
+      });
+      this.removeUnlockHandlers();
+      this.game.logger.fatal('SoundManager', {
+        error,
+        tags: { 'audio.initialState': initialState, 'audio.state': this.context!.state },
+      });
+    }
+  }
 
   /**
    * Stops all sounds in the manager.
@@ -270,7 +278,7 @@ export class SoundManager {
    * Decodes an audio file for playback.
    * @param {string} key - The key of the sound to decode.
    */
-  public decode(key: string): void {
+  public async decode(key: string): Promise<void> {
     const soundData = this.game.cache.getSoundData(key);
     if (!(soundData instanceof ArrayBuffer)) {
       return;
@@ -279,21 +287,19 @@ export class SoundManager {
       return;
     }
     this.game.cache.updateSound(key, 'isDecoding', true);
-    this.context!.decodeAudioData(soundData)
-      .then((buffer: AudioBuffer): void => {
-        this.game.cache.decodedSound(key, buffer);
-      })
-      .catch((error: unknown): void => {
-        const typedError = error instanceof Error ? error : new Error(String(error));
-        this.game.logger.fatal('SoundManager', { error: typedError, tags: { 'asset.key': key } });
-        if (typedError.name === 'InvalidStateError') {
-          addPageLifecycleCallback(PAGE_LIFECYCLE_STATE_ACTIVE, (): void => {
-            this.decode(key);
-          });
-        } else if (typedError.name === 'EncodingError') {
-          this._watchList.remove(key);
-        }
-      });
+    try {
+      this.game.cache.decodedSound(key, await this.context!.decodeAudioData(soundData));
+    } catch (error: unknown) {
+      const typedError = error instanceof Error ? error : new Error(String(error));
+      this.game.logger.fatal('SoundManager', { error: typedError, tags: { 'asset.key': key } });
+      if (typedError.name === 'InvalidStateError') {
+        addPageLifecycleCallback(PAGE_LIFECYCLE_STATE_ACTIVE, (): void => {
+          void this.decode(key);
+        });
+      } else if (typedError.name === 'EncodingError') {
+        this._watchList.remove(key);
+      }
+    }
   }
 
   /**
@@ -304,7 +310,7 @@ export class SoundManager {
    */
   public setDecodedCallback(
     files: string | string[] | Sound | Sound[],
-    callback: Function,
+    callback: Callback,
     callbackContext: unknown
   ): void {
     const candidates: (string | Sound)[] = typeof files === 'string' ? [files] : Array.isArray(files) ? files : [files];