AssetListLoader
Extends: EventHandler
Used to load a group of assets and fires a callback when all assets are loaded.
const assets = [
new Asset('model', 'container', { url: `http://example.com/asset.glb` }),
new Asset('styling', 'css', { url: `http://example.com/asset.css` })
];
const assetListLoader = new AssetListLoader(assets, app.assets);
assetListLoader.load((err, failed) => {
if (err) {
console.error(`${failed.length} assets failed to load`);
} else {
console.log(`${assets.length} assets loaded`);
}
});
const assetListLoader = new pc.AssetListLoader([
new pc.Asset("texture1", "texture", { url: 'http://example.com/my/assets/here/texture1.png') }),
new pc.Asset("texture2", "texture", { url: 'http://example.com/my/assets/here/texture2.png') })
], pc.app.assets);
Summary
Methods
destroy | Removes all references to this asset list loader. |
load | Start loading asset list, call done() when all assets have loaded or failed to load. |
ready | Sets a callback which will be called when all assets in the list have been loaded. |
Inherited
Methods
fire | Fire an event, all additional arguments are passed on to the event listener. |
hasEvent | Test if there are any handlers bound to an event name. |
off | Detach an event handler from an event. |
on | Attach an event handler to an event. |
once | Attach an event handler to an event. |
Details
Constructor
AssetListLoader(assetList, assetRegistry)
Create a new AssetListLoader using a list of assets to load and the asset registry used to load and manage them.
const assetListLoader = new pc.AssetListLoader([
new pc.Asset("texture1", "texture", { url: 'http://example.com/my/assets/here/texture1.png') }),
new pc.Asset("texture2", "texture", { url: 'http://example.com/my/assets/here/texture2.png') })
], pc.app.assets);
Parameters
assetList | Asset[], number[] | An array of Asset objects to load or an array of Asset IDs to load. |
assetRegistry | AssetRegistry | The application's asset registry. |
Methods
destroy()
Removes all references to this asset list loader.
load(done, [scope])
Start loading asset list, call done() when all assets have loaded or failed to load.
Parameters
done | function | Callback called when all assets in the list are loaded. Passed (err, failed) where err is the undefined if no errors are encountered and failed contains a list of assets that failed to load. |
scope | object | Scope to use when calling callback. |
ready(done, [scope])
Sets a callback which will be called when all assets in the list have been loaded.
Parameters
done | function | Callback called when all assets in the list are loaded. |
scope | object | Scope to use when calling callback. |
Inherited
Methods
fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])
Fire an event, all additional arguments are passed on to the event listener.
obj.fire('test', 'This is the message');
Parameters
name | string | Name of event to fire. |
arg1 | * | First argument that is passed to the event handler. |
arg2 | * | Second argument that is passed to the event handler. |
arg3 | * | Third argument that is passed to the event handler. |
arg4 | * | Fourth argument that is passed to the event handler. |
arg5 | * | Fifth argument that is passed to the event handler. |
arg6 | * | Sixth argument that is passed to the event handler. |
arg7 | * | Seventh argument that is passed to the event handler. |
arg8 | * | Eighth argument that is passed to the event handler. |
Returns
EventHandlerSelf for chaining.
hasEvent(name)
Test if there are any handlers bound to an event name.
obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
Parameters
name | string | The name of the event to test. |
Returns
booleanTrue if the object has handlers bound to the specified event name.
off([name], [callback], [scope])
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
const handler = function () {
};
obj.on('test', handler);
obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
Parameters
name | string | Name of the event to unbind. |
callback | HandleEventCallback | Function to be unbound. |
scope | object | Scope that was used as the this when the event is fired. |
Returns
EventHandlerSelf for chaining.
on(name, callback, [scope])
Attach an event handler to an event.
obj.on('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
Parameters
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandlerSelf for chaining.
once(name, callback, [scope])
Attach an event handler to an event. This handler will be removed after being fired once.
obj.once('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled
Parameters
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandlerSelf for chaining.