@vpmedia/phaser 1.95.0 → 1.96.0

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

@@ -1,9 +1,9 @@
 export class Tween {
     /**
-     * TBD.
-     * @param {import('../display/display_object.js').DisplayObject} target - TBD.
-     * @param {import('./game.js').Game} game - TBD.
-     * @param {import('./tween_manager.js').TweenManager} manager - TBD.
+     * Creates a new Tween instance.
+     * @param {import('../display/display_object.js').DisplayObject} target - The object to tween.
+     * @param {import('./game.js').Game} game - Reference to the Phaser Game instance.
+     * @param {import('./tween_manager.js').TweenManager} manager - Reference to the Tween Manager.
      */
     constructor(target: import("../display/display_object.js").DisplayObject, game: import("./game.js").Game, manager: import("./tween_manager.js").TweenManager);
     game: import("./game.js").Game;
@@ -47,158 +47,158 @@ export class Tween {
     /** @type {boolean} */
     _hasStarted: boolean;
     /**
-     * TBD.
-     * @param {object} properties - TBD.
-     * @param {number} duration - TBD.
-     * @param {string | Function} ease - TBD.
-     * @param {boolean} autoStart - TBD.
-     * @param {number} delay - TBD.
-     * @param {number} repeat - TBD.
-     * @param {boolean} yoyo - TBD.
-     * @returns {Tween} TBD.
+     * Adds a tween to the timeline that animates properties to their target values.
+     * @param {object} properties - The properties to tween and their target values.
+     * @param {number} duration - The duration of the tween in milliseconds.
+     * @param {string | Function} ease - The easing function to use.
+     * @param {boolean} autoStart - Whether to start the tween immediately.
+     * @param {number} delay - The delay before starting the tween in milliseconds.
+     * @param {number} repeat - Number of times to repeat the tween.
+     * @param {boolean} yoyo - Whether to reverse the tween on repeat.
+     * @returns {Tween} This Tween object for chaining.
      */
     to(properties: object, duration?: number, ease?: string | Function, autoStart?: boolean, delay?: number, repeat?: number, yoyo?: boolean): Tween;
     /**
-     * TBD.
-     * @param {object} properties - TBD.
-     * @param {number} duration - TBD.
-     * @param {string | Function} ease - TBD.
-     * @param {boolean} autoStart - TBD.
-     * @param {number} delay - TBD.
-     * @param {number} repeat - TBD.
-     * @param {boolean} yoyo - TBD.
-     * @returns {Tween} TBD.
+     * Adds a tween to the timeline that animates properties from their current values.
+     * @param {object} properties - The properties to tween and their target values.
+     * @param {number} duration - The duration of the tween in milliseconds.
+     * @param {string | Function} ease - The easing function to use.
+     * @param {boolean} autoStart - Whether to start the tween immediately.
+     * @param {number} delay - The delay before starting the tween in milliseconds.
+     * @param {number} repeat - Number of times to repeat the tween.
+     * @param {boolean} yoyo - Whether to reverse the tween on repeat.
+     * @returns {Tween} This Tween object for chaining.
      */
     from(properties: object, duration?: number, ease?: string | Function, autoStart?: boolean, delay?: number, repeat?: number, yoyo?: boolean): Tween;
     /**
-     * TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Starts the tween timeline from a specific index.
+     * @param {number} index - The index to start from in the timeline.
+     * @returns {Tween} This Tween object for chaining.
      */
     start(index?: number): Tween;
     /**
-     * TBD.
-     * @param {boolean} complete - TBD.
-     * @returns {Tween} TBD.
+     * Stops the tween and optionally completes it.
+     * @param {boolean} complete - Whether to dispatch the complete event.
+     * @returns {Tween} This Tween object for chaining.
      */
     stop(complete?: boolean): Tween;
     /**
-     * TBD.
-     * @param {string} property - TBD.
-     * @param {object} value - TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Updates a property in the tween data.
+     * @param {string} property - The property name to update.
+     * @param {object} value - The new value for the property.
+     * @param {number} index - The index in the timeline to update.
+     * @returns {Tween} This Tween object for chaining.
      */
     updateTweenData(property: string, value: object, index?: number): Tween;
     /**
-     * TBD.
-     * @param {number} duration - TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Sets a delay for a specific timeline entry.
+     * @param {number} duration - The delay in milliseconds.
+     * @param {number} index - The index in the timeline to apply the delay to.
+     * @returns {Tween} This Tween object for chaining.
      */
     delay(duration: number, index: number): Tween;
     /**
-     * TBD.
-     * @param {number} total - TBD.
-     * @param {number} repeatDelay - TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Sets how many times to repeat the tween.
+     * @param {number} total - The number of times to repeat (-1 for infinite).
+     * @param {number} repeatDelay - Delay between repeats in milliseconds.
+     * @param {number} index - The index in the timeline to apply the repeat to.
+     * @returns {Tween} This Tween object for chaining.
      */
     repeat(total: number, repeatDelay?: number, index?: number): Tween;
     /**
-     * TBD.
-     * @param {number} duration - TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Sets the repeat delay for a specific timeline entry.
+     * @param {number} duration - The delay between repeats in milliseconds.
+     * @param {number} index - The index in the timeline to apply the delay to.
+     * @returns {Tween} This Tween object for chaining.
      */
     repeatDelay(duration: number, index: number): Tween;
     /**
-     * TBD.
-     * @param {boolean} enable - TBD.
-     * @param {number} yoyoDelay - TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Enables or disables yoyo behavior for a timeline entry.
+     * @param {boolean} enable - Whether to enable yoyo behavior.
+     * @param {number} yoyoDelay - Delay between yoyo cycles in milliseconds.
+     * @param {number} index - The index in the timeline to apply yoyo to.
+     * @returns {Tween} This Tween object for chaining.
      */
     yoyo(enable: boolean, yoyoDelay?: number, index?: number): Tween;
     /**
-     * TBD.
-     * @param {number} duration - TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Sets the yoyo delay for a specific timeline entry.
+     * @param {number} duration - The delay between yoyo cycles in milliseconds.
+     * @param {number} index - The index in the timeline to apply the delay to.
+     * @returns {Tween} This Tween object for chaining.
      */
     yoyoDelay(duration: number, index: number): Tween;
     /**
-     * TBD.
-     * @param {string|Function} ease - TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Sets the easing function for a timeline entry.
+     * @param {string|Function} ease - The easing function to use.
+     * @param {number} index - The index in the timeline to apply easing to.
+     * @returns {Tween} This Tween object for chaining.
      */
     easing(ease: string | Function, index: number): Tween;
     /**
-     * TBD.
-     * @param {Function} interpolation - TBD.
-     * @param {object} context - TBD.
-     * @param {number} index - TBD.
-     * @returns {Tween} TBD.
+     * Sets the interpolation function for a timeline entry.
+     * @param {Function} interpolation - The interpolation function to use.
+     * @param {object} context - The context in which to call the interpolation function.
+     * @param {number} index - The index in the timeline to apply interpolation to.
+     * @returns {Tween} This Tween object for chaining.
      */
     interpolation(interpolation: Function, context?: object, index?: number): Tween;
     /**
-     * TBD.
-     * @param {number} total - TBD.
-     * @returns {Tween} TBD.
+     * Sets how many times to repeat all timeline entries.
+     * @param {number} total - The number of times to repeat (-1 for infinite).
+     * @returns {Tween} This Tween object for chaining.
      */
     repeatAll(total?: number): Tween;
     /**
-     * TBD.
-     * @param {...any} args - TBD.
-     * @returns {Tween} TBD.
+     * Chains one or more tweens to this tween.
+     * @param {...any} args - The tweens to chain.
+     * @returns {Tween} This Tween object for chaining.
      */
     chain(...args: any[]): Tween;
     /**
-     * TBD.
-     * @param {boolean} value - TBD.
-     * @returns {Tween} TBD.
+     * Sets whether the tween should loop infinitely.
+     * @param {boolean} value - Whether to loop infinitely.
+     * @returns {Tween} This Tween object for chaining.
      */
     loop(value?: boolean): Tween;
     /**
-     * TBD.
-     * @param {Function} callback - TBD.
-     * @param {object} callbackContext - TBD.
-     * @returns {Tween} TBD.
+     * Sets a callback to be called when the tween updates.
+     * @param {Function} callback - The callback function to call.
+     * @param {object} callbackContext - The context in which to call the callback.
+     * @returns {Tween} This Tween object for chaining.
      */
     onUpdateCallback(callback: Function, callbackContext: object): Tween;
     /**
-     * TBD.
+     * Pauses the tween.
      */
     pause(): void;
     /**
-     * TBD.
+     * Internal method to pause the tween.
      */
     _pause(): void;
     /**
-     * TBD.
+     * Resumes the tween.
      */
     resume(): void;
     /**
-     * TBD.
+     * Internal method to resume the tween.
      */
     _resume(): void;
     /**
-     * TBD.
-     * @param {number} time - TBD.
-     * @returns {boolean} TBD.
+     * Updates the tween state at a given time.
+     * @param {number} time - The current game time.
+     * @returns {boolean} True if the tween should continue running, false if it's complete.
      */
     update(time: number): boolean;
     /**
-     * TBD.
-     * @param {number} frameRate - TBD.
-     * @param {object[]} data - TBD.
-     * @returns {object[]} TBD.
+     * Generates animation data for a given frame rate.
+     * @param {number} frameRate - The target frame rate.
+     * @param {object[]} data - The array to store the generated data in.
+     * @returns {object[]} The populated data array.
      */
     generateData(frameRate?: number, data?: object[]): object[];
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the total duration of all timeline entries.
+     * @returns {number} The total duration in milliseconds.
      */
     get totalDuration(): number;
 }

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

@@ -1,7 +1,7 @@
 export class TweenData {
     /**
-     * TBD.
-     * @param {import('./tween.js').Tween} parent - TBD.
+     * Creates a new TweenData instance.
+     * @param {import('./tween.js').Tween} parent - The parent Tween instance.
      */
     constructor(parent: import("./tween.js").Tween);
     parent: import("./tween.js").Tween;
@@ -29,53 +29,53 @@ export class TweenData {
     isRunning: boolean;
     isFrom: boolean;
     /**
-     * TBD.
-     * @param {object} properties - TBD.
-     * @param {number} duration - TBD.
-     * @param {(number) => number} ease - TBD.
-     * @param {number} delay - TBD.
-     * @param {number} repeat - TBD.
-     * @param {boolean} yoyo - TBD.
-     * @returns {TweenData} TBD.
+     * Sets the target properties to tween to.
+     * @param {object} properties - The properties to tween to.
+     * @param {number} duration - The duration of the tween in milliseconds.
+     * @param {(number) => number} ease - The easing function to use.
+     * @param {number} delay - The delay before starting the tween in milliseconds.
+     * @param {number} repeat - The number of times to repeat the tween (0 = no repeat, -1 = infinite).
+     * @param {boolean} yoyo - Whether to reverse the tween on each repeat.
+     * @returns {TweenData} This TweenData object for chaining.
      */
     to(properties: object, duration: number, ease: (number: any) => number, delay: number, repeat: number, yoyo: boolean): TweenData;
     /**
-     * TBD.
-     * @param {object} properties - TBD.
-     * @param {number} duration - TBD.
-     * @param {(number) => number} ease - TBD.
-     * @param {number} delay - TBD.
-     * @param {number} repeat - TBD.
-     * @param {boolean} yoyo - TBD.
-     * @returns {TweenData} TBD.
+     * Sets the target properties to tween from (in reverse).
+     * @param {object} properties - The properties to tween from.
+     * @param {number} duration - The duration of the tween in milliseconds.
+     * @param {(number) => number} ease - The easing function to use.
+     * @param {number} delay - The delay before starting the tween in milliseconds.
+     * @param {number} repeat - The number of times to repeat the tween (0 = no repeat, -1 = infinite).
+     * @param {boolean} yoyo - Whether to reverse the tween on each repeat.
+     * @returns {TweenData} This TweenData object for chaining.
      */
     from(properties: object, duration: number, ease: (number: any) => number, delay: number, repeat: number, yoyo: boolean): TweenData;
     /**
-     * TBD.
-     * @returns {TweenData} TBD.
+     * Starts the tween.
+     * @returns {TweenData} This TweenData object for chaining.
      */
     start(): TweenData;
     yoyoCounter: number;
     /**
-     * TBD.
-     * @returns {TweenData} TBD.
+     * Loads the tween values from the parent object.
+     * @returns {TweenData} This TweenData object for chaining.
      */
     loadValues(): TweenData;
     /**
-     * TBD.
-     * @param {number} time - TBD.
-     * @returns {number} TBD.
+     * Updates the tween at a given time.
+     * @param {number} time - The current time in milliseconds.
+     * @returns {number} The tween status (TWEEN_PENDING, TWEEN_RUNNING, or TWEEN_COMPLETE).
      */
     update(time: number): number;
     /**
-     * TBD.
-     * @param {number} frameRate - TBD.
-     * @returns {object[]} TBD.
+     * Generates an array of tween data points for a given frame rate.
+     * @param {number} frameRate - The frame rate to generate data for.
+     * @returns {object[]} An array of tween data points.
      */
     generateData(frameRate: number): object[];
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Handles tween repetition logic.
+     * @returns {number} The tween status (TWEEN_LOOPED or TWEEN_COMPLETE).
      */
     repeat(): number;
 }

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

@@ -1,7 +1,7 @@
 export class TweenManager {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
+     * Creates a new TweenManager instance.
+     * @param {import('./game.js').Game} game - The game instance this manager belongs to.
      */
     constructor(game: import("./game.js").Game);
     game: import("./game.js").Game;
@@ -14,61 +14,66 @@ export class TweenManager {
         [key: string]: (k: number) => number;
     };
     /**
-     * TBD.
-     * @returns {Tween[]} TBD.
+     * Get all tweens managed by this manager.
+     * @returns {Tween[]} An array of all active tweens.
      */
     getAll(): Tween[];
     /**
-     * TBD.
+     * Remove all tweens from the manager.
+     * This method removes all active and pending tweens.
      */
     removeAll(): void;
     /**
-     * TBD.
-     * @param {object} obj - TBD.
-     * @param {object[]} children - TBD.
+     * Remove tweens associated with an object or its children.
+     * @param {object} obj - The object to remove tweens from.
+     * @param {object[]} children - Optional array of child objects to remove tweens from.
      */
     removeFrom(obj: object, children?: object[]): void;
     /**
-     * TBD.
-     * @param {Tween} tween - TBD.
+     * Add a tween to the manager.
+     * @param {Tween} tween - The tween to add.
      */
     add(tween: Tween): void;
     /**
-     * TBD.
-     * @param {object} object - TBD.
-     * @returns {Tween} TBD.
+     * Create a new tween for an object.
+     * @param {object} object - The object to create a tween for.
+     * @returns {Tween} The created Tween object.
      */
     create(object: object): Tween;
     /**
-     * TBD.
-     * @param {Tween | null | undefined} tween - TBD.
+     * Remove a tween from the manager.
+     * @param {Tween | null | undefined} tween - The tween to remove.
      */
     remove(tween: Tween | null | undefined): void;
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Update all tweens managed by this manager.
+     * @returns {boolean} True if any tweens were updated, false otherwise.
      */
     update(): boolean;
     /**
-     * TBD.
-     * @param {object} object - TBD.
-     * @returns {boolean} TBD.
+     * Check if an object is currently being tweened.
+     * @param {object} object - The object to check.
+     * @returns {boolean} True if the object is being tweened, false otherwise.
      */
     isTweening(object: object): boolean;
     /**
-     * TBD.
+     * Pause all tweens managed by this manager.
+     * This method pauses all active tweens.
      */
     _pauseAll(): void;
     /**
-     * TBD.
+     * Resume all tweens managed by this manager.
+     * This method resumes all paused tweens.
      */
     _resumeAll(): void;
     /**
-     * TBD.
+     * Pause all tweens managed by this manager.
+     * This method pauses all active tweens.
      */
     pauseAll(): void;
     /**
-     * TBD.
+     * Resume all tweens managed by this manager.
+     * This method resumes all paused tweens.
      */
     resumeAll(): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"tween_manager.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/tween_manager.js"],"names":[],"mappings":"AAoCA;IACE;;;OAGG;IACH,kBAFW,OAAO,WAAW,EAAE,IAAI,EAuDlC;IApDC,+BAAgB;IAChB,sBAAsB;IACtB,SADW,KAAK,EAAE,CACD;IACjB,sBAAsB;IACtB,MADW,KAAK,EAAE,CACJ;IACd,qDAAqD;IACrD,SADW;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;KAAC,CA2ChD;IAMH;;;OAGG;IACH,UAFa,KAAK,EAAE,CAInB;IAED;;OAEG;IACH,kBAKC;IAED;;;;OAIG;IACH,gBAHW,MAAM,aACN,MAAM,EAAE,QAyBlB;IAED;;;OAGG;IACH,WAFW,KAAK,QAKf;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,KAAK,CAIjB;IAED;;;OAGG;IACH,cAFW,KAAK,GAAG,IAAI,GAAG,SAAS,QAYlC;IAED;;;OAGG;IACH,UAFa,OAAO,CAuBnB;IAED;;;;OAIG;IACH,mBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;OAEG;IACH,kBAIC;IAED;;OAEG;IACH,mBAIC;IAED;;OAEG;IACH,iBAIC;IAED;;OAEG;IACH,kBAIC;CACF;sBAxPqB,YAAY"}
+{"version":3,"file":"tween_manager.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/tween_manager.js"],"names":[],"mappings":"AAoCA;IACE;;;OAGG;IACH,kBAFW,OAAO,WAAW,EAAE,IAAI,EAuDlC;IApDC,+BAAgB;IAChB,sBAAsB;IACtB,SADW,KAAK,EAAE,CACD;IACjB,sBAAsB;IACtB,MADW,KAAK,EAAE,CACJ;IACd,qDAAqD;IACrD,SADW;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;KAAC,CA2ChD;IAMH;;;OAGG;IACH,UAFa,KAAK,EAAE,CAInB;IAED;;;OAGG;IACH,kBAKC;IAED;;;;OAIG;IACH,gBAHW,MAAM,aACN,MAAM,EAAE,QAyBlB;IAED;;;OAGG;IACH,WAFW,KAAK,QAKf;IAED;;;;OAIG;IACH,eAHW,MAAM,GACJ,KAAK,CAIjB;IAED;;;OAGG;IACH,cAFW,KAAK,GAAG,IAAI,GAAG,SAAS,QAYlC;IAED;;;OAGG;IACH,UAFa,OAAO,CAuBnB;IAED;;;;OAIG;IACH,mBAHW,MAAM,GACJ,OAAO,CAInB;IAED;;;OAGG;IACH,kBAIC;IAED;;;OAGG;IACH,mBAIC;IAED;;;OAGG;IACH,iBAIC;IAED;;;OAGG;IACH,kBAIC;CACF;sBA7PqB,YAAY"}

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

@@ -1,11 +1,12 @@
 export class World extends Group {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
+     * Creates a new World instance.
+     * @param {import('./game.js').Game} game - The game instance this world belongs to.
      */
     constructor(game: import("./game.js").Game);
     /**
-     * TBD.
+     * Initialize the world.
+     * This method is called when the game boots and sets up the world.
      */
     boot(): void;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"world.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/world.js"],"names":[],"mappings":"AAEA;IACE;;;OAGG;IACH,kBAFW,OAAO,WAAW,EAAE,IAAI,EAIlC;IAED;;OAEG;IACH,aAEC;CACF;sBAjBqB,qBAAqB"}
+{"version":3,"file":"world.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/world.js"],"names":[],"mappings":"AAEA;IACE;;;OAGG;IACH,kBAFW,OAAO,WAAW,EAAE,IAAI,EAIlC;IAED;;;OAGG;IACH,aAEC;CACF;sBAlBqB,qBAAqB"}