@vpmedia/phaser 1.95.0 → 1.96.0

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

@@ -1,13 +1,13 @@
 export class Animation {
     /**
-     * TBD.
-     * @param {import('./game.js').Game} game - TBD.
-     * @param {import('../display/image.js').Image} parent - TBD.
-     * @param {string} name - TBD.
-     * @param {import('./frame_data.js').FrameData} frameData - TBD.
-     * @param {string[]|number[]} frames - TBD.
-     * @param {number} frameRate - TBD.
-     * @param {boolean} loop - TBD.
+     * Creates a new Animation instance.
+     * @param {import('./game.js').Game} game - The game instance this animation belongs to.
+     * @param {import('../display/image.js').Image} parent - The Image object that owns this animation.
+     * @param {string} name - The unique name of this animation.
+     * @param {import('./frame_data.js').FrameData} frameData - The FrameData object that contains the frames for this animation.
+     * @param {string[]|number[]} frames - An array of frame identifiers (names or indices) to use in this animation.
+     * @param {number} frameRate - The frame rate at which this animation should play (frames per second).
+     * @param {boolean} loop - Whether the animation should loop when it completes.
      */
     constructor(game: import("./game.js").Game, parent: import("../display/image.js").Image, name: string, frameData: import("./frame_data.js").FrameData, frames: string[] | number[], frameRate: number, loop?: boolean);
     /** @type {import('./game.js').Game} */
@@ -50,131 +50,136 @@ export class Animation {
     /** @type {boolean} */
     isReversed: boolean;
     /**
-     * TBD.
-     * @param {number} frameRate - TBD.
-     * @param {boolean} loop - TBD.
-     * @returns {Animation} TBD.
+     * Plays this animation.
+     * @param {number} frameRate - The new frame rate to use for this animation (if null, uses the original frame rate).
+     * @param {boolean} loop - Whether to loop this animation (if null, uses the original loop setting).
+     * @returns {Animation} This Animation instance for chaining.
      */
     play(frameRate?: number, loop?: boolean): Animation;
     /**
-     * TBD.
+     * Sets whether this animation is currently paused.
+     * @param {boolean} value - True to pause the animation, false to resume it.
      */
     set paused(value: boolean);
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Gets whether this animation is currently paused.
+     * @returns {boolean} True if the animation is paused, false otherwise.
      */
     get paused(): boolean;
     _timeLastFrame: number;
     _timeNextFrame: number;
     /**
-     * TBD.
+     * Restarts this animation from the beginning.
      */
     restart(): void;
     /**
-     * TBD.
-     * @returns {Animation} TBD.
+     * Reverses the direction of this animation.
+     * @returns {Animation} This Animation instance for chaining.
      */
     reverse(): Animation;
     /**
-     * TBD.
+     * Sets whether this animation is currently reversed.
+     * @param {boolean} value - True to reverse the animation, false to normal direction.
      */
     set reversed(value: boolean);
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Gets whether this animation is currently reversed.
+     * @returns {boolean} True if the animation is reversed, false otherwise.
      */
     get reversed(): boolean;
     /**
-     * TBD.
-     * @returns {Animation} TBD.
+     * Reverses the animation direction once, then returns to normal direction.
+     * @returns {Animation} This Animation instance for chaining.
      */
     reverseOnce(): Animation;
     /**
-     * TBD.
-     * @param {string|number} frameId - TBD.
-     * @param {boolean} useLocalFrameIndex - TBD.
+     * Sets the current frame of this animation.
+     * @param {string|number} frameId - The identifier (name or index) of the frame to set.
+     * @param {boolean} useLocalFrameIndex - If true, treats frameId as an index into the local frames array.
      */
     setFrame(frameId: string | number, useLocalFrameIndex?: boolean): void;
     /**
-     * TBD.
-     * @param {boolean} resetFrame - TBD.
-     * @param {boolean} dispatchComplete - TBD.
+     * Stops this animation.
+     * @param {boolean} resetFrame - If true, resets to the first frame.
+     * @param {boolean} dispatchComplete - If true, dispatches the onComplete signal.
      */
     stop(resetFrame?: boolean, dispatchComplete?: boolean): void;
     /**
-     * TBD.
+     * Called when the game is paused.
      */
     onPause(): void;
     /**
-     * TBD.
+     * Called when the game is resumed.
      */
     onResume(): void;
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Updates this animation.
+     * @returns {boolean} True if the animation was updated, false otherwise.
      */
     update(): boolean;
     /**
-     * TBD.
-     * @param {boolean} signalUpdate - TBD.
-     * @param {boolean} fromPlay - TBD.
-     * @returns {boolean} TBD.
+     * Updates the current frame of this animation.
+     * @param {boolean} signalUpdate - Whether to signal the update event.
+     * @param {boolean} fromPlay - Whether this call is from play().
+     * @returns {boolean} True if the frame was updated, false otherwise.
      */
     updateCurrentFrame(signalUpdate: boolean, fromPlay?: boolean): boolean;
     /**
-     * TBD.
-     * @param {number} quantity - TBD.
+     * Advances the animation to the next frame(s).
+     * @param {number} quantity - The number of frames to advance by.
      */
     next(quantity?: number): void;
     /**
-     * TBD.
-     * @param {number} quantity - TBD.
+     * Moves the animation to the previous frame(s).
+     * @param {number} quantity - The number of frames to move back by.
      */
     previous(quantity?: number): void;
     /**
-     * TBD.
-     * @param {import('./frame_data.js').FrameData} frameData - TBD.
+     * Updates the frame data used by this animation.
+     * @param {import('./frame_data.js').FrameData} frameData - The new FrameData object to use.
      */
     updateFrameData(frameData: import("./frame_data.js").FrameData): void;
     /**
-     * TBD.
+     * Destroys this animation and cleans up resources.
      */
     destroy(): void;
     /**
-     * TBD.
+     * Completes this animation, setting it to the final frame.
      */
     complete(): void;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the total number of frames in this animation.
+     * @returns {number} The total number of frames.
      */
     get frameTotal(): number;
     /**
-     * TBD.
+     * Sets the current frame index.
+     * @param {number} value - The new frame index to set.
      */
     set frame(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the current frame index.
+     * @returns {number} The current frame index.
      */
     get frame(): number;
     /**
-     * TBD.
+     * Sets the animation speed (frame rate).
+     * @param {number} value - The new frame rate in frames per second.
      */
     set speed(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the current animation speed (frame rate).
+     * @returns {number} The frame rate in frames per second.
      */
     get speed(): number;
     /**
-     * TBD.
+     * Sets whether the update signal is enabled.
+     * @param {boolean} value - True to enable the update signal, false to disable it.
      */
     set enableUpdate(value: boolean);
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Gets whether the update signal is enabled.
+     * @returns {boolean} True if the update signal is enabled, false otherwise.
      */
     get enableUpdate(): boolean;
 }

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

@@ -1 +1 @@
-{"version":3,"file":"animation.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/animation.js"],"names":[],"mappings":"AAEA;IACE;;;;;;;;;OASG;IACH,kBARW,OAAO,WAAW,EAAE,IAAI,UACxB,OAAO,qBAAqB,EAAE,KAAK,QACnC,MAAM,aACN,OAAO,iBAAiB,EAAE,SAAS,UACnC,MAAM,EAAE,GAAC,MAAM,EAAE,aACjB,MAAM,SACN,OAAO,EA8CjB;IA3CC,uCAAuC;IACvC,MADW,OAAO,WAAW,EAAE,IAAI,CACnB;IAChB,6CAAqB;IACrB,kDAAkD;IAClD,YADW,OAAO,iBAAiB,EAAE,SAAS,CACnB;IAC3B,qBAAqB;IACrB,MADW,MAAM,CACD;IAChB,eAAiB;IAEjB,qBAAqB;IACrB,OADW,MAAM,CACY;IAC7B,sBAAsB;IACtB,MADW,OAAO,CACF;IAChB,qBAAqB;IACrB,WADW,MAAM,CACC;IAClB,sBAAsB;IACtB,YADW,OAAO,CACK;IACvB,sBAAsB;IACtB,WADW,OAAO,CACI;IACtB,sBAAsB;IACtB,UADW,OAAO,CACG;IACrB,qBAAqB;IACrB,iBADW,MAAM,CACO;IACxB,qBAAqB;IACrB,aADW,MAAM,CACG;IACpB,qBAAqB;IACrB,YADW,MAAM,CACE;IACnB,qBAAqB;IACrB,YADW,MAAM,CACE;IACnB,yCAA4E;IAC5E,qBAAqB;IACrB,SADW,MAAM,CACU;IAC3B,qBAAqB;IACrB,UADW,MAAM,CACG;IACpB,qBAAqB;IACrB,YADW,MAAM,CACa;IAC9B,qBAAqB;IACrB,QADW,MAAM,CACS;IAC1B,sBAAsB;IACtB,YADW,OAAO,CACK;IAMzB;;;;;OAKG;IACH,iBAJW,MAAM,SACN,OAAO,GACL,SAAS,CAwBrB;IAiSD;;OAEG;IACH,kBATa,OAAO,EAgBnB;IAlBD;;;OAGG;IACH,cAFa,OAAO,CAInB;IAxSC,uBAAyC;IACzC,uBAAsD;IAUxD;;OAEG;IACH,gBAaC;IAED;;;OAGG;IACH,WAFa,SAAS,CAKrB;IA0RD;;OAEG;IACH,oBATa,OAAO,EAWnB;IAbD;;;OAGG;IACH,gBAFa,OAAO,CAInB;IAtRD;;;OAGG;IACH,eAFa,SAAS,CAKrB;IAED;;;;OAIG;IACH,kBAHW,MAAM,GAAC,MAAM,uBACb,OAAO,QA6BjB;IAED;;;;OAIG;IACH,kBAHW,OAAO,qBACP,OAAO,QAgBjB;IAED;;OAEG;IACH,gBAIC;IAED;;OAEG;IACH,iBAIC;IAED;;;OAGG;IACH,UAFa,OAAO,CAuDnB;IAED;;;;;OAKG;IACH,iCAJW,OAAO,aACP,OAAO,GACL,OAAO,CAmBnB;IAED;;;OAGG;IACH,gBAFW,MAAM,QAehB;IAED;;;OAGG;IACH,oBAFW,MAAM,QAehB;IAED;;;OAGG;IACH,2BAFW,OAAO,iBAAiB,EAAE,SAAS,QAO7C;IAED;;OAEG;IACH,gBAmBC;IAED;;OAEG;IACH,iBAQC;IAqCD;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAaD;;OAEG;IACH,iBAZa,MAAM,EAqBlB;IAvBD;;;OAGG;IACH,aAFa,MAAM,CAOlB;IAwBD;;OAEG;IACH,iBATa,MAAM,EAalB;IAfD;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAmBD;;OAEG;IACH,wBATa,OAAO,EAgBnB;IAlBD;;;OAGG;IACH,oBAFa,OAAO,CAInB;CAaF;uBAxdsB,aAAa"}
+{"version":3,"file":"animation.d.ts","sourceRoot":"","sources":["../../../src/phaser/core/animation.js"],"names":[],"mappings":"AAEA;IACE;;;;;;;;;OASG;IACH,kBARW,OAAO,WAAW,EAAE,IAAI,UACxB,OAAO,qBAAqB,EAAE,KAAK,QACnC,MAAM,aACN,OAAO,iBAAiB,EAAE,SAAS,UACnC,MAAM,EAAE,GAAC,MAAM,EAAE,aACjB,MAAM,SACN,OAAO,EA8CjB;IA3CC,uCAAuC;IACvC,MADW,OAAO,WAAW,EAAE,IAAI,CACnB;IAChB,6CAAqB;IACrB,kDAAkD;IAClD,YADW,OAAO,iBAAiB,EAAE,SAAS,CACnB;IAC3B,qBAAqB;IACrB,MADW,MAAM,CACD;IAChB,eAAiB;IAEjB,qBAAqB;IACrB,OADW,MAAM,CACY;IAC7B,sBAAsB;IACtB,MADW,OAAO,CACF;IAChB,qBAAqB;IACrB,WADW,MAAM,CACC;IAClB,sBAAsB;IACtB,YADW,OAAO,CACK;IACvB,sBAAsB;IACtB,WADW,OAAO,CACI;IACtB,sBAAsB;IACtB,UADW,OAAO,CACG;IACrB,qBAAqB;IACrB,iBADW,MAAM,CACO;IACxB,qBAAqB;IACrB,aADW,MAAM,CACG;IACpB,qBAAqB;IACrB,YADW,MAAM,CACE;IACnB,qBAAqB;IACrB,YADW,MAAM,CACE;IACnB,yCAA4E;IAC5E,qBAAqB;IACrB,SADW,MAAM,CACU;IAC3B,qBAAqB;IACrB,UADW,MAAM,CACG;IACpB,qBAAqB;IACrB,YADW,MAAM,CACa;IAC9B,qBAAqB;IACrB,QADW,MAAM,CACS;IAC1B,sBAAsB;IACtB,YADW,OAAO,CACK;IAMzB;;;;;OAKG;IACH,iBAJW,MAAM,SACN,OAAO,GACL,SAAS,CAwBrB;IAiSD;;;OAGG;IACH,kBAFW,OAAO,EASjB;IAnBD;;;OAGG;IACH,cAFa,OAAO,CAInB;IAxSC,uBAAyC;IACzC,uBAAsD;IAUxD;;OAEG;IACH,gBAaC;IAED;;;OAGG;IACH,WAFa,SAAS,CAKrB;IA2RD;;;OAGG;IACH,oBAFW,OAAO,EAIjB;IAdD;;;OAGG;IACH,gBAFa,OAAO,CAInB;IAvRD;;;OAGG;IACH,eAFa,SAAS,CAKrB;IAED;;;;OAIG;IACH,kBAHW,MAAM,GAAC,MAAM,uBACb,OAAO,QA6BjB;IAED;;;;OAIG;IACH,kBAHW,OAAO,qBACP,OAAO,QAgBjB;IAED;;OAEG;IACH,gBAIC;IAED;;OAEG;IACH,iBAIC;IAED;;;OAGG;IACH,UAFa,OAAO,CAuDnB;IAED;;;;;OAKG;IACH,iCAJW,OAAO,aACP,OAAO,GACL,OAAO,CAmBnB;IAED;;;OAGG;IACH,gBAFW,MAAM,QAehB;IAED;;;OAGG;IACH,oBAFW,MAAM,QAehB;IAED;;;OAGG;IACH,2BAFW,OAAO,iBAAiB,EAAE,SAAS,QAO7C;IAED;;OAEG;IACH,gBAmBC;IAED;;OAEG;IACH,iBAQC;IAuCD;;;OAGG;IACH,kBAFa,MAAM,CAIlB;IAaD;;;OAGG;IACH,iBAFW,MAAM,EAWhB;IAxBD;;;OAGG;IACH,aAFa,MAAM,CAOlB;IAyBD;;;OAGG;IACH,iBAFW,MAAM,EAMhB;IAhBD;;;OAGG;IACH,aAFa,MAAM,CAIlB;IAoBD;;;OAGG;IACH,wBAFW,OAAO,EASjB;IAnBD;;;OAGG;IACH,oBAFa,OAAO,CAInB;CAcF;uBA7dsB,aAAa"}

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

@@ -1,7 +1,7 @@
 export class AnimationManager {
     /**
-     * TBD.
-     * @param {import('../display/image.js').Image} sprite - TBD.
+     * Creates a new AnimationManager instance.
+     * @param {import('../display/image.js').Image} sprite - Reference to the parent Sprite.
      */
     constructor(sprite: import("../display/image.js").Image);
     sprite: import("../display/image.js").Image;
@@ -21,119 +21,119 @@ export class AnimationManager {
     /** @type {number[]} */
     _outputFrames: number[];
     /**
-     * TBD.
+     * Destroys the AnimationManager and cleans up resources.
      */
     destroy(): void;
     /**
-     * TBD.
-     * @param {import('./frame_data.js').FrameData} frameData - TBD.
-     * @param {string|number} frame - TBD.
-     * @returns {boolean} TBD.
+     * Loads frame data into the AnimationManager.
+     * @param {import('./frame_data.js').FrameData} frameData - The FrameData to load.
+     * @param {string|number} frame - The frame index or name to set as current.
+     * @returns {boolean} True if the frame data was loaded successfully, false otherwise.
      */
     loadFrameData(frameData: import("./frame_data.js").FrameData, frame: string | number): boolean;
     /**
-     * TBD.
+     * Sets the current frame index.
      */
     set frame(value: number);
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the current frame index.
+     * @returns {number} The current frame index.
      */
     get frame(): number;
     /**
-     * TBD.
+     * Sets the current frame by name.
      */
     set frameName(value: string);
     /**
-     * TBD.
-     * @returns {string} TBD.
+     * Gets the current frame name.
+     * @returns {string} The current frame name, or null if no frame is set.
      */
     get frameName(): string;
     /**
-     * TBD.
-     * @param {import('./frame_data.js').FrameData} frameData - TBD.
-     * @param {string|number} frame - TBD.
-     * @returns {boolean} TBD.
+     * Copies frame data into the AnimationManager.
+     * @param {import('./frame_data.js').FrameData} frameData - The FrameData to copy.
+     * @param {string|number} frame - The frame index or name to set as current.
+     * @returns {boolean} True if the frame data was copied successfully, false otherwise.
      */
     copyFrameData(frameData: import("./frame_data.js").FrameData, frame: string | number): boolean;
     /**
-     * TBD.
-     * @param {string} name - TBD.
-     * @param {number[] | string[] | null | undefined} frameList - TBD.
-     * @param {number} frameRate - TBD.
-     * @param {boolean} loop - TBD.
-     * @param {boolean | undefined} useNumericIndex - TBD.
-     * @returns {Animation} TBD.
+     * Adds a new animation to the AnimationManager.
+     * @param {string} name - The name of the animation.
+     * @param {number[] | string[] | null | undefined} frameList - The list of frames to include in the animation.
+     * @param {number} frameRate - The frame rate of the animation (frames per second).
+     * @param {boolean} loop - Whether the animation should loop.
+     * @param {boolean | undefined} useNumericIndex - Whether to treat frameList as numeric indices.
+     * @returns {Animation} The created Animation object.
      */
     add(name: string, frameList: number[] | string[] | null | undefined, frameRate?: number, loop?: boolean, useNumericIndex?: boolean | undefined): Animation;
     /**
-     * TBD.
-     * @param {string[] | number[]} frames - TBD.
-     * @param {boolean} useNumericIndex - TBD.
-     * @returns {boolean} TBD.
+     * Validates a list of frames against the current frame data.
+     * @param {string[] | number[]} frames - The list of frames to validate.
+     * @param {boolean} useNumericIndex - Whether to treat frameList as numeric indices.
+     * @returns {boolean} True if all frames are valid, false otherwise.
      */
     validateFrames(frames: string[] | number[], useNumericIndex?: boolean): boolean;
     /**
-     * TBD.
-     * @param {string} name - TBD.
-     * @param {number} frameRate - TBD.
-     * @param {boolean} loop - TBD.
-     * @returns {Animation} TBD.
+     * Plays an animation by name.
+     * @param {string} name - The name of the animation to play.
+     * @param {number} frameRate - The frame rate (frames per second) to play at, or null to use the animation's default.
+     * @param {boolean} loop - Whether the animation should loop, or null to use the animation's default.
+     * @returns {Animation} The Animation object that was played, or null if not found.
      */
     play(name: string, frameRate?: number, loop?: boolean): Animation;
     /**
-     * TBD.
-     * @param {string} name - TBD.
-     * @param {boolean} resetFrame - TBD.
+     * Stops an animation by name.
+     * @param {string} name - The name of the animation to stop, or null to stop the current animation.
+     * @param {boolean} resetFrame - Whether to reset the frame to the first frame of the animation.
      */
     stop(name?: string, resetFrame?: boolean): void;
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Updates the animation manager state.
+     * @returns {boolean} True if an animation was updated, false otherwise.
      */
     update(): boolean;
     /**
-     * TBD.
-     * @param {number} quantity - TBD.
+     * Advances the current animation by a specified number of frames.
+     * @param {number} quantity - The number of frames to advance by.
      */
     next(quantity: number): void;
     /**
-     * TBD.
-     * @param {number} quantity - TBD.
+     * Moves the current animation back by a specified number of frames.
+     * @param {number} quantity - The number of frames to move back by.
      */
     previous(quantity: number): void;
     /**
-     * TBD.
-     * @param {string} name - TBD.
-     * @returns {Animation} TBD.
+     * Gets an animation by name.
+     * @param {string} name - The name of the animation to retrieve.
+     * @returns {Animation} The Animation object, or null if not found.
      */
     getAnimation(name: string): Animation;
     /**
-     * TBD.
+     * Refreshes the current frame texture (not implemented).
      */
     refreshFrame(): void;
     /**
-     * TBD.
-     * @returns {import('./frame_data.js').FrameData} TBD.
+     * Gets the frame data used by this AnimationManager.
+     * @returns {import('./frame_data.js').FrameData} The FrameData object.
      */
     get frameData(): import("./frame_data.js").FrameData;
     /**
-     * TBD.
-     * @returns {number} TBD.
+     * Gets the total number of frames in the frame data.
+     * @returns {number} The total number of frames.
      */
     get frameTotal(): number;
     /**
-     * TBD.
+     * Sets the paused state of the current animation.
      */
     set paused(value: boolean);
     /**
-     * TBD.
-     * @returns {boolean} TBD.
+     * Gets the paused state of the current animation.
+     * @returns {boolean} True if the current animation is paused, false otherwise.
      */
     get paused(): boolean;
     /**
-     * TBD.
-     * @returns {string} TBD.
+     * Gets the name of the current animation.
+     * @returns {string} The name of the current animation, or null if no animation is active.
      */
     get name(): string;
     _frameIndex: number;