@vpmedia/phaser 1.18.0 → 1.19.0

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) {

package/src/phaser/core/scene_manager.js

@@ -40,7 +40,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,14 @@
+import { Signal } from './signal';
+
 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 +24,8 @@ export class SignalBinding {
 
   /**
    * TBD.
-   * @param paramsArr
+   * @param {any[]} paramsArr - TBD.
+   * @returns {Function} TBD.
    */
   execute(paramsArr) {
     let handlerReturn;
@@ -43,6 +46,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {Function} TBD.
    */
   detach() {
     return this.isBound() ? this._signal.remove(this._listener, this.context) : null;
@@ -50,6 +54,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   isBound() {
     return !!this._signal && !!this._listener;
@@ -57,6 +62,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {boolean} TBD.
    */
   isOnce() {
     return this._isOnce;
@@ -64,6 +70,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {Function} TBD.
    */
   getListener() {
     return this._listener;
@@ -71,6 +78,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {Signal} TBD.
    */
   getSignal() {
     return this._signal;
@@ -87,6 +95,7 @@ export class SignalBinding {
 
   /**
    * TBD.
+   * @returns {string} TBD.
    */
   toString() {
     return '[SignalBinding isOnce:' + this._isOnce + ', isBound:' + this.isBound() + ', active:' + this.active + ']';

package/src/phaser/core/tween.js

@@ -148,7 +148,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 +235,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 +424,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

@@ -1,10 +1,11 @@
+import { Tween } from './tween';
 import * as MathUtils from '../util/math';
 import { TWEEN_PENDING, TWEEN_RUNNING, TWEEN_COMPLETE, TWEEN_LOOPED } from './const';
 
 export class TweenData {
   /**
    * TBD.
-   * @param parent - TBD.
+   * @param {Tween} parent - TBD.
    */
   constructor(parent) {
     this.parent = parent;

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

@@ -24,6 +24,9 @@ import { getSmoothingPrefix } from './util';
 import { detectCapabilities } from './tinter';
 import * as CanvasMaskManager from './masker';
 import { Game } from '../../core/game';
+import { Stage } from '../../core/stage';
+import { Image } from '../image';
+import { Matrix } from '../../geom/matrix';
 
 export class CanvasRenderer {
   /**
@@ -60,7 +63,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param root - TBD.
+   * @param {Stage} root - TBD.
    */
   render(root) {
     if (!this.context) {
@@ -85,7 +88,7 @@ export class CanvasRenderer {
 
   /**
    * TBD.
-   * @param removeView - TBD.
+   * @param {boolean} removeView - TBD.
    */
   destroy(removeView = true) {
     if (removeView && this.view.parent) {
@@ -117,9 +120,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

@@ -4,6 +4,7 @@ import { Matrix } from '../geom/matrix';
 import { getIdentityMatrix } from '../geom/util/matrix';
 import { PI_2 } from '../util/math';
 import { renderCanvas, renderWebGL } from './sprite_util';
+import { Graphics } from './graphics';
 
 export class DisplayObject {
   /**
@@ -671,6 +672,7 @@ export class DisplayObject {
 
   /**
    * TBD.
+   * @returns {Graphics} TBD.
    */
   get mask() {
     return this._mask;

package/src/phaser/display/graphics.js

@@ -841,8 +841,8 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param points - TBD.
-   * @param cull - TBD.
+   * @param {Point[]} points - TBD.
+   * @param {boolean} cull - TBD.
    */
   drawTriangle(points, cull = false) {
     const triangle = new Polygon(points);
@@ -861,8 +861,8 @@ export class Graphics extends DisplayObject {
 
   /**
    * TBD.
-   * @param vertices - TBD.
-   * @param indices - TBD.
+   * @param {number[]|Point[]} vertices - TBD.
+   * @param {number[]} indices - TBD.
    * @param {boolean} cull - TBD.
    */
   drawTriangles(vertices, indices, cull = false) {

package/src/phaser/display/image.js

@@ -1,6 +1,7 @@
 import { Texture } from './webgl/texture';
 import { AnimationManager } from '../core/animation_manager';
 import { EventManager } from '../core/event_manager';
+import { Frame } from '../core/frame';
 import { Rectangle } from '../geom/rectangle';
 import { Matrix } from '../geom/matrix';
 import { DisplayObject } from './display_object';
@@ -140,7 +141,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param frame - TBD.
+   * @param {Frame} frame - TBD.
    */
   setFrame(frame) {
     this._frame = frame;
@@ -185,7 +186,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param parent - TBD.
+   * @param {DisplayObject} parent - TBD.
    * @param {number} width - TBD.
    * @param {number} height - TBD.
    */
@@ -205,6 +206,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
+   * @returns {number} TBD.
    */
   get frame() {
     return this.animations.frame;
@@ -236,7 +238,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param rect - TBD.
+   * @param {Rectangle} rect - TBD.
    * @param {boolean} copy - TBD.
    */
   crop(rect, copy = false) {
@@ -335,7 +337,7 @@ export class Image extends DisplayObject {
 
   /**
    * TBD.
-   * @param texture - TBD.
+   * @param {Texture} texture - TBD.
    * @param {boolean} destroyBase - TBD.
    */
   setTexture(texture, destroyBase = false) {