Packagecom.greensock.data
Classpublic dynamic class TweenMaxVars
InheritanceTweenMaxVars Inheritance TweenLiteVars Inheritance VarsCore Inheritance flash.utils.Proxy

There are 2 primary benefits of using this utility to define your TweenMax variables:
  1. In most code editors, code hinting will be activated which helps remind you which special properties are available in TweenMax
  2. It allows you to code using strict datatyping (although it doesn't force you to).
USAGE:

Instead of TweenMax.to(my_mc, 1, {x:300, tint:0xFF0000, onComplete:myFunction}), you could use this utility like:

var myVars:TweenMaxVars = new TweenMaxVars();
myVars.addProp("x", 300); // use addProp() to add any property that doesn't already exist in the TweenMaxVars instance.
myVars.tint = 0xFF0000;
myVars.onComplete = myFunction;
TweenMax.to(my_mc, 1, myVars);

NOTES: Copyright 2010, 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
 PropertyDefined by
 InheritedautoAlpha : Number
Same as changing the "alpha" property but with the additional feature of toggling the "visible" property to false when alpha is 0.
TweenLiteVars
 InheritedbevelFilter : BevelFilterVars
Applies a BevelFilter tween (use the BevelFilterVars class to define the values).
TweenLiteVars
 Inheritedbezier : Array
Array of Objects, one for each "control point" (see documentation on Flash's curveTo() drawing method for more about how control points work).
TweenLiteVars
 InheritedbezierThrough : Array
Identical to bezier except that instead of passing Bezier control point values, you pass values through which the Bezier values should move.
TweenLiteVars
 InheritedblurFilter : BlurFilterVars
Applies a BlurFilter tween (use the BlurFilterVars class to define the values).
TweenLiteVars
 InheritedcolorMatrixFilter : ColorMatrixFilterVars
Applies a ColorMatrixFilter tween (use the ColorMatrixFilterVars class to define the values).
TweenLiteVars
 InheritedcolorTransform : ColorTransformVars
Applies a ColorTransform tween (use the ColorTransformVars class to define the values).
TweenLiteVars
 Inheriteddata : *
Any data that you'd like associated with your tween.
TweenLiteVars
 Inheriteddelay : Number
The number of seconds (or frames for frames-based tweens) to delay before the tween begins.
TweenLiteVars
 InheriteddropShadowFilter : DropShadowFilterVars
Applies a DropShadowFilter tween (use the DropShadowFilterVars class to define the values).
TweenLiteVars
 InheriteddynamicProps : Object
Allows you to associate a function with a property so that every time the tween is updated, it calls that function to get the end value for the associated property.
TweenLiteVars
 Inheritedease : Function
An easing function (i.e.
TweenLiteVars
 InheritedeaseParams : Array
An Array of extra parameter values to feed the easing equation (beyond the standard 4).
TweenLiteVars
 InheritedendArray : Array
An Array containing numeric end values of the target Array.
TweenLiteVars
 Inheritedframe : int
Tweens a MovieClip to a particular frame.
TweenLiteVars
 InheritedframeLabel : String
Tweens a MovieClip to a particular frame.
TweenLiteVars
 InheritedglowFilter : GlowFilterVars
Applies a GlowFilter tween (use the GlowFilterVars class to define the values).
TweenLiteVars
 InheritedhexColors : Object
Although hex colors are technically numbers, if you try to tween them conventionally, you'll notice that they don't tween smoothly.
TweenLiteVars
 InheritedimmediateRender : Boolean
Normally, zero-duration tweens render immediately and all other tweens begin rendering on the very next frame after they are instantiated, but immediateRender allows you to override that behavior if you prefer.
TweenLiteVars
 InheritedmotionBlur : Object
Applies a motionBlur tween.
TweenLiteVars
 InheritedonComplete : Function
A function to call when the tween has completed.
TweenLiteVars
  onCompleteListener : Function
A function to which the TweenMax instance should dispatch a TweenEvent when it completes.
TweenMaxVars
 InheritedonCompleteParams : Array
An Array of parameters to pass the onComplete function
TweenLiteVars
 InheritedonInit : Function
A function that should be called just before the tween inits (renders for the first time).
TweenLiteVars
 InheritedonInitParams : Array
An Array of parameters to pass the onInit function.
TweenLiteVars
  onRepeat : Function
A function that should be called every time the tween repeats
TweenMaxVars
  onRepeatParams : Array
An Array of parameters to pass the onRepeat function
TweenMaxVars
  onReverseComplete : Function
A function that should be called when the tween has reached its starting point again after having been reversed
TweenMaxVars
  onReverseCompleteParams : Array
An Array of parameters to pass the onReverseComplete functions
TweenMaxVars
 InheritedonStart : Function
A function that should be called when the tween begins (when its currentTime is at 0 and changes to some other value which can happen more than once if the tween is restarted multiple times).
TweenLiteVars
  onStartListener : Function
A function to which the TweenMax instance should dispatch a TweenEvent when it begins.
TweenMaxVars
 InheritedonStartParams : Array
An Array of parameters to pass the onStart function.
TweenLiteVars
 InheritedonUpdate : Function
A function to call whenever the tweening values are updated (on every frame during the time the tween is active).
TweenLiteVars
  onUpdateListener : Function
A function to which the TweenMax instance should dispatch a TweenEvent every time it updates values.
TweenMaxVars
 InheritedonUpdateParams : Array
An Array of parameters to pass the onUpdate function
TweenLiteVars
 InheritedorientToBezier : Array
A common effect that designers/developers want is for a MovieClip/Sprite to orient itself in the direction of a Bezier path (alter its rotation).
TweenLiteVars
 Inheritedoverwrite : int
NONE = 0, ALL_IMMEDIATE = 1, AUTO = 2, CONCURRENT = 3, ALL_ONSTART = 4, PREEXISTING = 5 (2 through 5 are only available with the optional OverwriteManager add-on class which must be initted once for TweenLite, like OverwriteManager.init().
TweenLiteVars
  paused : Boolean
If true, the tween will be paused initially.
TweenMaxVars
 Inheritedquaternions : Object
An object with properties that correspond to the quaternion properties of the target object.
TweenLiteVars
 InheritedremoveTint : Boolean
To remove the tint from a DisplayObject, set removeTint to true.
TweenLiteVars
  repeat : int
Number of times that the tween should repeat (to repeat indefinitely, use -1).
TweenMaxVars
  repeatDelay : Number
Amount of time in seconds (or frames for frames-based tween) between repeats.
TweenMaxVars
  reversed : Boolean
If true, the tween will be reversed initially.
TweenMaxVars
  roundProps : Array
An Array of the names of properties that should be rounded to the nearest integer when tweening
TweenMaxVars
 InheritedrunBackwards : Boolean
When true, the tween will flip the start and end values which is exactly what TweenLite.from() does.
TweenLiteVars
 InheritedscrollRect : Object
Tweens the scrollRect property of any DisplayObject; you can define any of the following properties in the object: left, right, top, bottom, x, y, width, height.
TweenLiteVars
 InheritedsetSize : Object
An object containing a "width" and/or "height" property which will be tweened over time and applied using setSize() on every frame during the course of the tween.
TweenLiteVars
 InheritedshortRotation : Object
To tween any rotation property (even multiple properties) of the target object in the shortest direction, use shortRotation.
TweenLiteVars
  startAt : TweenLiteVars
Allows you to define the starting values for each property.
TweenMaxVars
 Inheritedtint : uint
To change a DisplayObject's tint, set this to the hex value of the color you'd like the DisplayObject to end up at(or begin at if you're using TweenLite.from()).
TweenLiteVars
 InheritedtransformAroundCenter : TransformAroundCenterVars
Applies a transformAroundCenter tween (use the TransformAroundCenterVars class to define the values).
TweenLiteVars
 InheritedtransformAroundPoint : TransformAroundPointVars
Applies a transformAroundPoint tween (use the TransformAroundPointVars class to define the values).
TweenLiteVars
 InheriteduseFrames : Boolean
If useFrames is set to true, the tweens's timing mode will be based on frames.
TweenLiteVars
 Inheritedvisible : Boolean
To set a DisplayObject's "visible" property at the end of the tween, use this special property.
TweenLiteVars
 Inheritedvolume : Number
Changes the volume of any object that has a soundTransform property (MovieClip, SoundChannel, NetStream, etc.)
TweenLiteVars
  yoyo : Boolean
Works in conjunction with the repeat property, determining the behavior of each cycle.
TweenMaxVars
Public Methods
 MethodDefined by
  
TweenMaxVars(vars:Object = null)
TweenMaxVars
 Inherited
addProp(name:String, value:Number, relative:Boolean = false):void
Adds a dynamic property for tweening and allows you to set whether the end value is relative or not
TweenLiteVars
  
Clones the TweenMaxVars object.
TweenMaxVars
Protected Methods
 MethodDefined by
 Inherited
hasProperty(name:*):Boolean
VarsCore
Property detail
onCompleteListenerproperty
public var onCompleteListener:Function

A function to which the TweenMax instance should dispatch a TweenEvent when it completes. This is the same as doing myTweenMaxInstance.addEventListener(TweenEvent.COMPLETE, myFunction);

onRepeatproperty 
public var onRepeat:Function

A function that should be called every time the tween repeats

onRepeatParamsproperty 
public var onRepeatParams:Array

An Array of parameters to pass the onRepeat function

onReverseCompleteproperty 
public var onReverseComplete:Function

A function that should be called when the tween has reached its starting point again after having been reversed

onReverseCompleteParamsproperty 
public var onReverseCompleteParams:Array

An Array of parameters to pass the onReverseComplete functions

onStartListenerproperty 
public var onStartListener:Function

A function to which the TweenMax instance should dispatch a TweenEvent when it begins. This is the same as doing myTweenMaxInstance.addEventListener(TweenEvent.START, myFunction);

onUpdateListenerproperty 
public var onUpdateListener:Function

A function to which the TweenMax instance should dispatch a TweenEvent every time it updates values. This is the same as doing myTweenMaxInstance.addEventListener(TweenEvent.UPDATE, myFunction);

pausedproperty 
paused:Boolean  [read-write]

If true, the tween will be paused initially.

Implementation
    public function get paused():Boolean
    public function set paused(value:Boolean):void
repeatproperty 
repeat:int  [read-write]

Number of times that the tween should repeat (to repeat indefinitely, use -1).

Implementation
    public function get repeat():int
    public function set repeat(value:int):void
repeatDelayproperty 
public var repeatDelay:Number

Amount of time in seconds (or frames for frames-based tween) between repeats.

reversedproperty 
reversed:Boolean  [read-write]

If true, the tween will be reversed initially. This does not swap the starting/ending values in the tween - it literally changes its orientation/direction. Imagine the playhead moving backwards instead of forwards.

Implementation
    public function get reversed():Boolean
    public function set reversed(value:Boolean):void
roundPropsproperty 
public var roundProps:Array

An Array of the names of properties that should be rounded to the nearest integer when tweening

startAtproperty 
public var startAt:TweenLiteVars

Allows you to define the starting values for each property. Typically, TweenMax uses the current value (whatever it happens to be at the time the tween begins) as the start value, but startAt allows you to override that behavior. Simply pass a TweenLiteVars or TweenMaxVars in with whatever properties you'd liketo set just before the tween begins.

yoyoproperty 
yoyo:Boolean  [read-write]

Works in conjunction with the repeat property, determining the behavior of each cycle. When yoyo is true, the tween will go back and forth, appearing to reverse every other cycle (this has no affect on the "reversed" property though).

Implementation
    public function get yoyo():Boolean
    public function set yoyo(value:Boolean):void
Constructor detail
TweenMaxVars()constructor
public function TweenMaxVars(vars:Object = null)

Parameters
vars:Object (default = null) — An Object containing properties that correspond to the properties you'd like to add to this TweenMaxVars Object. For example, TweenMaxVars({blurFilter:{blurX:10, blurY:20}, onComplete:myFunction})
Method detail
clone()method
public override function clone():TweenLiteVars

Clones the TweenMaxVars object.

Returns
TweenLiteVars