mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-05 17:46:21 +00:00
Code Issues Releases Wiki Activity
95d3b646b2
CC-Tweaked/doc/events/terminate.md
Jonathan Coates 52b78f92cd
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 11:23:33 +01:00

850 B
Raw Blame History

module: [kind=event] terminate

The [terminate] event is fired when Ctrl-T 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:

while true do
  local event = os.pullEventRaw("terminate")
  if event == "terminate" then print("Terminate requested!") end
end

Exits when Ctrl-T is held:

while true do
  os.pullEvent()
end