@vpmedia/phaser 1.17.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.17.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.17.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",
@@ -22,16 +22,16 @@
   "main": "./src/index.js",
   "types": "./types/index.d.ts",
   "devDependencies": {
-    "eslint": "^8.38.0",
+    "eslint": "^8.39.0",
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jsdoc": "^43.0.6",
+    "eslint-plugin-jsdoc": "^43.0.7",
     "eslint-plugin-prettier": "^4.2.1",
     "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,16 @@
 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 parent - TBD.
+   * @param {Image} parent - TBD.
    * @param {string} name - TBD.
    * @param {FrameData} frameData - TBD.
-   * @param frames - TBD.
+   * @param {string[]|number[]} frames - TBD.
    * @param {number} frameRate - TBD.
    * @param {boolean} loop - TBD.
    */

package/src/phaser/core/animation_manager.js

@@ -1,10 +1,11 @@
 import { Animation } from './animation';
 import { FrameData } from './frame_data';
+import { Image } from '../display/image';
 
 export class AnimationManager {
   /**
    * TBD.
-   * @param sprite - TBD.
+   * @param {Image} sprite - TBD.
    */
   constructor(sprite) {
     this.sprite = sprite;
@@ -131,7 +132,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param {number[]} frames - TBD.
+   * @param {string[]|number[]} frames - TBD.
    * @param {boolean} useNumericIndex - TBD.
    * @returns {boolean} TBD.
    */

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,8 +113,8 @@ export class Cache {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
-   * @param atlasData - TBD.
+   * @param {HTMLCanvasElement} data - TBD.
+   * @param {object} atlasData - TBD.
    */
   addTextureAtlas(key, url, data, atlasData) {
     const obj = {
@@ -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/const.js

@@ -169,25 +169,91 @@ export const TOUCH_OVERRIDES_MOUSE = 1;
  */
 export const MOUSE_TOUCH_COMBINE = 2;
 // game objects
+/**
+ * @type {number}
+ */
 export const GROUP = 7;
+/**
+ * @type {number}
+ */
 export const SPRITE = 0;
+/**
+ * @type {number}
+ */
 export const SPRITE_BATCH = 17;
+/**
+ * @type {number}
+ */
 export const BUTTON = 1;
+/**
+ * @type {number}
+ */
 export const IMAGE = 2;
+/**
+ * @type {number}
+ */
 export const GRAPHICS = 3;
+/**
+ * @type {number}
+ */
 export const TEXT = 4;
+/**
+ * @type {number}
+ */
 export const BITMAP_TEXT = 6;
+/**
+ * @type {number}
+ */
 export const TILE_SPRITE = 5;
+/**
+ * @type {number}
+ */
 export const RENDER_TEXTURE = 8;
+/**
+ * @type {number}
+ */
 export const FILTER_CANVAS = 14;
+/**
+ * @type {number}
+ */
 export const FILTER_WEBGL = 15;
+/**
+ * @type {number}
+ */
 export const POINTER = 19;
+/**
+ * @type {number}
+ */
 export const GEOM_POLYGON = 12;
+/**
+ * @type {number}
+ */
 export const GEOM_RECTANGLE = 22;
+/**
+ * @type {number}
+ */
 export const GEOM_CIRCLE = 21;
+/**
+ * @type {number}
+ */
 export const GEOM_ELLIPSE = 16;
+/**
+ * @type {number}
+ */
 export const GEOM_ROUNDED_RECTANGLE = 26;
+/**
+ * @type {number}
+ */
 export const GEOM_LINE = 23;
+/**
+ * @type {number}
+ */
 export const GEOM_MATRIX = 24;
+/**
+ * @type {number}
+ */
 export const GEOM_POINT = 25;
+/**
+ * @type {number}
+ */
 export const PENDING_ATLAS = -1;

package/src/phaser/core/device.js

@@ -3,35 +3,122 @@ export class Device {
    * TBD.
    */
   constructor() {
+    /**
+     * @type {boolean}
+     */
     this.desktop = false;
+    /**
+     * @type {boolean}
+     */
     this.iOS = false;
+    /**
+     * @type {boolean}
+     */
     this.android = false;
+    /**
+     * @type {boolean}
+     */
     this.chromeOS = false;
+    /**
+     * @type {boolean}
+     */
     this.linux = false;
+    /**
+     * @type {boolean}
+     */
     this.macOS = false;
+    /**
+     * @type {boolean}
+     */
     this.windows = false;
+    /**
+     * @type {boolean}
+     */
     this.windowsPhone = false;
+    /**
+     * @type {boolean}
+     */
     this.canvas = false;
+    /**
+     * @type {boolean}
+     */
     this.touch = false;
+    /**
+     * @type {boolean}
+     */
     this.mspointer = false;
     this.wheelEvent = null;
+    /**
+     * @type {boolean}
+     */
     this.chrome = false;
+    /**
+     * @type {boolean}
+     */
     this.firefox = false;
+    /**
+     * @type {boolean}
+     */
     this.edge = false;
+    /**
+     * @type {boolean}
+     */
     this.safari = false;
+    /**
+     * @type {boolean}
+     */
     this.silk = false;
+    /**
+     * @type {boolean}
+     */
     this.ogg = false;
+    /**
+     * @type {boolean}
+     */
     this.opus = false;
+    /**
+     * @type {boolean}
+     */
     this.mp3 = false;
+    /**
+     * @type {boolean}
+     */
     this.wav = false;
+    /**
+     * @type {boolean}
+     */
     this.m4a = false;
+    /**
+     * @type {boolean}
+     */
     this.webm = false;
+    /**
+     * @type {boolean}
+     */
     this.dolby = false;
+    /**
+     * @type {boolean}
+     */
     this.avif = false;
+    /**
+     * @type {boolean}
+     */
     this.webp = false;
+    /**
+     * @type {boolean}
+     */
     this.fullscreen = false;
+    /**
+     * @type {string}
+     */
     this.requestFullscreen = '';
+    /**
+     * @type {string}
+     */
     this.cancelFullscreen = '';
+    /**
+     * @type {boolean}
+     */
     this.fullscreenKeyboard = false;
   }
 }

package/src/phaser/core/dom.js

@@ -1,4 +1,5 @@
 import { Point } from '../geom/point';
+import { Device } from './device';
 
 class VisualBoundsDesktopRectangle {
   /**
@@ -182,7 +183,7 @@ class DocumentBoundsRectangle {
 export class DOM {
   /**
    * TBD.
-   * @param device
+   * @param {Device} device - TBD.
    */
   constructor(device) {
     this.treatAsDesktop =
@@ -200,8 +201,9 @@ export class DOM {
 
   /**
    * TBD.
-   * @param element
-   * @param point
+   * @param {HTMLCanvasElement} element - TBD.
+   * @param {Point} point - TBD.
+   * @returns {Point} TBD.
    */
   getOffset(element, point = null) {
     point = point || new Point();
@@ -217,8 +219,9 @@ export class DOM {
 
   /**
    * TBD.
-   * @param element
-   * @param cushion
+   * @param {HTMLCanvasElement} element - TBD.
+   * @param {number} cushion - TBD.
+   * @returns {boolean} TBD.
    */
   getBounds(element, cushion = 0) {
     element = element && !element.nodeType ? element[0] : element;
@@ -230,8 +233,9 @@ export class DOM {
 
   /**
    * TBD.
-   * @param coords
-   * @param cushion
+   * @param {DOMRect} coords - TBD.
+   * @param {number} cushion - TBD.
+   * @returns {object} TBD.
    */
   calibrate(coords, cushion = 0) {
     const output = {
@@ -249,7 +253,8 @@ export class DOM {
 
   /**
    * TBD.
-   * @param primaryFallback
+   * @param {string} primaryFallback - TBD.
+   * @returns {string} TBD.
    */
   getScreenOrientation(primaryFallback) {
     const screen = window.screen;

package/src/phaser/core/event_manager.js

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

package/src/phaser/core/factory.js

@@ -20,7 +20,7 @@ export class GameObjectFactory {
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.
-   * @param frame - TBD.
+   * @param {string} frame - TBD.
    * @param {Group} group - TBD.
    * @returns {Image} TBD.
    */
@@ -46,8 +46,8 @@ export class GameObjectFactory {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param text - TBD.
-   * @param style - TBD.
+   * @param {string} text - TBD.
+   * @param {object} style - TBD.
    * @param {Group} group - TBD.
    * @returns {Text} TBD.
    */
@@ -63,10 +63,10 @@ export class GameObjectFactory {
    * @param {string} key - TBD.
    * @param {Function} callback - TBD.
    * @param {object} callbackContext - TBD.
-   * @param overFrame - TBD.
-   * @param outFrame - TBD.
-   * @param downFrame - TBD.
-   * @param upFrame - TBD.
+   * @param {string} overFrame - TBD.
+   * @param {string} outFrame - TBD.
+   * @param {string} downFrame - TBD.
+   * @param {string} upFrame - TBD.
    * @param {Group} group - TBD.
    * @returns {Button} TBD.
    */
@@ -93,11 +93,11 @@ export class GameObjectFactory {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param font - TBD.
-   * @param text - TBD.
-   * @param size - TBD.
+   * @param {string} font - TBD.
+   * @param {string} text - TBD.
+   * @param {number} size - TBD.
    * @param {Group} group - TBD.
-   * @param align - TBD.
+   * @param {string} align - TBD.
    * @returns {BitmapText} TBD.
    */
   bitmapText(x, y, font, text, size, group = null, align = 'left') {

package/src/phaser/core/game.js

@@ -35,6 +35,7 @@ export class Game {
     this.renderer = null;
     this.state = null;
     this.isBooted = false;
+    this.paused = false;
     this.raf = null;
     this.add = null;
     this.cache = null;