TimeMagic

Index

Constructors

• constructor

Properties

• accumulateTime
• lastTickTime
• playing
• speed

Methods

• addFn
• dispose
• executeFrameOrder
• getTime
• pause
• play
• registryRateLevel
• removeFn
• replay
• stop
• tick
• updateLastTickTime
• updateSpeed

Constructors

constructor

• new TimeMagic(frameRateLimiter?: number, speed?: number): TimeMagic

• Parameters

  • frameRateLimiter: number = 60

  • speed: number = 1

  Returns TimeMagic

Properties

accumulateTime

accumulateTime: number = 0

Accumulated tick time since TimeMagic was created.

lastTickTime

lastTickTime: number = -1

Last valid rendering time stamp.

playing

playing: boolean = false

speed

speed: number

Methods

addFn

• addFn(x: TickCallback, frameRateLevel?: FrameRateLevel, frameOrderLevel?: FrameOrderLevel): void

• Parameters

  • x: TickCallback

  • frameRateLevel: FrameRateLevel = DEFAULT_FRAME_RATE_LEVEL

  • frameOrderLevel: FrameOrderLevel = DEFAULT_FRAME_ORDER_LEVEL

  Returns void

dispose

• dispose(): void

• Returns void

executeFrameOrder

• executeFrameOrder(frameOrderLevel: FrameOrderLevel, timestamp?: number, deltaTime?: number, framesElapsed?: number): void

• Parameters

  • frameOrderLevel: FrameOrderLevel

  • timestamp: number = 0

  • deltaTime: number = 0

  • framesElapsed: number = 0

  Returns void

getTime

• getTime(): number

• Returns number

pause

• pause(): void

• Returns void

play

• play(): void

• Returns void

registryRateLevel

• registryRateLevel(frameRateLevel: FrameRateLevel, tokenName?: string): () => void

• Request the ticker run in specific frame rate level.

  ---

  Parameters

  • frameRateLevel: FrameRateLevel

    The frame rate level that is expected to work.

  • tokenName: string = 'cancelToken'

    The name of the task, only for debug purpose, two tokens with the same name won’t be overwritten.

  Returns () => void

  A callback that will cancel this task.

  • • (): void

    • Returns void

removeFn

• removeFn(x: TickCallback, frameOrderLevel?: FrameOrderLevel): void

• Parameters

  • x: TickCallback

  • frameOrderLevel: FrameOrderLevel = null

  Returns void

replay

• replay(): void

• Returns void

stop

• stop(): void

• Returns void

tick

• tick(x?: number): void

• Parameters

  • x: number = -1

  Returns void

updateLastTickTime

• updateLastTickTime(t: number): void

• Mark the timestamp as a valid rendering frame.

  ---

  Parameters

  • t: number

    The time stamp of the current frame.

  Returns void

updateSpeed

• updateSpeed(speed: number): void

• Parameters

  • speed: number

  Returns void