mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-14 12:10:30 +00:00
Code Issues Releases Wiki Activity
4accda6b8e
CC-Tweaked/doc/events/alarm.md
Jonathan Coates 8a203e7454
Re-license several more files under MPL-2.0 
- Several files where @MCJack123 is the exclusive contributor. He has
   signed over all contributions to "any OSI-approved license". Thank
   you!

 - Various the file handle classes: Looking at these again, I don't
   think they contain any of the original code.
2023-03-28 10:28:59 +01:00

599 B
Raw Blame History

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

The @{alarm} 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 waits for it to complete.

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