| Package | net.flashpunk |
| Class | public class Tween |
| Inheritance | Tween  Object |
| Subclasses | Alarm, AngleTween, ColorTween, Fader, Motion, MultiVarTween, NumTween, SfxFader, VarTween |
| Property | Defined By | ||
|---|---|---|---|
| active : Boolean
If the tween should update. | Tween | ||
| complete : Function
Tween completion callback. | Tween | ||
| delay : Number = 0
Length of time to wait before starting this tween. | Tween | ||
| percent : Number
The completion percentage of the Tween. | Tween | ||
| scale : Number [read-only]
The current time scale of the Tween (after easer has been applied). | Tween | ||
| Method | Defined By | ||
|---|---|---|---|
Tween(duration:Number, type:uint = 0, complete:Function = null, ease:Function = null)
Constructor. | Tween | ||
cancel():void
Immediately stops the Tween and removes it from its Tweener without calling the complete callback. | Tween | ||
start():void
Starts the Tween, or restarts it if it's currently running. | Tween | ||
update():void
Updates the Tween, called by World. | Tween | ||
| Constant | Defined By | ||
|---|---|---|---|
| LOOPING : uint = 1 [static]
Looping Tween type, will restart immediately when it finishes. | Tween | ||
| ONESHOT : uint = 2 [static]
Oneshot Tween type, will stop and remove itself from its core container when it finishes. | Tween | ||
| PERSIST : uint = 0 [static]
Persistent Tween type, will stop when it finishes. | Tween | ||
| active | property |
public var active:BooleanIf the tween should update.
| complete | property |
public var complete:FunctionTween completion callback.
| delay | property |
public var delay:Number = 0Length of time to wait before starting this tween.
| percent | property |
percent:NumberThe completion percentage of the Tween.
public function get percent():Number public function set percent(value:Number):void| scale | property |
scale:Number [read-only] The current time scale of the Tween (after easer has been applied).
public function get scale():Number| Tween | () | Constructor |
public function Tween(duration:Number, type:uint = 0, complete:Function = null, ease:Function = null)Constructor. Specify basic information about the Tween.
Parametersduration:Number — Duration of the tween (in seconds or frames).
| |
type:uint (default = 0) | |
complete:Function (default = null) | |
ease:Function (default = null) |
| cancel | () | method |
public function cancel():voidImmediately stops the Tween and removes it from its Tweener without calling the complete callback.
| start | () | method |
public function start():voidStarts the Tween, or restarts it if it's currently running.
| update | () | method |
public function update():voidUpdates the Tween, called by World.
| LOOPING | Constant |
public static const LOOPING:uint = 1Looping Tween type, will restart immediately when it finishes.
| ONESHOT | Constant |
public static const ONESHOT:uint = 2Oneshot Tween type, will stop and remove itself from its core container when it finishes.
| PERSIST | Constant |
public static const PERSIST:uint = 0Persistent Tween type, will stop when it finishes.