mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-10-05 18:30:47 +00:00
895bc7721a
This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/
28 lines
583 B
Markdown
28 lines
583 B
Markdown
---
|
|
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
|
|
Start and wait for a timer to finish.
|
|
```lua
|
|
local timer_id = os.startTimer(2)
|
|
local event, id
|
|
repeat
|
|
event, id = os.pullEvent("timer")
|
|
until id == timer_id
|
|
print("Timer with ID " .. id .. " was fired")
|
|
```
|