Allows you to reassign the .target object back to a property specified by assignmentProperty of an object specified by assignmentTarget. Useful for tweening elements like colorTransform that need to be reassigned to have an effect.

See setAssignment() for more information.

See also

Allows you to reassign the .target object back to a property specified by assignmentProperty of an object specified by assignmentTarget. Useful for tweening elements like colorTransform that need to be reassigned to have an effect.

See setAssignment() for more information.

See also

Indicates whether the target's visible property should automatically be set to false when its alpha value is tweened to 0 or less. Only affects objects with a visible property.

Indicates whether the tween should automatically play when a destination value is changed.

Specifies whether the tween should automatically reverse its initial and destination property values when it reaches its end. Example: this could be used to create a tween that automatically plays forward and in reverse continually with:
myTween.autoReverse = true;
myTween.nextTween = myTween; // automatically play this tween again when it ends

Allows you to associate arbitrary data with your tween. For example, you might use this to reference specific data when handling events from tweens.

The length of the delay in frames or seconds (depending on the timingMode). The delay occurs before a tween reads initial values or starts playing.

The length of the tween in frames or seconds (depending on the timingMode). Setting this will also update any child transitions that have synchDuration set to true.

The transition function to use for calculating the tween. This can be any standard tween function, such as the tween functions in fl.motion.easing.that come with Flash CS3.

Returns the name of the last progress point that was passed, or null if none.

Specifies another GTween instance that will have .play() called on it when this tween completes.

Setting this to true pauses all tween instances. This does not affect individual tweens' .paused property.

Indicates whether the tween is currently paused (including when it is at the beginning or end). See play() and pause() for more information.

Gets and sets the position in the tween in frames or seconds (depending on the timingMode). The value will be between -delay and duration (beginning and end of tween respectively).

Note: Normally this value would be set and modified automatically by the tween, but is provided for advanced users.

The proxy object allows you to work with the properties and methods of the target object directly through GTween. Numeric property assignments will be used by GTween as destination values. The proxy will return GTween destination values when they are set, or the target's property values if they are not. Delete operations on properties will result in a deleteProperty call. All other property access and method execution through proxy will be passed directly to the target object.

Example 1: Equivalent to calling myGTween.setProperty("scaleY",2.5):
myGTween.proxy.scaleY = 2.5;

Example 2: Gets the current rotation value from the target object (because it hasn't been set yet on the GTween), adds 100 to it, and then calls setProperty on the GTween instance with the appropriate value:
myGTween.proxy.rotation += 100;

Example 3: Sets a destination value (through setProperty) for scaleX, then retrieves it from GTween (because it will always return destination values when available):
trace(myGTween.proxy.scaleX); // 1 (value from target, because no destination value is set)
myGTween.proxy.scaleX = 2; // set a destination value
trace(myGTween.proxy.scaleX); // 2 (destination value from GTween)
trace(myGTween.target.scaleX); // 1 (current value from target)

Example 4: Property deletions only affect destination properties on GTween, not the target object:
myGTween.proxy.rotation = 50; // set a destination value
trace(myGTween.proxy.rotation); // 50 (destination value from GTween)
delete(myGTween.proxy.rotation); // delete the destination value
trace(myGTween.proxy.rotation); // 0 (current value from target)

Example 5: Non-numeric property access is passed through to the target:
myGTween.proxy.blendMode = "multiply"; // passes value assignment through to the target
trace(myGTween.target.blendMode); // "multiply" (value from target)
trace(myGTween.proxy.blendMode); // "multiply" (value passed through from target)

Example 6: Method calls are passed through to target:
myGTween.proxy.gotoAndStop(30); // gotoAndStop(30) will be called on the target

If set to true, all tweened values will be rounded before they are assigned to the target.

Returns the current positional state of the tween. This does not indicate if the tween is paused - use the .paused property for this. Possible values are: GTween.BEGINNING, GTween.DELAY_PHASE, GTween.TWEEN_PHASE, GTween.END
The beginning state indicates the tween either has not been played. The tween's position will equal -delay.
The delayPhase state indicates that the tween is active (running), but is currently delaying prior to initing. The tween's position is less than 0. Note that it may be paused.
The tweenPhase state indicates that the tween has inited, and is tweening the property values. Note that it may be paused.
The end state indicates that the tween has completed playing. Setting any new properties on the tween will reset it, and set its state to beginning.

New tweens with autoplay set to false start with a state of BEGINNING. When first played, a tween will have a state of either DELAY_PHASE (if delay > 0) or TWEEN_PHASE (if delay == 0). When the delay ends, and tweening begins, the state will change to TWEEN_PHASE. When the tween reaches its end (position == duration), the state will be set to END. If you change any destination properties on an ended tween, its state will be set back to BEGINNING.

The target object to tween. This can be any kind of object.

Sets the time in milliseconds between updates when timingMode is set to GTween.TIME ("time"). Setting this to a lower number will generally result in smoother animations but higher CPU usage. Defaults to 40ms (~25 updates per second).

Indicates how GTween should deal with timing. This can be set to either GTween.TIME, GTween.FRAME, or GTween.HYBRID.

In frame mode, GTween will update once every frame, and all positional values are specified in frames (duration, position, delay, and progress point positions).

In time mode, updates will occur at an interval specified by the timeInterval property, independent of the frame rate, and all positional values are specified in seconds.

In hybrid mode, all updates occur on a frame, but all positional values are specified in seconds. Each frame the tween will calculate it's position based on the elapsed time. This offers lower CPU usage, and a more familiar time based interface, but can result in choppy animations in high CPU situations.

The time mode will generally run more smoothly, as it is less dependent on the running frame rate of the movie. The frame mode will generally use less CPU, and can be synched with timeline animations. You can change modes at any time, but existing tweens will continue to use the mode that was active when they were created.

When true, the tween will always rotate in the shortest direction to reach the destination rotation. For example, rotating from 355 degress to 5 degrees will rotate 10 degrees clockwise with useSmartRotation set to true. It would rotate 350 degrees counter-clockwise with useSmartRotation set to false.

Constructs a new GTween instance.

Adds a child tween. Child tweens are played in synch with their parent (ie. their position properties are synchronized). By specifying true for synchDuration, you can also ensure that a child will keep its duration synchronized with its parent.

Adds a tween position at which to generate a progress event. You can use this to trigger other functionality at specific points in the tween. The name is the string value that lastProgressPoint will be set to when the event is dispatched.

Example: This will generate a progress event and set the lastProgressPoint to "middle" half way through a 5 second tween: myGTween.addProgressPoint(2.5, "middle");

Jumps the tween to its beginning and pauses it. This sets all target properties to their init values, and sets the state to BEGINNING.

Creates a clone of the GTween instance. You can optionally specify a different target for the tween, and indicate whether to preserve the state (position and paused properties) of the tween.

Removes a destination value from the tween. This prevents the GTween instance from tweening the property.

Jumps the tween to its end. This is the same as setting position=duration, except it also provides you with the option to also end the nextTween (recursively). This sets all target properties to their destination values, sets the state to END, and fires the COMPLETE event.

Returns the destination value for the specified property if one exists.

Invalidate forces the tween to repopulate all of the initial properties from the target object, and start playing if autoplay is set to true. If the tween is currently playing, then it will also set the position to 0. For example, if you changed the x and y position of an object while it was playing, you could call invalidate on it to force it to resume the tween with the new property values.

Pauses the tween by stopping tick from being automatically called. This also releases the tween for garbage collection if it is not referenced externally.

Plays a tween by incrementing the position property each frame. This also prevents the tween from being garbage collected while it is active. This is achieved by way of two methods: 1. If the target object is an IEventDispatcher, then the tween will subscribe to a dummy event using a hard reference. This allows the tween to be garbage collected if its target is also collected, and there are no other external references to it. 2. If the target object is not an IEventDispatcher, then the tween is placed in the activeTweens list, to prevent collection until it is paused or reaches the end of the transition). Note that pausing all tweens via the GTween.pauseAll static property will not free the tweens for collection.

Removes a child tween.

Removes the progress point at the specified position.

Resets the tween, pausing it, deleting all destination values, resetting the tween position to the beginning, and nulling the lastProgressPoint. This will not change the target's current properties.

Reverses the tween by swapping its initial and destination properties. If the tween is playing (state = TWEEN_PHASE), it will also reverse the tween position.

Note: calling reverse on a playing tween may result in unusual results with nonlinear tween functions.

Allows you to tween objects that require re-assignment whenever they are modified by reassigning the target object to a specified property of another object. For example, in order for changes to a colorTransform object to be visible, it must be assigned back to the .transform.colorTransform property of a display object. To make this work, you would call myTween.setAssignment(myDisplayObject.transform,"colorTransform"); This will also cause GTween to retrieve the target each time it copies its initial values.

Note: this does not work with filters yet, as they must be assigned to an array first, and then to the filters property. Use GTweenFilter instead.

Shorthand method for making multiple setProperty calls quickly.

Example: set x and y destination values:
myGTween.setProperties({x:200, y:400});

Sets the numeric destination value for a property on the target object that you would like to tween. For example, if you wanted to tween to a new x position, you could use: myGTween.setProperty("x",400). Nonnumeric values are ignored.

Shortcut method for setting multiple properties on the tween object quickly. This does not set destination values (ie. the value to tween to). This method also provides you with a quick method for adding listeners to specific events, using the special properties: activateListener, initListener, completeListener, progressListener, changeListener.

Example: This will set the duration, autoReverse, and nextTween properties of a tween, and add a listener for the complete event:
myTween.setTweenProperties({duration:4, autoReverse:true, nextTween:anotherTween, completeListener:completeHandlerFunction});

Constant for the BEGINNING state.

Constant for the DELAY_PHASE state.

Constant for the END state.

Constant for the FRAME timingMode.

Constant for the HYBRID timingMode.

Constant for the PROGRESS event type.

Dispatched when a tween activates and first starts running. That is, when the tween exits the beginning or end state, and enters either the delayPhase or tweenPhase state.

Constant for the TWEEN_PHASE state.