@vpmedia/phaser 1.95.0 → 1.96.0

package/types/phaser/core/sound_manager.d.ts

@@ -1,7 +1,7 @@
 export class SoundManager {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
+     * Creates a new SoundManager instance.
+     * @param {import('./game.js').Game} game - Reference to the Phaser Game instance.
      */
     constructor(game: import("./game.js").Game);
     game: import("./game.js").Game;
@@ -24,127 +24,127 @@ export class SoundManager {
     _watchCallback: Function;
     _watchContext: any;
     /**
-     * TBD.
+     * Initializes the sound manager and sets up audio context.
      */
     boot(): void;
     masterGain: any;
     /**
-     * TBD.
+     * Handles page lifecycle changes for audio management.
      */
     onPageLifecycleChange: () => void;
     /**
-     * TBD.
+     * Handles audio context state changes.
      */
     onContextStateChange: () => void;
     /**
-     * TBD.
+     * Checks if audio unlock handlers need to be added or removed.
      */
     checkUnlockHandlers: () => void;
     /**
-     * TBD.
+     * Adds event listeners to unlock audio context.
      */
     addUnlockHandlers: () => void;
     /**
-     * TBD.
+     * Removes event listeners that unlock audio context.
      */
     removeUnlockHandlers: () => void;
     /**
-     * TBD.
-     * @param {Event} event - TBD.
+     * Handles unlock events to resume audio context.
+     * @param {Event} event - The DOM event that triggered the unlock.
      */
     onUnlockEvent: (event: Event) => void;
     /**
-     * TBD.
+     * Stops all sounds in the manager.
      */
     stopAll(): void;
     /**
-     * TBD.
+     * Pauses all sounds in the manager.
      */
     pauseAll(): void;
     /**
-     * TBD.
+     * Resumes all sounds in the manager.
      */
     resumeAll(): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Decodes an audio file for playback.
+     * @param {string} key - The key of the sound to decode.
      */
     decode(key: string): void;
     /**
-     * TBD.
-     * @param {Sound[]|string[]} files - TBD.
-     * @param {Function} callback - TBD.
-     * @param {object} callbackContext - TBD.
+     * Sets up a callback to be called when audio files are decoded.
+     * @param {Sound[]|string[]} files - The sound files or keys to wait for.
+     * @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: Sound[] | string[], callback: Function, callbackContext: object): void;
     /**
-     * TBD.
+     * Updates the sound manager state.
      */
     update(): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {number} volume - TBD.
-     * @param {boolean} loop - TBD.
-     * @param {boolean} connect - TBD.
-     * @returns {Sound} TBD.
+     * Adds a new sound to the manager.
+     * @param {string} key - The key of the sound to add.
+     * @param {number} volume - The initial volume level (0.0 to 1.0).
+     * @param {boolean} loop - Whether the sound should loop.
+     * @param {boolean} connect - Whether to connect to the master gain node.
+     * @returns {Sound} The created Sound object.
      */
     add(key: string, volume?: number, loop?: boolean, connect?: boolean): Sound;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {SoundSprite} TBD.
+     * Adds a new sound sprite to the manager.
+     * @param {string} key - The key of the sound sprite to add.
+     * @returns {SoundSprite} The created SoundSprite object.
      */
     addSprite(key: string): SoundSprite;
     /**
-     * TBD.
-     * @param {Sound | null | undefined} sound - TBD.
-     * @returns {boolean} TBD.
+     * Removes a sound from the manager.
+     * @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): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {number} TBD.
+     * Removes all sounds with a specific key from the manager.
+     * @param {string} key - The key of sounds to remove.
+     * @returns {number} The number of sounds removed.
      */
     removeByKey(key: string): number;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {number} volume - TBD.
-     * @param {boolean} loop - TBD.
-     * @returns {Sound} TBD.
+     * Plays a sound by key.
+     * @param {string} key - The key of the sound to play.
+     * @param {number} volume - The volume level (0.0 to 1.0).
+     * @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, loop?: boolean): Sound;
     /**
-     * TBD.
+     * Mutes all sounds in the manager.
      */
     setMute(): void;
     _muteVolume: any;
     /**
-     * TBD.
+     * Unmutes all sounds in the manager.
      */
     unsetMute(): void;
     /**
-     * TBD.
+     * Destroys the sound manager and cleans up resources.
      */
     destroy(): void;
     /**
-     * TBD.
+     * Sets the muted state of the sound manager.
      */
     set mute(value: boolean);
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Gets the muted state of the sound manager.
+     * @returns {boolean} True if the manager is muted, false otherwise.
      */
     get mute(): boolean;
     /**
-     * TBD.
+     * Sets the volume level of the sound manager.
      */
     set volume(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the volume level of the sound manager.
+     * @returns {number} The volume level (0.0 to 1.0).
      */
     get volume(): number;
 }

package/types/phaser/core/stage.d.ts

@@ -9,34 +9,34 @@ export class Stage extends DisplayObject {
         rgba: string;
     };
     /**
-     * TBD.
-     * @param {number} color - TBD.
+     * Sets the background color of the stage.
+     * @param {number} color - The color to set as the background.
      */
     setBackgroundColor(color: number): void;
     /**
-     * TBD.
+     * Initializes the stage after game creation.
      */
     boot(): void;
     /**
-     * TBD.
+     * Updates the stage's transformation matrix.
      */
     updateTransform(): void;
     /**
-     * TBD.
+     * Sets the background color of the stage.
      */
     set backgroundColor(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the background color of the stage.
+     * @returns {number} The background color.
      */
     get backgroundColor(): number;
     /**
-     * TBD.
+     * Sets whether texture smoothing is enabled.
      */
     set smoothed(value: boolean);
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Gets whether texture smoothing is enabled.
+     * @returns {boolean} True if texture smoothing is enabled, false otherwise.
      */
     get smoothed(): boolean;
 }

package/types/phaser/core/time.d.ts

@@ -1,7 +1,7 @@
 export class Time {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
+     * Creates a new Time instance.
+     * @param {import('./game.js').Game} game - Reference to the Phaser Game instance.
      */
     constructor(game: import("./game.js").Game);
     game: import("./game.js").Game;
@@ -57,82 +57,82 @@ export class Time {
     /** @type {Timer[]} */
     _timers: Timer[];
     /**
-     * TBD.
+     * Initializes the time manager and starts tracking time.
      */
     boot(): void;
     /**
-     * TBD.
-     * @param {Timer} timer - TBD.
-     * @returns {Timer} TBD.
+     * Adds a Timer to the Time manager.
+     * @param {Timer} timer - The Timer to add.
+     * @returns {Timer} The added Timer object.
      */
     add(timer: Timer): Timer;
     /**
-     * TBD.
-     * @param {boolean} autoDestroy - TBD.
-     * @returns {Timer} TBD.
+     * Creates a new Timer and adds it to the Time manager.
+     * @param {boolean} autoDestroy - Whether the timer should be automatically destroyed when it completes.
+     * @returns {Timer} The created Timer object.
      */
     create(autoDestroy?: boolean): Timer;
     /**
-     * TBD.
+     * Removes all timers from the Time manager.
      */
     removeAll(): void;
     /**
-     * TBD.
+     * Refreshes the time tracking values.
      */
     refresh(): void;
     /**
-     * TBD.
-     * @param {number} time - TBD.
+     * Updates the Time manager with a new timestamp.
+     * @param {number} time - The new timestamp to use for updating.
      */
     update(time: number): void;
     /**
-     * TBD.
+     * Updates all timers managed by the Time manager.
      */
     updateTimers(): void;
     /**
-     * TBD.
+     * Updates the advanced timing values.
      */
     updateAdvancedTiming(): void;
     /**
-     * TBD.
+     * Handles game pause event.
      */
     gamePaused(): void;
     /**
-     * TBD.
+     * Handles game resume event.
      */
     gameResumed(): void;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the total elapsed time in seconds since the game started.
+     * @returns {number} The total elapsed time in seconds.
      */
     totalElapsedSeconds(): number;
     /**
-     * TBD.
-     * @param {number} since - TBD.
-     * @returns {number} TBD.
+     * Gets the elapsed time in milliseconds since a given timestamp.
+     * @param {number} since - The timestamp to calculate elapsed time from.
+     * @returns {number} The elapsed time in milliseconds.
      */
     elapsedSince(since: number): number;
     /**
-     * TBD.
-     * @param {number} since - TBD.
-     * @returns {number} TBD.
+     * Gets the elapsed time in seconds since a given timestamp.
+     * @param {number} since - The timestamp to calculate elapsed time from.
+     * @returns {number} The elapsed time in seconds.
      */
     elapsedSecondsSince(since: number): number;
     /**
-     * TBD.
+     * Resets the time tracking values.
      */
     reset(): void;
     /**
-     * TBD.
+     * Destroys the Time manager and cleans up resources.
      */
     destroy(): void;
     /**
-     * TBD.
+     * Sets the desired frames per second.
      */
     set desiredFps(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the desired frames per second.
+     * @returns {number} The desired frames per second.
      */
     get desiredFps(): number;
 }

package/types/phaser/core/timer.d.ts

@@ -1,8 +1,8 @@
 export class Timer {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
-     * @param {boolean} autoDestroy - TBD.
+     * Creates a new Timer instance.
+     * @param {import('./game.js').Game} game - The game instance.
+     * @param {boolean} autoDestroy - Whether to automatically destroy the timer when it completes.
      */
     constructor(game: import("./game.js").Game, autoDestroy?: boolean);
     game: import("./game.js").Game;
@@ -45,133 +45,133 @@ export class Timer {
     /** @type {number} */
     _newTick: number;
     /**
-     * TBD.
-     * @param {number} delay - TBD.
-     * @param {boolean} loop - TBD.
-     * @param {number} repeatCount - TBD.
-     * @param {Function} callback - TBD.
-     * @param {object} callbackContext - TBD.
-     * @param {...any} args - TBD.
-     * @returns {TimerEvent} TBD.
+     * Creates a new TimerEvent.
+     * @param {number} delay - The delay in milliseconds before the event fires.
+     * @param {boolean} loop - Whether the event should loop indefinitely.
+     * @param {number} repeatCount - The number of times to repeat the event (0 = infinite).
+     * @param {Function} callback - The function to call when the event fires.
+     * @param {object} callbackContext - The context in which to call the callback.
+     * @param {...any} args - Arguments to pass to the callback function.
+     * @returns {TimerEvent} The created TimerEvent.
      */
     create(delay: number, loop: boolean, repeatCount: number, callback: Function, callbackContext: object, args: any[]): TimerEvent;
     /**
-     * TBD.
-     * @param {number} delay - TBD.
-     * @param {Function} callback - TBD.
-     * @param {object} callbackContext - TBD.
-     * @param {...any} args - TBD.
-     * @returns {TimerEvent} TBD.
+     * Creates a new TimerEvent that runs once.
+     * @param {number} delay - The delay in milliseconds before the event fires.
+     * @param {Function} callback - The function to call when the event fires.
+     * @param {object} callbackContext - The context in which to call the callback.
+     * @param {...any} args - Arguments to pass to the callback function.
+     * @returns {TimerEvent} The created TimerEvent.
      */
     add(delay: number, callback: Function, callbackContext?: object, ...args: any[]): TimerEvent;
     /**
-     * TBD.
-     * @param {number} delay - TBD.
-     * @param {number} repeatCount - TBD.
-     * @param {Function} callback - TBD.
-     * @param {object} callbackContext - TBD.
-     * @param {...any} args - TBD.
-     * @returns {TimerEvent} TBD.
+     * Creates a new TimerEvent that repeats a specified number of times.
+     * @param {number} delay - The delay in milliseconds before the event fires.
+     * @param {number} repeatCount - The number of times to repeat the event (0 = infinite).
+     * @param {Function} callback - The function to call when the event fires.
+     * @param {object} callbackContext - The context in which to call the callback.
+     * @param {...any} args - Arguments to pass to the callback function.
+     * @returns {TimerEvent} The created TimerEvent.
      */
     repeat(delay: number, repeatCount: number, callback: Function, callbackContext?: object, ...args: any[]): TimerEvent;
     /**
-     * TBD.
-     * @param {number} delay - TBD.
-     * @param {Function} callback - TBD.
-     * @param {object} callbackContext - TBD.
-     * @param {...any} args - TBD.
-     * @returns {TimerEvent} TBD.
+     * Creates a new TimerEvent that loops indefinitely.
+     * @param {number} delay - The delay in milliseconds before the event fires.
+     * @param {Function} callback - The function to call when the event fires.
+     * @param {object} callbackContext - The context in which to call the callback.
+     * @param {...any} args - Arguments to pass to the callback function.
+     * @returns {TimerEvent} The created TimerEvent.
      */
     loop(delay: number, callback: Function, callbackContext?: object, ...args: any[]): TimerEvent;
     /**
-     * TBD.
-     * @param {number} delay - TBD.
+     * Starts the timer.
+     * @param {number} delay - The delay in milliseconds before starting (optional).
      */
     start(delay?: number): void;
     /**
-     * TBD.
-     * @param {boolean} clearEvents - TBD.
+     * Stops the timer.
+     * @param {boolean} clearEvents - Whether to clear all events (default: true).
      */
     stop(clearEvents?: boolean): void;
     /**
-     * TBD.
-     * @param {TimerEvent | null | undefined} event - TBD.
-     * @returns {boolean} TBD.
+     * Removes a TimerEvent from the timer.
+     * @param {TimerEvent | null | undefined} event - The TimerEvent to remove.
+     * @returns {boolean} True if the event was removed, false otherwise.
      */
     remove(event: TimerEvent | null | undefined): boolean;
     /**
-     * TBD.
+     * Orders the timer events by their next tick time.
      */
     order(): void;
     /**
-     * TBD.
-     * @param {TimerEvent} a - TBD.
-     * @param {TimerEvent} b - TBD.
-     * @returns {number} TBD.
+     * Sorts TimerEvents by their tick time.
+     * @param {TimerEvent} a - First TimerEvent to compare.
+     * @param {TimerEvent} b - Second TimerEvent to compare.
+     * @returns {number} Comparison result (-1, 0, or 1).
      */
     sortHandler(a: TimerEvent, b: TimerEvent): number;
     /**
-     * TBD.
+     * Clears pending events from the timer.
      */
     clearPendingEvents(): void;
     /**
-     * TBD.
-     * @param {number} time - TBD.
-     * @returns {boolean} TBD.
+     * Updates the timer state at a given time.
+     * @param {number} time - The current time in milliseconds.
+     * @returns {boolean} True if the timer should continue running, false if it should be destroyed.
      */
     update(time: number): boolean;
     /**
-     * TBD.
+     * Pauses the timer.
      */
     pause(): void;
     /**
-     * TBD.
+     * Internal pause method for the timer.
      */
     _pause(): void;
     /**
-     * TBD.
-     * @param {number} baseTime - TBD.
+     * Adjusts timer events when time has jumped (e.g., when tab is switched).
+     * @param {number} baseTime - The time to adjust from.
      */
     adjustEvents(baseTime: number): void;
     /**
-     * TBD.
+     * Resumes the timer.
      */
     resume(): void;
     /**
-     * TBD.
+     * Internal resume method for the timer.
      */
     _resume(): void;
     /**
-     * TBD.
+     * Removes all events from the timer.
      */
     removeAll(): void;
     /**
-     * TBD.
+     * Destroys the timer and cleans up resources.
      */
     destroy(): void;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the next tick time for the timer.
+     * @returns {number} The next tick time in milliseconds.
      */
     get next(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the duration until the next event.
+     * @returns {number} The duration in milliseconds.
      */
     get duration(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the number of active events in the timer.
+     * @returns {number} The number of events.
      */
     get length(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the elapsed time since the timer started.
+     * @returns {number} The elapsed time in milliseconds.
      */
     get ms(): number;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the elapsed time in seconds since the timer started.
+     * @returns {number} The elapsed time in seconds.
      */
     get seconds(): number;
 }

package/types/phaser/core/timer_event.d.ts

@@ -1,14 +1,14 @@
 export class TimerEvent {
     /**
-     * TBD.
-     * @param {import('./timer.js').Timer} timer - TBD.
-     * @param {number} delay - TBD.
-     * @param {number} tick - TBD.
-     * @param {number} repeatCount - TBD.
-     * @param {boolean} loop - TBD.
-     * @param {Function} callback - TBD.
-     * @param {object} callbackContext - TBD.
-     * @param {...any} args - TBD.
+     * Creates a new TimerEvent instance.
+     * @param {import('./timer.js').Timer} timer - Reference to the parent Timer.
+     * @param {number} delay - The delay (in milliseconds) before the event should occur.
+     * @param {number} tick - The tick (in milliseconds) at which the event should occur.
+     * @param {number} repeatCount - The number of times the event should repeat.
+     * @param {boolean} loop - Whether the event should loop.
+     * @param {Function} callback - The function to call when the event occurs.
+     * @param {object} callbackContext - The context in which to call the callback function.
+     * @param {...any} args - Arguments to pass to the callback function.
      */
     constructor(timer: import("./timer.js").Timer, delay: number, tick: number, repeatCount: number, loop: boolean, callback: Function, callbackContext: object, args: any[]);
     timer: import("./timer.js").Timer;