window.runtime propertywindow.runtime.flash.utils.Timer
InheritanceTimer Inheritance EventDispatcher
Runtime Versions:  1.0

The Timer class is the interface to timers, which let you run code on a specified time sequence. Use the start() method to start a timer. Add an event listener for the timer event to set up code to be run on the timer interval.

You can create Timer objects to run once or repeat at specified intervals to execute code on a schedule. Applications may dispatch events at slightly offset intervals based on the internal frame rate of the application. Memory-intensive scripts may also offset the events.



Properties
 PropertyDefined By
  currentCount : int
[read-only] The total number of times the timer has fired since it started at zero.
Timer
  delay : Number
The delay, in milliseconds, between timer events.
Timer
  repeatCount : int
The total number of times the timer is set to run.
Timer
  running : Boolean
[read-only] The timer's current state; true if the timer is running, otherwise false.
Timer
Public Methods
 MethodDefined By
  
Timer(delay:Number, repeatCount:int = 0)
Constructs a new Timer object with the specified delay and repeatCount states.
Timer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
reset():void
Stops the timer, if it is running, and sets the currentCount property back to 0, like the reset button of a stopwatch.
Timer
  
start():void
Starts the timer, if it is not already running.
Timer
  
stop():void
Stops the timer.
Timer
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property.Timer
  Dispatched whenever it has completed the number of requests set by Timer.repeatCount.Timer
Property Detail
currentCountproperty
currentCount:int  [read-only]
Runtime Versions:  1.0

The total number of times the timer has fired since it started at zero. If the timer has been reset, only the fires since the reset are counted.

delayproperty 
delay:Number
Runtime Versions:  1.0

The delay, in milliseconds, between timer events. If you set the delay interval while the timer is running, the timer will restart at the same repeatCount iteration.


Throws
— Throws an exception if the delay specified is negative or not a finite number.
repeatCountproperty 
repeatCount:int
Runtime Versions:  1.0

The total number of times the timer is set to run. If the repeat count is set to 0, the timer continues forever or until the stop() method is invoked or the program stops. If the repeat count is nonzero, the timer runs the specified number of times. If repeatCount is set to a total that is the same or less then currentCount the timer stops and will not fire again.

runningproperty 
running:Boolean  [read-only]
Runtime Versions:  1.0

The timer's current state; true if the timer is running, otherwise false.

Constructor Detail
Timer()Constructor
function Timer(delay:Number, repeatCount:int = 0)
Runtime Versions:  1.0

Constructs a new Timer object with the specified delay and repeatCount states.

The timer does not start automatically; you must call the start() method to start it.

Parameters
delay:Number — The delay between timer events, in milliseconds.
 
repeatCount:int (default = 0) — Specifies the number of repetitions. If zero, the timer repeats infinitely. If nonzero, the timer runs the specified number of times and then stops.

Throws
— if the delay specified is negative or not a finite number
Method Detail
reset()method
function reset():void
Runtime Versions:  1.0

Stops the timer, if it is running, and sets the currentCount property back to 0, like the reset button of a stopwatch. Then, when start() is called, the timer instance runs for the specified number of repetitions, as set by the repeatCount value.

See also

start()method 
function start():void
Runtime Versions:  1.0

Starts the timer, if it is not already running.

stop()method 
function stop():void
Runtime Versions:  1.0

Stops the timer. When start() is called after stop(), the timer instance runs for the remaining number of repetitions, as set by the repeatCount property.

See also

Event Detail
timer Event
Event Object Type: flash.events.TimerEvent
property TimerEvent.type = flash.events.TimerEvent.TIMER
Runtime Versions:  1.0

Dispatched whenever a Timer object reaches an interval specified according to the Timer.delay property.

Defines the value of the type property of a timer event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe Timer object that has reached its interval.
timerComplete Event  
Event Object Type: flash.events.TimerEvent
property TimerEvent.type = flash.events.TimerEvent.TIMER_COMPLETE
Runtime Versions:  1.0

Dispatched whenever it has completed the number of requests set by Timer.repeatCount.

Defines the value of the type property of a timerComplete event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe Timer object that has completed its requests.