1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-15 20:50:29 +00:00
CC-Tweaked/doc/events/term_resize.md
Jonathan Coates 895bc7721a
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

890 B

module: [kind=event] term_resize

The @{term_resize} event is fired when the main terminal is resized. For instance:

  • When a the tab bar is shown or hidden in @{multishell}.
  • When the terminal is redirected to a monitor via the "monitor" program and the monitor is resized.

When this event fires, some parts of the terminal may have been moved or deleted. Simple terminal programs (those not using @{term.setCursorPos}) can ignore this event, but more complex GUI programs should redraw the entire screen.

Return values

  1. @{string}: The event name.

Example

Print a message each time the terminal is resized.

while true do
  os.pullEvent("term_resize")
  local w, h = term.getSize()
  print("The term was resized to (" .. w .. ", " .. h .. ")")
end