mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-12-06 14:28:05 +00:00
Code Issues Releases Wiki Activity

Some event typo fixes

Browse Source
This commit is contained in:
Jonathan Coates
2023-01-16 22:53:58 +00:00
parent f43b839056
commit 2014e9527e
12 changed files with 30 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/events/alarm.md
View File

@@ -3,19 +3,20 @@ module: [kind=event] alarm
see: os.setAlarm To start an alarm.
---
The @{timer} event is fired when an alarm started with @{os.setAlarm} completes.
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 prints its ID:
Starts a timer and then waits for it to complete.
```lua
local alarmID = os.setAlarm(os.time() + 0.05)
local alarm_id = os.setAlarm(os.time() + 0.05)
local event, id
repeat
event, id = os.pullEvent("alarm")
until id == alarmID
until id == alarm_id
print("Alarm with ID " .. id .. " was fired")
```