Skip to main content

Timer

The Timer class allows for code to run periodically at specified intervals.

local timer = Timer.new(2)
timer.Tick:Connect(function()
	print("Tock")
end)
timer:Start()

Types​

CallbackFn​

</>
type CallbackFn = () → ()

Callback function.

TimeFn​

</>
type TimeFn = () → number

Time function.

Properties​

Interval​

</>
Timer.Interval: number

Interval at which the Tick event fires.

UpdateSignal​

</>
Timer.UpdateSignal: RBXScriptSignal | Signal

The signal which updates the timer internally.

TimeFunction​

</>
Timer.TimeFunction: TimeFn

The function which gets the current time.

AllowDrift​

</>
Timer.AllowDrift: boolean

Flag which indicates if the timer is allowed to drift. This is set to true by default. This flag must be set before calling Start or StartNow. This flag should only be set to false if it is necessary for drift to be eliminated.

Tick​

</>
Timer.Tick: RBXScriptSignal | Signal

The event which is fired every time the timer hits its interval.

Functions​

new​

</>
Timer.new(interval: number) → Timer

Creates a new timer.

Simple​

</>
Timer.Simple(
interval: number,
callback: CallbackFn,
startNow: boolean?,
updateSignal: RBXScriptSignal?,
timeFn: TimeFn?
) → RBXScriptConnection

Creates a simplified timer which just fires off a callback function at the given interval.

-- Basic:
Timer.Simple(1, function()
	print("Tick")
end)

-- Using other arguments:
Timer.Simple(1, function()
	print("Tick")
end, true, RunService.Heartbeat, os.clock)

Is​

</>
Timer.Is(obj: any) → boolean

Returns true if the given object is a Timer.

Start​

</>
Timer:Start() → ()

Starts the timer. Will do nothing if the timer is already running.

timer:Start()

StartNow​

</>
Timer:StartNow() → ()

Starts the timer and fires off the Tick event immediately. Will do nothing if the timer is already running. 

timer:StartNow()

Stop​

</>
Timer:Stop() → ()

Stops the timer. Will do nothing if the timer is already stopped.

timer:Stop()

IsRunning​

</>
Timer:IsRunning() → boolean

Returns true if the timer is currently running.

if timer:IsRunning() then
	-- Do something
end

Destroy​

</>
Timer:Destroy() → ()

Destroys the timer. This will also stop the timer.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new timer.",
            "params": [
                {
                    "name": "interval",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Timer"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 73,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "Simple",
            "desc": "Creates a simplified timer which just fires off a callback function at the given interval.\n\n```lua\n-- Basic:\nTimer.Simple(1, function()\n\tprint(\"Tick\")\nend)\n\n-- Using other arguments:\nTimer.Simple(1, function()\n\tprint(\"Tick\")\nend, true, RunService.Heartbeat, os.clock)\n```",
            "params": [
                {
                    "name": "interval",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "callback",
                    "desc": "",
                    "lua_type": "CallbackFn"
                },
                {
                    "name": "startNow",
                    "desc": "",
                    "lua_type": "boolean?"
                },
                {
                    "name": "updateSignal",
                    "desc": "",
                    "lua_type": "RBXScriptSignal?"
                },
                {
                    "name": "timeFn",
                    "desc": "",
                    "lua_type": "TimeFn?\n"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "RBXScriptConnection"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 103,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "Is",
            "desc": "Returns `true` if the given object is a Timer.",
            "params": [
                {
                    "name": "obj",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 128,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "Start",
            "desc": "Starts the timer. Will do nothing if the timer is already running.\n\n```lua\ntimer:Start()\n```",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 167,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "StartNow",
            "desc": "Starts the timer and fires off the Tick event immediately. Will do\nnothing if the timer is already running.\n\n```lua\ntimer:StartNow()\n```",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 186,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "Stop",
            "desc": "Stops the timer. Will do nothing if the timer is already stopped.\n\n```lua\ntimer:Stop()\n```",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 201,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "IsRunning",
            "desc": "Returns `true` if the timer is currently running.\n\n```lua\nif timer:IsRunning() then\n\t-- Do something\nend\n```",
            "params": [],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean\n"
                }
            ],
            "function_type": "method",
            "source": {
                "line": 218,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "Destroy",
            "desc": "Destroys the timer. This will also stop the timer.",
            "params": [],
            "returns": [],
            "function_type": "method",
            "source": {
                "line": 225,
                "path": "modules/timer/init.luau"
            }
        }
    ],
    "properties": [
        {
            "name": "Interval",
            "desc": "Interval at which the `Tick` event fires.",
            "lua_type": "number",
            "source": {
                "line": 44,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "UpdateSignal",
            "desc": "The signal which updates the timer internally.",
            "lua_type": "RBXScriptSignal | Signal",
            "source": {
                "line": 49,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "TimeFunction",
            "desc": "The function which gets the current time.",
            "lua_type": "TimeFn",
            "source": {
                "line": 54,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "AllowDrift",
            "desc": "Flag which indicates if the timer is allowed to drift. This\nis set to `true` by default. This flag must be set before\ncalling `Start` or `StartNow`. This flag should only be set\nto `false` if it is necessary for drift to be eliminated.",
            "lua_type": "boolean",
            "source": {
                "line": 62,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "Tick",
            "desc": "The event which is fired every time the timer hits its interval.",
            "lua_type": "RBXScriptSignal | Signal",
            "source": {
                "line": 67,
                "path": "modules/timer/init.luau"
            }
        }
    ],
    "types": [
        {
            "name": "CallbackFn",
            "desc": "Callback function.",
            "lua_type": "() -> ()",
            "source": {
                "line": 10,
                "path": "modules/timer/init.luau"
            }
        },
        {
            "name": "TimeFn",
            "desc": "Time function.",
            "lua_type": "() -> number",
            "source": {
                "line": 17,
                "path": "modules/timer/init.luau"
            }
        }
    ],
    "name": "Timer",
    "desc": "The Timer class allows for code to run periodically at specified intervals.\n\n```lua\nlocal timer = Timer.new(2)\ntimer.Tick:Connect(function()\n\tprint(\"Tock\")\nend)\ntimer:Start()\n```",
    "source": {
        "line": 36,
        "path": "modules/timer/init.luau"
    }
}