@vpmedia/phaser 1.11.0 → 1.13.0

package/src/phaser/core/tween_easing.js

@@ -1,13 +1,13 @@
 /**
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function LinearNone(k) {
   return k;
@@ -15,8 +15,8 @@ export function LinearNone(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuadraticIn(k) {
   return k * k;
@@ -24,8 +24,8 @@ export function QuadraticIn(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuadraticOut(k) {
   return k * (2 - k);
@@ -33,8 +33,8 @@ export function QuadraticOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuadraticInOut(k) {
   if ((k *= 2) < 1) return 0.5 * k * k;
@@ -43,8 +43,8 @@ export function QuadraticInOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CubicIn(k) {
   return k * k * k;
@@ -52,8 +52,8 @@ export function CubicIn(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CubicOut(k) {
   return --k * k * k + 1;
@@ -61,8 +61,8 @@ export function CubicOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CubicInOut(k) {
   if ((k *= 2) < 1) return 0.5 * k * k * k;
@@ -71,8 +71,8 @@ export function CubicInOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuarticIn(k) {
   return k * k * k * k;
@@ -80,17 +80,17 @@ export function QuarticIn(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuarticOut(k) {
-  return 1 - (--k * k * k * k);
+  return 1 - --k * k * k * k;
 }
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuarticInOut(k) {
   if ((k *= 2) < 1) return 0.5 * k * k * k * k;
@@ -99,8 +99,8 @@ export function QuarticInOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuinticIn(k) {
   return k * k * k * k * k;
@@ -108,8 +108,8 @@ export function QuinticIn(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuinticOut(k) {
   return --k * k * k * k * k + 1;
@@ -117,8 +117,8 @@ export function QuinticOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuinticInOut(k) {
   if ((k *= 2) < 1) return 0.5 * k * k * k * k * k;
@@ -127,30 +127,30 @@ export function QuinticInOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function SinusoidalIn(k) {
   if (k === 0) return 0;
   if (k === 1) return 1;
-  return 1 - Math.cos(k * Math.PI / 2);
+  return 1 - Math.cos((k * Math.PI) / 2);
 }
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function SinusoidalOut(k) {
   if (k === 0) return 0;
   if (k === 1) return 1;
-  return Math.sin(k * Math.PI / 2);
+  return Math.sin((k * Math.PI) / 2);
 }
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function SinusoidalInOut(k) {
   if (k === 0) return 0;
@@ -160,8 +160,8 @@ export function SinusoidalInOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ExponentialIn(k) {
   return k === 0 ? 0 : Math.pow(1024, k - 1);
@@ -169,8 +169,8 @@ export function ExponentialIn(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ExponentialOut(k) {
   return k === 1 ? 1 : 1 - Math.pow(2, -10 * k);
@@ -178,8 +178,8 @@ export function ExponentialOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ExponentialInOut(k) {
   if (k === 0) return 0;
@@ -190,8 +190,8 @@ export function ExponentialInOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CircularIn(k) {
   return 1 - Math.sqrt(1 - k * k);
@@ -199,17 +199,17 @@ export function CircularIn(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CircularOut(k) {
-  return Math.sqrt(1 - (--k * k));
+  return Math.sqrt(1 - --k * k);
 }
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CircularInOut(k) {
   if ((k *= 2) < 1) return -0.5 * (Math.sqrt(1 - k * k) - 1);
@@ -218,8 +218,8 @@ export function CircularInOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ElasticIn(k) {
   let s;
@@ -228,17 +228,18 @@ export function ElasticIn(k) {
   if (k === 0) return 0;
   if (k === 1) return 1;
   if (!a || a < 1) {
-    a = 1; s = p / 4;
+    a = 1;
+    s = p / 4;
   } else {
-    s = p * Math.asin(1 / a) / (2 * Math.PI);
+    s = (p * Math.asin(1 / a)) / (2 * Math.PI);
   }
-  return -(a * Math.pow(2, 10 * (k -= 1)) * Math.sin((k - s) * (2 * Math.PI) / p));
+  return -(a * Math.pow(2, 10 * (k -= 1)) * Math.sin(((k - s) * (2 * Math.PI)) / p));
 }
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ElasticOut(k) {
   let s;
@@ -247,17 +248,18 @@ export function ElasticOut(k) {
   if (k === 0) return 0;
   if (k === 1) return 1;
   if (!a || a < 1) {
-    a = 1; s = p / 4;
+    a = 1;
+    s = p / 4;
   } else {
-    s = p * Math.asin(1 / a) / (2 * Math.PI);
+    s = (p * Math.asin(1 / a)) / (2 * Math.PI);
   }
-  return (a * Math.pow(2, -10 * k) * Math.sin((k - s) * (2 * Math.PI) / p) + 1);
+  return a * Math.pow(2, -10 * k) * Math.sin(((k - s) * (2 * Math.PI)) / p) + 1;
 }
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ElasticInOut(k) {
   let s;
@@ -266,18 +268,20 @@ export function ElasticInOut(k) {
   if (k === 0) return 0;
   if (k === 1) return 1;
   if (!a || a < 1) {
-    a = 1; s = p / 4;
+    a = 1;
+    s = p / 4;
   } else {
-    s = p * Math.asin(1 / a) / (2 * Math.PI);
+    s = (p * Math.asin(1 / a)) / (2 * Math.PI);
   }
-  if ((k *= 2) < 1) return -0.5 * (a * Math.pow(2, 10 * (k -= 1)) * Math.sin((k - s) * (2 * Math.PI) / p));
-  return a * Math.pow(2, -10 * (k -= 1)) * Math.sin((k - s) * (2 * Math.PI) / p) * 0.5 + 1;
+  if ((k *= 2) < 1)
+    return -0.5 * (a * Math.pow(2, 10 * (k -= 1)) * Math.sin(((k - s) * (2 * Math.PI)) / p));
+  return a * Math.pow(2, -10 * (k -= 1)) * Math.sin(((k - s) * (2 * Math.PI)) / p) * 0.5 + 1;
 }
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BackIn(k) {
   const s = 1.70158;
@@ -286,8 +290,8 @@ export function BackIn(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BackOut(k) {
   const s = 1.70158;
@@ -296,8 +300,8 @@ export function BackOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BackInOut(k) {
   const s = 1.70158 * 1.525;
@@ -307,24 +311,24 @@ export function BackInOut(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BounceOut(k) {
-  if (k < (1 / 2.75)) {
+  if (k < 1 / 2.75) {
     return 7.5625 * k * k;
-  } else if (k < (2 / 2.75)) {
-    return 7.5625 * (k -= (1.5 / 2.75)) * k + 0.75;
-  } else if (k < (2.5 / 2.75)) {
-    return 7.5625 * (k -= (2.25 / 2.75)) * k + 0.9375;
+  } else if (k < 2 / 2.75) {
+    return 7.5625 * (k -= 1.5 / 2.75) * k + 0.75;
+  } else if (k < 2.5 / 2.75) {
+    return 7.5625 * (k -= 2.25 / 2.75) * k + 0.9375;
   }
-  return 7.5625 * (k -= (2.625 / 2.75)) * k + 0.984375;
+  return 7.5625 * (k -= 2.625 / 2.75) * k + 0.984375;
 }
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BounceIn(k) {
   return 1 - BounceOut(1 - k);
@@ -332,8 +336,8 @@ export function BounceIn(k) {
 
 /**
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BounceInOut(k) {
   if (k < 0.5) return BounceIn(k * 2) * 0.5;

package/src/phaser/core/tween_manager.js

@@ -1,26 +1,45 @@
 /**
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Tween from './tween';
+import { Tween } from './tween';
 import {
   LinearNone,
-  QuadraticIn, QuadraticOut, QuadraticInOut,
-  CubicIn, CubicOut, CubicInOut,
-  QuarticIn, QuarticOut, QuarticInOut,
-  QuinticIn, QuinticOut, QuinticInOut,
-  SinusoidalIn, SinusoidalOut, SinusoidalInOut,
-  ExponentialIn, ExponentialOut, ExponentialInOut,
-  CircularIn, CircularOut, CircularInOut,
-  ElasticIn, ElasticOut, ElasticInOut,
-  BackIn, BackOut, BackInOut,
-  BounceIn, BounceOut, BounceInOut,
+  QuadraticIn,
+  QuadraticOut,
+  QuadraticInOut,
+  CubicIn,
+  CubicOut,
+  CubicInOut,
+  QuarticIn,
+  QuarticOut,
+  QuarticInOut,
+  QuinticIn,
+  QuinticOut,
+  QuinticInOut,
+  SinusoidalIn,
+  SinusoidalOut,
+  SinusoidalInOut,
+  ExponentialIn,
+  ExponentialOut,
+  ExponentialInOut,
+  CircularIn,
+  CircularOut,
+  CircularInOut,
+  ElasticIn,
+  ElasticOut,
+  ElasticInOut,
+  BackIn,
+  BackOut,
+  BackInOut,
+  BounceIn,
+  BounceOut,
+  BounceInOut,
 } from './tween_easing';
 import { GROUP } from './const';
 
-export default class {
-
+export class TweenManager {
   constructor(game) {
     this.game = game;
     this._tweens = [];
@@ -154,7 +173,7 @@ export default class {
   }
 
   isTweening(object) {
-    return this._tweens.some(tween => tween.target === object);
+    return this._tweens.some((tween) => tween.target === object);
   }
 
   _pauseAll() {
@@ -180,5 +199,4 @@ export default class {
       this._tweens[i].resume(true);
     }
   }
-
 }

package/src/phaser/core/world.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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Group from '../display/group';
-
-export default class extends Group {
+import { Group } from  '../display/group';
 
+export class World extends Group {
   constructor(game) {
     super(game, null, '__world', false);
   }
@@ -14,5 +13,4 @@ export default class extends Group {
   boot() {
     this.game.stage.addChild(this);
   }
-
 }

package/src/phaser/display/bitmap_text.js

@@ -1,15 +1,26 @@
 /**
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import DisplayObject from './display_object';
-import Image from './image';
-import Point from '../geom/point';
+import { DisplayObject } from  './display_object';
+import { Image } from './image';
+import { Point } from '../geom/point';
 import { BITMAP_TEXT, SCALE_LINEAR, SCALE_NEAREST } from '../core/const';
 
-export default class extends DisplayObject {
-
+export class BitmapText extends DisplayObject {
+  /**
+   * TBD.
+   *
+   * @param {object} game - TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {string} font - TBD.
+   * @param {string} text - TBD.
+   * @param {number} size - TBD.
+   * @param {string} align - TBD.
+   */
   constructor(game, x = 0, y = 0, font = '', text = '', size = 32, align = 'left') {
     super();
     this.game = game;
@@ -25,7 +36,7 @@ export default class extends DisplayObject {
     this._font = font;
     this._fontSize = size;
     this._align = align;
-    this._tint = 0xFFFFFF;
+    this._tint = 0xffffff;
     this.updateText();
     this.dirty = false;
   }
@@ -67,7 +78,7 @@ export default class extends DisplayObject {
     let lastSpace = -1;
     let wrappedWidth = 0;
     let prevCharCode = null;
-    const maxWidth = (this._maxWidth > 0) ? this._maxWidth : null;
+    const maxWidth = this._maxWidth > 0 ? this._maxWidth : null;
     const chars = [];
     //  Let's scan the text and work out if any of the lines are > maxWidth
     let end = true;
@@ -91,7 +102,8 @@ export default class 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;
@@ -100,7 +112,7 @@ export default class extends DisplayObject {
       //  What will the line width be if we add this character to it?
       c = (kerning + charData.texture.width + charData.xOffset) * scale;
       //  Do we need to line-wrap?
-      if (maxWidth && ((w + c) >= maxWidth) && lastSpace > -1) {
+      if (maxWidth && w + c >= maxWidth && lastSpace > -1) {
         //  The last space was at "lastSpace" which was "i - lastSpace" characters ago
         return {
           width: wrappedWidth || w,
@@ -162,7 +174,7 @@ export default class extends DisplayObject {
       if (line.width > this.textWidth) {
         this.textWidth = line.width;
       }
-      y += (data.lineHeight * scale);
+      y += data.lineHeight * scale;
       text = text.substr(line.text.length + 1);
     } while (line.end === false);
     this.textHeight = y;
@@ -194,8 +206,8 @@ export default class extends DisplayObject {
           g.name = currentLine.text[c];
           this._glyphs.push(g);
         }
-        g.position.x = (currentLine.chars[c] + align) - ax;
-        g.position.y = (currentLine.y + (charData.yOffset * scale)) - ay;
+        g.position.x = currentLine.chars[c] + align - ax;
+        g.position.y = currentLine.y + charData.yOffset * scale - ay;
         g.scale.set(scale);
         g.tint = this.tint;
         g.texture.requiresReTint = true;
@@ -333,5 +345,4 @@ export default class extends DisplayObject {
       this._data.base.scaleMode = SCALE_NEAREST;
     }
   }
-
 }

package/src/phaser/display/button.js

@@ -1,10 +1,11 @@
 /**
+ * @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>
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
-import Image from './image';
-import Signal from '../core/signal';
+import { Image } from './image';
+import { Signal } from  '../core/signal';
 import InputHandler from '../core/input_handler';
 import { BUTTON, POINTER_CONTACT } from '../core/const';
 
@@ -14,9 +15,33 @@ const STATE_DOWN = 'Down';
 const STATE_UP = 'Up';
 const STATE_DISABLED = 'Disabled';
 
-export default class extends Image {
-
-  constructor(game, x = 0, y = 0, key = null, callback = null, callbackContext = null, overFrame = null, outFrame = null, downFrame = null, upFrame = null) {
+export class Button extends Image {
+  /**
+   * TBD.
+   *
+   * @param {object} game - TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   * @param {string} key - TBD.
+   * @param {Function} callback - TBD.
+   * @param {object} callbackContext - TBD.
+   * @param {string} overFrame - TBD.
+   * @param {string} outFrame - TBD.
+   * @param {string} downFrame - TBD.
+   * @param {string} upFrame - TBD.
+   */
+  constructor(
+    game,
+    x = 0,
+    y = 0,
+    key = null,
+    callback = null,
+    callbackContext = null,
+    overFrame = null,
+    outFrame = null,
+    downFrame = null,
+    upFrame = null
+  ) {
     super(game, x, y, key, outFrame);
     this.type = BUTTON;
     this._onOverFrame = null;
@@ -125,7 +150,10 @@ export default class extends Image {
   }
 
   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;
     }
@@ -190,5 +218,4 @@ export default class extends Image {
       this.input.stop();
     }
   }
-
 }

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

@@ -1,13 +1,12 @@
 /**
+ * @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
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
  */
 import { create, removeByCanvas } from './pool';
 
 export default class {
-
   constructor(width, height) {
     this.width = width;
     this.height = height;
@@ -32,5 +31,4 @@ export default class {
   destroy() {
     removeByCanvas(this.canvas);
   }
-
 }