ComputerCraft Wiki - User contributions [en]

Paintutils (API)

2013-05-14T09:56:37Z

TheCoryKid: Removed the NeedsWork (it no longer explained what needed work), adjusted column widths, changed int to number, added <em> tags.

Paintutils is a default API for advanced computers which can draw pixels and lines, and load and draw image files.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Paintutils (API)
</td></tr>

<tr><td style="width: 550px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.loadImage]]({{type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns an image object from <em>path</em>.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawImage]]({{type|table}} image, {{type|number}} x, {{type|number}} y)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws an image at (<em>x</em>, <em>y</em>) where <em>image</em> is an image object.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawPixel]]({{type|number}} x, {{type|number}} y, {{type|number}} colour)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a pixel at (<em>x</em>, <em>y</em>) in the specified <em>colour</em>.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[paintutils.drawLine]]({{type|number}} startX, {{type|number}} startY, {{type|number}} endX, {{type|number}} endY, {{type|number}} color)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Draws a line from (<em>startX</em>, <em>startY</em>) to (<em>endX</em>, <em>endY</em>) in the specified <em>colour</em>.</td></tr>

</table>

[[Category:APIs]]

Bit (API)

2013-05-14T09:27:54Z

TheCoryKid: Fixed table background colors.

The Bit API is for manipulating numbers using bitwise binary operations.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">[[File:Grid_disk.png|24px]]  Bit (API)</td></tr>

<tr><td style="width: 100px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} value</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.blshift]]({{Type|int}} n, {{Type|int}} bits)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number left by a specified number of bits.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} value</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.brshift]]({{Type|int}} n, {{Type|int}} bits)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number right arithmetically by a specified number of bits.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} value</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.blogic_rshift]]({{Type|int}} n, {{Type|int}} bits)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number right logically by a specified number of bits.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} value</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bxor]]({{Type|int}} m, {{Type|int}} n)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise exclusive OR of two numbers.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} value</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bor]]({{Type|int}} m, {{Type|int}} n)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise inclusive OR of two numbers.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} value</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.band]]({{Type|int}} m, {{Type|int}} n)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise AND of two numbers.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} value</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bnot]]({{Type|int}} n)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise NOT of a number.</td></tr>
</table>

The following functions used to exist in this API but no longer do:

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">[[File:Grid_disk.png|24px]]  Bit (API)</td></tr>

<tr><td style="width: 100px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} bit_tbl</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.tobits]]({{Type|int}} n)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Converts a number to an array (numerically-indexed table) containing the corresponding binary bit values.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} value</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.tonumb]]({{Type|table}} bit_tbl)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Converts an array (numerically-indexed table) of 0 and 1 values representing a number in binary into that number.</td></tr>
</table>

[[Category:APIs]]

Peripheral (event)

2013-05-06T11:14:20Z

TheCoryKid: Removed the NeedsWork.

{{Event
|name=peripheral
|desc=Fired when a peripheral is connected (directly adjacent) to the computer.
|return1=The [[String_(type)|string]] value of the side of the connected peripheral.
}}
{{Example
|desc=Prints the type of peripheral and side when peripheral is attached
|code=
while true do
event, side = os.pullEvent("peripheral")
print("A "..peripheral.getType(side).." has been attached on the "..side)
end
}}
{{Example
|desc=Prints if it found the peripheral it was looking for ( in this example modem, more peripheral type here [[peripheral.getType]]
|code=
while true do
event, side = os.pullEvent("peripheral")
if peripheral.getType(side) == "modem" then
print("A modem has been attached!")
break
end
end
}}

Fs (API)

2013-05-05T13:57:39Z

TheCoryKid: Fixed table row background colors and adjusted column widths.

The FS API allows you to mess around with the filesystem.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Fs (API)
</td></tr>

<tr><td style="width: 130px; background: #E0E0E0; padding: .4em; font-weight:bold;">Return</td><td style="width: 300px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} files</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.list]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a list of all the files (including subdirectories but not their contents) contained in a directory, as a numerically indexed table.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} exists</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.exists]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path refers to an existing file or directory.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} dir</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.isDir]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path refers to an existing directory.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} readOnly</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.isReadOnly]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Checks if a path is read-only (i.e. cannot be modified).</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} name</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getName]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the final component of a pathname.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} drive, or [[nil]]</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getDrive]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the storage medium holding a path, or [[nil]] if the path does not exist.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} size</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getSize]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the size of a file in bytes</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|int}} space</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.getFreeSpace]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gets the remaining space in the given directory.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.makeDir]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes a directory.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.move]]({{Type|string}} fromPath, {{Type|string}} toPath)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Moves a file or directory to a new location.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.copy]]({{Type|string}} fromPath, {{Type|string}} toPath)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Copies a file or directory to a new location.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[nil]]</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.delete]]({{Type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Deletes a file or directory.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} path</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.combine]]({{Type|string}} basePath, {{Type|string}} localPath)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Combines two path components, returning a path consisting of the local path nested inside the base path.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} handle</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[fs.open]]({{Type|string}} path, {{Type|string}} mode)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Opens a file so it can be read or written.</td></tr>
</table>

[[Category:APIs]]

==Path Names==
All of these functions except for [[fs.combine]] refer solely to <em>absolute paths</em>.<br />
This means that the current working directory, as set by the <code>cd</code> command or the [[shell.setDir]] function, is ignored. Each path name consists of a list of nonempty path components separated by forward slashes, and those path components are taken one by one with the first being contained in the root directory of the computer.

If you need to deal with paths provided by the user that may be absolute or may be relative to the current working directory, use [[shell.resolve]].

Unlike most real-world operating systems, ComputerCraft's absolute path name system does not need to be started with a forward slash ( / ), making the directory "a/b/c" the same as "/a/b/c". Leaving the slashes is just a matter of preference to the coder.

Textutils (API)

2013-05-05T09:58:07Z

TheCoryKid: I need to start using [Show preview].

{{NeedsWork|Needs <s>5</s> <s>3</s> 2 function pages<s>, 1 function descriptions</s>. ''[[User:AfterLifeLochie|AfterLifeLochie]] 02:40, 29 November 2012 (MSK)''}}
The Textutils API is used to format and manipulate strings easily.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Textutils (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowWrite]]({{type|string}} text, {{type|int}} rate)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Writes string ''text'' at current cursor position, character-by-character. Number argument ''rate'' is optional and is defaulted to 20. The higher the value of ''rate'', the faster ''text'' is written (passing a value of 1 writes one character per second).</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowPrint]]({{type|string}} text, {{type|int}} rate)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints string ''text'' at current cursor position, character-by-character. Number argument ''rate'' is optional and is defaulted to 20. The higher the value of ''rate'', the faster ''text'' is printed (passing a value of 1 prints one character per second). This function also prints a newline.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.formatTime]]({{type|int}} time, {{type|boolean}} TwentyFourHour)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Takes input ''time'' and formats it in a more readable format. If second value is true, returns time in military time; if second value is false, returns time with AM or PM. Example: print(textutils.formatTime(os.time(), false))—os.time() returns MineCraft time.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.tabulate]]({{type|table}} table, {{type|table}} table2, ...)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints tables in an ordered form. Each table is a row, the column width is auto-adjusted.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedTabulate]]({{type|table}} table, {{type|table}} table2, ...)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints tables in an ordered form, like [[textutils.tabulate]]. However, it waits for confirmation before scrolling down.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedPrint]]({{type|string}} text, {{type|string}} confirmation_lines)</td><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints string ''text'' onto the screen, but waits for confirmation before scrolling down.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.serialize]]({{type|table}} table)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a string representation of the table ''table'' for storage or transmission.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.unserialize]]({{type|string}} text)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table reassembled from string ''text''.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.urlEncode]]({{type|string}} text)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes a string safe to encode into a url. Spaces are replaced with +s. Unsafe characters such as '\', '£' and '}' are translated into ASCII code and preceded with a % for transmission. For reference visit: [http://www.blooberry.com/indexdot/html/topics/urlencoding.htm].</td></tr>
</table>

[[Category:APIs]]

Textutils (API)

2013-05-05T09:55:16Z

TheCoryKid: Made function descriptions a little more informative and beginner-friendly. Users shouldn't have to visit individual pages to understand what any function does.

{{NeedsWork|Needs <s>5</s> 3 function pages, 1 function descriptions. ''[[User:AfterLifeLochie|AfterLifeLochie]] 02:40, 29 November 2012 (MSK)''}}
The Textutils API is used to format and manipulate strings easily.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Textutils (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowWrite]]({{type|string}} text, {{type|int}} rate)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Writes string ''text'' at current cursor position, character-by-character. Number argument ''rate'' is optional and is defaulted to 20. The higher the value of ''rate'', the faster ''text'' is written (passing a value of 1 writes one character per second).</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.slowPrint]]({{type|string}} text, {{type|int}} rate)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints string ''text'' at current cursor position, character-by-character. Number argument ''rate'' is optional and is defaulted to 20. The higher the value of ''rate'', the faster ''text'' is printed (passing a value of 1 prints one character per second). This function also prints a newline.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.formatTime]]({{type|int}} time, {{type|boolean}} TwentyFourHour)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Takes input ''time'' and formats it in a more readable format. If second value is true, returns time in military time; if second value is false, returns time with AM or PM. Example: print(textutils.formatTime(os.time(), false))—os.time() returns MineCraft time.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.tabulate]]({{type|table}} table, {{type|table}} table2, ...)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints tables in an ordered form. Each table is a row, the column width is auto-adjusted.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedTabulate]]({{type|table}} table, {{type|table}} table2, ...)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints tables in an ordered form, like [[textutils.tabulate]]. However, it waits for confirmation before scrolling down.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.pagedPrint]]({{type|string}} text, {{type|string}} confirmation_lines)</td><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Prints string ''text'' onto the screen, but waits for confirmation before scrolling down.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.serialize]]({{type|table}} table)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a string representation of the table ''table'' for storage or transmission.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.unserialize]]({{type|string}} text)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table reassembled from string ''text''.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[textutils.urlEncode]]({{type|string}} text)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes a string safe to encode into a url. Spaces are replaced with +s. Unsafe characters such as '\', '£' and '}' are translated into ASCII code and preceded with a % for transmission. For reference visit: [http://www.blooberry.com/indexdot/html/topics/urlencoding.htm].</td></tr>
</table>

[[Category:APIs]]

Redstone (API)

2013-05-05T09:41:59Z

TheCoryKid: Added periods, changed capitalization, swapped words around, removed (possibly fake) jargon.

The Redstone API contains methods to control attached RedPower cables/bundled cables and regular redstone. All methods from the redstone API can also be called using "rs", which points to the same library. For example, instead of redstone.getSides(), rs.getSides() can be used. Refer to the [[Colors]] API for more information on interacting with RedPower's bundled cables.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Redstone (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getSides]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table of possible sides.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone input signal state on ''side''.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setOutput]]({{type|string}} side, {{type|boolean}} value)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets or resets a redstone signal on ''side''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone output signal on ''side''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getAnalogInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone input signal strength on ''side''. If no input is present, returns 0. If a redstone source (such as a redstone torch or block) is directly adjacent to the computer, returns 15.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setAnalogOutput]]({{type|string}} side, {{type|number}} strength)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets or resets a redstone signal on ''side'' to ''strength''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getAnalogOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone output signal strength on ''side''.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getBundledInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the state (as a number) of a RedPower bundled cable connected to ''side''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getBundledOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the set of RedPower wires in the RedPower bundled cable which are being activated by the terminal on ''side''.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setBundledOutput]]({{type|string}} side, {{type|int}} colors)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets one or multiple colored signals in a RedPower bundled cable attached to ''side''. ''colors'' will determine which signals are activated. In order to set multiple signals, add the color values of the colors you want to activate. To turn off all of the colors, use 0.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.testBundledInput]]({{type|string}} side, {{type|int}} color)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns true if ''color'' is active in a RedPower bundled cable attached to ''side''. Else, returns false.</td></tr>

</table>

[[Category:APIs]]

Mouse scroll (event)

2013-05-04T08:31:34Z

TheCoryKid: *cough* Apparently, the Event template doesn't allow for more than three return values?

{{Event
|name=mouse_scroll
|desc=Fired when a mousewheel is scrolled in the terminal
|return1=The direction of the mouse-scroll (<var>-1</var> = up, <var>1</var> = down).
|return2=The X-coordinate of the scroll (in screen-characters).
|return3=The Y-coordinate of the scroll (in screen-characters).
|examples=
{{Example
|desc=Print the direction and the co-ordinates of every mouse scroll we receive a ''mouse_scroll'' event for.
|code=
while true do
_, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
[[print]]("mouse_scroll: " .. [[tostring]](dir) .. ", " ..
"X: " .. [[tostring]](x) .. ", " ..
"Y: " .. [[tostring]](y))
end
|output=The direction the mouse-wheel was scrolled in, followed by the X and Y position of the event.
}}
{{Example
|desc=A variable, i, keeps track of the relative value of the scroll: every time a mouse-scroll occurs, the code checks the direction, incrementing the variable by one for every scroll up and decrementing the variable by one for every scroll down.
|code=
i = 0
while true do
term.clear()
_, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
if dir == -1 then
i = i + 1
elseif dir == 1 then
i = i - 1
end
term.setCursorPos(x, y)
term.write(i)
end
|output=At the coordinates of the scroll, the counter value is printed.
}}
}}

Mouse scroll (event)

2013-05-04T08:29:19Z

TheCoryKid: Removed the NeedsWork and fixed my own error.

{{Event
|name=mouse_scroll
|desc=Fired when a mousewheel is scrolled in the terminal
|return1=The name of the event.
|return2=The direction of the mouse-scroll (<var>-1</var> = up, <var>1</var> = down).
|return3=The X-coordinate of the scroll (in screen-characters).
|return4=The Y-coordinate of the scroll (in screen-characters).
|examples=
{{Example
|desc=Print the direction and the co-ordinates of every mouse scroll we receive a ''mouse_scroll'' event for.
|code=
while true do
_, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
[[print]]("mouse_scroll: " .. [[tostring]](dir) .. ", " ..
"X: " .. [[tostring]](x) .. ", " ..
"Y: " .. [[tostring]](y))
end
|output=The direction the mouse-wheel was scrolled in, followed by the X and Y position of the event.
}}
{{Example
|desc=A variable, i, keeps track of the relative value of the scroll: every time a mouse-scroll occurs, the code checks the direction, incrementing the variable by one for every scroll up and decrementing the variable by one for every scroll down.
|code=
i = 0
while true do
term.clear()
_, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
if dir == -1 then
i = i + 1
elseif dir == 1 then
i = i - 1
end
term.setCursorPos(x, y)
term.write(i)
end
|output=At the coordinates of the scroll, the counter value is printed.
}}
}}

Mouse scroll (event)

2013-05-04T08:27:05Z

TheCoryKid: The description and code example were both wrong. Fixed the return values, changed the example to reflect this, and added a second example.

{{NeedsWork|A demonstration on the use and handling of this event would be beneficial. ''[[User:AfterLifeLochie|AfterLifeLochie]] 15:57, 30 November 2012 (MSK)''}}

{{Event
|name=mouse_scroll
|desc=Fired when a mousewheel is scrolled in the terminal
|return1=The name of the event.
|return2=The direction of the mouse-scroll (<var>-1</var> = up, <var>1</var> = down).
|return3=The X-coordinate of the scroll (in screen-characters).
|return4=The Y-coordinate of the scroll (in screen-characters).
|examples=
{{Example
|desc=Print the direction and the co-ordinates of every mouse scroll we receive a ''mouse_scroll'' event for.
|code=
while true do
_, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
[[print]]("mouse_scroll: " .. [[tostring]](dir) .. ", " ..
"X: " .. [[tostring]](x) .. ", " ..
"Y: " .. [[tostring]](y))
end
|output=The direction the mouse-wheel was scrolled in, followed by the X and Y position of the event.
}}
{{Example
|desc=A variable, i, keeps track of the relative value of the scroll: every time a mouse-scroll occurs, the code checks the direction, incrementing the variable by one for every scroll up and decrementing the variable by one for every scroll down.
|code=
i = 0
while true do
term.clear()
_, dir, x, y = os.pullEvent("[[mouse_scroll_(event)|mouse_scroll]]")
if dir == -1 then
i = i + 1
elseif dir == 1 then
i = i - 1
end
term.setCursorPos(x, y)
term.write(i)
|output=At the coordinates of the scroll, the counter value is printed.
}}
}}

Redstone (API)

2013-05-04T07:37:33Z

TheCoryKid: Added note about "rs" versus "redstone".

The Redstone API contains methods to control attached RedPower cables/bundled cables and regular redstone. All methods from the redstone API can also be called using "rs", which points to the same library. For example, instead of redstone.getSides(), rs.getSides() can be used.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Redstone (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getSides]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table of possible sides</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone input signal state on ''side''</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setOutput]]({{type|string}} side, {{type|boolean}} value)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Set or reset a redstone signal on ''side''</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone output signal on ''side''</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getAnalogInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone input signal strength on ''side''. If no input is present, returns 0. If a redstone source (such as a redstone torch or block) is directly adjacent to the computer, returns 15.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setAnalogOutput]]({{type|string}} side, {{type|number}} strength)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Set or reset a redstone signal on ''side'' to ''strength''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getAnalogOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone output signal strength on ''side''</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getBundledInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the state of a redpower wire inside a bundle connected to ''side''</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getBundledOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the set of redpower wires inside a bundle on ''side'' that are being driven high <b>by the local console</b> (not those that are driven high by another device on the bundle but not driven high by the local console)</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setBundledOutput]]({{type|string}} side, {{type|int}} colors)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets one or multiple colored signals in a redpower bundled wire connected to ''Side''. In order to set multiple signals, add the color values of the colors you want to activate. To turn off all of the values, use 0 for the integer.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.testBundledInput]]({{type|string}} side, {{type|int}} color)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns true or false whether or not a colored signal is active in a redpower bundled wire connected to ''side''</td></tr>

</table>

[[Category:APIs]]

Redstone (API)

2013-05-04T07:32:43Z

TheCoryKid: Added missing methods (rs.getAnalogInput/setAnalogOutput/getAnalogOutput()).

The Redstone API contains methods to control attached RedPower cables/bundled cables and regular redstone.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Redstone (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getSides]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table of possible sides</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone input signal state on ''side''</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setOutput]]({{type|string}} side, {{type|boolean}} value)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Set or reset a redstone signal on ''side''</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone output signal on ''side''</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getAnalogInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone input signal strength on ''side''. If no input is present, returns 0. If a redstone source (such as a redstone torch or block) is directly adjacent to the computer, returns 15.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setAnalogOutput]]({{type|string}} side, {{type|number}} strength)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Set or reset a redstone signal on ''side'' to ''strength''.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getAnalogOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current redstone output signal strength on ''side''</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getBundledInput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the state of a redpower wire inside a bundle connected to ''side''</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getBundledOutput]]({{type|string}} side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the set of redpower wires inside a bundle on ''side'' that are being driven high <b>by the local console</b> (not those that are driven high by another device on the bundle but not driven high by the local console)</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setBundledOutput]]({{type|string}} side, {{type|int}} colors)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets one or multiple colored signals in a redpower bundled wire connected to ''Side''. In order to set multiple signals, add the color values of the colors you want to activate. To turn off all of the values, use 0 for the integer.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.testBundledInput]]({{type|string}} side, {{type|int}} color)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns true or false whether or not a colored signal is active in a redpower bundled wire connected to ''side''</td></tr>

</table>

[[Category:APIs]]

Printer

2013-05-03T15:23:07Z

TheCoryKid: Re-applied previous changes which were accidentally deleted (added recipes).

{{Block
|name=Printer
|image=Iso_Printer.png
|id=4094
|damage-value=Un-used.
|is-peripheral=Yes
|peripheral-api=Printer (API)
}}
The printer was added in the [[ComputerCraft]] 1.42 update. The printer is placed next to a computer, and allows for printing text onto paper with any color of ink.

== Recipes ==
Using the printer will produce [[Printed Page]]. These pages can be used in two different shapeless recipes: [[Printed Pages]] and [[Printed Book]]. Using any of these when on your hotbar will allow you to view their contents (much like with signed books in vanilla).
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=Redstone |C2=stone
|A3=stone |B3=Ink_Sac |C3=stone
|Output=printer
}}
{{Crafting grid
|B1=printed_page
|A2=String |B2=printed_page
|B3=printed_page
|Output=printed_pages
}}
{{Crafting grid
|A1=printed_pages |B1=printed_pages |C1=printed_pages
|A2=printed_page |B2=printed_page |C2=printed_page
|B3=String
|Output=printed_pages
}}
{{Crafting grid
|A1=printed_page |B1=printed_page |C1=printed_page
|A2=String |B2=Leather
|Output=printed_book_
}}
{{Crafting grid
|A1=printed_pages |B1=printed_pages |C1=printed_pages
|A2=printed_page |B2=printed_page |C2=printed_page
|A3=String |B3=Leather
|Output=printed_book_
}}
== Usage ==
To use a printer, place it adjacently but not diagonally next to a computer (left, right, top, bottom, front, or back side). Place any color ink in the single left slot, and paper in any of the top slots.

If you are using blocks to pull/insert items from the printer the different slots are available from these sides:
Paper tray is accessible from the top, output paper tray is accessible from the front or bottom, and the ink slot is accessible from the back or sides.

== Printer API ==
The printer API allows programs to interact in various ways with the printer. In order for these functions to become available, you must first wrap the printer as a peripheral using [[peripheral.wrap]]().
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Printer API
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.getPaperLevel]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the amount of paper available in the paper tray.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.newPage]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Starts a new page. Returns true if page got started, false if not.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.endPage]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.write]]([[string]] text)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Writes text to the paper, works the same way as [[term.write|term.write()]]</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.setPageTitle]]([[string]] title)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the title of the page.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.getInkLevel]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the amount of ink in the ink slot.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.getCursorPos]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos|term.getCursorPos()]]</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.setCursorPos]]([[int (type)|int]] x, [[int (type)|int]] y)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the cursor pos, works the same way as [[term.setCursorPos|term.setCursorPos()]]</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.getPageSize]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the size of the paper, works the same way as [[term.getSize|term.getSize()]]</td></tr>
</table>

[[File:PrinterGUI.png|thumb|256px|GUI of the Printer]]

[[Category:Blocks]]

File:Grid printed pages.png

2013-05-03T14:51:37Z

TheCoryKid:

File:Grid printed page.png

2013-05-03T14:34:06Z

TheCoryKid:

Printer

2013-05-03T14:06:42Z

TheCoryKid:

{{NeedsWork|Printer methods are not documented on this page.}}
{{Block
|name=Printer
|image=Iso_Printer.png
|id=4094
|damage-value=Un-used.
|is-peripheral=Yes
|peripheral-api=Printer (API)
}}
The printer was added in the [[ComputerCraft]] 1.42 update. The printer is placed next to a computer, and allows for printing text onto paper with any color of ink.

== Recipes ==
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=Redstone |C2=stone
|A3=stone |B3=Ink_Sac |C3=stone
|Output=printer}}{{Crafting grid
|A1=Page |B1=Page |C1=Page
|A2=String |B2=Leather
|Output=printed_book_
}}
== Usage ==
To use a printer, place it adjacently but not diagonally next to a computer (left, right, top, bottom, front, or back side). Place any color ink in the single left slot, and paper in any of the top slots.

If you are using blocks to pull/insert items from the printer the different slots are available from these sides:
Paper tray is accessible from the top, output paper tray is accessible from the front or bottom, and the ink slot is accessible from the back or sides.

[[File:PrinterGUI.png|thumb|256px|GUI of the Printer]]

== Printer API ==
The printer API allows programs to interact in various ways with the printer. In order for these functions to become available, you must first wrap the printer as a peripheral using [[peripheral.wrap]]().
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Printer API
</td></tr>
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.getPaperLevel]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the amount of paper available in the paper tray.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.newPage]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Starts a new page. Returns true if page got started, false if not.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.endPage]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.write]]([[string]] text)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Writes text to the paper, works the same way as [[term.write|term.write()]]</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.setPageTitle]]([[string]] title)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the title of the page.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.getInkLevel]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the amount of ink in the ink slot.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.getCursorPos]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos|term.getCursorPos()]]</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.setCursorPos]]([[int (type)|int]] x, [[int (type)|int]] y)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the cursor pos, works the same way as [[term.setCursorPos|term.setCursorPos()]]</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[printer.getPageSize]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the size of the paper, works the same way as [[term.getSize|term.getSize()]]</td></tr>
</table>

[[Category:Blocks]]

File:Grid printed book .png

2013-05-03T14:05:14Z

TheCoryKid:

File:Grid Leather.png

2013-05-03T13:24:36Z

TheCoryKid: Leather used in crafting recipes for "Printed Pages" and "Printed Book".

Leather used in crafting recipes for "Printed Pages" and "Printed Book".

File:Grid String.png

2013-05-03T13:22:21Z

TheCoryKid: String used in crafting recipes for "Printed Pages" and "Printed Book".

String used in crafting recipes for "Printed Pages" and "Printed Book".

File:Grid Page.png

2013-05-03T13:19:02Z

TheCoryKid: Printed page created by the printer.

Printed page created by the printer.

Shell.aliases

2013-05-03T12:36:00Z

TheCoryKid:

{{lowercase}}
{{Function
|name=shell.aliases
|api=Shell
|returns=A table containing default and set aliases.
|addon=ComputerCraft
|desc=Returns a table containing the default aliases and user specified aliases
|examples=
{{Example
|desc=This code will return all set aliases and the programs they refer to.
|code= for k,v in pairs(shell.aliases()) do<br/> print(k.." : "..v)<br/>end
}}
}}

[[Category:API_Functions]]