phaser/src/loader/LoaderPlugin.js

1029 lines
27 KiB
JavaScript
Raw Normal View History

2018-02-12 16:01:20 +00:00
/**
* @author Richard Davey <rich@photonstorm.com>
* @copyright 2018 Photon Storm Ltd.
* @license {@link https://github.com/photonstorm/phaser/blob/master/license.txt|MIT License}
*/
var Class = require('../utils/Class');
var CONST = require('./const');
2017-10-04 22:48:16 +00:00
var CustomSet = require('../structs/Set');
var EventEmitter = require('eventemitter3');
2018-01-19 14:47:16 +00:00
var FileTypesManager = require('./FileTypesManager');
var GetFastValue = require('../utils/object/GetFastValue');
var PluginManager = require('../boot/PluginManager');
var XHRSettings = require('./XHRSettings');
2018-03-23 15:54:12 +00:00
/**
* @typedef {object} LinkFileObject
*
* @property {string} type - [description]
* @property {Phaser.Loader.File} fileA - [description]
* @property {Phaser.Loader.File} fileB - [description]
*/
2018-03-22 12:51:30 +00:00
/**
* @typedef {object} LoaderFileObject
*
* @property {string} key - [description]
* @property {string} type - [description]
* @property {string} [url] - [description]
* @property {string[]} [urls] - [description]
* @property {string} [textureURL] - [description]
* @property {string} [atlasURL] - [description]
* @property {string} [xmlURL] - [description]
* @property {string[]} [textureURLs] - [description]
* @property {string[]} [atlasURLs] - [description]
* @property {object} [config] - [description]
* @property {object} [json] - [description]
* @property {XHRSettingsObject} [xhrSettings] - [description]
* @property {XHRSettingsObject} [textureXhrSettings] - [description]
* @property {XHRSettingsObject} [atlasXhrSettings] - [description]
* @property {XHRSettingsObject} [xmlXhrSettings] - [description]
* @property {XHRSettingsObject} [audioXhrSettings] - [description]
* @property {XHRSettingsObject} [jsonXhrSettings] - [description]
*/
2018-02-09 17:56:43 +00:00
/**
* @classdesc
* [description]
*
* @class LoaderPlugin
2018-03-28 14:04:09 +00:00
* @extends Phaser.Events.EventEmitter
2018-02-09 17:56:43 +00:00
* @memberOf Phaser.Loader
* @constructor
* @since 3.0.0
*
* @param {Phaser.Scene} scene - [description]
*/
var LoaderPlugin = new Class({
Extends: EventEmitter,
initialize:
function LoaderPlugin (scene)
{
EventEmitter.call(this);
var gameConfig = scene.sys.game.config;
var sceneConfig = scene.sys.settings.loader;
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#scene
* @type {Phaser.Scene}
* @since 3.0.0
*/
this.scene = scene;
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#systems
* @type {Phaser.Scenes.Systems}
* @since 3.0.0
*/
2018-01-19 14:47:16 +00:00
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;
2018-01-19 14:47:16 +00:00
// Inject the available filetypes into the Loader
FileTypesManager.install(this);
/**
* An optional prefix that is automatically prepended to the start of every file key.
* If prefix was `MENU` and you load an image with the key 'Background' the resulting key would be `MENUBackground`.
*
* @name Phaser.Loader.LoaderPlugin#prefix
* @type {string}
* @default ''
* @since 3.7.0
*/
this.prefix = '';
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#path
* @type {string}
* @default ''
* @since 3.0.0
*/
this.path = '';
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#baseURL
* @type {string}
* @default ''
* @since 3.0.0
*/
this.baseURL = '';
this.setBaseURL(GetFastValue(sceneConfig, 'baseURL', gameConfig.loaderBaseURL));
2018-02-09 17:56:43 +00:00
this.setPath(GetFastValue(sceneConfig, 'path', gameConfig.loaderPath));
this.setPrefix(GetFastValue(sceneConfig, 'prefix', gameConfig.loaderPrefix));
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#enableParallel
* @type {boolean}
* @since 3.0.0
*/
this.enableParallel = GetFastValue(sceneConfig, 'enableParallel', gameConfig.loaderEnableParallel);
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#maxParallelDownloads
* @type {integer}
* @since 3.0.0
*/
this.maxParallelDownloads = GetFastValue(sceneConfig, 'maxParallelDownloads', gameConfig.loaderMaxParallelDownloads);
2018-02-09 17:56:43 +00:00
/**
* xhr specific global settings (can be overridden on a per-file basis)
*
* @name Phaser.Loader.LoaderPlugin#xhr
2018-03-21 12:03:14 +00:00
* @type {XHRSettingsObject}
2018-02-09 17:56:43 +00:00
* @since 3.0.0
*/
this.xhr = XHRSettings(
GetFastValue(sceneConfig, 'responseType', gameConfig.loaderResponseType),
GetFastValue(sceneConfig, 'async', gameConfig.loaderAsync),
GetFastValue(sceneConfig, 'user', gameConfig.loaderUser),
GetFastValue(sceneConfig, 'password', gameConfig.loaderPassword),
GetFastValue(sceneConfig, 'timeout', gameConfig.loaderTimeout)
);
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#crossOrigin
* @type {string}
* @since 3.0.0
*/
this.crossOrigin = GetFastValue(sceneConfig, 'crossOrigin', gameConfig.loaderCrossOrigin);
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#totalToLoad
* @type {integer}
2018-02-09 17:56:43 +00:00
* @default 0
* @since 3.0.0
*/
this.totalToLoad = 0;
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#progress
* @type {float}
2018-02-09 17:56:43 +00:00
* @default 0
* @since 3.0.0
*/
this.progress = 0;
2018-02-09 17:56:43 +00:00
/**
* Files are placed in this Set when they're added to the Loader via `addFile`.
*
* They are moved to the `inflight` Set when they start loading, and assuming a successful
* load, to the `queue` Set for further processing.
*
* By the end of the load process this Set will be empty.
2018-02-09 17:56:43 +00:00
*
* @name Phaser.Loader.LoaderPlugin#list
2018-03-23 15:54:12 +00:00
* @type {Phaser.Structs.Set.<Phaser.Loader.File>}
2018-02-09 17:56:43 +00:00
* @since 3.0.0
*/
2017-10-04 22:48:16 +00:00
this.list = new CustomSet();
2018-02-09 17:56:43 +00:00
/**
* Files are stored in this Set while they're in the process of being loaded.
*
* Upon a successful load they are moved to the `queue` Set.
*
* By the end of the load process this Set will be empty.
2018-02-09 17:56:43 +00:00
*
* @name Phaser.Loader.LoaderPlugin#inflight
2018-03-23 15:54:12 +00:00
* @type {Phaser.Structs.Set.<Phaser.Loader.File>}
2018-02-09 17:56:43 +00:00
* @since 3.0.0
*/
2017-10-04 22:48:16 +00:00
this.inflight = new CustomSet();
2018-02-09 17:56:43 +00:00
/**
* Files are stored in this Set while they're being processed.
*
* If the process is successful they are moved to their final destination, which could be
* a Cache or the Texture Manager.
*
* At the end of the load process this Set will be empty.
2018-02-09 17:56:43 +00:00
*
* @name Phaser.Loader.LoaderPlugin#queue
2018-03-23 15:54:12 +00:00
* @type {Phaser.Structs.Set.<Phaser.Loader.File>}
2018-02-09 17:56:43 +00:00
* @since 3.0.0
*/
this.queue = new CustomSet();
2018-02-09 17:56:43 +00:00
/**
* A temporary Set in which files are stored after processing,
* awaiting destruction at the end of the load process.
*
* @name Phaser.Loader.LoaderPlugin#_deleteQueue
* @type {Phaser.Structs.Set.<Phaser.Loader.File>}
* @private
* @since 3.7.0
*/
this._deleteQueue = new CustomSet();
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#totalFailed
* @type {integer}
* @default 0
* @since 3.7.0
2018-02-09 17:56:43 +00:00
*/
this.totalFailed = 0;
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#totalComplete
* @type {integer}
* @default 0
* @since 3.7.0
2018-02-09 17:56:43 +00:00
*/
this.totalComplete = 0;
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @name Phaser.Loader.LoaderPlugin#state
* @type {integer}
* @since 3.0.0
*/
this.state = CONST.LOADER_IDLE;
scene.sys.events.once('boot', this.boot, this);
scene.sys.events.on('start', this.pluginStart, this);
},
/**
* This method is called automatically, only once, when the Scene is first created.
* Do not invoke it directly.
*
* @method Phaser.Loader.LoaderPlugin#boot
* @private
* @since 3.5.1
*/
boot: function ()
{
this.systems.events.once('destroy', this.destroy, this);
},
2018-02-09 17:56:43 +00:00
/**
* This method is called automatically by the Scene when it is starting up.
* It is responsible for creating local systems, properties and listening for Scene events.
* Do not invoke it directly.
2018-02-09 17:56:43 +00:00
*
* @method Phaser.Loader.LoaderPlugin#pluginStart
* @private
* @since 3.5.1
2018-02-09 17:56:43 +00:00
*/
pluginStart: function ()
2018-01-19 14:47:16 +00:00
{
this.systems.events.once('shutdown', this.shutdown, this);
2018-01-19 14:47:16 +00:00
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#setBaseURL
* @since 3.0.0
*
* @param {string} url - The URL to use. Leave empty to reset.
2018-02-09 17:56:43 +00:00
*
* @return {Phaser.Loader.LoaderPlugin} This Loader object.
*/
setBaseURL: function (url)
{
if (url === undefined) { url = ''; }
if (url !== '' && url.substr(-1) !== '/')
{
url = url.concat('/');
}
this.baseURL = url;
return this;
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#setPath
* @since 3.0.0
*
* @param {string} path - The path to use. Leave empty to reset.
2018-02-09 17:56:43 +00:00
*
* @return {Phaser.Loader.LoaderPlugin} This Loader object.
*/
setPath: function (path)
{
if (path === undefined) { path = ''; }
if (path !== '' && path.substr(-1) !== '/')
{
path = path.concat('/');
}
this.path = path;
return this;
},
/**
* An optional prefix that is automatically prepended to the start of every file key.
* If prefix was `MENU` and you load an image with the key 'Background' the resulting key would be `MENUBackground`.
*
* @method Phaser.Loader.LoaderPlugin#setPrefix
* @since 3.7.0
*
* @param {string} prefix - The prefix to use. Leave empty to reset.
*
* @return {Phaser.Loader.LoaderPlugin} This Loader object.
*/
setPrefix: function (prefix)
{
if (prefix === undefined) { prefix = ''; }
this.prefix = prefix;
return this;
},
2018-02-13 05:54:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#setCORS
* @since 3.0.0
*
* @param {string} crossOrigin - [description]
*
* @return {Phaser.Loader.LoaderPlugin} This Loader object.
*/
setCORS: function (crossOrigin)
{
this.crossOrigin = crossOrigin;
return this;
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#addFile
* @since 3.0.0
*
* @param {(Phaser.Loader.File|Phaser.Loader.File[])} file - The file, or array of files, to be added to the load queue.
2018-02-09 17:56:43 +00:00
*/
addFile: function (file)
{
if (!Array.isArray(file))
{
file = [ file ];
}
for (var i = 0; i < file.length; i++)
{
var item = file[i];
// Does the file already exist in the cache or texture manager?
// Or will it conflict with a file already in the queue or inflight?
if (!this.keyExists(item))
{
this.list.set(item);
console.log('addFile', item.key);
if (this.isLoading())
{
this.totalToLoad++;
this.updateProgress();
}
}
}
},
/**
* Checks the key and type of the given file to see if it will conflict with anything already
* in a Cache, the Texture Manager, or the list or inflight queues.
*
* @method Phaser.Loader.LoaderPlugin#keyExists
* @since 3.7.0
*
* @param {Phaser.Loader.File} file - The file to check the key of.
*
* @return {boolean} `true` if adding this file will cause a cache or queue conflict, otherwise `false`.
*/
keyExists: function (file)
{
var keyConflict = file.hasCacheConflict();
if (!keyConflict)
{
this.list.iterate(function (item)
{
if (item.type === file.type && item.key === file.key)
{
keyConflict = true;
return false;
}
});
}
if (!keyConflict && this.isLoading())
{
this.inflight.iterate(function (item)
{
if (item.type === file.type && item.key === file.key)
{
keyConflict = true;
return false;
}
});
this.queue.iterate(function (item)
{
if (item.type === file.type && item.key === file.key)
{
keyConflict = true;
return false;
}
});
}
return keyConflict;
},
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#addPack
* @since 3.7.0
*
* @param {any} data - The Pack File data, or an array of Pack File data, to be added to the load queue.
*/
addPack: function (pack, packKey)
{
// if no packKey provided we'll add everything to the queue
if (packKey && pack.hasOwnProperty(packKey))
{
pack = { packKey: pack[packKey] };
}
console.log('---------> addPack', packKey);
console.log(pack);
// Store the loader settings in case this pack replaces them
var currentBaseURL = this.baseURL;
var currentPath = this.path;
var currentPrefix = this.prefix;
// Here we go ...
for (var key in pack)
{
var config = pack[key];
// Any meta data to process?
var baseURL = GetFastValue(config, 'baseURL', currentBaseURL);
var path = GetFastValue(config, 'path', currentPath);
var prefix = GetFastValue(config, 'prefix', currentPrefix);
var files = GetFastValue(config, 'files', null);
var defaultType = GetFastValue(config, 'defaultType', 'void');
if (Array.isArray(files))
{
this.setBaseURL(baseURL);
this.setPath(path);
this.setPrefix(prefix);
for (var i = 0; i < files.length; i++)
{
var file = files[i];
var type = (file.hasOwnProperty('type')) ? file.type : defaultType;
if (this[type])
{
this[type](file);
}
}
}
}
// Reset the loader settings
this.setBaseURL(currentBaseURL);
this.setPath(currentPath);
this.setPrefix(currentPrefix);
return this;
},
2018-02-09 17:56:43 +00:00
/**
* Is the Loader actively loading (or processing loaded files)
*
* @method Phaser.Loader.LoaderPlugin#isLoading
* @since 3.0.0
*
* @return {boolean} [description]
*/
isLoading: function ()
{
return (this.state === CONST.LOADER_LOADING || this.state === CONST.LOADER_PROCESSING);
},
2018-02-09 17:56:43 +00:00
/**
* Is the Loader ready to start a new load?
*
* @method Phaser.Loader.LoaderPlugin#isReady
* @since 3.0.0
*
* @return {boolean} [description]
*/
isReady: function ()
{
return (this.state === CONST.LOADER_IDLE || this.state === CONST.LOADER_COMPLETE);
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#start
* @since 3.0.0
*/
start: function ()
{
if (!this.isReady())
{
return;
}
this.progress = 0;
this.totalFailed = 0;
this.totalComplete = 0;
this.totalToLoad = this.list.size;
console.log('start', this.totalToLoad);
this.emit('start', this);
if (this.list.size === 0)
{
this.loadComplete();
}
else
{
this.state = CONST.LOADER_LOADING;
this.inflight.clear();
this.queue.clear();
this.updateProgress();
this.processLoadQueue();
}
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#updateProgress
* @since 3.0.0
*/
updateProgress: function ()
{
this.progress = 1 - ((this.list.size + this.inflight.size) / this.totalToLoad);
this.emit('progress', this.progress);
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#processLoadQueue
* @since 3.0.0
*/
processLoadQueue: function ()
{
this.list.each(function (file)
{
if (file.state === CONST.FILE_POPULATED || (file.state === CONST.FILE_PENDING && this.inflight.size < this.maxParallelDownloads))
{
2017-10-04 22:48:16 +00:00
this.inflight.set(file);
2017-10-04 22:48:16 +00:00
this.list.delete(file);
// If the file doesn't have its own crossOrigin set,
// we'll use the Loaders (which is undefined by default)
if (!file.crossOrigin)
{
file.crossOrigin = this.crossOrigin;
}
console.log('processLoadQueue', file.key);
file.load();
}
2017-10-04 22:48:16 +00:00
if (this.inflight.size === this.maxParallelDownloads)
{
// Tells the Set iterator to abort
return false;
}
2017-10-04 22:48:16 +00:00
}, this);
},
2018-02-09 17:56:43 +00:00
/**
* Called automatically by the Files XHRLoader function.
2018-02-09 17:56:43 +00:00
*
* @method Phaser.Loader.LoaderPlugin#nextFile
2018-02-09 17:56:43 +00:00
* @since 3.0.0
*
* @param {Phaser.Loader.File} file - The File that just finished loading, or errored during load.
* @param {boolean} success - `true` if the file loaded successfully, otherwise `false`.
2018-02-09 17:56:43 +00:00
*/
nextFile: function (file, success)
{
console.log('nextFile', file.key, success);
this.inflight.delete(file);
this.updateProgress();
if (success)
{
this.totalComplete++;
this.queue.set(file);
this.emit('load', file);
console.log('nextFile 1');
file.onProcess();
}
else
{
this.totalFailed++;
this._deleteQueue.set(file);
this.emit('loaderror', file);
console.log('nextFile 2');
}
if (this.list.size > 0)
{
console.log('nextFile processLoadQueue');
this.processLoadQueue();
}
2016-12-07 00:27:56 +00:00
},
2018-02-09 17:56:43 +00:00
/**
* Called automatically by the File when it has finished processing.
*
* @method Phaser.Loader.LoaderPlugin#fileProcessComplete
* @since 3.7.0
2018-02-09 17:56:43 +00:00
*
* @param {Phaser.Loader.File} file - [description]
*/
fileProcessComplete: function (file)
2016-12-07 00:27:56 +00:00
{
// This file has failed, so move it to the failed Set
if (file.state === CONST.FILE_ERRORED)
{
if (file.linkFile)
{
file.linkFile.onFileFailed(file);
}
}
else if (file.state === CONST.FILE_COMPLETE)
{
if (file.linkFile && file.linkFile.isReadyToProcess())
{
// If we got here then all files the link file needs are ready to add to the cache
file.linkFile.addToCache();
}
else
{
// If we got here, then the file processed, so let it add itself to its cache
file.addToCache();
}
}
// Remove it from the queue
this.queue.delete(file);
// Nothing left to do?
if (this.list.size === 0 && this.inflight.size === 0 && this.queue.size === 0)
{
this.loadComplete();
}
else
{
// In case we've added to the list by processing this file
this.processLoadQueue();
}
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#loadComplete
* @since 3.7.0
2018-02-09 17:56:43 +00:00
*/
loadComplete: function ()
2016-12-07 00:27:56 +00:00
{
console.log('>>> loadComplete');
this.emit('loadcomplete', this);
this.list.clear();
this.inflight.clear();
this.queue.clear();
this.progress = 1;
this.state = CONST.LOADER_COMPLETE;
// Call 'destroy' on each file ready for deletion
this._deleteQueue.iterateLocal('destroy');
this._deleteQueue.clear();
this.emit('complete', this, this.totalComplete, this.totalFailed);
},
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#flagForRemoval
* @since 3.7.0
*
* @param {Phaser.Loader.File} file - [description]
*/
flagForRemoval: function (file)
{
this._deleteQueue.set(file);
},
2018-02-09 17:56:43 +00:00
/**
* !!! TO BE DELETED !!!
* !!! TO BE DELETED !!!
* !!! TO BE DELETED !!!
2018-02-09 17:56:43 +00:00
*
* @method Phaser.Loader.LoaderPlugin#processCallback
* @since 3.0.0
*/
___processCallback: function ()
{
if (this.storage.size === 0)
{
return;
}
// Process all of the files
this.storage.each(function (file)
{
if (file.linkFile)
{
file.linkFile.addToCache();
}
else
{
file.addToCache();
}
/*
switch (file.type)
{
case 'dataimage':
fileA = file.fileA;
fileB = file.fileB;
if (fileA.linkParent)
{
textures.addImage(fileA.key, fileA.data, fileB.data);
}
else
{
textures.addImage(fileB.key, fileB.data, fileA.data);
}
break;
case 'audioSprite':
var files = [ file.fileA, file.fileB ];
files.forEach(function (file)
{
cache[file.type].add(file.key, file.data);
});
break;
}
*/
});
this.emit('processcomplete', this);
// Call 'destroy' on each file in storage
this.storage.iterateLocal('destroy');
this.storage.clear();
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#saveJSON
* @since 3.0.0
*
2018-03-20 16:15:49 +00:00
* @param {*} data - [description]
2018-03-19 00:54:19 +00:00
* @param {string} [filename=file.json] - [description]
2018-02-09 17:56:43 +00:00
*
2018-03-19 00:54:19 +00:00
* @return {Phaser.Loader.LoaderPlugin} This Loader plugin.
2018-02-09 17:56:43 +00:00
*/
saveJSON: function (data, filename)
{
return this.save(JSON.stringify(data), filename);
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#save
* @since 3.0.0
*
2018-03-20 16:15:49 +00:00
* @param {*} data - [description]
2018-03-19 00:54:19 +00:00
* @param {string} [filename=file.json] - [description]
* @param {string} [filetype=application/json] - [description]
2018-02-09 17:56:43 +00:00
*
* @return {Phaser.Loader.LoaderPlugin} This Loader plugin.
*/
save: function (data, filename, filetype)
{
if (filename === undefined) { filename = 'file.json'; }
if (filetype === undefined) { filetype = 'application/json'; }
var blob = new Blob([ data ], { type: filetype });
var url = URL.createObjectURL(blob);
var a = document.createElement('a');
a.download = filename;
a.textContent = 'Download ' + filename;
a.href = url;
a.click();
return this;
},
2018-02-09 17:56:43 +00:00
/**
* [description]
*
* @method Phaser.Loader.LoaderPlugin#reset
* @since 3.0.0
*/
reset: function ()
{
this.list.clear();
this.inflight.clear();
this.queue.clear();
var gameConfig = this.systems.game.config;
var sceneConfig = this.systems.settings.loader;
this.setBaseURL(GetFastValue(sceneConfig, 'baseURL', gameConfig.loaderBaseURL));
this.setPath(GetFastValue(sceneConfig, 'path', gameConfig.loaderPath));
this.setPrefix(GetFastValue(sceneConfig, 'prefix', gameConfig.loaderPrefix));
this.state = CONST.LOADER_IDLE;
},
2018-02-09 17:56:43 +00:00
/**
* !!! TO BE REPLACED BY THE PACK LOADER METHOD !!!
* !!! TO BE REPLACED BY THE PACK LOADER METHOD !!!
* !!! TO BE REPLACED BY THE PACK LOADER METHOD !!!
*
* Called by the Scene Manager if you specify a files payload for a pre-Scene Boot.
* Takes an array of file objects.
2018-02-09 17:56:43 +00:00
*
* @method Phaser.Loader.LoaderPlugin#loadArray
* @since 3.0.0
*
* @param {LoaderFileObject[]} files - An array of files to load.
2018-02-09 17:56:43 +00:00
*
* @return {boolean} `true` if any files were successfully added to the list, otherwise `false`.
2018-02-09 17:56:43 +00:00
*/
loadArray: function (files)
{
if (Array.isArray(files))
{
for (var i = 0; i < files.length; i++)
{
var file = files[i];
// Calls file-type methods like `atlas` or `image`
this[file.type](file);
}
}
return (this.list.size > 0);
},
2018-02-09 17:56:43 +00:00
/**
* The Scene that owns this plugin is shutting down.
* We need to kill and reset all internal properties as well as stop listening to Scene events.
2018-02-09 17:56:43 +00:00
*
* @method Phaser.Loader.LoaderPlugin#shutdown
* @private
2018-02-09 17:56:43 +00:00
* @since 3.0.0
*/
shutdown: function ()
{
this.reset();
this.state = CONST.LOADER_SHUTDOWN;
this.systems.events.off('shutdown', this.shutdown, this);
},
2018-02-09 17:56:43 +00:00
/**
* The Scene that owns this plugin is being destroyed.
* We need to shutdown and then kill off all external references.
2018-02-09 17:56:43 +00:00
*
* @method Phaser.Loader.LoaderPlugin#destroy
* @private
2018-02-09 17:56:43 +00:00
* @since 3.0.0
*/
destroy: function ()
{
this.shutdown();
this.state = CONST.LOADER_DESTROYED;
this.systems.events.off('start', this.pluginStart, this);
this.list = null;
this.inflight = null;
this.queue = null;
this.scene = null;
this.systems = null;
2018-04-25 16:16:39 +00:00
this.textureManager = null;
this.cacheManager = null;
}
});
PluginManager.register('Loader', LoaderPlugin, 'load');
2018-01-19 14:47:16 +00:00
module.exports = LoaderPlugin;