Term (API) - Revision history

MKlegoman357 at 12:27, 28 June 2015

2015-06-28T12:27:46Z

Bomb Bloke at 10:21, 28 June 2015

2015-06-28T10:21:01Z

Bomb Bloke at 14:43, 9 April 2014

2014-04-09T14:43:09Z

Bomb Bloke at 08:02, 6 April 2014

2014-04-06T08:02:23Z

Bomb Bloke at 08:01, 6 April 2014

2014-04-06T08:01:29Z

Bomb Bloke: Addition of Window-specific functions.

2014-04-06T07:56:41Z

Addition of Window-specific functions.

Bomb Bloke: Term.native

2014-04-04T05:42:15Z

Term.native

Oeed: Added link to term_resize page

2014-03-29T07:44:18Z

Added link to term_resize page

Oeed: Fixed incorrect term.redirect return value

2014-03-29T01:06:20Z

Fixed incorrect term.redirect return value

Oeed: Moved term.restore in to deprecated table, added term.current, added term_resize event

2014-03-28T08:05:09Z

Moved term.restore in to deprecated table, added term.current, added term_resize event

@@ Line 9: / Line 9: @@
 {{API table/row|[[term.blit]]({{type|string}} text, {{type|string}} text colors, {{type|string}} background colors)|{{type|nil}}
-|Writes ''text'' to the screen using the specified text and background colors.}}
+|Writes ''text'' to the screen using the specified text and background colors. ''Requires version 1.74 or newer.''}}
 {{API table/row|[[term.clear]]()|{{type|nil}}

@@ Line 6: / Line 6: @@
 {{API table/row|[[term.write]]({{type|string}} text)|{{type|nil}}
-|Writes ''text'' to the screen.|odd}}
+|Writes ''text'' to the screen, using the current [[term.setTextColor|text]] and [[term.setBackgroundColor|background colors]].|odd}}
 {{API table/row|[[term.clear]]()|{{type|nil}}
-|Clears the entire screen}}
+|Clears the entire screen.|odd}}
 {{API table/row|[[term.clearLine]]()|{{type|nil}}
-|Clears the line the cursor is on|odd}}
+|Clears the line the cursor is on.}}
 {{API table/row|[[term.getCursorPos]]()|{{type|number}} x, {{type|number}} y
-|Returns two arguments containing the x and the y position of the cursor.}}
+|Returns two arguments containing the x and the y position of the cursor.|odd}}
 {{API table/row|[[term.setCursorPos]]({{type|number}} x, {{type|number}} y)|{{type|nil}}
-|Sets the cursor's position.|odd}}
+|Sets the cursor's position.}}
 {{API table/row|[[term.setCursorBlink]]({{type|boolean}} bool)|{{type|nil}}
-|Disables the blinking or turns it on.}}
+|Disables the blinking or turns it on.|odd}}
 {{API table/row|[[term.isColor]]()|{{type|boolean}}
-|Returns whether the terminal supports color.|odd}}
+|Returns whether the terminal supports color.}}
 {{API table/row|[[term.getSize]]()|{{type|number}} x, {{type|number}} y
-|Returns two arguments containing the x and the y values stating the size of the screen. (Good for if you're making something to be compatible with both [[Turtle]]s and [[Computer]]s.)}}
+|Returns two arguments containing the x and the y values stating the size of the screen. (Good for if you're making something to be compatible with both [[Turtle]]s and [[Computer]]s.)|odd}}
 {{API table/row|[[term.scroll]]({{type|number}} n)|{{type|nil}}
-|Scrolls the terminal ''n'' lines.|odd}}
+|Scrolls the terminal ''n'' lines.}}
 {{API table/row|[[term.redirect]](target)|{{type|table}} previous terminal object
-|Redirects terminal output to another terminal object (such as a [[Window (API)|window]] or [[peripheral.wrap|wrapped]] [[monitor]]). ''Available only to the base term object.''}}
+|Redirects terminal output to another terminal object (such as a [[Window (API)|window]] or [[peripheral.wrap|wrapped]] [[monitor]]). ''Available only to the base term object.''|odd}}
 {{API table/row|[[term.current]]()|{{type|table}} terminal object
-|Returns the current terminal object. ''Requires version 1.6 or newer, available only to the base term object.''|odd}}
+|Returns the current terminal object. ''Requires version 1.6 or newer, available only to the base term object.''}}
 {{API table/row|[[term.native]]()|{{type|table}} terminal object
-|Returns the original terminal object. ''Requires version 1.6 or newer, available only to the base term object.''}}
+|Returns the original terminal object. ''Requires version 1.6 or newer, available only to the base term object.''|odd}}
 {{API table/row|[[term.setTextColor]]({{type|number}} [[Colors (API)|color]])|{{type|nil}}
-|Sets the text color of the terminal. ''Limited functionality without an Advanced [[Advanced Computer|Computer]] / [[Advanced Turtle|Turtle]] / [[Advanced Monitor|Monitor]].''|odd}}
+|Sets the text color of the terminal. ''Limited functionality without an Advanced [[Advanced Computer|Computer]] / [[Advanced Turtle|Turtle]] / [[Advanced Monitor|Monitor]].''}}
 {{API table/row|[[term.setBackgroundColor]]({{type|number}} [[Colors (API)#Colors|color]])|{{type|nil}}
 |Sets the background color of the terminal. ''Limited functionality without an Advanced [[Advanced Computer|Computer]] / [[Advanced Turtle|Turtle]] / [[Advanced Monitor|Monitor]].''}}
 {{API table/row|''[[monitor.setTextScale]]({{type|number}} scale)''|{{type|nil}}
-|Sets the text scale. ''Available only to [[Monitor#Monitor as a Peripheral|monitor]] objects.''|odd}}
+|Sets the text scale. ''Available only to [[Monitor#Monitor as a Peripheral|monitor]] objects.''}}
 {{API table/row|'''[[window.setVisible]]({{type|boolean}} visibility)'''|{{type|nil}}
-|Determines whether subsequent renders to the window will be visible. ''Available only to [[Window (API)|window]] objects.''|}}
+|Determines whether subsequent renders to the window will be visible. ''Available only to [[Window (API)|window]] objects.''|odd}}
 {{API table/row|'''[[window.redraw]]()'''|{{type|nil}}
-|Redraws the contents of the window. ''Available only to [[Window (API)|window]] objects.''|odd}}
+|Redraws the contents of the window. ''Available only to [[Window (API)|window]] objects.''}}
 {{API table/row|'''[[window.restoreCursor]]()'''|{{type|nil}}
-|Returns the cursor back to its position / state within the window. ''Available only to [[Window (API)|window]] objects.''|}}
+|Returns the cursor back to its position / state within the window. ''Available only to [[Window (API)|window]] objects.''|odd}}
 {{API table/row|'''[[window.getPosition]]()'''|{{type|number}} x, {{type|number}} y
-|Returns the top left co-ordinate of the window. ''Available only to [[Window (API)|window]] objects.''|odd}}
+|Returns the top left co-ordinate of the window. ''Available only to [[Window (API)|window]] objects.''}}
 {{API table/row|'''[[window.reposition]]({{type|number}} x, {{type|number}} y [<nowiki/>, {{type|number}} width, {{type|number}} height])'''|{{type|nil}}
-|Moves and / or resizes the window. ''Available only to [[Window (API)|window]] objects.''|}}
+|Moves and / or resizes the window. ''Available only to [[Window (API)|window]] objects.''|odd}}
 }}

@@ Line 51: / Line 51: @@
 {{API table/row|'''[[window.setVisible]]({{type|boolean}} visibility)'''|{{type|nil}}
-|Hides or reveals the window. ''Available only to [[Window (API)|window]] objects.''|}}
+|Determines whether subsequent renders to the window will be visible. ''Available only to [[Window (API)|window]] objects.''|}}
 {{API table/row|'''[[window.redraw]]()'''|{{type|nil}}

@@ Line 33: / Line 33: @@
 {{API table/row|[[term.redirect]](target)|{{type|table}} previous terminal object
-|Redirects terminal output to a monitor or other terminal object (such as a [[Window (API)|window]] or [[peripheral.wrap|wrapped]] [[monitor]]). ''Available only to the base term object.''}}
+|Redirects terminal output to another terminal object (such as a [[Window (API)|window]] or [[peripheral.wrap|wrapped]] [[monitor]]). ''Available only to the base term object.''}}
 {{API table/row|[[term.current]]()|{{type|table}} terminal object

@@ Line 33: / Line 33: @@
 {{API table/row|[[term.redirect]](target)|{{type|table}} previous terminal object
-|Redirects terminal output to a monitor or other terminal object. (Use [[peripheral.wrap]] to acquire a terminal object.) ''Available only to the base term object.''}}
+|Redirects terminal output to a monitor or other terminal object (such as a [[Window (API)|window]] or [[peripheral.wrap|wrapped]] [[monitor]]). ''Available only to the base term object.''}}
 {{API table/row|[[term.current]]()|{{type|table}} terminal object
@@ Line 59: / Line 59: @@
 |Returns the cursor back to its position / state within the window. ''Available only to [[Window (API)|window]] objects.''|}}
-{{API table/row|'''[[window.getPosition]]()'''|{{type|nil}}
+{{API table/row|'''[[window.getPosition]]()'''|{{type|number}} x, {{type|number}} y
 |Returns the top left co-ordinate of the window. ''Available only to [[Window (API)|window]] objects.''|odd}}

@@ Line 1: / Line 1: @@
 The Terminal API provides functions for writing text to the terminal and monitors, and drawing ASCII graphics.
-Methods in ''italics'' are available only to [[Advanced Computer|Advanced Computers]] and [[Advanced Monitor|Advanced Monitors]].
+Functions in ''italics'' are only available to [[Monitor|Monitors]]. Functions in '''bold''' are available only to [[Window (API)|Windows]].
-Methods in '''bold''' are available only to [[Monitor|Monitors]].
 {{API table|Term|image=Grid disk.png|2=
@@ Line 25: / Line 24: @@
 {{API table/row|[[term.isColor]]()|{{type|boolean}}
-|Returns if the computer supports color. (Used to determine whether or not an [[Advanced Computer]] is being used)|odd}}
+|Returns whether the terminal supports color.|odd}}
 {{API table/row|[[term.getSize]]()|{{type|number}} x, {{type|number}} y
@@ Line 34: / Line 33: @@
 {{API table/row|[[term.redirect]](target)|{{type|table}} previous terminal object
-|Redirects terminal output to a monitor or other terminal object. (Use [[peripheral.wrap]] to acquire a terminal object.)}}
+|Redirects terminal output to a monitor or other terminal object. (Use [[peripheral.wrap]] to acquire a terminal object.) ''Available only to the base term object.''}}
 {{API table/row|[[term.current]]()|{{type|table}} terminal object
-|Returns the current terminal object. ''Requires version 1.6 or newer.''|odd}}
+|Returns the current terminal object. ''Requires version 1.6 or newer, available only to the base term object.''|odd}}
 {{API table/row|[[term.native]]()|{{type|table}} terminal object
-|Returns the original terminal object. ''Requires version 1.6 or newer.''}}
+|Returns the original terminal object. ''Requires version 1.6 or newer, available only to the base term object.''}}
-{{API table/row|''[[term.setTextColor]]({{type|number}} [[Colors (API)|color]])''|{{type|nil}}
+{{API table/row|[[term.setTextColor]]({{type|number}} [[Colors (API)|color]])|{{type|nil}}
-|Sets the text color of the terminal. Available only to [[Advanced Computer|Advanced Computers]] and [[Advanced Monitor]]s.|odd}}
+|Sets the text color of the terminal. ''Limited functionality without an Advanced [[Advanced Computer|Computer]] / [[Advanced Turtle|Turtle]] / [[Advanced Monitor|Monitor]].''|odd}}
-{{API table/row|''[[term.setBackgroundColor]]({{type|number}} [[Colors (API)#Colors|color]])''|{{type|nil}}
+{{API table/row|[[term.setBackgroundColor]]({{type|number}} [[Colors (API)#Colors|color]])|{{type|nil}}
-|Sets the background color of the terminal. Available only to [[Advanced Computer|Advanced Computers]] and [[Advanced Monitor]]s.}}
+|Sets the background color of the terminal. ''Limited functionality without an Advanced [[Advanced Computer|Computer]] / [[Advanced Turtle|Turtle]] / [[Advanced Monitor|Monitor]].''}}
-{{API table/row|'''[[monitor.setTextScale]]({{type|number}} scale)'''|{{type|nil}}
+{{API table/row|''[[monitor.setTextScale]]({{type|number}} scale)''|{{type|nil}}
-|Sets the text scale on a [[Monitor]].|odd}}
+|Sets the text scale. ''Available only to [[Monitor#Monitor as a Peripheral|monitor]] objects.''|odd}}
 }}

@@ Line 38: / Line 38: @@
 {{API table/row|[[term.current]]()|{{type|table}} terminal object
 |Returns the current terminal object. ''Requires version 1.6 or newer.''|odd}}
 {{API table/row|''[[term.setTextColor]]({{type|number}} [[Colors (API)|color]])''|{{type|nil}}
-|Sets the text color of the terminal. Available only to [[Advanced Computer|Advanced Computers]] and [[Advanced Monitor]]s.}}
+|Sets the text color of the terminal. Available only to [[Advanced Computer|Advanced Computers]] and [[Advanced Monitor]]s.|odd}}
 {{API table/row|''[[term.setBackgroundColor]]({{type|number}} [[Colors (API)#Colors|color]])''|{{type|nil}}
-|Sets the background color of the terminal. Available only to [[Advanced Computer|Advanced Computers]] and [[Advanced Monitor]]s.|odd}}
+|Sets the background color of the terminal. Available only to [[Advanced Computer|Advanced Computers]] and [[Advanced Monitor]]s.}}
 {{API table/row|'''[[monitor.setTextScale]]({{type|number}} scale)'''|{{type|nil}}
-|Sets the text scale on a [[Monitor]].}}
+|Sets the text scale on a [[Monitor]].|odd}}
 }}
@@ Line 63: / Line 66: @@
 {{API table/row|[[term.restore]]()|{{type|nil}}
-|Restores terminal output to the previous target.|odd}}
+|Restores terminal output to the previous target. Removed by ComputerCraft 1.6.|odd}}
 }}
 [[Category:APIs]]

@@ Line 50: / Line 50: @@
 }}
 {{Event
-|name=term_resize
+|name=[[term_resize (event)|term_resize]]
 |desc=Fired when the screen changes size (through opening a new tab with ''bg'', etc). ''Requires version 1.6 or higher.''
 }}