Files
Basalt/docs/objects/Timer.md
2022-06-09 11:43:59 -04:00

1.3 KiB

With timers you can call delayed functions.
Here is a list of all available functions for timers:

setTime

sets the time the timer should wait after calling your function

local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTimer = mainFrame:addTimer("myFirstTimer")
aTimer:setTime(5)

Parameters:number time[, number repeats] - (time in seconds, if repeats is -1 it will call the function infinitly (every x seconds)

Returns: self

start

starts the timer

local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTimer = mainFrame:addTimer("myFirstTimer")
aTimer:setTime(5):start()

Parameters: -

Returns: self

cancel

stops/cancels the timer

local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTimer = mainFrame:addTimer("myFirstTimer")
aTimer:setTime(5):start()
aTimer:cancel()

Parameters: -

Returns: self

onCall

adds a function to the timer

local function timerCall(self)
    basalt.debug("i got called!")
end
local mainFrame = basalt.createFrame("myFirstFrame"):show()
local aTimer = mainFrame:addTimer("myFirstTimer")
aTimer:setTime(5):onCall(timerCall):start()

Parameters: function func

Returns: self