Alarm (event)

From ComputerCraft Wiki
Revision as of 02:04, 13 April 2013 by 1lann (Talk | contribs) (Added example)

Jump to: navigation, search
This page needs some serious TLC, stat!
Please help us by cleaning it, fixing it up, or sparing it some love.
(Reason: A demonstration on the use and handling of this event would be beneficial. AfterLifeLochie 16:13, 30 November 2012 (MSK))



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