@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/scene_manager.js

@@ -1,11 +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>
- */
+import { Game } from './game';
 import { Scene } from './scene';
 
 export class SceneManager {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   * @param pendingState - TBD.
+   */
   constructor(game, pendingState) {
     this.game = game;
     this.states = {};
@@ -27,12 +28,21 @@ export class SceneManager {
     this.onShutDownCallback = null;
   }
 
+  /**
+   * TBD.
+   */
   boot() {
     if (this._pendingState !== null && typeof this._pendingState !== 'string') {
       this.add('default', this._pendingState, true);
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param state - TBD.
+   * @param autoStart - TBD.
+   */
   add(key, state, autoStart = false) {
     let newState = null;
     if (state instanceof Scene) {
@@ -54,6 +64,10 @@ export class SceneManager {
     return newState;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   remove(key) {
     if (this.current === key) {
       this.callbackContext = null;
@@ -68,6 +82,13 @@ export class SceneManager {
     delete this.states[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param clearWorld - TBD.
+   * @param clearCache - TBD.
+   * @param {...any} args - TBD.
+   */
   start(key, clearWorld = true, clearCache = false, ...args) {
     if (this.checkState(key)) {
       //  Place the state in the queue. It will be started the next time the game loop begins.
@@ -80,6 +101,12 @@ export class SceneManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param clearWorld - TBD.
+   * @param clearCache - TBD.
+   * @param {...any} args - TBD.
+   */
   restart(clearWorld = true, clearCache = false, ...args) {
     this._pendingState = this.current;
     this._clearWorld = clearWorld;
@@ -89,6 +116,9 @@ export class SceneManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   preUpdate() {
     if (this._pendingState && this.game.isBooted) {
       // var previousStateKey = this.current;
@@ -120,6 +150,9 @@ export class SceneManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   clearCurrentState() {
     if (this.current) {
       if (this.onShutDownCallback) {
@@ -138,14 +171,13 @@ export class SceneManager {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   checkState(key) {
     if (this.states[key]) {
-      if (
-        this.states[key].preload ||
-        this.states[key].create ||
-        this.states[key].update ||
-        this.states[key].render
-      ) {
+      if (this.states[key].preload || this.states[key].create || this.states[key].update || this.states[key].render) {
         return true;
       }
       return false;
@@ -153,17 +185,29 @@ export class SceneManager {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   link(key) {
     this.states[key].game = this.game;
     this.states[key].key = key;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   unlink(key) {
     if (this.states[key]) {
       this.states[key].game = null;
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   setCurrentState(key) {
     this.callbackContext = this.states[key];
     this.link(key);
@@ -184,10 +228,16 @@ export class SceneManager {
     this.game.isKickStart = true;
   }
 
+  /**
+   * TBD.
+   */
   getCurrentState() {
     return this.states[this.current];
   }
 
+  /**
+   * TBD.
+   */
   loadComplete() {
     if (this._created === false && this.onCreateCallback) {
       this._created = true;
@@ -197,24 +247,38 @@ export class SceneManager {
     }
   }
 
+  /**
+   * TBD.
+   */
   update() {
     if (this._created && this.onUpdateCallback) {
       this.onUpdateCallback.call(this.callbackContext, this.game);
     }
   }
 
+  /**
+   * TBD.
+   */
   pauseUpdate() {
     if (this._created && this.onPauseUpdateCallback) {
       this.onPauseUpdateCallback.call(this.callbackContext, this.game);
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} width - TBD.
+   * @param {number} height - TBD.
+   */
   resize(width, height) {
     if (this.onResizeCallback) {
       this.onResizeCallback.call(this.callbackContext, width, height);
     }
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this._clearWorld = true;
     this._clearCache = true;
@@ -232,10 +296,16 @@ export class SceneManager {
     this.current = '';
   }
 
+  /**
+   * TBD.
+   */
   dummy() {
     // pass
   }
 
+  /**
+   * TBD.
+   */
   get created() {
     return this._created;
   }

package/src/phaser/core/signal.js

@@ -1,12 +1,9 @@
-/**
- * @module core/signal
- * @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 { SignalBinding } from  './signal_binding';
+import { SignalBinding } from './signal_binding';
 
 export class Signal {
+  /**
+   * TBD.
+   */
   constructor() {
     this._bindings = null;
     this._prevParams = null;
@@ -16,17 +13,30 @@ export class Signal {
     this._boundDispatch = false;
   }
 
+  /**
+   * TBD.
+   * @param {Function} listener - TBD.
+   * @param {string} fnName - TBD.
+   * @throws Error.
+   */
   validateListener(listener, fnName) {
     if (typeof listener !== 'function') {
       throw new Error(
-        'Signal: listener is a required param of {fn}() and should be a Function.'.replace(
-          '{fn}',
-          fnName
-        )
+        'Signal: listener is a required param of {fn}() and should be a Function.'.replace('{fn}', fnName)
       );
     }
   }
 
+  /**
+   * TBD.
+   * @param {Function} listener - TBD.
+   * @param {boolean} isOnce - TBD.
+   * @param {object} listenerContext - TBD.
+   * @param {number} priority - TBD.
+   * @param {...any} args - TBD.
+   * @returns {SignalBinding} TBD.
+   * @throws Error.
+   */
   _registerListener(listener, isOnce, listenerContext, priority, args) {
     const prevIndex = this._indexOfListener(listener, listenerContext);
     let binding;
@@ -51,6 +61,10 @@ export class Signal {
     return binding;
   }
 
+  /**
+   * TBD.
+   * @param {SignalBinding} binding - TBD.
+   */
   _addBinding(binding) {
     if (!this._bindings) {
       this._bindings = [];
@@ -63,6 +77,12 @@ export class Signal {
     this._bindings.splice(n + 1, 0, binding);
   }
 
+  /**
+   * TBD.
+   * @param {Function} listener - TBD.
+   * @param {object} context - TBD.
+   * @returns {number} TBD.
+   */
   _indexOfListener(listener, context = null) {
     if (!this._bindings) {
       return -1;
@@ -79,20 +99,48 @@ export class Signal {
     return -1;
   }
 
+  /**
+   * TBD.
+   * @param {Function} listener - TBD.
+   * @param {object} context - TBD.
+   * @returns {boolean} TBD.
+   */
   has(listener, context) {
     return this._indexOfListener(listener, context) !== -1;
   }
 
+  /**
+   * TBD.
+   * @param {Function} listener - TBD.
+   * @param {object} listenerContext - TBD.
+   * @param {number} priority - TBD.
+   * @param {...any} args - TBD.
+   * @returns {SignalBinding} TBD.
+   */
   add(listener, listenerContext, priority, ...args) {
     this.validateListener(listener, 'add');
     return this._registerListener(listener, false, listenerContext, priority, args);
   }
 
+  /**
+   * TBD.
+   * @param {Function} listener - TBD.
+   * @param {object} listenerContext - TBD.
+   * @param {number} priority - TBD.
+   * @param {...any} args - TBD.
+   * @returns {SignalBinding} TBD.
+   */
   addOnce(listener, listenerContext, priority, ...args) {
     this.validateListener(listener, 'addOnce');
     return this._registerListener(listener, true, listenerContext, priority, args);
   }
 
+  /**
+   * TBD.
+   * @param {Function} listener - TBD.
+   * @param {object} context - TBD.
+   * @returns {Function} TBD.
+   */
   remove(listener, context) {
     this.validateListener(listener, 'remove');
     const i = this._indexOfListener(listener, context);
@@ -104,6 +152,10 @@ export class Signal {
     return listener;
   }
 
+  /**
+   * TBD.
+   * @param {object} context - TBD.
+   */
   removeAll(context = null) {
     if (!this._bindings) {
       return;
@@ -125,14 +177,25 @@ export class Signal {
     }
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   getNumListeners() {
     return this._bindings ? this._bindings.length : 0;
   }
 
+  /**
+   * TBD.
+   */
   halt() {
     this._shouldPropagate = false;
   }
 
+  /**
+   * TBD.
+   * @param {...any} args - TBD.
+   */
   dispatch(...args) {
     if (!this.active || !this._bindings) {
       return;
@@ -157,22 +220,36 @@ export class Signal {
     } while (bindings[n] && this._shouldPropagate && bindings[n].execute(paramsArr) !== false);
   }
 
+  /**
+   * TBD.
+   */
   forget() {
     if (this._prevParams) {
       this._prevParams = null;
     }
   }
 
+  /**
+   * TBD.
+   */
   dispose() {
     this.removeAll();
     this.forget();
     this._bindings = null;
   }
 
+  /**
+   * TBD.
+   * @returns {string} TBD.
+   */
   toString() {
     return '[Signal active:' + this.active + ' numListeners:' + this.getNumListeners() + ']';
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get boundDispatch() {
     const _this = this;
     if (!this._boundDispatch) {

package/src/phaser/core/signal_binding.js

@@ -1,10 +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>
- */
-
 export class SignalBinding {
+  /**
+   * TBD.
+   * @param signal
+   * @param listener
+   * @param isOnce
+   * @param listenerContext
+   * @param priority
+   * @param args - TBD.
+   */
   constructor(signal, listener, isOnce = false, listenerContext = null, priority = 0, args = null) {
     this._signal = signal;
     this._listener = listener;
@@ -17,6 +20,10 @@ export class SignalBinding {
     this.params = null;
   }
 
+  /**
+   * TBD.
+   * @param paramsArr
+   */
   execute(paramsArr) {
     let handlerReturn;
     let params;
@@ -34,41 +41,54 @@ export class SignalBinding {
     return handlerReturn;
   }
 
+  /**
+   * TBD.
+   */
   detach() {
     return this.isBound() ? this._signal.remove(this._listener, this.context) : null;
   }
 
+  /**
+   * TBD.
+   */
   isBound() {
     return !!this._signal && !!this._listener;
   }
 
+  /**
+   * TBD.
+   */
   isOnce() {
     return this._isOnce;
   }
 
+  /**
+   * TBD.
+   */
   getListener() {
     return this._listener;
   }
 
+  /**
+   * TBD.
+   */
   getSignal() {
     return this._signal;
   }
 
+  /**
+   * TBD.
+   */
   _destroy() {
     delete this._signal;
     delete this._listener;
     delete this.context;
   }
 
+  /**
+   * TBD.
+   */
   toString() {
-    return (
-      '[SignalBinding isOnce:' +
-      this._isOnce +
-      ', isBound:' +
-      this.isBound() +
-      ', active:' +
-      this.active +
-      ']'
-    );
+    return '[SignalBinding isOnce:' + this._isOnce + ', isBound:' + this.isBound() + ', active:' + this.active + ']';
   }
 }