Difference between revisions of "Alarm (event)"

From ComputerCraft Wiki
Jump to: navigation, search
(Added example)
m (Removed needs work box)
Line 1: Line 1:
−
{{NeedsWork|A demonstration on the use and handling of this event would be beneficial. ''[[User:AfterLifeLochie|AfterLifeLochie]] 16:13, 30 November 2012 (MSK)''}}
 
−
 
 
{{Event
 
{{Event
 
|name=alarm
 
|name=alarm

Revision as of 02:05, 13 April 2013



Grid Modem.png  Event alarm
Fired when an alarm has expired.
Returned Object 1 The alarm's numerical representation value (returned when os.setAlarm() is initially called).

Examples

Grid paper.png  Example
Sets the alarm for 1 (in-game) hour, then waits for the event to fire
Code 
local alarm = os.setAlarm(os.time()+01.00) -- Sets the Alarm for 1 hour after the current time
while true do
 local  _, id = os.pullEvent("alarm") -- Waits for the alarm event
  if id == alarm then -- Checks to see if it's the alarm we created
    print("The alarm has gone off!")
    break -- Get out of the loop
  end
end
Retrieved from "https://www.computercraft.info/wiki/index.php?title=Alarm_(event)&oldid=5347"