@vpmedia/phaser 1.12.0 → 1.14.0

package/src/phaser/core/tween_easing.js

@@ -1,40 +1,44 @@
 /**
+ * @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)
  */
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function LinearNone(k) {
   return k;
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuadraticIn(k) {
   return k * k;
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuadraticOut(k) {
   return k * (2 - k);
 }
 
 /**
+ * TBD.
  *
- * @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;
@@ -42,27 +46,30 @@ export function QuadraticInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CubicIn(k) {
   return k * k * k;
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CubicOut(k) {
   return --k * k * k + 1;
 }
 
 /**
+ * TBD.
  *
- * @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;
@@ -70,27 +77,30 @@ export function CubicInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuarticIn(k) {
   return k * k * k * k;
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuarticOut(k) {
   return 1 - --k * k * k * k;
 }
 
 /**
+ * TBD.
  *
- * @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;
@@ -98,27 +108,30 @@ export function QuarticInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function QuinticIn(k) {
   return k * k * k * k * k;
 }
 
 /**
+ * TBD.
  *
- * @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;
 }
 
 /**
+ * TBD.
  *
- * @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;
@@ -126,9 +139,10 @@ export function QuinticInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function SinusoidalIn(k) {
   if (k === 0) return 0;
@@ -137,9 +151,10 @@ export function SinusoidalIn(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function SinusoidalOut(k) {
   if (k === 0) return 0;
@@ -148,9 +163,10 @@ export function SinusoidalOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function SinusoidalInOut(k) {
   if (k === 0) return 0;
@@ -159,27 +175,30 @@ export function SinusoidalInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @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);
 }
 
 /**
+ * TBD.
  *
- * @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);
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ExponentialInOut(k) {
   if (k === 0) return 0;
@@ -189,27 +208,30 @@ export function ExponentialInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @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);
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function CircularOut(k) {
   return Math.sqrt(1 - --k * k);
 }
 
 /**
+ * TBD.
  *
- * @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);
@@ -217,9 +239,10 @@ export function CircularInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ElasticIn(k) {
   let s;
@@ -237,9 +260,10 @@ export function ElasticIn(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ElasticOut(k) {
   let s;
@@ -257,9 +281,10 @@ export function ElasticOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function ElasticInOut(k) {
   let s;
@@ -279,9 +304,10 @@ export function ElasticInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BackIn(k) {
   const s = 1.70158;
@@ -289,9 +315,10 @@ export function BackIn(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BackOut(k) {
   const s = 1.70158;
@@ -299,9 +326,10 @@ export function BackOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BackInOut(k) {
   const s = 1.70158 * 1.525;
@@ -310,9 +338,10 @@ export function BackInOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BounceOut(k) {
   if (k < 1 / 2.75) {
@@ -326,18 +355,20 @@ export function BounceOut(k) {
 }
 
 /**
+ * TBD.
  *
- * @param {number} k TBD
- * @returns {number} TBD
+ * @param {number} k - TBD.
+ * @returns {number} TBD.
  */
 export function BounceIn(k) {
   return 1 - BounceOut(1 - k);
 }
 
 /**
+ * TBD.
  *
- * @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,9 +1,9 @@
 /**
+ * @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,
@@ -39,7 +39,7 @@ import {
 } from './tween_easing';
 import { GROUP } from './const';
 
-export default class {
+export class TweenManager {
   constructor(game) {
     this.game = game;
     this._tweens = [];

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

package/src/phaser/display/bitmap_text.js

@@ -1,14 +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;

package/src/phaser/display/button.js

@@ -1,11 +1,12 @@
 /**
+ * @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 InputHandler from '../core/input_handler';
+import { Image } from './image';
+import { Signal } from  '../core/signal';
+import { InputHandler } from '../core/input_handler';
 import { BUTTON, POINTER_CONTACT } from '../core/const';
 
 const STATE_OVER = 'Over';
@@ -14,7 +15,21 @@ const STATE_DOWN = 'Down';
 const STATE_UP = 'Up';
 const STATE_DISABLED = 'Disabled';
 
-export default class extends Image {
+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,

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

@@ -1,12 +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 {
+export class CanvasBuffer {
   constructor(width, height) {
     this.width = width;
     this.height = height;

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

@@ -1,8 +1,8 @@
 /**
+ * @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 {
   GEOM_POLYGON,
@@ -13,8 +13,9 @@ import {
 } from '../../core/const';
 
 /**
+ * TBD.
  *
- * @param {object} graphics TBD
+ * @param {object} graphics - TBD.
  */
 export function updateGraphicsTint(graphics) {
   if (graphics.tint === 0xffffff) {
@@ -39,9 +40,10 @@ export function updateGraphicsTint(graphics) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} graphics TBD
- * @param {object} context TBD
+ * @param {object} graphics - TBD.
+ * @param {object} context - TBD.
  */
 export function renderGraphics(graphics, context) {
   const worldAlpha = graphics.worldAlpha;
@@ -168,9 +170,10 @@ export function renderGraphics(graphics, context) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} graphics TBD
- * @param {object} context TBD
+ * @param {object} graphics - TBD.
+ * @param {object} context - TBD.
  */
 export function renderGraphicsMask(graphics, context) {
   const len = graphics.graphicsData.length;

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

@@ -1,15 +1,16 @@
 /**
+ * @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 { renderGraphicsMask } from './graphics';
 
 /**
+ * TBD.
  *
- * @param {object} maskData TBD
- * @param {object} renderSession TBD
+ * @param {object} maskData - TBD.
+ * @param {object} renderSession - TBD.
  */
 export function pushMask(maskData, renderSession) {
   const context = renderSession.context;
@@ -31,8 +32,9 @@ export function pushMask(maskData, renderSession) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} renderSession TBD
+ * @param {object} renderSession - TBD.
  */
 export function popMask(renderSession) {
   renderSession.context.restore();

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

@@ -1,13 +1,14 @@
 /**
+ * @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)
  */
 
 /**
+ * TBD.
  *
- * @returns {object} TBD
+ * @returns {object[]} TBD.
  */
 export function getPool() {
   if (!window.PhaserRegistry) {
@@ -20,8 +21,9 @@ export function getPool() {
 }
 
 /**
+ * TBD.
  *
- * @returns {object} TBD
+ * @returns {object} TBD.
  */
 export function getFirst() {
   const pool = getPool();
@@ -34,8 +36,9 @@ export function getFirst() {
 }
 
 /**
+ * TBD.
  *
- * @param {object} parent TBD
+ * @param {object} parent - TBD.
  */
 export function remove(parent) {
   const pool = getPool();
@@ -49,8 +52,9 @@ export function remove(parent) {
 }
 
 /**
+ * TBD.
  *
- * @param {object} canvas TBD
+ * @param {HTMLCanvasElement} canvas - TBD.
  */
 export function removeByCanvas(canvas) {
   const pool = getPool();
@@ -64,8 +68,9 @@ export function removeByCanvas(canvas) {
 }
 
 /**
+ * TBD.
  *
- * @returns {number} TBD
+ * @returns {number} TBD.
  */
 export function getTotal() {
   const pool = getPool();
@@ -79,8 +84,9 @@ export function getTotal() {
 }
 
 /**
+ * TBD.
  *
- * @returns {number} TBD
+ * @returns {number} TBD.
  */
 export function getFree() {
   const pool = getPool();
@@ -94,11 +100,12 @@ export function getFree() {
 }
 
 /**
+ * TBD.
  *
- * @param {object} parent TBD
- * @param {number} width TBD
- * @param {number} height TBD
- * @returns {object} TBD
+ * @param {object} parent - TBD.
+ * @param {number} width - TBD.
+ * @param {number} height - TBD.
+ * @returns {object} TBD.
  */
 export function create(parent, width, height) {
   if (parent === undefined) {

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

@@ -1,8 +1,8 @@
 /**
+ * @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 {
   RENDER_CANVAS,
@@ -30,7 +30,7 @@ import { getSmoothingPrefix } from './util';
 import { detectCapabilities } from './tinter';
 import * as CanvasMaskManager from './masker';
 
-export default class {
+export class CanvasRenderer {
   constructor(game) {
     detectCapabilities();
     this.type = RENDER_CANVAS;