mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-17 23:34:51 +00:00
Code Issues Releases Wiki Activity
03f9e6bd6d
CC-Tweaked/doc/events/alarm.md
Jonathan Coates 52b78f92cd
Use standard Markdown link syntax for references 
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
2023-08-24 11:23:33 +01:00

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