Difference between revisions of "Lua:Class:Timer"
Jump to navigation
Jump to search
m (Reverted edits by 211.13.46.219 (Talk) to last revision by Dark Byte) |
|||
Line 8: | Line 8: | ||
− | ''' | + | '''setInterval'''(interval) |
Sets the speed on how often the timer should trigger. In milliseconds (1000=1 second) | Sets the speed on how often the timer should trigger. In milliseconds (1000=1 second) | ||
− | ''' | + | '''getEnabled'''() |
Returns true if the timer is enabled otherwise false | Returns true if the timer is enabled otherwise false | ||
− | ''' | + | '''setEnabled'''(boolean) |
Lets you enable of disable the timer | Lets you enable of disable the timer | ||
− | ''' | + | '''onTimer'''(function) |
function (sender) | function (sender) | ||
Line 31: | Line 31: | ||
local t = createTimer(nil) -- it will create a Timer object and assign it to variable t. | local t = createTimer(nil) -- it will create a Timer object and assign it to variable t. | ||
− | + | t.onTimer=rep -- The function repeat will be called every 3 seconds. | |
− | + | t.Interval=3000 --Call repeat() every 3 seconds | |
− | + | t.Enabled=true -- Set timer to true. If false is passed as argument then it will disable timer object. |
Revision as of 23:20, 18 January 2017
Timer Class (Inheritance Component->object)
The timer class is an non visual component that when active triggers an onTimer event every few milliseconds, based on the given interval
createTimer(owner, enabled OPT)
Creates a timer object. If enabled is not given it will be enabled by default (will start as soon as an onTimer event has been assigned) Owner may be nil, but you will be responsible for destroying it
setInterval(interval)
Sets the speed on how often the timer should trigger. In milliseconds (1000=1 second)
getEnabled()
Returns true if the timer is enabled otherwise false
setEnabled(boolean)
Lets you enable of disable the timer
onTimer(function)
function (sender)
Example 1:
function rep() print "hello world" end local t = createTimer(nil) -- it will create a Timer object and assign it to variable t. t.onTimer=rep -- The function repeat will be called every 3 seconds. t.Interval=3000 --Call repeat() every 3 seconds t.Enabled=true -- Set timer to true. If false is passed as argument then it will disable timer object.