Difference between revisions of "Lua:Class:Timer"
Jump to navigation
Jump to search
(→Related Classes) |
|||
| Line 1: | Line 1: | ||
[[Category:Lua]] | [[Category:Lua]] | ||
| − | Timer '''class''': ('''Inheritance''': ''[[Component]]''->''[[Object]]'') | + | Timer '''class''': ('''Inheritance''': ''[[Lua:Class:Component|Component]]''->''[[Lua:Class:Object|Object]]'') |
The timer class is an non visual component that when active triggers an onTimer event every tick. (base on Interval property) | The timer class is an non visual component that when active triggers an onTimer event every tick. (base on Interval property) | ||
== Creation == | == Creation == | ||
| − | ; [[createTimer]](''owner'' OPTIONAL, ''enabled'' OPTIONAL) | + | ; [[Lua:createTimer|createTimer]](''owner'' OPTIONAL, ''enabled'' OPTIONAL) |
: Returns a newly created timer object. | : Returns a newly created timer object. | ||
: If enabled is not given it will be enabled by default (will start as soon as an onTimer event has been assigned) | : 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 instead of being the responsibility of the owner object) | : Owner may be nil, but you will be responsible for destroying it instead of being the responsibility of the owner object) | ||
| − | Tip: use [[getMainForm]] for the owner of any timer so that it is destroyed when the main form is destroyed (closed). | + | Tip: use [[Lua:getMainForm|getMainForm]] for the owner of any timer so that it is destroyed when the main form is destroyed (closed). |
createTimer(getMainForm()) | createTimer(getMainForm()) | ||
Revision as of 02:14, 25 January 2018
Timer class: (Inheritance: Component->Object)
The timer class is an non visual component that when active triggers an onTimer event every tick. (base on Interval property)
Contents
Creation
- createTimer(owner OPTIONAL, enabled OPTIONAL)
- Returns a newly created 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 instead of being the responsibility of the owner object)
Tip: use getMainForm for the owner of any timer so that it is destroyed when the main form is destroyed (closed).
createTimer(getMainForm())
Properties
- Interval : integer
- The number of milliseconds (1000 = 1 second) between ticks (executions).
- Enabled : boolean
- The enable state of the Timer.
- OnTimer : function(timer)
- The function to call when the timer triggers (tick).
Methods
- getInterval() : integer
- Returns the speed on how often the timer will trigger. In milliseconds (1000 = 1 second).
- setInterval(interval)
- Sets the speed on how often the timer should trigger. In milliseconds (1000 = 1 second).
- getOnTimer() : function(timer)
- Returns the 'OnTimer' event.
- setOnTimer(function(timer))
- Sets the 'OnTimer' event.
- getEnabled() : boolean
- Returns the enable state of the Timer.
- setEnabled(state)
- Sets the enable state of the Timer.
Examples
local timer = createTimer(getMainForm())
timer.Interval = 100
timer.OnTimer = function(timer)
-- code setting done state.
if DoneState == true then
timer.destroy()
end
end
local mainForm = getMainForm()
local function timer_tick(timer)
-- code setting done state.
if DoneState == true then
timer.destroy()
end
end
local someTimer = createTimer(mainForm, false)
someTimer.Interval = 100
someTimer.OnTimer = timer_tick
someTimer.Enabled = true
