@vpmedia/phaser 1.14.0 → 1.16.0

package/src/phaser/core/tween_manager.js

@@ -1,8 +1,3 @@
-/**
- * @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 { Tween } from './tween';
 import {
   LinearNone,
@@ -38,8 +33,13 @@ import {
   BounceInOut,
 } from './tween_easing';
 import { GROUP } from './const';
+import { Game } from './game';
 
 export class TweenManager {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this._tweens = [];
@@ -92,10 +92,16 @@ export class TweenManager {
     this.game.onResume.add(this._resumeAll, this);
   }
 
+  /**
+   * TBD.
+   */
   getAll() {
     return this._tweens;
   }
 
+  /**
+   * TBD.
+   */
   removeAll() {
     for (let i = 0; i < this._tweens.length; i += 1) {
       this._tweens[i].pendingDelete = true;
@@ -103,6 +109,11 @@ export class TweenManager {
     this._add = [];
   }
 
+  /**
+   * TBD.
+   * @param obj
+   * @param children
+   */
   removeFrom(obj, children) {
     let i;
     let len;
@@ -128,15 +139,27 @@ export class TweenManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param tween
+   */
   add(tween) {
     tween._manager = this;
     this._add.push(tween);
   }
 
+  /**
+   * TBD.
+   * @param object
+   */
   create(object) {
     return new Tween(object, this.game, this);
   }
 
+  /**
+   * TBD.
+   * @param tween
+   */
   remove(tween) {
     let i = this._tweens.indexOf(tween);
     if (i !== -1) {
@@ -149,6 +172,9 @@ export class TweenManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   update() {
     const addTweens = this._add.length;
     let numTweens = this._tweens.length;
@@ -172,28 +198,44 @@ export class TweenManager {
     return true;
   }
 
+  /**
+   * TBD.
+   * @param object
+   */
   isTweening(object) {
     return this._tweens.some((tween) => tween.target === object);
   }
 
+  /**
+   * TBD.
+   */
   _pauseAll() {
     for (let i = this._tweens.length - 1; i >= 0; i -= 1) {
       this._tweens[i]._pause();
     }
   }
 
+  /**
+   * TBD.
+   */
   _resumeAll() {
     for (let i = this._tweens.length - 1; i >= 0; i -= 1) {
       this._tweens[i]._resume();
     }
   }
 
+  /**
+   * TBD.
+   */
   pauseAll() {
     for (let i = this._tweens.length - 1; i >= 0; i -= 1) {
       this._tweens[i].pause();
     }
   }
 
+  /**
+   * TBD.
+   */
   resumeAll() {
     for (let i = this._tweens.length - 1; i >= 0; i -= 1) {
       this._tweens[i].resume(true);

package/src/phaser/core/world.js

@@ -1,15 +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 { Group } from  '../display/group';
+import { Group } from '../display/group';
+import { Game } from './game';
 
 export class World extends Group {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     super(game, null, '__world', false);
   }
 
+  /**
+   * TBD.
+   */
   boot() {
     this.game.stage.addChild(this);
   }

package/src/phaser/display/bitmap_text.js

@@ -1,19 +1,13 @@
-/**
- * @module display/bitmap_text
- * @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 { DisplayObject } from  './display_object';
+import { DisplayObject } from './display_object';
 import { Image } from './image';
+import { Game } from '../core/game';
 import { Point } from '../geom/point';
 import { BITMAP_TEXT, SCALE_LINEAR, SCALE_NEAREST } from '../core/const';
 
 export class BitmapText extends DisplayObject {
   /**
    * TBD.
-   *
-   * @param {object} game - TBD.
+   * @param {Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} font - TBD.
@@ -41,6 +35,9 @@ export class BitmapText extends DisplayObject {
     this.dirty = false;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this._prevAnchor = null;
     this._glyphs = null;
@@ -49,6 +46,9 @@ export class BitmapText extends DisplayObject {
     super.destroy();
   }
 
+  /**
+   * TBD.
+   */
   preUpdate() {
     if (this.pendingDestroy) {
       this.destroy();
@@ -68,10 +68,21 @@ export class BitmapText extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @param text - TBD.
+   */
   setText(text) {
     this.text = text;
   }
 
+  /**
+   * TBD.
+   * @param data - TBD.
+   * @param scale - TBD.
+   * @param text - TBD.
+   * @returns {object} TBD.
+   */
   scanLine(data, scale, text) {
     let x = 0;
     let w = 0;
@@ -102,8 +113,7 @@ export class BitmapText extends DisplayObject {
         charData = data.chars[charCode];
       }
       //  Adjust for kerning from previous character to this one
-      const kerning =
-        prevCharCode && charData.kerning[prevCharCode] ? charData.kerning[prevCharCode] : 0;
+      const kerning = prevCharCode && charData.kerning[prevCharCode] ? charData.kerning[prevCharCode] : 0;
       //  Record the last space in the string and the current width
       if (/(\s)/.test(text.charAt(i))) {
         lastSpace = i;
@@ -134,6 +144,12 @@ export class BitmapText extends DisplayObject {
     };
   }
 
+  /**
+   * TBD.
+   * @param text - TBD.
+   * @param replace - TBD.
+   * @returns {string} TBD.
+   */
   cleanText(text, replace = '') {
     const data = this._data.font;
     if (!data) {
@@ -156,6 +172,9 @@ export class BitmapText extends DisplayObject {
     return lines.join('\n');
   }
 
+  /**
+   * TBD.
+   */
   updateText() {
     const data = this._data.font;
     if (!data) {
@@ -224,6 +243,10 @@ export class BitmapText extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   purgeGlyphs() {
     const len = this._glyphs.length;
     const kept = [];
@@ -240,6 +263,9 @@ export class BitmapText extends DisplayObject {
     return len - kept.length;
   }
 
+  /**
+   * TBD.
+   */
   updateTransform() {
     if (this.dirty || !this.anchor.equals(this._prevAnchor)) {
       this.updateText();
@@ -249,10 +275,17 @@ export class BitmapText extends DisplayObject {
     super.updateTransform();
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   get align() {
     return this._align;
   }
 
+  /**
+   * TBD.
+   */
   set align(value) {
     if (value !== this._align && (value === 'left' || value === 'center' || value === 'right')) {
       this._align = value;
@@ -260,10 +293,17 @@ export class BitmapText extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get tint() {
     return this._tint;
   }
 
+  /**
+   * TBD.
+   */
   set tint(value) {
     if (value !== this._tint) {
       this._tint = value;
@@ -271,6 +311,10 @@ export class BitmapText extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   get fill() {
     if (typeof this.tint === 'number') {
       let colorStr = this.tint.toString(16);
@@ -282,14 +326,24 @@ export class BitmapText extends DisplayObject {
     return this.tint;
   }
 
+  /**
+   * TBD.
+   */
   set fill(value) {
     this.tint = typeof value === 'string' ? parseInt(value.replace('#', ''), 16) : value;
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   get font() {
     return this._font;
   }
 
+  /**
+   * TBD.
+   */
   set font(value) {
     const trimmedValue = value.trim();
     if (trimmedValue !== this._font) {
@@ -299,10 +353,17 @@ export class BitmapText extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get fontSize() {
     return this._fontSize;
   }
 
+  /**
+   * TBD.
+   */
   set fontSize(value) {
     value = parseInt(value, 10);
     if (value !== this._fontSize && value > 0) {
@@ -311,10 +372,17 @@ export class BitmapText extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   get text() {
     return this._text;
   }
 
+  /**
+   * TBD.
+   */
   set text(value) {
     const typedValue = value.toString();
     if (typedValue !== this._text) {
@@ -323,10 +391,16 @@ export class BitmapText extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   */
   get maxWidth() {
     return this._maxWidth;
   }
 
+  /**
+   * TBD.
+   */
   set maxWidth(value) {
     if (value !== this._maxWidth) {
       this._maxWidth = value;
@@ -334,10 +408,17 @@ export class BitmapText extends DisplayObject {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get smoothed() {
     return !this._data.base.scaleMode;
   }
 
+  /**
+   * TBD.
+   */
   set smoothed(value) {
     if (value) {
       this._data.base.scaleMode = SCALE_LINEAR;

package/src/phaser/display/button.js

@@ -1,11 +1,6 @@
-/**
- * @module display/button
- * @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 { Image } from './image';
-import { Signal } from  '../core/signal';
+import { Signal } from '../core/signal';
+import { Game } from '../core/game';
 import { InputHandler } from '../core/input_handler';
 import { BUTTON, POINTER_CONTACT } from '../core/const';
 
@@ -18,8 +13,7 @@ const STATE_DISABLED = 'Disabled';
 export class Button extends Image {
   /**
    * TBD.
-   *
-   * @param {object} game - TBD.
+   * @param {Game} game - TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.
@@ -71,6 +65,9 @@ export class Button extends Image {
     this.events.onInputUp.add(this.onInputUpHandler, this);
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this._onOverFrame = null;
     this._onOutFrame = null;
@@ -94,6 +91,11 @@ export class Button extends Image {
     super.destroy();
   }
 
+  /**
+   * TBD.
+   * @param {boolean} isEnabled - TBD.
+   * @param {boolean} isImmediate - TBD.
+   */
   setEnabled(isEnabled, isImmediate) {
     this.input.enabled = isEnabled;
     if (isImmediate) {
@@ -105,14 +107,26 @@ export class Button extends Image {
     }
   }
 
+  /**
+   * TBD.
+   */
   clearFrames() {
     this.setFrames(null, null, null, null);
   }
 
+  /**
+   * TBD.
+   */
   removedFromWorld() {
     this.inputEnabled = false;
   }
 
+  /**
+   * TBD.
+   * @param {string} state - TBD.
+   * @param {string} frame - TBD.
+   * @param {boolean} switchImmediately - TBD.
+   */
   setStateFrame(state, frame, switchImmediately = false) {
     const frameKey = '_on' + state + 'Frame';
     if (frame) {
@@ -125,6 +139,11 @@ export class Button extends Image {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} newState - TBD.
+   * @returns {boolean} TBD.
+   */
   changeStateFrame(newState) {
     if (this.freezeFrames) {
       return false;
@@ -142,6 +161,13 @@ export class Button extends Image {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {string} overFrame - TBD.
+   * @param {string} outFrame - TBD.
+   * @param {string} downFrame - TBD.
+   * @param {string} upFrame - TBD.
+   */
   setFrames(overFrame, outFrame, downFrame, upFrame) {
     this.setStateFrame(STATE_OVER, overFrame, this.input.pointerOver());
     this.setStateFrame(STATE_OUT, outFrame, !this.input.pointerOver());
@@ -149,11 +175,13 @@ export class Button extends Image {
     this.setStateFrame(STATE_UP, upFrame, this.input.pointerUp());
   }
 
+  /**
+   * TBD.
+   * @param {object} sprite - TBD.
+   * @param {object} pointer - TBD.
+   */
   onInputOverHandler(sprite, pointer) {
-    if (
-      pointer.justReleased() &&
-      (this.justReleasedPreventsOver & pointer.pointerMode) === pointer.pointerMode
-    ) {
+    if (pointer.justReleased() && (this.justReleasedPreventsOver & pointer.pointerMode) === pointer.pointerMode) {
       //  If the Pointer was only just released then we don't fire an over event
       return;
     }
@@ -166,6 +194,11 @@ export class Button extends Image {
     }
   }
 
+  /**
+   * TBD.
+   * @param {object} sprite - TBD.
+   * @param {object} pointer - TBD.
+   */
   onInputOutHandler(sprite, pointer) {
     this.changeStateFrame(STATE_OUT);
     if (this.onInputOut) {
@@ -173,6 +206,11 @@ export class Button extends Image {
     }
   }
 
+  /**
+   * TBD.
+   * @param {object} sprite - TBD.
+   * @param {object} pointer - TBD.
+   */
   onInputDownHandler(sprite, pointer) {
     this.changeStateFrame(STATE_DOWN);
     if (this.onInputDown) {
@@ -180,6 +218,12 @@ export class Button extends Image {
     }
   }
 
+  /**
+   * TBD.
+   * @param {object} sprite - TBD.
+   * @param {object} pointer - TBD.
+   * @param {boolean} isOver - TBD.
+   */
   onInputUpHandler(sprite, pointer, isOver) {
     if (this.onInputUp) {
       this.onInputUp.dispatch(this, pointer, isOver);
@@ -202,10 +246,17 @@ export class Button extends Image {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get inputEnabled() {
     return this.input && this.input.enabled;
   }
 
+  /**
+   * TBD.
+   */
   set inputEnabled(value) {
     if (value) {
       if (this.input === null) {

package/src/phaser/display/canvas/buffer.js

@@ -1,12 +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>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
 import { create, removeByCanvas } from './pool';
 
 export class CanvasBuffer {
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   constructor(width, height) {
     this.width = width;
     this.height = height;
@@ -16,11 +15,19 @@ export class CanvasBuffer {
     this.canvas.height = height;
   }
 
+  /**
+   * TBD.
+   */
   clear() {
     this.context.setTransform(1, 0, 0, 1, 0, 0);
     this.context.clearRect(0, 0, this.width, this.height);
   }
 
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   resize(width, height) {
     this.width = width;
     this.height = height;
@@ -28,6 +35,9 @@ export class CanvasBuffer {
     this.canvas.height = height;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     removeByCanvas(this.canvas);
   }

package/src/phaser/display/canvas/graphics.js

@@ -1,20 +1,7 @@
-/**
- * @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>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
-import {
-  GEOM_POLYGON,
-  GEOM_RECTANGLE,
-  GEOM_CIRCLE,
-  GEOM_ELLIPSE,
-  GEOM_ROUNDED_RECTANGLE,
-} from '../../core/const';
+import { GEOM_POLYGON, GEOM_RECTANGLE, GEOM_CIRCLE, GEOM_ELLIPSE, GEOM_ROUNDED_RECTANGLE } from '../../core/const';
 
 /**
  * TBD.
- *
  * @param {object} graphics - TBD.
  */
 export function updateGraphicsTint(graphics) {
@@ -41,7 +28,6 @@ export function updateGraphicsTint(graphics) {
 
 /**
  * TBD.
- *
  * @param {object} graphics - TBD.
  * @param {object} context - TBD.
  */
@@ -171,7 +157,6 @@ export function renderGraphics(graphics, context) {
 
 /**
  * TBD.
- *
  * @param {object} graphics - TBD.
  * @param {object} context - TBD.
  */

package/src/phaser/display/canvas/masker.js

@@ -1,14 +1,7 @@
-/**
- * @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>
- * @author       Mat Groves http://matgroves.com/ @Doormat23
- */
 import { renderGraphicsMask } from './graphics';
 
 /**
  * TBD.
- *
  * @param {object} maskData - TBD.
  * @param {object} renderSession - TBD.
  */
@@ -33,7 +26,6 @@ export function pushMask(maskData, renderSession) {
 
 /**
  * TBD.
- *
  * @param {object} renderSession - TBD.
  */
 export function popMask(renderSession) {