@vpmedia/phaser 1.20.0 → 1.21.0

package/src/phaser/core/loader.js

@@ -1,7 +1,6 @@
 import { Signal } from './signal';
 import { Rectangle } from '../geom/rectangle';
 import { canPlayAudio } from './device_util';
-import { Game } from './game';
 
 const TEXTURE_ATLAS_JSON_HASH = 1;
 
@@ -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,5 +1,3 @@
-import { Game } from './game';
-
 export class RequestAnimationFrame {
   /**
    * TBD.

package/src/phaser/core/scale_manager.js

@@ -3,7 +3,6 @@ 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 {
   /**

package/src/phaser/core/scene_manager.js

@@ -1,4 +1,3 @@
-import { Game } from './game';
 import { Scene } from './scene';
 
 export class SceneManager {
@@ -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.
    */

package/src/phaser/core/signal_binding.js

@@ -1,12 +1,12 @@
 export class SignalBinding {
   /**
    * TBD.
-   * @param signal
-   * @param listener
-   * @param isOnce
-   * @param listenerContext
-   * @param priority
-   * @param args - TBD.
+   * @param {Signal} signal - TBD.
+   * @param {Function} listener - TBD.
+   * @param {boolean} isOnce - TBD.
+   * @param {object} listenerContext - TBD.
+   * @param {number} priority - TBD.
+   * @param {...any} args - TBD.
    */
   constructor(signal, listener, isOnce = false, listenerContext = null, priority = 0, args = null) {
     this._signal = signal;
@@ -22,7 +22,8 @@ export class SignalBinding {
 
   /**
    * TBD.
-   * @param paramsArr
+   * @param {any[]} paramsArr - TBD.
+   * @returns {Function} TBD.
    */
   execute(paramsArr) {
     let handlerReturn;
@@ -43,6 +44,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {Function} TBD.
    */
   detach() {
     return this.isBound() ? this._signal.remove(this._listener, this.context) : null;
@@ -50,6 +52,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   isBound() {
     return !!this._signal && !!this._listener;
@@ -57,6 +60,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   isOnce() {
     return this._isOnce;
@@ -64,6 +68,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {Function} TBD.
    */
   getListener() {
     return this._listener;
@@ -71,6 +76,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {Signal} TBD.
    */
   getSignal() {
     return this._signal;
@@ -87,6 +93,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {string} TBD.
    */
   toString() {
     return '[SignalBinding isOnce:' + this._isOnce + ', isBound:' + this.isBound() + ', active:' + this.active + ']';

package/src/phaser/core/sound.js

@@ -1,4 +1,3 @@
-import { Game } from './game';
 import { Signal } from './signal';
 
 export class Sound {

package/src/phaser/core/sound_manager.js

@@ -1,5 +1,4 @@
 import { ArraySet } from './array_set';
-import { Game } from './game';
 import { Signal } from './signal';
 import { Sound } from './sound';
 import { SoundSprite } from './sound_sprite';

package/src/phaser/core/sound_sprite.js

@@ -1,6 +1,3 @@
-import { Game } from './game';
-import { Sound } from './sound';
-
 export class SoundSprite {
   /**
    * TBD.

package/src/phaser/core/stage.js

@@ -3,7 +3,6 @@ import { DisplayObject } from '../display/display_object';
 import { setUserSelect, setTouchAction } from '../display/canvas/util';
 import { valueToColor } from '../util/math';
 import { SCALE_LINEAR, SCALE_NEAREST } from './const';
-import { Game } from './game';
 
 export class Stage extends DisplayObject {
   /**

package/src/phaser/core/time.js

@@ -1,4 +1,3 @@
-import { Game } from './game';
 import { Timer } from './timer';
 
 export class Time {

package/src/phaser/core/timer.js

@@ -1,4 +1,3 @@
-import { Game } from './game';
 import { Signal } from './signal';
 import { TimerEvent } from './timer_event';
 

package/src/phaser/core/timer_event.js

@@ -1,5 +1,3 @@
-import { Timer } from './timer';
-
 export class TimerEvent {
   /**
    * TBD.

package/src/phaser/core/tween.js

@@ -1,10 +1,7 @@
 import { Signal } from './signal';
 import { TweenData } from './tween_data';
-import { TweenManager } from './tween_manager';
-import { DisplayObject } from '../display/display_object';
 import * as MathUtils from '../util/math';
 import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './const';
-import { Game } from './game';
 
 export class Tween {
   /**
@@ -148,7 +145,7 @@ export class Tween {
   /**
    * TBD.
    * @param {string} property - TBD.
-   * @param {number} value - TBD.
+   * @param {object} value - TBD.
    * @param {number} index - TBD.
    * @returns {Tween} TBD.
    */
@@ -235,8 +232,8 @@ export class Tween {
 
   /**
    * TBD.
-   * @param interpolation - TBD.
-   * @param context - TBD.
+   * @param {Function} interpolation - TBD.
+   * @param {object} context - TBD.
    * @param {number} index - TBD.
    * @returns {Tween} TBD.
    */
@@ -424,7 +421,8 @@ export class Tween {
   /**
    * TBD.
    * @param {number} frameRate - TBD.
-   * @param data - TBD.
+   * @param {object[]} data - TBD.
+   * @returns {object[]} TBD.
    */
   generateData(frameRate = 60, data = []) {
     if (this.game === null || this.target === null) {

package/src/phaser/core/tween_data.js

@@ -4,7 +4,7 @@ import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './co
 export class TweenData {
   /**
    * TBD.
-   * @param parent - TBD.
+   * @param {Tween} parent - TBD.
    */
   constructor(parent) {
     this.parent = parent;

package/src/phaser/core/tween_manager.js

@@ -33,7 +33,6 @@ import {
   BounceInOut,
 } from './tween_easing';
 import { GROUP } from './const';
-import { Game } from './game';
 
 export class TweenManager {
   /**

package/src/phaser/core/world.js

@@ -1,5 +1,4 @@
 import { Group } from '../display/group';
-import { Game } from './game';
 
 export class World extends Group {
   /**

package/src/phaser/display/bitmap_text.js

@@ -1,6 +1,5 @@
 import { DisplayObject } from './display_object';
 import { Image } from './image';
-import { Game } from '../core/game';
 import { Point } from '../geom/point';
 import { BITMAP_TEXT, SCALE_LINEAR, SCALE_NEAREST } from '../core/const';
 

package/src/phaser/display/button.js

@@ -1,6 +1,5 @@
 import { Image } from './image';
 import { Signal } from '../core/signal';
-import { Game } from '../core/game';
 import { InputHandler } from '../core/input_handler';
 import { BUTTON, POINTER_CONTACT } from '../core/const';
 

package/src/phaser/display/canvas/renderer.js

@@ -23,7 +23,6 @@ import {
 import { getSmoothingPrefix } from './util';
 import { detectCapabilities } from './tinter';
 import * as CanvasMaskManager from './masker';
-import { Game } from '../../core/game';
 
 export class CanvasRenderer {
   /**
@@ -60,7 +59,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param root - TBD.
+   * @param {Stage} root - TBD.
    */
   render(root) {
     if (!this.context) {
@@ -85,7 +84,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param removeView - TBD.
+   * @param {boolean} removeView - TBD.
    */
   destroy(removeView = true) {
     if (removeView && this.view.parent) {
@@ -117,9 +116,9 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param displayObject - TBD.
-   * @param context - TBD.
-   * @param matrix - TBD.
+   * @param {Image} displayObject - TBD.
+   * @param {CanvasRenderingContext2D} context - TBD.
+   * @param {Matrix} matrix - TBD.
    */
   renderDisplayObject(displayObject, context, matrix) {
     this.renderSession.context = context || this.context;

package/src/phaser/display/display_object.js

@@ -671,6 +671,7 @@ export class DisplayObject {
 
   /**
    * TBD.
+   * @returns {Graphics} TBD.
    */
   get mask() {
     return this._mask;