@vpmedia/phaser 1.119.0 → 1.121.0

package/src/phaser/core/input_pointer.ts

@@ -11,12 +11,13 @@ import {
   POINTER_CURSOR,
   TOUCH_OVERRIDES_MOUSE,
 } from './const.js';
+import type { AppliedCallback, Callback } from './callback.js';
 
 /** A callback deferred until the click that triggered it has finished dispatching. */
 export type ClickTrampoline = {
   name: string;
   targetObject: InputHandler | null;
-  callback: Function;
+  callback: Callback;
   callbackContext: unknown;
   callbackArgs: unknown[];
 };
@@ -281,7 +282,7 @@ export class Pointer {
     while (i) {
       i -= 1;
       const moveCallback = input.moveCallbacks[i]!;
-      moveCallback.callback.call(moveCallback.context, this, this.x, this.y, fromClick);
+      (moveCallback.callback as AppliedCallback).call(moveCallback.context, this, this.x, this.y, fromClick);
     }
     //  Easy out if we're dragging something and it still exists
     if (this.targetObject !== null && this.targetObject.isDragged) {
@@ -331,26 +332,26 @@ export class Pointer {
     // (A node that was previously checked did not request a pixel-perfect check.)
     currentNode = this.game.input.interactiveItems.first;
     while (currentNode) {
-      if (!currentNode.checked && currentNode.validForInput(highestInputPriorityID, highestRenderOrderID, true)) {
-        if (
-          (fromClick && currentNode.checkPointerDown(this, false)) ||
-          (!fromClick && currentNode.checkPointerOver(this, false))
-        ) {
-          highestRenderOrderID = currentNode.sprite.renderOrderID;
-          highestInputPriorityID = currentNode.priorityID;
-          candidateTarget = currentNode;
-          this.interactiveCandidates.push(currentNode);
-        }
+      if (
+        !currentNode.checked &&
+        currentNode.validForInput(highestInputPriorityID, highestRenderOrderID, true) &&
+        ((fromClick && currentNode.checkPointerDown(this, false)) ||
+          (!fromClick && currentNode.checkPointerOver(this, false)))
+      ) {
+        highestRenderOrderID = currentNode.sprite.renderOrderID;
+        highestInputPriorityID = currentNode.priorityID;
+        candidateTarget = currentNode;
+        this.interactiveCandidates.push(currentNode);
       }
       currentNode = this.game.input.interactiveItems.next;
     }
     if (this.game.input.customCandidateHandler) {
-      candidateTarget = this.game.input.customCandidateHandler.call(
+      candidateTarget = (this.game.input.customCandidateHandler as AppliedCallback).call(
         this.game.input.customCandidateHandlerContext,
         this,
         this.interactiveCandidates,
         candidateTarget
-      );
+      ) as InputHandler | null;
     }
     this.swapTarget(candidateTarget, false);
     return this.targetObject !== null;
@@ -456,8 +457,8 @@ export class Pointer {
    * @returns {boolean} TBD.
    */
   public justPressed(duration: number): boolean {
-    duration = duration || this.game.input.justPressedRate;
-    return this.isDown && this.timeDown + duration > this.game.time.time;
+    const window = duration || this.game.input.justPressedRate;
+    return this.isDown && this.timeDown + window > this.game.time.time;
   }
 
   /**
@@ -466,8 +467,8 @@ export class Pointer {
    * @returns {boolean} TBD.
    */
   public justReleased(duration: number): boolean {
-    duration = duration || this.game.input.justReleasedRate;
-    return this.isUp && this.timeUp + duration > this.game.time.time;
+    const window = duration || this.game.input.justReleasedRate;
+    return this.isUp && this.timeUp + window > this.game.time.time;
   }
 
   /**
@@ -477,11 +478,11 @@ export class Pointer {
    * @param {object} callbackContext - TBD.
    * @param {...any} callbackArgs - TBD.
    */
-  public addClickTrampoline(name: string, callback: Function, callbackContext: unknown, callbackArgs: unknown[]): void {
+  public addClickTrampoline(name: string, callback: Callback, callbackContext: unknown, callbackArgs: unknown[]): void {
     if (!this.isDown) {
       return;
     }
-    this._clickTrampolines = this._clickTrampolines ?? [];
+    this._clickTrampolines ??= [];
     const trampolines = this._clickTrampolines;
     for (let i = 0; i < trampolines.length; i += 1) {
       if (trampolines[i]!.name === name) {
@@ -508,7 +509,7 @@ export class Pointer {
     }
     for (const trampoline of trampolines) {
       if (trampoline.targetObject === this._trampolineTargetObject) {
-        trampoline.callback.apply(trampoline.callbackContext, trampoline.callbackArgs);
+        (trampoline.callback as AppliedCallback).apply(trampoline.callbackContext, trampoline.callbackArgs);
       }
     }
     this._clickTrampolines = null;

package/src/phaser/core/input_touch.ts

@@ -51,24 +51,23 @@ export class Touch {
     if (!this.game.device.touch || this._onTouchStart !== null) {
       return;
     }
-    const scope = this;
     this._onTouchStart = (event): void => {
-      scope.onTouchStart(event);
+      this.onTouchStart(event);
     };
     this._onTouchMove = (event): void => {
-      scope.onTouchMove(event);
+      this.onTouchMove(event);
     };
     this._onTouchEnd = (event): void => {
-      scope.onTouchEnd(event);
+      this.onTouchEnd(event);
     };
     this._onTouchEnter = (event): void => {
-      scope.onTouchEnter(event);
+      this.onTouchEnter(event);
     };
     this._onTouchLeave = (event): void => {
-      scope.onTouchLeave(event);
+      this.onTouchLeave(event);
     };
     this._onTouchCancel = (event): void => {
-      scope.onTouchCancel(event);
+      this.onTouchCancel(event);
     };
     this.game.canvas.addEventListener('touchstart', this._onTouchStart, false);
     this.game.canvas.addEventListener('touchmove', this._onTouchMove, false);
@@ -132,8 +131,8 @@ export class Touch {
     // event.touches = list of all touches on the ENTIRE DOCUMENT, not just the target element
     // event.changedTouches = the touches that CHANGED in this event, not the total number of them
     const changed = event.changedTouches ?? [];
-    for (let i = 0; i < changed.length; i += 1) {
-      this.game.input.startPointer(changed[i]!);
+    for (const touch of changed) {
+      this.game.input.startPointer(touch);
     }
   }
 
@@ -153,8 +152,8 @@ export class Touch {
     // Touch cancel - touches that were disrupted (perhaps by moving into a plugin or browser chrome)
     // http://www.w3.org/TR/touch-events/#dfn-touchcancel
     const changed = event.changedTouches ?? [];
-    for (let i = 0; i < changed.length; i += 1) {
-      this.game.input.stopPointer(changed[i]!);
+    for (const touch of changed) {
+      this.game.input.stopPointer(touch);
     }
   }
 
@@ -196,8 +195,8 @@ export class Touch {
     }
     this.eventPreventDefault(event);
     const changed = event.changedTouches ?? [];
-    for (let i = 0; i < changed.length; i += 1) {
-      this.game.input.updatePointer(changed[i]!);
+    for (const touch of changed) {
+      this.game.input.updatePointer(touch);
     }
   }
 
@@ -215,8 +214,8 @@ export class Touch {
     // https://developer.mozilla.org/en-US/docs/DOM/TouchList
     // event.changedTouches = the touches that CHANGED in this event, not the total number of them
     const changed = event.changedTouches ?? [];
-    for (let i = 0; i < changed.length; i += 1) {
-      this.game.input.stopPointer(changed[i]!);
+    for (const touch of changed) {
+      this.game.input.stopPointer(touch);
     }
   }
 
@@ -225,10 +224,8 @@ export class Touch {
    * @param {TouchEvent} event - TBD.
    */
   public eventPreventDefault(event: InputEvent): void {
-    if (this.preventDefault) {
-      if (typeof event.cancelable !== 'boolean' || event.cancelable) {
-        event.preventDefault();
-      }
+    if (this.preventDefault && (typeof event.cancelable !== 'boolean' || event.cancelable)) {
+      event.preventDefault();
     }
   }
 }

package/src/phaser/core/loader.ts

@@ -5,6 +5,7 @@ import type { Cache } from './cache.js';
 import type { Game } from './game.js';
 import type { Image } from '../display/image.js';
 import { Signal } from './signal.js';
+import type { AppliedCallback, Callback } from './callback.js';
 
 const TEXTURE_ATLAS_JSON_HASH = 1;
 
@@ -163,13 +164,8 @@ export class Loader {
       height: sprite.height,
       rect: null,
     };
-    if (direction === 0) {
-      // Horizontal rect
-      this.preloadSprite.rect = new Rectangle(0, 0, 1, sprite.height);
-    } else {
-      // Vertical rect
-      this.preloadSprite.rect = new Rectangle(0, 0, sprite.width, 1);
-    }
+    this.preloadSprite.rect =
+      direction === 0 ? new Rectangle(0, 0, 1, sprite.height) : new Rectangle(0, 0, sprite.width, 1);
     sprite.crop(this.preloadSprite.rect);
     sprite.visible = true;
   }
@@ -585,10 +581,10 @@ export class Loader {
    * @param {object} callbackContext - The context in which to call the callback.
    * @returns {Loader} This Loader instance for chaining.
    */
-  public withSyncPoint(callback: Function, callbackContext: unknown): this {
+  public withSyncPoint(callback: Callback, callbackContext: unknown): this {
     this._withSyncPointDepth += 1;
     try {
-      callback.call(callbackContext ?? this, this);
+      (callback as AppliedCallback).call(callbackContext ?? this, this);
     } finally {
       this._withSyncPointDepth -= 1;
     }
@@ -616,10 +612,8 @@ export class Loader {
    */
   public removeFile(type: string, key: string): void {
     const asset = this.getAsset(type, key);
-    if (asset) {
-      if (!asset.file.loaded && !asset.file.loading) {
-        this._fileList.splice(asset.index, 1);
-      }
+    if (asset && !asset.file.loaded && !asset.file.loading) {
+      this._fileList.splice(asset.index, 1);
     }
   }
 
@@ -735,9 +729,8 @@ export class Loader {
       // Flight queue is empty but file list is not done being processed.
       // This indicates a critical internal error with no known recovery.
       this.game.logger.warn('Aborting: processing queue empty, loading may have stalled');
-      const scope = this;
       setTimeout((): void => {
-        scope.finishedLoading(true);
+        this.finishedLoading(true);
       }, 2000);
     }
   }
@@ -929,32 +922,34 @@ export class Loader {
    */
   public loadImageTag(file: LoaderFile): void {
     this.log('loadImageTag', file);
-    const scope = this;
     const image = new globalThis.Image();
     file.data = image;
-    image.name = file.key;
+    image.dataset['key'] = file.key;
     if (typeof this.crossOrigin === 'string' && this.crossOrigin) {
       image.crossOrigin = this.crossOrigin;
     }
-    image.onload = (): void => {
-      if (image.onload) {
-        image.onload = null;
-        image.onerror = null;
-        scope.fileComplete(file);
-      }
-    };
-    image.onerror = (): void => {
-      if (scope.isUseRetry && (!file.numRetry || file.numRetry < scope.maxRetry)) {
+    let settled = false;
+    image.addEventListener(
+      'load',
+      (): void => {
+        if (!settled) {
+          settled = true;
+          this.fileComplete(file);
+        }
+      },
+      { once: true }
+    );
+    image.addEventListener('error', (): void => {
+      if (this.isUseRetry && (!file.numRetry || file.numRetry < this.maxRetry)) {
         setTimeout((): void => {
-          file.numRetry = !file.numRetry ? 1 : (file.numRetry += 1);
-          scope.loadImageTag(file);
+          file.numRetry = file.numRetry ? file.numRetry + 1 : 1;
+          this.loadImageTag(file);
         }, 1000);
-      } else if (image.onload) {
-        image.onload = null;
-        image.onerror = null;
-        scope.fileError(file);
+      } else if (!settled) {
+        settled = true;
+        this.fileError(file);
       }
-    };
+    });
     const src = this.transformUrl(file.url, file);
     if (src === false) {
       this.fileError(file, null, 'Could not resolve the file URL');
@@ -975,15 +970,14 @@ export class Loader {
     file: LoaderFile,
     url: string | false,
     type: XMLHttpRequestResponseType,
-    onload: Function,
-    onerror: Function | null = null
+    onload: Callback,
+    onerror: Callback | null = null
   ): void {
     if (url === false) {
       this.fileError(file, null, 'Could not resolve the file URL');
       return;
     }
     this.log('xhrLoad', file);
-    const scope = this;
     const xhr = new XMLHttpRequest();
     xhr.open('GET', url, true);
     xhr.responseType = type;
@@ -995,53 +989,51 @@ export class Loader {
     if (acceptHeader) {
       xhr.setRequestHeader('Accept', acceptHeader);
     }
-    onerror = onerror ?? this.fileError;
-    xhr.onload = () => {
+    const handleError = onerror ?? this.fileError;
+    const retry = (): boolean => {
+      if (!this.isUseRetry || (file.numRetry && file.numRetry >= this.maxRetry)) {
+        return false;
+      }
+      setTimeout((): void => {
+        file.numRetry = file.numRetry ? file.numRetry + 1 : 1;
+        this.xhrLoad(file, url, type, onload, handleError);
+      }, 1000);
+      return true;
+    };
+    const reportException = (error: unknown): void => {
+      const typedError = error instanceof Error ? error : new Error(String(error));
+      //  If this was the last file in the queue and an error is thrown in the create method
+      //  then it's caught here, so be sure we don't carry on processing it
+      if (this.hasLoaded) {
+        this.game.logger.fatal('Loader', { error: typedError });
+      } else {
+        this.asyncComplete(file, typedError.message || 'Exception');
+      }
+    };
+    xhr.addEventListener('load', (): void => {
       try {
+        // Handle HTTP status codes of 4xx and 5xx as errors, even if xhr.onerror was not called.
         if (xhr.readyState === 4 && xhr.status >= 400 && xhr.status <= 599) {
-          // Handle HTTP status codes of 4xx and 5xx as errors, even if xhr.onerror was not called.
-          if (scope.isUseRetry && (!file.numRetry || file.numRetry < scope.maxRetry)) {
-            setTimeout((): void => {
-              file.numRetry = !file.numRetry ? 1 : (file.numRetry += 1);
-              scope.xhrLoad(file, url, type, onload, onerror);
-            }, 1000);
-            return null;
+          if (!retry()) {
+            (handleError as AppliedCallback).call(this, file, xhr);
           }
-          return onerror.call(scope, file, xhr);
+          return;
         }
-        return onload.call(scope, file, xhr);
+        (onload as AppliedCallback).call(this, file, xhr);
       } catch (error) {
-        const typedError = error instanceof Error ? error : new Error(String(error));
-        //  If this was the last file in the queue and an error is thrown in the create method
-        //  then it's caught here, so be sure we don't carry on processing it
-        if (!scope.hasLoaded) {
-          scope.asyncComplete(file, typedError.message || 'Exception');
-        } else {
-          scope.game.logger.fatal('Loader', { error: typedError });
-        }
+        reportException(error);
       }
-      return null;
-    };
-    xhr.onerror = () => {
-      if (scope.isUseRetry && (!file.numRetry || file.numRetry < scope.maxRetry)) {
-        setTimeout((): void => {
-          file.numRetry = !file.numRetry ? 1 : (file.numRetry += 1);
-          scope.xhrLoad(file, url, type, onload, onerror);
-        }, 1000);
-      } else {
-        try {
-          return onerror.call(scope, file, xhr);
-        } catch (error) {
-          const typedError = error instanceof Error ? error : new Error(String(error));
-          if (!scope.hasLoaded) {
-            scope.asyncComplete(file, typedError.message || 'Exception');
-          } else {
-            scope.game.logger.fatal('Loader', { error: typedError });
-          }
-        }
+    });
+    xhr.addEventListener('error', (): void => {
+      if (retry()) {
+        return;
       }
-      return null;
-    };
+      try {
+        (handleError as AppliedCallback).call(this, file, xhr);
+      } catch (error) {
+        reportException(error);
+      }
+    });
     file.requestObject = xhr;
     file.requestUrl = url;
     xhr.send();
@@ -1051,7 +1043,6 @@ export class Loader {
    * Placeholder for XDomainRequest loading (not implemented).
    */
   public xhrLoadWithXDR(): void {
-    // TODO
     this.game.logger.warn('loader.xhrLoadWithXDR() is not implemented');
   }
 
@@ -1065,8 +1056,7 @@ export class Loader {
       return null;
     }
     const candidates = typeof urls === 'string' ? [urls] : urls;
-    for (let i = 0; i < candidates.length; i += 1) {
-      const candidate = candidates[i]!;
+    for (const candidate of candidates) {
       let url: string;
       let audioType = null;
       if (typeof candidate !== 'string') {
@@ -1107,7 +1097,7 @@ export class Loader {
     if (!reason && xhr) {
       reason = xhr.status;
     }
-    const message = `Error loading asset (${reason})`;
+    const message = `Error loading asset (${String(reason)})`;
     this.asyncComplete(file, message);
   }
 
@@ -1153,7 +1143,7 @@ export class Loader {
           if (file.format === TEXTURE_ATLAS_JSON_HASH) {
             this.xhrLoad(file, this.transformUrl(file.atlasURL, file), 'text', this.jsonLoadComplete);
           } else {
-            throw new Error(`Invalid Texture Atlas format: ${file.format}`);
+            throw new Error(`Invalid Texture Atlas format: ${String(file.format)}`);
           }
         }
         break;
@@ -1201,7 +1191,7 @@ export class Loader {
         file.data = audio;
         this.cache.addSound(file.key, url, audio);
         if (file.autoDecode) {
-          this.game.sound.decode(file.key);
+          void this.game.sound.decode(file.key);
         }
         break;
       }
@@ -1251,7 +1241,6 @@ export class Loader {
    * TBD.
    */
   public csvLoadComplete(): void {
-    // TODO
     this.game.logger.warn('loader.csvLoadComplete() is not implemented');
   }
 
@@ -1337,13 +1326,13 @@ export class Loader {
   /**
    * Logs a message to the console if logging is enabled.
    * @param {string} message - The message to log.
-   * @param {string|object} data - Additional data to log with the message.
+   * @param {object} file - The file the message is about.
    */
-  public log(message: string, data: string | any = ''): void {
+  public log(message: string, file: LoaderFile): void {
     if (!this.isUseLog) {
       return;
     }
-    this.game.logger.info(message, data);
+    this.game.logger.info(message, { key: file.key, type: file.type });
   }
 
   /**

package/src/phaser/core/loader_parser.ts

@@ -50,8 +50,8 @@ export const xmlBitmapFont = (
   xSpacing: number,
   ySpacing: number
 ): BitmapFontData => {
-  const info = xml.querySelectorAll('info')[0];
-  const common = xml.querySelectorAll('common')[0];
+  const [info] = xml.querySelectorAll('info');
+  const [common] = xml.querySelectorAll('common');
   const attr = (element: Element | undefined, name: string): number => Math.trunc(Number(element?.getAttribute(name)));
   const data: BitmapFontData = {
     font: info?.getAttribute('face') ?? '',
@@ -115,7 +115,7 @@ export const jsonBitmapFont = (
     lineHeight: Math.trunc(Number(json.font.common._lineHeight)) + ySpacing,
     chars: {},
   };
-  json.font.chars.char.forEach((letter: Record<string, string>): void => {
+  for (const letter of json.font.chars.char as Record<string, string>[]) {
     const charCode = Math.trunc(Number(letter['_id']));
     data.chars[charCode] = {
       x: Math.trunc(Number(letter['_x'])),
@@ -127,14 +127,14 @@ export const jsonBitmapFont = (
       xAdvance: Math.trunc(Number(letter['_xadvance'])) + xSpacing,
       kerning: {},
     };
-  });
+  }
   if (json.font.kernings && json.font.kernings.kerning) {
-    json.font.kernings.kerning.forEach((kerning: Record<string, string>): void => {
+    for (const kerning of json.font.kernings.kerning as Record<string, string>[]) {
       const char = data.chars[Math.trunc(Number(kerning['_second']))];
       if (char) {
         char.kerning[Math.trunc(Number(kerning['_first']))] = Math.trunc(Number(kerning['_amount']));
       }
-    });
+    }
   }
   return finalizeBitmapFont(baseTexture, data);
 };