@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/time.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>
- */
+import { Game } from './game';
 import { Timer } from './timer';
 
 export class Time {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this.time = 0;
@@ -36,6 +36,9 @@ export class Time {
     this._timers = [];
   }
 
+  /**
+   * TBD.
+   */
   boot() {
     this._started = Date.now();
     this.time = Date.now();
@@ -43,17 +46,30 @@ export class Time {
     this.timeExpected = this.time;
   }
 
+  /**
+   * TBD.
+   * @param {Timer} timer - TBD.
+   * @returns {Timer} TBD.
+   */
   add(timer) {
     this._timers.push(timer);
     return timer;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} autoDestroy - TBD.
+   * @returns {Timer} TBD.
+   */
   create(autoDestroy = true) {
     const timer = new Timer(this.game, autoDestroy);
     this._timers.push(timer);
     return timer;
   }
 
+  /**
+   * TBD.
+   */
   removeAll() {
     for (let i = 0; i < this._timers.length; i += 1) {
       this._timers[i].destroy();
@@ -62,6 +78,9 @@ export class Time {
     this.events.removeAll();
   }
 
+  /**
+   * TBD.
+   */
   refresh() {
     const previousDateNow = this.time;
     // this.time always holds a Date.now value
@@ -70,6 +89,10 @@ export class Time {
     this.elapsedMS = this.time - previousDateNow;
   }
 
+  /**
+   * TBD.
+   * @param {number} time - TBD.
+   */
   update(time) {
     const previousDateNow = this.time;
     // this.time always holds a Date.now value
@@ -96,6 +119,9 @@ export class Time {
     }
   }
 
+  /**
+   * TBD.
+   */
   updateTimers() {
     let i = 0;
     let len = this._timers.length;
@@ -110,6 +136,9 @@ export class Time {
     }
   }
 
+  /**
+   * TBD.
+   */
   updateAdvancedTiming() {
     // count the number of time.update calls
     this._frameCount += 1;
@@ -133,6 +162,9 @@ export class Time {
     }
   }
 
+  /**
+   * TBD.
+   */
   gamePaused() {
     this._pauseStarted = Date.now();
     this.events.pause();
@@ -143,6 +175,9 @@ export class Time {
     }
   }
 
+  /**
+   * TBD.
+   */
   gameResumed() {
     this.time = Date.now();
     this.pauseDuration = this.time - this._pauseStarted;
@@ -154,31 +189,58 @@ export class Time {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   totalElapsedSeconds() {
     return (this.time - this._started) * 0.001;
   }
 
+  /**
+   * TBD.
+   * @param {number} since - TBD.
+   * @returns {number} TBD.
+   */
   elapsedSince(since) {
     return this.time - since;
   }
 
+  /**
+   * TBD.
+   * @param {number} since - TBD.
+   * @returns {number} TBD.
+   */
   elapsedSecondsSince(since) {
     return (this.time - since) * 0.001;
   }
 
+  /**
+   * TBD.
+   */
   reset() {
     this._started = this.time;
     this.removeAll();
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.reset();
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get desiredFps() {
     return this._desiredFps;
   }
 
+  /**
+   * TBD.
+   */
   set desiredFps(value) {
     this._desiredFps = value;
     this.desiredFpsMult = 1.0 / value;

package/src/phaser/core/timer.js

@@ -1,12 +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>
- */
-import { Signal } from  './signal';
+import { Game } from './game';
+import { Signal } from './signal';
 import { TimerEvent } from './timer_event';
 
 export class Timer {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   * @param {boolean} autoDestroy - TBD.
+   */
   constructor(game, autoDestroy = false) {
     this.game = game;
     this.running = false;
@@ -30,6 +31,15 @@ export class Timer {
     this._newTick = 0;
   }
 
+  /**
+   * TBD.
+   * @param delay - TBD.
+   * @param loop
+   * @param repeatCount
+   * @param {Function} callback - TBD.
+   * @param callbackContext
+   * @param args - TBD.
+   */
   create(delay, loop, repeatCount, callback, callbackContext, args) {
     const roundedDelay = Math.round(delay);
     let tick = roundedDelay;
@@ -38,34 +48,51 @@ export class Timer {
     } else {
       tick += this._now;
     }
-    const event = new TimerEvent(
-      this,
-      roundedDelay,
-      tick,
-      repeatCount,
-      loop,
-      callback,
-      callbackContext,
-      args
-    );
+    const event = new TimerEvent(this, roundedDelay, tick, repeatCount, loop, callback, callbackContext, args);
     this.events.push(event);
     this.order();
     this.expired = false;
     return event;
   }
 
+  /**
+   * TBD.
+   * @param delay - TBD.
+   * @param {Function} callback - TBD.
+   * @param callbackContext
+   * @param {...any} args
+   */
   add(delay, callback, callbackContext, ...args) {
     return this.create(delay, false, 0, callback, callbackContext, args);
   }
 
+  /**
+   * TBD.
+   * @param delay - TBD.
+   * @param repeatCount
+   * @param {Function} callback - TBD.
+   * @param callbackContext
+   * @param {...any} args
+   */
   repeat(delay, repeatCount, callback, callbackContext, ...args) {
     return this.create(delay, false, repeatCount, callback, callbackContext, args);
   }
 
+  /**
+   * TBD.
+   * @param delay - TBD.
+   * @param {Function} callback - TBD.
+   * @param callbackContext
+   * @param {...any} args
+   */
   loop(delay, callback, callbackContext, ...args) {
     return this.create(delay, true, 0, callback, callbackContext, args);
   }
 
+  /**
+   * TBD.
+   * @param delay - TBD.
+   */
   start(delay) {
     if (this.running) {
       return;
@@ -77,6 +104,10 @@ export class Timer {
     }
   }
 
+  /**
+   * TBD.
+   * @param clearEvents
+   */
   stop(clearEvents = true) {
     this.running = false;
     if (clearEvents) {
@@ -84,6 +115,10 @@ export class Timer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   remove(event) {
     for (let i = 0; i < this.events.length; i += 1) {
       if (this.events[i] === event) {
@@ -94,6 +129,9 @@ export class Timer {
     return false;
   }
 
+  /**
+   * TBD.
+   */
   order() {
     if (this.events.length > 0) {
       //  Sort the events so the one with the lowest tick is first
@@ -102,6 +140,11 @@ export class Timer {
     }
   }
 
+  /**
+   * TBD.
+   * @param a - TBD.
+   * @param b - TBD.
+   */
   sortHandler(a, b) {
     if (a.tick < b.tick) {
       return -1;
@@ -111,6 +154,9 @@ export class Timer {
     return 0;
   }
 
+  /**
+   * TBD.
+   */
   clearPendingEvents() {
     this._i = this.events.length;
     while (this._i) {
@@ -123,6 +169,10 @@ export class Timer {
     this._i = 0;
   }
 
+  /**
+   * TBD.
+   * @param time - TBD.
+   */
   update(time) {
     if (this.paused) {
       return true;
@@ -143,31 +193,21 @@ export class Timer {
       while (this._i < this._len && this.running) {
         if (this._now >= this.events[this._i].tick && !this.events[this._i].pendingDelete) {
           //  (now + delay) - (time difference from last tick to now)
-          this._newTick =
-            this._now + this.events[this._i].delay - (this._now - this.events[this._i].tick);
+          this._newTick = this._now + this.events[this._i].delay - (this._now - this.events[this._i].tick);
           if (this._newTick < 0) {
             this._newTick = this._now + this.events[this._i].delay;
           }
           if (this.events[this._i].loop === true) {
             this.events[this._i].tick = this._newTick;
-            this.events[this._i].callback.apply(
-              this.events[this._i].callbackContext,
-              this.events[this._i].args
-            );
+            this.events[this._i].callback.apply(this.events[this._i].callbackContext, this.events[this._i].args);
           } else if (this.events[this._i].repeatCount > 0) {
             this.events[this._i].repeatCount -= 1;
             this.events[this._i].tick = this._newTick;
-            this.events[this._i].callback.apply(
-              this.events[this._i].callbackContext,
-              this.events[this._i].args
-            );
+            this.events[this._i].callback.apply(this.events[this._i].callbackContext, this.events[this._i].args);
           } else {
             this._marked += 1;
             this.events[this._i].pendingDelete = true;
-            this.events[this._i].callback.apply(
-              this.events[this._i].callbackContext,
-              this.events[this._i].args
-            );
+            this.events[this._i].callback.apply(this.events[this._i].callbackContext, this.events[this._i].args);
           }
           this._i += 1;
         } else {
@@ -188,6 +228,9 @@ export class Timer {
     return true;
   }
 
+  /**
+   * TBD.
+   */
   pause() {
     if (!this.running) {
       return;
@@ -200,6 +243,9 @@ export class Timer {
     this.paused = true;
   }
 
+  /**
+   * TBD.
+   */
   _pause() {
     if (this.paused || !this.running) {
       return;
@@ -208,6 +254,10 @@ export class Timer {
     this.paused = true;
   }
 
+  /**
+   * TBD.
+   * @param baseTime - TBD.
+   */
   adjustEvents(baseTime) {
     for (let i = 0; i < this.events.length; i += 1) {
       if (!this.events[i].pendingDelete) {
@@ -228,6 +278,9 @@ export class Timer {
     }
   }
 
+  /**
+   * TBD.
+   */
   resume() {
     if (!this.paused) {
       return;
@@ -240,6 +293,9 @@ export class Timer {
     this._codePaused = false;
   }
 
+  /**
+   * TBD.
+   */
   _resume() {
     if (this._codePaused) {
       return;
@@ -247,6 +303,9 @@ export class Timer {
     this.resume();
   }
 
+  /**
+   * TBD.
+   */
   removeAll() {
     this.onComplete.removeAll();
     this.events.length = 0;
@@ -254,6 +313,9 @@ export class Timer {
     this._i = 0;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.onComplete.removeAll();
     this.running = false;
@@ -262,10 +324,16 @@ export class Timer {
     this._i = 0;
   }
 
+  /**
+   * TBD.
+   */
   get next() {
     return this.nextTick;
   }
 
+  /**
+   * TBD.
+   */
   get duration() {
     if (this.running && this.nextTick > this._now) {
       return this.nextTick - this._now;
@@ -273,10 +341,16 @@ export class Timer {
     return 0;
   }
 
+  /**
+   * TBD.
+   */
   get length() {
     return this.events.length;
   }
 
+  /**
+   * TBD.
+   */
   get ms() {
     if (this.running) {
       return this._now - this._started - this._pauseTotal;
@@ -284,6 +358,9 @@ export class Timer {
     return 0;
   }
 
+  /**
+   * TBD.
+   */
   get seconds() {
     if (this.running) {
       return this.ms * 0.001;

package/src/phaser/core/timer_event.js

@@ -1,10 +1,15 @@
-/**
- * @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>
- */
-
 export class TimerEvent {
+  /**
+   * TBD.
+   * @param timer - TBD.
+   * @param delay - TBD.
+   * @param tick - TBD.
+   * @param repeatCount - TBD.
+   * @param loop - TBD.
+   * @param {Function} callback - TBD.
+   * @param {object} callbackContext - TBD.
+   * @param args - TBD.
+   */
   constructor(timer, delay, tick, repeatCount, loop, callback, callbackContext, args) {
     this.timer = timer;
     this.delay = delay;