1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-14 20:20:30 +00:00
CC-Tweaked/doc/events/timer.md

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

28 lines
583 B
Markdown
Raw Normal View History

---
module: [kind=event] timer
see: os.startTimer To start a timer.
---
<!--
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
SPDX-License-Identifier: LicenseRef-CCPL
-->
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.
```lua
2023-01-16 22:53:58 +00:00
local timer_id = os.startTimer(2)
local event, id
repeat
event, id = os.pullEvent("timer")
2023-01-16 22:53:58 +00:00
until id == timer_id
print("Timer with ID " .. id .. " was fired")
```