Window (API) - Revision history

MKlegoman357: Recreated table using {{API table}} tag

2014-04-09T19:21:45Z

Recreated table using {{API table}} tag

Bomb Bloke at 15:14, 9 April 2014

2014-04-09T15:14:47Z

MKlegoman357: Added {{NeedsWork}} tag

2014-04-06T09:22:43Z

Added {{NeedsWork}} tag

Bomb Bloke at 07:53, 6 April 2014

2014-04-06T07:53:19Z

Oeed: Created window API page.

2014-03-28T05:59:47Z

Created window API page.

New page

{{NeedsWork|This page should be created ASAP. - [[User:Oeed|Oeed]] 05:59, 28 March 2014 (GMT)}}

@@ Line 1: / Line 1: @@
 Added by ComputerCraft 1.6, the '''Window API''' allows easy definition of spaces within the display that can be written / drawn to, then later [[window.redraw|redrawn]] / [[window.reposition|repositioned]] / etc as need be. The API itself contains only one function, [[window.create|window.create()]], which returns the windows themselves.
@@ Line 8: / Line 9: @@
 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.
 ==API==
-{| class="wikitable" width="100%"
-! width="100px" | Returns
+{{API table|window|image=Grid disk.png|2=
-! width="200px" | Method name
-! Description
+{{API table/row
-|-
-|{{type|table}} window object
 |[[window.create]]({{type|table}} parentTerm, {{type|number}} x, {{type|number}} y, {{type|number}} width, {{type|number}} height [<nowiki/>, {{type|boolean}} visible])
 |Creates and returns a new window object, similar to a [[peripheral.wrap|wrapped]] [[monitor]]. Refer to the [[term (API)|term API]] for a list of functions attached to it.
-|}
+|odd}}
 [[Category:APIs]]

← Older revision		Revision as of 15:14, 9 April 2014
Line 1:		Line 1:
−	~~{{NeedsWork~~\|~~This page needs more explanation and examples~~. [[~~User:MKlegoman357~~\|~~MKlegoman357~~]] ~~09:22~~, ~~6 April 2014~~ (~~GMT~~)}}	+	Added by ComputerCraft 1.6, the '''Window API''' allows easy definition of spaces within the display that can be written / drawn to, then later [[window.redraw\|redrawn]] / [[window.reposition\|repositioned]] / etc as need be. The API itself contains only one function, [[window.create\|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)\|term API]] (plus a few extras of their own, listed within said API) and are valid targets to [[term.redirect\|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 [[window.redraw\|redrawn]] later. A window may also be flagged as [[window.setVisible\|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.

−	~~Added by ComputerCraft 1.6, the '''Window API''' allows easy definition of spaces within the display that can be written / drawn to, then repositioned or hidden (along with their contents).~~

	==API==		==API==

← Older revision		Revision as of 09:22, 6 April 2014
Line 1:		Line 1:
		+	{{NeedsWork\|This page needs more explanation and examples. [[User:MKlegoman357\|MKlegoman357]] 09:22, 6 April 2014 (GMT)}}
		+
	Added by ComputerCraft 1.6, the '''Window API''' allows easy definition of spaces within the display that can be written / drawn to, then repositioned or hidden (along with their contents).		Added by ComputerCraft 1.6, the '''Window API''' allows easy definition of spaces within the display that can be written / drawn to, then repositioned or hidden (along with their contents).

← Older revision		Revision as of 07:53, 6 April 2014
Line 1:		Line 1:
−	{{~~NeedsWork~~\|~~This page should be created ASAP~~. - [[~~User:Oeed~~\|~~Oeed~~]] ~~05:59, 28 March 2014~~ (~~GMT~~)}}	+	Added by ComputerCraft 1.6, the '''Window API''' allows easy definition of spaces within the display that can be written / drawn to, then repositioned or hidden (along with their contents).
		+
		+	==API==
		+	{\| class="wikitable" width="100%"
		+	! width="100px" \| Returns
		+	! width="200px" \| Method name
		+	! Description
		+	\|-
		+	\|{{type\|table}} window object
		+	\|[[window.create]]({{type\|table}} parentTerm, {{type\|number}} x, {{type\|number}} y, {{type\|number}} width, {{type\|number}} height [<nowiki/>, {{type\|boolean}} visible])
		+	\|Creates and returns a new window object, similar to a [[peripheral.wrap\|wrapped]] [[monitor]]. Refer to the [[term (API)\|term API]] for a list of functions attached to it.
		+	\|}
		+
		+	[[Category:APIs]]