mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-13 05:19:59 +00:00
Code Issues Releases Wiki Activity
9cb7091ce7
CC-Tweaked/doc/events/alarm.md
JackMacWindows a934e42219
Finish the rest of the event documentation (#683)
2021-01-19 09:20:52 +00:00

485 B
Raw Blame History

module: [kind=event] alarm see: os.setAlarm To start an alarm.

The @{timer} event is fired when an alarm started with @{os.setAlarm} completes.

Return Values

  1. @{string}: The event name.
  2. @{number}: The ID of the alarm that finished.

Example

Starts a timer and then prints its ID:

local alarmID = os.setAlarm(os.time() + 0.05)
local event, id
repeat
    event, id = os.pullEvent("alarm")
until id == alarmID
print("Alarm with ID " .. id .. " was fired")