Changes

Jump to navigation Jump to search

timer.start

496 bytes added, 19:45, 7 January 2012
no edit summary
Line 1: Line 1:  
timer.'''start''' is a function that is part of the [[:Category:timer|timer]] functions.
 
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 />
 +
This means that the this function fires the [[on.timer]]() event (that you have to define with a function in your code) will be called every x seconds, according to the period given in the parameter.<br />
 
If the timer is already running when this routine is called, the timer is reset to the new period.
 
If the timer is already running when this routine is called, the timer is reset to the new period.
   −
This function fires the [[on.timer]]() event.
      
<br />
 
<br />
Line 22: Line 22:     
== Example ==
 
== Example ==
 +
 +
This example will display on the top-left corner of the screen a number going from 0 to infinity (it never stops), by adding 1 to ''variable'' every 0.5 seconds.
 +
 
<source>
 
<source>
 
variable = 0
 
variable = 0
    
function on.timer()
 
function on.timer()
   timer.stop()
+
   timer.stop() -- stops the current timer. Not necessary.
 
   variable = variable + 1
 
   variable = variable + 1
   platform.window:invalidate()
+
   platform.window:invalidate()  -- screen refresh (on.paint is called)
 
end
 
end
    
function on.paint(gc)
 
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>
 
end</source>
  

Navigation menu