Ticker

Index

Constructors

• constructor

Accessors

• accumulator
• deltaTime
• deltaTimeMs
• isRunning
• isStopped
• maxAccumulation
• realtimeSinceStartup
• realtimeSinceStartupMs
• tickNumber

Methods

• getHighResolutionTime
• setMaxAccumulation
• setTickNumber
• setTickRate
• start
• stop

Constructors

constructor

• new Ticker(tickFunction: () => void, tickRate?: number, maxAccumulation?: number, startImmediately?: boolean): Ticker

• Creates a new Ticker.

  ---

  Parameters

  • tickFunction: () => void

    Function to be called on each tick.

  • tickRate: number = 60

    Number of ticks per second.

  • maxAccumulation: number = 25

    Maximum number of milliseconds that can be accumulated.

  • startImmediately: boolean = true

    Whether to start the ticker immediately.

  Returns Ticker

Accessors

accumulator

• get accumulator(): number

• Current accumulated frame time, in milliseconds.

  @memberof

  Ticker

  @see

  • maxAccumulation
  • deltaTimeMs
  • deltaTime

  ---

  Returns number

deltaTime

• get deltaTime(): number

• Fixed time between ticks, in seconds.

  @memberof

  Ticker

  @see

  deltaTimeMs

  ---

  Returns number

deltaTimeMs

• get deltaTimeMs(): number

• Fixed time between ticks, in milliseconds.

  @memberof

  Ticker

  @see

  deltaTime

  ---

  Returns number

isRunning

• get isRunning(): boolean

• Whether the ticker is running.

  @memberof

  Ticker

  ---

  Returns boolean

isStopped

• get isStopped(): boolean

• Whether the ticker is stopped.

  @memberof

  Ticker

  ---

  Returns boolean

maxAccumulation

• get maxAccumulation(): number

• Maximum number of milliseconds that can be accumulated in a single tick.

  @memberof

  Ticker

  @see

  • accumulator
  • deltaTimeMs
  • deltaTime

  ---

  Returns number

realtimeSinceStartup

• get realtimeSinceStartup(): number

• Time since the ticker started, in seconds.

  @memberof

  Ticker

  ---

  Returns number

realtimeSinceStartupMs

• get realtimeSinceStartupMs(): number

• Time since the ticker started, in milliseconds.

  @memberof

  Ticker

  ---

  Returns number

tickNumber

• get tickNumber(): number

• Current tick number. Increased by 1 every time tick() gets called.

  @memberof

  Ticker

  ---

  Returns number

Methods

getHighResolutionTime

• getHighResolutionTime(): number

• Returns the current time in milliseconds. High-res if supported.

  ---

  Returns number

  Current time in milliseconds.

setMaxAccumulation

• setMaxAccumulation(maxAccumulation: number): void

• Sets the maximum number of milliseconds that can be accumulated in one frame.

  ---

  Parameters

  • maxAccumulation: number

    Maximum number of milliseconds that can be accumulated.

  Returns void

setTickNumber

• setTickNumber(tickNumber: number): void

• Sets the current tick number.

  @memberof

  Ticker

  @see

  tickNumber

  ---

  Parameters

  • tickNumber: number

    Tick number.

  Returns void

setTickRate

• setTickRate(ticksPerSecond: number): void

• How many times a second should we tick?

  ---

  Parameters

  • ticksPerSecond: number

    Number of ticks per second.

  Returns void

start

• start(): void

• Starts the ticker.

  ---

  Returns void

stop

• stop(): void

• Stops the ticker.

  ---

  Returns void