os.setAlarm

From ComputerCraft Wiki
Jump to: navigation, search


Grid Redstone.png  Function os.setAlarm
Adds an alarm which will fire an "alarm" event at the specified Minecraft world time. The returned table acts as a unique ID for the alarm.
Syntax os.setAlarm(number time)
Returns table alarmID
Part of ComputerCraft
API OS

Examples

Grid paper.png  Example
The basic usage of os.setAlarm From a forum Post by jag_e_nummer_ett.
Code
--(( Basic format ))--
os.setAlarm(time)
--(( Will timeout when it's 18 o'clock in the world ))--
os.setAlarm(18.00)
--(( Will timeout 2 (in-game) hours later ))--
os.setAlarm(os.time()+2)
--(( Basic event layout ))--
local ev,p1 = os.pullEvent("alarm")
--(( Event output ))--
Name: alarm
Parameter 1: A table that acts like it's unique ID



Grid paper.png  Example
Waits until 5 in the morning and prints a message. From a forum Post by MysticT.
Code
local alarm = os.setAlarm(5)
while true do
    local evt, arg = os.pullEvent("alarm")
    if arg == alarm then
        print("It's 5:00, wake up!")
    end
end