| Package | net.flashpunk |
| Class | public class Tweener |
| Inheritance | Tweener Object |
| Subclasses | Entity, World |
| Property | Defined By | ||
|---|---|---|---|
| active : Boolean = true
If this object should update. | Tweener | ||
| autoClear : Boolean = false
If the Tweener should clear on removal. | Tweener | ||
| Method | Defined By | ||
|---|---|---|---|
Tweener()
Constructor. | Tweener | ||
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 | ||
| Constant | Defined 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 | ||
| active | property |
public var active:Boolean = trueIf this object should update.
| autoClear | property |
public var autoClear:Boolean = falseIf 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.
| Tweener | () | Constructor |
public function Tweener()Constructor.
| addTween | () | method |
public function addTween(t:Tween, start:Boolean = false):TweenAdds a new Tween.
Parameters
t:Tween — The Tween to add.
| |
start:Boolean (default = false) — If the Tween should call start() immediately.
|
Tween — The added Tween.
|
| clearTweens | () | method |
public function clearTweens():voidRemoves all Tweens.
| removeTween | () | method |
public function removeTween(t:Tween):TweenRemoves a Tween.
Parameters
t:Tween — The Tween to remove.
|
Tween — The removed Tween.
|
| update | () | method |
public function update():voidUpdates the Tween container.
| updateTweens | () | method |
public function updateTweens():voidUpdates all contained tweens.
| LOOPING | Constant |
public const LOOPING:uint = 1Looping Tween type, will restart immediately when it finishes.
| ONESHOT | Constant |
public const ONESHOT:uint = 2Oneshot Tween type, will stop and remove itself from its core container when it finishes.
| PERSIST | Constant |
public const PERSIST:uint = 0Persistent Tween type, will stop when it finishes.