Indicates whether or not the loader's bytesTotal value has been set by any of the following:

• Defining an estimatedBytes in the vars object passed to the constructor
• Calling auditSize() and getting a response (an error is also considered a response)
• When a LoaderMax instance begins loading, it will automatically force a call to auditSize() for any of its children that don't have an estimatedBytes defined. You can disable this behavior by passing auditSize:false through the constructor's vars object.

When autoDispose is true, the loader will be disposed immediately after it completes (it calls the dispose() method internally after dispatching its COMPLETE event). This will remove any listeners that were defined in the vars object (like onComplete, onProgress, onError, onInit). Once a loader is disposed, it can no longer be found with LoaderMax.getLoader() or LoaderMax.getContent() - it is essentially destroyed but its content is not unloaded (you must call unload() or dispose(true) to unload its content). The default autoDispose value is false.

Bytes loaded

Total bytes that are to be loaded by the loader. Initially, this value is set to the estimatedBytes if one was defined in the vars object via the constructor, or it defaults to LoaderMax.defaultEstimatedBytes. When the loader loads enough of the content to accurately determine the bytesTotal, it will do so automatically.

The content that was loaded by the loader which varies by the type of loader:

• ImageLoader - A com.greensock.loading.display.ContentDisplay (a Sprite) which contains the ImageLoader's rawContent (a flash.display.Bitmap unless script access was denied in which case rawContent will be a flash.display.Loader to avoid security errors). For Flex users, you can set LoaderMax.defaultContentDisplay to FlexContentDisplay in which case ImageLoaders, SWFLoaders, and VideoLoaders will return a com.greensock.loading.display.FlexContentDisplay instance instead.
• SWFLoader - A com.greensock.loading.display.ContentDisplay (a Sprite) which contains the SWFLoader's rawContent (the swf's root DisplayObject unless script access was denied in which case rawContent will be a flash.display.Loader to avoid security errors). For Flex users, you can set LoaderMax.defaultContentDisplay to FlexContentDisplay in which case ImageLoaders, SWFLoaders, and VideoLoaders will return a com.greensock.loading.display.FlexContentDisplay instance instead.
• VideoLoader - A com.greensock.loading.display.ContentDisplay (a Sprite) which contains the VideoLoader's rawContent (a Video object to which the NetStream was attached). For Flex users, you can set LoaderMax.defaultContentDisplay to FlexContentDisplay in which case ImageLoaders, SWFLoaders, and VideoLoaders will return a com.greensock.loading.display.FlexContentDisplay instance instead.
• XMLLoader - XML
• DataLoader
  • String if the DataLoader's format vars property is "text" (the default).
  • flash.utils.ByteArray if the DataLoader's format vars property is "binary".
  • flash.net.URLVariables if the DataLoader's format vars property is "variables".
• CSSLoader - flash.text.StyleSheet
• MP3Loader - flash.media.Sound
• LoaderMax - an array containing the content objects from each of its child loaders.

The number of seconds that elapsed between when the loader began and when it either completed, failed, or was canceled. You may check a loader's loadTime anytime, not just after it completes. For example, you could access this value in an onProgress handler and you'd see it steadily increase as the loader loads and then when it completes, loadTime will stop increasing. LoaderMax instances ignore any pauses when calculating this value, so if a LoaderMax begins loading and after 1 second it gets paused, and then 10 seconds later it resumes and takes an additional 14 seconds to complete, its loadTime would be 15, not 25.

A name that you use to identify the loader instance. This name can be fed to the getLoader() or getContent() methods or traced at any time. Each loader's name should be unique. If you don't define one, a unique name will be created automatically, like "loader21".

If a loader is paused, its progress will halt and any LoaderMax instances to which it belongs will either skip over it or stop when its position is reached in the queue (depending on whether or not the LoaderMax's skipPaused property is true).

A value between 0 and 1 indicating the overall progress of the loader. When nothing has loaded, it will be 0; when it is halfway loaded, progress will be 0.5, and when it is fully loaded it will be 1.

Integer code indicating the loader's status; options are LoaderStatus.READY, LoaderStatus.LOADING, LoaderStatus.COMPLETE, LoaderStatus.PAUSED, and LoaderStatus.DISPOSED.

An object containing optional configuration details, typically passed through a constructor parameter. For example: new SWFLoader("assets/file.swf", {name:"swf1", container:this, autoPlay:true, noCache:true}). See the constructor's documentation for details about what special properties are recognized.

Constructor

Attempts loading just enough of the content to accurately determine the bytesTotal in order to improve the accuracy of the progress property. Once the bytesTotal has been determined or the auditSize() attempt fails due to an error (typically IO_ERROR or SECURITY_ERROR), the auditedSize property will be set to true. Auditing the size opens a URLStream that will be closed as soon as a response is received.

If the loader is currently loading (status is LoaderStatus.LOADING), it will be canceled immediately and its status will change to LoaderStatus.READY. This does NOT pause the loader - it simply halts the progress and it remains eligible for loading by any of its parent LoaderMax instances. A paused loader, however, cannot be loaded by any of its parent LoaderMax instances until you unpause it (by either calling resume() or setting its paused property to false).

See also

Disposes of the loader and releases it internally for garbage collection. If it is in the process of loading, it will also be cancelled immediately. By default, dispose() does NOT unload its content, but you may set the flushContent parameter to true in order to flush/unload the content as well (in the case of ImageLoaders, SWFLoaders, and VideoLoaders, this will also destroy its ContentDisplay Sprite, removing it from the display list if necessary). When a loader is disposed, all of the listeners that were added through the vars object (like {onComplete:completeHandler, onProgress:progressHandler}) are removed. If you manually added listeners, though, you should remove those yourself.

See also

Loads the loader's content, optionally flushing any previously loaded content first. For example, a LoaderMax may have already loaded 4 out of the 10 loaders in its queue but if you want it to flush the data and start again, set the flushContent parameter to true (it is false by default).

Pauses the loader immediately. This is the same as setting the paused property to true. Some loaders may not stop loading immediately in order to work around some garbage collection issues in the Flash Player, but they will stop as soon as possible after calling pause().

Immediately prioritizes the loader inside any LoaderMax instances that contain it, forcing it to the top position in their queue and optionally calls load() immediately as well. If one of its parent LoaderMax instances is currently loading a different loader, that one will be temporarily cancelled.

By contrast, when load() is called, it doesn't change the loader's position/index in any LoaderMax queues. For example, if a LoaderMax is working on loading the first object in its queue, you can call load() on the 20th item and it will honor your request without changing its index in the queue. prioritize(), however, affects the position in the queue and optionally loads it immediately as well.

So even if your LoaderMax hasn't begun loading yet, you could prioritize(false) a loader and it will rise to the top of all LoaderMax instances to which it belongs, but not start loading yet. If the goal is to load something immediately, you can just use the load() method.

You may use the static LoaderMax.prioritize() method instead and simply pass the name or url of the loader as the first parameter like:

LoaderMax.prioritize("myLoaderName", true);

See also

Unpauses the loader and resumes loading immediately.

Returns information about the loader, like its type, its name, and its url (if it has one).

Removes any content that was loaded and sets bytesLoaded back to zero. When you unload() a LoaderMax instance, it will also call unload() on all of its children as well. If the loader is in the process of loading, it will automatically be canceled.

See also

Dispatched when the loader is canceled while loading which can occur either because of a failure or when a sibling loader is prioritized in a LoaderMax queue.

Dispatched when the loader completes.

Dispatched when the loader experiences some type of error, like a SECURITY_ERROR or IO_ERROR.

Dispatched when the loader fails.

Dispatched when the loader starts loading.

Dispatched each time the bytesLoaded value changes while loading (indicating progress).