@vpmedia/phaser 1.95.0 → 1.96.0

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

@@ -1,8 +1,8 @@
 export class SceneManager {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
-     * @param {string} pendingState - TBD.
+     * Creates a new SceneManager instance.
+     * @param {import('./game.js').Game} game - The game instance this manager belongs to.
+     * @param {string} pendingState - The state to load when the game boots.
      */
     constructor(game: import("./game.js").Game, pendingState: string);
     game: import("./game.js").Game;
@@ -21,101 +21,109 @@ export class SceneManager {
     onPauseUpdateCallback: any;
     onShutDownCallback: any;
     /**
-     * TBD.
+     * Initialize the scene manager.
+     * This method is called when the game boots and sets up the initial state.
      */
     boot(): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {object} state - TBD.
-     * @param {boolean} autoStart - TBD.
-     * @returns {Scene|object} TBD.
+     * Add a new scene state to the manager.
+     * @param {string} key - The unique key for this state.
+     * @param {object} state - The scene state to add.
+     * @param {boolean} autoStart - Whether to start this state immediately.
+     * @returns {Scene|object} The created scene or state object.
      */
     add(key: string, state: object, autoStart?: boolean): Scene | object;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Remove a scene state from the manager.
+     * @param {string} key - The unique key for the state to remove.
      */
     remove(key: string): void;
     callbackContext: any;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @param {boolean} clearWorld - TBD.
-     * @param {boolean} clearCache - TBD.
-     * @param {...any} args - TBD.
+     * Start a scene state.
+     * @param {string} key - The unique key for the state to start.
+     * @param {boolean} clearWorld - Whether to clear the world before starting.
+     * @param {boolean} clearCache - Whether to clear the cache before starting.
+     * @param {...any} args - Additional arguments to pass to the state.
      */
     start(key: string, clearWorld?: boolean, clearCache?: boolean, ...args: any[]): void;
     /**
-     * TBD.
-     * @param {boolean} clearWorld - TBD.
-     * @param {boolean} clearCache - TBD.
-     * @param {...any} args - TBD.
+     * Restart the current scene state.
+     * @param {boolean} clearWorld - Whether to clear the world before restarting.
+     * @param {boolean} clearCache - Whether to clear the cache before restarting.
+     * @param {...any} args - Additional arguments to pass to the state.
      */
     restart(clearWorld?: boolean, clearCache?: boolean, ...args: any[]): void;
     /**
-     * TBD.
+     * Pre-update the scene manager.
+     * This method is called before the game loop updates.
      */
     preUpdate(): void;
     /**
-     * TBD.
+     * Clear the current scene state.
+     * This method is called when switching scenes to clean up the previous scene.
      */
     clearCurrentState(): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
-     * @returns {boolean} TBD.
+     * Check if a scene state exists.
+     * @param {string} key - The unique key for the state to check.
+     * @returns {boolean} True if the scene exists, false otherwise.
      */
     checkState(key: string): boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Link a scene state to the manager.
+     * @param {string} key - The unique key for the state to link.
      */
     link(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Unlink a scene state from the manager.
+     * @param {string} key - The unique key for the state to unlink.
      */
     unlink(key: string): void;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Set the current scene state.
+     * @param {string} key - The unique key for the state to set as current.
      */
     setCurrentState(key: string): void;
     /**
-     * TBD.
-     * @returns {Scene} TBD.
+     * Get the current scene state.
+     * @returns {Scene} The current scene state.
      */
     getCurrentState(): Scene;
     /**
-     * TBD.
+     * Handle loading completion.
+     * This method is called when scene loading is complete.
      */
     loadComplete(): void;
     /**
-     * TBD.
+     * Update the scene manager.
+     * This method is called every frame while the game is running.
      */
     update(): void;
     /**
-     * TBD.
+     * Pause the scene manager updates.
+     * This method is called when the game is paused.
      */
     pauseUpdate(): void;
     /**
-     * TBD.
-     * @param {number} width - TBD.
-     * @param {number} height - TBD.
+     * Handle scene resize.
+     * @param {number} width - The new width of the scene.
+     * @param {number} height - The new height of the scene.
      */
     resize(width: number, height: number): void;
     /**
-     * TBD.
+     * Destroy the scene manager.
+     * This method is called when the scene manager is about to be destroyed.
      */
     destroy(): void;
     /**
-     * TBD.
+     * Dummy function for callbacks.
+     * This is a placeholder function used when no callback is defined.
      */
     dummy(): void;
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Get whether the scene has been created.
+     * @returns {boolean} True if the scene has been created, false otherwise.
      */
     get created(): boolean;
 }

package/types/phaser/core/scene_manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scene_manager.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/scene_manager.js"],"names":[],"mappings":"AAEA;IACE;;;;OAIG;IACH,kBAHW,OAAO,WAAW,EAAE,IAAI,gBACxB,MAAM,EAqBhB;IAlBC,+BAAgB;IAChB,WAAgB;IAChB,sBAAyB;IAIzB,qBAAwB;IACxB,qBAAwB;IACxB,kBAAqB;IACrB,aAAe;IACf,gBAAiB;IACjB,oBAA0B;IAC1B,uBAA6B;IAC7B,sBAA4B;IAC5B,sBAA4B;IAC5B,sBAA4B;IAC5B,2BAAiC;IACjC,wBAA8B;IAGhC;;OAEG;IACH,aAIC;IAED;;;;;;OAMG;IACH,SALW,MAAM,SACN,MAAM,cACN,OAAO,GACL,KAAK,GAAC,MAAM,CAqBxB;IAED;;;OAGG;IACH,YAFW,MAAM,QAchB;IAVG,qBAA2B;IAY/B;;;;;;OAMG;IACH,WALW,MAAM,eACN,OAAO,eACP,OAAO,WACJ,GAAG,EAAA,QAYhB;IAED;;;;;OAKG;IACH,qBAJW,OAAO,eACP,OAAO,WACJ,GAAG,EAAA,QAShB;IAED;;OAEG;IACH,kBA6BC;IAED;;OAEG;IACH,0BAgBC;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAUnB;IAED;;;OAGG;IACH,UAFW,MAAM,QAKhB;IAED;;;OAGG;IACH,YAFW,MAAM,QAMhB;IAED;;;OAGG;IACH,qBAFW,MAAM,QAoBhB;IAED;;;OAGG;IACH,mBAFa,KAAK,CAIjB;IAED;;OAEG;IACH,qBAOC;IAED;;OAEG;IACH,eAIC;IAED;;OAEG;IACH,oBAIC;IAED;;;;OAIG;IACH,cAHW,MAAM,UACN,MAAM,QAMhB;IAED;;OAEG;IACH,gBAeC;IAED;;OAEG;IACH,cAEC;IAED;;;OAGG;IACH,eAFa,OAAO,CAInB;CACF;sBA1TqB,YAAY"}
+{"version":3,"file":"scene_manager.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/scene_manager.js"],"names":[],"mappings":"AAEA;IACE;;;;OAIG;IACH,kBAHW,OAAO,WAAW,EAAE,IAAI,gBACxB,MAAM,EAqBhB;IAlBC,+BAAgB;IAChB,WAAgB;IAChB,sBAAyB;IAIzB,qBAAwB;IACxB,qBAAwB;IACxB,kBAAqB;IACrB,aAAe;IACf,gBAAiB;IACjB,oBAA0B;IAC1B,uBAA6B;IAC7B,sBAA4B;IAC5B,sBAA4B;IAC5B,sBAA4B;IAC5B,2BAAiC;IACjC,wBAA8B;IAGhC;;;OAGG;IACH,aAIC;IAED;;;;;;OAMG;IACH,SALW,MAAM,SACN,MAAM,cACN,OAAO,GACL,KAAK,GAAC,MAAM,CAqBxB;IAED;;;OAGG;IACH,YAFW,MAAM,QAchB;IAVG,qBAA2B;IAY/B;;;;;;OAMG;IACH,WALW,MAAM,eACN,OAAO,eACP,OAAO,WACJ,GAAG,EAAA,QAYhB;IAED;;;;;OAKG;IACH,qBAJW,OAAO,eACP,OAAO,WACJ,GAAG,EAAA,QAShB;IAED;;;OAGG;IACH,kBA6BC;IAED;;;OAGG;IACH,0BAgBC;IAED;;;;OAIG;IACH,gBAHW,MAAM,GACJ,OAAO,CAUnB;IAED;;;OAGG;IACH,UAFW,MAAM,QAKhB;IAED;;;OAGG;IACH,YAFW,MAAM,QAMhB;IAED;;;OAGG;IACH,qBAFW,MAAM,QAoBhB;IAED;;;OAGG;IACH,mBAFa,KAAK,CAIjB;IAED;;;OAGG;IACH,qBAOC;IAED;;;OAGG;IACH,eAIC;IAED;;;OAGG;IACH,oBAIC;IAED;;;;OAIG;IACH,cAHW,MAAM,UACN,MAAM,QAMhB;IAED;;;OAGG;IACH,gBAeC;IAED;;;OAGG;IACH,cAEC;IAED;;;OAGG;IACH,eAFa,OAAO,CAInB;CACF;sBAlUqB,YAAY"}

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

@@ -6,102 +6,105 @@ export class Signal {
     active: boolean;
     _boundDispatch: (...rest: any[]) => void;
     /**
-     * TBD.
-     * @param {Function} listener - TBD.
-     * @param {string} fnName - TBD.
-     * @throws {Error}
+     * Validates that a listener is a function.
+     * @param {Function} listener - The listener to validate.
+     * @param {string} fnName - The name of the function this validation is for.
+     * @throws {Error} If the listener is not a function.
      */
     validateListener(listener: Function, fnName: string): void;
     /**
-     * TBD.
-     * @param {Function} listener - TBD.
-     * @param {boolean} isOnce - TBD.
-     * @param {object} listenerContext - TBD.
-     * @param {number} priority - TBD.
-     * @param {...any} args - TBD.
-     * @returns {SignalBinding} TBD.
-     * @throws {Error}
+     * Register a new listener with the signal.
+     * @param {Function} listener - The function to call when the signal is dispatched.
+     * @param {boolean} isOnce - Whether the listener should only be called once.
+     * @param {object} listenerContext - The context to apply when calling the listener.
+     * @param {number} priority - The priority of this listener (higher numbers execute first).
+     * @param {...any} args - Additional arguments to pass to the listener.
+     * @returns {SignalBinding} The binding for this listener.
+     * @throws {Error} If the listener is already registered with a different once setting.
      */
     _registerListener(listener: Function, isOnce?: boolean, listenerContext?: object, priority?: number, args?: any[]): SignalBinding;
     /**
-     * TBD.
-     * @param {SignalBinding} binding - TBD.
+     * Add a binding to the list of listeners.
+     * @param {SignalBinding} binding - The binding to add.
      */
     _addBinding(binding: SignalBinding): void;
     /**
-     * TBD.
-     * @param {Function} listener - TBD.
-     * @param {object} context - TBD.
-     * @returns {number} TBD.
+     * Find the index of a listener in the bindings array.
+     * @param {Function} listener - The listener to find.
+     * @param {object} context - The context of the listener.
+     * @returns {number} The index of the listener in the bindings array, or -1 if not found.
      */
     _indexOfListener(listener: Function, context?: object): number;
     /**
-     * TBD.
-     * @param {Function} listener - TBD.
-     * @param {object} context - TBD.
-     * @returns {boolean} TBD.
+     * Check if a listener is registered with the signal.
+     * @param {Function} listener - The listener to check.
+     * @param {object} context - The context of the listener.
+     * @returns {boolean} True if the listener is registered, false otherwise.
      */
     has(listener: Function, context?: object): boolean;
     /**
-     * TBD.
-     * @param {Function} listener - TBD.
-     * @param {object} listenerContext - TBD.
-     * @param {number} priority - TBD.
-     * @param {...any} args - TBD.
-     * @returns {SignalBinding} TBD.
+     * Add a listener that will be called every time the signal is dispatched.
+     * @param {Function} listener - The function to call when the signal is dispatched.
+     * @param {object} listenerContext - The context to apply when calling the listener.
+     * @param {number} priority - The priority of this listener (higher numbers execute first).
+     * @param {...any} args - Additional arguments to pass to the listener.
+     * @returns {SignalBinding} The binding for this listener.
      */
     add(listener: Function, listenerContext?: object, priority?: number, ...args: any[]): SignalBinding;
     /**
-     * TBD.
-     * @param {Function} listener - TBD.
-     * @param {object} listenerContext - TBD.
-     * @param {number} priority - TBD.
-     * @param {...any} args - TBD.
-     * @returns {SignalBinding} TBD.
+     * Add a listener that will be called only once when the signal is dispatched.
+     * @param {Function} listener - The function to call when the signal is dispatched.
+     * @param {object} listenerContext - The context to apply when calling the listener.
+     * @param {number} priority - The priority of this listener (higher numbers execute first).
+     * @param {...any} args - Additional arguments to pass to the listener.
+     * @returns {SignalBinding} The binding for this listener.
      */
     addOnce(listener: Function, listenerContext?: object, priority?: number, ...args: any[]): SignalBinding;
     /**
-     * TBD.
-     * @param {Function} listener - TBD.
-     * @param {object} context - TBD.
-     * @returns {Function} TBD.
+     * Remove a listener from the signal.
+     * @param {Function} listener - The listener to remove.
+     * @param {object} context - The context of the listener.
+     * @returns {Function} The removed listener function.
      */
     remove(listener: Function, context?: object): Function;
     /**
-     * TBD.
-     * @param {object} context - TBD.
+     * 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.
      */
     removeAll(context?: object): void;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Get the number of listeners registered with the signal.
+     * @returns {number} The number of registered listeners.
      */
     getNumListeners(): number;
     /**
-     * TBD.
+     * Stop the signal from propagating to other listeners.
+     * This method prevents any remaining listeners from being called.
      */
     halt(): void;
     /**
-     * TBD.
-     * @param {...any} args - TBD.
+     * Dispatch the signal to all registered listeners.
+     * @param {...any} args - Arguments to pass to the listeners.
      */
     dispatch(...args: any[]): void;
     /**
-     * TBD.
+     * Clear any previously memorized arguments.
+     * This removes the stored arguments from a previous dispatch.
      */
     forget(): void;
     /**
-     * TBD.
+     * Dispose of the signal and clean up all resources.
+     * This method removes all listeners and clears internal state.
      */
     dispose(): void;
     /**
-     * TBD.
-     * @returns {string} TBD.
+     * Get a string representation of the signal.
+     * @returns {string} A string representation of the signal.
      */
     toString(): string;
     /**
-     * TBD.
-     * @returns {Function} TBD.
+     * Get a bound version of the dispatch function.
+     * @returns {Function} A function that will dispatch the signal with the correct context.
      */
     get boundDispatch(): Function;
 }

package/types/phaser/core/signal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signal.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/signal.js"],"names":[],"mappings":"AAEA;IAKI,iBAAqB;IACrB,mBAAuB;IACvB,kBAAqB;IACrB,0BAA4B;IAC5B,gBAAkB;IAClB,yCAA0B;IAG5B;;;;;OAKG;IACH,6CAHW,MAAM,QAShB;IAED;;;;;;;;;OASG;IACH,+CAPW,OAAO,oBACP,MAAM,aACN,MAAM,SACH,GAAG,EAAA,GACJ,aAAa,CAuBzB;IAED;;;OAGG;IACH,qBAFW,aAAa,QAYvB;IAED;;;;;OAKG;IACH,+CAHW,MAAM,GACJ,MAAM,CAgBlB;IAED;;;;;OAKG;IACH,kCAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;;;;OAOG;IACH,0CALW,MAAM,aACN,MAAM,WACH,GAAG,EAAA,GACJ,aAAa,CAKzB;IAED;;;;;;;OAOG;IACH,8CALW,MAAM,aACN,MAAM,WACH,GAAG,EAAA,GACJ,aAAa,CAKzB;IAED;;;;;OAKG;IACH,qCAHW,MAAM,YAYhB;IAED;;;OAGG;IACH,oBAFW,MAAM,QAqBhB;IAED;;;OAGG;IACH,mBAFa,MAAM,CAIlB;IAED;;OAEG;IACH,aAEC;IAED;;;OAGG;IACH,kBAFc,GAAG,EAAA,QAwBhB;IAED;;OAEG;IACH,eAIC;IAED;;OAEG;IACH,gBAIC;IAED;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,8BAMC;CACF;8BAjQ6B,qBAAqB"}
+{"version":3,"file":"signal.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/signal.js"],"names":[],"mappings":"AAEA;IAMI,iBAAqB;IACrB,mBAAuB;IACvB,kBAAqB;IACrB,0BAA4B;IAC5B,gBAAkB;IAClB,yCAA0B;IAG5B;;;;;OAKG;IACH,6CAHW,MAAM,QAShB;IAED;;;;;;;;;OASG;IACH,+CAPW,OAAO,oBACP,MAAM,aACN,MAAM,SACH,GAAG,EAAA,GACJ,aAAa,CAuBzB;IAED;;;OAGG;IACH,qBAFW,aAAa,QAYvB;IAED;;;;;OAKG;IACH,+CAHW,MAAM,GACJ,MAAM,CAgBlB;IAED;;;;;OAKG;IACH,kCAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;;;;;OAOG;IACH,0CALW,MAAM,aACN,MAAM,WACH,GAAG,EAAA,GACJ,aAAa,CAKzB;IAED;;;;;;;OAOG;IACH,8CALW,MAAM,aACN,MAAM,WACH,GAAG,EAAA,GACJ,aAAa,CAKzB;IAED;;;;;OAKG;IACH,qCAHW,MAAM,YAYhB;IAED;;;OAGG;IACH,oBAFW,MAAM,QAqBhB;IAED;;;OAGG;IACH,mBAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,aAEC;IAED;;;OAGG;IACH,kBAFc,GAAG,EAAA,QAwBhB;IAED;;;OAGG;IACH,eAIC;IAED;;;OAGG;IACH,gBAIC;IAED;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,8BAMC;CACF;8BArQ6B,qBAAqB"}

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

@@ -1,11 +1,11 @@
 export class Sound {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
-     * @param {string} key - TBD.
-     * @param {number} volume - TBD.
-     * @param {boolean} loop - TBD.
-     * @param {boolean} connect - TBD.
+     * Creates a new Sound instance.
+     * @param {import('./game.js').Game} game - Reference to the Phaser Game instance.
+     * @param {string} key - The key of the sound to play.
+     * @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.
      */
     constructor(game: import("./game.js").Game, key: string, volume?: number, loop?: boolean, connect?: boolean);
     game: import("./game.js").Game;
@@ -61,111 +61,111 @@ export class Sound {
     _tempLoop: boolean;
     _paused: boolean;
     /**
-     * TBD.
-     * @param {string} key - TBD.
+     * Callback when a sound has been unlocked.
+     * @param {string} key - The key of the sound that was unlocked.
      */
     soundHasUnlocked(key: string): void;
     /**
-     * TBD.
-     * @param {string} name - TBD.
-     * @param {number} start - TBD.
-     * @param {number} duration - TBD.
-     * @param {number} volume - TBD.
-     * @param {boolean} loop - TBD.
+     * Adds a marker to the sound.
+     * @param {string} name - The name of the marker.
+     * @param {number} start - The start time (in seconds) of the marker.
+     * @param {number} duration - The duration (in seconds) of the marker.
+     * @param {number} volume - The volume level (0.0 to 1.0) of the marker.
+     * @param {boolean} loop - Whether the marker should loop.
      */
     addMarker(name: string, start: number, duration?: number, volume?: number, loop?: boolean): void;
     /**
-     * TBD.
-     * @param {string} name - TBD.
+     * Removes a marker from the sound.
+     * @param {string} name - The name of the marker to remove.
      */
     removeMarker(name: string): void;
     /**
-     * TBD.
+     * Handler for when the sound ends.
      */
     onEndedHandler(): void;
     /**
-     * TBD.
+     * Updates the sound state.
      */
     update(): void;
     /**
-     * TBD.
-     * @param {number} volume - TBD.
-     * @returns {Sound} TBD.
+     * Plays the sound at full volume in a loop.
+     * @param {number} volume - The volume level (0.0 to 1.0) to play at.
+     * @returns {Sound} This Sound instance for chaining.
      */
     loopFull(volume: number): Sound;
     /**
-     * TBD.
-     * @param {string} marker - TBD.
-     * @param {number} position - TBD.
-     * @param {number} volume - TBD.
-     * @param {boolean} loop - TBD.
-     * @param {boolean} forceRestart - TBD.
-     * @returns {Sound} TBD.
+     * Plays the sound, optionally using a marker.
+     * @param {string} marker - The name of the marker to play, or null/undefined to play the entire sound.
+     * @param {number} position - The position (in seconds) to start playing from.
+     * @param {number} volume - The volume level (0.0 to 1.0) to play at.
+     * @param {boolean} loop - Whether the sound should loop.
+     * @param {boolean} forceRestart - Whether to force restarting the sound even if it's already playing.
+     * @returns {Sound} This Sound instance for chaining.
      */
     play(marker: string, position: number, volume: number, loop: boolean, forceRestart?: boolean): Sound;
     /**
-     * TBD.
+     * Sets the volume of the sound.
      */
     set volume(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the volume of the sound.
+     * @returns {number} The volume level (0.0 to 1.0).
      */
     get volume(): number;
     /**
-     * TBD.
-     * @param {string} marker - TBD.
-     * @param {number} position - TBD.
-     * @param {number} volume - TBD.
-     * @param {boolean} loop - TBD.
+     * Restarts the sound, optionally using a marker.
+     * @param {string} marker - The name of the marker to play, or empty string to play the entire sound.
+     * @param {number} position - The position (in seconds) to start playing from.
+     * @param {number} volume - The volume level (0.0 to 1.0) to play at.
+     * @param {boolean} loop - Whether the sound should loop.
      */
     restart(marker?: string, position?: number, volume?: number, loop?: boolean): void;
     /**
-     * TBD.
+     * Pauses the sound.
      */
     pause(): void;
     /**
-     * TBD.
+     * Resumes the sound.
      */
     resume(): void;
     /**
-     * TBD.
+     * Stops the sound.
      */
     stop(): void;
     /**
-     * TBD.
-     * @param {number} duration - TBD.
-     * @param {boolean} loop - TBD.
-     * @param {string} marker - TBD.
+     * Fades in the sound to full volume.
+     * @param {number} duration - The fade-in duration (in milliseconds).
+     * @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.
      */
     fadeIn(duration: number, loop?: boolean, marker?: string): void;
     /**
-     * TBD.
-     * @param {number} duration - TBD.
+     * Fades out the sound to silence.
+     * @param {number} duration - The fade-out duration (in milliseconds).
      */
     fadeOut(duration: number): void;
     /**
-     * TBD.
-     * @param {number} duration - TBD.
-     * @param {number} volume - TBD.
+     * Fades the sound to a specific volume level.
+     * @param {number} duration - The fade duration (in milliseconds).
+     * @param {number} volume - The target volume level (0.0 to 1.0).
      */
     fadeTo(duration?: number, volume?: number): void;
     /**
-     * TBD.
+     * Callback when fade completes.
      */
     fadeComplete(): void;
     /**
-     * TBD.
-     * @param {boolean} remove - TBD.
+     * Destroys the sound and cleans up resources.
+     * @param {boolean} remove - Whether to remove the sound from the SoundManager.
      */
     destroy(remove?: boolean): void;
     /**
-     * TBD.
+     * Sets the muted state of the sound.
      */
     set mute(value: boolean);
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Gets the muted state of the sound.
+     * @returns {boolean} True if the sound is muted, false otherwise.
      */
     get mute(): boolean;
 }