@vpmedia/phaser 1.20.0 → 1.22.0

package/src/phaser/core/input_handler.js

@@ -1,14 +1,11 @@
 import { Point } from '../geom/point';
 import { GROUP } from './const';
 import { distance } from '../util/math';
-import { Pointer } from './input_pointer';
-import { Rectangle } from '../geom/rectangle';
-import { DisplayObject } from '../display/display_object';
 
 export class InputHandler {
   /**
    * TBD.
-   * @param sprite
+   * @param {Image} sprite - TBD.
    */
   constructor(sprite) {
     this.sprite = sprite;
@@ -75,7 +72,7 @@ export class InputHandler {
    * TBD.
    * @param {number} priority - TBD.
    * @param {boolean} useHandCursor - TBD.
-   * @returns {DisplayObject} TBD.
+   * @returns {import('../display/display_object').DisplayObject} TBD.
    */
   start(priority = 0, useHandCursor = false) {
     //  Turning on
@@ -346,7 +343,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} fastTest - TBD.
    * @returns {boolean} TBD.
    */
@@ -375,7 +372,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} fastTest - TBD.
    * @returns {boolean} TBD.
    */
@@ -405,7 +402,7 @@ export class InputHandler {
    * TBD.
    * @param {number} x - TBD.
    * @param {number} y - TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @returns {boolean} TBD.
    */
   checkPixel(x, y, pointer) {
@@ -454,7 +451,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @returns {boolean} TBD.
    */
   update(pointer) {
@@ -491,7 +488,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} silent - TBD.
    */
   _pointerOverHandler(pointer, silent) {
@@ -522,7 +519,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} silent - TBD.
    */
   _pointerOutHandler(pointer, silent = false) {
@@ -548,7 +545,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   _touchedHandler(pointer) {
     if (this.sprite === null) {
@@ -600,7 +597,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   dragTimeElapsed(pointer) {
     this._dragTimePass = true;
@@ -613,7 +610,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   _releasedHandler(pointer) {
     if (this.sprite === null) {
@@ -661,7 +658,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    * @param {boolean} fromStart - TBD.
    * @returns {boolean} TBD.
    */
@@ -769,8 +766,8 @@ export class InputHandler {
    * @param {boolean} bringToTop - TBD.
    * @param {boolean} pixelPerfect - TBD.
    * @param {number} alphaThreshold - TBD.
-   * @param {Rectangle} boundsRect - TBD.
-   * @param {DisplayObject} boundsSprite - TBD.
+   * @param {import('../geom/rectangle').Rectangle} boundsRect - TBD.
+   * @param {import('../display/display_object').DisplayObject} boundsSprite - TBD.
    */
   enableDrag(
     lockCenter = false,
@@ -812,7 +809,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   startDrag(pointer) {
     const x = this.sprite.x;
@@ -869,7 +866,7 @@ export class InputHandler {
 
   /**
    * TBD.
-   * @param {Pointer} pointer - TBD.
+   * @param {import('./input_pointer').Pointer} pointer - TBD.
    */
   stopDrag(pointer) {
     this.isDragged = false;

package/src/phaser/core/input_mouse.js

@@ -7,13 +7,11 @@ 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.
+   * @param {number} scaleFactor - TBD.
+   * @param {number} deltaMode - TBD.
    */
   constructor(scaleFactor, deltaMode) {
     this._scaleFactor = scaleFactor;
@@ -48,6 +46,7 @@ class WheelEventProxy {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get deltaMode() {
     return this._deltaMode;
@@ -73,7 +72,7 @@ class WheelEventProxy {
 export class Mouse {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/input_mspointer.js

@@ -1,9 +1,7 @@
-import { Game } from './game';
-
 export class MSPointer {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/input_pointer.js

@@ -8,12 +8,11 @@ import {
   TOUCH_OVERRIDES_MOUSE,
   MOUSE_TOUCH_COMBINE,
 } from './const';
-import { Game } from './game';
 
 export class Pointer {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {number} id - TBD.
    * @param {number} pointerMode - TBD.
    */
@@ -302,7 +301,7 @@ export class Pointer {
 
   /**
    * TBD.
-   * @param newTarget - TBD.
+   * @param {import('./input_handler').InputHandler} newTarget - TBD.
    * @param {boolean} silent - TBD.
    */
   swapTarget(newTarget, silent = false) {

package/src/phaser/core/input_touch.js

@@ -1,9 +1,7 @@
-import { Game } from './game';
-
 export class Touch {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/loader.js

@@ -1,14 +1,13 @@
 import { Signal } from './signal';
 import { Rectangle } from '../geom/rectangle';
 import { canPlayAudio } from './device_util';
-import { Game } from './game';
 
 const TEXTURE_ATLAS_JSON_HASH = 1;
 
 export class Loader {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;
@@ -47,8 +46,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 +79,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @returns {boolean} TBD.
    */
@@ -90,7 +89,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @returns {number} TBD.
    */
@@ -112,7 +111,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @returns {object} TBD.
    */
@@ -126,10 +125,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 +153,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 +210,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 +224,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 +263,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 +293,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 +304,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 +315,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 +326,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 +347,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 +364,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 +389,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 +433,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 +473,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    * @returns {Loader} TBD.
    */
@@ -488,7 +487,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param type - TBD.
+   * @param {string} type - TBD.
    * @param {string} key - TBD.
    */
   removeFile(type, key) {
@@ -621,7 +620,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param abnormal - TBD.
+   * @param {boolean} abnormal - TBD.
    */
   finishedLoading(abnormal) {
     if (this.hasLoaded) {
@@ -644,8 +643,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 +659,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param pack - TBD.
+   * @param {object} pack - TBD.
    */
   processPack(pack) {
     const packData = pack.data[pack.key];
@@ -724,7 +723,7 @@ export class Loader {
   /**
    * TBD.
    * @param {string} url - TBD.
-   * @param file - TBD.
+   * @param {object} file - TBD.
    * @returns {string} TBD.
    */
   transformUrl(url, file) {
@@ -739,7 +738,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
+   * @param {object} file - TBD.
    */
   loadFile(file) {
     switch (file.type) {
@@ -777,7 +776,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param file - TBD.
+   * @param {object} file - TBD.
    */
   loadImageTag(file) {
     this.log('loadImageTag', file);
@@ -809,13 +808,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 +883,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param urls - TBD.
+   * @param {object[]} urls - TBD.
    * @returns {string} TBD.
    */
   getAudioURL(urls) {
@@ -922,9 +921,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 +939,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 +1031,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 +1056,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 +1081,7 @@ export class Loader {
 
   /**
    * TBD.
-   * @param data - TBD.
+   * @param {object} data - TBD.
    * @returns {Document} TBD.
    */
   parseXml(data) {
@@ -1127,8 +1126,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) {

package/src/phaser/core/raf.js

@@ -1,9 +1,7 @@
-import { Game } from './game';
-
 export class RequestAnimationFrame {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    */
   constructor(game) {
     this.game = game;

package/src/phaser/core/scale_manager.js

@@ -3,12 +3,11 @@ import { DOM } from './dom';
 import { Point } from '../geom/point';
 import { Rectangle } from '../geom/rectangle';
 import { SCALE_OFF, SCALE_RESIZE, SCALE_EXACT_FIT, SCALE_USER, SCALE_SHOW_ALL, RENDER_CANVAS } from './const';
-import { Game } from './game';
 
 export class ScaleManager {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
    */

package/src/phaser/core/scene_manager.js

@@ -1,10 +1,9 @@
-import { Game } from './game';
 import { Scene } from './scene';
 
 export class SceneManager {
   /**
    * TBD.
-   * @param {Game} game - TBD.
+   * @param {import('./game').Game} game - TBD.
    * @param {string} pendingState - TBD.
    */
   constructor(game, pendingState) {
@@ -40,7 +39,7 @@ export class SceneManager {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param state - TBD.
+   * @param {object} state - TBD.
    * @param {boolean} autoStart - TBD.
    * @returns {Scene|object} TBD.
    */