@vpmedia/phaser 1.103.0 → 1.105.0

package/src/phaser/core/animation.ts

@@ -1,7 +1,29 @@
-// @ts-nocheck
 import { Signal } from './signal.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;
+  onStart!: Signal;
+  onUpdate!: Signal | null;
+  onComplete!: Signal;
+  onLoop!: Signal;
+  isReversed!: boolean;
+  _timeLastFrame!: number;
+  _timeNextFrame!: number;
   /**
    * Creates a new Animation instance.
    * @param {import('./game.js').Game} game - The game instance this animation belongs to.
@@ -12,7 +34,7 @@ export class 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, parent, name, frameData, frames, frameRate, loop = false) {
+  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 = false) {
     /** @type {import('./game.js').Game} */
     this.game = game;
     this._parent = parent;
@@ -64,7 +86,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 = null, loop = null) {
+  play(frameRate: number = null, loop: boolean = 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 +143,8 @@ export class Animation {
    */
   reverseOnce() {
     this.onComplete.addOnce(this.reverse, this);
-    return this.reverse();
+    this.reverse();
+    return this;
   }
 
   /**
@@ -129,7 +152,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, useLocalFrameIndex = false) {
+  setFrame(frameId: string|number, useLocalFrameIndex: boolean = false) {
     let frameIndex;
     //  Find the index to the desired frame.
     if (typeof frameId === 'string') {
@@ -163,7 +186,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 = false, dispatchComplete = false) {
+  stop(resetFrame: boolean = false, dispatchComplete: boolean = false) {
     this.isPlaying = false;
     this.isFinished = true;
     this.paused = false;
@@ -243,7 +266,7 @@ export class Animation {
           if (this.onUpdate) {
             this.onUpdate.dispatch(this, this.currentFrame);
             // False if the animation was destroyed from within a callback
-            return !!this._frameData;
+            return Boolean(this._frameData);
           }
           return true;
         }
@@ -262,7 +285,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, fromPlay = false) {
+  updateCurrentFrame(signalUpdate: boolean, fromPlay: boolean = false) {
     if (!this._frameData || !this.currentFrame) {
       // The animation is already destroyed, probably from a callback
       return false;
@@ -276,7 +299,7 @@ export class Animation {
     if (this.onUpdate && signalUpdate) {
       this.onUpdate.dispatch(this, this.currentFrame);
       // False if the animation was destroyed from within a callback
-      return !!this._frameData;
+      return Boolean(this._frameData);
     }
     return true;
   }
@@ -285,7 +308,7 @@ export class Animation {
    * Advances the animation to the next frame(s).
    * @param {number} quantity - The number of frames to advance by.
    */
-  next(quantity = 1) {
+  next(quantity: number = 1) {
     let frame = this._frameIndex + quantity;
     if (frame >= this._frames.length) {
       if (this.loop) {
@@ -304,7 +327,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 = 1) {
+  previous(quantity: number = 1) {
     let frame = this._frameIndex - quantity;
     if (frame < 0) {
       if (this.loop) {
@@ -323,7 +346,7 @@ export class Animation {
    * Updates the frame data used by this animation.
    * @param {import('./frame_data.js').FrameData} frameData - The new FrameData object to use.
    */
-  updateFrameData(frameData) {
+  updateFrameData(frameData: import('./frame_data.js').FrameData) {
     this._frameData = frameData;
     this.currentFrame = this._frameData
       ? this._frameData.getFrame(this._frames[this._frameIndex % this._frames.length])
@@ -379,7 +402,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) {
+  set paused(value: boolean) {
     this.isPaused = value;
     if (value) {
       this._pauseStartTime = this.game.time.time;
@@ -400,7 +423,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) {
+  set reversed(value: boolean) {
     this.isReversed = value;
   }
 
@@ -427,7 +450,7 @@ export class Animation {
    * Sets the current frame index.
    * @param {number} value - The new frame index to set.
    */
-  set frame(value) {
+  set frame(value: number) {
     this.currentFrame = this._frameData.getFrame(this._frames[value]);
     if (this.currentFrame !== null) {
       this._frameIndex = value;
@@ -450,7 +473,7 @@ export class Animation {
    * Sets the animation speed (frame rate).
    * @param {number} value - The new frame rate in frames per second.
    */
-  set speed(value) {
+  set speed(value: number) {
     if (value > 0) {
       this.delay = 1000 / value;
     }
@@ -468,7 +491,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) {
+  set enableUpdate(value: boolean) {
     if (value && this.onUpdate === null) {
       this.onUpdate = new Signal();
     } else if (!value && this.onUpdate !== null) {
@@ -476,4 +499,4 @@ export class Animation {
       this.onUpdate = null;
     }
   }
-}
+}

package/src/phaser/core/animation_manager.ts

@@ -1,13 +1,22 @@
-// @ts-nocheck
 import { Animation } from './animation.js';
 import { ENGINE_ERROR_CANNOT_SET_FRAME, ENGINE_ERROR_CANNOT_SET_FRAME_NAME } from './error_code.js';
 
 export class AnimationManager {
+  sprite!: any;
+  game!: any;
+  currentFrame!: any;
+  currentAnim!: any;
+  updateIfVisible!: any;
+  isLoaded!: any;
+  _frameData!: any;
+  _anims!: any;
+  _outputFrames!: any;
+  _frameIndex!: any;
   /**
    * Creates a new AnimationManager instance.
    * @param {import('../display/image.js').Image} sprite - Reference to the parent Sprite.
    */
-  constructor(sprite) {
+  constructor(sprite: import('../display/image.js').Image) {
     this.sprite = sprite;
     this.game = sprite.game;
     /** @type {import('./frame.js').Frame} */
@@ -47,7 +56,7 @@ export class AnimationManager {
    * @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, frame) {
+  loadFrameData(frameData: import('./frame_data.js').FrameData, frame: string|number) {
     if (!frameData) {
       return false;
     }
@@ -77,7 +86,7 @@ export class AnimationManager {
    * @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, frame) {
+  copyFrameData(frameData: import('./frame_data.js').FrameData, frame: string|number) {
     this._frameData = frameData.clone();
     if (this.isLoaded) {
       // We need to update the frameData that the animations are using
@@ -107,7 +116,7 @@ export class AnimationManager {
    * @param {boolean | undefined} useNumericIndex - Whether to treat frameList as numeric indices.
    * @returns {Animation} The created Animation object.
    */
-  add(name, frameList, frameRate = 60, loop = false, useNumericIndex = undefined) {
+  add(name: string, frameList: number[] | string[] | null | undefined, frameRate: number = 60, loop: boolean = false, useNumericIndex: boolean | undefined = undefined) {
     const frames = frameList || [];
     //  If they didn't set the useNumericIndex then let's at least try and guess it
     if (useNumericIndex === undefined) {
@@ -141,7 +150,7 @@ 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, useNumericIndex = false) {
+  validateFrames(frames: string[] | number[], useNumericIndex: boolean = false) {
     for (let i = 0; i < frames.length; i += 1) {
       if (useNumericIndex === true) {
         if (frames[i] > this._frameData.total) {
@@ -161,7 +170,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, frameRate = null, loop = null) {
+  play(name: string, frameRate: number = null, loop: boolean = null) {
     if (this._anims[name]) {
       if (this.currentAnim === this._anims[name]) {
         if (this.currentAnim.isPlaying === false) {
@@ -186,7 +195,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 = null, resetFrame = false) {
+  stop(name: string = null, resetFrame: boolean = false) {
     if (this.currentAnim && (typeof name !== 'string' || name === this.currentAnim.name)) {
       this.currentAnim.stop(resetFrame);
     }
@@ -211,7 +220,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) {
+  next(quantity: number) {
     if (this.currentAnim) {
       this.currentAnim.next(quantity);
       this.currentFrame = this.currentAnim.currentFrame;
@@ -222,7 +231,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) {
+  previous(quantity: number) {
     if (this.currentAnim) {
       this.currentAnim.previous(quantity);
       this.currentFrame = this.currentAnim.currentFrame;
@@ -234,7 +243,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) {
+  getAnimation(name: string) {
     if (name && this._anims[name]) {
       return this._anims[name];
     }
@@ -346,4 +355,4 @@ export class AnimationManager {
       });
     }
   }
-}
+}

package/src/phaser/core/animation_parser.ts

@@ -12,8 +12,16 @@ import { FrameData } from './frame_data.js';
  * @param {number} spacing - TBD.
  * @returns {FrameData} TBD.
  */
-export const spriteSheet = (game, key, frameWidth, frameHeight, frameMax, margin, spacing) => {
-  let img = key;
+export const spriteSheet = (
+  game: import('./game.js').Game,
+  key: any,
+  frameWidth: number,
+  frameHeight: number,
+  frameMax: number,
+  margin: number,
+  spacing: number
+) => {
+  let img: any = key;
   if (typeof key === 'string') {
     img = game.cache.getImage(key);
   }
@@ -62,7 +70,7 @@ export const spriteSheet = (game, key, frameWidth, frameHeight, frameMax, margin
  * @param {object} json - TBD.
  * @returns {FrameData} TBD.
  */
-export const JSONDataHash = (game, json) => {
+export const JSONDataHash = (game: import('./game.js').Game, json: any, _key?: any) => {
   if (!json.frames) {
     game.logger.warn('JSONDataHash: Invalid Texture Atlas JSON given, missing frames object', json);
     return null;

package/src/phaser/core/array_set.ts

@@ -16,7 +16,7 @@ export class ArraySet {
    * @param {object} item - TBD.
    * @returns {object} TBD.
    */
-  add(item) {
+  add(item: any) {
     if (!this.exists(item)) {
       this.list.push(item);
     }
@@ -28,7 +28,7 @@ export class ArraySet {
    * @param {object} item - TBD.
    * @returns {number} TBD.
    */
-  getIndex(item) {
+  getIndex(item: any) {
     return this.list.indexOf(item);
   }
 
@@ -38,7 +38,7 @@ export class ArraySet {
    * @param {object} value - TBD.
    * @returns {object} TBD.
    */
-  getByKey(property, value) {
+  getByKey(property: string, value: any) {
     let i = this.list.length;
     while (i) {
       i -= 1;
@@ -54,7 +54,7 @@ export class ArraySet {
    * @param {object} item - TBD.
    * @returns {boolean} TBD.
    */
-  exists(item) {
+  exists(item: any) {
     return this.list.indexOf(item) > -1;
   }
 
@@ -70,7 +70,7 @@ export class ArraySet {
    * @param {object} item - TBD.
    * @returns {object} TBD.
    */
-  remove(item) {
+  remove(item: any) {
     const idx = this.list.indexOf(item);
     if (idx !== -1) {
       this.list.splice(idx, 1);
@@ -84,7 +84,7 @@ export class ArraySet {
    * @param {string} key - TBD.
    * @param {object} value - TBD.
    */
-  setAll(key, value) {
+  setAll(key: string, value: any) {
     let i = this.list.length;
     while (i) {
       i -= 1;
@@ -99,7 +99,7 @@ export class ArraySet {
    * @param {string} key - TBD.
    * @param {...any} args - TBD.
    */
-  callAll(key, ...args) {
+  callAll(key: string, ...args: any[]) {
     let i = this.list.length;
     while (i) {
       i -= 1;
@@ -113,7 +113,7 @@ export class ArraySet {
    * TBD.
    * @param {boolean} destroy - TBD.
    */
-  removeAll(destroy = false) {
+  removeAll(destroy: boolean = false) {
     let i = this.list.length;
     while (i) {
       i -= 1;