API Docs for: 1.4.0
Show:

Kiwi.Time.TimerEvent Class

Defined in: src\time\TimerEvent.ts:10
Module: Time
Parent Module: Kiwi

A TimerEvent hooks into a Timer and is an object that is generated when you are wanting to executed a callback at a specific point in time.

Constructor

Kiwi.Time.TimerEvent

(
  • type
  • callback
  • context
)
Kiwi.Time.TimerEvent

Defined in src\time\TimerEvent.ts:10

Parameters:

  • type Number

    The type of TimerEvent that this is.

  • callback Any

    The method that is to be executed when the event occurs.

  • context Any

    The context that the callback is to be called in.

Returns:

Kiwi.Time.TimerEvent:

This Object.

Item Index

Methods

Properties

Methods

objType

() String public

Defined in src\time\TimerEvent.ts:31

The type of object that this is.

Returns:

String:

"TimerEvent"

run

() public

Defined in src\time\TimerEvent.ts:98

Fires the callback associated with this TimerEvent

Properties

_callback

Function private

Defined in src\time\TimerEvent.ts:74

The callback to be called when this TimerEvent triggers

_callbackContext

Function private

Defined in src\time\TimerEvent.ts:82

The context in which the callback will be fired

TIMER_COUNT

String public final static

Defined in src\time\TimerEvent.ts:52

Name for the event fired when a timer repeats.

Default: 2

TIMER_START

Number public final static

Defined in src\time\TimerEvent.ts:41

Name for the event fired when a timer starts.

Default: 1

TIMER_STOP

String public final static

Defined in src\time\TimerEvent.ts:63

Name for the event fired when a timer stops.

Default: 3

type

Function public

Defined in src\time\TimerEvent.ts:90

The type of TimerEvent