Class System

Readonly Beta currentTick

Readonly Beta events

clearRun

• clearRun(runId): void
• Beta

  Parameters

  • runId: number

  Returns void

  Remarks

  Cancels the execution of a function run that was previously scheduled via the run function.

run

• run(callback): number

• Parameters

  • callback: (() => void)

    Function callback to run when the tickDelay time criteria is met.

    • • (): void

      • Returns void

  Returns number

  An opaque identifier that can be used with the clearRun function to cancel the execution of this run.

  Remarks

  Runs a specified function at a future time. This is frequently used to implement delayed behaviors and game loops.

runInterval

• runInterval(callback, tickInterval?): number

• Parameters

  • callback: (() => void)

    • • (): void

      • Returns void

  • Optional tickInterval: number

  Returns number

runTimeout

• runTimeout(callback, tickDelay?): number

• Parameters

  • callback: (() => void)

    • • (): void

      • Returns void

  • Optional tickDelay: number

  Returns number