CC-Tweaked/doc/events/alarm.md

---
module: [kind=event] alarm
see: os.setAlarm To start an alarm.
---

<!--
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers

SPDX-License-Identifier: MPL-2.0
-->

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 waits for it to complete.

```lua
local alarm_id = os.setAlarm(os.time() + 0.05)
local event, id
repeat
    event, id = os.pullEvent("alarm")
until id == alarm_id
print("Alarm with ID " .. id .. " was fired")
```
Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00			`---`
			`module: [kind=event] alarm`
			`see: os.setAlarm To start an alarm.`
			`---`

License CC:T according to the REUSE specification (#1351) 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/ 2023-03-15 21:52:13 +00:00			`<!--`
			`SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers`

Re-license several more files under MPL-2.0 - Several files where @MCJack123 is the exclusive contributor. He has signed over all contributions to "any OSI-approved license". Thank you! - Various the file handle classes: Looking at these again, I don't think they contain any of the original code. 2023-03-28 09:23:28 +00:00			`SPDX-License-Identifier: MPL-2.0`
License CC:T according to the REUSE specification (#1351) 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/ 2023-03-15 21:52:13 +00:00			`-->`

Use standard Markdown link syntax for references References are now written using normal links: You now use [`print`] or [print a string][`print`]) instead of @{print} or @{print\|print a string}. 2023-08-24 09:48:30 +00:00			The [`alarm`] event is fired when an alarm started with [`os.setAlarm`] completes.
Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00
			`## Return Values`
Use standard Markdown link syntax for references References are now written using normal links: You now use [`print`] or [print a string][`print`]) instead of @{print} or @{print\|print a string}. 2023-08-24 09:48:30 +00:00			1. [`string`]: The event name.
			2. [`number`]: The ID of the alarm that finished.
Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00
			`## Example`
Some event typo fixes 2023-01-16 22:53:58 +00:00			`Starts a timer and then waits for it to complete.`

Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00			```lua
Some event typo fixes 2023-01-16 22:53:58 +00:00			`local alarm_id = os.setAlarm(os.time() + 0.05)`
Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00			`local event, id`
			`repeat`
			`event, id = os.pullEvent("alarm")`
Some event typo fixes 2023-01-16 22:53:58 +00:00			`until id == alarm_id`
Finish the rest of the event documentation (#683) 2021-01-19 09:20:52 +00:00			`print("Alarm with ID " .. id .. " was fired")`
			```