Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Timer

时间控制器

Hierarchy

  • Timer
    • Timer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new Timer(autoActive?: boolean): Timer

  • 创建 Timer 类的一个实例。

    Parameters

    • Optional autoActive: boolean

    Returns Timer

Properties

currFrame

currFrame: number

当前的帧数。

currTimer

currTimer: number

当前帧开始的时间。

scale

scale: number

时针缩放。

Accessors

delta

  • get delta(): number

  • 两帧之间的时间间隔,单位毫秒。

    Returns number

Methods

callLater

  • callLater<A>(method: A, caller?: unknown, args?: Parameters<A>): void

  • 延迟执行函数

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • method: A

      定时器回调函数

    • Optional caller: unknown

      执行域，一般是this，可选

    • Optional args: Parameters<A>

      回调参数，可选

    Returns void

clear

  • clear(method: (...args: any[]) => void, caller: unknown): void

  • 清理定时器

    Parameters

    • method: (...args: any[]) => void

      定时器回调函数

        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • caller: unknown

      执行域，一般是this

    Returns void

clearAll

  • clearAll(caller: unknown): void

  • 清理所有定时器

    Parameters

    • caller: unknown

      执行域，一般是this

    Returns void

frameLoop

  • frameLoop<A>(delay: number, method: A, caller?: unknown, args?: Parameters<A>, coverBefore?: boolean): void

  • 定时重复执行函数(基于帧)，不用或者销毁时，需要使用clear函数清除

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • delay: number

      延迟时间，单位为帧数

    • method: A

      定时器回调函数

    • Optional caller: unknown

      执行域，一般是this，可选

    • Optional args: Parameters<A>

      回调参数，可选

    • coverBefore: boolean = true

      是否覆盖之前的延迟执行，默认为 true

    Returns void

frameOnce

  • frameOnce<A>(delay: number, method: A, caller?: unknown, args?: Parameters<A>, coverBefore?: boolean): void

  • 定时执行一次函数(基于帧)，不用或者销毁时，需要使用clear函数清除

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • delay: number

      延迟时间，单位为帧数

    • method: A

      定时器回调函数

    • Optional caller: unknown

      执行域，一般是this，可选

    • Optional args: Parameters<A>

      回调参数，可选

    • coverBefore: boolean = true

      是否覆盖之前的延迟执行，默认为 true

    Returns void

loop

  • loop<A>(delay: number, method: A, caller?: unknown, args?: Parameters<A>, coverBefore?: boolean): void

  • 定时重复执行函数，不用或者销毁时，需要使用clear函数清除

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • delay: number

      延迟时间，单位为毫秒

    • method: A

      定时器回调函数

    • Optional caller: unknown

      执行域，一般是this，可选

    • Optional args: Parameters<A>

      回调参数，可选

    • coverBefore: boolean = true

      是否覆盖之前的延迟执行，默认为 true

    Returns void

once

  • once<A>(delay: number, method: A, caller?: unknown, args?: Parameters<A>, coverBefore?: boolean): void

  • 定时执行一次函数，不用或者销毁时，需要使用clear函数清除

    Type parameters

    • A: (...args: any[]) => void

    Parameters

    • delay: number

      延迟时间，单位为毫秒

    • method: A

      定时器回调函数

    • Optional caller: unknown

      执行域，一般是this，可选

    • Optional args: Parameters<A>

      回调参数，可选

    • coverBefore: boolean = true

      是否覆盖之前的延迟执行，默认为 true

    Returns void

pause

  • pause(): void

  • 暂停时钟

    Returns void

resume

  • resume(): void

  • 恢复时钟

    Returns void

runCallLater

  • runCallLater(method: (...args: any[]) => void, caller: unknown): void

  • 立即执行 callLater 。

    Parameters

    • method: (...args: any[]) => void

      定时器回调函数

        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • caller: unknown

      执行域，一般是this

    Returns void

runTimer

  • runTimer(method: (...args: any[]) => void, caller: unknown): void

  • 立即提前执行定时器，执行之后从队列中删除

    Parameters

    • method: (...args: any[]) => void

      定时器回调函数

        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • caller: unknown

      执行域，一般是this

    Returns void

sleep

  • sleep(time?: number): Promise<void>

  • 休眠一段时间

    Parameters

    • time: number = 1000

      休闲时间，单位为毫秒

    Returns Promise<void>

toString

  • toString(): string

  • 返回统计信息。

    Returns string