API Reference

---

API Reference / Ticker

Class: Ticker

Defined in: system/Ticker.ts:6

Extends

• EventEmitter

Constructors

Constructor

new Ticker(stage): Ticker

Defined in: system/Ticker.ts:20

Parameters

stage

Stage

Returns

Ticker

Overrides

EventEmitter.constructor

Properties

$boundTick()

protected readonly $boundTick: () => void

Defined in: system/Ticker.ts:17

Returns

void

---

$deltaTime

protected $deltaTime: number = 0

Defined in: system/Ticker.ts:10

---

$emittingType

protected $emittingType: string = null

Defined in: event/EventEmitter.ts:6

Inherited from

EventEmitter.$emittingType

---

$enterFrameCallbackList

protected readonly $enterFrameCallbackList: Layer[]

Defined in: system/Ticker.ts:18

---

$events

protected $events: Object = {}

Defined in: event/EventEmitter.ts:5

Inherited from

EventEmitter.$events

---

$fps

protected $fps: number = 0

Defined in: system/Ticker.ts:9

---

$lastTimestamp

protected $lastTimestamp: number = 0

Defined in: system/Ticker.ts:14

---

$paused

protected $paused: boolean = true

Defined in: system/Ticker.ts:11

---

$removedListeners

protected $removedListeners: Listener[] = []

Defined in: event/EventEmitter.ts:7

Inherited from

EventEmitter.$removedListeners

---

$shouldResume

protected $shouldResume: boolean = false

Defined in: system/Ticker.ts:12

---

$stage

protected $stage: Stage = null

Defined in: system/Ticker.ts:8

---

$tickHandle

protected $tickHandle: number = null

Defined in: system/Ticker.ts:15

---

$timerIndex

protected $timerIndex: number = 0

Defined in: system/Ticker.ts:13

---

$timers

protected readonly $timers: Object

Defined in: system/Ticker.ts:16

Accessors

deltaTime

Get Signature

get deltaTime(): number

Defined in: system/Ticker.ts:33

Returns

number

---

fps

Get Signature

get fps(): number

Defined in: system/Ticker.ts:29

Returns

number

---

paused

Get Signature

get paused(): boolean

Defined in: system/Ticker.ts:37

Returns

boolean

Methods

$checkTimers()

protected $checkTimers(dt): void

Defined in: system/Ticker.ts:160

Parameters

dt

number

Returns

void

---

$start()

protected $start(): this

Defined in: system/Ticker.ts:41

Returns

this

---

$tick()

protected $tick(): void

Defined in: system/Ticker.ts:140

Returns

void

---

clearInterval()

clearInterval(handle): void

Defined in: system/Ticker.ts:119

Parameters

handle

number

Returns

void

---

clearTimeout()

clearTimeout(handle): void

Defined in: system/Ticker.ts:109

Parameters

handle

number

Returns

void

---

emit()

Call Signature

emit(event): boolean

Defined in: event/EventEmitter.ts:42

Parameters

event

Event

Returns

boolean

Inherited from

EventEmitter.emit

Call Signature

emit(type, ...args): boolean

Defined in: event/EventEmitter.ts:43

Parameters

type

string

args

...any[]

Returns

boolean

Inherited from

EventEmitter.emit

---

hasEventListener()

hasEventListener(type): boolean

Defined in: event/EventEmitter.ts:80

Parameters

type

string

Returns

boolean

Inherited from

EventEmitter.hasEventListener

---

off()

off(type, listener?): this

Defined in: event/EventEmitter.ts:16

Parameters

type

string

listener?

Listener

Returns

this

Inherited from

EventEmitter.off

---

on()

on(type, listener): this

Defined in: event/EventEmitter.ts:9

Parameters

type

string

listener

Listener

Returns

this

Inherited from

EventEmitter.on

---

once()

once(type, listener): this

Defined in: event/EventEmitter.ts:33

Parameters

type

string

listener

Listener

Returns

this

Inherited from

EventEmitter.once

---

pause()

pause(): this

Defined in: system/Ticker.ts:84

Returns

this

---

registerEnterFrameCallback()

registerEnterFrameCallback(layer): this

Defined in: system/Ticker.ts:123

Parameters

layer

Layer

Returns

this

---

removeAllListeners()

removeAllListeners(): this

Defined in: event/EventEmitter.ts:85

Returns

this

Inherited from

EventEmitter.removeAllListeners

---

resume()

resume(): this

Defined in: system/Ticker.ts:94

Returns

this

---

setInterval()

setInterval(handler, timeout): number

Defined in: system/Ticker.ts:113

Parameters

handler

Function

timeout

number

Returns

number

---

setTimeout()

setTimeout(handler, timeout?): number

Defined in: system/Ticker.ts:103

Parameters

handler

Function

timeout?

number = 0

Returns

number

---

unregisterEnterFrameCallback()

unregisterEnterFrameCallback(layer): this

Defined in: system/Ticker.ts:131

Parameters

layer

Layer

Returns

this