@vpmedia/phaser 1.16.0 → 1.18.0

package/README.md

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

package/src/phaser/core/animation.js

@@ -1,16 +1,18 @@
 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 name - TBD.
-   * @param frameData - TBD.
-   * @param frames - TBD.
-   * @param frameRate - TBD.
-   * @param loop - TBD.
+   * @param {Image} parent - TBD.
+   * @param {string} name - TBD.
+   * @param {FrameData} frameData - TBD.
+   * @param {string[]|number[]} frames - TBD.
+   * @param {number} frameRate - TBD.
+   * @param {boolean} loop - TBD.
    */
   constructor(game, parent, name, frameData, frames, frameRate, loop = false) {
     this.game = game;
@@ -43,9 +45,10 @@ export class Animation {
 
   /**
    * TBD.
-   * @param frameRate - TBD.
-   * @param loop - TBD.
-   * @param killOnComplete - TBD.
+   * @param {number} frameRate - TBD.
+   * @param {boolean} loop - TBD.
+   * @param {boolean} killOnComplete - TBD.
+   * @returns {Animation} TBD.
    */
   play(frameRate, loop, killOnComplete) {
     if (typeof frameRate === 'number') {
@@ -95,6 +98,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {Animation} TBD.
    */
   reverse() {
     this.reversed = !this.reversed;
@@ -103,6 +107,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {Animation} TBD.
    */
   reverseOnce() {
     this.onComplete.addOnce(this.reverse, this);
@@ -111,8 +116,8 @@ export class Animation {
 
   /**
    * TBD.
-   * @param frameId - TBD.
-   * @param useLocalFrameIndex - TBD.
+   * @param {number|string} frameId - TBD.
+   * @param {boolean} useLocalFrameIndex - TBD.
    */
   setFrame(frameId, useLocalFrameIndex = false) {
     let frameIndex;
@@ -145,8 +150,8 @@ export class Animation {
 
   /**
    * TBD.
-   * @param resetFrame - TBD.
-   * @param dispatchComplete - TBD.
+   * @param {boolean} resetFrame - TBD.
+   * @param {boolean} dispatchComplete - TBD.
    */
   stop(resetFrame = false, dispatchComplete = false) {
     this.isPlaying = false;
@@ -184,6 +189,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   update() {
     if (this.isPaused) {
@@ -242,8 +248,9 @@ export class Animation {
 
   /**
    * TBD.
-   * @param signalUpdate - TBD.
-   * @param fromPlay - TBD.
+   * @param {boolean} signalUpdate - TBD.
+   * @param {boolean} fromPlay - TBD.
+   * @returns {boolean} TBD.
    */
   updateCurrentFrame(signalUpdate, fromPlay = false) {
     if (!this._frameData || !this.currentFrame) {
@@ -266,7 +273,7 @@ export class Animation {
 
   /**
    * TBD.
-   * @param quantity - TBD.
+   * @param {number} quantity - TBD.
    */
   next(quantity = 1) {
     let frame = this._frameIndex + quantity;
@@ -285,7 +292,7 @@ export class Animation {
 
   /**
    * TBD.
-   * @param quantity - TBD.
+   * @param {number} quantity - TBD.
    */
   previous(quantity = 1) {
     let frame = this._frameIndex - quantity;
@@ -304,7 +311,7 @@ export class Animation {
 
   /**
    * TBD.
-   * @param frameData - TBD.
+   * @param {FrameData} frameData - TBD.
    */
   updateFrameData(frameData) {
     this._frameData = frameData;
@@ -355,6 +362,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get paused() {
     return this.isPaused;
@@ -374,6 +382,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get reversed() {
     return this.isReversed;
@@ -388,6 +397,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get frameTotal() {
     return this._frames.length;
@@ -395,6 +405,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get frame() {
     if (this.currentFrame !== null) {
@@ -419,6 +430,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get speed() {
     return 1000 / this.delay;
@@ -435,6 +447,7 @@ export class Animation {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get enableUpdate() {
     return this.onUpdate !== null;

package/src/phaser/core/animation_manager.js

@@ -1,9 +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;
@@ -36,8 +38,9 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param frameData - TBD.
-   * @param frame - TBD.
+   * @param {FrameData} frameData - TBD.
+   * @param {number|string} frame - TBD.
+   * @returns {boolean} TBD.
    */
   loadFrameData(frameData, frame) {
     if (!frameData) {
@@ -65,8 +68,9 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param frameData - TBD.
-   * @param frame - TBD.
+   * @param {FrameData} frameData - TBD.
+   * @param {number|string} frame - TBD.
+   * @returns {boolean} TBD.
    */
   copyFrameData(frameData, frame) {
     this._frameData = frameData.clone();
@@ -91,11 +95,12 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param name - TBD.
-   * @param frameList - TBD.
-   * @param frameRate - TBD.
-   * @param loop - TBD.
-   * @param useNumericIndex - 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 || [];
@@ -127,8 +132,9 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param frames - TBD.
-   * @param useNumericIndex - TBD.
+   * @param {string[]|number[]} frames - TBD.
+   * @param {boolean} useNumericIndex - TBD.
+   * @returns {boolean} TBD.
    */
   validateFrames(frames, useNumericIndex = false) {
     for (let i = 0; i < frames.length; i += 1) {
@@ -145,10 +151,11 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param name - TBD.
-   * @param frameRate - TBD.
-   * @param loop - TBD.
-   * @param killOnComplete - 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]) {
@@ -172,8 +179,8 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param name - TBD.
-   * @param resetFrame - TBD.
+   * @param {string} name - TBD.
+   * @param {boolean} resetFrame - TBD.
    */
   stop(name, resetFrame = false) {
     if (this.currentAnim && (typeof name !== 'string' || name === this.currentAnim.name)) {
@@ -183,6 +190,7 @@ export class AnimationManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   update() {
     if (this.updateIfVisible && !this.sprite.visible) {
@@ -197,7 +205,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param quantity - TBD.
+   * @param {number} quantity - TBD.
    */
   next(quantity) {
     if (this.currentAnim) {
@@ -208,7 +216,7 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param quantity - TBD.
+   * @param {number} quantity - TBD.
    */
   previous(quantity) {
     if (this.currentAnim) {
@@ -219,7 +227,8 @@ export class AnimationManager {
 
   /**
    * TBD.
-   * @param name - TBD.
+   * @param {string} name - TBD.
+   * @returns {Animation} TBD.
    */
   getAnimation(name) {
     if (name && this._anims[name]) {
@@ -239,6 +248,7 @@ export class AnimationManager {
 
   /**
    * TBD.
+   * @returns {FrameData} TBD.
    */
   get frameData() {
     return this._frameData;
@@ -246,6 +256,7 @@ export class AnimationManager {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get frameTotal() {
     return this._frameData.total;
@@ -253,6 +264,7 @@ export class AnimationManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get paused() {
     return this.currentAnim.isPaused;
@@ -267,6 +279,7 @@ export class AnimationManager {
 
   /**
    * TBD.
+   * @returns {string} TBD.
    */
   get name() {
     if (this.currentAnim) {
@@ -277,6 +290,7 @@ export class AnimationManager {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get frame() {
     if (this.currentFrame) {
@@ -301,6 +315,7 @@ export class AnimationManager {
 
   /**
    * TBD.
+   * @returns {string} TBD.
    */
   get frameName() {
     if (this.currentFrame) {

package/src/phaser/core/animation_parser.js

@@ -5,7 +5,7 @@ import { Game } from './game';
 /**
  * TBD.
  * @param {Game} game - TBD.
- * @param {object} key - TBD.
+ * @param {string} key - TBD.
  * @param {number} frameWidth - TBD.
  * @param {number} frameHeight - TBD.
  * @param {number} frameMax - TBD.

package/src/phaser/core/array_set.js

@@ -1,7 +1,7 @@
 export class ArraySet {
   /**
    * TBD.
-   * @param list - TBD.
+   * @param {object[]} list - TBD.
    */
   constructor(list = []) {
     this.position = 0;
@@ -10,7 +10,8 @@ export class ArraySet {
 
   /**
    * TBD.
-   * @param item - TBD.
+   * @param {object} item - TBD.
+   * @returns {object} TBD.
    */
   add(item) {
     if (!this.exists(item)) {
@@ -21,7 +22,8 @@ export class ArraySet {
 
   /**
    * TBD.
-   * @param item - TBD.
+   * @param {object} item - TBD.
+   * @returns {number} TBD.
    */
   getIndex(item) {
     return this.list.indexOf(item);
@@ -29,8 +31,9 @@ export class ArraySet {
 
   /**
    * TBD.
-   * @param property - TBD.
-   * @param value - TBD.
+   * @param {string} property - TBD.
+   * @param {object} value - TBD.
+   * @returns {object} TBD.
    */
   getByKey(property, value) {
     let i = this.list.length;
@@ -45,7 +48,8 @@ export class ArraySet {
 
   /**
    * TBD.
-   * @param item - TBD.
+   * @param {object} item - TBD.
+   * @returns {boolean} TBD.
    */
   exists(item) {
     return this.list.indexOf(item) > -1;
@@ -60,7 +64,8 @@ export class ArraySet {
 
   /**
    * TBD.
-   * @param item - TBD.
+   * @param {object} item - TBD.
+   * @returns {object} TBD.
    */
   remove(item) {
     const idx = this.list.indexOf(item);
@@ -74,7 +79,7 @@ export class ArraySet {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param value - TBD.
+   * @param {object} value - TBD.
    */
   setAll(key, value) {
     let i = this.list.length;
@@ -103,7 +108,7 @@ export class ArraySet {
 
   /**
    * TBD.
-   * @param destroy - TBD.
+   * @param {boolean} destroy - TBD.
    */
   removeAll(destroy = false) {
     let i = this.list.length;
@@ -122,6 +127,7 @@ export class ArraySet {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get total() {
     return this.list.length;
@@ -129,6 +135,7 @@ export class ArraySet {
 
   /**
    * TBD.
+   * @returns {object} TBD.
    */
   get first() {
     this.position = 0;
@@ -140,6 +147,7 @@ export class ArraySet {
 
   /**
    * TBD.
+   * @returns {object} TBD.
    */
   get next() {
     if (this.position < this.list.length) {