Packagenet.flashpunk
Classpublic class Tweener
SubclassesEntity, World

Updateable Tween container.



Public Properties
 PropertyDefined by
  active : Boolean = true
If the Tweener 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
  
clearTweens():void
Removes all Tweens.
Tweener
  
Removes a Tween.
Tweener
  
update():void
Updates the Tween container.
Tweener
  
updateTweens():void
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 the Tweener 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.