Package | net.flashpunk.tweens.misc |
Class | public class Alarm |
Inheritance | Alarm Tween Object |
Property | Defined By | ||
---|---|---|---|
active : Boolean
If the tween should update. | Tween | ||
complete : Function
Tween completion callback. | Tween | ||
delay : Number = 0
Length of time to wait before starting this tween. | Tween | ||
duration : Number [read-only]
Current alarm duration. | Alarm | ||
elapsed : Number [read-only]
How much time has passed since reset. | Alarm | ||
percent : Number
The completion percentage of the Tween. | Tween | ||
remaining : Number [read-only]
Time remaining on the alarm. | Alarm | ||
scale : Number [read-only]
The current time scale of the Tween (after easer has been applied). | Tween |
Method | Defined By | ||
---|---|---|---|
Alarm(duration:Number, complete:Function = null, type:uint = 0)
Constructor. | Alarm | ||
cancel():void
Immediately stops the Tween and removes it from its Tweener without calling the complete callback. | Tween | ||
reset(duration:Number):void
Sets the alarm. | Alarm | ||
start():void
Starts the Tween, or restarts it if it's currently running. | Tween | ||
update():void
Updates the Tween, called by World. | Tween |
duration | property |
duration:Number
[read-only] Current alarm duration.
public function get duration():Number
elapsed | property |
elapsed:Number
[read-only] How much time has passed since reset.
public function get elapsed():Number
remaining | property |
remaining:Number
[read-only] Time remaining on the alarm.
public function get remaining():Number
Alarm | () | Constructor |
public function Alarm(duration:Number, complete:Function = null, type:uint = 0)
Constructor.
Parametersduration:Number — Duration of the alarm.
| |
complete:Function (default = null ) — Optional completion callback.
| |
type:uint (default = 0 ) — Tween type.
|
reset | () | method |
public function reset(duration:Number):void
Sets the alarm.
Parameters
duration:Number — Duration of the alarm.
|