@vpmedia/phaser 1.116.0 → 1.118.0

package/src/phaser/core/scene_manager.ts

@@ -59,7 +59,7 @@ export class SceneManager {
    * Initialize the scene manager.
    * This method is called when the game boots and sets up the initial state.
    */
-  public boot() {
+  public boot(): void {
     if (this._pendingState !== null && typeof this._pendingState !== 'string') {
       this.add('default', this._pendingState, true);
     }
@@ -97,7 +97,7 @@ export class SceneManager {
    * Remove a scene state from the manager.
    * @param {string} key - The unique key for the state to remove.
    */
-  public remove(key: string) {
+  public remove(key: string): void {
     if (this.current === key) {
       this.onInitCallback = null;
       this.onShutDownCallback = null;
@@ -117,7 +117,7 @@ export class SceneManager {
    * @param {boolean} clearCache - Whether to clear the cache before starting.
    * @param {...any} args - Additional arguments to pass to the state.
    */
-  public start(key: string, clearWorld = true, clearCache = false, ...args: unknown[]) {
+  public start(key: string, clearWorld = true, clearCache = false, ...args: unknown[]): void {
     if (this.checkState(key)) {
       //  Place the state in the queue. It will be started the next time the game loop begins.
       this._pendingState = key;
@@ -135,7 +135,7 @@ export class SceneManager {
    * @param {boolean} clearCache - Whether to clear the cache before restarting.
    * @param {...any} args - Additional arguments to pass to the state.
    */
-  public restart(clearWorld = true, clearCache = false, ...args: unknown[]) {
+  public restart(clearWorld = true, clearCache = false, ...args: unknown[]): void {
     this._pendingState = this.current;
     this._clearWorld = clearWorld;
     this._clearCache = clearCache;
@@ -148,7 +148,7 @@ export class SceneManager {
    * Pre-update the scene manager.
    * This method is called before the game loop updates.
    */
-  public preUpdate() {
+  public preUpdate(): void {
     if (this._pendingState && this.game.isBooted) {
       // var previousStateKey = this.current;
       //  Already got a state running?
@@ -183,7 +183,7 @@ export class SceneManager {
    * Clear the current scene state.
    * This method is called when switching scenes to clean up the previous scene.
    */
-  public clearCurrentState() {
+  public clearCurrentState(): void {
     if (this.current) {
       if (this.onShutDownCallback) {
         this.onShutDownCallback.call(this.callbackContext, this.game);
@@ -206,7 +206,7 @@ export class SceneManager {
    * @param {string} key - The unique key for the state to check.
    * @returns {boolean} True if the scene exists, false otherwise.
    */
-  public checkState(key: string) {
+  public checkState(key: string): boolean {
     if (this.states[key]) {
       if (this.states[key].preload || this.states[key].create || this.states[key].update || this.states[key].render) {
         return true;
@@ -220,7 +220,7 @@ export class SceneManager {
    * Link a scene state to the manager.
    * @param {string} key - The unique key for the state to link.
    */
-  public link(key: string) {
+  public link(key: string): void {
     this.states[key].game = this.game;
     this.states[key].key = key;
   }
@@ -229,7 +229,7 @@ export class SceneManager {
    * Unlink a scene state from the manager.
    * @param {string} key - The unique key for the state to unlink.
    */
-  public unlink(key: string) {
+  public unlink(key: string): void {
     if (this.states[key]) {
       this.states[key].game = null;
     }
@@ -239,7 +239,7 @@ export class SceneManager {
    * Set the current scene state.
    * @param {string} key - The unique key for the state to set as current.
    */
-  public setCurrentState(key: string) {
+  public setCurrentState(key: string): void {
     this.callbackContext = this.states[key];
     this.link(key);
     //  Used when the state is set as being the current active state
@@ -272,7 +272,7 @@ export class SceneManager {
    * Handle loading completion.
    * This method is called when scene loading is complete.
    */
-  public loadComplete() {
+  public loadComplete(): void {
     if (this._created === false && this.onCreateCallback) {
       this._created = true;
       this.onCreateCallback.call(this.callbackContext, this.game);
@@ -285,7 +285,7 @@ export class SceneManager {
    * Update the scene manager.
    * This method is called every frame while the game is running.
    */
-  public update() {
+  public update(): void {
     if (this._created && this.onUpdateCallback) {
       this.onUpdateCallback.call(this.callbackContext, this.game);
     }
@@ -295,7 +295,7 @@ export class SceneManager {
    * Pause the scene manager updates.
    * This method is called when the game is paused.
    */
-  public pauseUpdate() {
+  public pauseUpdate(): void {
     if (this._created && this.onPauseUpdateCallback) {
       this.onPauseUpdateCallback.call(this.callbackContext, this.game);
     }
@@ -306,7 +306,7 @@ export class SceneManager {
    * @param {number} width - The new width of the scene.
    * @param {number} height - The new height of the scene.
    */
-  public resize(width: number, height: number) {
+  public resize(width: number, height: number): void {
     if (this.onResizeCallback) {
       this.onResizeCallback.call(this.callbackContext, width, height);
     }
@@ -316,7 +316,7 @@ export class SceneManager {
    * Destroy the scene manager.
    * This method is called when the scene manager is about to be destroyed.
    */
-  public destroy() {
+  public destroy(): void {
     this._clearWorld = true;
     this._clearCache = true;
     this.clearCurrentState();
@@ -335,7 +335,7 @@ export class SceneManager {
    * Dummy function for callbacks.
    * This is a placeholder function used when no callback is defined.
    */
-  public dummy() {
+  public dummy(): void {
     // pass
   }
 

package/src/phaser/core/signal.ts

@@ -19,7 +19,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) {
+  public validateListener(listener: Function, 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)
@@ -43,7 +43,7 @@ export class Signal {
     listenerContext: unknown | null = null,
     priority = 0,
     args: any = null
-  ) {
+  ): SignalBinding {
     const prevIndex = this._indexOfListener(listener, listenerContext);
     let binding;
     const existing = prevIndex !== -1 && this._bindings ? this._bindings[prevIndex] : undefined;
@@ -70,7 +70,7 @@ export class Signal {
    * Add a binding to the list of listeners.
    * @param {SignalBinding} binding - The binding to add.
    */
-  public _addBinding(binding: SignalBinding) {
+  public _addBinding(binding: SignalBinding): void {
     this._bindings ??= [];
     //  Simplified insertion sort
     let n = this._bindings.length;
@@ -86,7 +86,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) {
+  public _indexOfListener(listener: Function, context: unknown = null): number {
     if (!this._bindings) {
       return -1;
     }
@@ -108,7 +108,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) {
+  public has(listener: Function, context: unknown = null): boolean {
     return this._indexOfListener(listener, context) !== -1;
   }
 
@@ -120,7 +120,12 @@ export class Signal {
    * @param {...any} args - Additional arguments to pass to the listener.
    * @returns {SignalBinding} The binding for this listener.
    */
-  public add(listener: Function, listenerContext: unknown | null = null, priority = 0, ...args: unknown[]) {
+  public add(
+    listener: Function,
+    listenerContext: unknown | null = null,
+    priority = 0,
+    ...args: unknown[]
+  ): SignalBinding {
     this.validateListener(listener, 'add');
     return this._registerListener(listener, false, listenerContext, priority, args);
   }
@@ -133,7 +138,12 @@ export class Signal {
    * @param {...any} args - Additional arguments to pass to the listener.
    * @returns {SignalBinding} The binding for this listener.
    */
-  public addOnce(listener: Function, listenerContext: unknown | null = null, priority = 0, ...args: unknown[]) {
+  public addOnce(
+    listener: Function,
+    listenerContext: unknown | null = null,
+    priority = 0,
+    ...args: unknown[]
+  ): SignalBinding {
     this.validateListener(listener, 'addOnce');
     return this._registerListener(listener, true, listenerContext, priority, args);
   }
@@ -144,7 +154,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) {
+  public remove(listener: Function, context: unknown = null): Function {
     this.validateListener(listener, 'remove');
     const i = this._indexOfListener(listener, context);
     if (i !== -1 && this._bindings) {
@@ -159,7 +169,7 @@ export class Signal {
    * Remove all listeners from the signal, or only those in a specific context.
    * @param {object} context - The context to filter listeners by, or null to remove all.
    */
-  public removeAll(context: unknown = null) {
+  public removeAll(context: unknown = null): void {
     if (!this._bindings) {
       return;
     }
@@ -184,7 +194,7 @@ export class Signal {
    * Get the number of listeners registered with the signal.
    * @returns {number} The number of registered listeners.
    */
-  public getNumListeners() {
+  public getNumListeners(): number {
     return this._bindings ? this._bindings.length : 0;
   }
 
@@ -192,7 +202,7 @@ export class Signal {
    * Stop the signal from propagating to other listeners.
    * This method prevents any remaining listeners from being called.
    */
-  public halt() {
+  public halt(): void {
     this._shouldPropagate = false;
   }
 
@@ -200,7 +210,7 @@ export class Signal {
    * Dispatch the signal to all registered listeners.
    * @param {...any} args - Arguments to pass to the listeners.
    */
-  public dispatch(...args: unknown[]) {
+  public dispatch(...args: unknown[]): void {
     if (!this.active || !this._bindings) {
       return;
     }
@@ -228,7 +238,7 @@ export class Signal {
    * Clear any previously memorized arguments.
    * This removes the stored arguments from a previous dispatch.
    */
-  public forget() {
+  public forget(): void {
     if (this._prevParams) {
       this._prevParams = null;
     }
@@ -238,7 +248,7 @@ export class Signal {
    * Dispose of the signal and clean up all resources.
    * This method removes all listeners and clears internal state.
    */
-  public dispose() {
+  public dispose(): void {
     this.removeAll();
     this.forget();
     this._bindings = null;
@@ -248,7 +258,7 @@ export class Signal {
    * Get a string representation of the signal.
    * @returns {string} A string representation of the signal.
    */
-  public toString() {
+  public toString(): string {
     return `[Signal active:${this.active} numListeners:${this.getNumListeners()}]`;
   }
 
@@ -258,7 +268,7 @@ export class Signal {
    */
   public get boundDispatch() {
     const _this = this;
-    this._boundDispatch ??= (...rest: unknown[]) => {
+    this._boundDispatch ??= (...rest: unknown[]): void => {
       _this.dispatch(...rest);
     };
     return this._boundDispatch;
@@ -268,9 +278,9 @@ export class Signal {
    * Promisify the Signal.
    * @returns {Promise<any>} The resolved result.
    */
-  public toPromise() {
-    return new Promise((resolve) => {
-      this.addOnce((...args: unknown[]) => {
+  public toPromise(): Promise<unknown> {
+    return new Promise((resolve): void => {
+      this.addOnce((...args: unknown[]): void => {
         resolve(args.length <= 1 ? args[0] : args);
       }, this);
     });

package/src/phaser/core/signal_binding.ts

@@ -72,7 +72,7 @@ export class SignalBinding {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public isBound() {
+  public isBound(): boolean {
     return Boolean(this._signal) && Boolean(this._listener);
   }
 
@@ -80,7 +80,7 @@ export class SignalBinding {
    * TBD.
    * @returns {boolean} TBD.
    */
-  public isOnce() {
+  public isOnce(): boolean {
     return this._isOnce;
   }
 
@@ -103,7 +103,7 @@ export class SignalBinding {
   /**
    * TBD.
    */
-  public _destroy() {
+  public _destroy(): void {
     delete this._signal;
     delete this._listener;
     delete this.context;
@@ -113,7 +113,7 @@ export class SignalBinding {
    * TBD.
    * @returns {string} TBD.
    */
-  public toString() {
+  public toString(): string {
     return `[SignalBinding isOnce:${this._isOnce}, isBound:${this.isBound()}, active:${this.active}]`;
   }
 }

package/src/phaser/core/sound.ts

@@ -2,13 +2,24 @@ import { Signal } from './signal.js';
 import type { Game } from './game.js';
 import type { Tween } from './tween.js';
 
+/** A named span within a sound file. */
+export type SoundMarker = {
+  name: string;
+  start: number;
+  stop: number;
+  volume: number;
+  duration: number;
+  durationMS: number;
+  loop: boolean;
+};
+
 export class Sound {
-  public _paused!: any;
+  public _paused!: boolean;
   public game!: Game;
   public name!: string;
   public key!: string;
   public loop!: boolean;
-  public markers!: any;
+  public markers!: Record<string, SoundMarker>;
   public context!: AudioContext | null;
   public autoplay!: boolean;
   public totalDuration!: number;
@@ -122,10 +133,12 @@ export class Sound {
    * Callback when a sound has been unlocked.
    * @param {string} key - The key of the sound that was unlocked.
    */
-  public soundHasUnlocked(key: string) {
+  public soundHasUnlocked(key: string): void {
     if (key === this.key) {
-      this._sound = this.game.cache.getSoundData(this.key);
-      this.totalDuration = (this._sound as any).duration;
+      // Unlocking parks the decoded buffer in _sound; play() replaces it with a real source node.
+      const buffer = this.game.cache.getSoundData(this.key) as AudioBuffer;
+      this._sound = buffer as unknown as AudioBufferSourceNode;
+      this.totalDuration = buffer.duration;
     }
   }
 
@@ -137,7 +150,7 @@ export class Sound {
    * @param {number} volume - The volume level (0.0 to 1.0) of the marker.
    * @param {boolean} loop - Whether the marker should loop.
    */
-  public addMarker(name: string, start: number, duration = 1, volume = 1, loop = false) {
+  public addMarker(name: string, start: number, duration = 1, volume = 1, loop = false): void {
     this.markers[name] = {
       name,
       start,
@@ -153,14 +166,14 @@ export class Sound {
    * Removes a marker from the sound.
    * @param {string} name - The name of the marker to remove.
    */
-  public removeMarker(name: string) {
+  public removeMarker(name: string): void {
     delete this.markers[name];
   }
 
   /**
    * Handler for when the sound ends.
    */
-  public onEndedHandler() {
+  public onEndedHandler(): void {
     this._sound.onended = null;
     this.isPlaying = false;
     this.currentTime = this.durationMS;
@@ -194,7 +207,7 @@ export class Sound {
   /**
    * Updates the sound state.
    */
-  public update() {
+  public update(): void {
     if (!this.game.cache.checkSoundKey(this.key)) {
       this.destroy();
       return;
@@ -233,7 +246,7 @@ export class Sound {
    * @param {number} volume - The volume level (0.0 to 1.0) to play at.
    * @returns {Sound} This Sound instance for chaining.
    */
-  public loopFull(volume: number) {
+  public loopFull(volume: number): this {
     return this.play(null, 0, volume, true);
   }
 
@@ -246,7 +259,7 @@ export class Sound {
    * @param {boolean} forceRestart - Whether to force restarting the sound even if it's already playing.
    * @returns {Sound} This Sound instance for chaining.
    */
-  public play(marker: any = '', position: any = 0, volume: any = 1, loop: any = false, forceRestart = true) {
+  public play(marker: string | false | null = '', position = 0, volume = 1, loop = false, forceRestart = true): this {
     if (marker === undefined || marker === false || marker === null) {
       marker = '';
     }
@@ -274,15 +287,16 @@ export class Sound {
       //  We should never play the entire thing
       return this;
     }
+    const markerData = marker === '' ? undefined : this.markers[marker];
     if (marker !== '') {
-      if (this.markers[marker]) {
+      if (markerData) {
         this.currentMarker = marker;
         //  Playing a marker? Then we default to the marker values
-        this.position = this.markers[marker].start;
-        this.volume = this.markers[marker].volume;
-        this.loop = this.markers[marker].loop;
-        this.duration = this.markers[marker].duration;
-        this.durationMS = this.markers[marker].durationMS;
+        this.position = markerData.start;
+        this.volume = markerData.volume;
+        this.loop = markerData.loop;
+        this.duration = markerData.duration;
+        this.durationMS = markerData.durationMS;
         if (volume !== undefined) {
           this.volume = volume;
         }
@@ -298,10 +312,8 @@ export class Sound {
         return this;
       }
     } else {
-      position = position ?? 0;
-      if (volume === undefined) {
-        volume = this._volume;
-      }
+      position ??= 0;
+      volume ??= this._volume;
       if (loop === undefined) {
         ({ loop } = this);
       }
@@ -323,7 +335,7 @@ export class Sound {
       } else {
         this._sound.connect(this.gainNode);
       }
-      this._buffer = this.game.cache.getSoundData(this.key);
+      this._buffer = this.game.cache.getSoundData(this.key) as AudioBuffer | null;
       this._sound.buffer = this._buffer;
       if (this.loop && marker === '') {
         this._sound.loop = true;
@@ -351,7 +363,7 @@ export class Sound {
       this.onPlay.dispatch(this);
     } else {
       this.pendingPlayback = true;
-      if (this.game.cache.getSound(this.key) && this.game.cache.getSound(this.key).isDecoding === false) {
+      if (this.game.cache.getSound(this.key)?.isDecoding === false) {
         this.game.sound.decode(this.key);
       }
     }
@@ -365,14 +377,14 @@ export class Sound {
    * @param {number} volume - The volume level (0.0 to 1.0) to play at.
    * @param {boolean} loop - Whether the sound should loop.
    */
-  public restart(marker = '', position = 0, volume = 1, loop = false) {
+  public restart(marker = '', position = 0, volume = 1, loop = false): void {
     this.play(marker, position, volume, loop, true);
   }
 
   /**
    * Pauses the sound.
    */
-  public pause() {
+  public pause(): void {
     if (this.isPlaying && this._sound) {
       this.paused = true;
       this.pausedPosition = this.currentTime;
@@ -386,7 +398,7 @@ export class Sound {
   /**
    * Resumes the sound.
    */
-  public resume() {
+  public resume(): void {
     if (this.paused && this._sound) {
       const p = Math.max(0, this.position + this.pausedPosition / 1000);
       this._sound = this.context!.createBufferSource();
@@ -418,7 +430,7 @@ export class Sound {
   /**
    * Stops the sound.
    */
-  public stop() {
+  public stop(): void {
     if (this.isPlaying && this._sound) {
       if (this._sound.stop === undefined) {
         (this._sound as any).noteOff(0);
@@ -452,7 +464,7 @@ export class Sound {
    * @param {boolean} loop - Whether the sound should loop.
    * @param {string} marker - The name of the marker to fade in, or empty string to use current marker.
    */
-  public fadeIn(duration: number, loop = false, marker: string = this.currentMarker) {
+  public fadeIn(duration: number, loop = false, marker: string = this.currentMarker): void {
     if (this.paused) {
       return;
     }
@@ -464,7 +476,7 @@ export class Sound {
    * Fades out the sound to silence.
    * @param {number} duration - The fade-out duration (in milliseconds).
    */
-  public fadeOut(duration: number) {
+  public fadeOut(duration: number): void {
     this.fadeTo(duration, 0);
   }
 
@@ -473,7 +485,7 @@ export class Sound {
    * @param {number} duration - The fade duration (in milliseconds).
    * @param {number} volume - The target volume level (0.0 to 1.0).
    */
-  public fadeTo(duration = 100, volume = 0) {
+  public fadeTo(duration = 100, volume = 0): void {
     if (!this.isPlaying || this.paused || volume === this.volume) {
       return;
     }
@@ -484,7 +496,7 @@ export class Sound {
   /**
    * Callback when fade completes.
    */
-  public fadeComplete() {
+  public fadeComplete(): void {
     this.onFadeComplete.dispatch(this, this.volume);
     if (this.volume === 0) {
       this.stop();
@@ -495,7 +507,7 @@ export class Sound {
    * Destroys the sound and cleans up resources.
    * @param {boolean} remove - Whether to remove the sound from the SoundManager.
    */
-  public destroy(remove = true) {
+  public destroy(remove = true): void {
     this._markedToDelete = true;
     this._removeFromSoundManager = remove;
     this.stop();
@@ -548,7 +560,7 @@ export class Sound {
    * Gets the volume of the sound.
    * @returns {number} The volume level (0.0 to 1.0).
    */
-  public get volume() {
+  public get volume(): number {
     return this._volume;
   }