sdk.schedule

Timers on game.on("tick"). after / every are non-blocking. wait(ms) yields only when the caller is a coroutine.

local M = require("sdk.schedule")

now

function · now(): number

Monotonic timer service. Times are steady-clock milliseconds, not Unix time.

Returns

Type	Summary
number	—

pump

function · pump(now)

Fire due timers. The host tick already calls this.

after

function · after(delay_ms: number, callback: fun()): TimerId?, ErrorMessage?

Delay is clamped to at least 0 ms.

Parameters

Name	Type	Summary
delay_ms	number	—
callback	fun()	—

Returns

Type	Summary
TimerId?, ErrorMessage?	—

every

function · every(interval_ms: number, callback: fun()): TimerId?, ErrorMessage?

Interval is clamped to at least 1 ms.

Parameters

Name	Type	Summary
interval_ms	number	—
callback	fun()	—

Returns

Type	Summary
TimerId?, ErrorMessage?	—

cancel

function · cancel(id: TimerId): Result?, ErrorMessage?

Monotonic timer service. Times are steady-clock milliseconds, not Unix time.

Parameters

Name	Type	Summary
id	TimerId	—

Returns

Type	Summary
Result?, ErrorMessage?	—

reset

function · reset()

Monotonic timer service. Times are steady-clock milliseconds, not Unix time.

wait

function · wait(ms)

Suspend the current coroutine for at least ms without blocking the game thread. Calling this from a normal top-level script is an API error; use after there.

Parameters

Name	Type	Summary
ms	number	—

Returns

Type	Summary
boolean|nil	ok
string|nil	err