mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-11-19 08:14:52 +00:00
52b78f92cd
References are now written using normal links: You now use [`print`] or
[print a string][`print`]) instead of @{print} or @{print|print a
string}.
35 lines
850 B
Markdown
35 lines
850 B
Markdown
---
|
|
module: [kind=event] terminate
|
|
---
|
|
|
|
<!--
|
|
SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: MPL-2.0
|
|
-->
|
|
|
|
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
|
|
```
|