API Reference / Ticker
# Class: Ticker
# Hierarchy
-
↳
Ticker
# Table of contents
# Constructors
# Properties
- $boundTick
- $deltaTime
- $emittingType
- $enterFrameCallbackList
- $events
- $fps
- $lastTimestamp
- $paused
- $removedListeners
- $shouldResume
- $stage
- $tickHandle
- $timerIndex
- $timers
# Accessors
# Methods
- $checkTimers
- $start
- $tick
- clearInterval
- clearTimeout
- emit
- hasEventListener
- off
- on
- once
- pause
- registerEnterFrameCallback
- removeAllListeners
- resume
- setInterval
- setTimeout
- unregisterEnterFrameCallback
# Constructors
# constructor
• new Ticker(stage)
# Parameters
| Name | Type |
|---|---|
stage | Stage |
# Overrides
# Defined in
system/Ticker.ts:20 (opens new window)
# Properties
# $boundTick
• Protected Readonly $boundTick: () => void
# Type declaration
▸ (): void
# Returns
void
# Defined in
system/Ticker.ts:17 (opens new window)
# $deltaTime
• Protected $deltaTime: number = 0
# Defined in
system/Ticker.ts:10 (opens new window)
# $emittingType
• Protected $emittingType: string = null
# Inherited from
# Defined in
event/EventEmitter.ts:6 (opens new window)
# $enterFrameCallbackList
• Protected Readonly $enterFrameCallbackList: Layer[]
# Defined in
system/Ticker.ts:18 (opens new window)
# $events
• Protected $events: Object = {}
# Inherited from
# Defined in
event/EventEmitter.ts:5 (opens new window)
# $fps
• Protected $fps: number = 0
# Defined in
system/Ticker.ts:9 (opens new window)
# $lastTimestamp
• Protected $lastTimestamp: number = 0
# Defined in
system/Ticker.ts:14 (opens new window)
# $paused
• Protected $paused: boolean = true
# Defined in
system/Ticker.ts:11 (opens new window)
# $removedListeners
• Protected $removedListeners: Listener[] = []
# Inherited from
EventEmitter.$removedListeners
# Defined in
event/EventEmitter.ts:7 (opens new window)
# $shouldResume
• Protected $shouldResume: boolean = false
# Defined in
system/Ticker.ts:12 (opens new window)
# $stage
• Protected $stage: Stage = null
# Defined in
system/Ticker.ts:8 (opens new window)
# $tickHandle
• Protected $tickHandle: number = null
# Defined in
system/Ticker.ts:15 (opens new window)
# $timerIndex
• Protected $timerIndex: number = 0
# Defined in
system/Ticker.ts:13 (opens new window)
# $timers
• Protected Readonly $timers: Object
# Defined in
system/Ticker.ts:16 (opens new window)
# Accessors
# deltaTime
• get deltaTime(): number
# Returns
number
# Defined in
system/Ticker.ts:33 (opens new window)
# fps
• get fps(): number
# Returns
number
# Defined in
system/Ticker.ts:29 (opens new window)
# paused
• get paused(): boolean
# Returns
boolean
# Defined in
system/Ticker.ts:37 (opens new window)
# Methods
# $checkTimers
▸ Protected $checkTimers(dt): void
# Parameters
| Name | Type |
|---|---|
dt | number |
# Returns
void
# Defined in
system/Ticker.ts:160 (opens new window)
# $start
▸ Protected $start(): Ticker
# Returns
# Defined in
system/Ticker.ts:41 (opens new window)
# $tick
▸ Protected $tick(): void
# Returns
void
# Defined in
system/Ticker.ts:140 (opens new window)
# clearInterval
▸ clearInterval(handle): void
# Parameters
| Name | Type |
|---|---|
handle | number |
# Returns
void
# Defined in
system/Ticker.ts:119 (opens new window)
# clearTimeout
▸ clearTimeout(handle): void
# Parameters
| Name | Type |
|---|---|
handle | number |
# Returns
void
# Defined in
system/Ticker.ts:109 (opens new window)
# emit
▸ emit(event): boolean
# Parameters
| Name | Type |
|---|---|
event | Event |
# Returns
boolean
# Inherited from
# Defined in
event/EventEmitter.ts:42 (opens new window)
▸ emit(type, ...args): boolean
# Parameters
| Name | Type |
|---|---|
type | string |
...args | any[] |
# Returns
boolean
# Inherited from
# Defined in
event/EventEmitter.ts:43 (opens new window)
# hasEventListener
▸ hasEventListener(type): boolean
# Parameters
| Name | Type |
|---|---|
type | string |
# Returns
boolean
# Inherited from
# Defined in
event/EventEmitter.ts:80 (opens new window)
# off
▸ off(type, listener?): Ticker
# Parameters
| Name | Type |
|---|---|
type | string |
listener? | Listener |
# Returns
# Inherited from
# Defined in
event/EventEmitter.ts:16 (opens new window)
# on
▸ on(type, listener): Ticker
# Parameters
| Name | Type |
|---|---|
type | string |
listener | Listener |
# Returns
# Inherited from
# Defined in
event/EventEmitter.ts:9 (opens new window)
# once
▸ once(type, listener): Ticker
# Parameters
| Name | Type |
|---|---|
type | string |
listener | Listener |
# Returns
# Inherited from
# Defined in
event/EventEmitter.ts:33 (opens new window)
# pause
▸ pause(): Ticker
# Returns
# Defined in
system/Ticker.ts:84 (opens new window)
# registerEnterFrameCallback
▸ registerEnterFrameCallback(layer): Ticker
# Parameters
| Name | Type |
|---|---|
layer | Layer |
# Returns
# Defined in
system/Ticker.ts:123 (opens new window)
# removeAllListeners
▸ removeAllListeners(): Ticker
# Returns
# Inherited from
EventEmitter.removeAllListeners
# Defined in
event/EventEmitter.ts:85 (opens new window)
# resume
▸ resume(): Ticker
# Returns
# Defined in
system/Ticker.ts:94 (opens new window)
# setInterval
▸ setInterval(handler, timeout): number
# Parameters
| Name | Type |
|---|---|
handler | Function |
timeout | number |
# Returns
number
# Defined in
system/Ticker.ts:113 (opens new window)
# setTimeout
▸ setTimeout(handler, timeout?): number
# Parameters
| Name | Type | Default value |
|---|---|---|
handler | Function | undefined |
timeout | number | 0 |
# Returns
number
# Defined in
system/Ticker.ts:103 (opens new window)
# unregisterEnterFrameCallback
▸ unregisterEnterFrameCallback(layer): Ticker
# Parameters
| Name | Type |
|---|---|
layer | Layer |