| Package | starling.assets |
| Class | public class DataLoader |
| Inheritance | DataLoader  Object |
The DataLoader is used by the AssetManager to load any local or remote data. Its single purpose is to get the binary data that's stored at a specific URL.
You can use this class for your own purposes (as an easier to use 'URLLoader'
alternative), or you can extend the class to modify the AssetManager's behavior.
E.g. you could extend this class to add a caching mechanism for remote assets.
Assign an instance of your extended class to the AssetManager's dataLoader
property.
| Method | Defined By | ||
|---|---|---|---|
Creates a new DataLoader instance. | DataLoader | ||
close():void Aborts all current load operations. | DataLoader | ||
load(url:String, onComplete:Function, onError:Function, onProgress:Function = null):void Loads the binary data from a specific URL. | DataLoader | ||
| DataLoader | () | Constructor |
public function DataLoader()Creates a new DataLoader instance.
| close | () | method |
public function close():voidAborts all current load operations. The loader can still be used, though.
| load | () | method |
public function load(url:String, onComplete:Function, onError:Function, onProgress:Function = null):voidLoads the binary data from a specific URL. Always supply both 'onComplete' and 'onError' parameters; in case of an error, only the latter will be called.
The 'onComplete' callback may have up to four parameters, all of them being optional. If you pass a callback that just takes zero or one, it will work just as well. The additional parameters may be used to describe the name and type of the downloaded data. They are not provided by the base class, but the AssetManager will check if they are available.
Parameters
url:String — a String containing an URL.
| |
onComplete:Function — will be called when the data has been loaded.
function(data:ByteArray, mimeType:String, name:String, extension:String):void
| |
onError:Function — will be called in case of an error. The 2nd parameter is optional.
function(error:String, httpStatus:int):void
| |
onProgress:Function (default = null)function(ratio:Number):void
|