Class System

Readonly currentTick

Readonly events

clearRun

• clearRun(runId): void

• Parameters

  • runId: number

  Returns void

  Remarks

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

clearRunSchedule

• clearRunSchedule(runScheduleId): void

• Parameters

  • runScheduleId: number

  Returns void

  Remarks

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

run

• run(callback, tickDelay?): number

• Parameters

  • callback: (() => void)

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

    • • (): void

      • Returns void

  • Optional tickDelay: number

    Number of ticks to wait before running this function. 1 means this function will run on the next tick. A value of 20 means that this function will run in 20 ticks (or approximately one second). When the value of '0' is used within an event handler, this funtion will run later within the tick frame. Using the value of '0' within a System.run function is not supported.

  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.

runSchedule

• runSchedule(callback, tickInterval?): number

• Parameters

  • callback: (() => void)

    Function callback to run on the specified schedule.

    • • (): void

      • Returns void

  • Optional tickInterval: number

    The number of ticks to run this function within - run this function every tickInterval ticks.

  Returns number

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

  Remarks

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