Class Asset extends MessageDispatcher

This is abstract class for custom assets. For example Asset can be used to load video or other data files.
Holds information about external assets.

Methods

Asset(name) constructor

Creates new Asset instance.

Parameters
name : string — Name of asset.
addLoader(loader) method

Adds given loader to the list. Loader cannot be added to multiply Assets.

Parameters
loader : AssetLoader — Loader to add.
Returns
AssetLoader
onLoaderRequested(factory) method

Called when AssetManager is about to request loaders for this asset.

Parameters
factory : LoaderFactory
onAllLoaded() method
abort() method
Aborts loading of this asset.
ready(data) method

Protected method used to notify AssetManager about completion of loading this asset.

Parameters
data : Object
Returns
void

Inherited Methods

on(name, callback, context) inherited method

Adds listener by given name and callback.

Parameters
name : string — Message name.
callback : function — Function to be called on message send.
context : * — Object to be used as this in callback function.
Returns
MessageBinding
off(names) inherited method

Removes all bindings by given message name.

Parameters
names : string — One or more message name.
Returns
void
once(name, callback, context) inherited method

Adds listener by given name and callback. Binding will be automatically removed after first execution.

Parameters
name : string — Message name.
callback : function — Function to be called on message send.
context : * — Object to be used as this in callback function.
Returns
MessageBinding
post(name, params) inherited method

Posts message with a given params.

Adding ~ character to the begging of the name will bubble message to the top of the tree.

Parameters
name : string — The name of a message
params : * — A list of params to send
Returns
void

Properties

type : string property
Returns the type of this asset.
name : string property
Returns the name of this asset.
data : ? property
Returns loaded data object associated with this asset.
isReady : boolean property
Returns true if this asset is loaded.
loaders : Array. property
Returns array of loaders.

Inherited Properties

parent : MessageDispatcher | null inherited property
Returns parent MessageDispatcher.
stage : Stage | null inherited property
Returns the stage Game Object to which this belongs to or null if not added onto stage.
path : string | null inherited property
Returns string representing a url like path to this object in the display
tree.

Messages

error message
Posted when error occurred during loading this asset.
complete message
Posted when asset finished loading.