@vpmedia/phaser 1.17.0 → 1.18.0

package/src/phaser/core/tween.js

@@ -1,5 +1,7 @@
 import { Signal } from './signal';
 import { TweenData } from './tween_data';
+import { TweenManager } from './tween_manager';
+import { DisplayObject } from '../display/display_object';
 import * as MathUtils from '../util/math';
 import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './const';
 import { Game } from './game';
@@ -7,9 +9,9 @@ import { Game } from './game';
 export class Tween {
   /**
    * TBD.
-   * @param target - TBD.
+   * @param {DisplayObject} target - TBD.
    * @param {Game} game - TBD.
-   * @param manager
+   * @param {TweenManager} manager - TBD.
    */
   constructor(target, game, manager) {
     this.game = game;
@@ -39,13 +41,14 @@ export class Tween {
 
   /**
    * TBD.
-   * @param properties
-   * @param duration - TBD.
-   * @param ease - TBD.
-   * @param autoStart
-   * @param delay - TBD.
-   * @param repeat
-   * @param yoyo
+   * @param {object} properties - TBD.
+   * @param {number} duration - TBD.
+   * @param {string} ease - TBD.
+   * @param {boolean} autoStart - TBD.
+   * @param {number} delay - TBD.
+   * @param {number} repeat - TBD.
+   * @param {boolean} yoyo - TBD.
+   * @returns {Tween} TBD.
    */
   to(properties, duration = 1000, ease = 'Linear', autoStart = false, delay = 0, repeat = 0, yoyo = false) {
     if (typeof ease === 'string' && this.manager.easeMap[ease]) {
@@ -63,13 +66,14 @@ export class Tween {
 
   /**
    * TBD.
-   * @param properties
-   * @param duration - TBD.
-   * @param ease - TBD.
-   * @param autoStart
-   * @param delay - TBD.
-   * @param repeat
-   * @param yoyo
+   * @param {object} properties - TBD.
+   * @param {number} duration - TBD.
+   * @param {string} ease - TBD.
+   * @param {boolean} autoStart - TBD.
+   * @param {number} delay - TBD.
+   * @param {number} repeat - TBD.
+   * @param {boolean} yoyo - TBD.
+   * @returns {Tween} TBD.
    */
   from(properties, duration = 1000, ease = 'Linear', autoStart = false, delay = 0, repeat = 0, yoyo = false) {
     if (typeof ease === 'string' && this.manager.easeMap[ease]) {
@@ -88,7 +92,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param index - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   start(index = 0) {
     if (this.game === null || this.target === null || this.timeline.length === 0 || this.isRunning) {
@@ -122,7 +127,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param complete
+   * @param {boolean} complete - TBD.
+   * @returns {Tween} TBD.
    */
   stop(complete = false) {
     this.isRunning = false;
@@ -141,9 +147,10 @@ export class Tween {
 
   /**
    * TBD.
-   * @param property
-   * @param value
-   * @param index - TBD.
+   * @param {string} property - TBD.
+   * @param {number} value - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   updateTweenData(property, value, index = 0) {
     if (this.timeline.length === 0) {
@@ -161,8 +168,9 @@ export class Tween {
 
   /**
    * TBD.
-   * @param duration - TBD.
-   * @param index - TBD.
+   * @param {number} duration - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   delay(duration, index) {
     return this.updateTweenData('delay', duration, index);
@@ -170,9 +178,10 @@ export class Tween {
 
   /**
    * TBD.
-   * @param total
-   * @param repeatDelay
-   * @param index - TBD.
+   * @param {number} total - TBD.
+   * @param {number} repeatDelay - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   repeat(total, repeatDelay = 0, index = 0) {
     this.updateTweenData('repeatCounter', total, index);
@@ -181,8 +190,9 @@ export class Tween {
 
   /**
    * TBD.
-   * @param duration - TBD.
-   * @param index - TBD.
+   * @param {number} duration - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   repeatDelay(duration, index) {
     return this.updateTweenData('repeatDelay', duration, index);
@@ -190,9 +200,10 @@ export class Tween {
 
   /**
    * TBD.
-   * @param enable
-   * @param yoyoDelay
-   * @param index - TBD.
+   * @param {boolean} enable - TBD.
+   * @param {number} yoyoDelay - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   yoyo(enable, yoyoDelay = 0, index = 0) {
     this.updateTweenData('yoyo', enable, index);
@@ -201,8 +212,9 @@ export class Tween {
 
   /**
    * TBD.
-   * @param duration - TBD.
-   * @param index - TBD.
+   * @param {number} duration - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   yoyoDelay(duration, index) {
     return this.updateTweenData('yoyoDelay', duration, index);
@@ -210,8 +222,9 @@ export class Tween {
 
   /**
    * TBD.
-   * @param ease - TBD.
-   * @param index - TBD.
+   * @param {string|Function} ease - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   easing(ease, index) {
     if (typeof ease === 'string' && this.manager.easeMap[ease]) {
@@ -222,9 +235,10 @@ export class Tween {
 
   /**
    * TBD.
-   * @param interpolation
-   * @param context
-   * @param index - TBD.
+   * @param interpolation - TBD.
+   * @param context - TBD.
+   * @param {number} index - TBD.
+   * @returns {Tween} TBD.
    */
   interpolation(interpolation, context = MathUtils, index = 0) {
     this.updateTweenData('interpolationFunction', interpolation, index);
@@ -233,7 +247,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param total
+   * @param {number} total - TBD.
+   * @returns {Tween} TBD.
    */
   repeatAll(total = 0) {
     this.repeatCounter = total;
@@ -242,7 +257,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param {...any} args
+   * @param {...any} args - TBD.
+   * @returns {Tween} TBD.
    */
   chain(...args) {
     let i = args.length;
@@ -259,7 +275,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param value
+   * @param {boolean} value - TBD.
+   * @returns {Tween} TBD.
    */
   loop(value = true) {
     this.repeatCounter = value ? -1 : 0;
@@ -269,7 +286,8 @@ export class Tween {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param callbackContext
+   * @param {object} callbackContext - TBD.
+   * @returns {Tween} TBD.
    */
   onUpdateCallback(callback, callbackContext) {
     this._onUpdateCallback = callback;
@@ -322,7 +340,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param time
+   * @param {number} time - TBD.
+   * @returns {boolean} TBD.
    */
   update(time) {
     if (this.pendingDelete || !this.target) {
@@ -404,8 +423,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param frameRate
-   * @param data
+   * @param {number} frameRate - TBD.
+   * @param data - TBD.
    */
   generateData(frameRate = 60, data = []) {
     if (this.game === null || this.target === null) {
@@ -435,6 +454,7 @@ export class Tween {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get totalDuration() {
     let total = 0;

package/src/phaser/core/tween_data.js

@@ -4,7 +4,7 @@ import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './co
 export class TweenData {
   /**
    * TBD.
-   * @param parent
+   * @param parent - TBD.
    */
   constructor(parent) {
     this.parent = parent;
@@ -35,12 +35,13 @@ export class TweenData {
 
   /**
    * TBD.
-   * @param properties
-   * @param duration - TBD.
-   * @param ease - TBD.
-   * @param delay - TBD.
-   * @param repeat
-   * @param yoyo
+   * @param {object} properties - TBD.
+   * @param {number} duration - TBD.
+   * @param {string} ease - TBD.
+   * @param {number} delay - TBD.
+   * @param {number} repeat - TBD.
+   * @param {boolean} yoyo - TBD.
+   * @returns {TweenData} TBD.
    */
   to(properties, duration, ease, delay, repeat, yoyo) {
     this.vEnd = properties;
@@ -55,12 +56,13 @@ export class TweenData {
 
   /**
    * TBD.
-   * @param properties
-   * @param duration - TBD.
-   * @param ease - TBD.
-   * @param delay - TBD.
-   * @param repeat
-   * @param yoyo
+   * @param {object} properties - TBD.
+   * @param {number} duration - TBD.
+   * @param {string} ease - TBD.
+   * @param {number} delay - TBD.
+   * @param {number} repeat - TBD.
+   * @param {boolean} yoyo - TBD.
+   * @returns {TweenData} TBD.
    */
   from(properties, duration, ease, delay, repeat, yoyo) {
     this.vEnd = properties;
@@ -75,6 +77,7 @@ export class TweenData {
 
   /**
    * TBD.
+   * @returns {TweenData} TBD.
    */
   start() {
     this.startTime = this.game.time.time + this.delay;
@@ -106,6 +109,7 @@ export class TweenData {
 
   /**
    * TBD.
+   * @returns {TweenData} TBD.
    */
   loadValues() {
     const keys = Object.keys(this.parent.properties);
@@ -142,7 +146,8 @@ export class TweenData {
 
   /**
    * TBD.
-   * @param time
+   * @param {number} time - TBD.
+   * @returns {number} TBD.
    */
   update(time) {
     if (!this.isRunning) {
@@ -184,7 +189,8 @@ export class TweenData {
 
   /**
    * TBD.
-   * @param frameRate
+   * @param {number} frameRate - TBD.
+   * @returns {object[]} TBD.
    */
   generateData(frameRate) {
     if (this.parent.reverse) {
@@ -232,6 +238,7 @@ export class TweenData {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   repeat() {
     //  If not a yoyo and repeatCounter = 0 then we're done

package/src/phaser/core/tween_manager.js

@@ -94,6 +94,7 @@ export class TweenManager {
 
   /**
    * TBD.
+   * @returns {Tween[]} TBD.
    */
   getAll() {
     return this._tweens;
@@ -111,8 +112,8 @@ export class TweenManager {
 
   /**
    * TBD.
-   * @param obj
-   * @param children
+   * @param {object} obj - TBD.
+   * @param {object[]} children - TBD.
    */
   removeFrom(obj, children) {
     let i;
@@ -141,7 +142,7 @@ export class TweenManager {
 
   /**
    * TBD.
-   * @param tween
+   * @param {Tween} tween - TBD.
    */
   add(tween) {
     tween._manager = this;
@@ -150,7 +151,8 @@ export class TweenManager {
 
   /**
    * TBD.
-   * @param object
+   * @param {object} object - TBD.
+   * @returns {Tween} TBD.
    */
   create(object) {
     return new Tween(object, this.game, this);
@@ -158,7 +160,7 @@ export class TweenManager {
 
   /**
    * TBD.
-   * @param tween
+   * @param {Tween} tween - TBD.
    */
   remove(tween) {
     let i = this._tweens.indexOf(tween);
@@ -174,6 +176,7 @@ export class TweenManager {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   update() {
     const addTweens = this._add.length;
@@ -200,7 +203,8 @@ export class TweenManager {
 
   /**
    * TBD.
-   * @param object
+   * @param {object} object - TBD.
+   * @returns {boolean} TBD.
    */
   isTweening(object) {
     return this._tweens.some((tween) => tween.target === object);

package/src/phaser/display/bitmap_text.js

@@ -70,7 +70,7 @@ export class BitmapText extends DisplayObject {
 
   /**
    * TBD.
-   * @param text - TBD.
+   * @param {string} text - TBD.
    */
   setText(text) {
     this.text = text;
@@ -78,9 +78,9 @@ export class BitmapText extends DisplayObject {
 
   /**
    * TBD.
-   * @param data - TBD.
-   * @param scale - TBD.
-   * @param text - TBD.
+   * @param {object} data - TBD.
+   * @param {number} scale - TBD.
+   * @param {string} text - TBD.
    * @returns {object} TBD.
    */
   scanLine(data, scale, text) {
@@ -146,8 +146,8 @@ export class BitmapText extends DisplayObject {
 
   /**
    * TBD.
-   * @param text - TBD.
-   * @param replace - TBD.
+   * @param {string} text - TBD.
+   * @param {string} replace - TBD.
    * @returns {string} TBD.
    */
   cleanText(text, replace = '') {
@@ -393,6 +393,7 @@ export class BitmapText extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get maxWidth() {
     return this._maxWidth;

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

@@ -91,7 +91,7 @@ export function getFree() {
  * @param {object} parent - TBD.
  * @param {number} width - TBD.
  * @param {number} height - TBD.
- * @returns {object} TBD.
+ * @returns {HTMLCanvasElement} TBD.
  */
 export function create(parent, width, height) {
   if (parent === undefined) {

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

@@ -37,6 +37,7 @@ export class CanvasRenderer {
     this.clearBeforeRender = game.config.clearBeforeRender;
     this.transparent = game.config.transparent;
     this.autoResize = false;
+    this.contextLost = false;
     this.width = game.width * this.resolution;
     this.height = game.height * this.resolution;
     this.view = game.canvas;
@@ -59,7 +60,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param root
+   * @param root - TBD.
    */
   render(root) {
     if (!this.context) {
@@ -84,7 +85,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param removeView
+   * @param removeView - TBD.
    */
   destroy(removeView = true) {
     if (removeView && this.view.parent) {
@@ -116,8 +117,8 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param displayObject
-   * @param context
+   * @param displayObject - TBD.
+   * @param context - TBD.
    * @param matrix - TBD.
    */
   renderDisplayObject(displayObject, context, matrix) {

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

@@ -40,7 +40,7 @@ export function setBackgroundColor(canvas, color) {
  * @param {string} value - TBD.
  * @returns {object} TBD.
  */
-export function setTouchAction(canvas, value) {
+export function setTouchAction(canvas, value = 'none') {
   value = value || 'none';
   canvas.style.msTouchAction = value;
   canvas.style['ms-touch-action'] = value;
@@ -54,7 +54,7 @@ export function setTouchAction(canvas, value) {
  * @param {string} value - TBD.
  * @returns {object} TBD.
  */
-export function setUserSelect(canvas, value) {
+export function setUserSelect(canvas, value = 'none') {
   value = value || 'none';
   canvas.style['-webkit-touch-callout'] = value;
   canvas.style['-webkit-user-select'] = value;

package/src/phaser/display/display_object.js

@@ -72,7 +72,8 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param child - TBD.
+   * @param {DisplayObject} child - TBD.
+   * @returns {DisplayObject} TBD.
    */
   addChild(child) {
     return this.addChildAt(child, this.children.length);
@@ -80,8 +81,10 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param child - TBD.
+   * @param {DisplayObject} child - TBD.
    * @param {number} index - TBD.
+   * @returns {DisplayObject} TBD.
+   * @throws Error.
    */
   addChildAt(child, index) {
     if (index >= 0 && index <= this.children.length) {
@@ -97,8 +100,9 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param child - TBD.
-   * @param child2 - TBD.
+   * @param {DisplayObject} child - TBD.
+   * @param {DisplayObject} child2 - TBD.
+   * @throws Error.
    */
   swapChildren(child, child2) {
     if (child === child2) {
@@ -115,7 +119,9 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param child - TBD.
+   * @param {DisplayObject} child - TBD.
+   * @returns {number} TBD.
+   * @throws Error.
    */
   getChildIndex(child) {
     const index = this.children.indexOf(child);
@@ -127,8 +133,9 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param child - TBD.
+   * @param {DisplayObject} child - TBD.
    * @param {number} index - TBD.
+   * @throws Error.
    */
   setChildIndex(child, index) {
     if (index < 0 || index >= this.children.length) {
@@ -142,6 +149,8 @@ export class DisplayObject {
   /**
    * TBD.
    * @param {number} index - TBD.
+   * @returns {DisplayObject} TBD.
+   * @throws Error.
    */
   getChildAt(index) {
     if (index < 0 || index >= this.children.length) {
@@ -156,7 +165,8 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param child - TBD.
+   * @param {DisplayObject} child - TBD.
+   * @returns {DisplayObject} TBD.
    */
   removeChild(child) {
     const index = this.children.indexOf(child);
@@ -169,6 +179,7 @@ export class DisplayObject {
   /**
    * TBD.
    * @param {number} index - TBD.
+   * @returns {DisplayObject} TBD.
    */
   removeChildAt(index) {
     const child = this.getChildAt(index);
@@ -183,6 +194,8 @@ export class DisplayObject {
    * TBD.
    * @param {number} beginIndex - TBD.
    * @param {number} endIndex - TBD.
+   * @returns {DisplayObject[]} TBD.
+   * @throws Error.
    */
   removeChildren(beginIndex, endIndex) {
     if (beginIndex === undefined) {
@@ -208,7 +221,8 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param parent - TBD.
+   * @param {DisplayObject} parent - TBD.
+   * @returns {DisplayObject} TBD.
    */
   updateTransform(parent) {
     if (!parent && !this.parent) {
@@ -295,7 +309,8 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param targetCoordinateSpace - TBD.
+   * @param {DisplayObject} targetCoordinateSpace - TBD.
+   * @returns {Rectangle} TBD.
    */
   getBounds(targetCoordinateSpace) {
     const isTargetCoordinateSpaceDisplayObject = targetCoordinateSpace && targetCoordinateSpace.contains !== undefined;
@@ -404,7 +419,7 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param child - TBD.
+   * @param {DisplayObject} child - TBD.
    * @returns {boolean} TBD.
    */
   contains(child) {
@@ -419,7 +434,7 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderWebGL(renderSession) {
     if (!this.visible || this.alpha <= 0) {
@@ -453,7 +468,7 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderCanvas(renderSession) {
     if (!this.visible || this.alpha <= 0) {
@@ -501,7 +516,8 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param position - TBD.
+   * @param {Point} position - TBD.
+   * @returns {Point} TBD.
    */
   toGlobal(position) {
     this.updateTransform();
@@ -510,8 +526,9 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param position - TBD.
-   * @param from - TBD.
+   * @param {Point} position - TBD.
+   * @param {DisplayObject} from - TBD.
+   * @returns {Point} TBD.
    */
   toLocal(position, from) {
     if (from) {
@@ -523,7 +540,7 @@ export class DisplayObject {
 
   /**
    * TBD.
-   * @param renderSession - TBD.
+   * @param {object} renderSession - TBD.
    */
   renderCachedSprite(renderSession) {
     if (!this._cachedSprite) {