@vpmedia/phaser 1.115.0 → 1.117.0

package/src/phaser/core/sound_manager.ts

@@ -14,24 +14,24 @@ import { SoundSprite } from './sound_sprite.js';
 
 export class SoundManager {
   public game!: Game;
-  public onChange!: any;
+  public onChange!: Signal;
   public context!: AudioContext | null;
-  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;
+  public baseLatency!: number;
+  public noAudio!: boolean;
+  public type!: number;
+  public connectToMaster!: boolean;
+  public isLocked!: boolean;
+  public _codeMuted!: boolean;
+  public _muted!: boolean;
+  public _unlockSource!: AudioBufferSourceNode | null;
+  public _volume!: number;
+  public _sounds!: Sound[];
+  public _watchList!: ArraySet;
+  public _watching!: boolean;
+  public _watchCallback!: Function | null;
+  public _watchContext!: unknown;
+  public masterGain!: GainNode;
+  public _muteVolume!: number;
   /**
    * Creates a new SoundManager instance.
    * @param {Game} game - Reference to the Phaser Game instance.
@@ -62,8 +62,8 @@ export class SoundManager {
   /**
    * Initializes the sound manager and sets up audio context.
    */
-  public boot() {
-    const setAudioDisabledState = () => {
+  public boot(): void {
+    const setAudioDisabledState = (): void => {
       this.type = AUDIO_DISABLED;
       this.noAudio = true;
       this.isLocked = false;
@@ -120,7 +120,7 @@ export class SoundManager {
   /**
    * Handles page lifecycle changes for audio management.
    */
-  public onPageLifecycleChange = () => {
+  public onPageLifecycleChange = (): void => {
     if (!document.hidden) {
       this.checkUnlockHandlers();
     }
@@ -129,7 +129,7 @@ export class SoundManager {
   /**
    * Handles audio context state changes.
    */
-  public onContextStateChange = () => {
+  public onContextStateChange = (): void => {
     this.game.logger.info('onContextStateChange', {
       state: this.context!.state,
       isLocked: this.isLocked,
@@ -140,7 +140,7 @@ export class SoundManager {
   /**
    * Checks if audio unlock handlers need to be added or removed.
    */
-  public checkUnlockHandlers = () => {
+  public checkUnlockHandlers = (): void => {
     this.game.logger.info('checkUnlockHandlers', {
       state: this.context!.state,
       isLocked: this.isLocked,
@@ -155,7 +155,7 @@ export class SoundManager {
   /**
    * Adds event listeners to unlock audio context.
    */
-  public addUnlockHandlers = () => {
+  public addUnlockHandlers = (): void => {
     this.isLocked = true;
     this.game.logger.info('addUnlockHandlers', {
       state: this.context!.state,
@@ -169,7 +169,7 @@ export class SoundManager {
   /**
    * Removes event listeners that unlock audio context.
    */
-  public removeUnlockHandlers = () => {
+  public removeUnlockHandlers = (): void => {
     this.isLocked = false;
     this.game.logger.info('removeUnlockHandlers', {
       state: this.context!.state,
@@ -184,7 +184,7 @@ export class SoundManager {
    * Handles unlock events to resume audio context.
    * @param {Event} event - The DOM event that triggered the unlock.
    */
-  public onUnlockEvent = (event: Event) => {
+  public onUnlockEvent = (event: Event): void => {
     const initialState = this.context!.state;
     if (initialState !== 'suspended' && initialState !== 'interrupted') {
       this.game.logger.info('onUnlockResumeDenied', {
@@ -201,7 +201,7 @@ export class SoundManager {
       event,
     });
     this.context!.resume()
-      .then(() => {
+      .then((): void => {
         this.game.logger.info('onContextResumeResult', {
           initialState,
           state: this.context!.state,
@@ -209,7 +209,7 @@ export class SoundManager {
         });
         this.removeUnlockHandlers();
       })
-      .catch((error: unknown) => {
+      .catch((error: unknown): void => {
         this.game.logger.info('onContextResumeReject', {
           initialState,
           state: this.context!.state,
@@ -227,13 +227,13 @@ export class SoundManager {
   /**
    * Stops all sounds in the manager.
    */
-  public stopAll() {
+  public stopAll(): void {
     if (this.noAudio) {
       return;
     }
-    for (let i = 0; i < this._sounds.length; i += 1) {
-      if (this._sounds[i]) {
-        this._sounds[i].stop();
+    for (const sound of this._sounds) {
+      if (sound) {
+        sound.stop();
       }
     }
   }
@@ -241,13 +241,13 @@ export class SoundManager {
   /**
    * Pauses all sounds in the manager.
    */
-  public pauseAll() {
+  public pauseAll(): void {
     if (this.noAudio) {
       return;
     }
-    for (let i = 0; i < this._sounds.length; i += 1) {
-      if (this._sounds[i]) {
-        this._sounds[i].pause();
+    for (const sound of this._sounds) {
+      if (sound) {
+        sound.pause();
       }
     }
   }
@@ -255,13 +255,13 @@ export class SoundManager {
   /**
    * Resumes all sounds in the manager.
    */
-  public resumeAll() {
+  public resumeAll(): void {
     if (this.noAudio) {
       return;
     }
-    for (let i = 0; i < this._sounds.length; i += 1) {
-      if (this._sounds[i]) {
-        this._sounds[i].resume();
+    for (const sound of this._sounds) {
+      if (sound) {
+        sound.resume();
       }
     }
   }
@@ -270,7 +270,7 @@ export class SoundManager {
    * Decodes an audio file for playback.
    * @param {string} key - The key of the sound to decode.
    */
-  public decode(key: string) {
+  public decode(key: string): void {
     const soundData = this.game.cache.getSoundData(key);
     if (!soundData) {
       return;
@@ -280,14 +280,14 @@ export class SoundManager {
     }
     this.game.cache.updateSound(key, 'isDecoding', true);
     this.context!.decodeAudioData(soundData)
-      .then((buffer: AudioBuffer) => {
+      .then((buffer: AudioBuffer): void => {
         this.game.cache.decodedSound(key, buffer);
       })
-      .catch((error: unknown) => {
+      .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, () => {
+          addPageLifecycleCallback(PAGE_LIFECYCLE_STATE_ACTIVE, (): void => {
             this.decode(key);
           });
         } else if (typedError.name === 'EncodingError') {
@@ -302,18 +302,17 @@ 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.
    */
-  public setDecodedCallback(files: any, callback: Function, callbackContext: unknown) {
-    if (typeof files === 'string') {
-      files = [files];
-    }
+  public setDecodedCallback(
+    files: string | string[] | Sound | Sound[],
+    callback: Function,
+    callbackContext: unknown
+  ): void {
+    const candidates: (string | Sound)[] = typeof files === 'string' ? [files] : Array.isArray(files) ? files : [files];
     this._watchList.reset();
-    for (let i = 0; i < files.length; i += 1) {
-      if (files[i] instanceof Sound) {
-        if (!this.game.cache.isSoundDecoded(files[i].key)) {
-          this._watchList.add(files[i].key);
-        }
-      } else if (!this.game.cache.isSoundDecoded(files[i])) {
-        this._watchList.add(files[i]);
+    for (const file of candidates) {
+      const key = file instanceof Sound ? file.key : file;
+      if (!this.game.cache.isSoundDecoded(key)) {
+        this._watchList.add(key);
       }
     }
     //  All decoded already?
@@ -330,12 +329,12 @@ export class SoundManager {
   /**
    * Updates the sound manager state.
    */
-  public update() {
+  public update(): void {
     if (this.noAudio) {
       return;
     }
-    for (let i = 0; i < this._sounds.length; i += 1) {
-      this._sounds[i].update();
+    for (const sound of this._sounds) {
+      sound.update();
     }
     if (this._watching) {
       let key = this._watchList.first;
@@ -348,7 +347,7 @@ export class SoundManager {
       if (this._watchList.total === 0) {
         this.game.logger.info('All sounds decoded');
         this._watching = false;
-        this._watchCallback.call(this._watchContext);
+        this._watchCallback?.call(this._watchContext);
       }
     }
   }
@@ -361,7 +360,7 @@ export class SoundManager {
    * @param {boolean} connect - Whether to connect to the master gain node.
    * @returns {Sound} The created Sound object.
    */
-  public add(key: string, volume = 1, loop = false, connect: boolean = this.connectToMaster) {
+  public add(key: string, volume = 1, loop = false, connect: boolean = this.connectToMaster): Sound {
     const sound = new Sound(this.game, key, volume, loop, connect);
     this._sounds.push(sound);
     return sound;
@@ -372,7 +371,7 @@ export class SoundManager {
    * @param {string} key - The key of the sound sprite to add.
    * @returns {SoundSprite} The created SoundSprite object.
    */
-  public addSprite(key: string) {
+  public addSprite(key: string): SoundSprite {
     return new SoundSprite(this.game, key);
   }
 
@@ -381,12 +380,12 @@ export class SoundManager {
    * @param {Sound | null | undefined} sound - The sound object to remove.
    * @returns {boolean} True if the sound was removed, false otherwise.
    */
-  public remove(sound: Sound | null | undefined) {
+  public remove(sound: Sound | null | undefined): boolean {
     let i = this._sounds.length;
     while (i) {
       i -= 1;
       if (this._sounds[i] === sound) {
-        this._sounds[i].destroy(false);
+        this._sounds[i]!.destroy(false);
         this._sounds.splice(i, 1);
         return true;
       }
@@ -399,13 +398,13 @@ export class SoundManager {
    * @param {string} key - The key of sounds to remove.
    * @returns {number} The number of sounds removed.
    */
-  public removeByKey(key: string) {
+  public removeByKey(key: string): number {
     let i = this._sounds.length;
     let removed = 0;
     while (i) {
       i -= 1;
-      if (this._sounds[i].key === key) {
-        this._sounds[i].destroy(false);
+      if (this._sounds[i]!.key === key) {
+        this._sounds[i]!.destroy(false);
         this._sounds.splice(i, 1);
         removed += 1;
       }
@@ -420,7 +419,7 @@ export class SoundManager {
    * @param {boolean} loop - Whether the sound should loop.
    * @returns {Sound} The created Sound object, or null if audio is disabled.
    */
-  public play(key: string, volume = 1, loop = false) {
+  public play(key: string, volume = 1, loop = false): Sound | null {
     if (this.noAudio) {
       return null;
     }
@@ -432,7 +431,7 @@ export class SoundManager {
   /**
    * Mutes all sounds in the manager.
    */
-  public setMute() {
+  public setMute(): void {
     if (this._muted) {
       return;
     }
@@ -447,7 +446,7 @@ export class SoundManager {
   /**
    * Unmutes all sounds in the manager.
    */
-  public unsetMute() {
+  public unsetMute(): void {
     if (!this._muted || this._codeMuted) {
       return;
     }
@@ -461,11 +460,11 @@ export class SoundManager {
   /**
    * Destroys the sound manager and cleans up resources.
    */
-  public destroy() {
+  public destroy(): void {
     this.stopAll();
-    for (let i = 0; i < this._sounds.length; i += 1) {
-      if (this._sounds[i]) {
-        this._sounds[i].destroy();
+    for (const sound of this._sounds) {
+      if (sound) {
+        sound.destroy();
       }
     }
     this._sounds = [];

package/src/phaser/core/sound_sprite.ts

@@ -46,7 +46,7 @@ export class SoundSprite {
    * TBD.
    * @param {string} marker - TBD.
    */
-  public stop(marker: string) {
+  public stop(marker: string): void {
     if (!marker) {
       for (const key in this.sounds) {
         this.sounds[key].stop();

package/src/phaser/core/stage.ts

@@ -40,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.
    */
-  public setBackgroundColor(color: number) {
+  public setBackgroundColor(color: number): void {
     if (this.game.config.transparent) {
       return;
     }
@@ -55,7 +55,7 @@ export class Stage extends DisplayObject {
   /**
    * Initializes the stage after game creation.
    */
-  public boot() {
+  public boot(): void {
     setUserSelect(this.game.canvas, 'none');
     setTouchAction(this.game.canvas, 'none');
   }
@@ -63,7 +63,7 @@ export class Stage extends DisplayObject {
   /**
    * Pre-updates the stage and its children.
    */
-  public override preUpdate() {
+  public override preUpdate(): void {
     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) {
@@ -74,7 +74,7 @@ export class Stage extends DisplayObject {
   /**
    * Updates the stage and its children.
    */
-  public override update() {
+  public override update(): void {
     let i = this.children.length;
     while (i) {
       i -= 1;
@@ -85,7 +85,7 @@ export class Stage extends DisplayObject {
   /**
    * Post-updates the stage and its children.
    */
-  public override postUpdate() {
+  public override postUpdate(): void {
     for (let i = 0; i < this.children.length; i += 1) {
       this.children[i]!.postUpdate();
     }
@@ -106,7 +106,7 @@ export class Stage extends DisplayObject {
   /**
    * Destroys the stage and cleans up resources.
    */
-  public override destroy() {
+  public override destroy(): void {
     this.exists = false;
     this.game = null!;
     this.worldTransform = null;
@@ -132,7 +132,7 @@ export class Stage extends DisplayObject {
    * Gets whether texture smoothing is enabled.
    * @returns {boolean} True if texture smoothing is enabled, false otherwise.
    */
-  public get smoothed() {
+  public get smoothed(): boolean {
     return globalThis.PhaserRegistry.TEXTURE_SCALE_MODE === SCALE_LINEAR;
   }
 

package/src/phaser/core/time.ts

@@ -66,7 +66,7 @@ export class Time {
   /**
    * Initializes the time manager and starts tracking time.
    */
-  public boot() {
+  public boot(): void {
     this._started = Date.now();
     this.time = Date.now();
     this.events.start();
@@ -78,7 +78,7 @@ export class Time {
    * @param {Timer} timer - The Timer to add.
    * @returns {Timer} The added Timer object.
    */
-  public add(timer: Timer) {
+  public add(timer: Timer): Timer {
     this._timers.push(timer);
     return timer;
   }
@@ -88,7 +88,7 @@ export class Time {
    * @param {boolean} autoDestroy - Whether the timer should be automatically destroyed when it completes.
    * @returns {Timer} The created Timer object.
    */
-  public create(autoDestroy = true) {
+  public create(autoDestroy = true): Timer {
     const timer = new Timer(this.game, autoDestroy);
     this._timers.push(timer);
     return timer;
@@ -97,7 +97,7 @@ export class Time {
   /**
    * Removes all timers from the Time manager.
    */
-  public removeAll() {
+  public removeAll(): void {
     for (const timer of this._timers) {
       timer.destroy();
     }
@@ -108,7 +108,7 @@ export class Time {
   /**
    * Refreshes the time tracking values.
    */
-  public refresh() {
+  public refresh(): void {
     const previousDateNow = this.time;
     // this.time always holds a Date.now value
     this.time = Date.now();
@@ -120,7 +120,7 @@ export class Time {
    * Updates the Time manager with a new timestamp.
    * @param {number} time - The new timestamp to use for updating.
    */
-  public update(time: number) {
+  public update(time: number): void {
     const previousDateNow = this.time;
     // this.time always holds a Date.now value
     this.time = Date.now();
@@ -149,7 +149,7 @@ export class Time {
   /**
    * Updates all timers managed by the Time manager.
    */
-  public updateTimers() {
+  public updateTimers(): void {
     let i = 0;
     let len = this._timers.length;
     while (i < len) {
@@ -166,7 +166,7 @@ export class Time {
   /**
    * Updates the advanced timing values.
    */
-  public updateAdvancedTiming() {
+  public updateAdvancedTiming(): void {
     // count the number of time.update calls
     this._frameCount += 1;
     this._elapsedAccumulator += this.elapsed;
@@ -192,7 +192,7 @@ export class Time {
   /**
    * Handles game pause event.
    */
-  public gamePaused() {
+  public gamePaused(): void {
     this._pauseStarted = Date.now();
     this.events.pause();
     let i = this._timers.length;
@@ -205,7 +205,7 @@ export class Time {
   /**
    * Handles game resume event.
    */
-  public gameResumed() {
+  public gameResumed(): void {
     this.time = Date.now();
     this.pauseDuration = this.time - this._pauseStarted;
     this.events.resume();
@@ -220,7 +220,7 @@ export class Time {
    * Gets the total elapsed time in seconds since the game started.
    * @returns {number} The total elapsed time in seconds.
    */
-  public totalElapsedSeconds() {
+  public totalElapsedSeconds(): number {
     return (this.time - this._started) * 0.001;
   }
 
@@ -229,7 +229,7 @@ export class Time {
    * @param {number} since - The timestamp to calculate elapsed time from.
    * @returns {number} The elapsed time in milliseconds.
    */
-  public elapsedSince(since: number) {
+  public elapsedSince(since: number): number {
     return this.time - since;
   }
 
@@ -238,14 +238,14 @@ export class Time {
    * @param {number} since - The timestamp to calculate elapsed time from.
    * @returns {number} The elapsed time in seconds.
    */
-  public elapsedSecondsSince(since: number) {
+  public elapsedSecondsSince(since: number): number {
     return (this.time - since) * 0.001;
   }
 
   /**
    * Resets the time tracking values.
    */
-  public reset() {
+  public reset(): void {
     this._started = this.time;
     this.removeAll();
   }
@@ -253,7 +253,7 @@ export class Time {
   /**
    * Destroys the Time manager and cleans up resources.
    */
-  public destroy() {
+  public destroy(): void {
     this.reset();
   }
 
@@ -261,7 +261,7 @@ export class Time {
    * Gets the desired frames per second.
    * @returns {number} The desired frames per second.
    */
-  public get desiredFps() {
+  public get desiredFps(): number {
     return this._desiredFps;
   }