Show:

JSUTILS.Timer Class

Extends JSUTILS.EventDispatcher
Defined in: src/utils/Timer.js:16

The Timer object wraps the window.setInterval() method to provide an as3-like Timer interface.

Constructor

JSUTILS.Timer

(
  • delay
  • repeatCount
)

Defined in src/utils/Timer.js:16

Parameters:

  • delay Number

    The delay (ms) interval between ticks

  • repeatCount Number

    The number of number of ticks. A value of zero will set the timer to repeat forever. Default = 0

Methods

addEventListener

(
  • type
  • listener
)

Inherited from JSUTILS.EventDispatcher: src/utils/EventDispatcher.js:37

Parameters:

  • type String

    The event type

  • listener Function

    The function to be called when the event is fired

dispatchEvent

(
  • type
  • optionalParams
)

Inherited from JSUTILS.EventDispatcher: src/utils/EventDispatcher.js:78

Parameters:

  • type Event

    The Event object.

  • optionalParams Object

    Optional parameters passed as an object. return {boolean} True if dispatch is successful, false if not.

hasEventListener

(
  • type
)

Inherited from JSUTILS.EventDispatcher: src/utils/EventDispatcher.js:65

Parameters:

  • type String

    The event type return {boolean} True is listener exists for this type, false if not.

onTick

() private

Defined in src/utils/Timer.js:141

removeEventListener

(
  • type
  • listener
)

Inherited from JSUTILS.EventDispatcher: src/utils/EventDispatcher.js:50

Parameters:

  • type String

    The event type

  • listener Function

    The function to be called when the event is fired

reset

()

Defined in src/utils/Timer.js:120

Stop the timer and reset the count to zero.

start

()

Defined in src/utils/Timer.js:109

Start the timer.

stop

()

Defined in src/utils/Timer.js:129

Stop the timer.

Properties

currentCount

Number

Defined in src/utils/Timer.js:95

[read-only] Returns the current count (number of ticks since timer started).

delay

Number

Defined in src/utils/Timer.js:45

The delay interval in milliseconds.

repeatCount

Number

Defined in src/utils/Timer.js:64

The repeat count in milliseconds.

running

Number

Defined in src/utils/Timer.js:83

[read-only] Returns true if the timer is running.

Events

timerComplete

JSUTILS.TimerEvent.TIMER_COMPLETE

Defined in src/utils/Timer.js:165

The timerComplete event is dispatched when the repeatCount value

Event Payload:

timerTick

JSUTILS.TimerEvent.TIMER

Defined in src/utils/Timer.js:157

The timerTick event is dispatched at the rate specified by the delay interval.

Event Payload: