All FileTypes now register themselves with the FileTypesManager, allowing devs to specify which loaders are included in their builds.

Author: photonstorm

src/loader/Loader.js

@@ -1,30 +1,9 @@
 var BaseLoader = require('./BaseLoader');
 var Class = require('../utils/Class');
 var CONST = require('./const');
+var FileTypesManager = require('./FileTypesManager');
 var NumberArray = require('../utils/array/NumberArray');
 var PluginManager = require('../plugins/PluginManager');
-var TILEMAP_FORMATS = require('../gameobjects/tilemap/Formats');
-
-//  TODO - Injection mapped
-var AnimationJSONFile = require('./filetypes/AnimationJSONFile');
-var AtlasJSONFile = require('./filetypes/AtlasJSONFile');
-var AudioFile = require('./filetypes/AudioFile');
-var BinaryFile = require('./filetypes/BinaryFile');
-var BitmapFontFile = require('./filetypes/BitmapFontFile');
-var GLSLFile = require('./filetypes/GLSLFile');
-var HTMLFile = require('./filetypes/HTMLFile');
-var ImageFile = require('./filetypes/ImageFile');
-var JSONFile = require('./filetypes/JSONFile');
-var PluginFile = require('./filetypes/PluginFile');
-var ScriptFile = require('./filetypes/ScriptFile');
-var SpriteSheet = require('./filetypes/SpriteSheet');
-var SVGFile = require('./filetypes/SVGFile');
-var TextFile = require('./filetypes/TextFile');
-var TilemapCSVFile = require('./filetypes/TilemapCSVFile');
-var TilemapJSONFile = require('./filetypes/TilemapJSONFile');
-var UnityAtlasFile = require('./filetypes/UnityAtlasFile');
-var WavefrontFile = require('./filetypes/WavefrontFile');
-var XMLFile = require('./filetypes/XMLFile');
 
 var Loader = new Class({
 
@@ -44,6 +23,9 @@ var Loader = new Class({
         }
 
         this._multilist = {};
+
+        //  Inject the available filetypes into the Loader
+        FileTypesManager.install(this);
     },
 
     boot: function ()
@@ -56,6 +38,7 @@ var Loader = new Class({
 
     //  key can be either a string, an object or an array of objects
 
+    /*
     image: function (key, url, xhrSettings)
     {
         return ImageFile.create(this, key, url, xhrSettings);
@@ -86,6 +69,7 @@ var Loader = new Class({
         return XMLFile.create(this, key, url, xhrSettings);
     },
 
+    /*
     binary: function (key, url, xhrSettings)
     {
         return BinaryFile.create(this, key, url, xhrSettings);
@@ -121,8 +105,10 @@ var Loader = new Class({
     {
         return SpriteSheet.create(this, key, url, config, xhrSettings);
     },
+    */
 
     //  config can include: instances
+    /*
     audio: function (key, urls, config, xhrSettings)
     {
         var audioFile = AudioFile.create(this, key, urls, config, xhrSettings);
@@ -134,7 +120,9 @@ var Loader = new Class({
 
         return this;
     },
+    */
 
+    /*
     tilemapCSV: function (key, url, xhrSettings)
     {
         return TilemapCSVFile.create(this, key, url, TILEMAP_FORMATS.CSV, xhrSettings);
@@ -149,6 +137,7 @@ var Loader = new Class({
     {
         return TilemapJSONFile.create(this, key, url, TILEMAP_FORMATS.WELTMEISTER, xhrSettings);
     },
+    */
 
     //  ---------------------------------------------------
     //  Multi-File Loaders
@@ -192,6 +181,7 @@ var Loader = new Class({
         return this;
     },
 
+    /*
     unityAtlas: function (key, textureURL, atlasURL, textureXhrSettings, atlasXhrSettings)
     {
         //  Returns an object with two properties: 'texture' and 'data'
@@ -224,6 +214,7 @@ var Loader = new Class({
 
         return this;
     },
+    */
 
     multiatlas: function (key, textureURLs, atlasURLs, textureXhrSettings, atlasXhrSettings)
     {

src/loader/filetypes/AnimationJSONFile.js

@@ -1,5 +1,8 @@
+var FileTypesManager = require('../FileTypesManager');
 var JSONFile = require('./JSONFile.js');
 
+//  Phaser.Loader.FileTypes.AnimationJSONFile
+
 var AnimationJSONFile = function (key, url, path, xhrSettings)
 {
     var json = new JSONFile(key, url, path, xhrSettings);
@@ -10,23 +13,29 @@ var AnimationJSONFile = function (key, url, path, xhrSettings)
     return json;
 };
 
-AnimationJSONFile.create = function (loader, key, url, xhrSettings)
+//  When registering a factory function 'this' refers to the Loader context.
+//  
+//  There are several properties available to use:
+//  
+//  this.scene - a reference to the Scene that owns the GameObjectFactory
+
+FileTypesManager.register('animation', function (key, url, xhrSettings)
 {
     if (Array.isArray(key))
     {
         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
-            loader.addFile(new AnimationJSONFile(key[i], url, loader.path, xhrSettings));
+            this.addFile(new AnimationJSONFile(key[i], url, this.path, xhrSettings));
         }
     }
     else
     {
-        loader.addFile(new AnimationJSONFile(key, url, loader.path, xhrSettings));
+        this.addFile(new AnimationJSONFile(key, url, this.path, xhrSettings));
     }
 
     //  For method chaining
-    return loader;
-};
+    return this;
+});
 
 module.exports = AnimationJSONFile;

src/loader/filetypes/AtlasJSONFile.js

@@ -1,6 +1,9 @@
+var FileTypesManager = require('../FileTypesManager');
 var ImageFile = require('./ImageFile.js');
 var JSONFile = require('./JSONFile.js');
 
+//  Phaser.Loader.FileTypes.AtlasJSONFile
+
 var AtlasJSONFile = function (key, textureURL, atlasURL, path, textureXhrSettings, atlasXhrSettings)
 {
     var image = new ImageFile(key, textureURL, path, textureXhrSettings);
@@ -17,4 +20,15 @@ var AtlasJSONFile = function (key, textureURL, atlasURL, path, textureXhrSetting
     return { texture: image, data: data };
 };
 
+FileTypesManager.register('atlas', function (key, textureURL, atlasURL, textureXhrSettings, atlasXhrSettings)
+{
+    //  Returns an object with two properties: 'texture' and 'data'
+    var files = new AtlasJSONFile(key, textureURL, atlasURL, this.path, textureXhrSettings, atlasXhrSettings);
+
+    this.addFile(files.texture);
+    this.addFile(files.data);
+
+    return this;
+});
+
 module.exports = AtlasJSONFile;

src/loader/filetypes/AudioFile.js

@@ -1,5 +1,6 @@
 var Class = require('../../utils/Class');
 var File = require('../File');
+var FileTypesManager = require('../FileTypesManager');
 var GetFastValue = require('../../utils/object/GetFastValue');
 var CONST = require('../../const');
 var HTML5AudioFile = require('./HTML5AudioFile');
@@ -58,33 +59,50 @@ var AudioFile = new Class({
 
 });
 
-AudioFile.create = function (loader, key, urls, config, xhrSettings)
+//  When registering a factory function 'this' refers to the Loader context.
+//  
+//  There are several properties available to use:
+//  
+//  this.scene - a reference to the Scene that owns the GameObjectFactory
+
+FileTypesManager.register('audio', function (key, urls, config, xhrSettings)
 {
-    var game = loader.scene.game;
+    var game = this.systems.game;
     var audioConfig = game.config.audio;
     var deviceAudio = game.device.Audio;
 
     if ((audioConfig && audioConfig.noAudio) || (!deviceAudio.webAudio && !deviceAudio.audioData))
     {
         console.info('Skipping loading audio \'' + key + '\' since sounds are disabled.');
-        return null;
+        return this;
     }
 
     var url = AudioFile.findAudioURL(game, urls);
 
     if (!url)
     {
         console.warn('No supported url provided for audio \'' + key + '\'!');
-        return null;
+        return this;
     }
 
-    if(deviceAudio.webAudio && !(audioConfig && audioConfig.disableWebAudio))
+    var audioFile;
+
+    if (deviceAudio.webAudio && !(audioConfig && audioConfig.disableWebAudio))
     {
-        return new AudioFile(key, url, loader.path, xhrSettings, game.sound.context);
+        audioFile = new AudioFile(key, url, this.path, xhrSettings, game.sound.context);
+    }
+    else
+    {
+        audioFile = new HTML5AudioFile(key, url, this.path, config);
     }
 
-    return new HTML5AudioFile(key, url, loader.path, config);
-};
+    if (audioFile)
+    {
+        this.addFile(audioFile);
+    }
+
+    return this;
+});
 
 // this.load.audio('sound', 'assets/audio/booom.ogg', config, xhrSettings);
 //
@@ -129,6 +147,7 @@ AudioFile.create = function (loader, key, urls, config, xhrSettings)
 //         }
 //     ],
 //     config, xhrSettings);
+
 AudioFile.findAudioURL = function (game, urls)
 {
     if (urls.constructor !== Array)

src/loader/filetypes/BinaryFile.js

@@ -1,6 +1,7 @@
 var Class = require('../../utils/Class');
 var CONST = require('../const');
 var File = require('../File');
+var FileTypesManager = require('../FileTypesManager');
 var GetFastValue = require('../../utils/object/GetFastValue');
 
 //  Phaser.Loader.FileTypes.BinaryFile
@@ -41,23 +42,29 @@ var BinaryFile = new Class({
 
 });
 
-BinaryFile.create = function (loader, key, url, xhrSettings)
+//  When registering a factory function 'this' refers to the Loader context.
+//  
+//  There are several properties available to use:
+//  
+//  this.scene - a reference to the Scene that owns the GameObjectFactory
+
+FileTypesManager.register('binary', function (key, url, xhrSettings)
 {
     if (Array.isArray(key))
     {
         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
-            loader.addFile(new BinaryFile(key[i], url, loader.path, xhrSettings));
+            this.addFile(new BinaryFile(key[i], url, this.path, xhrSettings));
         }
     }
     else
     {
-        loader.addFile(new BinaryFile(key, url, loader.path, xhrSettings));
+        this.addFile(new BinaryFile(key, url, this.path, xhrSettings));
     }
 
     //  For method chaining
-    return loader;
-};
+    return this;
+});
 
 module.exports = BinaryFile;

src/loader/filetypes/BitmapFontFile.js

@@ -1,3 +1,4 @@
+var FileTypesManager = require('../FileTypesManager');
 var ImageFile = require('./ImageFile.js');
 var XMLFile = require('./XMLFile.js');
 
@@ -17,4 +18,21 @@ var BitmapFontFile = function (key, textureURL, xmlURL, path, textureXhrSettings
     return { texture: image, data: data };
 };
 
+//  When registering a factory function 'this' refers to the Loader context.
+//  
+//  There are several properties available to use:
+//  
+//  this.scene - a reference to the Scene that owns the GameObjectFactory
+
+FileTypesManager.register('bitmapFont', function (key, textureURL, xmlURL, textureXhrSettings, xmlXhrSettings)
+{
+    //  Returns an object with two properties: 'texture' and 'data'
+    var files = new BitmapFontFile(key, textureURL, xmlURL, this.path, textureXhrSettings, xmlXhrSettings);
+
+    this.addFile(files.texture);
+    this.addFile(files.data);
+
+    return this;
+});
+
 module.exports = BitmapFontFile;

src/loader/filetypes/GLSLFile.js

@@ -1,6 +1,7 @@
 var Class = require('../../utils/Class');
 var CONST = require('../const');
 var File = require('../File');
+var FileTypesManager = require('../FileTypesManager');
 var GetFastValue = require('../../utils/object/GetFastValue');
 
 //  Phaser.Loader.FileTypes.GLSLFile
@@ -41,23 +42,29 @@ var GLSLFile = new Class({
 
 });
 
-GLSLFile.create = function (loader, key, url, xhrSettings)
+//  When registering a factory function 'this' refers to the Loader context.
+//  
+//  There are several properties available to use:
+//  
+//  this.scene - a reference to the Scene that owns the GameObjectFactory
+
+FileTypesManager.register('glsl', function (key, url, xhrSettings)
 {
     if (Array.isArray(key))
     {
         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
-            loader.addFile(new GLSLFile(key[i], url, loader.path, xhrSettings));
+            this.addFile(new GLSLFile(key[i], url, this.path, xhrSettings));
         }
     }
     else
     {
-        loader.addFile(new GLSLFile(key, url, loader.path, xhrSettings));
+        this.addFile(new GLSLFile(key, url, this.path, xhrSettings));
     }
 
     //  For method chaining
-    return loader;
-};
+    return this;
+});
 
 module.exports = GLSLFile;