@vpmedia/phaser 1.104.0 → 1.105.0

package/src/phaser/core/frame_data.ts

@@ -1,30 +1,16 @@
-// @ts-nocheck
+import type { Frame } from './frame.js';
 import { cloneFrameData } from './frame_util.js';
 
 export class FrameData {
-_frames;
-_frameNames;
-  /**
-   * Creates a new FrameData instance.
-   * This class holds data about frames in a texture atlas or sprite sheet.
-   */
+  _frames: Frame[];
+  _frameNames: Record<string, number>;
+
   constructor() {
-    /**
-     * @type {import('./frame.js').Frame[]}
-     */
     this._frames = [];
-    /**
-     * @type {string[]}
-     */
-    this._frameNames = [];
+    this._frameNames = {};
   }
 
-  /**
-   * Add a frame to the frame data collection.
-   * @param {import('./frame.js').Frame} frame - The frame to add.
-   * @returns {import('./frame.js').Frame} The added frame.
-   */
-  addFrame(frame) {
+  addFrame(frame: Frame): Frame {
     frame.index = this._frames.length;
     this._frames.push(frame);
     if (frame.name !== '') {
@@ -33,58 +19,32 @@ _frameNames;
     return frame;
   }
 
-  /**
-   * Get a frame by its index.
-   * @param {number} index - The index of the frame to get.
-   * @returns {import('./frame.js').Frame} The frame at the specified index, or the first frame if index is out of bounds.
-   */
-  getFrame(index = 0) {
+  getFrame(index: number = 0): Frame {
     if (index >= this._frames.length) {
       index = 0;
     }
     return this._frames[index];
   }
 
-  /**
-   * Get a frame by its name.
-   * @param {string} name - The name of the frame to get.
-   * @returns {import('./frame.js').Frame} The frame with the specified name, or null if not found.
-   */
-  getFrameByName(name) {
+  getFrameByName(name: string): Frame | null {
     if (typeof this._frameNames[name] === 'number') {
       return this._frames[this._frameNames[name]];
     }
     return null;
   }
 
-  /**
-   * Check if a frame with the given name exists.
-   * @param {string} name - The name of the frame to check.
-   * @returns {boolean} True if a frame with this name exists, false otherwise.
-   */
-  checkFrameName(name) {
+  checkFrameName(name: string): boolean {
     if (this._frameNames[name] == null) {
       return false;
     }
     return true;
   }
 
-  /**
-   * Create a clone of this FrameData instance.
-   * @returns {FrameData} A new FrameData instance with cloned frames.
-   */
-  clone() {
+  clone(): FrameData {
     return cloneFrameData(this);
   }
 
-  /**
-   * Get a range of frames by index.
-   * @param {number} start - The starting index of the frame range.
-   * @param {number} end - The ending index of the frame range.
-   * @param {import('./frame.js').Frame[]} output - Optional array to populate with frames.
-   * @returns {import('./frame.js').Frame[]} An array of frames in the specified range.
-   */
-  getFrameRange(start, end, output = null) {
+  getFrameRange(start: number, end: number, output: Frame[] | null = null): Frame[] {
     const result = output || [];
     for (let i = start; i <= end; i += 1) {
       result.push(this._frames[i]);
@@ -92,21 +52,22 @@ _frameNames;
     return result;
   }
 
-  /**
-   * Get frame indexes from an array of frame names or indices.
-   * @param {number[]|string[]} frames - An array of frame names or indices.
-   * @param {boolean} useNumericIndex - Whether to treat numeric values as frame indices.
-   * @param {number[]} output - Optional array to populate with frame indexes.
-   * @returns {number[]} An array of frame indexes.
-   */
-  getFrameIndexes(frames, useNumericIndex = true, output = null) {
+  getFrameIndexes(
+    frames: (number | string)[],
+    useNumericIndex: boolean = true,
+    output: number[] | null = null
+  ): number[] {
     const result = output || [];
     if (frames && frames.length > 0) {
       for (let i = 0; i < frames.length; i += 1) {
-        if (useNumericIndex && this._frames[frames[i]]) {
-          result.push(this._frames[frames[i]].index);
-        } else if (this.getFrameByName(frames[i])) {
-          result.push(this.getFrameByName(frames[i]).index);
+        const f = frames[i];
+        if (useNumericIndex && this._frames[f as number]) {
+          result.push(this._frames[f as number].index);
+        } else {
+          const found = this.getFrameByName(f as string);
+          if (found) {
+            result.push(found.index);
+          }
         }
       }
     } else {
@@ -117,20 +78,12 @@ _frameNames;
     return result;
   }
 
-  /**
-   * Destroy this FrameData instance and clean up resources.
-   * This method clears internal arrays and releases references to frames.
-   */
-  destroy() {
-    this._frames = null;
-    this._frameNames = null;
+  destroy(): void {
+    this._frames = null as unknown as Frame[];
+    this._frameNames = null as unknown as Record<string, number>;
   }
 
-  /**
-   * Get the total number of frames in this FrameData instance.
-   * @returns {number} The total number of frames.
-   */
-  get total() {
+  get total(): number {
     return this._frames.length;
   }
-}
+}

package/src/phaser/core/frame_util.ts

@@ -1,29 +1,16 @@
-// @ts-nocheck
 import { Frame } from './frame.js';
 import { FrameData } from './frame_data.js';
 
-/**
- * Clone a Frame object.
- * @param {Frame} frame - The frame to clone.
- * @param {Frame} output - Optional output frame to populate.
- * @returns {Frame} The cloned frame or the provided output frame.
- */
-export const cloneFrame = (frame, output = null) => {
+export const cloneFrame = (frame: Frame, output: Frame | null = null): Frame => {
   const result = output || new Frame(frame.index, frame.x, frame.y, frame.width, frame.height);
   result.initialize(frame.index, frame.x, frame.y, frame.width, frame.height);
   return result;
 };
 
-/**
- * Clone a FrameData object.
- * @param {FrameData} frameData - The frame data to clone.
- * @param {FrameData} output - Optional output frame data to populate.
- * @returns {FrameData} The cloned frame data or the provided output frame data.
- */
-export const cloneFrameData = (frameData, output = null) => {
+export const cloneFrameData = (frameData: FrameData, output: FrameData | null = null): FrameData => {
   const result = output || new FrameData();
   for (let i = 0; i < frameData.total; i += 1) {
     result.addFrame(frameData.getFrame(i).clone());
   }
   return result;
-};
+};

package/src/phaser/core/game.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { Logger } from '@vpmedia/simplify';
 import { CanvasRenderer } from '../display/canvas/renderer.js';
 import { addToDOM, create, removeFromDOM, setTouchAction } from '../display/canvas/util.js';
@@ -21,62 +20,36 @@ import { TweenManager } from './tween_manager.js';
 import { World } from './world.js';
 
 export class Game {
-  /** @type {object} */
-  config;
-  /** @type {number} */
-  id;
-  /** @type {string|HTMLElement} */
-  parent;
-  /** @type {number} */
-  width;
-  /** @type {number} */
-  height;
-  /** @type {CanvasRenderer | WebGLRenderer} */
-  renderer;
-  /** @type {SceneManager} */
-  state;
-  /** @type {boolean} */
-  isBooted;
-  /** @type {boolean} */
-  paused;
-  /** @type {RequestAnimationFrame} */
-  raf;
-  /** @type {GameObjectFactory} */
-  add;
-  /** @type {Cache} */
-  cache;
-  /** @type {Input} */
-  input;
-  /** @type {Loader} */
-  load;
-  /** @type {ScaleManager} */
-  scale;
-  /** @type {SoundManager} */
-  sound;
-  /** @type {Stage} */
-  stage;
-  /** @type {Time} */
-  time;
-  /** @type {TweenManager} */
-  tweens;
-  /** @type {World} */
-  world;
-  /** @type {Device} */
-  device;
-  /** @type {Logger} */
-  logger;
-  /** @type {HTMLCanvasElement} */
-  canvas;
-  /** @type {CanvasRenderingContext2D | ImageBitmapRenderingContext | WebGLRenderingContext | WebGL2RenderingContext} */
-  context;
-  /** @type {Signal} */
-  onPause;
-  /** @type {Signal} */
-  onResume;
-  /** @type {Signal} */
-  onBoot;
-  /** @type {boolean} */
-  isPaused;
+  config!: any;
+  id!: number;
+  parent!: string | HTMLElement;
+  width!: number;
+  height!: number;
+  renderer!: CanvasRenderer | WebGLRenderer;
+  state!: SceneManager;
+  isBooted!: boolean;
+  paused!: boolean;
+  raf!: RequestAnimationFrame;
+  add!: GameObjectFactory;
+  cache!: Cache;
+  input!: Input;
+  load!: Loader;
+  scale!: ScaleManager;
+  sound!: SoundManager;
+  stage!: Stage;
+  time!: Time;
+  tweens!: TweenManager;
+  world!: World;
+  device!: Device;
+  logger!: Logger;
+  canvas!: HTMLCanvasElement;
+  context!: CanvasRenderingContext2D | ImageBitmapRenderingContext | WebGLRenderingContext | WebGL2RenderingContext;
+  onPause!: Signal;
+  onResume!: Signal;
+  onBoot!: Signal;
+  isPaused!: boolean;
+  contextLostBinded!: any;
+  contextRestoredBinded!: any;
   /**
    * Creates a new Game instance.
    * @param {object} gameConfig - The configuration object for the game.
@@ -97,7 +70,7 @@ export class Game {
    * @param {string|HTMLElement} gameConfig.parent - The parent element to append the canvas to.
    * @param {object} gameConfig.state - The initial state object or class.
    */
-  constructor(gameConfig = {}) {
+  constructor(gameConfig: any = {}) {
     if (!window.PhaserRegistry) {
       window.PhaserRegistry = {};
     }
@@ -262,7 +235,7 @@ export class Game {
    * @param {string} key - The configuration key to parse.
    * @param {*} defaultValue - The default value if the key is not found in config.
    */
-  parseConfigElement(config, key, defaultValue) {
+  parseConfigElement(config: any, key: string, defaultValue?: any) {
     if (config[key] !== undefined) {
       this.config[key] = config[key];
     } else {
@@ -274,7 +247,7 @@ export class Game {
    * Parses the configuration object and sets up game properties.
    * @param {object} config - The configuration object to parse.
    */
-  parseConfig(config) {
+  parseConfig(config: any) {
     this.logger = config.logger ?? new Logger('phaser');
     this.logger.info('parseConfig');
     this.parseConfigElement(config, 'width', 800);
@@ -305,7 +278,7 @@ export class Game {
    * Called when the WebGL context is lost.
    * @param {WebGLContextEvent | Event} event - The WebGL context loss event.
    */
-  contextLost(event) {
+  contextLost(event: any) {
     this.logger.info('contextLost', event);
     event.preventDefault();
     if (this.renderer) {
@@ -317,7 +290,7 @@ export class Game {
    * Called when the WebGL context is restored.
    * @param {WebGLContextEvent | Event} event - The WebGL context restore event.
    */
-  contextRestored(event) {
+  contextRestored(event: any) {
     this.logger.info('contextRestored', event);
     if (this.renderer) {
       this.renderer.initContext(this);
@@ -330,7 +303,7 @@ export class Game {
    * Updates the game state.
    * @param {number} time - The current timestamp.
    */
-  update(time) {
+  update(time: number) {
     this.time.update(time);
     if (!this.isPaused) {
       this.scale.preUpdate();

package/src/phaser/core/input.ts

@@ -1,4 +1,3 @@
-// @ts-nocheck
 import { create, remove } from '../display/canvas/pool.js';
 import { Graphics } from '../display/graphics.js';
 import { Image } from '../display/image.js';
@@ -15,62 +14,63 @@ import { Signal } from './signal.js';
 const MAX_POINTERS = 10;
 
 export class Input {
-game;
-hitCanvas;
-hitContext;
-moveCallbacks;
-lockCallbacks;
-customCandidateHandler;
-customCandidateHandlerContext;
-pollRate;
-enabled;
-multiInputOverride;
-position;
-speed;
-circle;
-scale;
-maxPointers;
-tapRate;
-doubleTapRate;
-holdRate;
-justPressedRate;
-justReleasedRate;
-recordPointerHistory;
-recordRate;
-recordLimit;
-pointer1;
-pointer2;
-pointer3;
-pointer4;
-pointer5;
-pointer6;
-pointer7;
-pointer8;
-pointer9;
-pointer10;
-pointers;
-activePointer;
-mousePointer;
-mouse;
-touch;
-mspointer;
-resetLocked;
-onDown;
-onUp;
-onTap;
-onHold;
-minPriorityID;
-interactiveItems;
-_localPoint;
-_pollCounter;
-_oldPosition;
-_x;
-_y;
+  game!: any;
+  hitCanvas!: any;
+  hitContext!: any;
+  moveCallbacks!: any;
+  lockCallbacks!: any;
+  customCandidateHandler!: any;
+  customCandidateHandlerContext!: any;
+  pollRate!: any;
+  enabled!: any;
+  multiInputOverride!: any;
+  position!: any;
+  speed!: any;
+  circle!: any;
+  scale!: any;
+  maxPointers!: any;
+  tapRate!: any;
+  doubleTapRate!: any;
+  holdRate!: any;
+  justPressedRate!: any;
+  justReleasedRate!: any;
+  recordPointerHistory!: any;
+  recordRate!: any;
+  recordLimit!: any;
+  pointer1!: any;
+  pointer2!: any;
+  pointer3!: any;
+  pointer4!: any;
+  pointer5!: any;
+  pointer6!: any;
+  pointer7!: any;
+  pointer8!: any;
+  pointer9!: any;
+  pointer10!: any;
+  pointers!: any;
+  activePointer!: any;
+  mousePointer!: any;
+  mouse!: any;
+  touch!: any;
+  mspointer!: any;
+  resetLocked!: any;
+  onDown!: any;
+  onUp!: any;
+  onTap!: any;
+  onHold!: any;
+  minPriorityID!: any;
+  interactiveItems!: any;
+  _localPoint!: any;
+  _pollCounter!: any;
+  _oldPosition!: any;
+  _onClickTrampoline!: any;
+  _x!: any;
+  _y!: any;
   /**
    * TBD.
    * @param {import('./game.js').Game} game - TBD.
    */
-  constructor(game) {
+  constructor(game: import('./game.js').Game) {
     this.game = game;
     this.hitCanvas = null;
     this.hitContext = null;
@@ -154,7 +154,7 @@ _y;
     }
     this.mousePointer.active = true;
     const scope = this;
-    this._onClickTrampoline = (event) => scope.onClickTrampoline(event);
+    this._onClickTrampoline = (event: any) => (scope as any).onClickTrampoline(event);
     this.game.canvas.addEventListener('click', this._onClickTrampoline, false);
   }
 
@@ -178,7 +178,7 @@ _y;
    * @param {Function} callback - TBD.
    * @param {object} context - TBD.
    */
-  setInteractiveCandidateHandler(callback, context) {
+  setInteractiveCandidateHandler(callback: Function, context: any) {
     this.customCandidateHandler = callback;
     this.customCandidateHandlerContext = context;
   }
@@ -188,7 +188,7 @@ _y;
    * @param {Function} callback - TBD.
    * @param {object} context - TBD.
    */
-  addMoveCallback(callback, context) {
+  addMoveCallback(callback: Function, context: any) {
     this.moveCallbacks.push({ callback, context });
   }
 
@@ -197,7 +197,7 @@ _y;
    * @param {Function} callback - TBD.
    * @param {object} context - TBD.
    */
-  deleteMoveCallback(callback, context) {
+  deleteMoveCallback(callback: Function, context: any) {
     let i = this.moveCallbacks.length;
     while (i) {
       i -= 1;
@@ -246,7 +246,7 @@ _y;
    * TBD.
    * @param {boolean} hard - TBD.
    */
-  reset(hard = false) {
+  reset(hard: boolean = false) {
     if (!this.game.isBooted || this.resetLocked) {
       return;
     }
@@ -276,7 +276,7 @@ _y;
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    */
-  resetSpeed(x, y) {
+  resetSpeed(x: number, y: number) {
     this._oldPosition.setTo(x, y);
     this.speed.setTo(0, 0);
   }
@@ -286,7 +286,7 @@ _y;
    * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
    * @returns {Pointer} TBD.
    */
-  startPointer(event) {
+  startPointer(event: any|TouchEvent|PointerEvent) {
     if (this.maxPointers >= 0 && this.countActivePointers(this.maxPointers) >= this.maxPointers) {
       return null;
     }
@@ -310,7 +310,7 @@ _y;
    * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
    * @returns {Pointer} TBD.
    */
-  updatePointer(event) {
+  updatePointer(event: any|TouchEvent|PointerEvent) {
     if (this.pointer1.active && this.pointer1.identifier === event.identifier) {
       return this.pointer1.move(event);
     }
@@ -331,7 +331,7 @@ _y;
    * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
    * @returns {Pointer} TBD.
    */
-  stopPointer(event) {
+  stopPointer(event: any|TouchEvent|PointerEvent) {
     if (this.pointer1.active && this.pointer1.identifier === event.identifier) {
       return this.pointer1.stop(event);
     }
@@ -352,7 +352,7 @@ _y;
    * @param {number} limit - TBD.
    * @returns {number} TBD.
    */
-  countActivePointers(limit = this.pointers.length) {
+  countActivePointers(limit: number = this.pointers.length) {
     let count = limit;
     for (let i = 0; i < this.pointers.length && count > 0; i += 1) {
       const pointer = this.pointers[i];
@@ -368,7 +368,7 @@ _y;
    * @param {boolean} isActive - TBD.
    * @returns {Pointer} TBD.
    */
-  getPointer(isActive = false) {
+  getPointer(isActive: boolean = false) {
     for (let i = 0; i < this.pointers.length; i += 1) {
       const pointer = this.pointers[i];
       if (pointer.active === isActive) {
@@ -383,7 +383,7 @@ _y;
    * @param {number} identifier - TBD.
    * @returns {Pointer} TBD.
    */
-  getPointerFromIdentifier(identifier) {
+  getPointerFromIdentifier(identifier: number) {
     for (let i = 0; i < this.pointers.length; i += 1) {
       const pointer = this.pointers[i];
       if (pointer.identifier === identifier) {
@@ -399,7 +399,7 @@ _y;
    * @param {number} pointerId - TBD.
    * @returns {Pointer} TBD.
    */
-  getPointerFromId(pointerId) {
+  getPointerFromId(pointerId: number) {
     for (let i = 0; i < this.pointers.length; i += 1) {
       const pointer = this.pointers[i];
       if (pointer.pointerId === pointerId) {
@@ -417,7 +417,7 @@ _y;
    * @param {Point} output - TBD.
    * @returns {Point} TBD.
    */
-  getLocalPosition(displayObject, pointer, output = null) {
+  getLocalPosition(displayObject: import('../display/display_object.js').DisplayObject, pointer: Pointer, output: Point = null) {
     const result = output || new Point();
     const wt = displayObject.worldTransform;
     const id = 1 / (wt.a * wt.d + wt.c * -wt.b);
@@ -434,7 +434,7 @@ _y;
    * @param {Point} localPoint - TBD.
    * @returns {boolean} TBD.
    */
-  hitTest(displayObject, pointer, localPoint) {
+  hitTest(displayObject: import('../display/display_object.js').DisplayObject, pointer: Pointer, localPoint: Point) {
     if (!displayObject.worldVisible) {
       return false;
     }