@vpmedia/phaser 1.115.0 → 1.117.0

package/src/phaser/display/group.ts

@@ -74,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).
    */
-  public override destroy(destroyChildren = true, soft = false) {
+  public override destroy(destroyChildren = true, soft = false): void {
     if (this.game === null || this.ignoreDestroy) {
       return;
     }
@@ -128,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.
    */
-  public addAt(child: DisplayObject, index: number, silent: boolean) {
+  public addAt(child: DisplayObject, index: number, silent: boolean): void {
     this.add(child, silent, index);
   }
 
@@ -137,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.
    */
-  public getAt(index: number) {
+  public getAt(index: number): -1 | DisplayObject | undefined {
     if (index < 0 || index >= this.children.length) {
       return -1;
     }
@@ -147,7 +147,7 @@ export class Group extends DisplayObject {
   /**
    * Updates the Z indices of all children in this group.
    */
-  public updateZ() {
+  public updateZ(): void {
     let i = this.children.length;
     while (i) {
       i -= 1;
@@ -159,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.
    */
-  public next() {
+  public next(): DisplayObject | null {
     if (this.cursor) {
       //  Wrap the cursor?
       if (this.cursorIndex >= this.children.length - 1) {
@@ -177,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.
    */
-  public previous() {
+  public previous(): DisplayObject | null {
     if (this.cursor) {
       //  Wrap the cursor?
       if (this.cursorIndex === 0) {
@@ -196,7 +196,7 @@ export class Group extends DisplayObject {
    * @param {DisplayObject} child1 - The first child to swap.
    * @param {DisplayObject} child2 - The second child to swap.
    */
-  public swap(child1: DisplayObject, child2: DisplayObject) {
+  public swap(child1: DisplayObject, child2: DisplayObject): void {
     this.swapChildren(child1, child2);
     this.updateZ();
   }
@@ -206,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.
    */
-  public bringToTop(child: DisplayObject) {
+  public bringToTop(child: DisplayObject): DisplayObject {
     if (child.parent === this && this.getIndex(child) < this.children.length) {
       this.remove(child, false, true);
       this.add(child, true);
@@ -219,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.
    */
-  public sendToBack(child: DisplayObject) {
+  public sendToBack(child: DisplayObject): DisplayObject {
     if (child.parent === this && this.getIndex(child) > 0) {
       this.remove(child, false, true);
       this.addAt(child, 0, true);
@@ -230,7 +230,7 @@ export class Group extends DisplayObject {
   /**
    * Reverses the order of children in this group.
    */
-  public reverse() {
+  public reverse(): void {
     this.children.reverse();
     this.updateZ();
   }
@@ -240,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.
    */
-  public getIndex(child: DisplayObject) {
+  public getIndex(child: DisplayObject): number {
     return this.children.indexOf(child);
   }
 
   /**
    * Updates the Z indices of all children in this group before the update cycle.
    */
-  public override preUpdate() {
+  public override preUpdate(): void {
     if (this.pendingDestroy) {
       this.destroy();
       return;
@@ -264,7 +264,7 @@ export class Group extends DisplayObject {
   /**
    * Updates all children in this group during the update cycle.
    */
-  public override update() {
+  public override update(): void {
     let i = this.children.length;
     while (i) {
       i -= 1;
@@ -275,7 +275,7 @@ export class Group extends DisplayObject {
   /**
    * Updates all children in this group after the update cycle.
    */
-  public override postUpdate() {
+  public override postUpdate(): void {
     for (const child of this.children) {
       child.postUpdate();
     }
@@ -288,7 +288,7 @@ export class Group extends DisplayObject {
    * @param {boolean} silent - Whether to dispatch events.
    * @returns {boolean} True if the child was removed, false otherwise.
    */
-  public remove(child: any, destroy = true, silent = false) {
+  public remove(child: any, destroy = true, silent = false): boolean {
     if (this.children.length === 0 || !this.children.includes(child)) {
       return false;
     }
@@ -312,7 +312,7 @@ export class Group extends DisplayObject {
    * @param {boolean} silent - Whether to dispatch events.
    * @param {boolean} destroyTexture - Whether to destroy textures as well.
    */
-  public removeAll(destroy = true, silent = false, destroyTexture = false) {
+  public removeAll(destroy = true, silent = false, destroyTexture = false): void {
     if (this.children.length === 0) {
       return;
     }

package/src/phaser/display/image.ts

@@ -88,7 +88,7 @@ export class Image extends DisplayObject {
   /**
    * Destroys this image and cleans up resources.
    */
-  public override destroy() {
+  public override destroy(): void {
     this.game = null!;
     this.key = null;
     this.data = null;
@@ -112,7 +112,7 @@ export class Image extends DisplayObject {
   /**
    * Called before the update cycle for this image.
    */
-  public override preUpdate() {
+  public override preUpdate(): void {
     if (this.pendingDestroy) {
       this.destroy();
       return;
@@ -141,7 +141,11 @@ 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.
    */
-  public loadTexture(key: string | number | Texture | null, frame: string | number | null = 0, stopAnimation = true) {
+  public loadTexture(
+    key: string | number | Texture | null,
+    frame: string | number | null = 0,
+    stopAnimation = true
+  ): void {
     if (key === PENDING_ATLAS) {
       key = frame ?? 0;
       frame = 0;
@@ -159,7 +163,7 @@ export class Image extends DisplayObject {
     if (key instanceof Texture) {
       this.setTexture(key);
     } else {
-      const img = cache.getImage(key, true);
+      const img = cache.getImage(key ?? undefined, true);
       if (img) {
         this.key = img.key;
         this.setTexture(new Texture(img.base));
@@ -183,7 +187,7 @@ export class Image extends DisplayObject {
    * Sets the current frame of this image.
    * @param {Frame} frame - The frame to set.
    */
-  public setFrame(frame: Frame) {
+  public setFrame(frame: Frame): void {
     this._frame = frame;
     this.texture.frame.x = frame.x;
     this.texture.frame.y = frame.y;
@@ -200,12 +204,12 @@ export class Image extends DisplayObject {
         this.texture.trim.width = frame.sourceSizeW;
         this.texture.trim.height = frame.sourceSizeH;
       } else {
-        this.texture.trim = {
-          x: frame.spriteSourceSizeX,
-          y: frame.spriteSourceSizeY,
-          width: frame.sourceSizeW,
-          height: frame.sourceSizeH,
-        };
+        this.texture.trim = new Rectangle(
+          frame.spriteSourceSizeX,
+          frame.spriteSourceSizeY,
+          frame.sourceSizeW,
+          frame.sourceSizeH
+        );
       }
       this.texture.width = frame.sourceSizeW;
       this.texture.height = frame.sourceSizeH;
@@ -230,7 +234,7 @@ export class Image extends DisplayObject {
    * @param {number} width - The new width of the frame.
    * @param {number} height - The new height of the frame.
    */
-  public resizeFrame(_parent: DisplayObject, width: number, height: number) {
+  public resizeFrame(_parent: DisplayObject, width: number, height: number): void {
     this.texture.frame.resize(width, height);
     this.texture.setFrame(this.texture.frame);
   }
@@ -238,7 +242,7 @@ export class Image extends DisplayObject {
   /**
    * Resets the frame of this image to its original frame.
    */
-  public resetFrame() {
+  public resetFrame(): void {
     if (this._frame) {
       this.setFrame(this._frame);
     }
@@ -248,7 +252,7 @@ export class Image extends DisplayObject {
    * Gets the current frame index of this image.
    * @returns {number} The current frame index.
    */
-  public get frame() {
+  public get frame(): number {
     return this.animations.frame;
   }
 
@@ -264,7 +268,7 @@ export class Image extends DisplayObject {
    * Gets the current frame name of this image.
    * @returns {string} The current frame name.
    */
-  public get frameName() {
+  public get frameName(): string | null {
     return this.animations.frameName;
   }
 
@@ -272,7 +276,7 @@ export class Image extends DisplayObject {
    * Sets the current frame name of this image.
    * @param {string} value - The new frame name to set.
    */
-  public set frameName(value: string) {
+  public set frameName(value: string | null) {
     this.animations.frameName = value;
   }
 
@@ -283,7 +287,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.
    */
-  public crop(rect: Rectangle, copy = false) {
+  public crop(rect: Rectangle, copy = false): void {
     if (rect) {
       if (copy && this.cropRect !== null) {
         this.cropRect.setTo(rect.x, rect.y, rect.width, rect.height);
@@ -303,7 +307,7 @@ export class Image extends DisplayObject {
   /**
    * Updates the crop rectangle of this image.
    */
-  public updateCrop() {
+  public updateCrop(): void {
     if (!this.cropRect) {
       return;
     }
@@ -336,7 +340,7 @@ export class Image extends DisplayObject {
    * Gets the width of this image.
    * @returns {number} The width in pixels.
    */
-  public override get width() {
+  public override get width(): number {
     return this.scale.x * this.texture.frame.width;
   }
 
@@ -353,7 +357,7 @@ export class Image extends DisplayObject {
    * Gets the height of this image.
    * @returns {number} The height in pixels.
    */
-  public override get height() {
+  public override get height(): number {
     return this.scale.y * this.texture.frame.height;
   }
 
@@ -369,7 +373,7 @@ export class Image extends DisplayObject {
   /**
    * Called when the texture of this image is updated.
    */
-  public onTextureUpdate() {
+  public onTextureUpdate(): void {
     // So if _width is 0 then width was not set..
     if (this._width) {
       this.scale.x = this._width / this.texture.frame.width;
@@ -384,7 +388,7 @@ export class Image extends DisplayObject {
    * @param {Texture} texture - The new texture to set.
    * @param {boolean} destroyBase - Whether to destroy the base texture.
    */
-  public setTexture(texture: Texture, destroyBase = false) {
+  public setTexture(texture: Texture, destroyBase = false): void {
     setTexture(this, texture, destroyBase);
   }
 
@@ -393,7 +397,7 @@ export class Image extends DisplayObject {
    * @param {Matrix} matrix - The transformation matrix to use.
    * @returns {Rectangle} The bounds rectangle of this image.
    */
-  public override getBounds(matrix: Matrix | null = null) {
+  public override getBounds(matrix: Matrix | null = null): Rectangle {
     return getBounds(this, matrix);
   }
 
@@ -401,7 +405,7 @@ export class Image extends DisplayObject {
    * Gets the local bounds of this image.
    * @returns {Rectangle} The local bounds rectangle of this image.
    */
-  public override getLocalBounds() {
+  public override getLocalBounds(): Rectangle {
     return getLocalBounds(this);
   }
 
@@ -410,7 +414,7 @@ export class Image extends DisplayObject {
    * @param {object} renderSession - The WebGL rendering session.
    * @param {Matrix} matrix - The transformation matrix to use.
    */
-  public override renderWebGL(renderSession: RenderSession, matrix: Matrix | null = null) {
+  public override renderWebGL(renderSession: RenderSession, matrix: Matrix | null = null): void {
     renderWebGL(this, renderSession, matrix);
   }
 
@@ -419,7 +423,7 @@ export class Image extends DisplayObject {
    * @param {object} renderSession - The Canvas rendering session.
    * @param {Matrix} matrix - The transformation matrix to use.
    */
-  public override renderCanvas(renderSession: RenderSession, matrix: Matrix | null = null) {
+  public override renderCanvas(renderSession: RenderSession, matrix: Matrix | null = null): void {
     renderCanvas(this, renderSession, matrix);
   }
 }

package/src/phaser/display/sprite_util.ts

@@ -13,7 +13,7 @@ import { setSmoothing } from './canvas/util.js';
  * @param {Texture} texture - The new texture to set.
  * @param {boolean} destroyBase - Whether to destroy the base texture.
  */
-export const setTexture = (target: Image, texture: Texture, destroyBase = false) => {
+export const setTexture = (target: Image, texture: Texture, destroyBase = false): void => {
   if (destroyBase) {
     target.texture.baseTexture.destroy();
   }
@@ -131,7 +131,11 @@ export const getLocalBounds = (target: Image) => {
  * @param {object} renderSession - The render session object.
  * @param {Matrix | null | undefined} matrix - The transformation matrix.
  */
-export const renderWebGL = (target: Image, renderSession: RenderSession, matrix: Matrix | null | undefined = null) => {
+export const renderWebGL = (
+  target: Image,
+  renderSession: RenderSession,
+  matrix: Matrix | null | undefined = null
+): void => {
   // if the sprite is not visible or the alpha is 0 then no need to render this element
   if (!target.visible || target.alpha <= 0 || !target.renderable) {
     return;
@@ -184,7 +188,11 @@ export const renderWebGL = (target: Image, renderSession: RenderSession, matrix:
  * @param {object} renderSession - The render session object.
  * @param {Matrix | null | undefined} matrix - The transformation matrix.
  */
-export const renderCanvas = (target: Image, renderSession: RenderSession, matrix: Matrix | null | undefined = null) => {
+export const renderCanvas = (
+  target: Image,
+  renderSession: RenderSession,
+  matrix: Matrix | null | undefined = null
+): void => {
   // If the sprite is not visible or the alpha is 0 then no need to render this element
   if (
     !target.visible ||
@@ -253,7 +261,7 @@ export const renderCanvas = (target: Image, renderSession: RenderSession, matrix
       cw = Math.floor(cw);
       ch = Math.floor(ch);
       renderSession.context.drawImage(
-        target.texture.baseTexture.source,
+        target.texture.baseTexture.source!,
         cx,
         cy,
         cw,