@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/event_manager.js

@@ -1,11 +1,10 @@
-/**
- * @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 { Signal } from './signal';
 
 export class EventManager {
+  /**
+   * TBD.
+   * @param sprite - TBD.
+   */
   constructor(sprite) {
     this.parent = sprite;
     this._onAddedToGroup = null;
@@ -25,6 +24,9 @@ export class EventManager {
     this._onAnimationLoop = null;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this._parent = null;
     if (this._onDestroy) {
@@ -74,6 +76,10 @@ export class EventManager {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onAddedToGroup() {
     if (!this._onAddedToGroup) {
       this._onAddedToGroup = new Signal();
@@ -81,12 +87,20 @@ export class EventManager {
     return this._onAddedToGroup;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onAddedToGroup$dispatch(...args) {
     if (this._onAddedToGroup) {
       this._onAddedToGroup.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onRemovedFromGroup() {
     if (!this._onRemovedFromGroup) {
       this._onRemovedFromGroup = new Signal();
@@ -94,12 +108,20 @@ export class EventManager {
     return this._onRemovedFromGroup;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onRemovedFromGroup$dispatch(...args) {
     if (this._onRemovedFromGroup) {
       this._onRemovedFromGroup.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onDestroy() {
     if (!this._onDestroy) {
       this._onDestroy = new Signal();
@@ -107,12 +129,20 @@ export class EventManager {
     return this._onDestroy;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onDestroy$dispatch(...args) {
     if (this._onDestroy) {
       this._onDestroy.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onOutOfBounds() {
     if (!this._onOutOfBounds) {
       this._onOutOfBounds = new Signal();
@@ -120,12 +150,20 @@ export class EventManager {
     return this._onOutOfBounds;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onOutOfBounds$dispatch(...args) {
     if (this._onOutOfBounds) {
       this._onOutOfBounds.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onEnterBounds() {
     if (!this._onEnterBounds) {
       this._onEnterBounds = new Signal();
@@ -133,12 +171,20 @@ export class EventManager {
     return this._onEnterBounds;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onEnterBounds$dispatch(...args) {
     if (this._onEnterBounds) {
       this._onEnterBounds.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onInputOver() {
     if (!this._onInputOver) {
       this._onInputOver = new Signal();
@@ -146,12 +192,20 @@ export class EventManager {
     return this._onInputOver;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onInputOver$dispatch(...args) {
     if (this._onInputOver) {
       this._onInputOver.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onInputOut() {
     if (!this._onInputOut) {
       this._onInputOut = new Signal();
@@ -159,12 +213,20 @@ export class EventManager {
     return this._onInputOut;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onInputOut$dispatch(...args) {
     if (this._onInputOut) {
       this._onInputOut.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onInputDown() {
     if (!this._onInputDown) {
       this._onInputDown = new Signal();
@@ -172,12 +234,20 @@ export class EventManager {
     return this._onInputDown;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onInputDown$dispatch(...args) {
     if (this._onInputDown) {
       this._onInputDown.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onInputUp() {
     if (!this._onInputUp) {
       this._onInputUp = new Signal();
@@ -185,12 +255,20 @@ export class EventManager {
     return this._onInputUp;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onInputUp$dispatch(...args) {
     if (this._onInputUp) {
       this._onInputUp.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onDragStart() {
     if (!this._onDragStart) {
       this._onDragStart = new Signal();
@@ -198,12 +276,20 @@ export class EventManager {
     return this._onDragStart;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onDragStart$dispatch(...args) {
     if (this._onDragStart) {
       this._onDragStart.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onDragUpdate() {
     if (!this._onDragUpdate) {
       this._onDragUpdate = new Signal();
@@ -211,12 +297,20 @@ export class EventManager {
     return this._onDragUpdate;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onDragUpdate$dispatch(...args) {
     if (this._onDragUpdate) {
       this._onDragUpdate.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onDragStop() {
     if (!this._onDragStop) {
       this._onDragStop = new Signal();
@@ -224,12 +318,20 @@ export class EventManager {
     return this._onDragStop;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onDragStop$dispatch(...args) {
     if (this._onDragStop) {
       this._onDragStop.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onAnimationStart() {
     if (!this._onAnimationStart) {
       this._onAnimationStart = new Signal();
@@ -237,12 +339,20 @@ export class EventManager {
     return this._onAnimationStart;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onAnimationStart$dispatch(...args) {
     if (this._onAnimationStart) {
       this._onAnimationStart.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onAnimationComplete() {
     if (!this._onAnimationComplete) {
       this._onAnimationComplete = new Signal();
@@ -250,12 +360,20 @@ export class EventManager {
     return this._onAnimationComplete;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onAnimationComplete$dispatch(...args) {
     if (this._onAnimationComplete) {
       this._onAnimationComplete.dispatch(...args);
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Signal} TBD.
+   */
   get onAnimationLoop() {
     if (!this._onAnimationLoop) {
       this._onAnimationLoop = new Signal();
@@ -263,6 +381,10 @@ export class EventManager {
     return this._onAnimationLoop;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   onAnimationLoop$dispatch(...args) {
     if (this._onAnimationLoop) {
       this._onAnimationLoop.dispatch(...args);

package/src/phaser/core/factory.js

@@ -1,20 +1,29 @@
-/**
- * @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 { BitmapText } from  '../display/bitmap_text';
-import { Button } from  '../display/button';
-import { Group } from  '../display/group';
-import { Graphics } from  '../display/graphics';
+import { BitmapText } from '../display/bitmap_text';
+import { Button } from '../display/button';
+import { Group } from '../display/group';
+import { Graphics } from '../display/graphics';
 import { Image } from '../display/image';
-import { Text } from  '../display/text';
+import { Text } from '../display/text';
+import { Game } from './game';
 
 export class GameObjectFactory {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {string} key - TBD.
+   * @param frame - TBD.
+   * @param {Group} group - TBD.
+   * @returns {Image} TBD.
+   */
   image(x, y, key, frame, group = null) {
     if (!group) {
       group = this.game.world;
@@ -22,49 +31,75 @@ export class GameObjectFactory {
     return group.add(new Image(this.game, x, y, key, frame));
   }
 
+  /**
+   * TBD.
+   * @param {Group} parent - TBD.
+   * @param {string} name - TBD.
+   * @param {boolean} addToStage - TBD.
+   * @returns {Group} TBD.
+   */
   group(parent, name, addToStage) {
     return new Group(this.game, parent, name, addToStage);
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param text - TBD.
+   * @param style - TBD.
+   * @param {Group} group - TBD.
+   * @returns {Text} TBD.
+   */
   text(x, y, text, style, group = null) {
     const parent = group || this.game.world;
     return parent.add(new Text(this.game, x, y, text, style));
   }
 
-  button(
-    x,
-    y,
-    key,
-    callback,
-    callbackContext,
-    overFrame,
-    outFrame,
-    downFrame,
-    upFrame,
-    group = null
-  ) {
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @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 {Group} group - TBD.
+   * @returns {Button} TBD.
+   */
+  button(x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame, group = null) {
     const parent = group || this.game.world;
     return parent.add(
-      new Button(
-        this.game,
-        x,
-        y,
-        key,
-        callback,
-        callbackContext,
-        overFrame,
-        outFrame,
-        downFrame,
-        upFrame
-      )
+      new Button(this.game, x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame)
     );
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {Group} group - TBD.
+   * @returns {Graphics} TBD.
+   */
   graphics(x, y, group = null) {
     const parent = group || this.game.world;
     return parent.add(new Graphics(this.game, x, y));
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param font - TBD.
+   * @param text - TBD.
+   * @param size - TBD.
+   * @param {Group} group - TBD.
+   * @param align - TBD.
+   * @returns {BitmapText} TBD.
+   */
   bitmapText(x, y, font, text, size, group = null, align = 'left') {
     const parent = group || this.game.world;
     return parent.add(new BitmapText(this.game, x, y, font, text, size, align));

package/src/phaser/core/frame.js

@@ -1,17 +1,30 @@
-/**
- * @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 { Rectangle } from  '../geom/rectangle';
+import { Rectangle } from '../geom/rectangle';
 import { distance } from '../util/math';
 import { cloneFrame } from './frame_util';
 
 export class Frame {
+  /**
+   * TBD.
+   * @param {number} index - TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   * @param {string} name - TBD.
+   */
   constructor(index, x, y, width, height, name) {
     this.initialize(index, x, y, width, height, name);
   }
 
+  /**
+   * TBD.
+   * @param {number} index - TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   * @param {string} name - TBD.
+   */
   initialize(index, x, y, width, height, name) {
     this.index = index;
     this.x = x;
@@ -35,6 +48,11 @@ export class Frame {
     this.bottom = this.y + this.height;
   }
 
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   resize(width, height) {
     this.width = width;
     this.height = height;
@@ -47,6 +65,16 @@ export class Frame {
     this.bottom = this.y + height;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} trimmed - TBD.
+   * @param {number} actualWidth - TBD.
+   * @param {number} actualHeight - TBD.
+   * @param {number} destX - TBD.
+   * @param {number} destY - TBD.
+   * @param {number} destWidth - TBD.
+   * @param {number} destHeight - TBD.
+   */
   setTrim(trimmed, actualWidth, actualHeight, destX, destY, destWidth, destHeight) {
     this.trimmed = trimmed;
     if (trimmed) {
@@ -61,10 +89,19 @@ export class Frame {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Frame} TBD.
+   */
   clone() {
     return cloneFrame(this);
   }
 
+  /**
+   * TBD.
+   * @param {Rectangle} output - TBD.
+   * @returns {Rectangle} TBD.
+   */
   getRect(output = null) {
     const result = output || new Rectangle();
     result.setTo(this.x, this.y, this.width, this.height);

package/src/phaser/core/frame_data.js

@@ -1,16 +1,26 @@
-/**
- * @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 { cloneFrameData } from './frame_util';
+import { Frame } from './frame';
 
 export class FrameData {
+  /**
+   * TBD.
+   */
   constructor() {
+    /**
+     * @type {Frame[]}
+     */
     this._frames = [];
+    /**
+     * @type {string[]}
+     */
     this._frameNames = [];
   }
 
+  /**
+   * TBD.
+   * @param {Frame} frame - TBD.
+   * @returns {Frame} TBD.
+   */
   addFrame(frame) {
     frame.index = this._frames.length;
     this._frames.push(frame);
@@ -20,6 +30,11 @@ export class FrameData {
     return frame;
   }
 
+  /**
+   * TBD.
+   * @param {number} index - TBD.
+   * @returns {Frame} TBD.
+   */
   getFrame(index = 0) {
     if (index >= this._frames.length) {
       index = 0;
@@ -27,6 +42,11 @@ export class FrameData {
     return this._frames[index];
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   * @returns {Frame} TBD.
+   */
   getFrameByName(name) {
     if (typeof this._frameNames[name] === 'number') {
       return this._frames[this._frameNames[name]];
@@ -34,6 +54,11 @@ export class FrameData {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   * @returns {boolean} TBD.
+   */
   checkFrameName(name) {
     if (this._frameNames[name] == null) {
       return false;
@@ -41,10 +66,21 @@ export class FrameData {
     return true;
   }
 
+  /**
+   * TBD.
+   * @returns {FrameData} TBD.
+   */
   clone() {
     return cloneFrameData(this);
   }
 
+  /**
+   * TBD.
+   * @param {number} start - TBD.
+   * @param {number} end - TBD.
+   * @param {Frame[]} output - TBD.
+   * @returns {Frame[]} TBD.
+   */
   getFrameRange(start, end, output = null) {
     const result = output || [];
     for (let i = start; i <= end; i += 1) {
@@ -53,6 +89,13 @@ export class FrameData {
     return result;
   }
 
+  /**
+   * TBD.
+   * @param {number[]|string[]} frames - TBD.
+   * @param {boolean} useNumericIndex - TBD.
+   * @param {number[]} output - TBD.
+   * @returns {number[]} TBD.
+   */
   getFrameIndexes(frames, useNumericIndex = true, output = null) {
     const result = output || [];
     if (frames && frames.length > 0) {
@@ -71,11 +114,18 @@ export class FrameData {
     return result;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this._frames = null;
     this._frameNames = null;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get total() {
     return this._frames.length;
   }

package/src/phaser/core/frame_util.js

@@ -1,28 +1,23 @@
-/**
- * @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';
 
 /**
  * TBD.
- * @param {object} frame - TBD.
- * @param {object} output - TBD.
- * @returns {object} TBD.
+ * @param {Frame} frame - TBD.
+ * @param {Frame} output - TBD.
+ * @returns {Frame} TBD.
  */
 export function cloneFrame(frame, output = null) {
-  const result = output || new Frame();
+  const result = output || new Frame(frame.index, frame.x, frame.y, frame.width, frame.height);
   result.initialize(frame.index, frame.x, frame.y, frame.width, frame.height);
   return result;
 }
 
 /**
  * TBD.
- * @param {object} frameData - TBD.
- * @param {object} output - TBD.
- * @returns {object} TBD.
+ * @param {FrameData} frameData - TBD.
+ * @param {FrameData} output - TBD.
+ * @returns {FrameData} TBD.
  */
 export function cloneFrameData(frameData, output = null) {
   const result = output || new FrameData();