API Documentation | All Packages | All Classes | Index | Frames No Frames |
Class SWFLoaderVars

Package | com.greensock.loading.data
Class | public class SWFLoaderVars

Can be used instead of a generic object to define the `vars` parameter of an SWFLoader's constructor.
There are 2 primary benefits of using a SWFLoaderVars instance to define your SWFLoader variables:

1. In most code editors, code hinting will be activated which helps remind you which special properties are available in SWFLoader
2. It enables strict data typing for improved debugging (ensuring, for example, that you don't define a Boolean value for `onComplete` where a Function is expected).

USAGE:
Note that each method returns the SWFLoaderVars instance, so you can reduce the lines of code by method chaining (see example below).
Without SWFLoaderVars:
`new SWFLoader("child.swf", {name:"swf", estimatedBytes:11500, container:this, width:400, height:300, onComplete:completeHandler, onProgress:progressHandler})
` With SWFLoaderVars
`new SWFLoader("photo1.jpg", new SWFLoaderVars().name("swf").estimatedBytes(11500).container(this).width(400).height(300).onComplete(completeHandler).onProgress(progressHandler))
` NOTES:

- To get the generic vars object that SWFLoaderVars builds internally, simply access its "vars" property. In fact, if you want maximum backwards compatibility, you can tack ".vars" onto the end of your chain like this:
  `new SWFLoader("child.swf", new SWFLoaderVars().name("swf").estimatedBytes(11500).vars);`
- Using SWFLoaderVars 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.

Copyright 2011, GreenSock. All rights reserved. This work is subject to the terms in http://www.greensock.com/terms_of_use.html or for corporate Club GreenSock members, the software agreement that was issued with the corporate membership.

Public Properties

| Property | Defined by
--- | --- | ---
|  | vars : Object [read-only] The generic Object populated by all of the method calls in the SWFLoaderVars instance. | SWFLoaderVars

Public Methods

| Method | Defined by
--- | --- | ---
|  | SWFLoaderVars(vars:Object = null) Constructor | SWFLoaderVars
|  | allowMalformedURL(value:Boolean):SWFLoaderVars Normally, the URL will be parsed and any variables in the query string (like "?name=test&state=il&gender=m") will be placed into a URLVariables object which is added to the URLRequest. | SWFLoaderVars
|  | alpha(value:Number):SWFLoaderVars Sets the `ContentDisplay`'s `alpha` property. | SWFLoaderVars
|  | alternateURL(value:String):SWFLoaderVars If you define an `alternateURL`, the loader will initially try to load from its original `url` and if it fails, it will automatically (and permanently) change the loader's `url` to the `alternateURL` and try again. | SWFLoaderVars
|  | autoDispose(value:Boolean):SWFLoaderVars When `autoDispose` is `true`, the loader will be disposed immediately after it completes (it calls the `dispose()` method internally after dispatching its `COMPLETE` event). | SWFLoaderVars
|  | autoPlay(value:Boolean):SWFLoaderVars If `autoPlay` is `true` (the default), the swf will begin playing immediately when the `INIT` event fires. | SWFLoaderVars
|  | bgAlpha(value:Number):SWFLoaderVars Controls the alpha of the rectangle that is drawn when a `width` and `height` are defined. | SWFLoaderVars
|  | bgColor(value:uint):SWFLoaderVars When a `width` and `height` are defined, a rectangle will be drawn inside the `ContentDisplay` Sprite immediately in order to ease the development process. | SWFLoaderVars
|  | blendMode(value:String):SWFLoaderVars Sets the `ContentDisplay`'s `blendMode` property. | SWFLoaderVars
|  | centerRegistration(value:Boolean):SWFLoaderVars If `true`, the registration point will be placed in the center of the ContentDisplay which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center. | SWFLoaderVars
|  | container(value:DisplayObjectContainer):SWFLoaderVars A DisplayObjectContainer into which the `ContentDisplay` Sprite should be added immediately. | SWFLoaderVars
|  | context(value:LoaderContext):SWFLoaderVars To control whether or not a policy file is checked (which is required if you're loading an image from another domain and you want to use it in BitmapData operations), define a `LoaderContext` object. | SWFLoaderVars
|  | crop(value:Boolean):SWFLoaderVars When a `width` and `height` are defined, setting `crop` to `true` will cause the image to be cropped within that area (by applying a `scrollRect` for maximum performance). | SWFLoaderVars
|  | estimatedBytes(value:uint):SWFLoaderVars Initially, the loader's `bytesTotal` is set to the `estimatedBytes` value (or `LoaderMax.defaultEstimatedBytes` if one isn't defined). | SWFLoaderVars
|  | hAlign(value:String):SWFLoaderVars When a `width` and `height` is defined, the `hAlign` determines how the image is horizontally aligned within that area. | SWFLoaderVars
|  | height(value:Number):SWFLoaderVars Sets the `ContentDisplay`'s `height` property (applied before rotation, scaleX, and scaleY). | SWFLoaderVars
|  | integrateProgress(value:Boolean):SWFLoaderVars By default, a SWFLoader instance will automatically look for LoaderMax loaders in the swf when it initializes. | SWFLoaderVars
|  | name(value:String):SWFLoaderVars A name that is used to identify the loader instance. | SWFLoaderVars
|  | noCache(value:Boolean):SWFLoaderVars If `true`, a "gsCacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you `LoaderMax.getLoader()` or `LoaderMax.getContent()` by `url` or when you're running locally). | SWFLoaderVars
|  | onCancel(value:Function):SWFLoaderVars 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. | SWFLoaderVars
|  | onChildCancel(value:Function):SWFLoaderVars A handler function for `LoaderEvent.CHILD_CANCEL` events which are dispatched each time loading is aborted on any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) due to either an error or because another loader was prioritized in the queue or because `cancel()` was manually called on the child loader. | SWFLoaderVars
|  | onChildComplete(value:Function):SWFLoaderVars A handler function for `LoaderEvent.CHILD_COMPLETE` events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) finishes loading successfully. | SWFLoaderVars
|  | onChildFail(value:Function):SWFLoaderVars A handler function for `LoaderEvent.CHILD_FAIL` events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) fails (and its `status` chances to `LoaderStatus.FAILED`). | SWFLoaderVars
|  | onChildOpen(value:Function):SWFLoaderVars A handler function for `LoaderEvent.CHILD_OPEN` events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) begins loading. | SWFLoaderVars
|  | onChildProgress(value:Function):SWFLoaderVars A handler function for `LoaderEvent.CHILD_PROGRESS` events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) dispatches a `PROGRESS` event. | SWFLoaderVars
|  | onComplete(value:Function):SWFLoaderVars A handler function for `LoaderEvent.COMPLETE` events which are dispatched when the loader has finished loading successfully. | SWFLoaderVars
|  | onError(value:Function):SWFLoaderVars A handler function for `LoaderEvent.ERROR` events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). | SWFLoaderVars
|  | onFail(value:Function):SWFLoaderVars A handler function for `LoaderEvent.FAIL` events which are dispatched whenever the loader fails and its `status` changes to `LoaderStatus.FAILED`. | SWFLoaderVars
|  | onHTTPStatus(value:Function):SWFLoaderVars A handler function for `LoaderEvent.HTTP_STATUS` events. | SWFLoaderVars
|  | onInit(value:Function):SWFLoaderVars A handler function for `LoaderEvent.INIT` events which are called when the swf has streamed enough of its content to render the first frame and determine if there are any required LoaderMax-related loaders recognized. | SWFLoaderVars
|  | onIOError(value:Function):SWFLoaderVars 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. | SWFLoaderVars
|  | onOpen(value:Function):SWFLoaderVars A handler function for `LoaderEvent.OPEN` events which are dispatched when the loader begins loading. | SWFLoaderVars
|  | onProgress(value:Function):SWFLoaderVars A handler function for `LoaderEvent.PROGRESS` events which are dispatched whenever the `bytesLoaded` changes. | SWFLoaderVars
|  | onSecurityError(value:Function):SWFLoaderVars A handler function for `LoaderEvent.SECURITY_ERROR` events which onError handles as well, so you can use that as more of a catch-all whereas onSecurityError is specifically for SECURITY_ERROR events. | SWFLoaderVars
|  | prop(property:String, value:*):SWFLoaderVars Adds a dynamic property to the vars object containing any value you want. | SWFLoaderVars
|  | requireWithRoot(value:DisplayObject):SWFLoaderVars LoaderMax supports subloading, where an object can be factored into a parent's loading progress. | SWFLoaderVars
|  | rotation(value:Number):SWFLoaderVars Sets the `ContentDisplay`'s `rotation` property. | SWFLoaderVars
|  | scaleMode(value:String):SWFLoaderVars When a `width` and `height` are defined, the `scaleMode` controls how the loaded image will be scaled to fit the area. | SWFLoaderVars
|  | scaleX(value:Number):SWFLoaderVars Sets the `ContentDisplay`'s `scaleX` property. | SWFLoaderVars
|  | scaleY(value:Number):SWFLoaderVars Sets the `ContentDisplay`'s `scaleY` property. | SWFLoaderVars
|  | suppressInitReparentEvents(value:Boolean):SWFLoaderVars If `true`, the SWFLoader will suppress the `REMOVED_FROM_STAGE` and `ADDED_TO_STAGE` events that are normally dispatched when the subloaded swf is reparented into the ContentDisplay (this always happens in Flash when any DisplayObject that's in the display list gets reparented - SWFLoader just circumvents it by default initially to avoid common problems that could arise if the child swf is coded a certain way). | SWFLoaderVars
|  | vAlign(value:String):SWFLoaderVars When a `width` and `height` is defined, the `vAlign` determines how the image is vertically aligned within that area. | SWFLoaderVars
|  | visible(value:Boolean):SWFLoaderVars Sets the `ContentDisplay`'s `visible` property. | SWFLoaderVars
|  | width(value:Number):SWFLoaderVars Sets the `ContentDisplay`'s `width` property (applied before rotation, scaleX, and scaleY). | SWFLoaderVars
|  | x(value:Number):SWFLoaderVars Sets the `ContentDisplay`'s `x` property (for positioning on the stage). | SWFLoaderVars
|  | y(value:Number):SWFLoaderVars Sets the `ContentDisplay`'s `y` property (for positioning on the stage). | SWFLoaderVars

Property detail

vars | property

`vars:Object` [read-only]

The generic Object populated by all of the method calls in the SWFLoaderVars instance. This is the raw data that gets passed to the loader.

Implementation
`public function get vars():Object`
Constructor detail

SWFLoaderVars | () | constructor

`public function SWFLoaderVars(vars:Object = null)`

Constructor

Parameters

| `vars:Object` (default = `null`)`` — A generic Object containing properties that you'd like to add to this SWFLoaderVars instance.

Method detail

allowMalformedURL | () | method

`public function allowMalformedURL(value:Boolean):SWFLoaderVars`

Normally, the URL will be parsed and any variables in the query string (like "?name=test&state=il&gender=m") will be placed into a URLVariables object which is added to the URLRequest. This avoids a few bugs in Flash, but if you need to keep the entire URL intact (no parsing into URLVariables), set `allowMalformedURL:true`. For example, if your URL has duplicate variables in the query string like `http://www.greensock.com/?c=S&c=SE&c=SW`, it is technically considered a malformed URL and a URLVariables object can't properly contain all the duplicates, so in this case you'd want to set `allowMalformedURL` to `true`.

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

alpha | () | method |

`public function alpha(value:Number):SWFLoaderVars`

Sets the `ContentDisplay`'s `alpha` property.

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`

alternateURL | () | method |

`public function alternateURL(value:String):SWFLoaderVars`

If you define an `alternateURL`, the loader will initially try to load from its original `url` and if it fails, it will automatically (and permanently) change the loader's `url` to the `alternateURL` and try again. Think of it as a fallback or backup `url`. It is perfectly acceptable to use the same `alternateURL` for multiple loaders (maybe a default image for various SWFLoaders for example).

Parameters

| `value:String`

Returns

| `SWFLoaderVars`

autoDispose | () | method |

`public function autoDispose(value:Boolean):SWFLoaderVars`

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`.

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

autoPlay | () | method |

`public function autoPlay(value:Boolean):SWFLoaderVars`

If `autoPlay` is `true` (the default), the swf will begin playing immediately when the `INIT` event fires. To prevent this behavior, set `autoPlay` to `false` which will also mute the swf until the SWFLoader completes.

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

bgAlpha | () | method |

`public function bgAlpha(value:Number):SWFLoaderVars`

Controls the alpha of the rectangle that is drawn when a `width` and `height` are defined.

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`

bgColor | () | method |

`public function bgColor(value:uint):SWFLoaderVars`

When a `width` and `height` are defined, a rectangle will be drawn inside the `ContentDisplay` Sprite immediately in order to ease the development process. It is transparent by default, but you may define a `bgColor` if you prefer.

Parameters

| `value:uint`

Returns

| `SWFLoaderVars`

blendMode | () | method |

`public function blendMode(value:String):SWFLoaderVars`

Sets the `ContentDisplay`'s `blendMode` property.

Parameters

| `value:String`

Returns

| `SWFLoaderVars`

centerRegistration | () | method |

`public function centerRegistration(value:Boolean):SWFLoaderVars`

If `true`, the registration point will be placed in the center of the ContentDisplay which can be useful if, for example, you want to animate its scale and have it grow/shrink from its center.

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

container | () | method |

`public function container(value:DisplayObjectContainer):SWFLoaderVars`

A DisplayObjectContainer into which the `ContentDisplay` Sprite should be added immediately.

Parameters

| `value:DisplayObjectContainer`

Returns

| `SWFLoaderVars`

context | () | method |

`public function context(value:LoaderContext):SWFLoaderVars`

To control whether or not a policy file is checked (which is required if you're loading an image from another domain and you want to use it in BitmapData operations), define a `LoaderContext` object. By default, the policy file will be checked when running remotely, so make sure the appropriate crossdomain.xml file is in place. See Adobe's `LoaderContext` documentation for details and precautions.

Parameters

| `value:LoaderContext`

Returns

| `SWFLoaderVars`

crop | () | method |

`public function crop(value:Boolean):SWFLoaderVars`

When a `width` and `height` are defined, setting `crop` to `true` will cause the image to be cropped within that area (by applying a `scrollRect` for maximum performance). This is typically useful when the `scaleMode` is `"proportionalOutside"` or `"none"` so that any parts of the image that exceed the dimensions defined by `width` and `height` are visually chopped off. Use the `hAlign` and `vAlign` special properties to control the vertical and horizontal alignment within the cropped area.

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

estimatedBytes | () | method |

`public function estimatedBytes(value:uint):SWFLoaderVars`

Initially, the loader's `bytesTotal` is set to the `estimatedBytes` value (or `LoaderMax.defaultEstimatedBytes` if one isn't defined). Then, when the loader begins loading and it can accurately determine the bytesTotal, it will do so. Setting `estimatedBytes` is optional, but the more accurate the value, the more accurate your loaders' overall progress will be initially. If the loader is inserted into a LoaderMax instance (for queue management), its `auditSize` feature can attempt to automatically determine the `bytesTotal` at runtime (there is a slight performance penalty for this, however - see LoaderMax's documentation for details).

Parameters

| `value:uint`

Returns

| `SWFLoaderVars`

hAlign | () | method |

`public function hAlign(value:String):SWFLoaderVars`

When a `width` and `height` is defined, the `hAlign` determines how the image is horizontally aligned within that area. The following values are recognized (you may use the `com.greensock.layout.AlignMode` constants if you prefer):

- `"center"` (the default) - The image will be centered horizontally in the area
- `"left"` - The image will be aligned with the left side of the area
- `"right"` - The image will be aligned with the right side of the area

Parameters

| `value:String`

Returns

| `SWFLoaderVars`

height | () | method |

`public function height(value:Number):SWFLoaderVars`

Sets the `ContentDisplay`'s `height` property (applied before rotation, scaleX, and scaleY).

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`

integrateProgress | () | method |

`public function integrateProgress(value:Boolean):SWFLoaderVars`

By default, a SWFLoader instance will automatically look for LoaderMax loaders in the swf when it initializes. Every loader found with a `requireWithRoot` parameter set to that swf's `root` will be integrated into the SWFLoader's overall progress. The SWFLoader's `COMPLETE` event won't fire until all such loaders are also complete. If you prefer NOT to integrate the subloading loaders into the SWFLoader's overall progress, set `integrateProgress` to `false`.

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

name | () | method |

`public function name(value:String):SWFLoaderVars`

A name that is used to identify the loader instance. This name can be fed to the `LoaderMax.getLoader()` or `LoaderMax.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".

Parameters

| `value:String`

Returns

| `SWFLoaderVars`

noCache | () | method |

`public function noCache(value:Boolean):SWFLoaderVars`

If `true`, a "gsCacheBusterID" parameter will be appended to the url with a random set of numbers to prevent caching (don't worry, this info is ignored when you `LoaderMax.getLoader()` or `LoaderMax.getContent()` by `url` or when you're running locally).

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

onCancel | () | method |

`public function onCancel(value:Function):SWFLoaderVars`

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. Make sure your onCancel function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onChildCancel | () | method |

`public function onChildCancel(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.CHILD_CANCEL` events which are dispatched each time loading is aborted on any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) 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`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onChildComplete | () | method |

`public function onChildComplete(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.CHILD_COMPLETE` events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) finishes loading successfully. Make sure your onChildComplete function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onChildFail | () | method |

`public function onChildFail(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.CHILD_FAIL` events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) fails (and its `status` chances to `LoaderStatus.FAILED`). Make sure your onChildFail function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onChildOpen | () | method |

`public function onChildOpen(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.CHILD_OPEN` events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) begins loading. Make sure your onChildOpen function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onChildProgress | () | method |

`public function onChildProgress(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.CHILD_PROGRESS` events which are dispatched each time any nested LoaderMax-related loaders (active ones that the SWFLoader found inside the subloading swf that had their `requireWithRoot` set to its `root`) dispatches a `PROGRESS` event. To listen for changes in the SWFLoader'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 SWFLoader, 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`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onComplete | () | method |

`public function onComplete(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.COMPLETE` events which are dispatched when the loader has finished loading successfully. Make sure your onComplete function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onError | () | method |

`public function onError(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.ERROR` events which are dispatched whenever the loader experiences an error (typically an IO_ERROR or SECURITY_ERROR). An error doesn't necessarily mean the loader failed, however - to listen for when a loader fails, use the `onFail` special property. Make sure your onError function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onFail | () | method |

`public function onFail(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.FAIL` events which are dispatched whenever the loader fails and its `status` changes to `LoaderStatus.FAILED`. Make sure your onFail function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onHTTPStatus | () | method |

`public function onHTTPStatus(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.HTTP_STATUS` events. Make sure your onHTTPStatus function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`). You can determine the httpStatus code using the LoaderEvent's `target.httpStatus` (LoaderItems keep track of their `httpStatus` when possible, although certain environments prevent Flash from getting httpStatus information).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onInit | () | method |

`public function onInit(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.INIT` events which are called when the swf has streamed enough of its content to render the first frame and determine if there are any required LoaderMax-related loaders recognized. It also adds the swf to the ContentDisplay Sprite at this point. Make sure your onInit function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onIOError | () | method |

`public function onIOError(value:Function):SWFLoaderVars`

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. Make sure your onIOError function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onOpen | () | method |

`public function onOpen(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.OPEN` events which are dispatched when the loader begins loading. Make sure your onOpen function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onProgress | () | method |

`public function onProgress(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.PROGRESS` events which are dispatched whenever the `bytesLoaded` changes. Make sure your onProgress function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`). You can use the LoaderEvent's `target.progress` to get the loader's progress value or use its `target.bytesLoaded` and `target.bytesTotal`.

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

onSecurityError | () | method |

`public function onSecurityError(value:Function):SWFLoaderVars`

A handler function for `LoaderEvent.SECURITY_ERROR` events which onError handles as well, so you can use that as more of a catch-all whereas onSecurityError is specifically for SECURITY_ERROR events. Make sure your onSecurityError function accepts a single parameter of type `LoaderEvent` (`com.greensock.events.LoaderEvent`).

Parameters

| `value:Function`

Returns

| `SWFLoaderVars`

prop | () | method |

`public function prop(property:String, value:*):SWFLoaderVars`

Adds a dynamic property to the vars object containing any value you want. This can be useful in situations where you need to associate certain data with a particular loader. Just make sure that the property name is a valid variable name (starts with a letter or underscore, no special characters, etc.) and that it doesn't use a reserved property name like "name" or "onComplete", etc. For example, to set an "index" property to 5, do: `prop("index", 5);`

Parameters

| `property:String` — Property name
| `value:*` — Value

Returns

| `SWFLoaderVars`

requireWithRoot | () | method |

`public function requireWithRoot(value:DisplayObject):SWFLoaderVars`

LoaderMax supports subloading, where an object can be factored into a parent's loading progress. If you want LoaderMax to require this loader as part of its parent SWFLoader's progress, you must set the `requireWithRoot` property to your swf's `root`. For example, `vars.requireWithRoot = this.root;`.

Parameters

| `value:DisplayObject`

Returns

| `SWFLoaderVars`

rotation | () | method |

`public function rotation(value:Number):SWFLoaderVars`

Sets the `ContentDisplay`'s `rotation` property.

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`

scaleMode | () | method |

`public function scaleMode(value:String):SWFLoaderVars`

When a `width` and `height` are defined, the `scaleMode` controls how the loaded image will be scaled to fit the area. The following values are recognized (you may use the `com.greensock.layout.ScaleMode` constants if you prefer):

- `"stretch"` (the default) - The image will fill the width/height exactly.
- `"proportionalInside"` - The image will be scaled proportionally to fit inside the area defined by the width/height
- `"proportionalOutside"` - The image will be scaled proportionally to completely fill the area, allowing portions of it to exceed the bounds defined by the width/height.
- `"widthOnly"` - Only the width of the image will be adjusted to fit.
- `"heightOnly"` - Only the height of the image will be adjusted to fit.
- `"none"` - No scaling of the image will occur.

Parameters

| `value:String`

Returns

| `SWFLoaderVars`

scaleX | () | method |

`public function scaleX(value:Number):SWFLoaderVars`

Sets the `ContentDisplay`'s `scaleX` property.

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`

scaleY | () | method |

`public function scaleY(value:Number):SWFLoaderVars`

Sets the `ContentDisplay`'s `scaleY` property.

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`

suppressInitReparentEvents | () | method |

`public function suppressInitReparentEvents(value:Boolean):SWFLoaderVars`

If `true`, the SWFLoader will suppress the `REMOVED_FROM_STAGE` and `ADDED_TO_STAGE` events that are normally dispatched when the subloaded swf is reparented into the ContentDisplay (this always happens in Flash when any DisplayObject that's in the display list gets reparented - SWFLoader just circumvents it by default initially to avoid common problems that could arise if the child swf is coded a certain way). For example, if your subloaded swf has this code: `addEventListener(Event.REMOVED_FROM_STAGE, disposeEverything)` and you set `suppressInitReparentEvents` to `false`, `disposeEverything()` would get called as soon as the swf inits (assuming the ContentDisplay is in the display list).

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

vAlign | () | method |

`public function vAlign(value:String):SWFLoaderVars`

When a `width` and `height` is defined, the `vAlign` determines how the image is vertically aligned within that area. The following values are recognized (you may use the `com.greensock.layout.AlignMode` constants if you prefer):

- `"center"` (the default) - The image will be centered vertically in the area
- `"top"` - The image will be aligned with the top of the area
- `"bottom"` - The image will be aligned with the bottom of the area

Parameters

| `value:String`

Returns

| `SWFLoaderVars`

visible | () | method |

`public function visible(value:Boolean):SWFLoaderVars`

Sets the `ContentDisplay`'s `visible` property.

Parameters

| `value:Boolean`

Returns

| `SWFLoaderVars`

width | () | method |

`public function width(value:Number):SWFLoaderVars`

Sets the `ContentDisplay`'s `width` property (applied before rotation, scaleX, and scaleY).

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`

x | () | method |

`public function x(value:Number):SWFLoaderVars`

Sets the `ContentDisplay`'s `x` property (for positioning on the stage).

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`

y | () | method |

`public function y(value:Number):SWFLoaderVars`

Sets the `ContentDisplay`'s `y` property (for positioning on the stage).

Parameters

| `value:Number`

Returns

| `SWFLoaderVars`