| Package | com.greensock.loading.data |
| Class | public dynamic class LoaderMaxVars |
| Inheritance | LoaderMaxVars  LoaderCoreVars |
vars parameter of a LoaderMax's constructor. onComplete where a Function is expected).new LoaderMax({name:"mainQueue", onComplete:completeHandler, onProgress:progressHandler}), you could use this utility like:
var vars:LoaderMaxVars = new LoaderMaxVars();
vars.name = "mainQueue";
vars.onComplete = completeHandler;
vars.onProgress = progressHandler;
var queue:LoaderMax = new LoaderMax(vars);
Some of the most common properties can be defined directly in the constructor like this:
var queue:LoaderMax = new LoaderMax( new LoaderMaxVars("mainQueue", completeHandler, progressHandler) );
NOTE: Using LoaderMaxVars is completely optional. If you prefer the shorter synatax with the generic Object, feel
free to use it. The purpose of this class is simply to enable code hinting and to allow for strict data typing. | Property | Defined by | ||
|---|---|---|---|
| auditSize : Boolean By default, when the LoaderMax begins to load it quickly loops through its children and if it finds any that don't have an
estimatedBytes defined, it will briefly open a URLStream in order to attempt to determine its bytesTotal, immediately closing the URLStream once the value has been determined. | LoaderMaxVars | ||
 | autoDispose : Boolean When
autoDispose is true, the loader will be disposed immediately after it completes (it calls the dispose() method internally after dispatching its COMPLETE event). | LoaderCoreVars | |
| loaders : Array An array of loaders (ImageLoaders, SWFLoaders, XMLLoaders, MP3Loaders, other LoaderMax instances, etc.) that should be immediately inserted into the LoaderMax.
| LoaderMaxVars | ||
| maxConnections : uint Maximum number of simultaneous connections that should be used while loading the LoaderMax queue.
| LoaderMaxVars | ||
| name : String A name that is used to identify the loader instance.
| LoaderCoreVars | |
| onCancel : Function A handler function for
LoaderEvent.CANCEL events which are dispatched when loading is aborted due to either a failure or because another loader was prioritized or cancel() was manually called. | LoaderCoreVars | |
| onChildCancel : Function A handler function for
LoaderEvent.CHILD_CANCEL events which are dispatched each time loading is aborted on one of the loader's children (or any descendant) due to either an error or because another loader was prioritized in the queue or because cancel() was manually called on the child loader. | LoaderMaxVars | ||
| onChildComplete : Function A handler function for
LoaderEvent.CHILD_COMPLETE events which are dispatched each time one of the loader's children (or any descendant) finishes loading successfully. | LoaderMaxVars | ||
| onChildFail : Function A handler function for
LoaderEvent.CHILD_FAIL events which are dispatched each time one of the loader's children (or any descendant) fails (and its status chances to LoaderStatus.FAILED). | LoaderMaxVars | ||
| onChildOpen : Function A handler function for
LoaderEvent.CHILD_OPEN events which are dispatched each time one of the loader's children (or any descendant) begins loading. | LoaderMaxVars | ||
| onChildProgress : Function A handler function for
LoaderEvent.CHILD_PROGRESS events which are dispatched each time one of the loader's children (or any descendant) dispatches a PROGRESS event. | LoaderMaxVars | ||
| onComplete : Function A handler function for
LoaderEvent.COMPLETE events which are dispatched when the loader has finished loading successfully. | LoaderCoreVars | |
| onError : Function A handler function for
LoaderEvent.ERROR events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). | LoaderCoreVars | |
| onFail : Function A handler function for
LoaderEvent.FAIL events which are dispatched whenever the loader fails and its status changes to LoaderStatus.FAILED. | LoaderCoreVars | |
| onHTTPStatus : Function A handler function for
LoaderEvent.HTTP_STATUS events. | LoaderCoreVars | |
| onIOError : Function A handler function for
LoaderEvent.IO_ERROR events which will also call the onError handler, so you can use that as more of a catch-all whereas onIOError is specifically for LoaderEvent.IO_ERROR events. | LoaderCoreVars | |
| onOpen : Function A handler function for
LoaderEvent.OPEN events which are dispatched when the loader begins loading. | LoaderCoreVars | |
| onProgress : Function A handler function for
LoaderEvent.PROGRESS events which are dispatched whenever the bytesLoaded changes. | LoaderCoreVars | |
| onScriptAccessDenied : Function A handler function for
LoaderEvent.SCRIPT_ACCESS_DENIED events which are dispatched when one of the LoaderMax's children (or any descendant) is loaded from another domain and no crossdomain.xml is in place to grant full script access for things like smoothing or BitmapData manipulation. | LoaderMaxVars | ||
| requireWithRoot : DisplayObject LoaderMax supports subloading, where an object can be factored into a parent's loading progress.
| LoaderCoreVars | |
| skipFailed : Boolean If
skipFailed is true (the default), any failed loaders in the queue will be skipped. | LoaderMaxVars | ||
| skipPaused : Boolean If
skipPaused is true (the default), any paused loaders in the queue will be skipped. | LoaderMaxVars | ||
| Method | Defined by | ||
|---|---|---|---|
|
LoaderMaxVars(name:String = "", onComplete:Function = null, onProgress:Function = null, onFail:Function = null, maxConnections:uint = 2, auditSize:Boolean = true, requireWithRoot:DisplayObject = null, skipFailed:Boolean = true, skipPaused:Boolean = true)
Constructor
| LoaderMaxVars | ||
|
Clones the object.
| LoaderMaxVars | ||
| auditSize | property |
Hide Inherited Public Properties
Show Inherited Public Propertiespublic var auditSize:Boolean By default, when the LoaderMax begins to load it quickly loops through its children and if it finds any that don't have an estimatedBytes defined, it will briefly open a URLStream in order to attempt to determine its bytesTotal, immediately closing the URLStream once the value has been determined. This causes a brief delay initially, but greatly improves the accuracy of the progress and bytesTotal values. Set auditSize to false to prevent the LoaderMax from auditing its childrens' size (it is true by default). For maximum performance, it is best to define an estimatedBytes value for as many loaders as possible to avoid the delay caused by audits. When the LoaderMax audits an XMLLoader, it cannot recognize loaders that will be created from the XML data nor can it recognize loaders inside subloaded swf files from a SWFLoader (it would take far too long to load sufficient data for that - audits should be as fast as possible). If you do not set an appropriate estimatedSize for XMLLoaders or SWFLoaders that contain LoaderMax loaders, you'll notice that the parent LoaderMax's progress and bytesTotal change when the nested loaders are recognized (this is normal). To control the default auditSize value, use the static LoaderMax.defaultAuditSize property.
| loaders | property |
public var loaders:ArrayAn array of loaders (ImageLoaders, SWFLoaders, XMLLoaders, MP3Loaders, other LoaderMax instances, etc.) that should be immediately inserted into the LoaderMax.
| maxConnections | property |
public var maxConnections:uint Maximum number of simultaneous connections that should be used while loading the LoaderMax queue. A higher number will generally result in faster overall load times for the group. The default is 2. This value is instance-based, not system-wide, so if you have two LoaderMax instances that both have a maxConnections value of 3 and they are both loading, there could be up to 6 connections at a time total. Sometimes there are limits imposed by the Flash Player itself or the browser or the user's system, but LoaderMax will do its best to honor the maxConnections you define.
| onChildCancel | property |
public var onChildCancel:Function A handler function for LoaderEvent.CHILD_CANCEL events which are dispatched each time loading is aborted on one of the loader's children (or any descendant) due to either an error or because another loader was prioritized in the queue or because cancel() was manually called on the child loader. Make sure your onChildCancel function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| onChildComplete | property |
public var onChildComplete:Function A handler function for LoaderEvent.CHILD_COMPLETE events which are dispatched each time one of the loader's children (or any descendant) finishes loading successfully. Make sure your onChildComplete function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| onChildFail | property |
public var onChildFail:Function A handler function for LoaderEvent.CHILD_FAIL events which are dispatched each time one of the loader's children (or any descendant) fails (and its status chances to LoaderStatus.FAILED). Make sure your onChildFail function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| onChildOpen | property |
public var onChildOpen:Function A handler function for LoaderEvent.CHILD_OPEN events which are dispatched each time one of the loader's children (or any descendant) begins loading. Make sure your onChildOpen function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| onChildProgress | property |
public var onChildProgress:Function A handler function for LoaderEvent.CHILD_PROGRESS events which are dispatched each time one of the loader's children (or any descendant) dispatches a PROGRESS event. To listen for changes in the LoaderMax's overall progress, use the onProgress special property instead. You can use the LoaderEvent's target.progress to get the child loader's progress value or use its target.bytesLoaded and target.bytesTotal. The LoaderEvent's currentTarget refers to the LoaderMax, so you can check its overall progress with the LoaderEvent's currentTarget.progress. Make sure your onChildProgress function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| onScriptAccessDenied | property |
public var onScriptAccessDenied:Function A handler function for LoaderEvent.SCRIPT_ACCESS_DENIED events which are dispatched when one of the LoaderMax's children (or any descendant) is loaded from another domain and no crossdomain.xml is in place to grant full script access for things like smoothing or BitmapData manipulation. Make sure your function accepts a single parameter of type LoaderEvent (com.greensock.events.LoaderEvent).
| skipFailed | property |
public var skipFailed:Boolean If skipFailed is true (the default), any failed loaders in the queue will be skipped. Otherwise, the LoaderMax will stop when it hits a failed loader and the LoaderMax's status will become LoaderStatus.FAILED.
| skipPaused | property |
public var skipPaused:Boolean If skipPaused is true (the default), any paused loaders in the queue will be skipped. Otherwise, the LoaderMax will stop when it hits a paused loader and the LoaderMax's status will become LoaderStatus.FAILED.
| LoaderMaxVars | () | constructor |
public function LoaderMaxVars(name:String = "", onComplete:Function = null, onProgress:Function = null, onFail:Function = null, maxConnections:uint = 2, auditSize:Boolean = true, requireWithRoot:DisplayObject = null, skipFailed:Boolean = true, skipPaused:Boolean = true)Constructor
Parametersname:String (default = " |
|
onComplete:Function (default = null) |
|
onProgress:Function (default = null) |
|
onFail:Function (default = null) |
|
maxConnections:uint (default = 2) |
|
auditSize:Boolean (default = true) |
|
requireWithRoot:DisplayObject (default = null) |
|
skipFailed:Boolean (default = true) |
|
skipPaused:Boolean (default = true) |
| clone | () | method |