Tween  - AS3 Flash

The initial value of the target object's designated property before the tween starts.

The duration of the tweened animation in frames or seconds. This property is set as a parameter when creating a new Tween instance or when calling the Tween.yoyo() method.

A number indicating the ending value of the target object property that is to be tweened. This property is set as a parameter when creating a new Tween instance or when calling the Tween.yoyo() method.

Related API Elements

The number of frames per second calculated into the tweened animation. By default the current Stage frame rate is used to calculate the tweened animation. Setting this property recalculates the number of increments in the animated property that is displayed each second to the Tween.FPS property rather than the current Stage frame rate. Setting the Tween.FPS property does not change the actual frame rate of the Stage.

Note: The Tween.FPS property returns undefined unless it is first set explicitly.

import fl.transitions.Tween;
import fl.transitions.easing.*;
 
var tween:Tween = new Tween(mc, "x", Elastic.easeOut, 0, 300, 3, true);
tween.FPS = 60;
 
mc.addEventListener(MouseEvent.CLICK, onClick);
 
function onClick(evt:MouseEvent):void {
    tween.start();
}

The easing function which is used with the tween.

Indicates whether the tween is currently playing.

Indicates whether the tween will loop. If the value is true, the tween will restart indefinitely each time the tween has completed. If the value is false, the tween will play only once.

The target object that is being tweened.

The current value of the target object property being tweened. This value updates with each drawn frame of the tweened animation.

The name of the property affected by the tween of the target object.

The current time within the duration of the animation.

Indicates whether the tween plays over a period of frames or seconds. A value of true will cause the tween to animate over a period of seconds specified by the duration property. A value of false will cause the tween to animate over a period of frames.

Creates an instance of the Tween class. Use the constructor function with the new operator: var myTween:Tween = new Tween().

Related API Elements

Instructs the tweened animation to continue tweening from its current animation point to a new finish and duration point.

Parameters

Related API Elements

Forwards the tweened animation directly to the final value of the tweened animation.

Forwards the tweened animation to the next frame of an animation that was stopped. Use this method to forward a frame at a time of a tweened animation after you use the Tween.stop() method to stop it.

Note: Use this method on frame-based tweens only. A tween is set to frame based at its creation by setting the useSeconds parameter to false.

Plays the previous frame of the tweened animation from the current stopping point of an animation that was stopped. Use this method to play a tweened animation backwards one frame at a time after you use the Tween.stop() method to stop it.

Note: Use this method on frame-based tweens only. A tween is set to frame based at its creation by setting the Tween.start() useSeconds parameter to false.

Related API Elements

Resumes the play of a tweened animation that has been stopped. Use this method to continue a tweened animation after you have stopped it by using the Tween.stop() method.

Note: Use this method on frame-based tweens only. A tween is set to be frame based at its creation by setting the useSeconds parameter to false.

Moves the play of a tweened animation back to its starting value. If Tween.rewind() is called while the tweened animation is still playing, the animation rewinds to its starting value and continues playing. If Tween.rewind() is called while the tweened animation has been stopped or has finished its animation, the tweened animation rewinds to its starting value and remains stopped. Use this method to rewind a tweened animation to its starting point after you have stopped it by using the Tween.stop() method or to rewind a tweened animation during its play.

Parameters

Starts the play of a tweened animation from its starting point. This method is used for restarting a Tween from the beginning of its animation after it stops or has completed its animation.

Stops the play of a tweened animation at its current value.

Instructs the tweened animation to play in reverse from its last direction of tweened property increments. If this method is called before a Tween object's animation is complete, the animation abruptly jumps to the end of its play and then plays in a reverse direction from that point. You can achieve an effect of an animation completing its entire play and then reversing its entire play by calling the Tween.yoyo() method within a TweenEvent.MOTION_FINISH event handler. This process ensures that the reverse effect of the Tween.yoyo() method does not begin until the current tweened animation is complete.

The properties of the event object have the following values:

The properties of the event object have the following values:

The properties of the event object have the following values:

The properties of the event object have the following values:

The properties of the event object have the following values:

The properties of the event object have the following values:

Note: For the classes in the fl.transitions package, you need to use an import statement, even in the Actions panel of Flash Professional (for most classes you do not need the import statement within the Actions panel). Use * at the package level to include all the classes in the package, or import each one individually.

import fl.transitions.Tween;
import fl.transitions.easing.*;
   
//create a Sprite instance
var mySprite:Sprite = new Sprite()
   
// create an input text field
var myTextField:TextField = new TextField();
   
myTextField.type = TextFieldType.INPUT;
myTextField.width = 180;
myTextField.height = 20;
myTextField.x = 20;
myTextField.y = 140;
myTextField.border = true;
myTextField.text = "Type a number here and press Enter";
myTextField.restrict = "0-9";   
 
addChild(myTextField);

// add a listener when the user clicks in the text field
myTextField.addEventListener(MouseEvent.CLICK, fieldClickHandler);

// add a listener for a key press
myTextField.addEventListener(KeyboardEvent.KEY_DOWN, keyDownHandler);
 
// clear the text field when the user clicks in it to enter a value
function fieldClickHandler(event:MouseEvent):void {
    myTextField.text = "";
}

// if the key pressed is the Enter key
// change the values of the box's width based on the value provided
function keyDownHandler(event:KeyboardEvent):void {
     if (event.keyCode == Keyboard.ENTER) {  

     mySprite.graphics.clear();
     var userNumber:Number = new Number(myTextField.text);
     mySprite.graphics.beginFill(0x666999);
     mySprite.graphics.drawRect(0, 0, 40, 120);
     addChild(mySprite);
     //provide tween values, including passing the variable userNumber for the width at
     //the end of the tween
     var myTween:Tween = new Tween(mySprite, "width", Elastic.easeOut, 0, userNumber, 4, true);
     }
}