mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-11-01 22:22:59 +00:00
Code Issues Releases Wiki Activity
Files
dd48c65a6f11c06fac415ebad38475447bed755a
CC-Tweaked/doc/events/alarm.md
Toad-Dev 43101773bb Revert "Remove CC: Tweaked doc files." 
Never mind, we needed them for linting the lua doc :)
2022-01-04 18:08:40 -08: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")