GitHub/Basalt
1
0
Fork 0
Code Issues 28 Pull Requests 3 Actions Packages Projects Releases 9 Wiki Activity
Files
bb1b1beb795e3cf06a84ca79408244bca715961e
Basalt/docs/docs1_6/objects/Timer.md
Robert Jelic bb1b1beb79 Basalt 1.7 Update 
- New Objects (Flexbox, Graph, Treeview)
- Pluginsystem to add/remove functionality
- Reworked the entire Object system, instead of one big Object Class we have multiple classes: Object, VisualObject, ChangeableObject
- Instead of one big Frame Class we have multiple Frame Classes: BaseFrame, Frame, MovableFrame, ScrollableFrame, MonitorFrame, Flexbox
- Removed the Animation Object, and added a animation plugin instead
- Removed the Graphic Object and merged it's functionality with the image object
- Updated currently existing objects
2023-04-30 17:05:34 +02:00

1.5 KiB
Raw Blame History

Timers can call your functions delay and repeat it as often as you wish

setTime

sets the time the timer should wait after calling your function

Parameters:

  1. number the time to delay
  2. number how often it should be repeated -1 is infinite

Returns:

  1. object The object
local mainFrame = basalt.createFrame()
local aTimer = mainFrame:addTimer()
aTimer:setTime(2)

<timer time="2" repeat="1"/>

start

Starts the timer

Returns:

  1. object The object
local mainFrame = basalt.createFrame()
local aTimer = mainFrame:addTimer()
aTimer:setTime(2):start()

<timer time="2" start="true"/>

cancel

Cancels the timer

Returns:

  1. object The object
local mainFrame = basalt.createFrame()
local aTimer = mainFrame:addTimer()
aTimer:setTime(2):start()
aTimer:cancel()

Events

onCall

onCall(self)
A custom event which gets triggered as soon as the current timer has finished

Here is a example on how to add a onCall event to your timer:

local basalt = require("Basalt")

local mainFrame = basalt.createFrame()
local aTimer = mainFrame:addTimer()

function call()
  basalt.debug("The timer has finished!")
end
aTimer:onCall(call)

Here is also a example how this is done with xml:

local basalt = require("Basalt")

local mainFrame = basalt.createFrame()

basalt.setVariable("call", function()
  basalt.debug("The timer has finished!")
end)

<progressbar onDone="call" />