mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-09-05 12:12:35 +00:00
8a203e7454
- 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.
29 lines
599 B
Markdown
29 lines
599 B
Markdown
---
|
|
module: [kind=event] alarm
|
|
see: os.setAlarm To start an alarm.
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: MPL-2.0
|
|
-->
|
|
|
|
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.
|
|
|
|
```lua
|
|
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")
|
|
```
|