Documentation
Timers

Timers

All Lua functions and events in the Timers category, on the server and the client.

Shared functions 16

asyncRuns a function as a task (coroutine). The code in the task runs immediately until its first wait (sleep, await, waitForEvent). Then it yields and the server and the game keep running. When the wait is over, the task continues from where it stopped. This lets you write steps spread over time (a countdown, a database query, an HTTP response, waiting for a player) one after another, without nested callbacks and timers.
awaitWaits for a result inside an async task. It takes two forms. The first is a starter function: it receives resume and starts something that ends in a callback (a dbQuery query, fetchRemote, a timer). When the callback calls resume(...), await returns the same values. The second form is another task from async: await waits until it ends and returns its results, and if that task failed, it re-throws the error (catch it with pcall).
getTaskStatusReturns the state of a task from async: "running" (waiting or working), "done" (finished) or "failed" (error). After the state it returns the values returned by the task function or, for "failed", the error message.
getTimerDetailsReturns the time until the timer's next call, the number of remaining repeats and the interval.
getTimerInfoReturns a description of the timer as a table: remaining, repeats, interval, paused and resource.
getTimersReturns the active timers of the calling resource. With an argument, only those whose interval does not exceed the given number of ms.
isTaskChecks whether a value is a task returned by async.
isTimerChecks whether a value is an active timer. A one-shot timer stops being active after it fires.
isTimerPausedChecks whether a timer is paused by setTimerPaused.
killTimerStops a timer permanently. Its function will not be called any more.
resetTimerRestarts counting the timer's interval from this moment.
setTimerCalls a function after a given time, once, several times or forever.
setTimerDelaySets the time until the timer's next call without changing its interval.
setTimerPausedPauses or resumes a timer. The remaining time is kept.
sleepPauses an async task for the given time. Meanwhile other scripts, the server and the game run normally. sleep(0) waits until the next server frame (the same as setTimer with interval 0).
waitForEventPauses an async task until an event happens. Returns the event's source element and its arguments. With a time limit it returns false if the event did not happen in time. The handler and the limit timer are removed when the wait ends.