@vpmedia/phaser 1.15.0 → 1.17.0

package/src/phaser/core/cache.js

@@ -1,15 +1,11 @@
-/**
- * @copyright    Copyright (c) 2018-present Richard Davey, Photon Storm Ltd., Andras Csizmadia <andras@vpmedia.hu> (www.vpmedia.hu)
- * @author       Andras Csizmadia <andras@vpmedia.hu>
- * @author       Richard Davey <rich@photonstorm.com>
- */
 import { Texture } from '../display/webgl/texture';
 import { BaseTexture } from '../display/webgl/base_texture';
-import { Signal } from  './signal';
+import { Signal } from './signal';
 import { Frame } from './frame';
 import { FrameData } from './frame_data';
 import { JSONDataHash } from './animation_parser';
 import { jsonBitmapFont, xmlBitmapFont } from './loader_parser';
+import { Game } from './game';
 
 export const CANVAS = 0;
 export const IMAGE = 1;
@@ -23,6 +19,10 @@ export const XML = 8;
 export const RENDER_TEXTURE = 9;
 
 export class Cache {
+  /**
+   * TBD.
+   * @param {Game} game - TBD.
+   */
   constructor(game) {
     this.game = game;
     this.autoResolveURL = false;
@@ -57,6 +57,9 @@ export class Cache {
     this.addMissingImage();
   }
 
+  /**
+   * TBD.
+   */
   addDefaultImage() {
     const img = new Image();
     img.src =
@@ -66,6 +69,9 @@ export class Cache {
     window.PhaserRegistry.CACHE_DEFAULT_IMAGE = new Texture(obj.base);
   }
 
+  /**
+   * TBD.
+   */
   addMissingImage() {
     const img = new Image();
     img.src =
@@ -74,6 +80,13 @@ export class Cache {
     window.PhaserRegistry.CACHE_MISSING_IMAGE = new Texture(obj.base);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @returns {object} TBD.
+   */
   addImage(key, url, data) {
     if (this.checkImageKey(key)) {
       this.removeImage(key);
@@ -95,6 +108,13 @@ export class Cache {
     return img;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @param atlasData - TBD.
+   */
   addTextureAtlas(key, url, data, atlasData) {
     const obj = {
       key,
@@ -107,6 +127,12 @@ export class Cache {
     this._resolveURL(url, obj);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   */
   addSound(key, url, data) {
     this._cache.sound[key] = {
       url,
@@ -118,11 +144,27 @@ export class Cache {
     this._resolveURL(url, this._cache.sound[key]);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   */
   addText(key, url, data) {
     this._cache.text[key] = { url, data };
     this._resolveURL(url, this._cache.text[key]);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @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 = {
       url,
@@ -139,11 +181,23 @@ export class Cache {
     this._resolveURL(url, obj);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   */
   addJSON(key, url, data) {
     this._cache.json[key] = { url, data };
     this._resolveURL(url, this._cache.json[key]);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   */
   addXML(key, url, data) {
     this._cache.xml[key] = { url, data };
     this._resolveURL(url, this._cache.xml[key]);
@@ -151,6 +205,10 @@ export class Cache {
 
   // SOUND
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   reloadSound(key) {
     const scope = this;
     const sound = this.getSound(key);
@@ -161,6 +219,10 @@ export class Cache {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   reloadSoundComplete(key) {
     const sound = this.getSound(key);
     if (sound) {
@@ -169,6 +231,12 @@ export class Cache {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {string} property - TBD.
+   * @param value - TBD.
+   */
   updateSound(key, property, value) {
     const sound = this.getSound(key);
     if (sound) {
@@ -176,6 +244,11 @@ export class Cache {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param data - TBD.
+   */
   decodedSound(key, data) {
     const sound = this.getSound(key);
     sound.data = data;
@@ -183,6 +256,11 @@ export class Cache {
     sound.isDecoding = false;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   isSoundDecoded(key) {
     const sound = this.getItem(key, SOUND, 'isSoundDecoded');
     if (sound) {
@@ -191,6 +269,11 @@ export class Cache {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   isSoundReady(key) {
     const sound = this.getItem(key, SOUND, 'isSoundDecoded');
     if (sound) {
@@ -201,6 +284,12 @@ export class Cache {
 
   // CHECK
 
+  /**
+   * TBD.
+   * @param {number} cache - TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkKey(cache, key) {
     if (this._cacheMap[cache][key]) {
       return true;
@@ -208,6 +297,11 @@ export class Cache {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {string} url - TBD.
+   * @returns {boolean} TBD.
+   */
   checkURL(url) {
     if (this._urlMap[this._resolveURL(url)]) {
       return true;
@@ -215,44 +309,97 @@ export class Cache {
     return false;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkCanvasKey(key) {
     return this.checkKey(CANVAS, key);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkImageKey(key) {
     return this.checkKey(IMAGE, key);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkTextureKey(key) {
     return this.checkKey(TEXTURE, key);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkSoundKey(key) {
     return this.checkKey(SOUND, key);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkTextKey(key) {
     return this.checkKey(TEXT, key);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkBitmapDataKey(key) {
     return this.checkKey(BITMAPDATA, key);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkBitmapFontKey(key) {
     return this.checkKey(BITMAPFONT, key);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkJSONKey(key) {
     return this.checkKey(JSON, key);
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @returns {boolean} TBD.
+   */
   checkXMLKey(key) {
     return this.checkKey(XML, key);
   }
 
   // GET
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @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)) {
       if (!property) {
@@ -263,10 +410,19 @@ export class Cache {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getCanvas(key) {
     return this.getItem(key, CANVAS, 'getCanvas', 'canvas');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param full - TBD.
+   */
   getImage(key = '__default', full = false) {
     let img = this.getItem(key, IMAGE, 'getImage');
     if (img === null) {
@@ -278,53 +434,105 @@ export class Cache {
     return img.data;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getTextureFrame(key) {
     return this.getItem(key, TEXTURE, 'getTextureFrame', 'frame');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getSound(key) {
     return this.getItem(key, SOUND, 'getSound');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getSoundData(key) {
     return this.getItem(key, SOUND, 'getSoundData', 'data');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getText(key) {
     return this.getItem(key, TEXT, 'getText', 'data');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getBitmapData(key) {
     return this.getItem(key, BITMAPDATA, 'getBitmapData', 'data');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getBitmapFont(key) {
     return this.getItem(key, BITMAPFONT, 'getBitmapFont');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {boolean} isClone - TBD.
+   */
   getJSON(key, isClone = false) {
     const data = this.getItem(key, JSON, 'getJSON', 'data');
     return isClone ? JSON.parse(JSON.stringify(data)) : data;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getXML(key) {
     return this.getItem(key, XML, 'getXML', 'data');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   getRenderTexture(key) {
     return this.getItem(key, RENDER_TEXTURE, 'getRenderTexture');
   }
 
   // FRAME
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {number} cache - TBD.
+   */
   getBaseTexture(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getBaseTexture', 'base');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {number} cache - TBD.
+   */
   getFrame(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getFrame', 'frame');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {number} cache - TBD.
+   */
   getFrameCount(key, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
     if (data) {
@@ -333,20 +541,42 @@ export class Cache {
     return 0;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {number} cache - TBD.
+   */
   getFrameData(key, cache = IMAGE) {
     return this.getItem(key, cache, 'getFrameData', 'frameData');
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {number} cache - TBD.
+   */
   hasFrameData(key, cache = IMAGE) {
     return this.getItem(key, cache, '', 'frameData') !== null;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param frameData - TBD.
+   * @param {number} cache - TBD.
+   */
   updateFrameData(key, frameData, cache = IMAGE) {
     if (this._cacheMap[cache][key]) {
       this._cacheMap[cache][key].frameData = frameData;
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {number} index - TBD.
+   * @param {number} cache - TBD.
+   */
   getFrameByIndex(key, index, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
     if (data) {
@@ -355,6 +585,12 @@ export class Cache {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {string} name - TBD.
+   * @param {number} cache - TBD.
+   */
   getFrameByName(key, name, cache = IMAGE) {
     const data = this.getFrameData(key, cache);
     if (data) {
@@ -363,6 +599,10 @@ export class Cache {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {string} url - TBD.
+   */
   getURL(url) {
     const resolvedURL = this._resolveURL(url);
     if (resolvedURL) {
@@ -372,6 +612,10 @@ export class Cache {
     return null;
   }
 
+  /**
+   * TBD.
+   * @param {object} cache - TBD.
+   */
   getKeys(cache = IMAGE) {
     const result = [];
     if (this._cacheMap[cache]) {
@@ -388,10 +632,19 @@ export class Cache {
 
   // REMOVE
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeCanvas(key) {
     delete this._cache.canvas[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   * @param {boolean} destroyBaseTexture - TBD.
+   */
   removeImage(key, destroyBaseTexture = true) {
     const img = this.getImage(key, true);
     if (destroyBaseTexture && img.base) {
@@ -400,42 +653,81 @@ export class Cache {
     delete this._cache.image[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeSound(key) {
     delete this._cache.sound[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeText(key) {
     delete this._cache.text[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeBitmapData(key) {
     delete this._cache.bitmapData[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeBitmapFont(key) {
     delete this._cache.bitmapFont[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeJSON(key) {
     delete this._cache.json[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeXML(key) {
     delete this._cache.xml[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeRenderTexture(key) {
     delete this._cache.renderTexture[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeSpriteSheet(key) {
     delete this._cache.spriteSheet[key];
   }
 
+  /**
+   * TBD.
+   * @param {string} key - TBD.
+   */
   removeTextureAtlas(key) {
     delete this._cache.atlas[key];
   }
 
+  /**
+   * TBD.
+   */
   clearGLTextures() {
     const keys = Object.keys(this._cache.image);
     for (let i = 0; i < keys.length; i += 1) {
@@ -444,6 +736,12 @@ export class Cache {
     }
   }
 
+  /**
+   * TBD.
+   * @param {string} url - TBD.
+   * @param data - TBD.
+   * @returns {string} TBD.
+   */
   _resolveURL(url, data) {
     if (!this.autoResolveURL) {
       return null;
@@ -459,6 +757,9 @@ export class Cache {
     return this._urlTemp;
   }
 
+  /**
+   * TBD.
+   */
   destroy() {
     for (let i = 0; i < this._cacheMap.length; i += 1) {
       const cache = this._cacheMap[i];