mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-09-19 10:49:44 +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/
35 lines
850 B
Markdown
35 lines
850 B
Markdown
---
|
|
module: [kind=event] terminate
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: LicenseRef-CCPL
|
|
-->
|
|
|
|
The @{terminate} event is fired when <kbd>Ctrl-T</kbd> is held down.
|
|
|
|
This event is normally handled by @{os.pullEvent}, and will not be returned. However, @{os.pullEventRaw} will return this event when fired.
|
|
|
|
@{terminate} will be sent even when a filter is provided to @{os.pullEventRaw}. When using @{os.pullEventRaw} with a filter, make sure to check that the event is not @{terminate}.
|
|
|
|
## Return values
|
|
1. @{string}: The event name.
|
|
|
|
## Example
|
|
Prints a message when Ctrl-T is held:
|
|
```lua
|
|
while true do
|
|
local event = os.pullEventRaw("terminate")
|
|
if event == "terminate" then print("Terminate requested!") end
|
|
end
|
|
```
|
|
|
|
Exits when Ctrl-T is held:
|
|
```lua
|
|
while true do
|
|
os.pullEvent()
|
|
end
|
|
```
|