@vpmedia/phaser 1.16.0 → 1.18.0

package/src/phaser/core/factory.js

@@ -20,8 +20,8 @@ export class GameObjectFactory {
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.
-   * @param frame - TBD.
-   * @param group - TBD.
+   * @param {string} frame - TBD.
+   * @param {Group} group - TBD.
    * @returns {Image} TBD.
    */
   image(x, y, key, frame, group = null) {
@@ -33,9 +33,9 @@ export class GameObjectFactory {
 
   /**
    * TBD.
-   * @param parent - TBD.
-   * @param name - TBD.
-   * @param addToStage - TBD.
+   * @param {Group} parent - TBD.
+   * @param {string} name - TBD.
+   * @param {boolean} addToStage - TBD.
    * @returns {Group} TBD.
    */
   group(parent, name, addToStage) {
@@ -46,9 +46,9 @@ export class GameObjectFactory {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param text - TBD.
-   * @param style - TBD.
-   * @param group - TBD.
+   * @param {string} text - TBD.
+   * @param {object} style - TBD.
+   * @param {Group} group - TBD.
    * @returns {Text} TBD.
    */
   text(x, y, text, style, group = null) {
@@ -61,13 +61,13 @@ export class GameObjectFactory {
    * @param {number} x - TBD.
    * @param {number} y - TBD.
    * @param {string} key - TBD.
-   * @param callback - TBD.
-   * @param callbackContext - TBD.
-   * @param overFrame - TBD.
-   * @param outFrame - TBD.
-   * @param downFrame - TBD.
-   * @param upFrame - TBD.
-   * @param group - TBD.
+   * @param {Function} callback - TBD.
+   * @param {object} callbackContext - TBD.
+   * @param {string} overFrame - TBD.
+   * @param {string} outFrame - TBD.
+   * @param {string} downFrame - TBD.
+   * @param {string} upFrame - TBD.
+   * @param {Group} group - TBD.
    * @returns {Button} TBD.
    */
   button(x, y, key, callback, callbackContext, overFrame, outFrame, downFrame, upFrame, group = null) {
@@ -81,7 +81,7 @@ export class GameObjectFactory {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param group - TBD.
+   * @param {Group} group - TBD.
    * @returns {Graphics} TBD.
    */
   graphics(x, y, group = null) {
@@ -93,11 +93,11 @@ export class GameObjectFactory {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param font - TBD.
-   * @param text - TBD.
-   * @param size - TBD.
-   * @param group - TBD.
-   * @param align - TBD.
+   * @param {string} font - TBD.
+   * @param {string} text - TBD.
+   * @param {number} size - TBD.
+   * @param {Group} group - TBD.
+   * @param {string} align - TBD.
    * @returns {BitmapText} TBD.
    */
   bitmapText(x, y, font, text, size, group = null, align = 'left') {

package/src/phaser/core/frame_data.js

@@ -91,7 +91,7 @@ export class FrameData {
 
   /**
    * TBD.
-   * @param {string[]} frames - TBD.
+   * @param {number[]|string[]} frames - TBD.
    * @param {boolean} useNumericIndex - TBD.
    * @param {number[]} output - TBD.
    * @returns {number[]} TBD.

package/src/phaser/core/game.js

@@ -35,6 +35,7 @@ export class Game {
     this.renderer = null;
     this.state = null;
     this.isBooted = false;
+    this.paused = false;
     this.raf = null;
     this.add = null;
     this.cache = null;

package/src/phaser/core/input.js

@@ -124,8 +124,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param callback - TBD.
-   * @param context
+   * @param {Function} callback - TBD.
+   * @param context - TBD.
    */
   setInteractiveCandidateHandler(callback, context) {
     this.customCandidateHandler = callback;
@@ -134,8 +134,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param callback - TBD.
-   * @param context
+   * @param {Function} callback - TBD.
+   * @param context - TBD.
    */
   addMoveCallback(callback, context) {
     this.moveCallbacks.push({ callback, context });
@@ -143,8 +143,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param callback - TBD.
-   * @param context
+   * @param {Function} callback - TBD.
+   * @param context - TBD.
    */
   deleteMoveCallback(callback, context) {
     let i = this.moveCallbacks.length;
@@ -159,6 +159,7 @@ export class Input {
 
   /**
    * TBD.
+   * @returns {Pointer} TBD.
    */
   addPointer() {
     if (this.pointers.length >= MAX_POINTERS) {
@@ -192,7 +193,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param hard
+   * @param {boolean} hard - TBD.
    */
   reset(hard = false) {
     if (!this.game.isBooted || this.resetLocked) {
@@ -231,7 +232,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
    */
   startPointer(event) {
     if (this.maxPointers >= 0 && this.countActivePointers(this.maxPointers) >= this.maxPointers) {
@@ -254,7 +256,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
    */
   updatePointer(event) {
     if (this.pointer1.active && this.pointer1.identifier === event.identifier) {
@@ -274,7 +277,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent|TouchEvent|PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
    */
   stopPointer(event) {
     if (this.pointer1.active && this.pointer1.identifier === event.identifier) {
@@ -294,7 +298,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param limit
+   * @param limit - TBD.
+   * @returns {number} TBD.
    */
   countActivePointers(limit = this.pointers.length) {
     let count = limit;
@@ -309,7 +314,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param isActive
+   * @param {boolean} isActive - TBD.
+   * @returns {Pointer} TBD.
    */
   getPointer(isActive = false) {
     for (let i = 0; i < this.pointers.length; i += 1) {
@@ -323,7 +329,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param identifier
+   * @param identifier - TBD.
+   * @returns {Pointer} TBD.
    */
   getPointerFromIdentifier(identifier) {
     for (let i = 0; i < this.pointers.length; i += 1) {
@@ -338,7 +345,8 @@ export class Input {
 
   /**
    * TBD.
-   * @param pointerId
+   * @param pointerId - TBD.
+   * @returns {Pointer} TBD.
    */
   getPointerFromId(pointerId) {
     for (let i = 0; i < this.pointers.length; i += 1) {
@@ -353,9 +361,10 @@ export class Input {
 
   /**
    * TBD.
-   * @param displayObject
-   * @param pointer
-   * @param output
+   * @param displayObject - TBD.
+   * @param pointer - TBD.
+   * @param output - TBD.
+   * @returns {Point} TBD.
    */
   getLocalPosition(displayObject, pointer, output = null) {
     const result = output || new Point();
@@ -369,9 +378,10 @@ export class Input {
 
   /**
    * TBD.
-   * @param displayObject
-   * @param pointer
-   * @param localPoint
+   * @param displayObject - TBD.
+   * @param pointer - TBD.
+   * @param localPoint - TBD.
+   * @returns {boolean} TBD.
    */
   hitTest(displayObject, pointer, localPoint) {
     if (!displayObject.worldVisible) {
@@ -418,6 +428,7 @@ export class Input {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get x() {
     return this._x;
@@ -432,6 +443,7 @@ export class Input {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get y() {
     return this._y;
@@ -446,6 +458,7 @@ export class Input {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   get pollLocked() {
     return this.pollRate > 0 && this._pollCounter < this.pollRate;
@@ -453,6 +466,7 @@ export class Input {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get totalInactivePointers() {
     return this.pointers.length - this.countActivePointers();
@@ -460,6 +474,7 @@ export class Input {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get totalActivePointers() {
     return this.countActivePointers();
@@ -467,6 +482,7 @@ export class Input {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get worldX() {
     return this.x;
@@ -474,6 +490,7 @@ export class Input {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get worldY() {
     return this.y;

package/src/phaser/core/input_handler.js

@@ -525,7 +525,7 @@ export class InputHandler {
    * @param {Pointer} pointer - TBD.
    * @param {boolean} silent - TBD.
    */
-  _pointerOutHandler(pointer, silent) {
+  _pointerOutHandler(pointer, silent = false) {
     if (this.sprite === null) {
       // Abort. We've been destroyed.
       return;

package/src/phaser/core/input_mouse.js

@@ -12,8 +12,8 @@ import { Game } from './game';
 class WheelEventProxy {
   /**
    * TBD.
-   * @param scaleFactor
-   * @param deltaMode
+   * @param scaleFactor - TBD.
+   * @param deltaMode - TBD.
    */
   constructor(scaleFactor, deltaMode) {
     this._scaleFactor = scaleFactor;
@@ -25,7 +25,8 @@ class WheelEventProxy {
 
   /**
    * TBD.
-   * @param event
+   * @param {WheelEvent} event - TBD.
+   * @returns {WheelEventProxy} TBD.
    */
   bindEvent(event) {
     // TODO
@@ -54,6 +55,7 @@ class WheelEventProxy {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get deltaY() {
     return this._scaleFactor * (this.originalEvent.wheelDelta || this.originalEvent.detail) || 0;
@@ -61,6 +63,7 @@ class WheelEventProxy {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get deltaX() {
     return this._scaleFactor * this.originalEvent.wheelDeltaX || 0;
@@ -81,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;
@@ -152,7 +156,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent} event - TBD.
    */
   onMouseDown(event) {
     this.event = event;
@@ -169,7 +173,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent} event - TBD.
    */
   onMouseMove(event) {
     this.event = event;
@@ -186,7 +190,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent} event - TBD.
    */
   onMouseUp(event) {
     this.event = event;
@@ -203,7 +207,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent} event - TBD.
    */
   onMouseUpGlobal(event) {
     if (!this.input.mousePointer.withinGame) {
@@ -217,7 +221,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent} event - TBD.
    */
   onMouseOutGlobal(event) {
     this.event = event;
@@ -236,7 +240,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent} event - TBD.
    */
   onMouseOut(event) {
     this.event = event;
@@ -256,7 +260,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent} event - TBD.
    */
   onMouseOver(event) {
     this.event = event;
@@ -269,7 +273,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {WheelEvent} event - TBD.
    */
   onMouseWheel(event) {
     if (this._wheelEvent) {
@@ -286,7 +290,7 @@ export class Mouse {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent} event - TBD.
    */
   eventPreventDefault(event) {
     if (this.capture) {

package/src/phaser/core/input_mspointer.js

@@ -83,7 +83,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {PointerEvent} event - TBD.
    */
   onPointerDown(event) {
     this.event = event;
@@ -104,7 +104,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {PointerEvent} event - TBD.
    */
   onPointerMove(event) {
     this.event = event;
@@ -125,7 +125,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {PointerEvent} event - TBD.
    */
   onPointerUp(event) {
     this.event = event;
@@ -146,7 +146,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {PointerEvent} event - TBD.
    */
   onPointerUpGlobal(event) {
     if ((event.pointerType === 'mouse' || event.pointerType === 0x00000004) && !this.input.mousePointer.withinGame) {
@@ -161,7 +161,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {PointerEvent} event - TBD.
    */
   onPointerOut(event) {
     this.event = event;
@@ -193,7 +193,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {PointerEvent} event - TBD.
    */
   onPointerOver(event) {
     this.event = event;
@@ -213,7 +213,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {Event} event - TBD.
    */
   eventPreventDefault(event) {
     if (this.capture) {

package/src/phaser/core/input_pointer.js

@@ -14,8 +14,8 @@ export class Pointer {
   /**
    * TBD.
    * @param {Game} game - TBD.
-   * @param id
-   * @param pointerMode
+   * @param {number} id - TBD.
+   * @param {number} pointerMode - TBD.
    */
   constructor(game, id, pointerMode) {
     this.game = game;
@@ -74,7 +74,7 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent|PointerEvent} event - TBD.
    */
   updateButtons(event) {
     if (event.type.toLowerCase().substr(-4) === 'down') {
@@ -88,7 +88,8 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
    */
   start(event) {
     const input = this.game.input;
@@ -175,8 +176,9 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param event
-   * @param fromClick
+   * @param {MouseEvent|PointerEvent} event - TBD.
+   * @param {boolean} fromClick - TBD.
+   * @returns {Pointer} TBD.
    */
   move(event, fromClick = false) {
     const input = this.game.input;
@@ -238,7 +240,8 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param fromClick
+   * @param {boolean} fromClick - TBD.
+   * @returns {boolean} TBD.
    */
   processInteractiveObjects(fromClick = false) {
     // Work out which object is on the top
@@ -299,8 +302,8 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param newTarget
-   * @param silent
+   * @param newTarget - TBD.
+   * @param {boolean} silent - TBD.
    */
   swapTarget(newTarget, silent = false) {
     //  Now we know the top-most item (if any) we can process it
@@ -331,7 +334,7 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent|PointerEvent} event - TBD.
    */
   leave(event) {
     this.withinGame = false;
@@ -340,7 +343,8 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param event
+   * @param {MouseEvent|PointerEvent} event - TBD.
+   * @returns {Pointer} TBD.
    */
   stop(event) {
     const input = this.game.input;
@@ -395,7 +399,8 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param duration - TBD.
+   * @param {number} duration - TBD.
+   * @returns {boolean} TBD.
    */
   justPressed(duration) {
     duration = duration || this.game.input.justPressedRate;
@@ -404,7 +409,8 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param duration - TBD.
+   * @param {number} duration - TBD.
+   * @returns {boolean} TBD.
    */
   justReleased(duration) {
     duration = duration || this.game.input.justReleasedRate;
@@ -413,10 +419,10 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param name
-   * @param callback - TBD.
-   * @param callbackContext
-   * @param callbackArgs
+   * @param {string} name - TBD.
+   * @param {Function} callback - TBD.
+   * @param {object} callbackContext - TBD.
+   * @param {...any} callbackArgs - TBD.
    */
   addClickTrampoline(name, callback, callbackContext, callbackArgs) {
     if (!this.isDown) {
@@ -488,6 +494,7 @@ export class Pointer {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get duration() {
     if (this.isUp) {
@@ -498,6 +505,7 @@ export class Pointer {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get worldX() {
     return this.x;
@@ -505,6 +513,7 @@ export class Pointer {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get worldY() {
     return this.y;

package/src/phaser/core/input_touch.js

@@ -75,7 +75,7 @@ export class Touch {
 
   /**
    * TBD.
-   * @param event
+   * @param {TouchEvent} event - TBD.
    */
   onTouchStart(event) {
     this.event = event;
@@ -96,7 +96,7 @@ export class Touch {
 
   /**
    * TBD.
-   * @param event
+   * @param {TouchEvent} event - TBD.
    */
   onTouchCancel(event) {
     this.event = event;
@@ -116,7 +116,7 @@ export class Touch {
 
   /**
    * TBD.
-   * @param event
+   * @param {TouchEvent} event - TBD.
    */
   onTouchEnter(event) {
     this.event = event;
@@ -131,7 +131,7 @@ export class Touch {
 
   /**
    * TBD.
-   * @param event
+   * @param {TouchEvent} event - TBD.
    */
   onTouchLeave(event) {
     this.event = event;
@@ -143,7 +143,7 @@ export class Touch {
 
   /**
    * TBD.
-   * @param event
+   * @param {TouchEvent} event - TBD.
    */
   onTouchMove(event) {
     this.event = event;
@@ -158,7 +158,7 @@ export class Touch {
 
   /**
    * TBD.
-   * @param event
+   * @param {TouchEvent} event - TBD.
    */
   onTouchEnd(event) {
     this.event = event;
@@ -176,7 +176,7 @@ export class Touch {
 
   /**
    * TBD.
-   * @param event
+   * @param {TouchEvent} event - TBD.
    */
   eventPreventDefault(event) {
     if (this.preventDefault) {