ComputerCraft Wiki - User contributions [en]

Term.redirect

2015-08-27T16:31:30Z

Turkey: Fixing typo

{{lowercase}}
{{Function
|name=term.redirect
|args={{type|table}} terminal object
|returns={{type|table}} previous terminal object
|api=term
|addon=ComputerCraft
|desc=Redirects [[term (API)|terminal]] output to a [[monitor]], a [[window (API)|window]], or any other custom terminal object. Once the redirect is performed, any calls to a "term" function - or to a function that makes ''use'' of a term function, as as [[print|print()]] - will instead operate with the new terminal object.

A "terminal object" is simply a table that contains functions with the same names - and general features - as those found in the [[term (API)|term]] table. For example, a [[Peripheral.wrap|wrapped]] monitor is suitable.

The redirect can be undone by pointing back to the previous terminal object (which this function returns whenever you switch). For ComputerCraft builds older than 1.6, use [[term.restore|term.restore()]] to revert instead.

Advanced systems running on ComputerCraft 1.6 or later implement [[multishell]], which enables easy multitasking at the expense of some terminal slow-down (all instances of the [[shell]] are redirected to a [[window (API)|window]], increasing the number of function calls involved in any graphical updates). This can be circumvented by way of redirecting to [[term.native]](), at the cost of (somewhat messily) breaking things for users who actually want the multitasking capability.

|examples=
{{Example
|desc=Prints "Hello World!" on the right monitor.
|code=term.redirect(peripheral.wrap("right"))<br>print("Hello World!")
}}
{{Example
|desc=Redirects to a monitor, writes some text there, then reverts back to the previous display.
|code=
local mon = [[peripheral.find]]("monitor")
local oldTerm = term.redirect(mon)
print("I'm written on a monitor!")
term.redirect(oldTerm)
}}
}}

[[Category:API_Functions]]

Turtle Fuel

2015-08-20T03:01:39Z

Turkey: Works fine as a redirect, doesn't need to be deleted

#REDIRECT [[Turtle.refuel#Fuel_Values]]

Pocket computer

2015-08-20T02:58:41Z

Turkey: Redirected page to Pocket Computer

#REDIRECT [[Pocket Computer]]

Bios.lua

2015-08-20T02:58:10Z

Turkey:

{{stub}}

bios.lua is the main component in a computer ([[computer]]s, [[pocket computer]]s, [[turtle]]s). If you were to look at the .jar file, you would see bios.lua is in the same directory as rom (The root directory) but doesn't show up when used with ls, dir or list. It is a file that is run on boot of the computer and you can't edit it internally but can edit it externally with programs like [https://notepad-plus-plus.org/ Notepad++]. The functions, however, can be overwritten with simple Lua code.

Adventure

2015-08-20T02:55:00Z

Turkey:

[[image:2012-01-30 22.51.59.png|frame|right|Gameplay of Adventure.]]Adventure is one of the default programs in [[CraftOS]]. Adventure emulates a text adventure, but it takes place in Minecraft. Therefore, it is possible to play Minecraft, on a computer, in Minecraft, on a computer. This is referred to as "recursion". Also most LPs consist of LPers playing Adventure.

For more ingame info type: "help"

[[Category:Games]]

Lava

2015-08-19T19:42:34Z

Turkey:

{{Stub}}
'''Lava''' is a [[fuel]] source in Computercraft. A [[turtle]] can consume a bucket of lava for 1,000 fuel units (using the [[turtle.refuel]] command when a bucket is in the currently selected slot). This will leave an empty bucket in the selected slot after the lava is consumed. When a turtle uses [[turtle.place]] and has a bucket of lava in the currently selected slot, it will place the lava in front of it. When a turtle uses turtle.place and has an empty bucket in the currently selected slot, it can collect a lava source block in front of it and put the lava in the bucket. This allows turtles to easily [[refuel]] on the move when working deep underground or in the nether. Lava does not harm turtles.

== See also ==
* [[Turtle (API)]]
* [[Water]]

== External links ==
* [http://minecraft.gamepedia.com/Lava Lava at minecraftwiki]

[[Category:Vanilla_Minecraft]]

Redstone (API)

2014-11-22T18:37:44Z

Turkey: /* Data exchange */

The Redstone API contains methods to control attached 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.

In addition to regular redstone / RedPower cables for regular signals, RedPower bundled (for MineCraft 1.4.x) or Minefactory Reloaded RedNet cables (for MineCraft 1.5.x up) may be used to send "bundled" signals out the one face. Refer to the [[Colors]] API for more information on interacting with these.

As of ComputerCraft 1.6, the previous support for bundled cables has been replaced with an API allowing other mod developers to provide the support themselves. '''At this time, bundled cables cannot be used with this build - please update this page if and when any mods add compatibility!'''

<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;">'''(Requires CC1.51 and above)''' 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;">'''(Requires CC1.51 and above)''' Sets or resets a redstone signal on ''side'' to ''strength'' (where ''strength'' is a positive integer).</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;">'''(Requires CC1.51 and above)''' 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 / Minefactory Reloaded RedNet 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 / Minefactory Reloaded RedNet 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|number}} colors)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets one or multiple colored signals in a RedPower bundled / Minefactory Reloaded RedNet 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|number}} color)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns true if ''color'' is active in a RedPower bundled / Minefactory Reloaded RedNet cable attached to ''side''. Else, returns false.</td></tr>

</table>

:{|class="wikitable"
| ''[[Usage_of_the_bundled_cable_using_the_Redstone_API|Bundled cable code snippet. (You might want to take a look at this if you are doing bundledcable related things.)]]''
|}

== Data exchange ==
The redstone API can be used to exchange data between adjacent [[computer]]s and [[turtle]]s. Four bits of data can be transmitted and received with each use of redstone signals to send analog output and receive the input. One redstone signal can be sent at each tick [http://minecraft.gamepedia.com/Tick tick], and there are 20 ticks per second in minecraft. This limits data transmission over redstone to a maximum of 80 bits per second (bps).

This makes large-scale data transmission over the redstone API exceedingly slow. For example, using the redstone API, transmitting a colored bitmap image for a maximum [[resolution]] computercraft monitor cluster (162x80 pixels) would require 10 minutes and 48 seconds (this would be a 6.48 kB image). For reference, there are 16 colors available for monitors and terminals in computercraft, so a single color for a pixel can be represented in a 4-bit signal.

Despite the slowness, the redstone API can be useful when other options are not available. For example, it can be used to allow [[turtle]]s to communicate with each other and coordinate their work even if they do not have [[Wireless Modem]]s. Exchanging instructions can be done with much less total data than exchanges of image files and the like.
[[Category:APIs]]

Redstone (API)

2014-11-20T03:20:55Z

Turkey: Adding a note about usage in data exchange

The Redstone API contains methods to control attached 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.

In addition to regular redstone / RedPower cables for regular signals, RedPower bundled (for MineCraft 1.4.x) or Minefactory Reloaded RedNet cables (for MineCraft 1.5.x up) may be used to send "bundled" signals out the one face. Refer to the [[Colors]] API for more information on interacting with these.

As of ComputerCraft 1.6, the previous support for bundled cables has been replaced with an API allowing other mod developers to provide the support themselves. '''At this time, bundled cables cannot be used with this build - please update this page if and when any mods add compatibility!'''

<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;">'''(Requires CC1.51 and above)''' 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;">'''(Requires CC1.51 and above)''' Sets or resets a redstone signal on ''side'' to ''strength'' (where ''strength'' is a positive integer).</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;">'''(Requires CC1.51 and above)''' 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 / Minefactory Reloaded RedNet 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 / Minefactory Reloaded RedNet 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|number}} colors)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets one or multiple colored signals in a RedPower bundled / Minefactory Reloaded RedNet 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|number}} color)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns true if ''color'' is active in a RedPower bundled / Minefactory Reloaded RedNet cable attached to ''side''. Else, returns false.</td></tr>

</table>

:{|class="wikitable"
| ''[[Usage_of_the_bundled_cable_using_the_Redstone_API|Bundled cable code snippet. (You might want to take a look at this if you are doing bundledcable related things.)]]''
|}

== Data exchange ==
The redstone API can be used to exchange data between adjacent [[computer]]s and [[turtle]]s. Four bits of data can be transmitted and received with each use of analog input and output. One redstone signal can be sent at each tick [http://minecraft.gamepedia.com/Tick tick], and there are 20 ticks per second in minecraft. This limits data transmission over redstone to a maximum of 80 bits per second (bps).

This makes large-scale data transmission over the redstone API exceedingly slow. For example, using the redstone API, transmitting a colored bitmap image for a maximum [[resolution]] computercraft monitor cluster (162x80 pixels) would require 10 minutes and 48 seconds (this would be a 6.48 kB image). For reference, there are 16 colors available for monitors and terminals in computercraft, so a single color for a pixel can be represented in a 4-bit signal.

Nonetheless, the redstone API can be useful when other options are not available. For example, it can be used to allow [[turtle]]s to communicate with each other and coordinate their work even if they do not have [[Wireless Modem]]s.
[[Category:APIs]]

Os.time

2014-11-20T01:35:04Z

Turkey: /* Using the returned value */ Clarifying

{{lowercase}}
{{Function
|name=os.time
|returns={{type|number}} the current in-game time
|api=OS
|addon=ComputerCraft
|desc=Returns the current in-game time.
|examples=
{{Example
|desc=Prints current time in 12 hour format (with AM and PM).
|code=local time = '''os.time()'''
local formattedTime = [[textutils.formatTime]](time, false)

[[print]]("The time is " .. formattedTime)
}}
|notes=
* You should use [[textutils.formatTime]]() if you want to print the time in readable form.
}}

== Using the returned value ==
os.time() will return a value between 0.000 and 23.999. This corresponds to the day-night cycle of the server. Midnight is at 0.000 (when the cycle resets), while midday is at 12.000. 6.000 is the morning, when the player will wake up if they slept in a bed. The player can first get into [http://minecraft.gamepedia.com/Bed bed] for the night at 18.541.

Each full day/night cycle corresponds to 20 minutes (1,200 seconds) in real-life, or 24 'hours' on the os.time scale. Each 'hour' on the os.time scale is 50 seconds in real-life. After the decimal place, tenths represent 5 seconds, hundredths represent 0.5 seconds, and thousandths represent 0.05 seconds (one [http://minecraft.gamepedia.com/Tick tick]).

== Conversion ==

{|class=wikitable
!'''Minecraft ticks'''!!'''Real-time Equivalent'''!!'''Elapsed time'''!!'''os.time()'''
|-
|0||6:00||0:00||6.000
|-
|1000||7:00||0:50||7.000
|-
|2000||8:00||1:40||8.000
|-
|3000||9:00||2:30||9.000
|-
|4000||10:00||3:20||10.000
|-
|5000||11:00||4:10||11.000
|-
|6000||12:00||5:00||12.000
|-
|7000||13:00||5:50||13.000
|-
|8000||14:00||6:40||14.000
|-
|9000||15:00||7:30||15.000
|-
|10000||16:00||8:20||16.000
|-
|11000||17:00||9:10||17.000
|-
|12000||18:00||10:00||18.000
|-
|13000||19:00||10:50||19.000
|-
|14000||20:00||11:40||20.000
|-
|15000||21:00||12:30||21.000
|-
|16000||22:00||13:20||22.000
|-
|17000||23:00||14:10||23.000
|-
|18000||0:00||15:00||0.000
|-
|19000||1:00||15:50||1.000
|-
|20000||2:00||16:40||2.000
|-
|21000||3:00||17:30||3.000
|-
|22000||4:00||18:20||4.000
|-
|23000||5:00||19:10||5.000
|}

'''Minecraft ticks''' can be used in commands to set server time. For example, you can set the time to midnight by typing in {{Keypress|key=/time set 18000}}. The '''real-time equivalent''' shows what the time would look like if it were in real-life. '''Elapsed time''' indicates how many seconds would have elapsed from the point that your character gets of bed in the morning.

To convert os.time() to real-life seconds since the in-game midnight, you can multiply it by 50. Example:
<code>
local secondsSinceMidnight = os.time() * 50
</code>

To convert os.time() to minecraft ticks, multiply by 1,000, add 18,000, and then use a [http://www.lua.org/manual/5.1/manual.html#2.5.1 modulo] (%) to ensure the value is within 0 and 23999.
<code>
local MCTicks = (os.time() * 1000 + 18000)%24000
</code>

== See also ==
* [[os.clock]]
* [[os.day]]
* [http://minecraft.gamepedia.com/Day-night_cycle Minecraft day-night cycle]
* [http://minecraft.gamepedia.com/Tick Minecraft ticks]
* [http://minecraft.gamepedia.com/Bed Minecraft bed]

[[Category:Lua_Core_Functions]]

Os.time

2014-11-19T18:34:59Z

Turkey: /* Using the returned value */

{{lowercase}}
{{Function
|name=os.time
|returns={{type|number}} the current in-game time
|api=OS
|addon=ComputerCraft
|desc=Returns the current in-game time.
|examples=
{{Example
|desc=Prints current time in 12 hour format (with AM and PM).
|code=local time = '''os.time()'''
local formattedTime = [[textutils.formatTime]](time, false)

[[print]]("The time is " .. formattedTime)
}}
|notes=
* You should use [[textutils.formatTime]]() if you want to print the time in readable form.
}}

== Using the returned value ==
os.time() will return a value between 0.000 and 23.999. This corresponds to the day-night cycle of the server. Midnight is at 0.000 (when the cycle resets), while midday is at 12.000. 6.000 is the morning, when the player will wake up if they slept in a bed. The player can first get into [http://minecraft.gamepedia.com/Bed bed] for the night at 18.541.

Each full day/night cycle corresponds to 20 minutes (1,200 seconds) in real-life. Each 'hour' in minecraft is 50 seconds in real-life. Tenths are 5 seconds, hundredths are 0.5 seconds, and thousandths are 0.05 seconds (one [http://minecraft.gamepedia.com/Tick tick]).

== Conversion ==

{|class=wikitable
!'''Minecraft ticks'''!!'''Real-time Equivalent'''!!'''Elapsed time'''!!'''os.time()'''
|-
|0||6:00||0:00||6.000
|-
|1000||7:00||0:50||7.000
|-
|2000||8:00||1:40||8.000
|-
|3000||9:00||2:30||9.000
|-
|4000||10:00||3:20||10.000
|-
|5000||11:00||4:10||11.000
|-
|6000||12:00||5:00||12.000
|-
|7000||13:00||5:50||13.000
|-
|8000||14:00||6:40||14.000
|-
|9000||15:00||7:30||15.000
|-
|10000||16:00||8:20||16.000
|-
|11000||17:00||9:10||17.000
|-
|12000||18:00||10:00||18.000
|-
|13000||19:00||10:50||19.000
|-
|14000||20:00||11:40||20.000
|-
|15000||21:00||12:30||21.000
|-
|16000||22:00||13:20||22.000
|-
|17000||23:00||14:10||23.000
|-
|18000||0:00||15:00||0.000
|-
|19000||1:00||15:50||1.000
|-
|20000||2:00||16:40||2.000
|-
|21000||3:00||17:30||3.000
|-
|22000||4:00||18:20||4.000
|-
|23000||5:00||19:10||5.000
|}

'''Minecraft ticks''' can be used in commands to set server time. For example, you can set the time to midnight by typing in {{Keypress|key=/time set 18000}}. The '''real-time equivalent''' shows what the time would look like if it were in real-life. '''Elapsed time''' indicates how many seconds would have elapsed from the point that your character gets of bed in the morning.

To convert os.time() to real-life seconds since the in-game midnight, you can multiply it by 50. Example:
<code>
local secondsSinceMidnight = os.time() * 50
</code>

To convert os.time() to minecraft ticks, multiply by 1,000, add 18,000, and then use a [http://www.lua.org/manual/5.1/manual.html#2.5.1 modulo] (%) to ensure the value is within 0 and 23999.
<code>
local MCTicks = (os.time() * 1000 + 18000)%24000
</code>

== See also ==
* [[os.clock]]
* [[os.day]]
* [http://minecraft.gamepedia.com/Day-night_cycle Minecraft day-night cycle]
* [http://minecraft.gamepedia.com/Tick Minecraft ticks]
* [http://minecraft.gamepedia.com/Bed Minecraft bed]

[[Category:Lua_Core_Functions]]

Peripheral (API)

2014-11-09T04:06:14Z

Turkey: /* Computers */ Adding modems

{{msgbox
| text = This article is about the Peripheral API. For APIs exposed when wrapping peripherals through [[peripheral.wrap]]() see [[:Category:Peripheral_APIs|Peripheral APIs]].
}}

__TOC__
The Peripheral API is for interacting with [[peripheral]]s connected to the computer, such as the [[Disk Drive]], the [[Advanced Monitor]] and [[Monitor]]. (More peripherals can be found under [[:Category:Peripherals|here]]).

Each peripheral block has a name, or ''side''. Although peripherals can now be attached to a computer using networking cables, the word ''side'' is a holdover from when peripherals needed to be directly next to the computer.

If the peripheral is next to the computer, its side is either "front", "back", "left", "right", "top" or "bottom". If the peripheral is attached by a cable, its side will follow the format "''type''_''id''", for example "printer_0".

Peripheral functions are called '''methods''', a term borrowed from Java.

{{API table|Peripheral|image=Grid disk.png|2=

{{API table/row|[[peripheral.isPresent]]({{type|string}} side)|{{type|boolean}}|
Returns '''true''' if a peripheral is connected on ''side''.
|odd}}

{{API table/row|[[peripheral.getType]]({{type|string}} side)|{{type|string}} /{{type|nil}}|
Returns the type of peripheral connected on ''side'', as a string.
If no peripheral is connected, returns nil.
}}

{{API table/row|[[peripheral.getMethods]]({{type|string}} side)|{{type|table}} /{{type|nil}}|
Returns a list of the names of all the methods of the peripheral connected on ''side''.
If no peripheral is connected, returns nil.
|odd}}

{{API table/row|[[peripheral.call]]({{type|string}} side, {{type|string}} method, ...)|any|
Calls a method on a peripheral. The arguments (apart from ''side'' and ''method'') and the return values depend on the method being called.
If no peripheral is connected, returns nil.
}}

{{API table/row|[[peripheral.wrap]]({{type|string}} side)|{{type|table}} peripheral / {{type|nil}}|
Returns a table of functions, allowing you to call peripheral methods as if they were normal Lua functions.
If no peripheral is connected, returns nil.
|odd}}

{{API table/row|[[peripheral.find]]({{type|string}} type [, {{type|function}} fnFilter( name, object )])|{{type|table}} peripheral / {{type|nil}}|
Finds an attached peripheral of the given type and if found returns a table of functions, similar to [[peripheral.wrap]], allowing you to call peripheral methods as if they were normal Lua functions.
If no peripheral of the given type is connected, it returns nil. '''''Requires ComputerCraft 1.6 or later.'''''
|odd}}

{{API table/row|[[peripheral.getNames]]()|{{type|table}}|
This function returns a table of all the sides that have a peripheral present. If the present peripheral is a wired modem any names of the peripherals that is on the network are also added to the table.
|odd}}

}}

==Connecting peripherals using networking cables==
Using Networking Cables, you can attach and use peripherals without having them directly touching the computer. To connect a peripheral in this way, place a Wired Modem on any side of your computer, as you would a [[Wireless Modem]]. Place a Wired Modem on each peripheral you wish to connect, and then connect all of them with Networking Cables. Then right click each of the wired modems.

You should receive a message in your chat bar for each peripheral informing you of a successful connection, and the peripheral side.

==Monitor==
[[Monitor]] and [[Advanced Monitor]] peripheral functions can be found on the [[Term (API)]] page. Note that the [[Colors (API)|Colors API]] can also be useful for designing colors for use on an advanced monitor.

==Printer==
[[Printer#Printer API |Printer Peripheral functions]] have been moved to the [[Printer]] page.

==Computers==
[[Computer#Peripheral_Functions|Computer Peripheral functions]] have been moved to the [[Computer]] page.
In addition, the [[Advanced_Computer#Peripheral_Functions|Advanced Computer Peripheral functions]] have been moved to the [[Advanced Computer]] page.

==Modem==
[[Modem]] peripheral functions can be found on the [[Modem (API)]] page.

[[Category:APIs]]

Resolution

2014-11-07T16:53:40Z

Turkey: /* Computer resolution */ Adding resolution for turtles

'''Resolution''' refers to the number of pixels on a monitor, terminal, or other Computercraft user interface. Each '''pixel''' is a single rectangular patch of color, which can also contain a single letter of text.

== Monitor resolution ==
[[File:Computer_w_DiskDrive_w_Monitor.png|frame|428x241px|right|A 2x2 [[Monitor]], connected to a [[Computer]], with a [[Disk Drive]] connected.]]
[[Monitor]]s and [[Advanced Monitor]]s have variable resolution because of the borders of their screens, and because of the [[monitor.setTextScale]] function. This gives monitors potential for exceedingly high resolution when they are properly configured.

=== Default resolution ===
The default text scale for monitors is 1. Using the default text scale, a single monitor by itself has a resolution of 7 pixels horizontally by 5 pixels vertically. Resolution is increased when monitors are placed next to each other, both by using the extra monitors and by turning the borders between monitors into extra screen space. With the default text scale, monitor borders take up two pixels on the left and right sides, and one pixel on the top and bottom sides. The monitor in the middle of a 3x3 cluster of monitors would have a resolution of 11 pixels horizontally by 7 pixels vertically, while the whole cluster would have a total resolution of 29 pixels horizontally by 19 pixels vertically.

Using the default text scale, the largest possible monitor cluster (8 blocks wide and 6 blocks tall) has a total resolution of 70 pixels horizontally by 40 pixels vertically.

=== Enhanced resolution ===
The text scale of [[monitor.setTextScale]] can be increased or decreased in increments of 0.5, and the highest resolution setting is achieved when the text scale is set to 0.5. Under this setting, a single monitor by itself has a resolution of 15 pixels horizontally by 10 pixels vertically. At this scale, monitor borders take up three pixels on the left and right sides, and two pixels on the top and bottom sides.

Using the 0.5 text scale for maximum resolution, the largest possible monitor cluster has a total resolution of 162 pixels horizontally by 80 pixels vertically.

Note that the setTextScale function also changes the resolution of pixels drawn with the [[paintutils (API)|paintutils API]], so the function is more powerful than its name suggests.

== Turtle resolution ==
Interfaces for [[Turtle]]s and [[Advanced Turtle]]s have a resolution of 39 pixels horizontally by 13 pixels vertically.

== Computer resolution ==
[[Computer]]s and [[Advanced Computer]]s have a resolution of 51 pixels horizontally by 19 pixels vertically.

== Pocket computer resolution ==
[[Pocket Computer]]s have a resolution of 26 pixels horizontally by 19 pixels vertically.

== See also ==
* [[Term (API)]]
* [[Paintutils (API)]]
* [[CCLights2]] (Third-party graphics peripheral for OpenGL rendering with its own monitors.)
* [[CCGPU]] (Third-party graphics peripheral for OpenGL rendering. Has its own monitor.)

[[Category:Consoles]]
[[Category:Tutorials‏‎]]

Resolution

2014-11-07T16:50:26Z

Turkey:

'''Resolution''' refers to the number of pixels on a monitor, terminal, or other Computercraft user interface. Each '''pixel''' is a single rectangular patch of color, which can also contain a single letter of text.

== Monitor resolution ==
[[File:Computer_w_DiskDrive_w_Monitor.png|frame|428x241px|right|A 2x2 [[Monitor]], connected to a [[Computer]], with a [[Disk Drive]] connected.]]
[[Monitor]]s and [[Advanced Monitor]]s have variable resolution because of the borders of their screens, and because of the [[monitor.setTextScale]] function. This gives monitors potential for exceedingly high resolution when they are properly configured.

=== Default resolution ===
The default text scale for monitors is 1. Using the default text scale, a single monitor by itself has a resolution of 7 pixels horizontally by 5 pixels vertically. Resolution is increased when monitors are placed next to each other, both by using the extra monitors and by turning the borders between monitors into extra screen space. With the default text scale, monitor borders take up two pixels on the left and right sides, and one pixel on the top and bottom sides. The monitor in the middle of a 3x3 cluster of monitors would have a resolution of 11 pixels horizontally by 7 pixels vertically, while the whole cluster would have a total resolution of 29 pixels horizontally by 19 pixels vertically.

Using the default text scale, the largest possible monitor cluster (8 blocks wide and 6 blocks tall) has a total resolution of 70 pixels horizontally by 40 pixels vertically.

=== Enhanced resolution ===
The text scale of [[monitor.setTextScale]] can be increased or decreased in increments of 0.5, and the highest resolution setting is achieved when the text scale is set to 0.5. Under this setting, a single monitor by itself has a resolution of 15 pixels horizontally by 10 pixels vertically. At this scale, monitor borders take up three pixels on the left and right sides, and two pixels on the top and bottom sides.

Using the 0.5 text scale for maximum resolution, the largest possible monitor cluster has a total resolution of 162 pixels horizontally by 80 pixels vertically.

Note that the setTextScale function also changes the resolution of pixels drawn with the [[paintutils (API)|paintutils API]], so the function is more powerful than its name suggests.

== Computer resolution ==
[[Computer]]s and [[Advanced Computer]]s have a resolution of 51 pixels horizontally by 19 pixels vertically.

== Pocket computer resolution ==
[[Pocket Computer]]s have a resolution of 26 pixels horizontally by 19 pixels vertically.

== See also ==
* [[Term (API)]]
* [[Paintutils (API)]]
* [[CCLights2]] (Third-party graphics peripheral for OpenGL rendering with its own monitors.)
* [[CCGPU]] (Third-party graphics peripheral for OpenGL rendering. Has its own monitor.)

[[Category:Consoles]]
[[Category:Tutorials‏‎]]

Paint

2014-09-22T10:44:02Z

Turkey: Adding the code for the paint program

[[File:AdvancedComputerPaint.png|frame|right|An advanced computer running Paint, an exclusive program]]

Paint is a program, created by NitrogenFingers, added in ComputerCraft 1.45. It requires an [[Advanced Computer]], and is used for making images that may be drawn later with the [[Paintutils_(API)|paintutils library]]. This program, along with Advanced Computers is NOT available in Tekkit Classic.

Running paint on a monitor requires using an advanced monitor. For instructions, see [[monitor (program)]].

== Code ==
The paint program uses the following code:

<code>
-- Paint created by nitrogenfingers (edited by dan200)
-- http://www.youtube.com/user/NitrogenFingers

------------
-- Fields --
------------

-- The width and height of the terminal
local w,h = term.getSize()

-- The selected colours on the left and right mouse button, and the colour of the canvas
local leftColour, rightColour = colours.white, nil
local canvasColour = colours.black

-- The values stored in the canvas
local canvas = {}

-- The menu options
local mChoices = { "Save","Exit" }

-- The message displayed in the footer bar
local fMessage = "Press Ctrl to access menu"

-------------------------
-- Initialisation --
-------------------------

-- Determine if we can even run this
if not term.isColour() then
print("Requires an Advanced Computer")
return
end

-- Determines if the file exists, and can be edited on this computer
local tArgs = {...}
if #tArgs == 0 then
print("Usage: paint <path>")
return
end
local sPath = shell.resolve(tArgs[1])
local bReadOnly = fs.isReadOnly(sPath)
if fs.exists(sPath) and fs.isDir(sPath) then
print("Cannot edit a directory.")
return
end

---------------
-- Functions --
---------------

local function getCanvasPixel( x, y )
if canvas[y] then
return canvas[y][x]
end
return nil
end

--[[
Converts a colour value to a text character
params: colour = the number to convert to a hex value
returns: a string representing the chosen colour
]]
local function getCharOf( colour )
-- Incorrect values always convert to nil
if type(colour) == "number" then
local value = math.floor( math.log(colour) / math.log(2) ) + 1
if value >= 1 and value <= 16 then
return string.sub( "0123456789abcdef", value, value )
end
end
return " "
end

--[[
Converts a text character to colour value
params: char = the char (from string.byte) to convert to number
returns: the colour number of the hex value
]]
local tColourLookup = {}
for n=1,16 do
tColourLookup[ string.byte( "0123456789abcdef",n,n ) ] = 2^(n-1)
end
local function getColourOf( char )
-- Values not in the hex table are transparent (canvas coloured)
return tColourLookup[char]
end

--[[
Loads the file into the canvas
params: path = the path of the file to open
returns: nil
]]
local function load(path)
-- Load the file
if fs.exists(path) then
local file = fs.open(sPath, "r")
local sLine = file.readLine()
while sLine do
local line = {}
for x=1,w-2 do
line[x] = getColourOf( string.byte(sLine,x,x) )
end
table.insert( canvas, line )
sLine = file.readLine()
end
file.close()
end
end

--[[
Saves the current canvas to file
params: path = the path of the file to save
returns: true if save was successful, false otherwise
]]
local function save(path)
-- Open file
local sDir = string.sub(sPath, 1, #sPath - #fs.getName(sPath))
if not fs.exists(sDir) then
fs.makeDir(sDir)
end

local file = fs.open( path, "w" )
if not file then
return false
end

-- Encode (and trim)
local tLines = {}
local nLastLine = 0
for y=1,h-1 do
local sLine = ""
local nLastChar = 0
for x=1,w-2 do
local c = getCharOf( getCanvasPixel( x, y ) )
sLine = sLine .. c
if c ~= " " then
nLastChar = x
end
end
sLine = string.sub( sLine, 1, nLastChar )
tLines[y] = sLine
if string.len( sLine ) > 0 then
nLastLine = y
end
end

-- Save out
for n=1,nLastLine do
file.writeLine( tLines[ n ] )
end
file.close()
return true
end

--[[
Draws colour picker sidebar, the pallette and the footer
returns: nil
]]
local function drawInterface()
-- Footer
term.setCursorPos(1, h)
term.setBackgroundColour(colours.black)
term.setTextColour(colours.yellow)
term.clearLine()
term.write(fMessage)

-- Colour Picker
for i=1,16 do
term.setCursorPos(w-1, i)
term.setBackgroundColour( 2^(i-1) )
term.write(" ")
end

term.setCursorPos(w-1, 17)
term.setBackgroundColour( canvasColour )
term.setTextColour( colours.grey )
term.write("XX")

-- Left and Right Selected Colours
for i=18,18 do
term.setCursorPos(w-1, i)
if leftColour ~= nil then
term.setBackgroundColour( leftColour )
term.write(" ")
else
term.setBackgroundColour( canvasColour )
term.setTextColour( colours.grey )
term.write("X")
end
if rightColour ~= nil then
term.setBackgroundColour( rightColour )
term.write(" ")
else
term.setBackgroundColour( canvasColour )
term.setTextColour( colours.grey )
term.write("X")
end
end

-- Padding
term.setBackgroundColour( canvasColour )
for i=20,h-1 do
term.setCursorPos(w-1, i)
term.write(" ")
end
end

--[[
Converts a single pixel of a single line of the canvas and draws it
returns: nil
]]
local function drawCanvasPixel( x, y )
local pixel = getCanvasPixel( x, y )
if pixel then
term.setBackgroundColour( pixel or canvasColour )
term.setCursorPos(x, y)
term.write(" ")
else
term.setBackgroundColour( canvasColour )
term.setTextColour( colours.grey )
term.setCursorPos(x, y)
term.write("-")
end
end

--[[
Converts each colour in a single line of the canvas and draws it
returns: nil
]]
local function drawCanvasLine( y )
for x = 1, w-2 do
drawCanvasPixel( x, y )
end
end

--[[
Converts each colour in the canvas and draws it
returns: nil
]]
local function drawCanvas()
for y = 1, h-1 do
drawCanvasLine( y )
end
end

--[[
Draws menu options and handles input from within the menu.
returns: true if the program is to be exited; false otherwise
]]
local function accessMenu()
-- Selected menu option
local selection = 1

term.setBackgroundColour(colours.black)
while true do
-- Draw the menu
term.setCursorPos(1,h)
term.clearLine()
term.setTextColour(colours.white)
for k,v in pairs(mChoices) do
if selection==k then
term.setTextColour(colours.yellow)
local ox,_ = term.getCursorPos()
term.write("["..string.rep(" ",#v).."]")
term.setCursorPos(ox+1,h)
term.setTextColour(colours.white)
term.write(v)
term.setCursorPos(term.getCursorPos()+1,h)
else
term.write(" "..v.." ")
end
end

-- Handle input in the menu
local id,key = os.pullEvent("key")
if id == "key" then
-- S and E are shortcuts
if key == keys.s then
selection = 1
key = keys.enter
elseif key == keys.e then
selection = 2
key = keys.enter
end

if key == keys.right then
-- Move right
selection = selection + 1
if selection > #mChoices then
selection = 1
end

elseif key == keys.left and selection > 1 then
-- Move left
selection = selection - 1
if selection < 1 then
selection = #mChoices
end

elseif key == keys.enter then
-- Select an option
if mChoices[selection]=="Save" then
if bReadOnly then
fMessage = "Access Denied"
return false
end
local success = save(sPath)
if success then
fMessage = "Saved to "..sPath
else
fMessage = "Error saving to "..sPath
end
return false
elseif mChoices[selection]=="Exit" then
return true
end
elseif key == keys.leftCtrl or keys == keys.rightCtrl then
-- Cancel the menu
return false
end
end
end
end

--[[
Runs the main thread of execution. Draws the canvas and interface, and handles
mouse and key events.
returns: nil
]]
local function handleEvents()
local programActive = true
while programActive do
local id,p1,p2,p3 = os.pullEvent()
if id=="mouse_click" or id=="mouse_drag" then
if p2 >= w-1 and p3 >= 1 and p3 <= 17 then
if id ~= "mouse_drag" then
-- Selecting an items in the colour picker
if p3 <= 16 then
if p1==1 then
leftColour = 2^(p3-1)
else
rightColour = 2^(p3-1)
end
else
if p1==1 then
leftColour = nil
else
rightColour = nil
end
end
--drawCanvas()
drawInterface()
end
elseif p2 < w-1 and p3 <= h-1 then
-- Clicking on the canvas
local paintColour = nil
if p1==1 then
paintColour = leftColour
elseif p1==2 then
paintColour = rightColour
end
if not canvas[p3] then
canvas[p3] = {}
end
canvas[p3][p2] = paintColour

drawCanvasPixel( p2, p3 )
end
elseif id=="key" then
if p1==keys.leftCtrl or p1==keys.rightCtrl then
programActive = not accessMenu()
drawInterface()
end
elseif id=="term_resize" then
w,h = term.getSize()
drawCanvas()
drawInterface()
end
end
end

-- Init
load(sPath)
drawCanvas()
drawInterface()

-- Main loop
handleEvents()

-- Shutdown
term.setBackgroundColour(colours.black)
term.setTextColour(colours.white)
term.clear()
term.setCursorPos(1,1)
</code>

[[Category:Programs]]

Monitor.setTextScale

2014-09-22T01:44:48Z

Turkey: Adding a note about the impact of setTextScale on paintutils

{{lowercase}}
{{Function
|name=monitor.setTextScale
|args={{type|number}} scale
|api=Term
|addon=ComputerCraft
|desc=Sets the size of all text on the monitor. scale can be any multiple of 0.5, starting at 0.5 and ending at 5. Also changes the size of pixels drawn by the [[paintutils (API)|paintutils API]].
|examples=
{{Example
|desc=Sets the monitor's text scale to 2.
|code=local monitor = [[peripheral.wrap]]("left")
monitor.setTextScale(2)
}}
}}

[[Category:API_Functions]]

Resolution

2014-09-22T01:43:21Z

Turkey: /* Enhanced resolution */ Adding a note about the impact of setTextScale on paintutils

'''Resolution''' refers to the number of on a monitor, terminal, or other Computercraft user interface. Each '''pixel''' is a single rectangular patch of color, which can also contain a single letter of text.

== Monitor resolution ==
[[File:Computer_w_DiskDrive_w_Monitor.png|frame|428x241px|right|A 2x2 [[Monitor]], connected to a [[Computer]], with a [[Disk Drive]] connected.]]
[[Monitor]]s and [[Advanced Monitor]]s have variable resolution because of the borders of their screens, and because of the [[monitor.setTextScale]] function. This gives monitors potential for exceedingly high resolution when they are properly configured.

=== Default resolution ===
The default text scale for monitors is 1. Using the default text scale, a single monitor by itself has a resolution of 7 pixels horizontally by 5 pixels vertically. Resolution is increased when monitors are placed next to each other, both by using the extra monitors and by turning the borders between monitors into extra screen space. With the default text scale, monitor borders take up two pixels on the left and right sides, and one pixel on the top and bottom sides. The monitor in the middle of a 3x3 cluster of monitors would have a resolution of 11 pixels horizontally by 7 pixels vertically, while the whole cluster would have a total resolution of 29 pixels horizontally by 19 pixels vertically.

Using the default text scale, the largest possible monitor cluster (8 blocks wide and 6 blocks tall) has a total resolution of 70 pixels horizontally by 40 pixels vertically.

=== Enhanced resolution ===
The text scale of [[monitor.setTextScale]] can be increased or decreased in increments of 0.5, and the highest resolution setting is achieved when the text scale is set to 0.5. Under this setting, a single monitor by itself has a resolution of 15 pixels horizontally by 10 pixels vertically. At this scale, monitor borders take up three pixels on the left and right sides, and two pixels on the top and bottom sides.

Using the 0.5 text scale for maximum resolution, the largest possible monitor cluster has a total resolution of 162 pixels horizontally by 80 pixels vertically.

Note that the setTextScale function also changes the resolution of pixels drawn with the [[paintutils (API)|paintutils API]], so the function is more powerful than its name suggests.

== Computer resolution ==
[[Computer]]s and [[Advanced Computer]]s have a resolution of 51 pixels horizontally by 19 pixels vertically.

== Pocket computer resolution ==
[[Pocket Computer]]s have a resolution of 26 pixels horizontally by 19 pixels vertically.

== See also ==
* [[Term (API)]]
* [[Paintutils (API)]]
* [[CCLights2]] (Third-party graphics peripheral for OpenGL rendering with its own monitors.)
* [[CCGPU]] (Third-party graphics peripheral for OpenGL rendering. Has its own monitor.)

[[Category:Consoles]]
[[Category:Tutorials‏‎]]

Tutorials

2014-09-16T02:45:33Z

Turkey: /* Basic Tutorials */ Adding advanced tutorials section with classes

As some tutorials might not be listed here, you can also browse the [[:Category:Tutorials|tutorials category]].

== Basic Tutorials ==
These tutorials are designed to be used in the order shown, each tutorial will build on the previous ones.
=== Introduction to Coding ===
*[[Hello_World_Tutorial|Hello World!]]
*[[Variables]]
*[[Conditional_statements|If, Then, Else]]
*[[Function (type)|Functions]]
*[[Loops]]
*[[Tables]]

== Advanced Tutorials ==
These tutorials cover more advanced topics which can be useful but are not strictly necessary for simple projects.

*[[Class]]es

== Example Programs ==
These pages guide you through programs created by other users. They are not necessarily well-coded, but can be useful as a loose guide.

=== Programming & Wiring ===
*[[Guess_The_Number_(tutorial)|Guess the Number]]
*[[Making_a_Password_Protected_Door|Password Protected Door]]
*[[Making_an_API_(tutorial)|Programming an API]]
*[[Startup|Running script automatically at boot with Startup]]
*[[Raw key events| Detecting specific keys (such as the arrow keys)]]
*[[Receiving a rednet message through os.pullEvent()|Receiving a rednet message through os.pullEvent()]]
*[[Calculator Tutorial]]
*[[Rednet Tutorial]].
*[[Usage of the bundled cable using the Redstone API]]

=== Turtles ===
The nice little robots that do the hard work for you.
*[[Turtle_Tutorial|Turtles!]]
*[[Turtle_Lumberjack_(tutorial)|Turtle Lumberjack]]
*[[Advanced_Turtle_Lumberjack_(tutorial)|Advanced Turtle Lumberjack]]
*[[Cobble_Generator|Cobblestone Generator]]
*[[Turtle_Stairbuilder_(tutorial)|Turtle Stairbuilder]]

== External Tutorials/Guides ==
*[http://www.minecraftforum.net/topic/907632-mod-tutorial-computercraft-v12-very-basic-lua-tutorial-updated-1112/page__p__11556908#entry11556908 Onionnion's Basic Lua Tutorial]
*[http://www.computercraft.info/forums2/index.php?/topic/1516-ospullevent-what-is-it-and-how-is-it-useful/page__view__findpost__p__11156 Onionnion's os.pullEvent() Guide]
*[http://wiki.roblox.com/ Roblox Wiki (Has tutorials on Lua)]
*[http://www.lua.org/pil/contents.html Programming in Lua, a general purpose guidebook written by a programmer that writes the Lua interpreter]

[[Category:Tutorials]]

Prototype

2014-09-16T02:41:56Z