Timer (event) - Revision history

Bomb Bloke: Page has an example, no longer needs a request for one.

2013-12-19T19:52:47Z

Page has an example, no longer needs a request for one.

TheOriginalBIT: Better explanation and coding practices for first code example. Added second example to deal with multiple timers.

2013-10-28T09:38:33Z

Better explanation and coding practices for first code example. Added second example to deal with multiple timers.

AfterLifeLochie: Not 'numerical representation', 'unique ID'. os.startTimer() returns an ID.

2013-07-08T00:12:57Z

Not 'numerical representation', 'unique ID'. os.startTimer() returns an ID.

SuicidalSTDz: May need more work

2013-03-29T12:40:34Z

May need more work

AfterLifeLochie: Created event page.

2012-11-30T12:11:54Z

Created event page.

New page

{{NeedsWork|A demonstration on the use and handling of this event would be beneficial. ''[[User:AfterLifeLochie|AfterLifeLochie]] 16:11, 30 November 2012 (MSK)''}}

{{Event
|name=timer
|desc=Fired when a timer completes.
|return1=The timer's numerical representation value (returned when [[os.startTimer|os.startTimer()]] is initially called).
}}

@@ Line 1: / Line 1: @@
 {{Event
 |name=timer
 |desc=Fired when a timer completes.
-|return1=The timer's unique ID value (returned when [[os.startTimer|os.startTimer()]] is called).
+|return1=The timer's unique ID value (returned when [[os.startTimer|os.startTimer()]], which triggers this event, is called).
 }}
 {{Example
-|desc=This code will loop and refresh every 1 second. If the event that occurred was a not a timer the loop will complete
+|desc=This code will loop and refresh every 1 second. If the event that occurred was a not a timer (eg a [[Key_%28event%29|key event]] from a keypress), the loop will complete.
 |code=while true do
     os.startTimer(1)
@@ Line 15: / Line 13: @@
     else
       print("You've beaten me!")
     end
   end
 }}
 {{Example
-|desc=This code will output different text depending on which timer has completed
+|desc=This code will output different text depending on which timer has completed.
 |code=local timerA = os.startTimer(1)
   local timerB = os.startTimer(2)

@@ Line 7: / Line 7: @@
 }}
 {{Example
-|desc=This code will continuously start an internal timer and fire an event. If the event is not the timer, then it will break the loop
+|desc=This code will loop and refresh every 1 second. If the event that occurred was a not a timer the loop will complete
-|code= while true do<br/>  os.startTimer(1)<br/>  event = os.pullEvent()<br/>  if event == "timer" then <br/>    print("Too slow!")<br/>  else<br/>    print("Darn, you beat me!")<br/>    break<br/>  end<br/>end
+|code=while true do
 }}

@@ Line 5: / Line 5: @@
 |desc=Fired when a timer completes.
 |return1=The timer's numerical representation value (returned when [[os.startTimer|os.startTimer()]] is initially called).
 }}