@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/game.js

@@ -1,12 +1,6 @@
-/**
- * @module core/game
- * @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 { CanvasRenderer } from '../display/canvas/renderer';
 import { WebGLRenderer } from '../display/webgl/renderer';
-import { Signal } from  './signal';
+import { Signal } from './signal';
 import { Loader } from './loader';
 import { Cache } from './cache';
 import { Input } from './input';
@@ -25,6 +19,10 @@ import { create, removeFromDOM, addToDOM, setTouchAction } from '../display/canv
 import { initialize, checkOS } from './device_util';
 
 export class Game {
+  /**
+   * TBD.
+   * @param {object} gameConfig - TBD.
+   */
   constructor(gameConfig = {}) {
     if (!window.PhaserRegistry) {
       window.PhaserRegistry = {};
@@ -72,6 +70,9 @@ export class Game {
     }
   }
 
+  /**
+   * TBD.
+   */
   boot() {
     if (this.isBooted) {
       return;
@@ -105,6 +106,9 @@ export class Game {
     this.onBoot.dispatch(this);
   }
 
+  /**
+   * TBD.
+   */
   initRenderer() {
     if (this.config.canvas) {
       this.canvas = this.config.canvas;
@@ -165,6 +169,12 @@ export class Game {
     setTouchAction(this.canvas);
   }
 
+  /**
+   * TBD.
+   * @param {object} config - TBD.
+   * @param {string} key - TBD.
+   * @param {*} defaultValue - TBD.
+   */
   parseConfigElement(config, key, defaultValue) {
     if (config[key] !== undefined) {
       this.config[key] = config[key];
@@ -173,6 +183,10 @@ export class Game {
     }
   }
 
+  /**
+   * TBD.
+   * @param {object} config - TBD.
+   */
   parseConfig(config) {
     this.parseConfigElement(config, 'width', 800);
     this.parseConfigElement(config, 'height', 600);
@@ -205,6 +219,10 @@ export class Game {
     this.state = new SceneManager(this, state);
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   contextLost(event) {
     event.preventDefault();
     if (this.renderer) {
@@ -212,6 +230,9 @@ export class Game {
     }
   }
 
+  /**
+   * TBD.
+   */
   contextRestored() {
     this.renderer.initContext();
     // this.cache.clearGLTextures();
@@ -220,6 +241,10 @@ export class Game {
     }
   }
 
+  /**
+   * TBD.
+   * @param {number} time - TBD.
+   */
   update(time) {
     this.time.update(time);
     if (!this.isPaused) {
@@ -240,6 +265,9 @@ export class Game {
     this.renderer.render(this.stage);
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.isPaused = true;
 

package/src/phaser/core/input.js

@@ -1,24 +1,24 @@
-/**
- * @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 { ArraySet } from './array_set';
-import { Graphics } from  '../display/graphics';
+import { Graphics } from '../display/graphics';
 import { Image } from '../display/image';
-import { Signal } from  './signal';
+import { Signal } from './signal';
 import { Point } from '../geom/point';
-import { Circle } from  '../geom/circle';
+import { Circle } from '../geom/circle';
 import { Mouse } from './input_mouse';
 import { MSPointer } from './input_mspointer';
 import { Pointer } from './input_pointer';
 import { Touch } from './input_touch';
 import { POINTER_CURSOR, POINTER_CONTACT, MOUSE_TOUCH_COMBINE } from './const';
 import { create, remove } from '../display/canvas/pool';
+import { Game } from './game';
 
 const MAX_POINTERS = 10;
 
 export class Input {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this.hitCanvas = null;
@@ -73,6 +73,9 @@ export class Input {
     this._y = 0;
   }
 
+  /**
+   * TBD.
+   */
   boot() {
     this.mousePointer = new Pointer(this.game, 0, POINTER_CURSOR);
     this.addPointer();
@@ -104,6 +107,9 @@ export class Input {
     this.game.canvas.addEventListener('click', this._onClickTrampoline, false);
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     this.mouse.stop();
     if (this.game.device.mspointer) {
@@ -116,29 +122,45 @@ export class Input {
     this.game.canvas.removeEventListener('click', this._onClickTrampoline);
   }
 
+  /**
+   * TBD.
+   * @param {Function} callback - TBD.
+   * @param context - TBD.
+   */
   setInteractiveCandidateHandler(callback, context) {
     this.customCandidateHandler = callback;
     this.customCandidateHandlerContext = context;
   }
 
+  /**
+   * TBD.
+   * @param {Function} callback - TBD.
+   * @param context - TBD.
+   */
   addMoveCallback(callback, context) {
     this.moveCallbacks.push({ callback, context });
   }
 
+  /**
+   * TBD.
+   * @param {Function} callback - TBD.
+   * @param context - TBD.
+   */
   deleteMoveCallback(callback, context) {
     let i = this.moveCallbacks.length;
     while (i) {
       i -= 1;
-      if (
-        this.moveCallbacks[i].callback === callback &&
-        this.moveCallbacks[i].context === context
-      ) {
+      if (this.moveCallbacks[i].callback === callback && this.moveCallbacks[i].context === context) {
         this.moveCallbacks.splice(i, 1);
         return;
       }
     }
   }
 
+  /**
+   * TBD.
+   * @returns {Pointer} TBD.
+   */
   addPointer() {
     if (this.pointers.length >= MAX_POINTERS) {
       console.warn('Input.addPointer: Maximum limit of ' + MAX_POINTERS + ' pointers reached.');
@@ -151,6 +173,9 @@ export class Input {
     return pointer;
   }
 
+  /**
+   * TBD.
+   */
   update() {
     if (this.pollRate > 0 && this._pollCounter < this.pollRate) {
       this._pollCounter += 1;
@@ -166,6 +191,10 @@ export class Input {
     this._pollCounter = 0;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} hard - TBD.
+   */
   reset(hard = false) {
     if (!this.game.isBooted || this.resetLocked) {
       return;
@@ -191,11 +220,21 @@ export class Input {
     this._pollCounter = 0;
   }
 
+  /**
+   * TBD.
+   * @param {number} x - TBD.
+   * @param {number} y - TBD.
+   */
   resetSpeed(x, y) {
     this._oldPosition.setTo(x, y);
     this.speed.setTo(0, 0);
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
+   */
   startPointer(event) {
     if (this.maxPointers >= 0 && this.countActivePointers(this.maxPointers) >= this.maxPointers) {
       return null;
@@ -215,6 +254,11 @@ export class Input {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
+   */
   updatePointer(event) {
     if (this.pointer1.active && this.pointer1.identifier === event.identifier) {
       return this.pointer1.move(event);
@@ -231,6 +275,11 @@ export class Input {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
+   */
   stopPointer(event) {
     if (this.pointer1.active && this.pointer1.identifier === event.identifier) {
       return this.pointer1.stop(event);
@@ -247,6 +296,11 @@ export class Input {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param limit - TBD.
+   * @returns {number} TBD.
+   */
   countActivePointers(limit = this.pointers.length) {
     let count = limit;
     for (let i = 0; i < this.pointers.length && count > 0; i += 1) {
@@ -258,6 +312,11 @@ export class Input {
     return limit - count;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} isActive - TBD.
+   * @returns {Pointer} TBD.
+   */
   getPointer(isActive = false) {
     for (let i = 0; i < this.pointers.length; i += 1) {
       const pointer = this.pointers[i];
@@ -268,6 +327,11 @@ export class Input {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param identifier - TBD.
+   * @returns {Pointer} TBD.
+   */
   getPointerFromIdentifier(identifier) {
     for (let i = 0; i < this.pointers.length; i += 1) {
       const pointer = this.pointers[i];
@@ -279,6 +343,11 @@ export class Input {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param pointerId - TBD.
+   * @returns {Pointer} TBD.
+   */
   getPointerFromId(pointerId) {
     for (let i = 0; i < this.pointers.length; i += 1) {
       const pointer = this.pointers[i];
@@ -290,6 +359,13 @@ export class Input {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param displayObject - TBD.
+   * @param pointer - TBD.
+   * @param output - TBD.
+   * @returns {Point} TBD.
+   */
   getLocalPosition(displayObject, pointer, output = null) {
     const result = output || new Point();
     const wt = displayObject.worldTransform;
@@ -300,6 +376,13 @@ export class Input {
     );
   }
 
+  /**
+   * TBD.
+   * @param displayObject - TBD.
+   * @param pointer - TBD.
+   * @param localPoint - TBD.
+   * @returns {boolean} TBD.
+   */
   hitTest(displayObject, pointer, localPoint) {
     if (!displayObject.worldVisible) {
       return false;
@@ -321,11 +404,7 @@ export class Input {
     } else if (displayObject instanceof Graphics) {
       for (let i = 0; i < displayObject.graphicsData.length; i += 1) {
         const data = displayObject.graphicsData[i];
-        if (
-          data.fill &&
-          data.shape &&
-          data.shape.contains(this._localPoint.x, this._localPoint.y)
-        ) {
+        if (data.fill && data.shape && data.shape.contains(this._localPoint.x, this._localPoint.y)) {
           // Only deal with fills..
           return true;
         }
@@ -340,42 +419,79 @@ export class Input {
     return false;
   }
 
+  /**
+   * TBD.
+   */
   onClickTrampoline() {
     this.activePointer.processClickTrampolines();
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get x() {
     return this._x;
   }
 
+  /**
+   * TBD.
+   */
   set x(value) {
     this._x = Math.floor(value);
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get y() {
     return this._y;
   }
 
+  /**
+   * TBD.
+   */
   set y(value) {
     this._y = Math.floor(value);
   }
 
+  /**
+   * TBD.
+   * @returns {boolean} TBD.
+   */
   get pollLocked() {
     return this.pollRate > 0 && this._pollCounter < this.pollRate;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get totalInactivePointers() {
     return this.pointers.length - this.countActivePointers();
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get totalActivePointers() {
     return this.countActivePointers();
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get worldX() {
     return this.x;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get worldY() {
     return this.y;
   }