Difference between revisions of "Alarm (event)"
From ComputerCraft Wiki
m (Removed needs work box) |
MKlegoman357 (Talk | contribs) m (Fixed the example (hopefully)) |
||
| (One intermediate revision by one other user not shown) | |||
| Line 1: | Line 1: | ||
| + | {{lowercase}} | ||
{{Event | {{Event | ||
|name=alarm | |name=alarm | ||
|desc=Fired when an alarm has expired. | |desc=Fired when an alarm has expired. | ||
| − | |return1=The alarm's numerical representation value (returned when [[os.setAlarm | + | |return1=The alarm's numerical representation value (returned when [[os.setAlarm]]() is initially called). |
|examples= | |examples= | ||
{{Example | {{Example | ||
| − | |desc=Sets the alarm | + | |desc=Sets the alarm at 7.00 (in-game) hour, then waits for the event to fire. |
| − | |code=local | + | |code= local alarmID = [[os.setAlarm]](7) -- Sets the Alarm at 7.00 |
| + | |||
| + | while true do | ||
| + | local event, id = '''[[os.pullEvent]]("alarm")''' -- Waits for the alarm event | ||
| + | |||
| + | if id == alarmID 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 | ||
}} | }} | ||
}} | }} | ||
Latest revision as of 16:36, 10 April 2014
 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
 Example | |
| Sets the alarm at 7.00 (in-game) hour, then waits for the event to fire. | |
| Code |
local alarmID = os.setAlarm(7) -- Sets the Alarm at 7.00 while true do local event, id = os.pullEvent("alarm") -- Waits for the alarm event if id == alarmID 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 |
