createTimer - Revision history

TheyCallMeTim13 at 13:12, 19 March 2017

2017-03-19T13:12:40Z

TheyCallMeTim13: /* Function Parameters */

2017-03-11T05:20:07Z

‎Function Parameters

TheyCallMeTim13 at 05:18, 11 March 2017

2017-03-11T05:18:39Z

TheyCallMeTim13: Created page with ''''function''' createTimer(''Owner'' OPTIONAL, ''Enabled'' OPTIONAL) ''':''' Timer Returns a newly created timer object. If enabled is not given it will be enabled by defau…'

2017-03-11T05:18:15Z

Created page with ''''function''' createTimer(''Owner'' OPTIONAL, ''Enabled'' OPTIONAL) ''':''' Timer Returns a newly created timer object. If enabled is not given it will be enabled by defau…'

New page

'''function''' createTimer(''Owner'' OPTIONAL, ''Enabled'' OPTIONAL) ''':''' [[Timer]]

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).

===Function Parameters===
{|width="85%" cellpadding="10%" cellpadding="5%" cellspacing="0" border="0"
!align="left"|Parameter
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|Owner
|[[Control]] or [[Component]] based object
|The owner of the timer (used for resource clean up)
|-
|Enabled
|boolean
|The [[Timer]]s enable state, set to false to disable [[Timer]] on creation.
|}

== 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

== See also ==
* [[Lua]]
* [[Help_File:Script engine|Script engine]]

=== Related Classes ===
* [[Timer]]
* [[Component]]

← Older revision		Revision as of 13:12, 19 March 2017
Line 1:		Line 1:
		+	[[Category:Lua]]
	'''function''' createTimer(''Owner'' OPTIONAL, ''Enabled'' OPTIONAL) ''':''' [[Timer]]		'''function''' createTimer(''Owner'' OPTIONAL, ''Enabled'' OPTIONAL) ''':''' [[Timer]]

@@ Line 23: / Line 23: @@
 |Enabled
 |boolean
-|The [[Timer]]s enable state, set to false to disable [[Timer]] on creation.
+|The timer's enable state, set to false to disable timer on creation.
 |}

@@ Line 9: / Line 9: @@
 Tip: use [[getMainForm]] for the owner of any timer so that it is destroyed when the main form is destroyed (closed).
+ createTimer(getMainForm())
 ===Function Parameters===