@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/input_mouse.js

@@ -1,8 +1,3 @@
-/**
- * @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>
- */
 /* const NO_BUTTON = -1;
 const LEFT_BUTTON = 0;
 const MIDDLE_BUTTON = 1;
@@ -12,7 +7,14 @@ const FORWARD_BUTTON = 4;
 const WHEEL_UP = 1;
 const WHEEL_DOWN = -1; */
 
+import { Game } from './game';
+
 class WheelEventProxy {
+  /**
+   * TBD.
+   * @param scaleFactor - TBD.
+   * @param deltaMode - TBD.
+   */
   constructor(scaleFactor, deltaMode) {
     this._scaleFactor = scaleFactor;
     this._deltaMode = deltaMode;
@@ -21,6 +23,11 @@ class WheelEventProxy {
     this.deltaZ = { value: 0 };
   }
 
+  /**
+   * TBD.
+   * @param {WheelEvent} event - TBD.
+   * @returns {WheelEventProxy} TBD.
+   */
   bindEvent(event) {
     // TODO
     console.warn('input_mouse.bindEvent() is not implemented');
@@ -39,20 +46,35 @@ class WheelEventProxy {
     return this;
   }
 
+  /**
+   * TBD.
+   */
   get deltaMode() {
     return this._deltaMode;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get deltaY() {
     return this._scaleFactor * (this.originalEvent.wheelDelta || this.originalEvent.detail) || 0;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get deltaX() {
     return this._scaleFactor * this.originalEvent.wheelDeltaX || 0;
   }
 }
 
 export class Mouse {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this.input = game.input;
@@ -62,6 +84,7 @@ export class Mouse {
     this.mouseOutCallback = null;
     this.mouseOverCallback = null;
     this.mouseWheelCallback = null;
+    this.mouseMoveCallback = null;
     this.capture = false;
     this.button = -1;
     this.wheelDelta = 0;
@@ -78,6 +101,9 @@ export class Mouse {
     this._wheelEvent = null;
   }
 
+  /**
+   * TBD.
+   */
   start() {
     if (this.game.device.android && this.game.device.chrome === false) {
       //  Android stock browser fires mouse events even if you preventDefault on the touchStart, so ...
@@ -110,6 +136,9 @@ export class Mouse {
     }
   }
 
+  /**
+   * TBD.
+   */
   stop() {
     const canvas = this.game.canvas;
     canvas.removeEventListener('mousedown', this._onMouseDown, true);
@@ -125,6 +154,10 @@ export class Mouse {
     window.removeEventListener('mouseout', this._onMouseOutGlobal, true);
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent} event - TBD.
+   */
   onMouseDown(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -138,6 +171,10 @@ export class Mouse {
     this.input.mousePointer.start(event);
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent} event - TBD.
+   */
   onMouseMove(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -151,6 +188,10 @@ export class Mouse {
     this.input.mousePointer.move(event);
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent} event - TBD.
+   */
   onMouseUp(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -164,6 +205,10 @@ export class Mouse {
     this.input.mousePointer.stop(event);
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent} event - TBD.
+   */
   onMouseUpGlobal(event) {
     if (!this.input.mousePointer.withinGame) {
       if (this.mouseUpCallback) {
@@ -174,6 +219,10 @@ export class Mouse {
     }
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent} event - TBD.
+   */
   onMouseOutGlobal(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -189,6 +238,10 @@ export class Mouse {
     this.input.mousePointer.stop(event);
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent} event - TBD.
+   */
   onMouseOut(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -205,6 +258,10 @@ export class Mouse {
     }
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent} event - TBD.
+   */
   onMouseOver(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -214,6 +271,10 @@ export class Mouse {
     }
   }
 
+  /**
+   * TBD.
+   * @param {WheelEvent} event - TBD.
+   */
   onMouseWheel(event) {
     if (this._wheelEvent) {
       event = this._wheelEvent.bindEvent(event);
@@ -227,6 +288,10 @@ export class Mouse {
     }
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent} event - TBD.
+   */
   eventPreventDefault(event) {
     if (this.capture) {
       if (typeof event.cancelable !== 'boolean' || event.cancelable) {

package/src/phaser/core/input_mspointer.js

@@ -1,10 +1,10 @@
-/**
- * @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';
 
 export class MSPointer {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this.input = game.input;
@@ -24,6 +24,9 @@ export class MSPointer {
     this._onMSPointerOver = null;
   }
 
+  /**
+   * TBD.
+   */
   start() {
     if (!this.game.device.mspointer || this._onMSPointerDown !== null) {
       return;
@@ -54,6 +57,9 @@ export class MSPointer {
     canvas.addEventListener('pointerout', this._onMSPointerOut, true);
   }
 
+  /**
+   * TBD.
+   */
   stop() {
     if (!this.game.device.mspointer) {
       return;
@@ -75,6 +81,10 @@ export class MSPointer {
     canvas.removeEventListener('pointerout', this._onMSPointerOut, true);
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   onPointerDown(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -92,6 +102,10 @@ export class MSPointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   onPointerMove(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -109,6 +123,10 @@ export class MSPointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   onPointerUp(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -126,11 +144,12 @@ export class MSPointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   onPointerUpGlobal(event) {
-    if (
-      (event.pointerType === 'mouse' || event.pointerType === 0x00000004) &&
-      !this.input.mousePointer.withinGame
-    ) {
+    if ((event.pointerType === 'mouse' || event.pointerType === 0x00000004) && !this.input.mousePointer.withinGame) {
       this.onPointerUp(event);
     } else {
       const pointer = this.input.getPointerFromIdentifier(event.identifier);
@@ -140,6 +159,10 @@ export class MSPointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   onPointerOut(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -168,6 +191,10 @@ export class MSPointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   onPointerOver(event) {
     this.event = event;
     this.eventPreventDefault(event);
@@ -184,6 +211,10 @@ export class MSPointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {Event} event - TBD.
+   */
   eventPreventDefault(event) {
     if (this.capture) {
       if (typeof event.cancelable !== 'boolean' || event.cancelable) {

package/src/phaser/core/input_pointer.js

@@ -1,10 +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>
- */
 import { Point } from '../geom/point';
-import { Circle } from  '../geom/circle';
+import { Circle } from '../geom/circle';
 import {
   POINTER,
   POINTER_CURSOR,
@@ -13,8 +8,15 @@ import {
   TOUCH_OVERRIDES_MOUSE,
   MOUSE_TOUCH_COMBINE,
 } from './const';
+import { Game } from './game';
 
 export class Pointer {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   * @param {number} id - TBD.
+   * @param {number} pointerMode - TBD.
+   */
   constructor(game, id, pointerMode) {
     this.game = game;
     this.id = id;
@@ -62,11 +64,18 @@ export class Pointer {
     this._trampolineTargetObject = null;
   }
 
+  /**
+   * TBD.
+   */
   resetButtons() {
     this.isDown = false;
     this.isUp = true;
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent|PointerEvent} event - TBD.
+   */
   updateButtons(event) {
     if (event.type.toLowerCase().substr(-4) === 'down') {
       this.isUp = false;
@@ -77,6 +86,11 @@ export class Pointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
+   */
   start(event) {
     const input = this.game.input;
     if (event.pointerId) {
@@ -123,6 +137,9 @@ export class Pointer {
     return this;
   }
 
+  /**
+   * TBD.
+   */
   update() {
     const input = this.game.input;
     if (this.active) {
@@ -157,6 +174,12 @@ export class Pointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent|PointerEvent} event - TBD.
+   * @param {boolean} fromClick - TBD.
+   * @returns {Pointer} TBD.
+   */
   move(event, fromClick = false) {
     const input = this.game.input;
     if (input.pollLocked) {
@@ -202,13 +225,7 @@ export class Pointer {
     let i = input.moveCallbacks.length;
     while (i) {
       i -= 1;
-      input.moveCallbacks[i].callback.call(
-        input.moveCallbacks[i].context,
-        this,
-        this.x,
-        this.y,
-        fromClick
-      );
+      input.moveCallbacks[i].callback.call(input.moveCallbacks[i].context, this, this.x, this.y, fromClick);
     }
     //  Easy out if we're dragging something and it still exists
     if (this.targetObject !== null && this.targetObject.isDragged === true) {
@@ -221,6 +238,11 @@ export class Pointer {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {boolean} fromClick - TBD.
+   * @returns {boolean} TBD.
+   */
   processInteractiveObjects(fromClick = false) {
     // Work out which object is on the top
     let highestRenderOrderID = 0;
@@ -253,10 +275,7 @@ export class Pointer {
     // (A node that was previously checked did not request a pixel-perfect check.)
     currentNode = this.game.input.interactiveItems.first;
     while (currentNode) {
-      if (
-        !currentNode.checked &&
-        currentNode.validForInput(highestInputPriorityID, highestRenderOrderID, true)
-      ) {
+      if (!currentNode.checked && currentNode.validForInput(highestInputPriorityID, highestRenderOrderID, true)) {
         if (
           (fromClick && currentNode.checkPointerDown(this, false)) ||
           (!fromClick && currentNode.checkPointerOver(this, false))
@@ -281,6 +300,11 @@ export class Pointer {
     return this.targetObject !== null;
   }
 
+  /**
+   * TBD.
+   * @param newTarget - TBD.
+   * @param {boolean} silent - TBD.
+   */
   swapTarget(newTarget, silent = false) {
     //  Now we know the top-most item (if any) we can process it
     if (newTarget === null) {
@@ -308,11 +332,20 @@ export class Pointer {
     }
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent|PointerEvent} event - TBD.
+   */
   leave(event) {
     this.withinGame = false;
     this.move(event, false);
   }
 
+  /**
+   * TBD.
+   * @param {MouseEvent|PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
+   */
   stop(event) {
     const input = this.game.input;
     if (this._stateReset && this.withinGame) {
@@ -364,16 +397,33 @@ export class Pointer {
     return this;
   }
 
+  /**
+   * TBD.
+   * @param {number} duration - TBD.
+   * @returns {boolean} TBD.
+   */
   justPressed(duration) {
     duration = duration || this.game.input.justPressedRate;
     return this.isDown === true && this.timeDown + duration > this.game.time.time;
   }
 
+  /**
+   * TBD.
+   * @param {number} duration - TBD.
+   * @returns {boolean} TBD.
+   */
   justReleased(duration) {
     duration = duration || this.game.input.justReleasedRate;
     return this.isUp && this.timeUp + duration > this.game.time.time;
   }
 
+  /**
+   * TBD.
+   * @param {string} name - TBD.
+   * @param {Function} callback - TBD.
+   * @param {object} callbackContext - TBD.
+   * @param callbackArgs - TBD.
+   */
   addClickTrampoline(name, callback, callbackContext, callbackArgs) {
     if (!this.isDown) {
       return;
@@ -395,6 +445,9 @@ export class Pointer {
     });
   }
 
+  /**
+   * TBD.
+   */
   processClickTrampolines() {
     const trampolines = this._clickTrampolines;
     if (!trampolines) {
@@ -410,6 +463,9 @@ export class Pointer {
     this._trampolineTargetObject = null;
   }
 
+  /**
+   * TBD.
+   */
   reset() {
     if (this.isMouse === false) {
       this.active = false;
@@ -428,11 +484,18 @@ export class Pointer {
     this.targetObject = null;
   }
 
+  /**
+   * TBD.
+   */
   resetMovement() {
     this.movementX = 0;
     this.movementY = 0;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get duration() {
     if (this.isUp) {
       return -1;
@@ -440,10 +503,18 @@ export class Pointer {
     return this.game.time.time - this.timeDown;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get worldX() {
     return this.x;
   }
 
+  /**
+   * TBD.
+   * @returns {number} TBD.
+   */
   get worldY() {
     return this.y;
   }

package/src/phaser/core/input_touch.js

@@ -1,10 +1,10 @@
-/**
- * @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';
 
 export class Touch {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this.enabled = true;
@@ -26,6 +26,9 @@ export class Touch {
     this._onTouchMove = null;
   }
 
+  /**
+   * TBD.
+   */
   start() {
     if (!this.game.device.touch || this._onTouchStart !== null) {
       return;
@@ -45,6 +48,9 @@ export class Touch {
     this.game.canvas.addEventListener('touchleave', this._onTouchLeave, false);
   }
 
+  /**
+   * TBD.
+   */
   stop() {
     if (!this.game.device.touch) {
       return;
@@ -57,6 +63,9 @@ export class Touch {
     this.game.canvas.removeEventListener('touchcancel', this._onTouchCancel);
   }
 
+  /**
+   * TBD.
+   */
   consumeDocumentTouches() {
     this._documentTouchMove = (event) => {
       event.preventDefault();
@@ -64,6 +73,10 @@ export class Touch {
     document.addEventListener('touchmove', this._documentTouchMove, false);
   }
 
+  /**
+   * TBD.
+   * @param {TouchEvent} event - TBD.
+   */
   onTouchStart(event) {
     this.event = event;
     if (!this.game.input.enabled || !this.enabled) {
@@ -81,6 +94,10 @@ export class Touch {
     }
   }
 
+  /**
+   * TBD.
+   * @param {TouchEvent} event - TBD.
+   */
   onTouchCancel(event) {
     this.event = event;
     if (this.touchCancelCallback) {
@@ -97,6 +114,10 @@ export class Touch {
     }
   }
 
+  /**
+   * TBD.
+   * @param {TouchEvent} event - TBD.
+   */
   onTouchEnter(event) {
     this.event = event;
     if (this.touchEnterCallback) {
@@ -108,6 +129,10 @@ export class Touch {
     this.eventPreventDefault(event);
   }
 
+  /**
+   * TBD.
+   * @param {TouchEvent} event - TBD.
+   */
   onTouchLeave(event) {
     this.event = event;
     if (this.touchLeaveCallback) {
@@ -116,6 +141,10 @@ export class Touch {
     this.eventPreventDefault(event);
   }
 
+  /**
+   * TBD.
+   * @param {TouchEvent} event - TBD.
+   */
   onTouchMove(event) {
     this.event = event;
     if (this.touchMoveCallback) {
@@ -127,6 +156,10 @@ export class Touch {
     }
   }
 
+  /**
+   * TBD.
+   * @param {TouchEvent} event - TBD.
+   */
   onTouchEnd(event) {
     this.event = event;
     if (this.touchEndCallback) {
@@ -141,6 +174,10 @@ export class Touch {
     }
   }
 
+  /**
+   * TBD.
+   * @param {TouchEvent} event - TBD.
+   */
   eventPreventDefault(event) {
     if (this.preventDefault) {
       if (typeof event.cancelable !== 'boolean' || event.cancelable) {