| Package | feathers.motion.effectClasses |
| Class | public class TweenEffectContext |
| Inheritance | TweenEffectContext  BaseEffectContext EventDispatcher Object |
| Implements | IEffectContext |
| Subclasses | TweenMoveEffectContext, TweenResizeEffectContext |
| Product Version : | Feathers 3.5.0 |
starling.animation.Tween.
See also
| Property | Defined By | ||
|---|---|---|---|
 | duration : Number [read-only]
The duration of the effect, in seconds. | BaseEffectContext | |
| interruptBehavior : String
Indicates how the effect behaves when it is interrupted. | TweenEffectContext | ||
| juggler : Juggler
The Juggler used to update the effect when it is
playing. | BaseEffectContext | |
| position : Number
Sets the position of the effect using a value between 0
and 1. | BaseEffectContext | |
| target : DisplayObject [read-only]
The target of the effect. | BaseEffectContext | |
| transition : Object [read-only]
The transition, or easing function, used for the effect. | BaseEffectContext | |
| tween : Tween [read-only]
The tween that is controlled by the effect. | TweenEffectContext | ||
| Method | Defined By | ||
|---|---|---|---|
Constructor. | TweenEffectContext | ||
| addEventListener(type:String, listener:Function):void Registers an event listener at a certain object. | EventDispatcher | |
| dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher | |
| dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void Dispatches an event with the given parameters to all objects that have registered
listeners for the given type. | EventDispatcher | |
| hasEventListener(type:String, listener:Function = null):Boolean If called with one argument, figures out if there are any listeners registered for
the given event type. | EventDispatcher | |
| interrupt():void
Interrupts the playing effect, but the effect context will be allowed
to determine on its own if it should call stop() or
toEnd(). | BaseEffectContext | |
| pause():void
Pauses an effect that is currently playing. | BaseEffectContext | |
| play():void
Starts playing the effect from its current position to the end. | BaseEffectContext | |
| playReverse():void
Starts playing the effect from its current position back to the
beginning (completing at a position of 0). | BaseEffectContext | |
| removeEventListener(type:String, listener:Function):void Removes an event listener from the object. | EventDispatcher | |
| removeEventListeners(type:String = null):void Removes all event listeners with a certain type, or all of them if type is null. | EventDispatcher | |
| stop():void
Stops the effect at its current position and forces
Event.COMPLETE to dispatch. | BaseEffectContext | |
| toEnd():void
Advances the effect to the end and forces
Event.COMPLETE to dispatch. | BaseEffectContext | |
| interruptBehavior | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesinterruptBehavior:StringIndicates how the effect behaves when it is interrupted. Interrupted effects can either advance directly to the end or stop at the current position.
The default value is feathers.motion.EffectInterruptBehavior.END.
public function get interruptBehavior():String public function set interruptBehavior(value:String):voidSee also
| tween | property |
tween:Tween [read-only] The tween that is controlled by the effect.
public function get tween():Tween| TweenEffectContext | () | Constructor |
public function TweenEffectContext(target:DisplayObject, tween:Tween, interruptBehavior:String)Constructor.
Parameterstarget:DisplayObject | |
tween:Tween | |
interruptBehavior:String (default = NaN) |