@vpmedia/phaser 1.20.0 → 1.22.0

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/phaser
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.20.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.22.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
 [![Node.js CI](https://github.com/vpmedia/phaser/actions/workflows/node.js.yml/badge.svg)](https://github.com/vpmedia/phaser/actions/workflows/node.js.yml)
 
 @vpmedia/phaser is the modern ECMAScript port of the popular Phaser game engine v2.6.2.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/phaser",
-  "version": "1.20.0",
+  "version": "1.22.0",
   "description": "@vpmedia/phaser is the modern ECMAScript port of the popular Phaser game engine v2.6.2",
   "author": "Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)",
   "license": "MIT",
@@ -31,7 +31,7 @@
     "husky": "^8.0.3",
     "jest": "^29.5.0",
     "lint-staged": "^13.2.1",
-    "prettier": "^2.8.7",
+    "prettier": "^2.8.8",
     "typescript": "^5.0.4"
   },
   "scripts": {

package/src/phaser/core/animation.js

@@ -1,15 +1,12 @@
-import { Game } from './game';
 import { Signal } from './signal';
-import { FrameData } from './frame_data';
-import { Image } from '../display/image';
 
 export class Animation {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {Image} parent - TBD.
    * @param {string} name - TBD.
-   * @param {FrameData} frameData - TBD.
+   * @param {import('./frame_data').FrameData} frameData - TBD.
    * @param {string[]|number[]} frames - TBD.
    * @param {number} frameRate - TBD.
    * @param {boolean} loop - TBD.
@@ -311,7 +308,7 @@ export class Animation {
 
   /**
    * TBD.
-   * @param {FrameData} frameData - TBD.
+   * @param {import('./frame_data').FrameData} frameData - TBD.
    */
   updateFrameData(frameData) {
     this._frameData = frameData;

package/src/phaser/core/animation_manager.js

@@ -1,6 +1,4 @@
 import { Animation } from './animation';
-import { FrameData } from './frame_data';
-import { Image } from '../display/image';
 
 export class AnimationManager {
   /**
@@ -38,7 +36,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param {FrameData} frameData - TBD.
+   * @param {import('./frame_data').FrameData} frameData - TBD.
    * @param {number|string} frame - TBD.
    * @returns {boolean} TBD.
    */
@@ -68,7 +66,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param {FrameData} frameData - TBD.
+   * @param {import('./frame_data').FrameData} frameData - TBD.
    * @param {number|string} frame - TBD.
    * @returns {boolean} TBD.
    */
@@ -248,7 +246,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @returns {FrameData} TBD.
+   * @returns {import('./frame_data').FrameData} TBD.
    */
   get frameData() {
     return this._frameData;

package/src/phaser/core/animation_parser.js

@@ -1,10 +1,9 @@
 import { Frame } from './frame';
 import { FrameData } from './frame_data';
-import { Game } from './game';
 
 /**
  * TBD.
- * @param {Game} game - TBD.
+ * @param {import('./game').Game} game - TBD.
  * @param {string} key - TBD.
  * @param {number} frameWidth - TBD.
  * @param {number} frameHeight - TBD.
@@ -59,7 +58,7 @@ export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin
 
 /**
  * TBD.
- * @param {Game} game - TBD.
+ * @param {import('./game').Game} game - TBD.
  * @param {object} json - TBD.
  * @returns {object} TBD.
  */

package/src/phaser/core/cache.js

@@ -5,7 +5,6 @@ import { Frame } from './frame';
 import { FrameData } from './frame_data';
 import { JSONDataHash } from './animation_parser';
 import { jsonBitmapFont, xmlBitmapFont } from './loader_parser';
-import { Game } from './game';
 
 export const CANVAS = 0;
 export const IMAGE = 1;
@@ -21,7 +20,7 @@ export const RENDER_TEXTURE = 9;
 export class Cache {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;
@@ -84,7 +83,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
+   * @param {HTMLImageElement} data - TBD.
    * @returns {object} TBD.
    */
   addImage(key, url, data) {
@@ -112,7 +111,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
+   * @param {HTMLCanvasElement} data - TBD.
    * @param {object} atlasData - TBD.
    */
   addTextureAtlas(key, url, data, atlasData) {
@@ -131,7 +130,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
+   * @param {object} data - TBD.
    */
   addSound(key, url, data) {
     this._cache.sound[key] = {
@@ -148,7 +147,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
+   * @param {string} data - TBD.
    */
   addText(key, url, data) {
     this._cache.text[key] = { url, data };
@@ -159,11 +158,11 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
-   * @param atlasData - TBD.
-   * @param atlasType - TBD.
-   * @param xSpacing - TBD.
-   * @param ySpacing - TBD.
+   * @param {HTMLCanvasElement} data - TBD.
+   * @param {object} atlasData - TBD.
+   * @param {string} atlasType - TBD.
+   * @param {number} xSpacing - TBD.
+   * @param {number} ySpacing - TBD.
    */
   addBitmapFont(key, url, data, atlasData, atlasType, xSpacing = 0, ySpacing = 0) {
     const obj = {
@@ -185,7 +184,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
+   * @param {object} data - TBD.
    */
   addJSON(key, url, data) {
     this._cache.json[key] = { url, data };
@@ -196,7 +195,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
+   * @param {XMLDocument} data - TBD.
    */
   addXML(key, url, data) {
     this._cache.xml[key] = { url, data };
@@ -235,7 +234,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} property - TBD.
-   * @param value - TBD.
+   * @param {any} value - TBD.
    */
   updateSound(key, property, value) {
     const sound = this.getSound(key);
@@ -247,7 +246,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param data - TBD.
+   * @param {object} data - TBD.
    */
   decodedSound(key, data) {
     const sound = this.getSound(key);
@@ -413,6 +412,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {HTMLCanvasElement} TBD.
    */
   getCanvas(key) {
     return this.getItem(key, CANVAS, 'getCanvas', 'canvas');
@@ -421,7 +421,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param full - TBD.
+   * @param {boolean} full - TBD.
+   * @returns {HTMLImageElement} TBD.
    */
   getImage(key = '__default', full = false) {
     let img = this.getItem(key, IMAGE, 'getImage');
@@ -437,6 +438,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getTextureFrame(key) {
     return this.getItem(key, TEXTURE, 'getTextureFrame', 'frame');
@@ -445,6 +447,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getSound(key) {
     return this.getItem(key, SOUND, 'getSound');
@@ -453,6 +456,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getSoundData(key) {
     return this.getItem(key, SOUND, 'getSoundData', 'data');
@@ -461,6 +465,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getText(key) {
     return this.getItem(key, TEXT, 'getText', 'data');
@@ -469,6 +474,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getBitmapData(key) {
     return this.getItem(key, BITMAPDATA, 'getBitmapData', 'data');
@@ -477,6 +483,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getBitmapFont(key) {
     return this.getItem(key, BITMAPFONT, 'getBitmapFont');
@@ -486,6 +493,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {boolean} isClone - TBD.
+   * @returns {object} TBD.
    */
   getJSON(key, isClone = false) {
     const data = this.getItem(key, JSON, 'getJSON', 'data');
@@ -495,6 +503,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {XMLDocument} TBD.
    */
   getXML(key) {
     return this.getItem(key, XML, 'getXML', 'data');
@@ -503,6 +512,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {import('../display/webgl/render_texture').RenderTexture} TBD.
    */
   getRenderTexture(key) {
     return this.getItem(key, RENDER_TEXTURE, 'getRenderTexture');
@@ -514,6 +524,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {number} cache - TBD.
+   * @returns {BaseTexture} TBD.
    */
   getBaseTexture(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getBaseTexture', 'base');
@@ -523,6 +534,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {number} cache - TBD.
+   * @returns {Frame} TBD.
    */
   getFrame(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getFrame', 'frame');
@@ -532,6 +544,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {number} cache - TBD.
+   * @returns {number} TBD.
    */
   getFrameCount(key, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -545,6 +558,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {number} cache - TBD.
+   * @returns {FrameData} TBD.
    */
   getFrameData(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getFrameData', 'frameData');
@@ -554,6 +568,7 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {number} cache - TBD.
+   * @returns {boolean} TBD.
    */
   hasFrameData(key, cache = IMAGE) {
     return this.getItem(key, cache, '', 'frameData') !== null;
@@ -562,7 +577,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param frameData - TBD.
+   * @param {FrameData} frameData - TBD.
    * @param {number} cache - TBD.
    */
   updateFrameData(key, frameData, cache = IMAGE) {
@@ -576,6 +591,7 @@ export class Cache {
    * @param {string} key - TBD.
    * @param {number} index - TBD.
    * @param {number} cache - TBD.
+   * @returns {Frame} TBD.
    */
   getFrameByIndex(key, index, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -590,6 +606,7 @@ export class Cache {
    * @param {string} key - TBD.
    * @param {string} name - TBD.
    * @param {number} cache - TBD.
+   * @returns {Frame} TBD.
    */
   getFrameByName(key, name, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -602,6 +619,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} url - TBD.
+   * @returns {string} TBD.
    */
   getURL(url) {
     const resolvedURL = this._resolveURL(url);
@@ -615,6 +633,7 @@ export class Cache {
   /**
    * TBD.
    * @param {object} cache - TBD.
+   * @returns {string[]} TBD.
    */
   getKeys(cache = IMAGE) {
     const result = [];
@@ -739,7 +758,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
+   * @param {object} data - TBD.
    * @returns {string} TBD.
    */
   _resolveURL(url, data) {

package/src/phaser/core/dom.js

@@ -1,5 +1,4 @@
 import { Point } from '../geom/point';
-import { Device } from './device';
 
 class VisualBoundsDesktopRectangle {
   /**
@@ -183,7 +182,7 @@ class DocumentBoundsRectangle {
 export class DOM {
   /**
    * TBD.
-   * @param {Device} device - TBD.
+   * @param {import('./device').Device} device - TBD.
    */
   constructor(device) {
     this.treatAsDesktop =
@@ -201,7 +200,7 @@ export class DOM {
 
   /**
    * TBD.
-   * @param element - TBD.
+   * @param {HTMLCanvasElement} element - TBD.
    * @param {Point} point - TBD.
    * @returns {Point} TBD.
    */
@@ -219,7 +218,7 @@ export class DOM {
 
   /**
    * TBD.
-   * @param element - TBD.
+   * @param {HTMLCanvasElement} element - TBD.
    * @param {number} cushion - TBD.
    * @returns {boolean} TBD.
    */
@@ -233,7 +232,7 @@ export class DOM {
 
   /**
    * TBD.
-   * @param coords - TBD.
+   * @param {DOMRect} coords - TBD.
    * @param {number} cushion - TBD.
    * @returns {object} TBD.
    */

package/src/phaser/core/event_manager.js

@@ -1,10 +1,9 @@
 import { Signal } from './signal';
-import { DisplayObject } from '../display/display_object';
 
 export class EventManager {
   /**
    * TBD.
-   * @param {DisplayObject} sprite - TBD.
+   * @param {import('../display/display_object').DisplayObject} sprite - TBD.
    */
   constructor(sprite) {
     this.parent = sprite;

package/src/phaser/core/factory.js

@@ -4,12 +4,11 @@ import { Group } from '../display/group';
 import { Graphics } from '../display/graphics';
 import { Image } from '../display/image';
 import { Text } from '../display/text';
-import { Game } from './game';
 
 export class GameObjectFactory {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/frame_data.js

@@ -1,5 +1,4 @@
 import { cloneFrameData } from './frame_util';
-import { Frame } from './frame';
 
 export class FrameData {
   /**
@@ -7,7 +6,7 @@ export class FrameData {
    */
   constructor() {
     /**
-     * @type {Frame[]}
+     * @type {import('./frame').Frame[]}
      */
     this._frames = [];
     /**
@@ -18,8 +17,8 @@ export class FrameData {
 
   /**
    * TBD.
-   * @param {Frame} frame - TBD.
-   * @returns {Frame} TBD.
+   * @param {import('./frame').Frame} frame - TBD.
+   * @returns {import('./frame').Frame} TBD.
    */
   addFrame(frame) {
     frame.index = this._frames.length;
@@ -33,7 +32,7 @@ export class FrameData {
   /**
    * TBD.
    * @param {number} index - TBD.
-   * @returns {Frame} TBD.
+   * @returns {import('./frame').Frame} TBD.
    */
   getFrame(index = 0) {
     if (index >= this._frames.length) {
@@ -45,7 +44,7 @@ export class FrameData {
   /**
    * TBD.
    * @param {string} name - TBD.
-   * @returns {Frame} TBD.
+   * @returns {import('./frame').Frame} TBD.
    */
   getFrameByName(name) {
     if (typeof this._frameNames[name] === 'number') {
@@ -78,8 +77,8 @@ export class FrameData {
    * TBD.
    * @param {number} start - TBD.
    * @param {number} end - TBD.
-   * @param {Frame[]} output - TBD.
-   * @returns {Frame[]} TBD.
+   * @param {import('./frame').Frame[]} output - TBD.
+   * @returns {import('./frame').Frame[]} TBD.
    */
   getFrameRange(start, end, output = null) {
     const result = output || [];

package/src/phaser/core/input.js

@@ -10,14 +10,13 @@ import { Pointer } from './input_pointer';
 import { Touch } from './input_touch';
 import { POINTER_CURSOR, POINTER_CONTACT, MOUSE_TOUCH_COMBINE } from './const';
 import { create, remove } from '../display/canvas/pool';
-import { Game } from './game';
 
 const MAX_POINTERS = 10;
 
 export class Input {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;
@@ -125,7 +124,7 @@ export class Input {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param context - TBD.
+   * @param {object} context - TBD.
    */
   setInteractiveCandidateHandler(callback, context) {
     this.customCandidateHandler = callback;
@@ -135,7 +134,7 @@ export class Input {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param context - TBD.
+   * @param {object} context - TBD.
    */
   addMoveCallback(callback, context) {
     this.moveCallbacks.push({ callback, context });
@@ -144,7 +143,7 @@ export class Input {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param context - TBD.
+   * @param {object} context - TBD.
    */
   deleteMoveCallback(callback, context) {
     let i = this.moveCallbacks.length;
@@ -298,7 +297,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param limit - TBD.
+   * @param {number} limit - TBD.
    * @returns {number} TBD.
    */
   countActivePointers(limit = this.pointers.length) {
@@ -329,7 +328,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param identifier - TBD.
+   * @param {number} identifier - TBD.
    * @returns {Pointer} TBD.
    */
   getPointerFromIdentifier(identifier) {
@@ -345,7 +344,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param pointerId - TBD.
+   * @param {number} pointerId - TBD.
    * @returns {Pointer} TBD.
    */
   getPointerFromId(pointerId) {
@@ -361,9 +360,9 @@ export class Input {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param pointer - TBD.
-   * @param output - TBD.
+   * @param {import('../display/display_object').DisplayObject} displayObject - TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {Point} output - TBD.
    * @returns {Point} TBD.
    */
   getLocalPosition(displayObject, pointer, output = null) {
@@ -378,9 +377,9 @@ export class Input {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param pointer - TBD.
-   * @param localPoint - TBD.
+   * @param {import('../display/display_object').DisplayObject} displayObject - TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {Point} localPoint - TBD.
    * @returns {boolean} TBD.
    */
   hitTest(displayObject, pointer, localPoint) {