timer

timer allows you to schedule code to run at a future time or at an interval.

Installation

Learn more about installation.

wally

[dependencies]
timer = "lukadev-0/timer@1.0.1"

pesde

pesde add lukadev_0/timer@1.0.1

Functions

timer.delay

function timer.delay(duration: number): Future<number>

Returns a future that resolves after the given duration in seconds, returning the amount of time it took to resolve.

This is equivalent to the following code:

local fut = Future.spawn(task.wait, duration)

timer.interval

function timer.interval(duration: number, callback: function): () -> ()

Calls the given callback every duration seconds.

This will correct for drift, it repeatedly calls task.wait and calculates the amount of time until the next call.

Returns a function that will stop the interval when called.