@vpmedia/phaser 1.15.0 → 1.17.0

package/README.md

@@ -1,7 +1,6 @@
-@vpmedia/phaser
-===============
+# @vpmedia/phaser
 
-[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.15.0)](https://badge.fury.io/js/@vpmedia%2Fphaser)
+[![npm version](https://badge.fury.io/js/@vpmedia%2Fphaser.svg?v=1.17.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.
@@ -17,6 +16,7 @@ https://github.com/vpmedia/phaser-example
 ### Comments
 
 Some features has not been ported compared to the original version:
+
 - Creature, RetroFont, Rope, SpriteBatch and Video display objects
 - Particle System
 - Physics System

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vpmedia/phaser",
-  "version": "1.15.0",
+  "version": "1.17.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",
@@ -26,7 +26,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-import": "^2.27.5",
     "eslint-plugin-jest": "^27.2.1",
-    "eslint-plugin-jsdoc": "^43.0.0",
+    "eslint-plugin-jsdoc": "^43.0.6",
     "eslint-plugin-prettier": "^4.2.1",
     "husky": "^8.0.3",
     "jest": "^29.5.0",
@@ -36,10 +36,11 @@
   },
   "scripts": {
     "test": "NODE_OPTIONS=--experimental-vm-modules jest --passWithNoTests",
-    "lint": "eslint \"**/*.js\"",
-    "lint-fix": "eslint \"**/*.js\" --fix",
+    "lint": "eslint \"**/*.{js,jsx}\"",
+    "lint-fix": "eslint --fix \"**/*.{js,jsx}\"",
     "typecheck": "tsc",
-    "format": "prettier --write \"**/*.{js,json}\"",
+    "format": "prettier --write \"**/*.{css,js,jsx,json,md}\"",
+    "prepare": "husky install",
     "lint-staged": "lint-staged"
   },
   "engines": {

package/src/index.js

@@ -1,32 +1,28 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
 // core
 import * as Const from './phaser/core/const';
 import { Game } from './phaser/core/game';
-import { Signal } from  './phaser/core/signal';
+import { Signal } from './phaser/core/signal';
 import * as MathUtils from './phaser/util/math';
 // texture
 import { BaseTexture } from './phaser/display/webgl/base_texture';
 import { Texture } from './phaser/display/webgl/texture';
 // geom
-import { Circle } from  './phaser/geom/circle';
-import { Ellipse } from  './phaser/geom/ellipse';
-import { Line } from  './phaser/geom/line';
-import { Matrix } from  './phaser/geom/matrix';
+import { Circle } from './phaser/geom/circle';
+import { Ellipse } from './phaser/geom/ellipse';
+import { Line } from './phaser/geom/line';
+import { Matrix } from './phaser/geom/matrix';
 import { Point } from './phaser/geom/point';
-import { Polygon } from  './phaser/geom/polygon';
-import { Rectangle } from  './phaser/geom/rectangle';
-import { RoundedRectangle } from  './phaser/geom/rounded_rectangle';
+import { Polygon } from './phaser/geom/polygon';
+import { Rectangle } from './phaser/geom/rectangle';
+import { RoundedRectangle } from './phaser/geom/rounded_rectangle';
 // display
-import { BitmapText } from  './phaser/display/bitmap_text';
-import { DisplayObject } from  './phaser/display/display_object';
-import { Button } from  './phaser/display/button';
+import { BitmapText } from './phaser/display/bitmap_text';
+import { DisplayObject } from './phaser/display/display_object';
+import { Button } from './phaser/display/button';
 import { Image } from './phaser/display/image';
-import { Group } from  './phaser/display/group';
-import { Text } from  './phaser/display/text';
+import { Group } from './phaser/display/group';
+import { Text } from './phaser/display/text';
+import { Graphics } from './phaser/display/graphics';
 // exports
 export {
   Const,
@@ -49,4 +45,5 @@ export {
   Image,
   Group,
   Text,
+  Graphics,
 };

package/src/phaser/core/animation.js

@@ -1,11 +1,18 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
-import { Signal } from  './signal';
+import { Game } from './game';
+import { Signal } from './signal';
+import { FrameData } from './frame_data';
 
 export class Animation {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   * @param parent - TBD.
+   * @param {string} name - TBD.
+   * @param {FrameData} frameData - TBD.
+   * @param frames - TBD.
+   * @param {number} frameRate - TBD.
+   * @param {boolean} loop - TBD.
+   */
   constructor(game, parent, name, frameData, frames, frameRate, loop = false) {
     this.game = game;
     this._parent = parent;
@@ -35,6 +42,13 @@ export class Animation {
     this.game.onResume.add(this.onResume, this);
   }
 
+  /**
+   * TBD.
+   * @param {number} frameRate - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {boolean} killOnComplete - TBD.
+   * @returns {Animation} TBD.
+   */
   play(frameRate, loop, killOnComplete) {
     if (typeof frameRate === 'number') {
       //  If they set a new frame rate then use it, otherwise use the one set on creation
@@ -63,6 +77,9 @@ export class Animation {
     return this;
   }
 
+  /**
+   * TBD.
+   */
   restart() {
     this.isPlaying = true;
     this.isFinished = false;
@@ -78,16 +95,29 @@ export class Animation {
     this.onStart.dispatch(this._parent, this);
   }
 
+  /**
+   * TBD.
+   * @returns {Animation} TBD.
+   */
   reverse() {
     this.reversed = !this.reversed;
     return this;
   }
 
+  /**
+   * TBD.
+   * @returns {Animation} TBD.
+   */
   reverseOnce() {
     this.onComplete.addOnce(this.reverse, this);
     return this.reverse();
   }
 
+  /**
+   * TBD.
+   * @param {number|string} frameId - TBD.
+   * @param {boolean} useLocalFrameIndex - TBD.
+   */
   setFrame(frameId, useLocalFrameIndex = false) {
     let frameIndex;
     //  Find the index to the desired frame.
@@ -117,6 +147,11 @@ export class Animation {
     }
   }
 
+  /**
+   * TBD.
+   * @param {boolean} resetFrame - TBD.
+   * @param {boolean} dispatchComplete - TBD.
+   */
   stop(resetFrame = false, dispatchComplete = false) {
     this.isPlaying = false;
     this.isFinished = true;
@@ -133,18 +168,28 @@ export class Animation {
     }
   }
 
+  /**
+   * TBD.
+   */
   onPause() {
     if (this.isPlaying) {
       this._frameDiff = this._timeNextFrame - this.game.time.time;
     }
   }
 
+  /**
+   * TBD.
+   */
   onResume() {
     if (this.isPlaying) {
       this._timeNextFrame = this.game.time.time + this._frameDiff;
     }
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   update() {
     if (this.isPaused) {
       return false;
@@ -200,6 +245,12 @@ export class Animation {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} signalUpdate - TBD.
+   * @param {boolean} fromPlay - TBD.
+   * @returns {boolean} TBD.
+   */
   updateCurrentFrame(signalUpdate, fromPlay = false) {
     if (!this._frameData || !this.currentFrame) {
       // The animation is already destroyed, probably from a callback
@@ -219,6 +270,10 @@ export class Animation {
     return true;
   }
 
+  /**
+   * TBD.
+   * @param {number} quantity - TBD.
+   */
   next(quantity = 1) {
     let frame = this._frameIndex + quantity;
     if (frame >= this._frames.length) {
@@ -234,6 +289,10 @@ export class Animation {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} quantity - TBD.
+   */
   previous(quantity = 1) {
     let frame = this._frameIndex - quantity;
     if (frame < 0) {
@@ -249,6 +308,10 @@ export class Animation {
     }
   }
 
+  /**
+   * TBD.
+   * @param {FrameData} frameData - TBD.
+   */
   updateFrameData(frameData) {
     this._frameData = frameData;
     this.currentFrame = this._frameData
@@ -256,6 +319,9 @@ export class Animation {
       : null;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     if (!this._frameData) {
       // Already destroyed
@@ -277,6 +343,9 @@ export class Animation {
     }
   }
 
+  /**
+   * TBD.
+   */
   complete() {
     this._frameIndex = this._frames.length - 1;
     this.currentFrame = this._frameData.getFrame(this._frames[this._frameIndex]);
@@ -290,10 +359,17 @@ export class Animation {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get paused() {
     return this.isPaused;
   }
 
+  /**
+   * TBD.
+   */
   set paused(value) {
     this.isPaused = value;
     if (value) {
@@ -303,18 +379,33 @@ export class Animation {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get reversed() {
     return this.isReversed;
   }
 
+  /**
+   * TBD.
+   */
   set reversed(value) {
     this.isReversed = value;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get frameTotal() {
     return this._frames.length;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get frame() {
     if (this.currentFrame !== null) {
       return this.currentFrame.index;
@@ -322,6 +413,9 @@ export class Animation {
     return this._frameIndex;
   }
 
+  /**
+   * TBD.
+   */
   set frame(value) {
     this.currentFrame = this._frameData.getFrame(this._frames[value]);
     if (this.currentFrame !== null) {
@@ -333,20 +427,34 @@ export class Animation {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get speed() {
     return 1000 / this.delay;
   }
 
+  /**
+   * TBD.
+   */
   set speed(value) {
     if (value > 0) {
       this.delay = 1000 / value;
     }
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get enableUpdate() {
     return this.onUpdate !== null;
   }
 
+  /**
+   * TBD.
+   */
   set enableUpdate(value) {
     if (value && this.onUpdate === null) {
       this.onUpdate = new Signal();

package/src/phaser/core/animation_manager.js

@@ -1,11 +1,11 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
 import { Animation } from './animation';
+import { FrameData } from './frame_data';
 
 export class AnimationManager {
+  /**
+   * TBD.
+   * @param sprite - TBD.
+   */
   constructor(sprite) {
     this.sprite = sprite;
     this.game = sprite.game;
@@ -18,6 +18,9 @@ export class AnimationManager {
     this._outputFrames = [];
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     const keys = Object.keys(this._anims);
     for (let i = 0; i < keys.length; i += 1) {
@@ -32,6 +35,12 @@ export class AnimationManager {
     this.game = null;
   }
 
+  /**
+   * TBD.
+   * @param {FrameData} frameData - TBD.
+   * @param {number|string} frame - TBD.
+   * @returns {boolean} TBD.
+   */
   loadFrameData(frameData, frame) {
     if (!frameData) {
       return false;
@@ -56,6 +65,12 @@ export class AnimationManager {
     return true;
   }
 
+  /**
+   * TBD.
+   * @param {FrameData} frameData - TBD.
+   * @param {number|string} frame - TBD.
+   * @returns {boolean} TBD.
+   */
   copyFrameData(frameData, frame) {
     this._frameData = frameData.clone();
     if (this.isLoaded) {
@@ -77,6 +92,15 @@ export class AnimationManager {
     return true;
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   * @param {number[]|string[]} frameList - TBD.
+   * @param {number} frameRate - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {boolean} useNumericIndex - TBD.
+   * @returns {Animation} TBD.
+   */
   add(name, frameList, frameRate = 60, loop = false, useNumericIndex = undefined) {
     const frames = frameList || [];
     //  If they didn't set the useNumericIndex then let's at least try and guess it
@@ -105,6 +129,12 @@ export class AnimationManager {
     return this._anims[name];
   }
 
+  /**
+   * TBD.
+   * @param {number[]} frames - TBD.
+   * @param {boolean} useNumericIndex - TBD.
+   * @returns {boolean} TBD.
+   */
   validateFrames(frames, useNumericIndex = false) {
     for (let i = 0; i < frames.length; i += 1) {
       if (useNumericIndex === true) {
@@ -118,6 +148,14 @@ export class AnimationManager {
     return true;
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   * @param {number} frameRate - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {boolean} killOnComplete - TBD.
+   * @returns {Animation} TBD.
+   */
   play(name, frameRate, loop, killOnComplete) {
     if (this._anims[name]) {
       if (this.currentAnim === this._anims[name]) {
@@ -138,12 +176,21 @@ export class AnimationManager {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   * @param {boolean} resetFrame - TBD.
+   */
   stop(name, resetFrame = false) {
     if (this.currentAnim && (typeof name !== 'string' || name === this.currentAnim.name)) {
       this.currentAnim.stop(resetFrame);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   update() {
     if (this.updateIfVisible && !this.sprite.visible) {
       return false;
@@ -155,6 +202,10 @@ export class AnimationManager {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {number} quantity - TBD.
+   */
   next(quantity) {
     if (this.currentAnim) {
       this.currentAnim.next(quantity);
@@ -162,6 +213,10 @@ export class AnimationManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} quantity - TBD.
+   */
   previous(quantity) {
     if (this.currentAnim) {
       this.currentAnim.previous(quantity);
@@ -169,6 +224,11 @@ export class AnimationManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   * @returns {Animation} TBD.
+   */
   getAnimation(name) {
     if (name && this._anims[name]) {
       return this._anims[name];
@@ -176,28 +236,50 @@ export class AnimationManager {
     return null;
   }
 
+  /**
+   * TBD.
+   */
   refreshFrame() {
     // TODO
     console.warn('animation_manager.refreshFrame() is not implemented');
     // this.sprite.setTexture(PIXI.TextureCache[this.currentFrame.uuid]);
   }
 
+  /**
+   * TBD.
+   * @returns {FrameData} TBD.
+   */
   get frameData() {
     return this._frameData;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get frameTotal() {
     return this._frameData.total;
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get paused() {
     return this.currentAnim.isPaused;
   }
 
+  /**
+   * TBD.
+   */
   set paused(value) {
     this.currentAnim.paused = value;
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   get name() {
     if (this.currentAnim) {
       return this.currentAnim.name;
@@ -205,6 +287,10 @@ export class AnimationManager {
     return null;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get frame() {
     if (this.currentFrame) {
       return this.currentFrame.index;
@@ -212,6 +298,9 @@ export class AnimationManager {
     return 0;
   }
 
+  /**
+   * TBD.
+   */
   set frame(value) {
     if (typeof value === 'number' && this._frameData && this._frameData.getFrame(value) !== null) {
       this.currentFrame = this._frameData.getFrame(value);
@@ -223,6 +312,10 @@ export class AnimationManager {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   get frameName() {
     if (this.currentFrame) {
       return this.currentFrame.name;
@@ -230,12 +323,11 @@ export class AnimationManager {
     return null;
   }
 
+  /**
+   * TBD.
+   */
   set frameName(value) {
-    if (
-      typeof value === 'string' &&
-      this._frameData &&
-      this._frameData.getFrameByName(value) !== null
-    ) {
+    if (typeof value === 'string' && this._frameData && this._frameData.getFrameByName(value) !== null) {
       this.currentFrame = this._frameData.getFrameByName(value);
       if (this.currentFrame) {
         this._frameIndex = this.currentFrame.index;

package/src/phaser/core/animation_parser.js

@@ -1,15 +1,11 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
 import { Frame } from './frame';
 import { FrameData } from './frame_data';
+import { Game } from './game';
 
 /**
  * TBD.
- * @param {object} game - TBD.
- * @param {object} key - TBD.
+ * @param {Game} game - TBD.
+ * @param {string} key - TBD.
  * @param {number} frameWidth - TBD.
  * @param {number} frameHeight - TBD.
  * @param {number} frameMax - TBD.
@@ -42,9 +38,7 @@ export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin
   //  Zero or smaller than frame sizes?
   if (width === 0 || height === 0 || width < frameWidth || height < frameHeight || total === 0) {
     console.warn(
-      "AnimationParser.spriteSheet: '" +
-        key +
-        "'s width/height zero or width/height < given frameWidth/frameHeight"
+      "AnimationParser.spriteSheet: '" + key + "'s width/height zero or width/height < given frameWidth/frameHeight"
     );
     return null;
   }
@@ -65,7 +59,7 @@ export function spriteSheet(game, key, frameWidth, frameHeight, frameMax, margin
 
 /**
  * TBD.
- * @param {object} game - TBD.
+ * @param {Game} game - TBD.
  * @param {object} json - TBD.
  * @returns {object} TBD.
  */
@@ -84,14 +78,7 @@ export function JSONDataHash(game, json) {
   for (let k = 0; k < keys.length; k += 1) {
     const key = keys[k];
     newFrame = data.addFrame(
-      new Frame(
-        i,
-        frames[key].frame.x,
-        frames[key].frame.y,
-        frames[key].frame.w,
-        frames[key].frame.h,
-        key
-      )
+      new Frame(i, frames[key].frame.x, frames[key].frame.y, frames[key].frame.w, frames[key].frame.h, key)
     );
     if (frames[key].trimmed) {
       newFrame.setTrim(