@vpmedia/phaser 1.17.0 → 1.19.0

package/src/phaser/core/input.js

@@ -1,5 +1,6 @@
 import { ArraySet } from './array_set';
 import { Graphics } from '../display/graphics';
+import { DisplayObject } from '../display/display_object';
 import { Image } from '../display/image';
 import { Signal } from './signal';
 import { Point } from '../geom/point';
@@ -125,7 +126,7 @@ export class Input {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param context - TBD.
+   * @param {object} context - TBD.
    */
   setInteractiveCandidateHandler(callback, context) {
     this.customCandidateHandler = callback;
@@ -135,7 +136,7 @@ export class Input {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param context - TBD.
+   * @param {object} context - TBD.
    */
   addMoveCallback(callback, context) {
     this.moveCallbacks.push({ callback, context });
@@ -144,7 +145,7 @@ export class Input {
   /**
    * TBD.
    * @param {Function} callback - TBD.
-   * @param context - TBD.
+   * @param {object} context - TBD.
    */
   deleteMoveCallback(callback, context) {
     let i = this.moveCallbacks.length;
@@ -298,7 +299,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param limit - TBD.
+   * @param {number} limit - TBD.
    * @returns {number} TBD.
    */
   countActivePointers(limit = this.pointers.length) {
@@ -329,7 +330,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param identifier - TBD.
+   * @param {number} identifier - TBD.
    * @returns {Pointer} TBD.
    */
   getPointerFromIdentifier(identifier) {
@@ -345,7 +346,7 @@ export class Input {
 
   /**
    * TBD.
-   * @param pointerId - TBD.
+   * @param {number} pointerId - TBD.
    * @returns {Pointer} TBD.
    */
   getPointerFromId(pointerId) {
@@ -361,9 +362,9 @@ export class Input {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param pointer - TBD.
-   * @param output - TBD.
+   * @param {DisplayObject} displayObject - TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {Point} output - TBD.
    * @returns {Point} TBD.
    */
   getLocalPosition(displayObject, pointer, output = null) {
@@ -378,9 +379,9 @@ export class Input {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param pointer - TBD.
-   * @param localPoint - TBD.
+   * @param {DisplayObject} displayObject - TBD.
+   * @param {Pointer} pointer - TBD.
+   * @param {Point} localPoint - TBD.
    * @returns {boolean} TBD.
    */
   hitTest(displayObject, pointer, localPoint) {

package/src/phaser/core/input_handler.js

@@ -3,12 +3,13 @@ import { GROUP } from './const';
 import { distance } from '../util/math';
 import { Pointer } from './input_pointer';
 import { Rectangle } from '../geom/rectangle';
+import { Image } from '../display/image';
 import { DisplayObject } from '../display/display_object';
 
 export class InputHandler {
   /**
    * TBD.
-   * @param sprite
+   * @param {Image} sprite - TBD.
    */
   constructor(sprite) {
     this.sprite = sprite;

package/src/phaser/core/input_mouse.js

@@ -12,8 +12,8 @@ import { Game } from './game';
 class WheelEventProxy {
   /**
    * TBD.
-   * @param scaleFactor - TBD.
-   * @param deltaMode - TBD.
+   * @param {number} scaleFactor - TBD.
+   * @param {number} deltaMode - TBD.
    */
   constructor(scaleFactor, deltaMode) {
     this._scaleFactor = scaleFactor;
@@ -48,6 +48,7 @@ class WheelEventProxy {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get deltaMode() {
     return this._deltaMode;

package/src/phaser/core/input_mspointer.js

@@ -83,7 +83,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param {Event} event - TBD.
+   * @param {PointerEvent} event - TBD.
    */
   onPointerDown(event) {
     this.event = event;
@@ -104,7 +104,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param {Event} event - TBD.
+   * @param {PointerEvent} event - TBD.
    */
   onPointerMove(event) {
     this.event = event;
@@ -125,7 +125,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param {Event} event - TBD.
+   * @param {PointerEvent} event - TBD.
    */
   onPointerUp(event) {
     this.event = event;
@@ -146,7 +146,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param {Event} event - TBD.
+   * @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} event - TBD.
+   * @param {PointerEvent} event - TBD.
    */
   onPointerOut(event) {
     this.event = event;
@@ -193,7 +193,7 @@ export class MSPointer {
 
   /**
    * TBD.
-   * @param {Event} event - TBD.
+   * @param {PointerEvent} event - TBD.
    */
   onPointerOver(event) {
     this.event = event;

package/src/phaser/core/input_pointer.js

@@ -9,6 +9,7 @@ import {
   MOUSE_TOUCH_COMBINE,
 } from './const';
 import { Game } from './game';
+import { InputHandler } from './input_handler';
 
 export class Pointer {
   /**
@@ -302,7 +303,7 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param newTarget - TBD.
+   * @param {InputHandler} newTarget - TBD.
    * @param {boolean} silent - TBD.
    */
   swapTarget(newTarget, silent = false) {
@@ -422,7 +423,7 @@ export class Pointer {
    * @param {string} name - TBD.
    * @param {Function} callback - TBD.
    * @param {object} callbackContext - TBD.
-   * @param callbackArgs - TBD.
+   * @param {...any} callbackArgs - TBD.
    */
   addClickTrampoline(name, callback, callbackContext, callbackArgs) {
     if (!this.isDown) {

package/src/phaser/core/loader.js

@@ -1,5 +1,6 @@
 import { Signal } from './signal';
 import { Rectangle } from '../geom/rectangle';
+import { Image } from '../display/image';
 import { canPlayAudio } from './device_util';
 import { Game } from './game';
 
@@ -47,8 +48,8 @@ export class Loader {
 
   /**
    * TBD.
-   * @param sprite - TBD.
-   * @param direction - TBD.
+   * @param {Image} sprite - TBD.
+   * @param {number} direction - TBD.
    */
   setPreloadSprite(sprite, direction = 0) {
     this.preloadSprite = {
@@ -80,7 +81,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @returns {boolean} TBD.
    */
@@ -90,7 +91,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @returns {number} TBD.
    */
@@ -112,7 +113,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @returns {object} TBD.
    */
@@ -126,10 +127,10 @@ export class Loader {
 
   /**
    * TBD.
-   * @param hard
-   * @param clearEvents
+   * @param {boolean} hard - TBD.
+   * @param {boolean} clearEvents - TBD.
    */
-  reset(hard, clearEvents = false) {
+  reset(hard = false, clearEvents = false) {
     if (hard) {
       this.preloadSprite = null;
     }
@@ -154,12 +155,12 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param properties - TBD.
-   * @param overwrite - TBD.
-   * @param extension - TBD.
+   * @param {object} properties - TBD.
+   * @param {boolean} overwrite - TBD.
+   * @param {string} extension - TBD.
    * @returns {Loader} TBD.
    */
   addToFileList(type, key = '', url = null, properties = null, overwrite = false, extension = null) {
@@ -211,10 +212,10 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param properties - TBD.
+   * @param {object} properties - TBD.
    * @returns {Loader} TBD.
    */
   replaceInFileList(type, key, url, properties) {
@@ -225,7 +226,7 @@ export class Loader {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param data - TBD.
+   * @param {object} data - TBD.
    * @param {object} callbackContext - TBD.
    * @returns {Loader} TBD.
    */
@@ -264,17 +265,17 @@ export class Loader {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param overwrite - TBD.
+   * @param {boolean} overwrite - TBD.
    * @returns {Loader} TBD.
    */
-  image(key, url, overwrite) {
+  image(key, url, overwrite = false) {
     return this.addToFileList('image', key, url, undefined, overwrite, '.png');
   }
 
   /**
    * TBD.
-   * @param keys - TBD.
-   * @param urls - TBD.
+   * @param {string[]} keys - TBD.
+   * @param {string[]} urls - TBD.
    * @returns {Loader} TBD.
    */
   images(keys, urls) {
@@ -294,7 +295,7 @@ export class Loader {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param overwrite - TBD.
+   * @param {boolean} overwrite - TBD.
    * @returns {Loader} TBD.
    */
   text(key, url, overwrite) {
@@ -305,7 +306,7 @@ export class Loader {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param overwrite - TBD.
+   * @param {boolean} overwrite - TBD.
    * @returns {Loader} TBD.
    */
   json(key, url, overwrite) {
@@ -316,7 +317,7 @@ export class Loader {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param overwrite - TBD.
+   * @param {boolean} overwrite - TBD.
    * @returns {Loader} TBD.
    */
   xml(key, url, overwrite) {
@@ -327,11 +328,11 @@ export class Loader {
    * TBD.
    * @param {string} key - TBD.
    * @param {string} url - TBD.
-   * @param frameWidth - TBD.
-   * @param frameHeight - TBD.
-   * @param frameMax - TBD.
-   * @param margin - TBD.
-   * @param spacing - TBD.
+   * @param {number} frameWidth - TBD.
+   * @param {number} frameHeight - TBD.
+   * @param {number} frameMax - TBD.
+   * @param {number} margin - TBD.
+   * @param {number} spacing - TBD.
    * @returns {Loader} TBD.
    */
   spritesheet(key, url, frameWidth, frameHeight, frameMax = -1, margin = 0, spacing = 0) {
@@ -348,8 +349,8 @@ export class Loader {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param urls
-   * @param autoDecode
+   * @param {string[]} urls - TBD.
+   * @param {boolean} autoDecode - TBD.
    * @returns {Loader} TBD.
    */
   audio(key, urls, autoDecode = true) {
@@ -365,10 +366,10 @@ export class Loader {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param urls - TBD.
-   * @param jsonURL - TBD.
-   * @param jsonData - TBD.
-   * @param autoDecode - TBD.
+   * @param {string} urls - TBD.
+   * @param {string} jsonURL - TBD.
+   * @param {object} jsonData - TBD.
+   * @param {boolean} autoDecode - TBD.
    * @returns {Loader} TBD.
    */
   audioSprite(key, urls, jsonURL, jsonData, autoDecode = true) {
@@ -390,11 +391,11 @@ export class Loader {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param textureURL - TBD.
-   * @param atlasURL - TBD.
-   * @param atlasData - TBD.
-   * @param xSpacing - TBD.
-   * @param ySpacing - TBD.
+   * @param {string} textureURL - TBD.
+   * @param {string} atlasURL - TBD.
+   * @param {object} atlasData - TBD.
+   * @param {number} xSpacing - TBD.
+   * @param {number} ySpacing - TBD.
    * @returns {Loader} TBD.
    * @throws Error.
    */
@@ -434,10 +435,10 @@ export class Loader {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param textureURL - TBD.
-   * @param atlasURL - TBD.
-   * @param atlasData - TBD.
-   * @param format - TBD.
+   * @param {string} textureURL - TBD.
+   * @param {string} atlasURL - TBD.
+   * @param {object} atlasData - TBD.
+   * @param {number} format - TBD.
    * @returns {Loader} TBD.
    */
   atlas(key, textureURL, atlasURL = null, atlasData = null, format = TEXTURE_ATLAS_JSON_HASH) {
@@ -474,7 +475,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @returns {Loader} TBD.
    */
@@ -488,7 +489,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    */
   removeFile(type, key) {
@@ -621,7 +622,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param abnormal - TBD.
+   * @param {boolean} abnormal - TBD.
    */
   finishedLoading(abnormal) {
     if (this.hasLoaded) {
@@ -644,8 +645,8 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
-   * @param errorMessage - TBD.
+   * @param {object} file - TBD.
+   * @param {string} errorMessage - TBD.
    */
   asyncComplete(file, errorMessage = '') {
     file.loaded = true;
@@ -660,7 +661,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param pack - TBD.
+   * @param {object} pack - TBD.
    */
   processPack(pack) {
     const packData = pack.data[pack.key];
@@ -724,7 +725,7 @@ export class Loader {
   /**
    * TBD.
    * @param {string} url - TBD.
-   * @param file - TBD.
+   * @param {object} file - TBD.
    * @returns {string} TBD.
    */
   transformUrl(url, file) {
@@ -739,7 +740,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
+   * @param {object} file - TBD.
    */
   loadFile(file) {
     switch (file.type) {
@@ -777,7 +778,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
+   * @param {object} file - TBD.
    */
   loadImageTag(file) {
     this.log('loadImageTag', file);
@@ -809,13 +810,13 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
+   * @param {object} file - TBD.
    * @param {string} url - TBD.
-   * @param type - TBD.
-   * @param onload - TBD.
-   * @param onerror - TBD.
+   * @param {string} type - TBD.
+   * @param {Function} onload - TBD.
+   * @param {Function} onerror - TBD.
    */
-  xhrLoad(file, url, type, onload, onerror) {
+  xhrLoad(file, url, type, onload, onerror = null) {
     this.log('xhrLoad', file);
     const scope = this;
     const xhr = new XMLHttpRequest();
@@ -884,7 +885,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param urls - TBD.
+   * @param {object[]} urls - TBD.
    * @returns {string} TBD.
    */
   getAudioURL(urls) {
@@ -922,9 +923,9 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
-   * @param xhr - TBD.
-   * @param reason - TBD.
+   * @param {object} file - TBD.
+   * @param {XMLHttpRequest} xhr - TBD.
+   * @param {number} reason - TBD.
    */
   fileError(file, xhr, reason) {
     // const url = file.requestUrl || this.transformUrl(file.url, file);
@@ -940,8 +941,8 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
-   * @param xhr - TBD.
+   * @param {object} file - TBD.
+   * @param {XMLHttpRequest} xhr - TBD.
    * @throws Error.
    */
   fileComplete(file, xhr) {
@@ -1032,8 +1033,8 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
-   * @param xhr - TBD.
+   * @param {object} file - TBD.
+   * @param {XMLHttpRequest} xhr - TBD.
    */
   jsonLoadComplete(file, xhr) {
     const data = JSON.parse(xhr.responseText);
@@ -1057,8 +1058,8 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
-   * @param xhr - TBD.
+   * @param {object} file - TBD.
+   * @param {XMLHttpRequest} xhr - TBD.
    */
   xmlLoadComplete(file, xhr) {
     // Always try parsing the content as XML, regardless of actually response type
@@ -1082,7 +1083,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param data - TBD.
+   * @param {object} data - TBD.
    * @returns {Document} TBD.
    */
   parseXml(data) {
@@ -1127,8 +1128,8 @@ export class Loader {
 
   /**
    * TBD.
-   * @param message - TBD.
-   * @param data - TBD.
+   * @param {string} message - TBD.
+   * @param {string|object} data - TBD.
    */
   log(message, data = '') {
     if (!this.isUseLog) {