mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-07-20 02:34:25 +00:00
52b78f92cd
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
29 lines
603 B
Markdown
29 lines
603 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")
|
|
```
|