@vpmedia/phaser 1.112.0 → 1.113.0

package/src/phaser/core/animation.ts

@@ -1,52 +1,56 @@
 import { Signal } from './signal.js';
+import type { Game } from './game.js';
+import type { Image } from '../display/image.js';
+import type { FrameData } from './frame_data.js';
+import type { Frame } from './frame.js';
 
 export class Animation {
-  game!: import('./game.js').Game;
-  _parent!: import('../display/image.js').Image;
-  _frameData!: import('./frame_data.js').FrameData;
-  name!: string;
-  _frames!: any;
-  delay!: number;
-  loop!: boolean;
-  loopCount!: number;
-  isFinished!: boolean;
-  isPlaying!: boolean;
-  isPaused!: boolean;
-  _pauseStartTime!: number;
-  _frameIndex!: number;
-  _frameDiff!: number;
-  _frameSkip!: number;
-  currentFrame!: import('./frame.js').Frame | null;
-  onStart!: Signal;
-  onUpdate!: Signal | null;
-  onComplete!: Signal;
-  onLoop!: Signal;
-  isReversed!: boolean;
-  _timeLastFrame!: number;
-  _timeNextFrame!: number;
+  public game!: Game;
+  public _parent!: Image;
+  public _frameData!: FrameData;
+  public name!: string;
+  public _frames!: any;
+  public delay!: number;
+  public loop!: boolean;
+  public loopCount!: number;
+  public isFinished!: boolean;
+  public isPlaying!: boolean;
+  public isPaused!: boolean;
+  public _pauseStartTime!: number;
+  public _frameIndex!: number;
+  public _frameDiff!: number;
+  public _frameSkip!: number;
+  public currentFrame!: Frame | null;
+  public onStart!: Signal;
+  public onUpdate!: Signal | null;
+  public onComplete!: Signal;
+  public onLoop!: Signal;
+  public isReversed!: boolean;
+  public _timeLastFrame!: number;
+  public _timeNextFrame!: number;
   /**
    * 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 {Game} game - The game instance this animation belongs to.
+   * @param {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 {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,
+  public constructor(
+    game: Game,
+    parent: Image,
     name: string,
-    frameData: import('./frame_data.js').FrameData,
+    frameData: FrameData,
     frames: string[] | number[],
     frameRate: number,
-    loop: boolean = false
+    loop = false
   ) {
-    /** @type {import('./game.js').Game} */
+    /** @type {Game} */
     this.game = game;
     this._parent = parent;
-    /** @type {import('./frame_data.js').FrameData} */
+    /** @type {FrameData} */
     this._frameData = frameData;
     /** @type {string} */
     this.name = name;
@@ -94,7 +98,7 @@ export class Animation {
    * @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 | null = null, loop: boolean | null = null) {
+  public play(frameRate: number | null = null, loop: boolean | null = null) {
     if (typeof frameRate === 'number') {
       //  If they set a new frame rate then use it, otherwise use the one set on creation
       this.delay = 1000 / frameRate;
@@ -121,7 +125,7 @@ export class Animation {
   /**
    * Restarts this animation from the beginning.
    */
-  restart() {
+  public restart() {
     this.isPlaying = true;
     this.isFinished = false;
     this.paused = false;
@@ -140,7 +144,7 @@ export class Animation {
    * Reverses the direction of this animation.
    * @returns {Animation} This Animation instance for chaining.
    */
-  reverse() {
+  public reverse() {
     this.reversed = !this.reversed;
     return this;
   }
@@ -149,7 +153,7 @@ export class Animation {
    * Reverses the animation direction once, then returns to normal direction.
    * @returns {Animation} This Animation instance for chaining.
    */
-  reverseOnce() {
+  public reverseOnce() {
     this.onComplete.addOnce(this.reverse, this);
     this.reverse();
     return this;
@@ -160,7 +164,7 @@ export class 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 = false) {
+  public setFrame(frameId: string | number, useLocalFrameIndex = false) {
     let frameIndex;
     //  Find the index to the desired frame.
     if (typeof frameId === 'string') {
@@ -194,7 +198,7 @@ export class Animation {
    * @param {boolean} resetFrame - If true, resets to the first frame.
    * @param {boolean} dispatchComplete - If true, dispatches the onComplete signal.
    */
-  stop(resetFrame: boolean = false, dispatchComplete: boolean = false) {
+  public stop(resetFrame = false, dispatchComplete = false) {
     this.isPlaying = false;
     this.isFinished = true;
     this.paused = false;
@@ -213,7 +217,7 @@ export class Animation {
   /**
    * Called when the game is paused.
    */
-  onPause() {
+  public onPause() {
     if (this.isPlaying) {
       this._frameDiff = this._timeNextFrame - this.game.time.time;
     }
@@ -222,7 +226,7 @@ export class Animation {
   /**
    * Called when the game is resumed.
    */
-  onResume() {
+  public onResume() {
     if (this.isPlaying) {
       this._timeNextFrame = this.game.time.time + this._frameDiff;
     }
@@ -232,7 +236,7 @@ export class Animation {
    * Updates this animation.
    * @returns {boolean} True if the animation was updated, false otherwise.
    */
-  update() {
+  public update() {
     if (this.isPaused) {
       return false;
     }
@@ -293,7 +297,7 @@ export class Animation {
    * @param {boolean} fromPlay - Whether this call is from play().
    * @returns {boolean} True if the frame was updated, false otherwise.
    */
-  updateCurrentFrame(signalUpdate: boolean, fromPlay: boolean = false) {
+  public updateCurrentFrame(signalUpdate: boolean, fromPlay = false) {
     if (!this._frameData || !this.currentFrame) {
       // The animation is already destroyed, probably from a callback
       return false;
@@ -316,7 +320,7 @@ export class Animation {
    * Advances the animation to the next frame(s).
    * @param {number} quantity - The number of frames to advance by.
    */
-  next(quantity: number = 1) {
+  public next(quantity = 1) {
     let frame = this._frameIndex + quantity;
     if (frame >= this._frames.length) {
       if (this.loop) {
@@ -335,7 +339,7 @@ export class Animation {
    * Moves the animation to the previous frame(s).
    * @param {number} quantity - The number of frames to move back by.
    */
-  previous(quantity: number = 1) {
+  public previous(quantity = 1) {
     let frame = this._frameIndex - quantity;
     if (frame < 0) {
       if (this.loop) {
@@ -352,9 +356,9 @@ export class Animation {
 
   /**
    * Updates the frame data used by this animation.
-   * @param {import('./frame_data.js').FrameData} frameData - The new FrameData object to use.
+   * @param {FrameData} frameData - The new FrameData object to use.
    */
-  updateFrameData(frameData: import('./frame_data.js').FrameData) {
+  public updateFrameData(frameData: FrameData) {
     this._frameData = frameData;
     this.currentFrame = this._frameData
       ? this._frameData.getFrame(this._frames[this._frameIndex % this._frames.length])
@@ -364,7 +368,7 @@ export class Animation {
   /**
    * Destroys this animation and cleans up resources.
    */
-  destroy() {
+  public destroy() {
     if (!this._frameData) {
       // Already destroyed
       return;
@@ -388,7 +392,7 @@ export class Animation {
   /**
    * Completes this animation, setting it to the final frame.
    */
-  complete() {
+  public complete() {
     this._frameIndex = this._frames.length - 1;
     this.currentFrame = this._frameData.getFrame(this._frames[this._frameIndex]);
     this.isPlaying = false;
@@ -402,7 +406,7 @@ export class Animation {
    * Gets whether this animation is currently paused.
    * @returns {boolean} True if the animation is paused, false otherwise.
    */
-  get paused() {
+  public get paused() {
     return this.isPaused;
   }
 
@@ -410,7 +414,7 @@ export class Animation {
    * Sets whether this animation is currently paused.
    * @param {boolean} value - True to pause the animation, false to resume it.
    */
-  set paused(value: boolean) {
+  public set paused(value: boolean) {
     this.isPaused = value;
     if (value) {
       this._pauseStartTime = this.game.time.time;
@@ -423,7 +427,7 @@ export class Animation {
    * Gets whether this animation is currently reversed.
    * @returns {boolean} True if the animation is reversed, false otherwise.
    */
-  get reversed() {
+  public get reversed() {
     return this.isReversed;
   }
 
@@ -431,7 +435,7 @@ export class Animation {
    * Sets whether this animation is currently reversed.
    * @param {boolean} value - True to reverse the animation, false to normal direction.
    */
-  set reversed(value: boolean) {
+  public set reversed(value: boolean) {
     this.isReversed = value;
   }
 
@@ -439,7 +443,7 @@ export class Animation {
    * Gets the total number of frames in this animation.
    * @returns {number} The total number of frames.
    */
-  get frameTotal() {
+  public get frameTotal() {
     return this._frames.length;
   }
 
@@ -447,7 +451,7 @@ export class Animation {
    * Gets the current frame index.
    * @returns {number} The current frame index.
    */
-  get frame() {
+  public get frame() {
     if (this.currentFrame !== null) {
       return this.currentFrame.index;
     }
@@ -458,7 +462,7 @@ export class Animation {
    * Sets the current frame index.
    * @param {number} value - The new frame index to set.
    */
-  set frame(value: number) {
+  public set frame(value: number) {
     this.currentFrame = this._frameData.getFrame(this._frames[value]);
     if (this.currentFrame !== null) {
       this._frameIndex = value;
@@ -473,7 +477,7 @@ export class Animation {
    * Gets the current animation speed (frame rate).
    * @returns {number} The frame rate in frames per second.
    */
-  get speed() {
+  public get speed() {
     return 1000 / this.delay;
   }
 
@@ -481,7 +485,7 @@ export class Animation {
    * Sets the animation speed (frame rate).
    * @param {number} value - The new frame rate in frames per second.
    */
-  set speed(value: number) {
+  public set speed(value: number) {
     if (value > 0) {
       this.delay = 1000 / value;
     }
@@ -491,7 +495,7 @@ export class Animation {
    * Gets whether the update signal is enabled.
    * @returns {boolean} True if the update signal is enabled, false otherwise.
    */
-  get enableUpdate() {
+  public get enableUpdate() {
     return this.onUpdate !== null;
   }
 
@@ -499,7 +503,7 @@ export class Animation {
    * Sets whether the update signal is enabled.
    * @param {boolean} value - True to enable the update signal, false to disable it.
    */
-  set enableUpdate(value: boolean) {
+  public set enableUpdate(value: boolean) {
     if (value && this.onUpdate === null) {
       this.onUpdate = new Signal();
     } else if (!value && this.onUpdate !== null) {

package/src/phaser/core/animation_manager.ts

@@ -1,22 +1,24 @@
 import { Animation } from './animation.js';
 import { ENGINE_ERROR_CANNOT_SET_FRAME, ENGINE_ERROR_CANNOT_SET_FRAME_NAME } from './error_code.js';
+import type { Image } from '../display/image.js';
+import type { FrameData } from './frame_data.js';
 
 export class AnimationManager {
-  sprite!: any;
-  game!: any;
-  currentFrame!: any;
-  currentAnim!: any;
-  updateIfVisible!: boolean;
-  isLoaded!: boolean;
-  _frameData!: any;
-  _anims!: Record<string, Animation>;
-  _outputFrames!: number[];
-  _frameIndex!: number;
+  public sprite!: any;
+  public game!: any;
+  public currentFrame!: any;
+  public currentAnim!: any;
+  public updateIfVisible!: boolean;
+  public isLoaded!: boolean;
+  public _frameData!: any;
+  public _anims!: Record<string, Animation>;
+  public _outputFrames!: number[];
+  public _frameIndex!: number;
   /**
    * Creates a new AnimationManager instance.
-   * @param {import('../display/image.js').Image} sprite - Reference to the parent Sprite.
+   * @param {Image} sprite - Reference to the parent Sprite.
    */
-  constructor(sprite: import('../display/image.js').Image) {
+  public constructor(sprite: Image) {
     this.sprite = sprite;
     this.game = sprite.game;
     this.currentFrame = null;
@@ -32,10 +34,9 @@ export class AnimationManager {
   /**
    * Destroys the AnimationManager and cleans up resources.
    */
-  destroy() {
-    const keys = Object.keys(this._anims);
-    for (let i = 0; i < keys.length; i += 1) {
-      this._anims[keys[i]].destroy();
+  public destroy() {
+    for (const anim of Object.values(this._anims)) {
+      anim.destroy();
     }
     this._anims = {};
     this._outputFrames = [];
@@ -48,20 +49,18 @@ export class AnimationManager {
 
   /**
    * Loads frame data into the AnimationManager.
-   * @param {import('./frame_data.js').FrameData} frameData - The FrameData to load.
+   * @param {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) {
+  public loadFrameData(frameData: FrameData, frame: string | number) {
     if (!frameData) {
       return false;
     }
     if (this.isLoaded) {
       // We need to update the frameData that the animations are using
-      const keys = Object.keys(this._anims);
-      for (let i = 0; i < keys.length; i += 1) {
-        const anim = keys[i];
-        this._anims[anim].updateFrameData(frameData);
+      for (const anim of Object.values(this._anims)) {
+        anim.updateFrameData(frameData);
       }
     }
     this._frameData = frameData;
@@ -78,18 +77,16 @@ export class AnimationManager {
 
   /**
    * Copies frame data into the AnimationManager.
-   * @param {import('./frame_data.js').FrameData} frameData - The FrameData to copy.
+   * @param {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) {
+  public copyFrameData(frameData: FrameData, frame: string | number) {
     this._frameData = frameData.clone();
     if (this.isLoaded) {
       // We need to update the frameData that the animations are using
-      const keys = Object.keys(this._anims);
-      for (let i = 0; i < keys.length; i += 1) {
-        const anim = keys[i];
-        this._anims[anim].updateFrameData(this._frameData);
+      for (const anim of Object.values(this._anims)) {
+        anim.updateFrameData(this._frameData);
       }
     }
     if (frame === undefined || frame === null) {
@@ -112,14 +109,14 @@ export class AnimationManager {
    * @param {boolean | undefined} useNumericIndex - Whether to treat frameList as numeric indices.
    * @returns {Animation} The created Animation object.
    */
-  add(
+  public add(
     name: string,
     frameList: number[] | string[] | null | undefined,
-    frameRate: number = 60,
-    loop: boolean = false,
-    useNumericIndex: boolean | undefined = undefined
+    frameRate = 60,
+    loop = false,
+    useNumericIndex?: boolean
   ) {
-    const frames = frameList || [];
+    const frames = frameList ?? [];
     //  If they didn't set the useNumericIndex then let's at least try and guess it
     if (useNumericIndex === undefined) {
       if (frames && typeof frames[0] === 'number') {
@@ -152,10 +149,10 @@ export class AnimationManager {
    * @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 = false) {
+  public validateFrames(frames: string[] | number[], useNumericIndex = false) {
     for (let i = 0; i < frames.length; i += 1) {
-      if (useNumericIndex === true) {
-        if (frames[i] > this._frameData.total) {
+      if (useNumericIndex) {
+        if (frames[i]! > this._frameData.total) {
           return false;
         }
       } else if (this._frameData.checkFrameName(frames[i]) === false) {
@@ -172,7 +169,7 @@ export class AnimationManager {
    * @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 | null = null, loop: boolean | null = null) {
+  public play(name: string, frameRate: number | null = null, loop: boolean | null = null) {
     if (this._anims[name]) {
       if (this.currentAnim === this._anims[name]) {
         if (this.currentAnim.isPlaying === false) {
@@ -197,7 +194,7 @@ export class AnimationManager {
    * @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 | null = null, resetFrame: boolean = false) {
+  public stop(name: string | null = null, resetFrame = false) {
     if (this.currentAnim && (typeof name !== 'string' || name === this.currentAnim.name)) {
       this.currentAnim.stop(resetFrame);
     }
@@ -207,7 +204,7 @@ export class AnimationManager {
    * Updates the animation manager state.
    * @returns {boolean} True if an animation was updated, false otherwise.
    */
-  update() {
+  public update() {
     if (this.updateIfVisible && !this.sprite.visible) {
       return false;
     }
@@ -222,7 +219,7 @@ export class AnimationManager {
    * Advances the current animation by a specified number of frames.
    * @param {number} quantity - The number of frames to advance by.
    */
-  next(quantity: number) {
+  public next(quantity: number) {
     if (this.currentAnim) {
       this.currentAnim.next(quantity);
       this.currentFrame = this.currentAnim.currentFrame;
@@ -233,7 +230,7 @@ export class AnimationManager {
    * 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) {
+  public previous(quantity: number) {
     if (this.currentAnim) {
       this.currentAnim.previous(quantity);
       this.currentFrame = this.currentAnim.currentFrame;
@@ -245,7 +242,7 @@ export class AnimationManager {
    * @param {string} name - The name of the animation to retrieve.
    * @returns {Animation} The Animation object, or null if not found.
    */
-  getAnimation(name: string) {
+  public getAnimation(name: string) {
     if (name && this._anims[name]) {
       return this._anims[name];
     }
@@ -255,7 +252,7 @@ export class AnimationManager {
   /**
    * Refreshes the current frame texture (not implemented).
    */
-  refreshFrame() {
+  public refreshFrame() {
     // TODO
     this.game.logger.warn('animation_manager.refreshFrame() is not implemented');
     // this.sprite.setTexture(PIXI.TextureCache[this.currentFrame.uuid]);
@@ -263,9 +260,9 @@ export class AnimationManager {
 
   /**
    * Gets the frame data used by this AnimationManager.
-   * @returns {import('./frame_data.js').FrameData} The FrameData object.
+   * @returns {FrameData} The FrameData object.
    */
-  get frameData() {
+  public get frameData() {
     return this._frameData;
   }
 
@@ -273,7 +270,7 @@ export class AnimationManager {
    * Gets the total number of frames in the frame data.
    * @returns {number} The total number of frames.
    */
-  get frameTotal() {
+  public get frameTotal() {
     return this._frameData.total;
   }
 
@@ -281,14 +278,14 @@ export class AnimationManager {
    * Gets the paused state of the current animation.
    * @returns {boolean} True if the current animation is paused, false otherwise.
    */
-  get paused() {
+  public get paused() {
     return this.currentAnim.isPaused;
   }
 
   /**
    * Sets the paused state of the current animation.
    */
-  set paused(value) {
+  public set paused(value) {
     this.currentAnim.paused = value;
   }
 
@@ -296,7 +293,7 @@ export class AnimationManager {
    * Gets the name of the current animation.
    * @returns {string} The name of the current animation, or null if no animation is active.
    */
-  get name() {
+  public get name() {
     if (this.currentAnim) {
       return this.currentAnim.name;
     }
@@ -307,7 +304,7 @@ export class AnimationManager {
    * Gets the current frame index.
    * @returns {number} The current frame index.
    */
-  get frame() {
+  public get frame() {
     if (this.currentFrame) {
       return this.currentFrame.index;
     }
@@ -317,7 +314,7 @@ export class AnimationManager {
   /**
    * Sets the current frame index.
    */
-  set frame(value) {
+  public set frame(value) {
     if (typeof value === 'number' && this._frameData && this._frameData.getFrame(value) !== null) {
       this.currentFrame = this._frameData.getFrame(value);
       if (this.currentFrame) {
@@ -335,7 +332,7 @@ export class AnimationManager {
    * Gets the current frame name.
    * @returns {string} The current frame name, or null if no frame is set.
    */
-  get frameName() {
+  public get frameName() {
     if (this.currentFrame) {
       return this.currentFrame.name;
     }
@@ -345,7 +342,7 @@ export class AnimationManager {
   /**
    * Sets the current frame by name.
    */
-  set frameName(value) {
+  public set frameName(value) {
     if (typeof value === 'string' && this._frameData && this._frameData.getFrameByName(value) !== null) {
       this.currentFrame = this._frameData.getFrameByName(value);
       if (this.currentFrame) {

package/src/phaser/core/animation_parser.ts

@@ -1,9 +1,10 @@
 import { Frame } from './frame.js';
 import { FrameData } from './frame_data.js';
+import type { Game } from './game.js';
 
 /**
  * TBD.
- * @param {import('./game.js').Game} game - TBD.
+ * @param {Game} game - TBD.
  * @param {string} key - TBD.
  * @param {number} frameWidth - TBD.
  * @param {number} frameHeight - TBD.
@@ -13,7 +14,7 @@ import { FrameData } from './frame_data.js';
  * @returns {FrameData} TBD.
  */
 export const spriteSheet = (
-  game: import('./game.js').Game,
+  game: Game,
   key: any,
   frameWidth: number,
   frameHeight: number,
@@ -28,8 +29,8 @@ export const spriteSheet = (
   if (img === null) {
     return null;
   }
-  const width = img.width;
-  const height = img.height;
+  const { width } = img;
+  const { height } = img;
   if (frameWidth <= 0) {
     frameWidth = Math.floor(-width / Math.min(-1, frameWidth));
   }
@@ -66,11 +67,11 @@ export const spriteSheet = (
 
 /**
  * TBD.
- * @param {import('./game.js').Game} game - TBD.
+ * @param {Game} game - TBD.
  * @param {object} json - TBD.
  * @returns {FrameData} TBD.
  */
-export const JSONDataHash = (game: import('./game.js').Game, json: any, _key?: any) => {
+export const JSONDataHash = (game: Game, json: any, _key?: any) => {
   if (!json.frames) {
     game.logger.warn('JSONDataHash: Invalid Texture Atlas JSON given, missing frames object', json);
     return null;
@@ -78,12 +79,11 @@ export const JSONDataHash = (game: import('./game.js').Game, json: any, _key?: a
   // Let's create some frames then
   const data = new FrameData();
   // By this stage frames is a fully parsed array
-  const frames = json.frames;
+  const { frames } = json;
   let newFrame;
   let i = 0;
   const keys = Object.keys(frames);
-  for (let k = 0; k < keys.length; k += 1) {
-    const key = keys[k];
+  for (const key of keys) {
     newFrame = data.addFrame(
       new Frame(i, frames[key].frame.x, frames[key].frame.y, frames[key].frame.w, frames[key].frame.h, key)
     );