Class System

ReadonlycurrentTick

clearRun

• clearRun(runId: number): void

  Parameters

  • runId: number

  Returns void

  Remarks

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

  This function can't be called in read-only mode.

run

• run(callback: () => void): number

  Parameters

  • callback: () => void

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

  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.

  This function can't be called in read-only mode.

runInterval

• runInterval(callback: () => void, tickInterval?: number): number

  Parameters

  • callback: () => void

    Functional code that will run when this interval occurs.
  • OptionaltickInterval: number

    An interval of every N ticks that the callback will be called upon.

  Returns number

  An opaque handle that can be used with the clearRun method to stop the run of this function on an interval.

  Remarks

  Runs a set of code on an interval.

  This function can't be called in read-only mode.

runTimeout

• runTimeout(callback: () => void, tickDelay?: number): number

  Parameters

  • callback: () => void

    Functional code that will run when this timeout occurs.
  • OptionaltickDelay: number

    Amount of time, in ticks, before the interval will be called.

  Returns number

  An opaque handle that can be used with the clearRun method to stop the run of this function on an interval.

  Remarks

  Runs a set of code at a future time specified by tickDelay.

  This function can't be called in read-only mode.