class BaseEffectContext
package feathers.motion.effects
extends EventDispatcher
implements IEffectContext
extended by ActuateEffectContext
Variables
read onlyduration:Float
The total running time of the effect, measured in seconds.
1.0.0
.position:Float = 0.0
The current position of the effect, in the range of 0.0
to 1.0
.
1.0.0
.See:
read onlytarget:Dynamic
The effect's target object, which may be modified in some way, such as animating one of the target's properties.
1.0.0
.Methods
privatecleanupEffect ():Void
Called when the effect completes or is interrupted. Subclasses may override this method to customize the effect's behavior.
1.0.0
.interrupt ():Void
Interrupts the playing effect, but it will be allowed to determine on
its own whether this call behaves like stop()
or if it behaves like
toEnd()
instead.
1.0.0
.See:
playReverse ():Void
Starts playing the effect from its current position back to the
beginning (completing at a position of 0.0
).
1.0.0
.privateprepareEffect ():Void
Called when the effect is initialized. Subclasses may override this method to customize the effect's behavior.
1.0.0
.stop ():Void
Stops the effect at its current position and forces Event.COMPLETE
to
be dispatched.
1.0.0
.See:
toEnd ():Void
Advances the effect immediately to the end and forces Event.COMPLETE
to be dispatched.
1.0.0
.See:
privateupdateEffect ():Void
Called when the effect's position is updated. Subclasses may override this method to customize the effect's behavior.
1.0.0
.