@vpmedia/phaser 1.111.0 → 1.113.0

package/src/phaser/display/group.ts

@@ -2,46 +2,40 @@ import { GROUP } from '../core/const.js';
 import { Signal } from '../core/signal.js';
 import { DisplayObject } from './display_object.js';
 import { Image } from './image.js';
+import type { Game } from '../core/game.js';
 
 export const SORT_ASCENDING = -1;
 export const SORT_DESCENDING = 1;
 
 export class Group extends DisplayObject {
-  declare z: number;
-  ignoreDestroy!: boolean;
-  pendingDestroy!: boolean;
-  classType!: Function;
-  cursor!: DisplayObject | null;
-  inputEnableChildren!: boolean;
-  onChildInputDown!: Signal;
-  onChildInputUp!: Signal;
-  onChildInputOver!: Signal;
-  onChildInputOut!: Signal;
-  onDestroy!: Signal;
-  cursorIndex!: number;
-  _sortProperty!: string;
-  filters!: object[] | null;
+  declare public z: number;
+  public ignoreDestroy!: boolean;
+  public pendingDestroy!: boolean;
+  public classType!: Function;
+  public cursor!: DisplayObject | null;
+  public inputEnableChildren!: boolean;
+  public onChildInputDown!: Signal;
+  public onChildInputUp!: Signal;
+  public onChildInputOver!: Signal;
+  public onChildInputOut!: Signal;
+  public onDestroy!: Signal;
+  public cursorIndex!: number;
+  public _sortProperty!: string;
+  public filters!: object[] | null;
   /**
    * Creates a new Group object.
-   * @param {import('../core/game.js').Game} game - The game instance this group belongs to.
+   * @param {Game} game - The game instance this group belongs to.
    * @param {DisplayObject} parent - The parent display object.
    * @param {string} name - The name of this group.
    * @param {boolean} addToStage - Whether to add this group to the stage.
    */
-  constructor(
-    game: import('../core/game.js').Game,
-    parent: DisplayObject | null = null,
-    name: string | null = null,
-    addToStage: boolean = false
-  ) {
+  public constructor(game: Game, parent: DisplayObject | null = null, name: string | null = null, addToStage = false) {
     super(game);
     /** @type {number} */
     this.type = GROUP;
-    if (!parent) {
-      parent = game.world;
-    }
+    parent ??= game.world;
     /** @type {string} */
-    this.name = name || 'group';
+    this.name = name ?? 'group';
     /** @type {number} */
     this.z = 0;
     if (addToStage) {
@@ -80,7 +74,7 @@ export class Group extends DisplayObject {
    * @param {boolean} destroyChildren - Whether to destroy children as well.
    * @param {boolean} soft - Whether to perform a soft destroy (leaving the group in the parent's children list).
    */
-  override destroy(destroyChildren: boolean = true, soft: boolean = false) {
+  public override destroy(destroyChildren = true, soft = false) {
     if (this.game === null || this.ignoreDestroy) {
       return;
     }
@@ -106,7 +100,7 @@ export class Group extends DisplayObject {
    * @param {number} index - The index to add the child at.
    * @returns {T} The added child.
    */
-  add<T extends DisplayObject>(child: T, silent: boolean = false, index: number = -1): T {
+  public add<T extends DisplayObject>(child: T, silent = false, index = -1): T {
     if (child.parent === this) {
       return child;
     }
@@ -124,9 +118,7 @@ export class Group extends DisplayObject {
     if (!silent && child.events) {
       child.events.onAddedToGroup$dispatch(child, this);
     }
-    if (this.cursor === null) {
-      this.cursor = child;
-    }
+    this.cursor ??= child;
     return child;
   }
 
@@ -136,7 +128,7 @@ export class Group extends DisplayObject {
    * @param {number} index - The index to add the child at.
    * @param {boolean} silent - Whether to dispatch events.
    */
-  addAt(child: DisplayObject, index: number, silent: boolean) {
+  public addAt(child: DisplayObject, index: number, silent: boolean) {
     this.add(child, silent, index);
   }
 
@@ -145,7 +137,7 @@ export class Group extends DisplayObject {
    * @param {number} index - The index of the child to get.
    * @returns {DisplayObject} The child at the specified index, or -1 if not found.
    */
-  getAt(index: number) {
+  public getAt(index: number) {
     if (index < 0 || index >= this.children.length) {
       return -1;
     }
@@ -155,11 +147,11 @@ export class Group extends DisplayObject {
   /**
    * Updates the Z indices of all children in this group.
    */
-  updateZ() {
+  public updateZ() {
     let i = this.children.length;
     while (i) {
       i -= 1;
-      this.children[i].z = i;
+      this.children[i]!.z = i;
     }
   }
 
@@ -167,7 +159,7 @@ export class Group extends DisplayObject {
    * Gets the next child in this group (with circular wrapping).
    * @returns {DisplayObject} The next child, or null if no children exist.
    */
-  next() {
+  public next() {
     if (this.cursor) {
       //  Wrap the cursor?
       if (this.cursorIndex >= this.children.length - 1) {
@@ -175,7 +167,7 @@ export class Group extends DisplayObject {
       } else {
         this.cursorIndex += 1;
       }
-      this.cursor = this.children[this.cursorIndex];
+      this.cursor = this.children[this.cursorIndex] ?? null;
       return this.cursor;
     }
     return null;
@@ -185,7 +177,7 @@ export class Group extends DisplayObject {
    * Gets the previous child in this group (with circular wrapping).
    * @returns {DisplayObject} The previous child, or null if no children exist.
    */
-  previous() {
+  public previous() {
     if (this.cursor) {
       //  Wrap the cursor?
       if (this.cursorIndex === 0) {
@@ -193,7 +185,7 @@ export class Group extends DisplayObject {
       } else {
         this.cursorIndex -= 1;
       }
-      this.cursor = this.children[this.cursorIndex];
+      this.cursor = this.children[this.cursorIndex] ?? null;
       return this.cursor;
     }
     return null;
@@ -204,7 +196,7 @@ export class Group extends DisplayObject {
    * @param {DisplayObject} child1 - The first child to swap.
    * @param {DisplayObject} child2 - The second child to swap.
    */
-  swap(child1: DisplayObject, child2: DisplayObject) {
+  public swap(child1: DisplayObject, child2: DisplayObject) {
     this.swapChildren(child1, child2);
     this.updateZ();
   }
@@ -214,7 +206,7 @@ export class Group extends DisplayObject {
    * @param {DisplayObject} child - The child to bring to the top.
    * @returns {DisplayObject} The child that was brought to the top.
    */
-  bringToTop(child: DisplayObject) {
+  public bringToTop(child: DisplayObject) {
     if (child.parent === this && this.getIndex(child) < this.children.length) {
       this.remove(child, false, true);
       this.add(child, true);
@@ -227,7 +219,7 @@ export class Group extends DisplayObject {
    * @param {DisplayObject} child - The child to send to the back.
    * @returns {DisplayObject} The child that was sent to the back.
    */
-  sendToBack(child: DisplayObject) {
+  public sendToBack(child: DisplayObject) {
     if (child.parent === this && this.getIndex(child) > 0) {
       this.remove(child, false, true);
       this.addAt(child, 0, true);
@@ -238,7 +230,7 @@ export class Group extends DisplayObject {
   /**
    * Reverses the order of children in this group.
    */
-  reverse() {
+  public reverse() {
     this.children.reverse();
     this.updateZ();
   }
@@ -248,14 +240,14 @@ export class Group extends DisplayObject {
    * @param {DisplayObject} child - The child to get the index of.
    * @returns {number} The index of the child, or -1 if not found.
    */
-  getIndex(child: DisplayObject) {
+  public getIndex(child: DisplayObject) {
     return this.children.indexOf(child);
   }
 
   /**
    * Updates the Z indices of all children in this group before the update cycle.
    */
-  override preUpdate() {
+  public override preUpdate() {
     if (this.pendingDestroy) {
       this.destroy();
       return;
@@ -264,28 +256,28 @@ export class Group extends DisplayObject {
       this.renderOrderID = -1;
       return;
     }
-    for (let i = 0; i < this.children.length; i += 1) {
-      this.children[i].preUpdate();
+    for (const child of this.children) {
+      child.preUpdate();
     }
   }
 
   /**
    * Updates all children in this group during the update cycle.
    */
-  override update() {
+  public override update() {
     let i = this.children.length;
     while (i) {
       i -= 1;
-      this.children[i].update();
+      this.children[i]!.update();
     }
   }
 
   /**
    * Updates all children in this group after the update cycle.
    */
-  override postUpdate() {
-    for (let i = 0; i < this.children.length; i += 1) {
-      this.children[i].postUpdate();
+  public override postUpdate() {
+    for (const child of this.children) {
+      child.postUpdate();
     }
   }
 
@@ -296,8 +288,8 @@ export class Group extends DisplayObject {
    * @param {boolean} silent - Whether to dispatch events.
    * @returns {boolean} True if the child was removed, false otherwise.
    */
-  remove(child: any, destroy: boolean = true, silent: boolean = false) {
-    if (this.children.length === 0 || this.children.indexOf(child) === -1) {
+  public remove(child: any, destroy = true, silent = false) {
+    if (this.children.length === 0 || !this.children.includes(child)) {
       return false;
     }
     if (!silent && child.events && !child.destroyPhase) {
@@ -320,15 +312,16 @@ export class Group extends DisplayObject {
    * @param {boolean} silent - Whether to dispatch events.
    * @param {boolean} destroyTexture - Whether to destroy textures as well.
    */
-  removeAll(destroy: boolean = true, silent: boolean = false, destroyTexture: boolean = false) {
+  public removeAll(destroy = true, silent = false, destroyTexture = false) {
     if (this.children.length === 0) {
       return;
     }
     do {
-      if (!silent && this.children[0].events) {
-        this.children[0].events.onRemovedFromGroup$dispatch(this.children[0], this);
+      const first = this.children[0]!;
+      if (!silent && first.events) {
+        first.events.onRemovedFromGroup$dispatch(first, this);
       }
-      const removed = this.removeChild(this.children[0]);
+      const removed = this.removeChild(first);
       if (destroy && removed) {
         (removed as any).destroy(true, destroyTexture);
       }

package/src/phaser/display/image.ts

@@ -6,37 +6,40 @@ import { clone } from '../geom/util/rectangle.js';
 import { DisplayObject } from './display_object.js';
 import { getBounds, getLocalBounds, renderCanvas, renderWebGL, setTexture } from './sprite_util.js';
 import { Texture } from './webgl/texture.js';
+import type { Game } from '../core/game.js';
+import type { Frame } from '../core/frame.js';
+import type { Matrix } from '../geom/matrix.js';
 
 export class Image extends DisplayObject {
-  key!: any;
-  texture!: Texture;
-  declare _width: number;
-  declare _height: number;
-  tint!: number;
-  cachedTint!: number;
-  tilingTexture!: Texture | null;
-  tintedTexture!: Texture | null;
-  blendMode!: number;
-  shader!: object | null;
-  _frame!: any;
-  pendingDestroy!: boolean;
-  declare events: EventManager;
-  animations!: AnimationManager;
-  customRender!: boolean;
-  cropRect!: Rectangle | null;
-  _crop!: Rectangle | null;
-  refreshTexture!: boolean;
-  declare renderOrderID: number;
+  public key!: any;
+  public texture!: Texture;
+  declare public _width: number;
+  declare public _height: number;
+  public tint!: number;
+  public cachedTint!: number;
+  public tilingTexture!: Texture | null;
+  public tintedTexture!: Texture | null;
+  public blendMode!: number;
+  public shader!: object | null;
+  public _frame!: any;
+  public pendingDestroy!: boolean;
+  declare public events: EventManager;
+  public animations!: AnimationManager;
+  public customRender!: boolean;
+  public cropRect!: Rectangle | null;
+  public _crop!: Rectangle | null;
+  public refreshTexture!: boolean;
+  declare public renderOrderID: number;
   /**
    * Creates a new Image instance.
-   * @param {import('../core/game.js').Game} game - The game instance this image belongs to.
+   * @param {Game} game - The game instance this image belongs to.
    * @param {number} x - The x position of the image.
    * @param {number} y - The y position of the image.
    * @param {string | number | Texture} key - The texture key or texture to use.
    * @param {string | number} frame - The frame identifier (name or index) to use.
    */
-  constructor(
-    game: import('../core/game.js').Game,
+  public constructor(
+    game: Game,
     x: number,
     y: number,
     key: string | number | Texture | null,
@@ -49,7 +52,7 @@ export class Image extends DisplayObject {
     this.renderable = true;
     /** @type {string | number | Texture} */
     this.key = key;
-    this.texture = window.PhaserRegistry.CACHE_MISSING_IMAGE;
+    this.texture = globalThis.PhaserRegistry.CACHE_MISSING_IMAGE;
     /** @type {object} */
     this.data = {};
     /** @type {number} */
@@ -84,7 +87,7 @@ export class Image extends DisplayObject {
   /**
    * Destroys this image and cleans up resources.
    */
-  override destroy() {
+  public override destroy() {
     this.game = null!;
     this.key = null;
     this.data = null;
@@ -108,7 +111,7 @@ export class Image extends DisplayObject {
   /**
    * Called before the update cycle for this image.
    */
-  override preUpdate() {
+  public override preUpdate() {
     if (this.pendingDestroy) {
       this.destroy();
       return;
@@ -124,8 +127,8 @@ export class Image extends DisplayObject {
     if (this.animations) {
       this.animations.update();
     }
-    for (let i = 0; i < this.children.length; i += 1) {
-      this.children[i].preUpdate();
+    for (const child of this.children) {
+      child.preUpdate();
     }
   }
 
@@ -137,12 +140,12 @@ export class Image extends DisplayObject {
    * @param {string | number | null | undefined} frame - The frame identifier (name or index) to use.
    * @param {boolean} stopAnimation - Whether to stop the animation when changing textures.
    */
-  loadTexture(key: string | number | Texture | null, frame: string | number | null = 0, stopAnimation: boolean = true) {
+  public loadTexture(key: string | number | Texture | null, frame: string | number | null = 0, stopAnimation = true) {
     if (key === PENDING_ATLAS) {
       key = frame ?? 0;
       frame = 0;
     } else {
-      frame = frame || 0;
+      frame = frame ?? 0;
     }
     if (stopAnimation) {
       this.animations.stop();
@@ -177,9 +180,9 @@ export class Image extends DisplayObject {
 
   /**
    * Sets the current frame of this image.
-   * @param {import('../core/frame.js').Frame} frame - The frame to set.
+   * @param {Frame} frame - The frame to set.
    */
-  setFrame(frame: import('../core/frame.js').Frame) {
+  public setFrame(frame: Frame) {
     this._frame = frame;
     this.texture.frame.x = frame.x;
     this.texture.frame.y = frame.y;
@@ -226,7 +229,7 @@ export class Image extends DisplayObject {
    * @param {number} width - The new width of the frame.
    * @param {number} height - The new height of the frame.
    */
-  resizeFrame(_parent: DisplayObject, width: number, height: number) {
+  public resizeFrame(_parent: DisplayObject, width: number, height: number) {
     this.texture.frame.resize(width, height);
     this.texture.setFrame(this.texture.frame);
   }
@@ -234,7 +237,7 @@ export class Image extends DisplayObject {
   /**
    * Resets the frame of this image to its original frame.
    */
-  resetFrame() {
+  public resetFrame() {
     if (this._frame) {
       this.setFrame(this._frame);
     }
@@ -244,7 +247,7 @@ export class Image extends DisplayObject {
    * Gets the current frame index of this image.
    * @returns {number} The current frame index.
    */
-  get frame() {
+  public get frame() {
     return this.animations.frame;
   }
 
@@ -252,7 +255,7 @@ export class Image extends DisplayObject {
    * Sets the current frame index of this image.
    * @param {number} value - The new frame index to set.
    */
-  set frame(value: number) {
+  public set frame(value: number) {
     this.animations.frame = value;
   }
 
@@ -260,7 +263,7 @@ export class Image extends DisplayObject {
    * Gets the current frame name of this image.
    * @returns {string} The current frame name.
    */
-  get frameName() {
+  public get frameName() {
     return this.animations.frameName;
   }
 
@@ -268,7 +271,7 @@ export class Image extends DisplayObject {
    * Sets the current frame name of this image.
    * @param {string} value - The new frame name to set.
    */
-  set frameName(value: string) {
+  public set frameName(value: string) {
     this.animations.frameName = value;
   }
 
@@ -279,7 +282,7 @@ export class Image extends DisplayObject {
    * @param {Rectangle} rect - The rectangle to crop to.
    * @param {boolean} copy - Whether to copy the rect or use it directly.
    */
-  crop(rect: Rectangle, copy: boolean = false) {
+  public crop(rect: Rectangle, copy = false) {
     if (rect) {
       if (copy && this.cropRect !== null) {
         this.cropRect.setTo(rect.x, rect.y, rect.width, rect.height);
@@ -299,7 +302,7 @@ export class Image extends DisplayObject {
   /**
    * Updates the crop rectangle of this image.
    */
-  updateCrop() {
+  public updateCrop() {
     if (!this.cropRect) {
       return;
     }
@@ -332,7 +335,7 @@ export class Image extends DisplayObject {
    * Gets the width of this image.
    * @returns {number} The width in pixels.
    */
-  override get width() {
+  public override get width() {
     return this.scale.x * this.texture.frame.width;
   }
 
@@ -340,7 +343,7 @@ export class Image extends DisplayObject {
    * Sets the width of this image.
    * @param {number} value - The new width in pixels.
    */
-  override set width(value: number) {
+  public override set width(value: number) {
     this.scale.x = value / this.texture.frame.width;
     this._width = value;
   }
@@ -349,7 +352,7 @@ export class Image extends DisplayObject {
    * Gets the height of this image.
    * @returns {number} The height in pixels.
    */
-  override get height() {
+  public override get height() {
     return this.scale.y * this.texture.frame.height;
   }
 
@@ -357,7 +360,7 @@ export class Image extends DisplayObject {
    * Sets the height of this image.
    * @param {number} value - The new height in pixels.
    */
-  override set height(value: number) {
+  public override set height(value: number) {
     this.scale.y = value / this.texture.frame.height;
     this._height = value;
   }
@@ -365,7 +368,7 @@ export class Image extends DisplayObject {
   /**
    * Called when the texture of this image is updated.
    */
-  onTextureUpdate() {
+  public onTextureUpdate() {
     // So if _width is 0 then width was not set..
     if (this._width) {
       this.scale.x = this._width / this.texture.frame.width;
@@ -380,16 +383,16 @@ export class Image extends DisplayObject {
    * @param {Texture} texture - The new texture to set.
    * @param {boolean} destroyBase - Whether to destroy the base texture.
    */
-  setTexture(texture: Texture, destroyBase: boolean = false) {
+  public setTexture(texture: Texture, destroyBase = false) {
     setTexture(this, texture, destroyBase);
   }
 
   /**
    * Gets the bounds of this image.
-   * @param {import('../geom/matrix.js').Matrix} matrix - The transformation matrix to use.
+   * @param {Matrix} matrix - The transformation matrix to use.
    * @returns {Rectangle} The bounds rectangle of this image.
    */
-  override getBounds(matrix: import('../geom/matrix.js').Matrix | null = null) {
+  public override getBounds(matrix: Matrix | null = null) {
     return getBounds(this, matrix);
   }
 
@@ -397,25 +400,25 @@ export class Image extends DisplayObject {
    * Gets the local bounds of this image.
    * @returns {Rectangle} The local bounds rectangle of this image.
    */
-  override getLocalBounds() {
+  public override getLocalBounds() {
     return getLocalBounds(this);
   }
 
   /**
    * Renders this image using WebGL.
    * @param {object} renderSession - The WebGL rendering session.
-   * @param {import('../geom/matrix.js').Matrix} matrix - The transformation matrix to use.
+   * @param {Matrix} matrix - The transformation matrix to use.
    */
-  override renderWebGL(renderSession: any, matrix: import('../geom/matrix.js').Matrix | null = null) {
+  public override renderWebGL(renderSession: any, matrix: Matrix | null = null) {
     renderWebGL(this, renderSession, matrix);
   }
 
   /**
    * Renders this image using Canvas.
    * @param {object} renderSession - The Canvas rendering session.
-   * @param {import('../geom/matrix.js').Matrix} matrix - The transformation matrix to use.
+   * @param {Matrix} matrix - The transformation matrix to use.
    */
-  override renderCanvas(renderSession: any, matrix: import('../geom/matrix.js').Matrix | null = null) {
+  public override renderCanvas(renderSession: any, matrix: Matrix | null = null) {
     renderCanvas(this, renderSession, matrix);
   }
 }

package/src/phaser/display/sprite_batch.ts

@@ -1,11 +1,12 @@
 import { DisplayObject } from './display_object.js';
+import type { Game } from '../core/game.js';
 
 export class SpriteBatch extends DisplayObject {
   /**
    * Creates a new SpriteBatch object.
-   * @param {import('../core/game.js').Game} game - The game instance.
+   * @param {Game} game - The game instance.
    */
-  constructor(game: import('../core/game.js').Game) {
+  public constructor(game: Game) {
     super(game);
   }
 }