window

The Window API allows easy definition of spaces within the display that can be written/drawn to, then later redrawn/repositioned/etc as need be. The API itself contains only one function, window.create, which returns the windows themselves.

Windows are considered terminal objects - as such, they have access to nearly all the commands in the term API (plus a few extras of their own, listed within said API) and are valid targets to redirect to.

Each window has a "parent" terminal object, which can be the computer's own display, a monitor, another window or even other, user-defined terminal objects. Whenever a window is rendered to, the actual screen-writing is performed via that parent (or, if that has one too, then that parent, and so forth). Bear in mind that the cursor of a window's parent will hence be moved around etc when writing a given child window.

Windows retain a memory of everything rendered "through" them (hence acting as display buffers), and if the parent's display is wiped, the window's content can be easily redrawn later. A window may also be flagged as invisible, preventing any changes to it from being rendered until it's flagged as visible once more.

A parent terminal object may have multiple children assigned to it, and windows may overlap. For example, the Multishell system functions by assigning each tab a window covering the screen, each using the starting terminal display as its parent, and only one of which is visible at a time.

create(parent, nX, nY, nWidth, nHeight[, bStartVisible])Returns a terminal object that is a space within the specified parent terminal object.
create(parent, nX, nY, nWidth, nHeight[, bStartVisible])Source

Returns a terminal object that is a space within the specified parent terminal object. This can then be used (or even redirected to) in the same manner as eg a wrapped monitor. Refer to the term API for a list of functions available to it.

term itself may not be passed as the parent, though term.native is acceptable. Generally, term.current or a wrapped monitor will be most suitable, though windows may even have other windows assigned as their parents.

Parameters

  1. parent term.Redirect The parent terminal redirect to draw to.
  2. nX number The x coordinate this window is drawn at in the parent terminal
  3. nY number The y coordinate this window is drawn at in the parent terminal
  4. nWidth number The width of this window
  5. nHeight number The height of this window
  6. bStartVisible? boolean Whether this window is visible by default. Defaults to true.

Returns

  1. Window The constructed window

Types

Window

The window object. Refer to the module's documentation for a full description.

See also

Window.write(sText)Source

Parameters

  1. sText
Window.blit(sText, sTextColor, sBackgroundColor)Source

Parameters

  1. sText
  2. sTextColor
  3. sBackgroundColor
Window.clear()Source
Window.clearLine()Source
Window.getCursorPos()Source
Window.setCursorPos(x, y)Source

Parameters

  1. x
  2. y
Window.setCursorBlink(blink)Source

Parameters

  1. blink
Window.getCursorBlink()Source
Window.isColor()Source
Window.isColour()Source
Window.setTextColor(color)Source

Parameters

  1. color
Window.setTextColour(color)Source

Parameters

  1. color
Window.setPaletteColour(colour, r, g, b)Source

Parameters

  1. colour
  2. r
  3. g
  4. b
Window.setPaletteColor(colour, r, g, b)Source

Parameters

  1. colour
  2. r
  3. g
  4. b
Window.getPaletteColour(colour)Source

Parameters

  1. colour
Window.getPaletteColor(colour)Source

Parameters

  1. colour
Window.setBackgroundColor(color)Source

Parameters

  1. color
Window.setBackgroundColour(color)Source

Parameters

  1. color
Window.getSize()Source
Window.scroll(n)Source

Parameters

  1. n
Window.getTextColor()Source
Window.getTextColour()Source
Window.getBackgroundColor()Source
Window.getBackgroundColour()Source
Window.getLine(y)Source

Get the buffered contents of a line in this window.

Parameters

  1. y number The y position of the line to get.

Returns

  1. string The textual content of this line.
  2. string The text colours of this line, suitable for use with term.blit.
  3. string The background colours of this line, suitable for use with term.blit.

Throws

  • If y is not between 1 and this window's height.

Window.setVisible(visible)Source

Set whether this window is visible. Invisible windows will not be drawn to the screen until they are made visible again.

Making an invisible window visible will immediately draw it.

Parameters

  1. visible boolean Whether this window is visible.
Window.redraw()Source

Draw this window. This does nothing if the window is not visible.

See also

Window.restoreCursor()Source

Set the current terminal's cursor to where this window's cursor is. This does nothing if the window is not visible.

Window.getPosition()Source

Get the position of the top left corner of this window.

Returns

  1. number The x position of this window.
  2. number The y position of this window.
Window.reposition(new_x, new_y[, new_width, new_height[, new_parent]])Source

Reposition or resize the given window.

This function also accepts arguments to change the size of this window. It is recommended that you fire a term_resize event after changing a window's, to allow programs to adjust their sizing.

Parameters

  1. new_x number The new x position of this window.
  2. new_y number The new y position of this window.
  3. new_width? number The new width of this window.
  4. new_height number The new height of this window.
  5. new_parent? term.Redirect The new redirect object this window should draw to.