Timer
Kind of class: | class |
---|---|
Inherits from: | EventDispatcher < CoreObject |
Implements: | |
Known subclasses: | |
Version: | 04/09/07 |
Author: | Aaron Clinger |
Classpath: | org.casalib.time.Timer |
File last modified: | Monday, 01 December 2008, 13:34:40 |
Timer is used for executing code at a specific callback frequency.
Example:
-
function onFire(sender:Timer, fires:Number):Void { trace("onFire has been called " + fires + " times."); } var myTimer:Timer = new Timer(1000, 3); this.myTimer.addEventObserver(this, Timer.EVENT_FIRE, "onFire"); this.myTimer.start();
Events broadcasted to listeners:
onStart = function (sender:Timer) {}
onStop = function (sender:Timer) {}
onFire = function (sender:Timer, fires:Number) {}
onComplete = function (sender:Timer, fires:Number) {}
Summary
Constructor
- Timer (delay:Number, reps:Number)
- Defines the Timer object that dispatches an event at a specific frequency.
Class properties
- EVENT_START : String
- EVENT_STOP : String
- EVENT_FIRE : String
- EVENT_COMPLETE : String
Instance methods
- start : Void
- Starts or restarts the timer.
- stop : Void
- Stops the timer.
- changeDelay (delay:Number) : Void
- Changes the time between repetitions.
- getDelay : Number
- isFiring : Boolean
- Determines in the timer is running.
- getFires : Number
- Returns the number of fires.
- destroy : Void
- Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.Instance methods inherited from EventDispatcherInstance methods inherited from CoreObject
Constructor
Timer
function Timer (
delay:Number,
reps:Number)
Defines the Timer object that dispatches an event at a specific frequency.
Parameters:
delay:
The time in milliseconds between calls.
reps :
The amount of repetitions.
Class properties
EVENT_COMPLETE
static EVENT_COMPLETE:String = 'onComplete'
(read,write)
EVENT_FIRE
static EVENT_FIRE:String = 'onFire'
(read,write)
EVENT_START
static EVENT_START:String = 'onStart'
(read,write)
EVENT_STOP
static EVENT_STOP:String = 'onStop'
(read,write)
Instance methods
changeDelay
function changeDelay (
delay:Number) : Void
Changes the time between repetitions. Does NOT reset reps/fires.
Parameters:
delay:
The time in milliseconds between calls.
destroy
function destroy (
) : Void
Removes any internal variables, intervals, enter frames, internal MovieClips and event observers to allow the object to be garbage collected.
Always call
# Always call
function onFire(sender:Timer, fires:Number):Void { trace("onFire has been called " + fires + " times."); } var myTimer:Timer = new Timer(1000, 3); this.myTimer.addEventObserver(this, Timer.EVENT_FIRE, "onFire"); this.myTimer.start();before deleting last object pointer.
Overrides:
Specified by:
getDelay
function getDelay (
) : Number
Returns:
- Returns the time between repetitions.
getFires
function getFires (
) : Number
Returns the number of fires.
Returns:
- The number of elapsed fires.
isFiring
function isFiring (
) : Boolean
Determines in the timer is running.
Returns:
- Returns
true
if Timer instance is running/firing; otherwisefalse
.
start
function start (
) : Void
Starts or restarts the timer. Resets reps/fires to 0.
Events broadcasted to listeners:
onStart = function (sender:Timer) {}
Specified by:
stop
function stop (
) : Void
Stops the timer.
Events broadcasted to listeners:
onStop = function (sender:Timer) {}
Specified by: