timer

Methods
5
Fields
None

Getting one

timer

Methods

MethodReturnsDescription
after(number, () -> ())ScheduledFutureRun task once, delay milliseconds from now, on the client thread (at the first cycle at or after it is due).
every(number, () -> (), number?)ScheduledFutureRun task every period milliseconds, first after initialDelay (default one period), on the client thread. Runs missed while the game s…
afterTicks(number, () -> ())ScheduledFutureRun task once, ticks server ticks from now, right after that tick's GameTick.
everyTicks(number, () -> ())ScheduledFutureRun task every ticks server ticks, first ticks from now.
cancel(ScheduledFuture)booleanCancel future: future:cancel(false).

Method details

after

after: (TimerService, number, () -> ()) -> ScheduledFuture

Run task once, delay milliseconds from now, on the client thread (at the first cycle at or after it is due).

every

every: (TimerService, number, () -> (), number?) -> ScheduledFuture

Run task every period milliseconds, first after initialDelay (default one period), on the client thread. Runs missed while the game stalled are made up back to back, at most 16 per cycle.

Example
local saving: ScheduledFuture? = nil

function plugin:startUp()
    -- Every 30 seconds, on the client thread.
    saving = timer:every(30000, function()
        log:debug("saving")
    end)
end

function plugin:shutDown()
    if saving then
        saving:cancel(false)
        saving = nil
    end
end