timer.start - Revision history

Adriweb at 17:45, 7 January 2012

2012-01-07T17:45:16Z

Adriweb: /* Example */

2012-01-07T17:39:47Z

Example

Adriweb at 17:36, 7 January 2012

2012-01-07T17:36:39Z

Levak: /* Syntax */

2011-06-22T16:24:32Z

Syntax

Adriweb: Text replace - " ||" to " ||"

2011-05-30T22:41:59Z

Text replace - " ||" to "</center> ||"

Adriweb: Text replace - "| " to "| "

2011-05-30T22:41:14Z

Text replace - "| " to "| <center>"

Adriweb at 11:30, 25 May 2011

2011-05-25T11:30:16Z

Adriweb at 11:29, 25 May 2011

2011-05-25T11:29:10Z

Adriweb: Created page with "timer.'''start''' is a function that is part of the timer functions. Starts the timer with the given period in seconds.
If the timer is already running..."

2011-05-25T11:27:46Z

Created page with "timer.'''start''' is a function that is part of the timer functions. Starts the timer with the given period in seconds. If the timer is already running..."

New page

timer.'''start''' is a function that is part of the [[:Category:timer|timer]] functions.

Starts the timer with the given period in seconds. 
If the timer is already running when this routine is called, the timer is reset to the new period.
 

 

{{Since|3.0}}

== Syntax ==
timer.'''start'''(period) 

{| class="wikitable"
|-
! Parameter !! Type !! Description
|-
| period || number || the time period
|-
|}

== See also ==
*[[timer.stop]]

 
[[Category:timer]]

@@ Line 1: / Line 1: @@
 timer.'''start''' is a function that is part of the [[:Category:timer|timer]] functions.
-Starts the timer with the given period in seconds.<br />
+This fucntion starts the timer with the given period in seconds.<br />
 If the timer is already running when this routine is called, the timer is reset to the new period.
 <br />

@@ Line 22: / Line 22: @@
 == Example ==
 <source>
 variable = 0
 function on.timer()
-    timer.stop()
+    timer.stop()  -- stops the current timer. Not necessary.
     variable = variable + 1
-    platform.window:invalidate()
+    platform.window:invalidate()  -- screen refresh (on.paint is called)
 end
 function on.paint(gc)
-    timer.start(0.5)
+    timer.start(0.5)  -- will fire the on.timer event every half second.
-    gc:drawString(variable,0,0,"top")
+    gc:drawString(variable,0,0,"top")  -- display the number
 end</source>

@@ Line 22: / Line 22: @@
 == Example ==
-<source>timer.start(0.5)</source>
+<source>
 == See also ==

@@ Line 17: / Line 17: @@
 ! Parameter !! Type !! Description
 |-
-| <u><center>period</center></u> || number || the time period for the timer to start. Must be > 0.05
+| <u><center>period</center></u> || number || the time period in seconds for the timer to start. Must be > 0.01
 |-
 |}

@@ Line 3: / Line 3: @@
 Starts the timer with the given period in seconds.<br />
 If the timer is already running when this routine is called, the timer is reset to the new period.
-<br />
 <br />
@@ Line 25: / Line 26: @@
 == See also ==
 *[[timer.stop]]
 <br />
 [[Category:timer]]