2021-01-19 09:20:52 +00:00
|
|
|
---
|
|
|
|
|
module: [kind=event] alarm
|
|
|
|
|
see: os.setAlarm To start an alarm.
|
|
|
|
|
---
|
|
|
|
|
|
2023-01-16 22:53:58 +00:00
|
|
|
The @{alarm} event is fired when an alarm started with @{os.setAlarm} completes.
|
2021-01-19 09:20:52 +00:00
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
|
|
2021-01-19 09:20:52 +00:00
|
|
|
```lua
|
2023-01-16 22:53:58 +00:00
|
|
|
local alarm_id = os.setAlarm(os.time() + 0.05)
|
2021-01-19 09:20:52 +00:00
|
|
|
local event, id
|
|
|
|
|
repeat
|
|
|
|
|
event, id = os.pullEvent("alarm")
|
2023-01-16 22:53:58 +00:00
|
|
|
until id == alarm_id
|
2021-01-19 09:20:52 +00:00
|
|
|
print("Alarm with ID " .. id .. " was fired")
|
|
|
|
|
```
|
