Merge branch 'master' of https://github.com/photonstorm/phaser

Author: bitnenfer

CHANGELOG.md

@@ -24,10 +24,19 @@
 * TextureSource will now remove its respective WebGLTexture from the renderer when destroyed.
 * TextureSource will now automatically create a glTexture from its canvas if using one.
 * WebGLRenderer will now remove a GL texture from its local `nativeTextures` array when you call the `deleteTexture` method.
+* The BaseCache has a new method `exists` that will return a boolean if an entry for the given key exists in the cache or not.
+* Loader.File has a new argument in its constructor which is an instance of the LoaderPlugin. It stores this in the `loader` property. It also has a new property `cache` which is a reference to the cache that the file type will be stored in.
+* Loader.File has a new method `hasCacheConflict` which checks if a key matching the one used by this file exists in the target Cache or not.
+* Loader.File has a new method `addToCache` which will add the file to its target cache and then emit a `filecomplete` event, passing its key and a reference to itself to the listener.
+* LoaderPlugin has a new property `cacheManager` which is a reference to the global game cache and is used by the File Types.
+* LoaderPlugin has a new property `textureManager` which is a reference to the global Texture Manager and is used by the File Types.
+* LoaderPlugin will now check to see if loading a file would cache a cache conflict or not, and prevent it if it will.
+* LoaderPlugin now passes off processing of the final file data to the file itself, which will now self-add itself to its target cache.
 
 ### Bug Fixes
 
 * DataManagerPlugin would throw an error on Game.destroy if you had any Scenes in the Scene Manager had not been run. Fix #3596 (thanks @kuoruan)
+* If you created a Game with no Scenes defined, and then added one via `Game.scene.add` and passed in a data object, the data would be ignored when starting the Scene.
 
 ### Examples, Documentation and TypeScript
 

src/cache/BaseCache.js

@@ -83,6 +83,7 @@ var BaseCache = new Class({
 
     /**
      * Checks if this cache contains an item matching the given key.
+     * This performs the same action as `BaseCache.exists`.
      *
      * @method Phaser.Cache.BaseCache#has
      * @since 3.0.0
@@ -96,6 +97,22 @@ var BaseCache = new Class({
         return this.entries.has(key);
     },
 
+    /**
+     * Checks if this cache contains an item matching the given key.
+     * This performs the same action as `BaseCache.has` and is called directly by the Loader.
+     *
+     * @method Phaser.Cache.BaseCache#exists
+     * @since 3.7.0
+     *
+     * @param {string} key - The unique key of the item to be checked in this cache.
+     *
+     * @return {boolean} Returns `true` if the cache contains an item matching the given key, otherwise `false`.
+     */
+    exists: function (key)
+    {
+        return this.entries.has(key);
+    },
+
     /**
      * Gets an item from this cache based on the given key.
      *

src/loader/File.js

@@ -40,14 +40,33 @@ var XHRSettings = require('./XHRSettings');
  * @constructor
  * @since 3.0.0
  *
+ * @param {Phaser.Loader.LoaderPlugin} loader - The Loader that is going to load this File.
  * @param {FileConfig} fileConfig - [description]
  */
 var File = new Class({
 
     initialize:
 
-    function File (fileConfig)
+    function File (loader, fileConfig)
     {
+        /**
+         * A reference to the Loader that is going to load this file.
+         *
+         * @name Phaser.Loader.File#loader
+         * @type {Phaser.Loader.LoaderPlugin}
+         * @since 3.0.0
+         */
+        this.loader = loader;
+
+        /**
+         * A reference to the Cache, or Texture Manager, that is going to store this file if it loads.
+         *
+         * @name Phaser.Loader.File#cache
+         * @type {(Phaser.Cache.BaseCache|Phaser.Textures.TextureManager)}
+         * @since 3.7.0
+         */
+        this.cache = GetFastValue(fileConfig, 'cache');
+
         /**
          * The file type string (image, json, etc) for sorting within the Loader.
          *
@@ -112,15 +131,6 @@ var File = new Class({
             this.xhrSettings = MergeXHRSettings(this.xhrSettings, GetFastValue(fileConfig, 'xhrSettings', {}));
         }
 
-        /**
-         * The LoaderPlugin instance that is loading this file.
-         *
-         * @name Phaser.Loader.File#loader
-         * @type {?Phaser.Loader.LoaderPlugin}
-         * @since 3.0.0
-         */
-        this.loader = null;
-
         /**
          * The XMLHttpRequest instance (as created by XHR Loader) that is loading this File.
          *
@@ -275,30 +285,26 @@ var File = new Class({
      *
      * @method Phaser.Loader.File#load
      * @since 3.0.0
-     *
-     * @param {Phaser.Loader.LoaderPlugin} loader - The Loader that will load this File.
      */
-    load: function (loader)
+    load: function ()
     {
-        this.loader = loader;
-
         if (this.state === CONST.FILE_POPULATED)
         {
             this.onComplete();
 
-            loader.nextFile(this);
+            this.loader.nextFile(this);
         }
         else
         {
-            this.src = GetURL(this, loader.baseURL);
+            this.src = GetURL(this, this.loader.baseURL);
 
             if (this.src.indexOf('data:') === 0)
             {
                 console.warn('Local data URIs are not supported: ' + this.key);
             }
             else
             {
-                this.xhrLoader = XHRLoader(this, loader.xhr);
+                this.xhrLoader = XHRLoader(this, this.loader.xhr);
             }
         }
     },
@@ -407,6 +413,36 @@ var File = new Class({
         {
             this.state = CONST.FILE_COMPLETE;
         }
+    },
+
+    /**
+     * Checks if a key matching the one used by this file exists in the target Cache or not.
+     * This is called automatically by the LoaderPlugin to decide if the file can be safely
+     * loaded or will conflict.
+     *
+     * @method Phaser.Loader.File#hasCacheConflict
+     * @since 3.7.0
+     *
+     * @return {boolean} `true` if adding this file will cause a conflict, otherwise `false`.
+     */
+    hasCacheConflict: function ()
+    {
+        return (this.cache.exists(this.key));
+    },
+
+    /**
+     * Adds this file to its target cache upon successful loading and processing.
+     * It will emit a `filecomplete` event from the LoaderPlugin.
+     * This method is often overridden by specific file types.
+     *
+     * @method Phaser.Loader.File#addToCache
+     * @since 3.7.0
+     */
+    addToCache: function ()
+    {
+        this.cache.add(this.key, this.data);
+
+        this.loader.emit('filecomplete', this.key, this);
     }
 
 });

src/loader/LoaderPlugin.js

@@ -84,6 +84,24 @@ var LoaderPlugin = new Class({
          */
         this.systems = scene.sys;
 
+        /**
+         * A reference to the global Cache Manager.
+         *
+         * @name Phaser.Loader.LoaderPlugin#cacheManager
+         * @type {Phaser.Cache.CacheManager}
+         * @since 3.7.0
+         */
+        this.cacheManager = scene.sys.cache;
+
+        /**
+         * A reference to the global Texture Manager.
+         *
+         * @name Phaser.Loader.LoaderPlugin#textureManager
+         * @type {Phaser.Textures.TextureManager}
+         * @since 3.7.0
+         */
+        this.textureManager = scene.sys.textures;
+
         /**
          * [description]
          *
@@ -350,9 +368,13 @@ var LoaderPlugin = new Class({
             return -1;
         }
 
-        file.path = this.path;
+        //  Does the file already exist in the cache or texture manager?
+        if (!file.hasCacheConflict())
+        {
+            file.path = this.path;
 
-        this.list.set(file);
+            this.list.set(file);
+        }
 
         return file;
     },
@@ -721,12 +743,6 @@ var LoaderPlugin = new Class({
                     animJSON.push(file);
                     break;
 
-                case 'image':
-                case 'svg':
-                case 'html':
-                    textures.addImage(file.key, file.data);
-                    break;
-
                 case 'atlasjson':
 
                     fileA = file.fileA;
@@ -789,34 +805,6 @@ var LoaderPlugin = new Class({
                     }
                     break;
 
-                case 'spritesheet':
-                    textures.addSpriteSheet(file.key, file.data, file.config);
-                    break;
-
-                case 'json':
-                    cache.json.add(file.key, file.data);
-                    break;
-
-                case 'xml':
-                    cache.xml.add(file.key, file.data);
-                    break;
-
-                case 'text':
-                    cache.text.add(file.key, file.data);
-                    break;
-
-                case 'obj':
-                    cache.obj.add(file.key, file.data);
-                    break;
-
-                case 'binary':
-                    cache.binary.add(file.key, file.data);
-                    break;
-
-                case 'audio':
-                    cache.audio.add(file.key, file.data);
-                    break;
-
                 case 'audioSprite':
 
                     var files = [ file.fileA, file.fileB ];
@@ -828,14 +816,9 @@ var LoaderPlugin = new Class({
 
                     break;
 
-                case 'glsl':
-                    cache.shader.add(file.key, file.data);
-                    break;
+                default:
+                    file.addToCache();
 
-                case 'tilemapCSV':
-                case 'tilemapJSON':
-                    cache.tilemap.add(file.key, { format: file.tilemapFormat, data: file.data });
-                    break;
             }
         });
 
@@ -1027,6 +1010,8 @@ var LoaderPlugin = new Class({
 
         this.scene = null;
         this.systems = null;
+        this.textureManager = null;
+        this.cacheManager = null;
     }
 
 });

src/loader/filetypes/AnimationJSONFile.js

@@ -20,9 +20,9 @@ var JSONFile = require('./JSONFile.js');
  *
  * @return {Phaser.Loader.FileTypes.JSONFile} A File instance to be added to the Loader.
  */
-var AnimationJSONFile = function (key, url, path, xhrSettings)
+var AnimationJSONFile = function (loader, key, url, xhrSettings)
 {
-    var json = new JSONFile(key, url, path, xhrSettings);
+    var json = new JSONFile(loader, key, url, xhrSettings);
 
     //  Override the File type
     json.type = 'animationJSON';
@@ -55,12 +55,12 @@ FileTypesManager.register('animation', function (key, url, xhrSettings)
         for (var i = 0; i < key.length; i++)
         {
             //  If it's an array it has to be an array of Objects, so we get everything out of the 'key' object
-            this.addFile(new AnimationJSONFile(key[i], url, this.path, xhrSettings));
+            this.addFile(new AnimationJSONFile(this, key[i], url, xhrSettings));
         }
     }
     else
     {
-        this.addFile(new AnimationJSONFile(key, url, this.path, xhrSettings));
+        this.addFile(new AnimationJSONFile(this, key, url, xhrSettings));
     }
 
     //  For method chaining

src/loader/filetypes/AtlasJSONFile.js

@@ -23,10 +23,10 @@ var JSONFile = require('./JSONFile.js');
  *
  * @return {object} An object containing two File objects to be added to the loader.
  */
-var AtlasJSONFile = function (key, textureURL, atlasURL, path, textureXhrSettings, atlasXhrSettings)
+var AtlasJSONFile = function (loader, key, textureURL, atlasURL, textureXhrSettings, atlasXhrSettings)
 {
-    var image = new ImageFile(key, textureURL, path, textureXhrSettings);
-    var data = new JSONFile(key, atlasURL, path, atlasXhrSettings);
+    var image = new ImageFile(loader, key, textureURL, textureXhrSettings);
+    var data = new JSONFile(loader, key, atlasURL, atlasXhrSettings);
 
     //  Link them together
     image.linkFile = data;
@@ -60,20 +60,19 @@ var AtlasJSONFile = function (key, textureURL, atlasURL, path, textureXhrSetting
  */
 FileTypesManager.register('atlas', function (key, textureURL, atlasURL, textureXhrSettings, atlasXhrSettings)
 {
-
     var files;
 
     // If param key is an object, use object based loading method
     if ((typeof key === 'object') && (key !== null))
     {
-        files = new AtlasJSONFile(key.key, key.texture, key.data, this.path, textureXhrSettings, atlasXhrSettings);
+        files = new AtlasJSONFile(this, key.key, key.texture, key.data, textureXhrSettings, atlasXhrSettings);
     }
 
     // Else just use the parameters like normal
     else
     {
         //  Returns an object with two properties: 'texture' and 'data'
-        files = new AtlasJSONFile(key, textureURL, atlasURL, this.path, textureXhrSettings, atlasXhrSettings);
+        files = new AtlasJSONFile(this, key, textureURL, atlasURL, textureXhrSettings, atlasXhrSettings);
     }
 
     this.addFile(files.texture);

src/loader/filetypes/AudioFile.js

@@ -33,7 +33,7 @@ var AudioFile = new Class({
 
     initialize:
 
-    function AudioFile (key, url, path, xhrSettings, audioContext)
+    function AudioFile (loader, key, url, xhrSettings, audioContext)
     {
         /**
          * [description]
@@ -46,15 +46,16 @@ var AudioFile = new Class({
 
         var fileConfig = {
             type: 'audio',
+            cache: loader.cacheManager.audio,
             extension: GetFastValue(url, 'type', ''),
             responseType: 'arraybuffer',
             key: key,
             url: GetFastValue(url, 'uri', url),
-            path: path,
+            path: loader.path,
             xhrSettings: xhrSettings
         };
 
-        File.call(this, fileConfig);
+        File.call(this, loader, fileConfig);
     },
 
     /**
@@ -119,11 +120,11 @@ AudioFile.create = function (loader, key, urls, config, xhrSettings)
 
     if (deviceAudio.webAudio && !(audioConfig && audioConfig.disableWebAudio))
     {
-        return new AudioFile(key, url, loader.path, xhrSettings, game.sound.context);
+        return new AudioFile(loader, key, url, xhrSettings, game.sound.context);
     }
     else
     {
-        return new HTML5AudioFile(key, url, loader.path, config);
+        return new HTML5AudioFile(loader, key, url, config);
     }
 };