@vpmedia/phaser 1.14.0 → 1.16.0

package/src/phaser/core/tween.js

@@ -1,14 +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>
- */
-import { Signal } from  './signal';
+import { Signal } from './signal';
 import { TweenData } from './tween_data';
 import * as MathUtils from '../util/math';
 import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './const';
+import { Game } from './game';
 
 export class Tween {
+  /**
+   * TBD.
+   * @param target - TBD.
+   * @param {Game} game - TBD.
+   * @param manager
+   */
   constructor(target, game, manager) {
     this.game = game;
     this.target = target;
@@ -35,15 +37,17 @@ export class Tween {
     this._hasStarted = false;
   }
 
-  to(
-    properties,
-    duration = 1000,
-    ease = 'Linear',
-    autoStart = false,
-    delay = 0,
-    repeat = 0,
-    yoyo = false
-  ) {
+  /**
+   * TBD.
+   * @param properties
+   * @param duration - TBD.
+   * @param ease - TBD.
+   * @param autoStart
+   * @param delay - TBD.
+   * @param repeat
+   * @param yoyo
+   */
+  to(properties, duration = 1000, ease = 'Linear', autoStart = false, delay = 0, repeat = 0, yoyo = false) {
     if (typeof ease === 'string' && this.manager.easeMap[ease]) {
       ease = this.manager.easeMap[ease];
     }
@@ -57,15 +61,17 @@ export class Tween {
     return this;
   }
 
-  from(
-    properties,
-    duration = 1000,
-    ease = 'Linear',
-    autoStart = false,
-    delay = 0,
-    repeat = 0,
-    yoyo = false
-  ) {
+  /**
+   * TBD.
+   * @param properties
+   * @param duration - TBD.
+   * @param ease - TBD.
+   * @param autoStart
+   * @param delay - TBD.
+   * @param repeat
+   * @param yoyo
+   */
+  from(properties, duration = 1000, ease = 'Linear', autoStart = false, delay = 0, repeat = 0, yoyo = false) {
     if (typeof ease === 'string' && this.manager.easeMap[ease]) {
       ease = this.manager.easeMap[ease];
     }
@@ -80,13 +86,12 @@ export class Tween {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param index - TBD.
+   */
   start(index = 0) {
-    if (
-      this.game === null ||
-      this.target === null ||
-      this.timeline.length === 0 ||
-      this.isRunning
-    ) {
+    if (this.game === null || this.target === null || this.timeline.length === 0 || this.isRunning) {
       return this;
     }
     //  Populate the tween data
@@ -115,6 +120,10 @@ export class Tween {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param complete
+   */
   stop(complete = false) {
     this.isRunning = false;
     this._onUpdateCallback = null;
@@ -130,6 +139,12 @@ export class Tween {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param property
+   * @param value
+   * @param index - TBD.
+   */
   updateTweenData(property, value, index = 0) {
     if (this.timeline.length === 0) {
       return this;
@@ -144,28 +159,60 @@ export class Tween {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param duration - TBD.
+   * @param index - TBD.
+   */
   delay(duration, index) {
     return this.updateTweenData('delay', duration, index);
   }
 
+  /**
+   * TBD.
+   * @param total
+   * @param repeatDelay
+   * @param index - TBD.
+   */
   repeat(total, repeatDelay = 0, index = 0) {
     this.updateTweenData('repeatCounter', total, index);
     return this.updateTweenData('repeatDelay', repeatDelay, index);
   }
 
+  /**
+   * TBD.
+   * @param duration - TBD.
+   * @param index - TBD.
+   */
   repeatDelay(duration, index) {
     return this.updateTweenData('repeatDelay', duration, index);
   }
 
+  /**
+   * TBD.
+   * @param enable
+   * @param yoyoDelay
+   * @param index - TBD.
+   */
   yoyo(enable, yoyoDelay = 0, index = 0) {
     this.updateTweenData('yoyo', enable, index);
     return this.updateTweenData('yoyoDelay', yoyoDelay, index);
   }
 
+  /**
+   * TBD.
+   * @param duration - TBD.
+   * @param index - TBD.
+   */
   yoyoDelay(duration, index) {
     return this.updateTweenData('yoyoDelay', duration, index);
   }
 
+  /**
+   * TBD.
+   * @param ease - TBD.
+   * @param index - TBD.
+   */
   easing(ease, index) {
     if (typeof ease === 'string' && this.manager.easeMap[ease]) {
       ease = this.manager.easeMap[ease];
@@ -173,16 +220,30 @@ export class Tween {
     return this.updateTweenData('easingFunction', ease, index);
   }
 
+  /**
+   * TBD.
+   * @param interpolation
+   * @param context
+   * @param index - TBD.
+   */
   interpolation(interpolation, context = MathUtils, index = 0) {
     this.updateTweenData('interpolationFunction', interpolation, index);
     return this.updateTweenData('interpolationContext', context, index);
   }
 
+  /**
+   * TBD.
+   * @param total
+   */
   repeatAll(total = 0) {
     this.repeatCounter = total;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args
+   */
   chain(...args) {
     let i = args.length;
     while (i) {
@@ -196,23 +257,38 @@ export class Tween {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param value
+   */
   loop(value = true) {
     this.repeatCounter = value ? -1 : 0;
     return this;
   }
 
+  /**
+   * TBD.
+   * @param callback - TBD.
+   * @param callbackContext
+   */
   onUpdateCallback(callback, callbackContext) {
     this._onUpdateCallback = callback;
     this._onUpdateCallbackContext = callbackContext;
     return this;
   }
 
+  /**
+   * TBD.
+   */
   pause() {
     this.isPaused = true;
     this._codePaused = true;
     this._pausedTime = this.game.time.time;
   }
 
+  /**
+   * TBD.
+   */
   _pause() {
     if (!this._codePaused) {
       this.isPaused = true;
@@ -220,6 +296,9 @@ export class Tween {
     }
   }
 
+  /**
+   * TBD.
+   */
   resume() {
     if (this.isPaused) {
       this.isPaused = false;
@@ -232,12 +311,19 @@ export class Tween {
     }
   }
 
+  /**
+   * TBD.
+   */
   _resume() {
     if (!this._codePaused) {
       this.resume();
     }
   }
 
+  /**
+   * TBD.
+   * @param time
+   */
   update(time) {
     if (this.pendingDelete || !this.target) {
       return false;
@@ -316,6 +402,11 @@ export class Tween {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param frameRate
+   * @param data
+   */
   generateData(frameRate = 60, data = []) {
     if (this.game === null || this.target === null) {
       return null;
@@ -342,6 +433,9 @@ export class Tween {
     return data;
   }
 
+  /**
+   * TBD.
+   */
   get totalDuration() {
     let total = 0;
     for (let i = 0; i < this.timeline.length; i += 1) {

package/src/phaser/core/tween_data.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>
- */
 import * as MathUtils from '../util/math';
 import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './const';
 
 export class TweenData {
+  /**
+   * TBD.
+   * @param parent
+   */
   constructor(parent) {
     this.parent = parent;
     this.game = parent.game;
@@ -34,6 +33,15 @@ export class TweenData {
     this.isFrom = false;
   }
 
+  /**
+   * TBD.
+   * @param properties
+   * @param duration - TBD.
+   * @param ease - TBD.
+   * @param delay - TBD.
+   * @param repeat
+   * @param yoyo
+   */
   to(properties, duration, ease, delay, repeat, yoyo) {
     this.vEnd = properties;
     this.duration = duration;
@@ -45,6 +53,15 @@ export class TweenData {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param properties
+   * @param duration - TBD.
+   * @param ease - TBD.
+   * @param delay - TBD.
+   * @param repeat
+   * @param yoyo
+   */
   from(properties, duration, ease, delay, repeat, yoyo) {
     this.vEnd = properties;
     this.duration = duration;
@@ -56,6 +73,9 @@ export class TweenData {
     return this;
   }
 
+  /**
+   * TBD.
+   */
   start() {
     this.startTime = this.game.time.time + this.delay;
     if (this.parent.reverse) {
@@ -84,6 +104,9 @@ export class TweenData {
     return this;
   }
 
+  /**
+   * TBD.
+   */
   loadValues() {
     const keys = Object.keys(this.parent.properties);
     for (let k = 0; k < keys.length; k += 1) {
@@ -117,6 +140,10 @@ export class TweenData {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param time
+   */
   update(time) {
     if (!this.isRunning) {
       if (time >= this.startTime) {
@@ -144,24 +171,21 @@ export class TweenData {
       const start = this.vStart[property];
       const end = this.vEnd[property];
       if (Array.isArray(end)) {
-        this.parent.target[property] = this.interpolationFunction.call(
-          this.interpolationContext,
-          end,
-          this.value
-        );
+        this.parent.target[property] = this.interpolationFunction.call(this.interpolationContext, end, this.value);
       } else {
         this.parent.target[property] = start + (end - start) * this.value;
       }
     }
-    if (
-      (!this.parent.reverse && this.percent === 1) ||
-      (this.parent.reverse && this.percent === 0)
-    ) {
+    if ((!this.parent.reverse && this.percent === 1) || (this.parent.reverse && this.percent === 0)) {
       return this.repeat();
     }
     return TWEEN_RUNNING;
   }
 
+  /**
+   * TBD.
+   * @param frameRate
+   */
   generateData(frameRate) {
     if (this.parent.reverse) {
       this.dt = this.duration;
@@ -194,10 +218,7 @@ export class TweenData {
         }
       }
       data.push(blob);
-      if (
-        (!this.parent.reverse && this.percent === 1) ||
-        (this.parent.reverse && this.percent === 0)
-      ) {
+      if ((!this.parent.reverse && this.percent === 1) || (this.parent.reverse && this.percent === 0)) {
         complete = true;
       }
     } while (!complete);
@@ -209,6 +230,9 @@ export class TweenData {
     return data;
   }
 
+  /**
+   * TBD.
+   */
   repeat() {
     //  If not a yoyo and repeatCounter = 0 then we're done
     if (this.yoyo) {

package/src/phaser/core/tween_easing.js

@@ -1,12 +1,5 @@
-/**
- * @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>
- */
-
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -16,7 +9,6 @@ export function LinearNone(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -26,7 +18,6 @@ export function QuadraticIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -36,7 +27,6 @@ export function QuadraticOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -47,7 +37,6 @@ export function QuadraticInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -57,7 +46,6 @@ export function CubicIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -67,7 +55,6 @@ export function CubicOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -78,7 +65,6 @@ export function CubicInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -88,7 +74,6 @@ export function QuarticIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -98,7 +83,6 @@ export function QuarticOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -109,7 +93,6 @@ export function QuarticInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -119,7 +102,6 @@ export function QuinticIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -129,7 +111,6 @@ export function QuinticOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -140,7 +121,6 @@ export function QuinticInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -152,7 +132,6 @@ export function SinusoidalIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -164,7 +143,6 @@ export function SinusoidalOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -176,7 +154,6 @@ export function SinusoidalInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -186,7 +163,6 @@ export function ExponentialIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -196,7 +172,6 @@ export function ExponentialOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -209,7 +184,6 @@ export function ExponentialInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -219,7 +193,6 @@ export function CircularIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -229,7 +202,6 @@ export function CircularOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -240,7 +212,6 @@ export function CircularInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -261,7 +232,6 @@ export function ElasticIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -282,7 +252,6 @@ export function ElasticOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -298,14 +267,12 @@ export function ElasticInOut(k) {
   } else {
     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));
+  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;
 }
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -316,7 +283,6 @@ export function BackIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -327,7 +293,6 @@ export function BackOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -339,7 +304,6 @@ export function BackInOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -356,7 +320,6 @@ export function BounceOut(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */
@@ -366,7 +329,6 @@ export function BounceIn(k) {
 
 /**
  * TBD.
- *
  * @param {number} k - TBD.
  * @returns {number} TBD.
  */