mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-15 04:30:29 +00:00
Code Issues Releases Wiki Activity
988219ffca
CC-Tweaked/doc/events/alarm.md
Jonathan Coates 895bc7721a
License CC:T according to the REUSE specification (#1351) 
This adds SPDX license headers to all source code files, following the
REUSE[1] specification. This does not include any asset files (such as
generated JSON files, or textures). While REUSE does support doing so
with ".license" files, for now we define these licences using the
.reuse/dep5 file.

[1]: https://reuse.software/
2023-03-15 21:52:13 +00:00

607 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")