feathers.motion.effectClasses.TweenEffectContext

Package	feathers.motion.effectClasses
Class	public class TweenEffectContext
Inheritance	TweenEffectContext BaseEffectContext starling.events.EventDispatcher
Implements	IEffectContext
Subclasses	TweenMoveEffectContext, TweenResizeEffectContext

Product Version :

Feathers 3.5.0

An effect context for a starling.animation.Tween.

Public Properties

	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

Public Methods

	Method		Defined By
		TweenEffectContext(target:DisplayObject, tween:Tween, interruptBehavior:String) Constructor.	TweenEffectContext
		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
		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

	Method	Defined By
		cleanupEffect():void Called when the effect completes or is interrupted.	BaseEffectContext
		prepareEffect():void Called when the effect is initialized.	BaseEffectContext
		updateEffect():void Called when the effect's position is updated.	BaseEffectContext

	Event	Summary	Defined By
		complete	Dispatched when the effect completes or is interrupted.	BaseEffectContext

Property Detail

interruptBehavior

property

interruptBehavior:String

Indicates 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.

Implementation
public function get interruptBehavior():String
public function set interruptBehavior(value:String):void

Feathers (Starling) 4.1.1 API Reference	All Packages All Classes Index Frames No Frames
TweenEffectContext	Properties Methods Events

	`target:DisplayObject`

	`tween:Tween`

	`interruptBehavior:String` (default = `NaN`)