@vpmedia/phaser 1.16.0 → 1.17.0

package/src/phaser/core/cache.js

@@ -83,8 +83,9 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @returns {object} TBD.
    */
   addImage(key, url, data) {
     if (this.checkImageKey(key)) {
@@ -110,9 +111,9 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
-   * @param atlasData
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @param atlasData - TBD.
    */
   addTextureAtlas(key, url, data, atlasData) {
     const obj = {
@@ -129,8 +130,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
    */
   addSound(key, url, data) {
     this._cache.sound[key] = {
@@ -146,8 +147,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
    */
   addText(key, url, data) {
     this._cache.text[key] = { url, data };
@@ -157,12 +158,12 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
-   * @param atlasData
-   * @param atlasType
-   * @param xSpacing
-   * @param ySpacing
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @param atlasData - TBD.
+   * @param atlasType - TBD.
+   * @param xSpacing - TBD.
+   * @param ySpacing - TBD.
    */
   addBitmapFont(key, url, data, atlasData, atlasType, xSpacing = 0, ySpacing = 0) {
     const obj = {
@@ -183,8 +184,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
    */
   addJSON(key, url, data) {
     this._cache.json[key] = { url, data };
@@ -194,8 +195,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
    */
   addXML(key, url, data) {
     this._cache.xml[key] = { url, data };
@@ -233,8 +234,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param property
-   * @param value
+   * @param {string} property - TBD.
+   * @param value - TBD.
    */
   updateSound(key, property, value) {
     const sound = this.getSound(key);
@@ -246,7 +247,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param data
+   * @param data - TBD.
    */
   decodedSound(key, data) {
     const sound = this.getSound(key);
@@ -258,6 +259,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   isSoundDecoded(key) {
     const sound = this.getItem(key, SOUND, 'isSoundDecoded');
@@ -270,6 +272,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   isSoundReady(key) {
     const sound = this.getItem(key, SOUND, 'isSoundDecoded');
@@ -283,8 +286,9 @@ export class Cache {
 
   /**
    * TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkKey(cache, key) {
     if (this._cacheMap[cache][key]) {
@@ -295,7 +299,8 @@ export class Cache {
 
   /**
    * TBD.
-   * @param url
+   * @param {string} url - TBD.
+   * @returns {boolean} TBD.
    */
   checkURL(url) {
     if (this._urlMap[this._resolveURL(url)]) {
@@ -307,6 +312,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkCanvasKey(key) {
     return this.checkKey(CANVAS, key);
@@ -315,6 +321,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkImageKey(key) {
     return this.checkKey(IMAGE, key);
@@ -323,6 +330,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkTextureKey(key) {
     return this.checkKey(TEXTURE, key);
@@ -331,6 +339,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkSoundKey(key) {
     return this.checkKey(SOUND, key);
@@ -339,6 +348,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkTextKey(key) {
     return this.checkKey(TEXT, key);
@@ -347,6 +357,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkBitmapDataKey(key) {
     return this.checkKey(BITMAPDATA, key);
@@ -355,6 +366,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkBitmapFontKey(key) {
     return this.checkKey(BITMAPFONT, key);
@@ -363,6 +375,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkJSONKey(key) {
     return this.checkKey(JSON, key);
@@ -371,6 +384,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
+   * @returns {boolean} TBD.
    */
   checkXMLKey(key) {
     return this.checkKey(XML, key);
@@ -381,9 +395,10 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
-   * @param method
-   * @param property
+   * @param {number} cache - TBD.
+   * @param {string} method - TBD.
+   * @param {string} property - TBD.
+   * @returns {*} TBD.
    */
   getItem(key, cache, method, property = null) {
     if (this.checkKey(cache, key)) {
@@ -406,7 +421,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param full
+   * @param full - TBD.
    */
   getImage(key = '__default', full = false) {
     let img = this.getItem(key, IMAGE, 'getImage');
@@ -470,7 +485,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param isClone
+   * @param {boolean} isClone - TBD.
    */
   getJSON(key, isClone = false) {
     const data = this.getItem(key, JSON, 'getJSON', 'data');
@@ -498,7 +513,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   getBaseTexture(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getBaseTexture', 'base');
@@ -507,7 +522,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   getFrame(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getFrame', 'frame');
@@ -516,7 +531,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   getFrameCount(key, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -529,7 +544,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   getFrameData(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getFrameData', 'frameData');
@@ -538,7 +553,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param cache
+   * @param {number} cache - TBD.
    */
   hasFrameData(key, cache = IMAGE) {
     return this.getItem(key, cache, '', 'frameData') !== null;
@@ -547,8 +562,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param frameData
-   * @param cache
+   * @param frameData - TBD.
+   * @param {number} cache - TBD.
    */
   updateFrameData(key, frameData, cache = IMAGE) {
     if (this._cacheMap[cache][key]) {
@@ -559,8 +574,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param index - TBD.
-   * @param cache
+   * @param {number} index - TBD.
+   * @param {number} cache - TBD.
    */
   getFrameByIndex(key, index, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -573,8 +588,8 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param name
-   * @param cache
+   * @param {string} name - TBD.
+   * @param {number} cache - TBD.
    */
   getFrameByName(key, name, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
@@ -586,7 +601,7 @@ export class Cache {
 
   /**
    * TBD.
-   * @param url
+   * @param {string} url - TBD.
    */
   getURL(url) {
     const resolvedURL = this._resolveURL(url);
@@ -599,7 +614,7 @@ export class Cache {
 
   /**
    * TBD.
-   * @param cache
+   * @param {object} cache - TBD.
    */
   getKeys(cache = IMAGE) {
     const result = [];
@@ -628,7 +643,7 @@ export class Cache {
   /**
    * TBD.
    * @param {string} key - TBD.
-   * @param destroyBaseTexture
+   * @param {boolean} destroyBaseTexture - TBD.
    */
   removeImage(key, destroyBaseTexture = true) {
     const img = this.getImage(key, true);
@@ -723,8 +738,9 @@ export class Cache {
 
   /**
    * TBD.
-   * @param url
-   * @param data
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @returns {string} TBD.
    */
   _resolveURL(url, data) {
     if (!this.autoResolveURL) {

package/src/phaser/core/factory.js

@@ -21,7 +21,7 @@ export class GameObjectFactory {
    * @param {number} y - TBD.
    * @param {string} key - TBD.
    * @param frame - TBD.
-   * @param group - 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) {
@@ -48,7 +48,7 @@ export class GameObjectFactory {
    * @param {number} y - TBD.
    * @param text - TBD.
    * @param style - TBD.
-   * @param group - 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 {Function} callback - TBD.
+   * @param {object} callbackContext - TBD.
    * @param overFrame - TBD.
    * @param outFrame - TBD.
    * @param downFrame - TBD.
    * @param upFrame - TBD.
-   * @param group - 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) {
@@ -96,7 +96,7 @@ export class GameObjectFactory {
    * @param font - TBD.
    * @param text - TBD.
    * @param size - TBD.
-   * @param group - TBD.
+   * @param {Group} group - TBD.
    * @param align - TBD.
    * @returns {BitmapText} TBD.
    */

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/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;