Packagenet.flashpunk
Classpublic class Tweener
InheritanceTweener Inheritance Object
Subclasses Entity, World

Updateable Tween container.



Public Properties
 PropertyDefined By
  active : Boolean = true
If this object should update.
Tweener
  autoClear : Boolean = false
If the Tweener should clear on removal.
Tweener
Public Methods
 MethodDefined By
  
Constructor.
Tweener
  
addTween(t:Tween, start:Boolean = false):Tween
Adds a new Tween.
Tweener
  
Removes all Tweens.
Tweener
  
Removes a Tween.
Tweener
  
update():void
Updates the Tween container.
Tweener
  
Updates all contained tweens.
Tweener
Public Constants
 ConstantDefined By
  LOOPING : uint = 1
Looping Tween type, will restart immediately when it finishes.
Tweener
  ONESHOT : uint = 2
Oneshot Tween type, will stop and remove itself from its core container when it finishes.
Tweener
  PERSIST : uint = 0
Persistent Tween type, will stop when it finishes.
Tweener
Property Detail
activeproperty
public var active:Boolean = true

If this object should update.

autoClearproperty 
public var autoClear:Boolean = false

If the Tweener should clear on removal. For Entities, this is when they are removed from a World, and for World this is when the active World is switched.

Constructor Detail
Tweener()Constructor
public function Tweener()

Constructor.

Method Detail
addTween()method
public function addTween(t:Tween, start:Boolean = false):Tween

Adds a new Tween.

Parameters

t:Tween — The Tween to add.
 
start:Boolean (default = false) — If the Tween should call start() immediately.

Returns
Tween — The added Tween.
clearTweens()method 
public function clearTweens():void

Removes all Tweens.

removeTween()method 
public function removeTween(t:Tween):Tween

Removes a Tween.

Parameters

t:Tween — The Tween to remove.

Returns
Tween — The removed Tween.
update()method 
public function update():void

Updates the Tween container.

updateTweens()method 
public function updateTweens():void

Updates all contained tweens.

Constant Detail
LOOPINGConstant
public const LOOPING:uint = 1

Looping Tween type, will restart immediately when it finishes.

ONESHOTConstant 
public const ONESHOT:uint = 2

Oneshot Tween type, will stop and remove itself from its core container when it finishes.

PERSISTConstant 
public const PERSIST:uint = 0

Persistent Tween type, will stop when it finishes.