Class TickHelper

Helps instruct when to tick. Times are based on performance.now()

Hierarchy

  • TickHelper

Constructors

constructor

Properties

lastTickTime nextTickTime

Accessors

hasScheduledTick

Methods

hasTimePassedSinceLastTick markTick reset scheduleTick shouldTick unscheduleTick

Constructors

constructor

Properties

lastTickTime

lastTickTime: undefined | number

Time the last tick occurred

nextTickTime

nextTickTime: undefined | number

Time the next tick should run

Accessors

hasScheduledTick

  • get hasScheduledTick(): boolean

  • Check if a tick is scheduled

    Returns boolean

Methods

hasTimePassedSinceLastTick

  • Checks if the amount of time has passed since the previous tick

    Parameters

    • delay: number

      Delay

    • timeStamp: number = ...

      Timestamp or undefined if it's not available from the caller

    Returns boolean

markTick

  • Mark that we ticked

    Parameters

    • timeStamp: number = ...

    Returns void

reset

  • Resets internal data

    Returns void

scheduleTick

  • Schedules a tick

    Parameters

    • tickSpeed: number = ...

      Game tick speed

    • timeStamp: number = ...

      Timestamp or undefined if it's not available from the caller

    • Optional minTime: number

      Minimum amount of time until the next time should run

    Returns void

shouldTick

  • Check if we should tick based on the provided timestamp.

    Parameters

    • timeStamp: number = ...

    Returns boolean

unscheduleTick

  • Clears any pending scheduled tick

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc