@vpmedia/phaser 1.111.0 → 1.113.0

package/src/phaser/core/sound_manager.ts

@@ -1,3 +1,4 @@
+import type { Game } from './game.js';
 import {
   addPageLifecycleCallback,
   getPageLifecycleEventEmitter,
@@ -12,30 +13,30 @@ import { Sound } from './sound.js';
 import { SoundSprite } from './sound_sprite.js';
 
 export class SoundManager {
-  game!: any;
-  onChange!: any;
-  context!: any;
-  baseLatency!: any;
-  noAudio!: any;
-  type!: any;
-  connectToMaster!: any;
-  isLocked!: any;
-  _codeMuted!: any;
-  _muted!: any;
-  _unlockSource!: any;
-  _volume!: any;
-  _sounds!: any;
-  _watchList!: any;
-  _watching!: any;
-  _watchCallback!: any;
-  _watchContext!: any;
-  masterGain!: any;
-  _muteVolume!: any;
+  public game!: any;
+  public onChange!: any;
+  public context!: any;
+  public baseLatency!: any;
+  public noAudio!: any;
+  public type!: any;
+  public connectToMaster!: any;
+  public isLocked!: any;
+  public _codeMuted!: any;
+  public _muted!: any;
+  public _unlockSource!: any;
+  public _volume!: any;
+  public _sounds!: any;
+  public _watchList!: any;
+  public _watching!: any;
+  public _watchCallback!: any;
+  public _watchContext!: any;
+  public masterGain!: any;
+  public _muteVolume!: any;
   /**
    * Creates a new SoundManager instance.
-   * @param {import('./game.js').Game} game - Reference to the Phaser Game instance.
+   * @param {Game} game - Reference to the Phaser Game instance.
    */
-  constructor(game: import('./game.js').Game) {
+  public constructor(game: Game) {
     this.game = game;
     this.onChange = new Signal();
     /** @type {AudioContext} */
@@ -61,7 +62,7 @@ export class SoundManager {
   /**
    * Initializes the sound manager and sets up audio context.
    */
-  boot() {
+  public boot() {
     const setAudioDisabledState = () => {
       this.type = AUDIO_DISABLED;
       this.noAudio = true;
@@ -71,35 +72,35 @@ export class SoundManager {
       setAudioDisabledState();
       return;
     }
-    if (window.AudioContext) {
+    if (globalThis.AudioContext) {
       try {
         this.game.logger.info('initAudioContext');
-        this.context = new window.AudioContext();
+        this.context = new globalThis.AudioContext();
         this.type = AUDIO_STANDARD;
       } catch (error) {
         this.context = null;
         setAudioDisabledState();
         const typedError = error instanceof Error ? error : new Error(String(error));
-        this.game.logger.exception('SoundManager', typedError);
+        this.game.logger.fatal('SoundManager', { error: typedError });
       }
-    } else if ((window as any).webkitAudioContext) {
+    } else if ((globalThis as any).webkitAudioContext) {
       try {
         this.game.logger.info('initWebkitAudioContext');
-        this.context = new (window as any).webkitAudioContext();
+        this.context = new (globalThis as any).webkitAudioContext();
         this.type = AUDIO_WEBKIT;
       } catch (error) {
         this.context = null;
         setAudioDisabledState();
         const typedError = error instanceof Error ? error : new Error(String(error));
-        this.game.logger.exception('SoundManager', typedError);
+        this.game.logger.fatal('SoundManager', { error: typedError });
       }
     }
     if (!this.context) {
-      this.game.logger.exception('SoundManager', new Error(ENGINE_ERROR_CREATING_AUDIO_CONTEXT));
+      this.game.logger.fatal('SoundManager', { error: new Error(ENGINE_ERROR_CREATING_AUDIO_CONTEXT) });
       setAudioDisabledState();
       return;
     }
-    this.baseLatency = this.context.baseLatency || 256 / (this.context.sampleRate || 44100);
+    this.baseLatency = this.context.baseLatency ?? 256 / (this.context.sampleRate ?? 44_100);
     if (this.context.createGain === undefined) {
       this.masterGain = this.context.createGainNode();
     } else {
@@ -119,7 +120,7 @@ export class SoundManager {
   /**
    * Handles page lifecycle changes for audio management.
    */
-  onPageLifecycleChange = () => {
+  public onPageLifecycleChange = () => {
     if (!document.hidden) {
       this.checkUnlockHandlers();
     }
@@ -128,7 +129,7 @@ export class SoundManager {
   /**
    * Handles audio context state changes.
    */
-  onContextStateChange = () => {
+  public onContextStateChange = () => {
     this.game.logger.info('onContextStateChange', {
       state: this.context.state,
       isLocked: this.isLocked,
@@ -139,7 +140,7 @@ export class SoundManager {
   /**
    * Checks if audio unlock handlers need to be added or removed.
    */
-  checkUnlockHandlers = () => {
+  public checkUnlockHandlers = () => {
     this.game.logger.info('checkUnlockHandlers', {
       state: this.context.state,
       isLocked: this.isLocked,
@@ -154,7 +155,7 @@ export class SoundManager {
   /**
    * Adds event listeners to unlock audio context.
    */
-  addUnlockHandlers = () => {
+  public addUnlockHandlers = () => {
     this.isLocked = true;
     this.game.logger.info('addUnlockHandlers', {
       state: this.context.state,
@@ -168,7 +169,7 @@ export class SoundManager {
   /**
    * Removes event listeners that unlock audio context.
    */
-  removeUnlockHandlers = () => {
+  public removeUnlockHandlers = () => {
     this.isLocked = false;
     this.game.logger.info('removeUnlockHandlers', {
       state: this.context.state,
@@ -183,7 +184,7 @@ export class SoundManager {
    * Handles unlock events to resume audio context.
    * @param {Event} event - The DOM event that triggered the unlock.
    */
-  onUnlockEvent = (event: Event) => {
+  public onUnlockEvent = (event: Event) => {
     const initialState = this.context.state;
     if (initialState !== 'suspended' && initialState !== 'interrupted') {
       this.game.logger.info('onUnlockResumeDenied', {
@@ -217,7 +218,8 @@ export class SoundManager {
           error,
         });
         this.removeUnlockHandlers();
-        this.game.logger.exception('', error, {
+        this.game.logger.fatal('SoundManager', {
+          error,
           tags: { 'audio.initialState': initialState, 'audio.state': this.context.state },
         });
       });
@@ -226,7 +228,7 @@ export class SoundManager {
   /**
    * Stops all sounds in the manager.
    */
-  stopAll() {
+  public stopAll() {
     if (this.noAudio) {
       return;
     }
@@ -240,7 +242,7 @@ export class SoundManager {
   /**
    * Pauses all sounds in the manager.
    */
-  pauseAll() {
+  public pauseAll() {
     if (this.noAudio) {
       return;
     }
@@ -254,7 +256,7 @@ export class SoundManager {
   /**
    * Resumes all sounds in the manager.
    */
-  resumeAll() {
+  public resumeAll() {
     if (this.noAudio) {
       return;
     }
@@ -269,7 +271,7 @@ export class SoundManager {
    * Decodes an audio file for playback.
    * @param {string} key - The key of the sound to decode.
    */
-  decode(key: string) {
+  public decode(key: string) {
     const soundData = this.game.cache.getSoundData(key);
     if (!soundData) {
       return;
@@ -285,7 +287,7 @@ export class SoundManager {
       })
       .catch((error: unknown) => {
         const typedError = error instanceof Error ? error : new Error(String(error));
-        this.game.logger.exception('SoundManager', typedError, { tags: { 'asset.key': key } });
+        this.game.logger.fatal('SoundManager', { error: typedError, tags: { 'asset.key': key } });
         if (typedError.name === 'InvalidStateError') {
           addPageLifecycleCallback(PAGE_LIFECYCLE_STATE_ACTIVE, () => {
             this.decode(key);
@@ -302,7 +304,7 @@ export class SoundManager {
    * @param {Function} callback - The callback function to call when all files are decoded.
    * @param {object} callbackContext - The context in which to call the callback.
    */
-  setDecodedCallback(files: any, callback: Function, callbackContext: any) {
+  public setDecodedCallback(files: any, callback: Function, callbackContext: any) {
     if (typeof files === 'string') {
       files = [files];
     }
@@ -330,7 +332,7 @@ export class SoundManager {
   /**
    * Updates the sound manager state.
    */
-  update() {
+  public update() {
     if (this.noAudio) {
       return;
     }
@@ -361,7 +363,7 @@ export class SoundManager {
    * @param {boolean} connect - Whether to connect to the master gain node.
    * @returns {Sound} The created Sound object.
    */
-  add(key: string, volume: number = 1, loop: boolean = false, connect: boolean = this.connectToMaster) {
+  public add(key: string, volume = 1, loop = false, connect: boolean = this.connectToMaster) {
     const sound = new Sound(this.game, key, volume, loop, connect);
     this._sounds.push(sound);
     return sound;
@@ -372,7 +374,7 @@ export class SoundManager {
    * @param {string} key - The key of the sound sprite to add.
    * @returns {SoundSprite} The created SoundSprite object.
    */
-  addSprite(key: string) {
+  public addSprite(key: string) {
     return new SoundSprite(this.game, key);
   }
 
@@ -381,7 +383,7 @@ export class SoundManager {
    * @param {Sound | null | undefined} sound - The sound object to remove.
    * @returns {boolean} True if the sound was removed, false otherwise.
    */
-  remove(sound: Sound | null | undefined) {
+  public remove(sound: Sound | null | undefined) {
     let i = this._sounds.length;
     while (i) {
       i -= 1;
@@ -399,7 +401,7 @@ export class SoundManager {
    * @param {string} key - The key of sounds to remove.
    * @returns {number} The number of sounds removed.
    */
-  removeByKey(key: string) {
+  public removeByKey(key: string) {
     let i = this._sounds.length;
     let removed = 0;
     while (i) {
@@ -420,7 +422,7 @@ export class SoundManager {
    * @param {boolean} loop - Whether the sound should loop.
    * @returns {Sound} The created Sound object, or null if audio is disabled.
    */
-  play(key: string, volume: number = 1, loop: boolean = false) {
+  public play(key: string, volume = 1, loop = false) {
     if (this.noAudio) {
       return null;
     }
@@ -432,7 +434,7 @@ export class SoundManager {
   /**
    * Mutes all sounds in the manager.
    */
-  setMute() {
+  public setMute() {
     if (this._muted) {
       return;
     }
@@ -447,7 +449,7 @@ export class SoundManager {
   /**
    * Unmutes all sounds in the manager.
    */
-  unsetMute() {
+  public unsetMute() {
     if (!this._muted || this._codeMuted) {
       return;
     }
@@ -461,7 +463,7 @@ export class SoundManager {
   /**
    * Destroys the sound manager and cleans up resources.
    */
-  destroy() {
+  public destroy() {
     this.stopAll();
     for (let i = 0; i < this._sounds.length; i += 1) {
       if (this._sounds[i]) {
@@ -479,14 +481,14 @@ export class SoundManager {
    * Gets the muted state of the sound manager.
    * @returns {boolean} True if the manager is muted, false otherwise.
    */
-  get mute() {
+  public get mute() {
     return this._muted;
   }
 
   /**
    * Sets the muted state of the sound manager.
    */
-  set mute(value) {
+  public set mute(value) {
     if (value || false) {
       if (this._muted) {
         return;
@@ -506,14 +508,14 @@ export class SoundManager {
    * Gets the volume level of the sound manager.
    * @returns {number} The volume level (0.0 to 1.0).
    */
-  get volume() {
+  public get volume() {
     return this._volume;
   }
 
   /**
    * Sets the volume level of the sound manager.
    */
-  set volume(value) {
+  public set volume(value) {
     if (value < 0) {
       value = 0;
     } else if (value > 1) {

package/src/phaser/core/sound_sprite.ts

@@ -1,24 +1,25 @@
+import type { Game } from './game.js';
 export class SoundSprite {
-  game!: any;
-  key!: any;
-  config!: any;
-  autoplayKey!: any;
-  autoplay!: any;
-  sounds!: any;
+  public game!: any;
+  public key!: any;
+  public config!: any;
+  public autoplayKey!: any;
+  public autoplay!: any;
+  public sounds!: any;
   /**
    * TBD.
-   * @param {import('./game.js').Game} game - TBD.
+   * @param {Game} game - TBD.
    * @param {string} key - TBD.
    */
-  constructor(game: import('./game.js').Game, key: string) {
+  public constructor(game: Game, key: string) {
     this.game = game;
     this.key = key;
     this.config = this.game.cache.getJSON(`${key}-audioatlas`);
     this.autoplayKey = null;
     this.autoplay = false;
-    /** @type {{[key: string]: import('./sound.js').Sound}} */
+    /** @type {{[key: string]: Sound}} */
     this.sounds = {};
-    for (let k in this.config.spritemap) {
+    for (const k in this.config.spritemap) {
       const marker = this.config.spritemap[k];
       const sound = this.game.sound.add(this.key);
       sound.addMarker(k, marker.start, marker.end - marker.start, null, marker.loop);
@@ -35,9 +36,9 @@ export class SoundSprite {
    * TBD.
    * @param {string} marker - TBD.
    * @param {number} volume - TBD.
-   * @returns {import('./sound.js').Sound} TBD.
+   * @returns {Sound} TBD.
    */
-  play(marker: string, volume: number = 1) {
+  public play(marker: string, volume = 1) {
     return this.sounds[marker].play(marker, null, volume);
   }
 
@@ -45,9 +46,9 @@ export class SoundSprite {
    * TBD.
    * @param {string} marker - TBD.
    */
-  stop(marker: string) {
+  public stop(marker: string) {
     if (!marker) {
-      for (let key in this.sounds) {
+      for (const key in this.sounds) {
         this.sounds[key].stop();
       }
     } else {
@@ -58,9 +59,9 @@ export class SoundSprite {
   /**
    * TBD.
    * @param {string} marker - TBD.
-   * @returns {import('./sound.js').Sound} TBD.
+   * @returns {Sound} TBD.
    */
-  get(marker: string) {
+  public get(marker: string) {
     return this.sounds[marker];
   }
 }

package/src/phaser/core/stage.ts

@@ -3,17 +3,18 @@ import { DisplayObject } from '../display/display_object.js';
 import { Matrix } from '../geom/matrix.js';
 import { valueToColor } from '../util/math.js';
 import { SCALE_LINEAR, SCALE_NEAREST } from './const.js';
+import type { Game } from './game.js';
 
 export class Stage extends DisplayObject {
-  declare name: any;
-  declare worldTransform: any;
-  currentRenderOrderID!: any;
-  _bgColor!: any;
+  declare public name: any;
+  declare public worldTransform: any;
+  public currentRenderOrderID!: any;
+  public _bgColor!: any;
   /**
    * Creates a new Stage instance.
-   * @param {import('./game.js').Game} game - The game instance.
+   * @param {Game} game - The game instance.
    */
-  constructor(game: import('./game.js').Game) {
+  public constructor(game: Game) {
     super(game);
     this.name = '_stage_root';
     this.worldTransform = new Matrix();
@@ -39,7 +40,7 @@ export class Stage extends DisplayObject {
    * Sets the background color of the stage.
    * @param {number} color - The color to set as the background.
    */
-  setBackgroundColor(color: number) {
+  public setBackgroundColor(color: number) {
     if (this.game.config.transparent) {
       return;
     }
@@ -54,7 +55,7 @@ export class Stage extends DisplayObject {
   /**
    * Initializes the stage after game creation.
    */
-  boot() {
+  public boot() {
     setUserSelect(this.game.canvas, 'none');
     setTouchAction(this.game.canvas, 'none');
   }
@@ -62,31 +63,31 @@ export class Stage extends DisplayObject {
   /**
    * Pre-updates the stage and its children.
    */
-  override preUpdate() {
+  public override preUpdate() {
     this.currentRenderOrderID = 0;
     //  This can't loop in reverse, we need the renderOrderID to be in sequence
     for (let i = 0; i < this.children.length; i += 1) {
-      this.children[i].preUpdate();
+      this.children[i]!.preUpdate();
     }
   }
 
   /**
    * Updates the stage and its children.
    */
-  override update() {
+  public override update() {
     let i = this.children.length;
     while (i) {
       i -= 1;
-      this.children[i].update();
+      this.children[i]!.update();
     }
   }
 
   /**
    * Post-updates the stage and its children.
    */
-  override postUpdate() {
+  public override postUpdate() {
     for (let i = 0; i < this.children.length; i += 1) {
-      this.children[i].postUpdate();
+      this.children[i]!.postUpdate();
     }
     this.updateTransform();
   }
@@ -94,10 +95,10 @@ export class Stage extends DisplayObject {
   /**
    * Updates the stage's transformation matrix.
    */
-  override updateTransform(): this {
+  public override updateTransform(): this {
     this.worldAlpha = 1;
-    for (let i = 0; i < this.children.length; i += 1) {
-      this.children[i].updateTransform();
+    for (const child of this.children) {
+      child.updateTransform();
     }
     return this;
   }
@@ -105,7 +106,7 @@ export class Stage extends DisplayObject {
   /**
    * Destroys the stage and cleans up resources.
    */
-  override destroy() {
+  public override destroy() {
     this.exists = false;
     this.game = null!;
     this.worldTransform = null;
@@ -116,14 +117,14 @@ export class Stage extends DisplayObject {
    * Gets the background color of the stage.
    * @returns {number} The background color.
    */
-  get backgroundColor() {
+  public get backgroundColor() {
     return this._bgColor.color;
   }
 
   /**
    * Sets the background color of the stage.
    */
-  set backgroundColor(value) {
+  public set backgroundColor(value) {
     this.setBackgroundColor(value);
   }
 
@@ -131,14 +132,14 @@ export class Stage extends DisplayObject {
    * Gets whether texture smoothing is enabled.
    * @returns {boolean} True if texture smoothing is enabled, false otherwise.
    */
-  get smoothed() {
-    return window.PhaserRegistry.TEXTURE_SCALE_MODE === SCALE_LINEAR;
+  public get smoothed() {
+    return globalThis.PhaserRegistry.TEXTURE_SCALE_MODE === SCALE_LINEAR;
   }
 
   /**
    * Sets whether texture smoothing is enabled.
    */
-  set smoothed(value) {
-    window.PhaserRegistry.TEXTURE_SCALE_MODE = value ? SCALE_LINEAR : SCALE_NEAREST;
+  public set smoothed(value) {
+    globalThis.PhaserRegistry.TEXTURE_SCALE_MODE = value ? SCALE_LINEAR : SCALE_NEAREST;
   }
 }