@vpmedia/phaser 1.18.0 → 1.19.0

package/README.md

@@ -1,6 +1,6 @@
 # @vpmedia/phaser
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.18.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.19.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.18.0",
+  "version": "1.19.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/cache.js

@@ -1,5 +1,6 @@
 import { Texture } from '../display/webgl/texture';
 import { BaseTexture } from '../display/webgl/base_texture';
+import { RenderTexture } from '../display/webgl/render_texture';
 import { Signal } from './signal';
 import { Frame } from './frame';
 import { FrameData } from './frame_data';
@@ -84,7 +85,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 +113,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 +132,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 +149,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 +160,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 +186,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 +197,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 +236,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 +248,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 +414,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {HTMLCanvasElement} TBD.
    */
   getCanvas(key) {
     return this.getItem(key, CANVAS, 'getCanvas', 'canvas');
@@ -421,7 +423,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 +440,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getTextureFrame(key) {
     return this.getItem(key, TEXTURE, 'getTextureFrame', 'frame');
@@ -445,6 +449,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getSound(key) {
     return this.getItem(key, SOUND, 'getSound');
@@ -453,6 +458,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getSoundData(key) {
     return this.getItem(key, SOUND, 'getSoundData', 'data');
@@ -461,6 +467,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getText(key) {
     return this.getItem(key, TEXT, 'getText', 'data');
@@ -469,6 +476,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getBitmapData(key) {
     return this.getItem(key, BITMAPDATA, 'getBitmapData', 'data');
@@ -477,6 +485,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {object} TBD.
    */
   getBitmapFont(key) {
     return this.getItem(key, BITMAPFONT, 'getBitmapFont');
@@ -486,6 +495,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 +505,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {XMLDocument} TBD.
    */
   getXML(key) {
     return this.getItem(key, XML, 'getXML', 'data');
@@ -503,6 +514,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {RenderTexture} TBD.
    */
   getRenderTexture(key) {
     return this.getItem(key, RENDER_TEXTURE, 'getRenderTexture');
@@ -514,6 +526,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 +536,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 +546,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 +560,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 +570,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 +579,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 +593,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 +608,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 +621,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} url - TBD.
+   * @returns {string} TBD.
    */
   getURL(url) {
     const resolvedURL = this._resolveURL(url);
@@ -615,6 +635,7 @@ export class Cache {
   /**
    * TBD.
    * @param {object} cache - TBD.
+   * @returns {string[]} TBD.
    */
   getKeys(cache = IMAGE) {
     const result = [];
@@ -739,7 +760,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

@@ -201,7 +201,7 @@ export class DOM {
 
   /**
    * TBD.
-   * @param element - TBD.
+   * @param {HTMLCanvasElement} element - TBD.
    * @param {Point} point - TBD.
    * @returns {Point} TBD.
    */
@@ -219,7 +219,7 @@ export class DOM {
 
   /**
    * TBD.
-   * @param element - TBD.
+   * @param {HTMLCanvasElement} element - TBD.
    * @param {number} cushion - TBD.
    * @returns {boolean} TBD.
    */
@@ -233,7 +233,7 @@ export class DOM {
 
   /**
    * TBD.
-   * @param coords - TBD.
+   * @param {DOMRect} coords - TBD.
    * @param {number} cushion - TBD.
    * @returns {object} TBD.
    */

package/src/phaser/core/input.js

@@ -1,5 +1,6 @@
 import { ArraySet } from './array_set';
 import { Graphics } from '../display/graphics';
+import { DisplayObject } from '../display/display_object';
 import { Image } from '../display/image';
 import { Signal } from './signal';
 import { Point } from '../geom/point';
@@ -125,7 +126,7 @@ export class Input {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param context - TBD.
+   * @param {object} context - TBD.
    */
   setInteractiveCandidateHandler(callback, context) {
     this.customCandidateHandler = callback;
@@ -135,7 +136,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 +145,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 +299,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param limit - TBD.
+   * @param {number} limit - TBD.
    * @returns {number} TBD.
    */
   countActivePointers(limit = this.pointers.length) {
@@ -329,7 +330,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param identifier - TBD.
+   * @param {number} identifier - TBD.
    * @returns {Pointer} TBD.
    */
   getPointerFromIdentifier(identifier) {
@@ -345,7 +346,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param pointerId - TBD.
+   * @param {number} pointerId - TBD.
    * @returns {Pointer} TBD.
    */
   getPointerFromId(pointerId) {
@@ -361,9 +362,9 @@ export class Input {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param pointer - TBD.
-   * @param output - TBD.
+   * @param {DisplayObject} displayObject - TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {Point} output - TBD.
    * @returns {Point} TBD.
    */
   getLocalPosition(displayObject, pointer, output = null) {
@@ -378,9 +379,9 @@ export class Input {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param pointer - TBD.
-   * @param localPoint - TBD.
+   * @param {DisplayObject} displayObject - TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {Point} localPoint - TBD.
    * @returns {boolean} TBD.
    */
   hitTest(displayObject, pointer, localPoint) {

package/src/phaser/core/input_handler.js

@@ -3,12 +3,13 @@ import { GROUP } from './const';
 import { distance } from '../util/math';
 import { Pointer } from './input_pointer';
 import { Rectangle } from '../geom/rectangle';
+import { Image } from '../display/image';
 import { DisplayObject } from '../display/display_object';
 
 export class InputHandler {
   /**
    * TBD.
-   * @param sprite
+   * @param {Image} sprite - TBD.
    */
   constructor(sprite) {
     this.sprite = sprite;

package/src/phaser/core/input_mouse.js

@@ -12,8 +12,8 @@ import { Game } from './game';
 class WheelEventProxy {
   /**
    * TBD.
-   * @param scaleFactor - TBD.
-   * @param deltaMode - TBD.
+   * @param {number} scaleFactor - TBD.
+   * @param {number} deltaMode - TBD.
    */
   constructor(scaleFactor, deltaMode) {
     this._scaleFactor = scaleFactor;
@@ -48,6 +48,7 @@ class WheelEventProxy {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get deltaMode() {
     return this._deltaMode;

package/src/phaser/core/input_pointer.js

@@ -9,6 +9,7 @@ import {
   MOUSE_TOUCH_COMBINE,
 } from './const';
 import { Game } from './game';
+import { InputHandler } from './input_handler';
 
 export class Pointer {
   /**
@@ -302,7 +303,7 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param newTarget - TBD.
+   * @param {InputHandler} newTarget - TBD.
    * @param {boolean} silent - TBD.
    */
   swapTarget(newTarget, silent = false) {