sim

sim

namespace

Simulation tick scheduler

Functions

sim.tick()

Current simulation tick of the running session

returns number

sim.at(due_tick, handler)

Call a handler once at an absolute tick, returns the cancellation handle

due_tick number Absolute simulation tick
handler function Function called when the tick is reached

returns number

sim.after(delay_ticks, handler)

Call a handler once after a delay, returns the cancellation handle

delay_ticks number Delay in simulation ticks, at least one
handler function Function called when the delay expires

returns number

sim.every(interval_ticks, handler)

Call a handler on a repeating interval, returns the cancellation handle

interval_ticks number Interval in simulation ticks, at least one
handler function Function called on every interval

returns number

sim.cancel(handle)

Cancel a scheduled callback

handle number Handle returned by at, after or every

returns boolean