1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-15 20:50:29 +00:00
CC-Tweaked/doc/events/alarm.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

29 lines
607 B
Markdown
Raw Normal View History

---
module: [kind=event] alarm
see: os.setAlarm To start an alarm.
---
<!--
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
SPDX-License-Identifier: LicenseRef-CCPL
-->
2023-01-16 22:53:58 +00:00
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
2023-01-16 22:53:58 +00:00
Starts a timer and then waits for it to complete.
```lua
2023-01-16 22:53:58 +00:00
local alarm_id = os.setAlarm(os.time() + 0.05)
local event, id
repeat
event, id = os.pullEvent("alarm")
2023-01-16 22:53:58 +00:00
until id == alarm_id
print("Alarm with ID " .. id .. " was fired")
```