Mirrors/phaser
2
0
Fork 0
mirror of https://github.com/photonstorm/phaser synced 2025-02-26 04:17:08 +00:00
Code Issues Projects Releases Packages Wiki Activity

Loader - added means to add synchronization points

Browse source 
- Added `withSyncPoint` and `addSyncPoint` methods to allow explicit
  adding of synchronization points (synchronization points are explained
  in `withSyncPoint`.

- Changed the file/asset `sync` attribute to `syncPoint` to reflect
  terminology.
This commit is contained in:
Paul 2014-11-22 14:42:27 -08:00
parent a6116b3832
commit 609d77faba
1 changed files with 58 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

62
src/loader/Loader.js
View file

@ -131,6 +131,12 @@ Phaser.Loader = function (game) {
*/
this.maxParallelDownloads = 5;
/**
* A counter: if more than zero files will be automatically added as a synchronization point.
* @property {integer} _withSyncPointDepth;
*/
this._withSyncPointDepth = 0;
/**
* Contains all the information for asset files (including packs) to load.
*
@ -395,6 +401,7 @@ Phaser.Loader.prototype = {
type: type,
key: key,
url: url,
syncPoint: this._withSyncPointDepth > 0,
data: null,
loading: false,
loaded: false,
@ -477,9 +484,9 @@ Phaser.Loader.prototype = {
var pack = {
type: 'packfile',
sync: true,
key: key,
url: url,
syncPoint: true,
data: null,
loading: false,
loaded: false,
@ -613,7 +620,7 @@ Phaser.Loader.prototype = {
// Why is the default callback context the ..callback?
if (callback !== false && typeof callbackContext === 'undefined') { callbackContext = callback; }
this.addToFileList('script', key, url, { sync: true, callback: callback, callbackContext: callbackContext });
this.addToFileList('script', key, url, { syncPoint: true, callback: callback, callbackContext: callbackContext });
return this;
@ -962,6 +969,53 @@ Phaser.Loader.prototype = {
},
/**
* Add a synchronization point to the assets/files added within the supplied callback.
*
* A synchronization point denotes that an asset _must_ be completely loaded before
* subsequent assets can be loaded. An asset marked as a sync-point does not need to wait
* for previous assets to load (unless they are sync-points). Resources, such as packs, may still
* be downloaded around sync-points, as long as they do not finalize loading.
*
* @method Phader.Loader#withSyncPoints
* @param {function} callback - The callback is invoked and is supplied with a single argument: the loader.
* @param {object} [callbackContext=(loader)] - Context for the callback.
* @return {Phaser.Loader} This Loader instance.
*/
withSyncPoint: function (callback, callbackContext) {
this._withSyncPointDepth++;
try {
callback.call(callbackContext || this, this);
} finally {
this._withSyncPointDepth--;
}
return this;
},
/**
* Add a synchronization point to a specific file/asset in the load queue.
*
* This has no effect on already loaded assets.
*
* @method Phader.Loader#withSyncPoints
* @param {function} callback - The callback is invoked and is supplied with a single argument: the loader.
* @param {object} [callbackContext=(loader)] - Context for the callback.
* @return {Phaser.Loader} This Loader instance.
* @see {@link Phaser.Loader#withSyncPoint withSyncPoint}
*/
addSyncPoint: function (type, key) {
var asset = this.getAsset(type, key);
if (asset)
{
asset.file.syncPoint = true;
}
return this;
},
/**
* Remove a file/asset from the loading queue.
*
@ -1138,7 +1192,7 @@ Phaser.Loader.prototype = {
}
}
if (!file.loaded && file.sync)
if (!file.loaded && file.syncPoint)
{
syncblock = true;
}
@ -1316,7 +1370,7 @@ Phaser.Loader.prototype = {
* @method Phaser.Loader#transformUrl
* @protected
*/
transformUrl: function (url, file) {
transformUrl: function (url /*, file */) {
return this.baseURL + url;
},