2021-01-19 09:20:52 +00:00
|
|
|
---
|
|
|
|
|
module: [kind=event] timer
|
|
|
|
|
see: os.startTimer To start a timer.
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
The @{timer} event is fired when a timer started with @{os.startTimer} completes.
|
|
|
|
|
|
|
|
|
|
## Return Values
|
|
|
|
|
1. @{string}: The event name.
|
|
|
|
|
2. @{number}: The ID of the timer that finished.
|
|
|
|
|
|
|
|
|
|
## Example
|
2023-01-16 22:53:58 +00:00
|
|
|
Start and wait for a timer to finish.
|
2021-01-19 09:20:52 +00:00
|
|
|
```lua
|
2023-01-16 22:53:58 +00:00
|
|
|
local timer_id = os.startTimer(2)
|
2021-01-19 09:20:52 +00:00
|
|
|
local event, id
|
|
|
|
|
repeat
|
|
|
|
|
event, id = os.pullEvent("timer")
|
2023-01-16 22:53:58 +00:00
|
|
|
until id == timer_id
|
2021-01-19 09:20:52 +00:00
|
|
|
print("Timer with ID " .. id .. " was fired")
|
|
|
|
|
```
|
