https://www.computercraft.info/wiki/api.php?action=feedcontributions&feedformat=atom&user=Watcher7ComputerCraft Wiki - User contributions [en]2026-07-11T07:56:29ZUser contributionsMediaWiki 1.24.1https://www.computercraft.info/wiki/index.php?title=OS_(API)&diff=5823OS (API)2013-07-12T02:05:01Z<p>Watcher7: Changed nonexistent type int to type number. Changed nonexistent type float to type number. Fixed inconsistent spacing of parentheses around arguments.</p>
<hr />
<div>The Operating System API allows for interfacing with the Lua based Operating System itself.<br />
<br />
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;"><br />
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;"><br />
[[File:Grid_disk.png|24px]]&nbsp;&nbsp;<br />
OS (API)<br />
</td></tr><br />
<br />
<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><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.version]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the version of the OS the computer is running.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.getComputerID]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the unique ID of this computer. [[os.computerID]]() also behaves exactly the same as [[os.getComputerID]]().</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.getComputerLabel]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the label of this computer. [[os.computerLabel]]() also behaves exactly the same as [[os.getComputerLabel]]().</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.setComputerLabel]]({{type|string}} label)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Set the label of this computer.</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.run]]({{type|table}} environment, {{type|string}} program path [, {{type|string}} arguments])</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">An advanced way of starting programs. A started program will have a given <var>environment</var> table which determines what functions it has available, as well as any variables it will be able to access by default. You may prefer to use the [[Shell (API)]] unless you need to do something special.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[#APIs|os.loadAPI]]({{type|string}} name)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Loads a Lua script as an API in its own namespace (see example). It will be available to '''all''' programs that run on the terminal.</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[#APIs|os.unloadAPI]]({{type|string}} name)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Unloads a previously loaded API.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[Os.pullEvent|os.pullEvent]]({{type|string}} target-event)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Blocks until the computer receives an event, or if <var>target-event</var> is specified, will block until an instance of <var>target-event</var> occurs. [[Os.pullEvent|os.pullEvent]](target-event) returns the event and any parameters the event may have. If a <var>target-event</var> is specified, the computer will not break for any other events (except termination).</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[#pullEvent|os.pullEventRaw]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Advanced version of pullEvent(). [[#pullEvent|os.pullEventRaw]]() will block until an event occurs, and then returns the event (any any parameters the event may have). Unlike [[Os.pullEvent|os.pullEvent]](target-event), this function will not break for system events, and can be used to handle termination events.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.queueEvent]]({{type|string}} event, param1, param2, ...)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Adds an event to the event queue with the name <var>event</var> and the given parameters</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.clock]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns CPU time.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.startTimer]]({{Type|number}} timeout)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Queues an event to be triggered after a number of seconds (<var>timeout</var>). The ID of the timer is returned from this function to differentiate multiple timers. Timers are one-shot; once they have fired an event you will need to start another one if you need a recurring timer.</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.sleep]]({{Type|number}} timeout)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Makes the system wait a number of seconds before continuing in the program. [[os.sleep]](timeout) may also be used as simply "sleep( timeout )".</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.time]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current Minecraft world time.</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.day]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the current Minecraft day.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.setAlarm]]({{Type|number}} time)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Queues an event to be triggered at the specified Minecraft world <var>time</var>.</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.shutdown]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Turns off the computer.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[os.reboot]]()</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Reboots the computer.</td></tr><br />
</table><br />
<br />
<br />
[[Category:APIs]]<br />
<br />
== APIs ==<br />
<br />
APIs are Lua files which are loaded into the OS itself, and expose functions which other programs may use. The stock [[:Category:APIs|APIs]] that ship with ComputerCraft are loaded in this way, and may be replaced by a computer’s user or programs.<br />
<br />
The following is an example of a valid implementation of an API, and its usage after being registered:<br />
<code><br />
-- "apiTest" file<br />
function foo(bar)<br />
print(bar)<br />
end<br />
<br />
-- "program" file<br />
os.loadAPI("apiTest")<br />
apiTest.foo("this is a test")<br />
</code><br />
<br />
== <div id="pullEvent">os.pullEvent()</div> ==<br />
<br />
os.pullEvent() causes the current program to pause, retrieving the next event from the computer's queue of events. If there is no event to read, then the program will stall until such an event becomes available. Note that if a program has not attempted to pull an event in the past ten seconds, it will be forcefully terminated to prevent CPU waste in SMP environments.<br />
<br />
os.pullEvent() returns the name of the event that was read, as well as up to five parameters:<br />
<code><br />
local event, p1, p2, p3, p4, p5 = os.pullEvent()<br />
</code><br />
<br />
os.pullEvent() is usually run inside a 'while true do' loop.<br />
<br />
An advanced version of this method <code>os.pullEventRaw</code> bypasses the normal handling of events from the OS. You may use this to act on the "Terminate" event (triggered when holding Ctrl-T) for custom termination logic.</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Keys.getName&diff=5822Keys.getName2013-07-12T01:59:03Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=keys.getName<br />
|args={{Type|number}} code<br />
|api=keys<br />
|returns={{type|string}} the name of the key, or [[nil]] if not a valid key code<br />
|addon=ComputerCraft<br />
|desc=Translates a numerical key code to a human-readable name. The human-readable name is one of the constants in the [[Keys (API)|keys API]].<br />
|examples=<br />
{{Example<br />
|desc=Look up the name of key code 42.<br />
|code=print(keys.getName(42))<br />
|output=leftShift<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Keys_(API)&diff=5821Keys (API)2013-07-12T01:58:34Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>The Keys API provides a table of numerical codes corresponding to keyboard keys, suitable for decoding [[Key (event)|key events]].<br />
<br />
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;"><br />
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;"><br />
[[File:Grid_disk.png|24px]]&nbsp;&nbsp;<br />
keys (API)<br />
</td></tr><br />
<br />
<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><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{type|string}} keyName</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[keys.getName]]({{Type|number}} code)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Translates a numerical key code to a human-readable name.</td></tr><br />
<br />
</table><br />
<br />
Although this API contains only one method, it also contains a vast number of constants, one per key, containing the numerical key codes for those keys. As of ComputerCraft 1.52, the following constants are defined:<br />
* a<br />
* b<br />
* c<br />
* d<br />
* e<br />
* f<br />
* g<br />
* h<br />
* i<br />
* j<br />
* k<br />
* l<br />
* m<br />
* n<br />
* o<br />
* p<br />
* q<br />
* r<br />
* s<br />
* t<br />
* u<br />
* v<br />
* w<br />
* x<br />
* y<br />
* z<br />
* one<br />
* two<br />
* three<br />
* four<br />
* five<br />
* six<br />
* seven<br />
* eight<br />
* nine<br />
* zero<br />
* minus<br />
* equals<br />
* backspace<br />
* tab<br />
* leftBracket<br />
* rightBracket<br />
* enter<br />
* leftCtrl<br />
* semiColon<br />
* apostrophe<br />
* grave<br />
* leftShift<br />
* backslash<br />
* comma<br />
* period<br />
* slash<br />
* rightShift<br />
* multiply<br />
* leftAlt<br />
* space<br />
* capsLock<br />
* f1<br />
* f2<br />
* f3<br />
* f4<br />
* f5<br />
* f6<br />
* f7<br />
* f8<br />
* f9<br />
* f10<br />
* numLock<br />
* scollLock<br />
* numPad7<br />
* numPad8<br />
* numPad9<br />
* numPadSubtract<br />
* numPad4<br />
* numPad5<br />
* numPad6<br />
* numPadAdd<br />
* numPad1<br />
* numPad2<br />
* numPad3<br />
* numPad0<br />
* numPadDecimal<br />
* f11<br />
* f12<br />
* f13<br />
* f14<br />
* f15<br />
* kana<br />
* convert<br />
* noconvert<br />
* yen<br />
* numPadEquals<br />
* cimcumflex<br />
* at<br />
* colon<br />
* underscore<br />
* kanji<br />
* stop<br />
* ax<br />
* numPadEnter<br />
* rightCtrl<br />
* numPadComma<br />
* numPadDivide<br />
* rightAlt<br />
* pause<br />
* home<br />
* up<br />
* pageUp<br />
* left<br />
* right<br />
* end<br />
* down<br />
* pageDown<br />
* insert<br />
* delete<br />
<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.tonumb&diff=5820Bit.tonumb2013-07-12T01:53:48Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
<br />
{{Deprecated<br />
|type=This function<br />
|version=1.42<br />
}}<br />
<br />
{{Function<br />
|name=bit.tonumb<br />
|args={{Type|table}} bit_tbl<br />
|api=bit<br />
|returns={{Type|number}} the number resulting from the conversion of <var>bit_tbl</var> from binary<br />
|addon=ComputerCraft<br />
|desc=Converts an array (numerically-indexed table) containing binary bit values to a number (the inverse of [[bit.tobits]])<br />
|examples=<br />
{{Example<br />
|desc=Convert the binary representation 10010 into its corresponding value, 18<br />
|code=t = {}<br>t[1] = 0<br>t[2] = 1<br>t[3] = 0<br>t[4] = 0<br>t[5] = 1<br>print(bit.tonumb(t))<br />
|output=18<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.tobits&diff=5819Bit.tobits2013-07-12T01:52:03Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
<br />
{{Deprecated<br />
|type=This function<br />
}}<br />
<br />
{{Function<br />
|name=bit.tobits<br />
|args={{Type|number}} n<br />
|api=bit<br />
|returns={{Type|table}} the bits making up the value <var>n</var>, with entries up to the most-significant 1 bit in <var>n</var><br />
|addon=ComputerCraft<br />
|desc=Converts a number to an array (numerically-indexed table) containing the corresponding binary bit values (the inverse of [[bit.tonumb]])<br />
|examples=<br />
{{Example<br />
|desc=Convert the number 18 into its binary representation (10010)<br />
|code=for k, v in pairs(bit.tobits(18)) do print(k, ", ", v) end<br />
|output=1, 0<br>2, 1<br>3, 0<br>4, 0<br>5, 1<br />
}}<br />
}}<br />
As of ComputerCraft 1.42 the bit library has moved to Java code, and as such this function is no longer required or included.<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.bnot&diff=5818Bit.bnot2013-07-12T01:51:14Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=bit.bnot<br />
|args={{Type|number}} n<br />
|api=bit<br />
|returns={{Type|number}} the value of NOT <var>n</var><br />
|addon=ComputerCraft<br />
|desc=Computes the bitwise NOT of a number, taken in the domain and range of 32-bit unsigned integers<br />
|examples=<br />
{{Example<br />
|desc=NOT the number 18 (10010), yielding 4294967277 (11111111111111111111111111101101, 32 bits in length)<br />
|code=print(bit.bnot(18))<br />
|output=4294967277<br />
}}<br />
}}<br />
<br />
== Explanation ==<br />
All bit operations operate in binary numeral system [http://en.wikipedia.org/wiki/Binary_numeral_system]. A NOT operation yields a 1 if its input is 0 and a 0 if its input is 1. This function produces an output by computing the NOT of each bit of its input independently. So, for the example above:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Bit index:<br />
| 31<br />
| 30<br />
| 29<br />
| 28<br />
| 27<br />
| 26<br />
| 25<br />
| 24<br />
| 23<br />
| 22<br />
| 21<br />
| 20<br />
| 19<br />
| 18<br />
| 17<br />
| 16<br />
| 15<br />
| 14<br />
| 13<br />
| 12<br />
| 11<br />
| 10<br />
| 9<br />
| 8<br />
| 7<br />
| 6<br />
| 5<br />
| 4<br />
| 3<br />
| 2<br />
| 1<br />
| 0<br />
|-<br />
! Input (18):<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 0<br />
| 1<br />
| 0<br />
| 0<br />
| 1<br />
| 0<br />
|-<br />
! Output (4294967277):<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 1<br />
| 0<br />
| 1<br />
| 1<br />
| 0<br />
| 1<br />
|}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.band&diff=5817Bit.band2013-07-12T01:36:55Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=bit.band<br />
|args={{Type|number}} m, {{Type|number}} n<br />
|api=bit<br />
|returns={{Type|number}} the value of <var>m</var> AND <var>n</var><br />
|addon=ComputerCraft<br />
|desc=Computes the bitwise AND of two numbers<br />
|examples=<br />
{{Example<br />
|desc=AND the number 18 (10010) with the number 3 (00011), yielding 2 (00010)<br />
|code=print(bit.band(18, 3))<br />
|output=2<br />
}}<br />
}}<br />
<br />
== Explanation ==<br />
All bit operations operate in binary numeral system [http://en.wikipedia.org/wiki/Binary_numeral_system]. An AND operation between two bits yields a 1 if the bits are both 1 and a 0 if either of the bits is 0. This function produces an output by computing the AND of each bit of its two inputs independently. So, for the example above:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Bit index:<br />
| 4<br />
| 3<br />
| 2<br />
| 1<br />
| 0<br />
|-<br />
! Input 1 (18):<br />
| 1<br />
| 0<br />
| 0<br />
| 1<br />
| 0<br />
|-<br />
! Input 2 (3):<br />
| 0<br />
| 0<br />
| 0<br />
| 1<br />
| 1<br />
|-<br />
! Calculation:<br />
| 3 has a 0<br />
| Both 0<br />
| Both 0<br />
| Both 1<br />
| 18 has a 0<br />
|-<br />
! Output (2):<br />
| 0<br />
| 0<br />
| 0<br />
| 1<br />
| 0<br />
|}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.bor&diff=5816Bit.bor2013-07-12T01:34:13Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=bit.bor<br />
|args={{Type|number}} m, {{Type|number}} n<br />
|api=bit<br />
|returns={{Type|number}} the value of <var>m</var> OR <var>n</var><br />
|addon=ComputerCraft<br />
|desc=Computes the bitwise inclusive OR of two numbers<br />
|examples=<br />
{{Example<br />
|desc=OR the number 18 (10010) with the number 3 (00011), yielding 19 (10011)<br />
|code=print(bit.bor(18, 3))<br />
|output=19<br />
}}<br />
}}<br />
<br />
== Explanation ==<br />
All bit operations operate in binary numeral system [http://en.wikipedia.org/wiki/Binary_numeral_system]. An inclusive OR operation between two bits yields a 1 if either of the bits is 1 and a 0 if they are both 0. This function produces an output by computing the OR of each bit of its two inputs independently. So, for the example above:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Bit index:<br />
| 4<br />
| 3<br />
| 2<br />
| 1<br />
| 0<br />
|-<br />
! Input 1 (18):<br />
| 1<br />
| 0<br />
| 0<br />
| 1<br />
| 0<br />
|-<br />
! Input 2 (3):<br />
| 0<br />
| 0<br />
| 0<br />
| 1<br />
| 1<br />
|-<br />
! Calculation:<br />
| 18 has a 1<br />
| Both 0<br />
| Both 0<br />
| Both 1<br />
| 3 has a 1<br />
|-<br />
! Output (19):<br />
| 1<br />
| 0<br />
| 0<br />
| 1<br />
| 1<br />
|}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.bxor&diff=5815Bit.bxor2013-07-12T01:21:30Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=bit.bxor<br />
|args={{Type|number}} m, {{Type|number}} n<br />
|api=bit<br />
|returns={{Type|number}} the value of <var>m</var> XOR <var>n</var><br />
|addon=ComputerCraft<br />
|desc=Computes the bitwise exclusive OR of two numbers<br />
|examples=<br />
{{Example<br />
|desc=XOR the number 18 (10010) with the number 3 (00011), yielding 17 (10001)<br />
|code=print(bit.bxor(18, 3))<br />
|output=17<br />
}}<br />
}}<br />
<br />
== Explanation ==<br />
All bit operations operate in binary numeral system [http://en.wikipedia.org/wiki/Binary_numeral_system]. An exclusive OR operation between two bits yields a 1 if the bits are unequal and a 0 if they are equal. This function produces an output by computing the XOR of each bit of its two inputs independently. So, for the example above:<br />
<br />
{| class="wikitable"<br />
|-<br />
! Bit index:<br />
| 4<br />
| 3<br />
| 2<br />
| 1<br />
| 0<br />
|-<br />
! Input 1 (18):<br />
| 1<br />
| 0<br />
| 0<br />
| 1<br />
| 0<br />
|-<br />
! Input 2 (3):<br />
| 0<br />
| 0<br />
| 0<br />
| 1<br />
| 1<br />
|-<br />
! Calculation:<br />
| 1 ≠ 0<br />
| 0 = 0<br />
| 0 = 0<br />
| 1 = 1<br />
| 0 ≠ 1<br />
|-<br />
! Output (17):<br />
| 1<br />
| 0<br />
| 0<br />
| 0<br />
| 1<br />
|}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.blogic_rshift&diff=5814Bit.blogic rshift2013-07-12T01:16:54Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=bit.blogic_rshift<br />
|args={{Type|number}} n, {{Type|number}} bits<br />
|api=bit<br />
|returns={{Type|number}} the value of <var>n</var> shifted right by <var>bits</var> bits, with the shifted-in bits all being zero, which is equivalent to ⌊<var>n</var>÷2<sup><var>bits</var></sup>⌋ for nonnegative numbers<br />
|addon=ComputerCraft<br />
|desc=Shifts a number right logically by a specified number of bits<br />
|examples=<br />
{{Example<br />
|desc=Shift the number 73 (1001001) right by 2 bits, yielding 18 (10010)<br />
|code=print(bit.blogic_rshift(73, 2))<br />
|output=18<br />
}}<br />
{{Example<br />
|desc=Shift the number 2,147,483,648 (10000000000000000000000000000000) right by 2 bits, yielding 536,870,912 (00100000000000000000000000000000)<br />
|code=print(bit.blogic_rshift(2147483648, 2))<br />
|output=536870912<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.brshift&diff=5813Bit.brshift2013-07-12T01:08:03Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=bit.brshift<br />
|args={{Type|number}} n, {{Type|number}} bits<br />
|api=bit<br />
|returns={{Type|number}} the value of <var>n</var> shifted right by <var>bits</var> bits, with the shifted-in bits being equal to the original number’s 31st bit, which is equivalent to ⌊<var>n</var>÷2<sup><var>bits</var></sup>⌋<br />
|addon=ComputerCraft<br />
|desc=Shifts a number right arithmetically by a specified number of bits<br />
|examples=<br />
{{Example<br />
|desc=Shift the number 73 (1001001) right by 2 bits, yielding 18 (10010)<br />
|code=print(bit.brshift(73, 2))<br />
|output=18<br />
}}<br />
{{Example<br />
|desc=Shift the number 2,147,483,648 (10000000000000000000000000000000) right by 2 bits, yielding 3,758,096,384 (11100000000000000000000000000000)<br />
|code=print(bit.brshift(2147483648, 2))<br />
|output=3758096384<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit.blshift&diff=5812Bit.blshift2013-07-12T01:00:06Z<p>Watcher7: Changed nonexistent type int to type number.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=bit.blshift<br />
|args={{Type|number}} n, {{Type|number}} bits<br />
|api=bit<br />
|returns={{Type|number}} the value of <var>n</var> shifted left by <var>bits</var> bits, which is equivalent to <var>n</var>×2<sup><var>bits</var></sup><br />
|addon=ComputerCraft<br />
|desc=Shifts a number left by a specified number of bits<br />
|examples=<br />
{{Example<br />
|desc=Shift the number 18 (10010) left by 2 bits, yielding 72 (1001000)<br />
|code=print(bit.blshift(18, 2))<br />
|output=72<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Gps_(API)&diff=5811Gps (API)2013-07-12T00:55:13Z<p>Watcher7: Int -> {{type|number}}, Float -> {{type|number}}</p>
<hr />
<div>The GPS API provides a method for turtles and computers to retrieve their own locations.<br />
<br />
It broadcasts a PING message over [[Rednet_(API)|rednet]] and wait for responses. In order for this system to work, there must be at least 4 computers used as gps ''hosts'' which will respond and allow [[Wikipedia:Trilateration|trilateration]]. Three of these hosts should be in a plane, and the fourth should be either above or below the other three. You can set up hosts using the [[Gps (program)|gps program]].<br />
<br />
Note: When entering in the coordinates for the ''host'' you need to put in the x,y,z of the computer, not the modem, as all rednet distances are measured from the block the computer is in. <br />
<!-- do not edit this without actually testing it yourself --><br />
<br />
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;"><br />
<tr><td colspan="3" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;"><br />
[[File:Grid_disk.png|24px]]&nbsp;&nbsp;<br />
Gps (API)<br />
</td></tr><br />
<br />
<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><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">({{Type|number}} x, {{Type|number}} y, {{Type|number}} z), or [[nil]]</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">gps.locate(<nowiki>[</nowiki>{{Type|number}} timeout [, {{Type|boolean}} debug]])</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Tries to retrieve the computer or turtles own location. On success, returns the location of the turtle’s modem. On failure (if no responses are received for <var>timeout</var> seconds, by default 2), returns [[nil]]. If <var>debug</var> is <code>true</code>, debug messages are printed.</td></tr></table><br />
<br />
== Example ==<br />
print("Man I am so lost right now!")<br />
local x, y, z = gps.locate(5)<br />
if x == nil then<br />
print("Nope, still lost :(")<br />
else<br />
print("I am at ",x," ",y," ",z)<br />
end<br />
<br />
== Vector Example ==<br />
GPS position and navigation can be handled more easily using a [[vector (API)|vector]].<br />
<br />
local home = vector.new(45, 85, 20)<br />
local position = vector.new(gps.locate(5))<br />
local displacement = position - home<br />
<br />
print("I am ", displacement.tostring(), " away from home!!!")<br />
<br />
<br />
code>true<br />
<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit_(API)&diff=5810Bit (API)2013-07-12T00:52:11Z<p>Watcher7: Int -> {{type|number}}</p>
<hr />
<div>The Bit API is for manipulating numbers using bitwise binary operations.<br />
<br />
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;"><br />
<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]]&nbsp;&nbsp;Bit (API)</td></tr><br />
<br />
<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><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} value</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.blshift]]({{Type|number}} n, {{Type|number}} bits)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number left by a specified number of bits.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} value</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.brshift]]({{Type|number}} n, {{Type|number}} bits)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number right arithmetically by a specified number of bits.</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} value</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.blogic_rshift]]({{Type|number}} n, {{Type|number}} bits)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Shifts a number right logically by a specified number of bits.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} value</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bxor]]({{Type|number}} m, {{Type|number}} n)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise exclusive OR of two numbers.</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} value</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bor]]({{Type|number}} m, {{Type|number}} n)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise inclusive OR of two numbers.</td></tr><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} value</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.band]]({{Type|number}} m, {{Type|number}} n)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise AND of two numbers.</td></tr><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} value</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.bnot]]({{Type|number}} n)</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Computes the bitwise NOT of a number.</td></tr><br />
</table><br />
<br />
<br />
= Deprecated Functions =<br />
{{Deprecated<br />
|plural=yes<br />
|type=These functions<br />
}}<br />
<br />
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;"><br />
<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]]&nbsp;&nbsp;Bit (API)</td></tr><br />
<br />
<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><br />
<br />
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|table}} bit_tbl</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.tobits]]({{Type|number}} n)</td><br />
<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><br />
<br />
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|number}} value</td><br />
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[bit.tonumb]]({{Type|table}} bit_tbl)</td><br />
<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><br />
</table><br />
<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Colors.test&diff=5809Colors.test2013-07-12T00:47:21Z<p>Watcher7: Int -> {{type|number}}</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=colors.test<br />
|args={{Type|number}} colors, {{Type|number}} color<br />
|api=colors<br />
|returns={{Type|boolean}} whether or not all elements of <var>color</var> are contained in the set <var>colors</var><br />
|addon=ComputerCraft<br />
|desc=Tests whether <var>color</var> is contained within <var>colors</var>; <var>color</var> may be a single color or may be a set of colors (in the latter case, <code>true</code> is returned only if <em>all</em> colors in <var>color</var> are contained in <var>colors</var>)<br />
|examples=<br />
{{Example<br />
|desc=Combine white, magenta, and light blue, then check if light blue is within the set<br />
|code=[[print]](colors.test(colors.combine(colors.white, colors.magenta, colours.lightBlue), colors.lightBlue))<br />
|output=true<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Colors.combine&diff=5808Colors.combine2013-07-12T00:46:12Z<p>Watcher7: Int -> {{type|number}}</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=colors.combine<br />
|args={{Type|number}} color1, {{Type|number}} color2, …<br />
|api=colors<br />
|returns={{Type|number}} the union of sets <var>color1</var>, <var>color2</var>, …<br />
|addon=ComputerCraft<br />
|desc=Combines a set of colors (or sets of colors) into a larger set.<br />
|examples=<br />
{{Example<br />
|desc=Combine white, magenta, and light blue to yield 13 (the bitwise combination of the colors)<br />
|code=print(colors.combine(colors.white, colors.magenta, colours.lightBlue))<br />
|output=13<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Colors.subtract&diff=5807Colors.subtract2013-07-12T00:44:28Z<p>Watcher7: Int -> {{type|number}} (Boo! I missed one!)</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=colors.subtract<br />
|args={{Type|number}} colors, {{Type|number}} color1, {{Type|number}} color2, …<br />
|api=colors<br />
|returns={{Type|number}} the set <var>colors</var> after removing sets <var>color1</var>, <var>color2</var>, …<br />
|addon=ComputerCraft<br />
|desc=Removes one or more colors (or sets of colors) from an initial set; each parameter beyond the first may be a single color or may be a set of colors (in the latter case, all colors in the set are removed from the original set).<br />
|examples=<br />
{{Example<br />
|desc=Beginning with white, magenta, and light blue, remove magenta to yield 9 (the bitwise combination of white and light blue)<br />
|code=print(colors.subtract(colors.combine(colors.white, colors.magenta, colours.lightBlue), colors.magenta))<br />
|output=9<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Colors.subtract&diff=5805Colors.subtract2013-07-12T00:40:15Z<p>Watcher7: Int -> {{type|number}}</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=colors.subtract<br />
|args={{Type|number}} colors, {{Type|number}} color1, {{Type|number}} color2, …<br />
|api=colors<br />
|returns={{Type|int}} the set <var>colors</var> after removing sets <var>color1</var>, <var>color2</var>, …<br />
|addon=ComputerCraft<br />
|desc=Removes one or more colors (or sets of colors) from an initial set; each parameter beyond the first may be a single color or may be a set of colors (in the latter case, all colors in the set are removed from the original set).<br />
|examples=<br />
{{Example<br />
|desc=Beginning with white, magenta, and light blue, remove magenta to yield 9 (the bitwise combination of white and light blue)<br />
|code=print(colors.subtract(colors.combine(colors.white, colors.magenta, colours.lightBlue), colors.magenta))<br />
|output=9<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Download&diff=4664Download2012-12-04T18:50:04Z<p>Watcher7: Undo revision 4661 by 85.115.3.242 (talk)</p>
<hr />
<div>=== You can download the latest version of ComputerCraft [http://www.minecraftforum.net/topic/892282- here]. ===<br />
<br />
==Changelog:==<br />
<br />
{{Changelog}}<br />
<br />
[[Category:Lists]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Category:APIs&diff=4663Category:APIs2012-12-04T18:49:43Z<p>Watcher7: Undo revision 4662 by 205.158.23.125 (talk)</p>
<hr />
<div>[[File:Apis.png|thumb|350px|API's being listed with the "apis" command run in a computer.]]An API (Application Programming Interface) is a collection of code that, rather than being run directly by the user as a program, is meant to be used by other programs. This is different from a function in that an API may contain many functions that perform related tasks; the API groups them together. It is a library of functions.<br />
There are two reasons why one might want to use an API:<br />
* The API may provide a function that you could write yourself if you had to, but using the one from the API means you don't have to do that work.<br />
<br />
* The API may provide something it's impossible to do yourself because it has to be done in Java rather than Lua.<br />
<br />
<br />
ComputerCraft itself ships with a collection of APIs of both types. For example:<br />
<br />
* The [[color (API)|color API]] provides names for the various numbers used in RedPower bundled cable, and functions that manipulate those numbers. The names for the numbers are just variables, and the functions are written in Lua (you can find this in "rom/apis/colors"). You could write the same variables and functions in your own code if you wanted, but using the API saves you from doing that.<br />
<br />
* The [[fs (API)|fs API]] provides functions to work with files. You couldn't write the functions from this API in Lua because they have to access the corresponding files in your real computer (the one running Minecraft), and the only way to do that from Lua is… through the fs API (or the [[IO (API)|io API]], but that's just a wrapper around fs).<br />
<br />
All the stock APIs of the first kind, those that are implemented in Lua, can be found in your "mods/ComputerCraft/lua/rom/apis" directory. Inside Minecraft, on a ComputerCraft computer, these appear in the directory "rom/apis". All the built-in APIs of both kinds (Lua and Java) are automatically loaded, so you don't have to use "[[OS (API)|os]].loadAPI" on them.<br />
<br />
ComputerCraft mods, for example mods that add custom peripherals, might also add APIs that help you work with those peripherals.<br />
<br />
You can view a list of un-official API's at the [[:Category:Unofficial_APIs]] page.<br />
<br />
Finally, you might find APIs written by other people that you can download, or you might write APIs yourself if you'll be using a function in many different programs and don't want to keep rewriting it. If you're playing single-player or you're running the multiplayer server, you can add those APIs to "rom/apis" and they will automatically be loaded on every computer in the world. Normally, though, you would leave the APIs somewhere else and use "os.loadAPI" to make them available to your program.<br />
<br />
You can see a list of APIs built-in to ComputerCraft by typing "apis" in the terminal.<br />
<br />
[[Category:Lists]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Download&diff=4660Download2012-12-04T18:30:39Z<p>Watcher7: Undo revision 4659 by 193.23.123.194 (talk) faggotry</p>
<hr />
<div>=== You can download the latest version of ComputerCraft [http://www.minecraftforum.net/topic/892282- here]. ===<br />
<br />
==Changelog:==<br />
<br />
{{Changelog}}<br />
<br />
[[Category:Lists]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Making_a_Password_Protected_Door&diff=4600Making a Password Protected Door2012-12-04T12:55:21Z<p>Watcher7: Undo revision 4599 by Cocks (talk) derp</p>
<hr />
<div><br />
This tutorial covers on how to make a computer output redstone current when the right password is typed in. The current is then used to trigger an iron door.<br />
<br />
<br />
__TOC__<br />
= How to make it =<br />
<br />
A password protected door is actually pretty easy, if you break it into steps.<br />
<br />
<br />
First, you need to craft a computer, and connect the back to an iron door with redstone. Like this:<br />
<br />
The front: [[File:Tutorial1.png|border|200px]]<br />
<br />
The back: [[File:cTutorial2.png|border|200px]]<br />
<br />
<br/><br />
<br />
Alternatively, you can put the computer adjacent to the iron door without using redstone.Once you're done with the basics, open the computer and edit the "startup" file. (type in 'edit startup')<br />
This will make it so the program will be executed when the computer boots.<br />
<br />
Once you access the startup file, enter in these five lines.<br />
<br />
<br />
[[Loops#The_While_loop|while]] true do<br />
[[term_(API)|term]].[[term.clear|clear]]()<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1, 1)<br />
[[print]]("Please Enter Password:")<br />
local input = [[read]]("*")<br />
<br />
<br />
<br />
The first line opens a loop that will continue running forever, or until we explicitly exit it with the 'break' keyword. The second and third lines clear the screen of whatever may have been on it, and then set the cursor position to the top-left corner of the screen. This ensures that each time the program loops, the text appears in the same place. The fifth line assigns whatever the user types to the variable 'input'. So for example, if I typed "qwerty", it would be assigning "qwerty" to the 'input' variable. In the read call on the third line ('read("*")'), the asterisk character will be used to replace each letter typed by the user, so that the password stays hidden.<br />
<br />
Here are the next few lines added on:<br />
<br />
<br />
[[Loops#The_While_loop|while]] true do<br />
[[term_(API)|term]].[[term.clear|clear]]()<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1, 1)<br />
[[print]]("Please Enter Password:")<br />
input = [[read]]("*")<br />
if input == "password" then<br />
[[redstone_(API)|redstone]].[[redstone.setOutput|setOutput]]("back", true)<br />
[[os.sleep|sleep]](2)<br />
[[redstone_(API)|redstone]].[[redstone.setOutput|setOutput]]("back", false)<br />
end<br />
end<br />
<br />
''where "password" is the password needed to open the door. You can modify it.''<br />
<br />
The first line we add, 'if input == "password" then' checks whether or not the 'input' variable contains the string "password". The three lines immediately following are only executed if the password is correct. So if it's correct, 'redstone.setOutput("back", true)' sets the redstone output on the back side to true (on), which opens the door. The program then wait two seconds ('sleep(2)'), and turns the redstone output back off again. The program then reaches the end of the loop and repeats.<br />
<br />
Please note that this is the basic format for a computer protection program as well. We would put this program in the startup file and instead of outputting redstone signals if the password was correct, we would use the break keyword instead to exit the loop and allow access to the rest of the computer.<br />
<br />
Note also that if the program fails somehow, pressing and holding Ctrl + T will terminate it and allow you to edit it, see the [http://computercraft.info/wiki/index.php?title=Making_a_Password_Protected_Door#Stop_people_from_terminating_your_lock No termination section] to stop people from exiting your lock.<br />
<br />
= Easier to understand code =<br />
<br />
Type 'edit startup' and type in this code: <br />
(Use Ctrl + T to terminate the program, all code is explained in the comments, the --'s. It's good to read the comments, so you actually know what the code does, you do not need to have the comments in your code, of course)<br />
local side = "left" -- Change left to whatever side your door / redstone is on, E.G: left, right, front, back, bottom, top. Be sure to leave the "s around it, though<br />
local password = "bacon" -- Change bacon to what you want your password to be. Be sure to leave the "s around it, though<br />
local opentime = 5 -- Change 5 to how long (in seconds) you want the redstone current to be on. Don't put "s around it, though<br />
[[Loops#The_While_loop|while]] true do <br />
[[term_(API)|term]].[[term.clear|clear]]() -- Clears the screen<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1,1) -- Fixes the cursor position<br />
[[write]]("Password: ") -- Prints 'Password: ' to the screen<br />
local input = [[read]]("*") -- Makes the variable 'input' have the contents of what the user types in, the "*" part censors out the password<br />
if input == password then -- Checks if the user inputted the correct password<br />
[[term_(API)|term]].[[term.clear|clear]]() -- Already explained up top<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1,1)<br />
[[print]]("Password correct!") -- Prints 'Password correct!' to the screen<br />
[[redstone_(API)|rs]].[[redstone.setOutput|setOutput]](side,true) -- Output a redstone current to the side you specified<br />
[[os.sleep|sleep]](opentime) -- Wait the amount of seconds you specifed, then..<br />
[[redstone_(API)|rs]].[[redstone.setOutput|setOutput]](side,false) -- Stop outputting a redstone current<br />
else -- Checks if the user didn't input the correct password<br />
[[print]]("Password incorrect!") -- Prints 'Password incorrect!' to the screen<br />
[[os.sleep|sleep]](2) -- Waits 2 seconds<br />
end<br />
end<br />
<br />
= Stop people from terminating your lock =<br />
<br />
If you don't want people holding CTRL+T and quitting your lock, use this code at the top of your program:<br />
<pre>os.pullEvent = os.pullEventRaw</pre><br />
If you don't add this code to the top of your program, someone could terminate the lock and enter in a command and they can unlock your door without knowing the password. Adding the code is useful in Multiplayer.<br />
<br />
To re-enable the ability to terminate the program, you must first make a copy of <i>os.pullEvent</i>, then you can restore it later.<br />
<pre>local pullEvent = os.pullEvent<br />
os.pullEvent = os.pullEventRaw<br />
<br />
-- If the desired conditions are met, you can run this line to allow the program to be terminated.<br />
os.pullEvent = pullEvent</pre><br />
[[Category:Tutorials]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Making_a_Password_Protected_Door&diff=4599Making a Password Protected Door2012-12-04T12:54:34Z<p>Watcher7: </p>
<hr />
<div><br />
This tutorial covers on how to make a computer output redstone current when the right password is typed in. The current is then used to trigger an iron door.<br />
<br />
<br />
__TOC__<br />
= How to make it =<br />
<br />
A password protected door is actually pretty easy, if you break it into steps.<br />
<br />
<br />
First, you need to craft a computer, and connect the back to an iron door with redstone. Like this:<br />
<br />
The front: [[File:Tutorial1.png|border|200px]]<br />
<br />
The back: [[File:cTutorial2.png|border|200px]]<br />
<br />
<br/><br />
<br />
Alternatively, you can put the computer adjacent to the iron door without using redstone.Once you're done with the basics, open the computer and edit the "startup" file. (type in 'edit startup')<br />
This will make it so the program will be executed when the computer boots.<br />
<br />
Once you access the startup file, enter in these five lines.<br />
<br />
<br />
[[Loops#The_While_loop|while]] true do<br />
[[term_(API)|term]].[[term.clear|clear]]()<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1, 1)<br />
[[print]]("Please Enter Password:")<br />
local input = [[read]]("*")<br />
end<br />
<br />
<br />
<br />
The first line opens a loop that will continue running forever, or until we explicitly exit it with the 'break' keyword. The second and third lines clear the screen of whatever may have been on it, and then set the cursor position to the top-left corner of the screen. This ensures that each time the program loops, the text appears in the same place. The fifth line assigns whatever the user types to the variable 'input'. So for example, if I typed "qwerty", it would be assigning "qwerty" to the 'input' variable. In the read call on the third line ('read("*")'), the asterisk character will be used to replace each letter typed by the user, so that the password stays hidden.<br />
<br />
Here are the next few lines added on:<br />
<br />
<br />
[[Loops#The_While_loop|while]] true do<br />
[[term_(API)|term]].[[term.clear|clear]]()<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1, 1)<br />
[[print]]("Please Enter Password:")<br />
input = [[read]]("*")<br />
if input == "password" then<br />
[[redstone_(API)|redstone]].[[redstone.setOutput|setOutput]]("back", true)<br />
[[os.sleep|sleep]](2)<br />
[[redstone_(API)|redstone]].[[redstone.setOutput|setOutput]]("back", false)<br />
end<br />
end<br />
<br />
''where "password" is the password needed to open the door. You can modify it.''<br />
<br />
The first line we add, 'if input == "password" then' checks whether or not the 'input' variable contains the string "password". The three lines immediately following are only executed if the password is correct. So if it's correct, 'redstone.setOutput("back", true)' sets the redstone output on the back side to true (on), which opens the door. The program then wait two seconds ('sleep(2)'), and turns the redstone output back off again. The program then reaches the end of the loop and repeats.<br />
<br />
Please note that this is the basic format for a computer protection program as well. We would put this program in the startup file and instead of outputting redstone signals if the password was correct, we would use the break keyword instead to exit the loop and allow access to the rest of the computer.<br />
<br />
Note also that if the program fails somehow, pressing and holding Ctrl + T will terminate it and allow you to edit it, see the [http://computercraft.info/wiki/index.php?title=Making_a_Password_Protected_Door#Stop_people_from_terminating_your_lock No termination section] to stop people from exiting your lock.<br />
<br />
= Easier to understand code =<br />
<br />
Type 'edit startup' and type in this code: <br />
(Use Ctrl + T to terminate the program, all code is explained in the comments, the --'s. It's good to read the comments, so you actually know what the code does, you do not need to have the comments in your code, of course)<br />
local side = "left" -- Change left to whatever side your door / redstone is on, E.G: left, right, front, back, bottom, top. Be sure to leave the "s around it, though<br />
local password = "bacon" -- Change bacon to what you want your password to be. Be sure to leave the "s around it, though<br />
local opentime = 5 -- Change 5 to how long (in seconds) you want the redstone current to be on. Don't put "s around it, though<br />
[[Loops#The_While_loop|while]] true do <br />
[[term_(API)|term]].[[term.clear|clear]]() -- Clears the screen<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1,1) -- Fixes the cursor position<br />
[[write]]("Password: ") -- Prints 'Password: ' to the screen<br />
local input = [[read]]("*") -- Makes the variable 'input' have the contents of what the user types in, the "*" part censors out the password<br />
if input == password then -- Checks if the user inputted the correct password<br />
[[term_(API)|term]].[[term.clear|clear]]() -- Already explained up top<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1,1)<br />
[[print]]("Password correct!") -- Prints 'Password correct!' to the screen<br />
[[redstone_(API)|rs]].[[redstone.setOutput|setOutput]](side,true) -- Output a redstone current to the side you specified<br />
[[os.sleep|sleep]](opentime) -- Wait the amount of seconds you specifed, then..<br />
[[redstone_(API)|rs]].[[redstone.setOutput|setOutput]](side,false) -- Stop outputting a redstone current<br />
else -- Checks if the user didn't input the correct password<br />
[[print]]("Password incorrect!") -- Prints 'Password incorrect!' to the screen<br />
[[os.sleep|sleep]](2) -- Waits 2 seconds<br />
end<br />
end<br />
<br />
= Stop people from terminating your lock =<br />
<br />
If you don't want people holding CTRL+T and quitting your lock, use this code at the top of your program:<br />
<pre>os.pullEvent = os.pullEventRaw</pre><br />
If you don't add this code to the top of your program, someone could terminate the lock and enter in a command and they can unlock your door without knowing the password. Adding the code is useful in Multiplayer.<br />
<br />
To re-enable the ability to terminate the program, you must first make a copy of <i>os.pullEvent</i>, then you can restore it later.<br />
<pre>local pullEvent = os.pullEvent<br />
os.pullEvent = os.pullEventRaw<br />
<br />
-- If the desired conditions are met, you can run this line to allow the program to be terminated.<br />
os.pullEvent = pullEvent</pre><br />
[[Category:Tutorials]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Making_a_Password_Protected_Door&diff=4598Making a Password Protected Door2012-12-04T12:53:43Z<p>Watcher7: Undo revision 4597 by 207.104.28.181 (talk) possible SE thank-you bot</p>
<hr />
<div><br />
This tutorial covers on how to make a computer output redstone current when the right password is typed in. The current is then used to trigger an iron door.<br />
<br />
<br />
__TOC__<br />
= How to make it =<br />
<br />
A password protected door is actually pretty easy, if you break it into steps.<br />
<br />
<br />
First, you need to craft a computer, and connect the back to an iron door with redstone. Like this:<br />
<br />
The front: [[File:Tutorial1.png|border|200px]]<br />
<br />
The back: [[File:cTutorial2.png|border|200px]]<br />
<br />
<br/><br />
<br />
Alternatively, you can put the computer adjacent to the iron door without using redstone.Once you're done with the basics, open the computer and edit the "startup" file. (type in 'edit startup')<br />
This will make it so the program will be executed when the computer boots.<br />
<br />
Once you access the startup file, enter in these five lines.<br />
<br />
<br />
[[Loops#The_While_loop|while]] true do<br />
[[term_(API)|term]].[[term.clear|clear]]()<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1, 1)<br />
[[print]]("Please Enter Password:")<br />
local input = [[read]]("*")<br />
<br />
<br />
<br />
The first line opens a loop that will continue running forever, or until we explicitly exit it with the 'break' keyword. The second and third lines clear the screen of whatever may have been on it, and then set the cursor position to the top-left corner of the screen. This ensures that each time the program loops, the text appears in the same place. The fifth line assigns whatever the user types to the variable 'input'. So for example, if I typed "qwerty", it would be assigning "qwerty" to the 'input' variable. In the read call on the third line ('read("*")'), the asterisk character will be used to replace each letter typed by the user, so that the password stays hidden.<br />
<br />
Here are the next few lines added on:<br />
<br />
<br />
[[Loops#The_While_loop|while]] true do<br />
[[term_(API)|term]].[[term.clear|clear]]()<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1, 1)<br />
[[print]]("Please Enter Password:")<br />
input = [[read]]("*")<br />
if input == "password" then<br />
[[redstone_(API)|redstone]].[[redstone.setOutput|setOutput]]("back", true)<br />
[[os.sleep|sleep]](2)<br />
[[redstone_(API)|redstone]].[[redstone.setOutput|setOutput]]("back", false)<br />
end<br />
end<br />
<br />
''where "password" is the password needed to open the door. You can modify it.''<br />
<br />
The first line we add, 'if input == "password" then' checks whether or not the 'input' variable contains the string "password". The three lines immediately following are only executed if the password is correct. So if it's correct, 'redstone.setOutput("back", true)' sets the redstone output on the back side to true (on), which opens the door. The program then wait two seconds ('sleep(2)'), and turns the redstone output back off again. The program then reaches the end of the loop and repeats.<br />
<br />
Please note that this is the basic format for a computer protection program as well. We would put this program in the startup file and instead of outputting redstone signals if the password was correct, we would use the break keyword instead to exit the loop and allow access to the rest of the computer.<br />
<br />
Note also that if the program fails somehow, pressing and holding Ctrl + T will terminate it and allow you to edit it, see the [http://computercraft.info/wiki/index.php?title=Making_a_Password_Protected_Door#Stop_people_from_terminating_your_lock No termination section] to stop people from exiting your lock.<br />
<br />
= Easier to understand code =<br />
<br />
Type 'edit startup' and type in this code: <br />
(Use Ctrl + T to terminate the program, all code is explained in the comments, the --'s. It's good to read the comments, so you actually know what the code does, you do not need to have the comments in your code, of course)<br />
local side = "left" -- Change left to whatever side your door / redstone is on, E.G: left, right, front, back, bottom, top. Be sure to leave the "s around it, though<br />
local password = "bacon" -- Change bacon to what you want your password to be. Be sure to leave the "s around it, though<br />
local opentime = 5 -- Change 5 to how long (in seconds) you want the redstone current to be on. Don't put "s around it, though<br />
[[Loops#The_While_loop|while]] true do <br />
[[term_(API)|term]].[[term.clear|clear]]() -- Clears the screen<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1,1) -- Fixes the cursor position<br />
[[write]]("Password: ") -- Prints 'Password: ' to the screen<br />
local input = [[read]]("*") -- Makes the variable 'input' have the contents of what the user types in, the "*" part censors out the password<br />
if input == password then -- Checks if the user inputted the correct password<br />
[[term_(API)|term]].[[term.clear|clear]]() -- Already explained up top<br />
[[term_(API)|term]].[[term.setCursorPos|setCursorPos]](1,1)<br />
[[print]]("Password correct!") -- Prints 'Password correct!' to the screen<br />
[[redstone_(API)|rs]].[[redstone.setOutput|setOutput]](side,true) -- Output a redstone current to the side you specified<br />
[[os.sleep|sleep]](opentime) -- Wait the amount of seconds you specifed, then..<br />
[[redstone_(API)|rs]].[[redstone.setOutput|setOutput]](side,false) -- Stop outputting a redstone current<br />
else -- Checks if the user didn't input the correct password<br />
[[print]]("Password incorrect!") -- Prints 'Password incorrect!' to the screen<br />
[[os.sleep|sleep]](2) -- Waits 2 seconds<br />
end<br />
end<br />
<br />
= Stop people from terminating your lock =<br />
<br />
If you don't want people holding CTRL+T and quitting your lock, use this code at the top of your program:<br />
<pre>os.pullEvent = os.pullEventRaw</pre><br />
If you don't add this code to the top of your program, someone could terminate the lock and enter in a command and they can unlock your door without knowing the password. Adding the code is useful in Multiplayer.<br />
<br />
To re-enable the ability to terminate the program, you must first make a copy of <i>os.pullEvent</i>, then you can restore it later.<br />
<pre>local pullEvent = os.pullEvent<br />
os.pullEvent = os.pullEventRaw<br />
<br />
-- If the desired conditions are met, you can run this line to allow the program to be terminated.<br />
os.pullEvent = pullEvent</pre><br />
[[Category:Tutorials]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=ComputerCraft_IRC&diff=4595ComputerCraft IRC2012-12-04T12:18:49Z<p>Watcher7: Undo revision 4591 by 184.171.168.202 (talk)</p>
<hr />
<div>{{Stub}}<br />
The ComputerCraft IRC is the official IRC. Its channel is #computercraft. A link to it is [http://webchat.esper.net/?channels=#computercraft here.] Most development information is gained from this.<br />
<br />
[[Category:Lists]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Turtle_(API)&diff=4524Turtle (API)2012-12-03T11:01:30Z<p>Watcher7: Bleh, fixed parans, someone needs to fix the rest of this later /lazy</p>
<hr />
<div>The Turtle API is used to work with your [[Turtle|Turtles]].<br />
<br />
{| border="1" cellpadding="2" cellspacing="0|"<br />
| colspan="2" | <center><b>KEY</b></center><br />
|-<br />
! Color<br />
! Turtles that can perform this<br />
|-<br />
|White<br />
|All<br />
|-{{row-lightgreen}}<br />
|Green<br />
|Crafty<br />
|-{{row-lightyellow}}<br />
|Yellow<br />
|Mining, Felling, Digging, Farming<br />
|-{{row-lightred}}<br />
|Red<br />
|Any tool<br />
|}<br />
<!-- ##################<br />
To add additional colors, visit Template:row-lightgreen, copy the source, do a search for Template:row-yourcolor and hit Create Page. ################## --><br />
<br />
<br />
{| border="1" cellpadding="2" cellspacing="0|"<br />
!style="background:#EEE" width="100px"|Return<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
!style="background:#EEE" width="*"|Min version<br />
|-{{row-lightgreen}}<br />
|bool "success"<br />
|[[turtle.craft]]()<br />
|Craft items using ingredients anywhere in the Turtle's inventory and place results in the active slot<br />
|<br />
|-<br />
|bool "success"<br />
|[[turtle.forward]]()<br />
|Let the Turtle move forward<br />
|<br />
|- <br />
|bool "success"<br />
|[[turtle.back]]()<br />
|Let the Turtle move back<br />
|<br />
|-<br />
|bool "success"<br />
|[[turtle.up]]()<br />
|Let the Turtle move up<br />
|<br />
|-<br />
|bool "success"<br />
|[[turtle.down]]()<br />
|Let the Turtle move down <br />
|<br />
|-<br />
|bool "true"<br />
|[[turtle.turnLeft]]()<br />
|The Turtle turns left<br />
|<br />
|-<br />
|bool "true"<br />
|[[turtle.turnRight]]()<br />
|The Turtle turns right<br />
|<br />
|-<br />
|bool "slot > 16"<br />
|[[turtle.select]](slotNum)<br />
|The Turtle selects the given Slot (1 is top left, 16 (9 in 1.33 and earlier) is bottom right)<br />
|<br />
|-<br />
|int "result"<br />
|[[turtle.getItemCount]](slotNum)<br />
|Counts how many items are in the given Slot<br />
|<br />
|-<br />
|int "result"<br />
|[[turtle.getItemSpace]](slotNum)<br />
|Counts how many remaining items you need to fill the stack in the given Slot<br />
|<br />
|-{{row-lightred}}<br />
|bool "success"<br />
|[[turtle.attack]]()<br />
|Attacks in front of the turtle.<br />
| 1.4<br />
|-{{row-lightred}}<br />
|bool "success" <br />
|[[turtle.attackUp]]()<br />
|Attacks over the turtle.<br />
| 1.4<br />
|-{{row-lightred}}<br />
|bool "success"<br />
|[[turtle.attackDown]]()<br />
|Attacks under the turtle.<br />
| 1.4<br />
|-{{row-lightyellow}}<br />
|bool "success"<br />
|[[turtle.dig]]()<br />
|Breaks the Block in front. With hoe: tills the dirt in front of it.<br />
|<br />
|-{{row-lightyellow}}<br />
|bool "success"<br />
|[[turtle.digUp]]()<br />
|Breaks the Block above. With hoe: tills the dirt above it.<br />
|<br />
|-{{row-lightyellow}}<br />
|bool "success"<br />
|[[turtle.digDown]]()<br />
|Breaks the Block below. With hoe: tills the dirt below it.<br />
|<br />
|-<br />
|bool "success"<br />
|[[turtle.place]]([signText])<br />
|Places a Block of the selected slot in front. Engrave [signText] on signs if provided.<br />
| 1.4<br />
|-<br />
|bool "success"<br />
|[[turtle.placeUp]]()<br />
|Places a Block of the selected slot above<br />
|<br />
|-<br />
|bool "success"<br />
|[[turtle.placeDown]]()<br />
|Places a Block of the selected slot below<br />
|<br />
|-<br />
|bool "result"<br />
|[[turtle.detect]]()<br />
|Detects if there is a Block in front. Does not detect mobs.<br />
|<br />
|-<br />
|bool "result"<br />
|[[turtle.detectUp]]()<br />
|Detects if there is a Block above<br />
|<br />
|-<br />
|bool "result"<br />
|[[turtle.detectDown]]()<br />
|Detects if there is a Block below<br />
|<br />
|-<br />
|bool "result"<br />
|[[turtle.compare]]()<br />
|Detects if the block in front is the same as the one in the currently selected slot<br />
|<br />
|-<br />
|bool "result"<br />
|[[turtle.compareUp]]()<br />
|Detects if the block above is the same as the one in the currently selected slot<br />
|<br />
|-<br />
|bool "result"<br />
|[[turtle.compareDown]]()<br />
|Detects if the block below is the same as the one in the currently selected slot<br />
|<br />
|-<br />
|bool "result"<br />
|[[turtle.compareTo]]([slot])<br />
|Compare the current selected slot and the given slot to see if the items are the same, yields true if they are the same, and false if not.<br />
| 1.4<br />
|-<br />
|bool "success"<br />
|[[turtle.drop]]([count])<br />
|Drops all items in the selected slot, or if [count] is specified, drops that many items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e in front of the turtle) it will try to place into the inventory, returning false if the inventory is full.<br />
|<br />
|-<br />
|bool "success"<br />
|[[turtle.drop|turtle.dropUp]]([count])<br />
|Drops all items in the selected slot, or if [count] is specified, drops that many items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e above the turtle) it will try to place into the inventory, returning false if the inventory is full. If below a furnace, will place item in the bottom slot.<br />
|<br />
|-<br />
|bool "success"<br />
|[[turtle.drop|turtle.dropDown]]([count])<br />
|Drops all items in the selected slot, or if [count] is specified, drops that many items.<br />[>= 1.4 only:] If there is a inventory on the side (i.e below the turtle) it will try to place into the inventory, returning false if the inventory is full. If above a furnace, will place item in the top slot.<br />
|<br />
|-<br />
|bool "success"<br />
|[[turtle.suck]]()<br />
|Picks up an item stack of any number, from the ground or an inventory in front of the turtle. If the turtle can't pick up the item, the function yields false.<br />
| 1.4<br />
|-<br />
|bool "success"<br />
|[[turtle.suckUp]]()<br />
|Picks up an item stack of any number, from the ground or an inventory above the turtle. If the turtle can't pick up the item, the function yields false.<br />
| 1.4<br />
|-<br />
|bool "success"<br />
|[[turtle.suckDown]]()<br />
|Picks up an item stack of any number, from the ground or an inventory below the turtle. If the turtle can't pick up the item, the function yields false.<br />
| 1.4<br />
|-<br />
|bool "success"<br />
|[[turtle.refuel]]([quantity])<br />
|If the current selected slot contains a fuel item, it will consume it to give the turtle the ability to move.<br />Added in 1.4 and is only needed in needfuel mode. If the current slot doesn't contain a fuel item, it yields false. Fuel values for different items can be found at [[Turtle.refuel#Fuel_Values]]. If a quantity is specified, it will refuel only up to that many items, otherwise, it will consume all the items in the slot.<br />
| 1.4<br />
|-<br />
|int "fuel"<br />
|[[turtle.getFuelLevel]]()<br />
|Returns the current fuel level of the turtle, this is the number of blocks the turtle can move.<br />If turtleNeedFuel = 0 then it yields "unlimited".<br />
| 1.4<br />
|-<br />
|bool "success"<br />
|[[turtle.transferTo]]([slot], [quantity])<br />
|Transfers items from the selected slot to the specified [slot] in the [quantity] inputted.<br />
| 1.45<br />
|}<br />
<br />
Trivia:<br />
During the 1.4 beta, turtle.getFuelLevel() in softcore(that is now turtleneedsfuel = 0) returned 9000.<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Rednet.receive&diff=4507Rednet.receive2012-12-03T06:54:36Z<p>Watcher7: </p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=rednet.receive<br />
|args=[[float (type)|float]] timeoutSeconds<br />
|returns=senderID, message, distance-to-sender (or <code>nil</code> if using redpower bundled cable instead of a modem)<br />
|api=rednet<br />
|addon=ComputerCraft<br />
|desc=Waits for <var>timeoutSeconds</var> or until another computer sends a message to this computer. (see [[rednet.broadcast|rednet.broadcast( message )]] and [[rednet.send|rednet.send( receiverID, message )]]. If a Timeout occurs the return id and message are set to nil. If timeout is nil, waits forever.<br />To get the id from a computer see [[Os.getComputerID|os.getComputerID()]], or the [[id]] program.<br/>You must be calling this function at the moment a message is sent, or you will miss it. If you need to watch for messages while doing something else at the same time, see [[Parallel.waitForAny|parallel.waitForAny()]]<br />
|examples=<br />
{{Example<br />
|desc=Waits forever until someone sends a message to this computer and displays it.<br />
|code=local senderId, message, distance = rednet.receive()<br>term.write(message)<br />
|output=The received message.<br />
}}<br />
}}<br />
<br />
[[Category:API_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Fs.list&diff=4486Fs.list2012-12-02T18:05:37Z<p>Watcher7: </p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=fs.list<br />
|args=[[string (type)|string]] path<br />
|api=fs<br />
|returns=[[table (type)|table]] list of files and folders in <var>path</var>, which must be a directory<br />
|desc=Returns a list of all the files contained in a directory, in table format<br />
|examples=<br />
{{Example<br />
|desc=Displays a list of all files and folders in the root directory of a computer<br />
|code=local FileList = fs.list("") --Table with all the files and directories available<br />
<br />
for _, file in ipairs(FileList) do --Loop. Underscore because we don't use the key, ipairs so it's in order<br />
print(file) --Print the file name<br />
end --End the loop<br />
<br />
|output=A list of all files and folders in the root directory as a table. Note that fs.list() could also be inserted directly into ipairs() or pairs(). Using pairs would list hidden files as ipairs would not.<br />
}}<br />
}}<br />
<br />
[[Category:Lua_Core_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Os.queueEvent&diff=4055Os.queueEvent2012-11-28T18:54:33Z<p>Watcher7: </p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=os.queueEvent<br />
|args=[[string]] eventName, param1, param2, param3<br />
|api=os<br />
|addon=ComputerCraft<br />
|desc=Adds an event <var>eventName</var> with the specified parameters to the event queue.<br />
|examples=<br />
{{Example<br />
|desc=The program adds an event which it will eventually pull.<br />
|code=<br />
os.queueEvent("abc", 2, "meow")<br />
while true do<br />
local event, param1, param2 = os.pullEvent()<br />
if event == "abc" then<br />
print("ABC EVENT! Parameters: " .. param1 .. " / " .. param2)<br />
else<br />
print("Event: " .. event)<br />
end<br />
end<br />
}}<br />
}}<br />
{{Example<br />
|desc=To easily have a redstone and a key input do the same,<br /><br />
it queues a key event with the appropriate key if a redstone event happens.<br />
|code=<br />
while true do<br />
local event, param1 = os.pullEvent()<br />
if event == "redstone" then<br />
if rs.getInput("left") then<br />
os.queueEvent("key", 28)<br />
end<br />
elseif event == "key" then<br />
if param1 == 28 then<br />
print("Hello")<br />
end<br />
end<br />
end<br />
}}<br />
<br />
[[Category:Lua_Core_Functions]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Os.queueEvent&diff=3999Os.queueEvent2012-11-28T18:49:44Z<p>Watcher7: Block fix.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=os.queueEvent<br />
|args=[[string]] eventName, param1, param2, param3<br />
|api=os<br />
|addon=ComputerCraft<br />
|desc=Adds an event <var>eventName</var> with the specified parameters to the event queue.<br />
|examples=<br />
{{Example<br />
|desc=The program adds an event which it will eventually pull.<br />
|code=<br />
os.queueEvent("abc", 2, "meow")<br />
while true do<br />
local event, param1, param2 = os.pullEvent()<br />
if event == "abc" then<br />
print("ABC EVENT! Parameters: " .. param1 .. " / " .. param2)<br />
else<br />
print("Event: " .. event)<br />
end<br />
end<br />
}}<br />
}}<br />
{{Example<br />
|desc=To easily have a redstone and a key input do the same,<br /><br />
it queues a key event with the appropriate key if a redstone event happens.<br />
|code=<br />
while true do<br />
local event, param1 = os.pullEvent()<br />
if event == "redstone" then<br />
if rs.getInput("left") then<br />
os.queueEvent("key", 28)<br />
end<br />
elseif event == "key" then<br />
if param1 == 28 then<br />
print("Hello")<br />
end<br />
end<br />
end<br />
}}</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Os.queueEvent&diff=3995Os.queueEvent2012-11-28T18:48:26Z<p>Watcher7: Fixed minor format inconsistencies within the code snippets.</p>
<hr />
<div>{{lowercase}}<br />
{{Function<br />
|name=os.queueEvent<br />
|args=[[string]] eventName, param1, param2, param3<br />
|api=os<br />
|addon=ComputerCraft<br />
|desc=Adds an event <var>eventName</var> with the specified parameters to the event queue.<br />
|examples=<br />
{{Example<br />
|desc=The program adds an event which it will eventually pull.<br />
|code=<br />
os.queueEvent("abc", 2, "meow")<br />
while true do<br />
local event, param1, param2 = os.pullEvent()<br />
if event == "abc" then<br />
print("ABC EVENT! Parameters: " .. param1 .. " / " .. param2)<br />
else<br />
print("Event: " .. event)<br />
end<br />
end<br />
}}<br />
}}<br />
{{Example<br />
|desc=To easily have a redstone and a key input do the same,<br /><br />
it queues a key event with the appropriate key if a redstone event happens.<br />
|code=<br />
while true do<br />
local event, param1 = os.pullEvent()<br />
if event == "redstone" then<br />
if rs.getInput("left") then<br />
os.queueEvent("key", 28)<br />
end<br />
elseif event == "key" then<br />
if param1 == 28 then<br />
print("Hello")<br />
end<br />
end<br />
end<br />
}}</div>Watcher7https://www.computercraft.info/wiki/index.php?title=User:Watcher7&diff=3853User:Watcher72012-11-26T09:34:20Z<p>Watcher7: imo user-page changes should be ignored</p>
<hr />
<div>wangs</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Textutils_(API)&diff=3840Textutils (API)2012-11-25T09:14:00Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>Text utilities is used to mess around with text easier.<br />
<br />
Its functions include:<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[textutils.slowPrint|textutils.slowPrint]]([[string (type)|string]] text, [[number (type)|number]] rate)<br />
|Slowly prints the text. Only difference is, it leaves a new-line after it.<br />
|-<br />
|[[textutils.slowWrite|textutils.slowWrite]]([[string (type)|string]] text, [[number (type)|number]] rate)<br />
|Slowly writes the text.<br />
|-<br />
|[[textutils.formatTime|textutils.formatTime]]([[number (type)|number]] time, [[boolean (type)|bool]] TwentyFourHour)<br />
|Put a time into it, and it spews it out in a different format. For example:<br />
local time = os.time()<br />
<br />
print(textutils.formatTime(time, false))<br />
|-<br />
|[[textutils.tabulate|textutils.tabulate]]([[table (type)|table]] table, [[table (type)|table]] table2, ...)<br />
|Prints tables in an ordered form. Each table is a row, columns' width is auto-adjusted.<br />
|-<br />
|[[textutils.pagedTabulate|textutils.pagedTabulate]]([[table (type)|table]] table, [[table (type)|table]] table2, ...)<br />
|<no description given><br />
|-<br />
|[[textutils.pagedPrint|textutils.pagedPrint]]([[string (type)|string]] string, [[string (type)|string]] confirmation_lines)<br />
|Prints a string onto the screen, but waits for confirmation before scrolling down.<br />
|-<br />
|[[textutils.serialize|textutils.serialize]]([[table (type)|table]] table)<br />
|Returns a string representation of the table t for storage or transmission.<br />
|-<br />
|[[textutils.unserialize|textutils.unserialize]]([[string (type)|string]] text)<br />
|Returns a table reassembled from the string s.<br />
|-<br />
|[[textutils.urlEncode|textutils.urlEncode]]([[string (type)|string]] text)<br />
|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].<br />
|}<br />
<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Textutils_(API)&diff=3839Textutils (API)2012-11-25T09:13:15Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>Text utilities is used to mess around with text easier.<br />
<br />
Its functions include:<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[textutils.slowPrint|textutils.slowPrint]]([[string (type)|string]] text, [[number (type)|number]] rate)<br />
|Slowly prints the text. Only difference is, it leaves a new-line after it.<br />
|-<br />
|[[textutils.slowWrite|textutils.slowWrite]]([[string (type)|string]] text, [[number (type)|number]] rate)<br />
|Slowly writes the text.<br />
|-<br />
|[[textutils.formatTime|textutils.formatTime]]([[number (type)|number]] time, [[boolean (type)|bool]] TwentyFourHour)<br />
|Put a time into it, and it spews it out in a different format. For example:<br />
local time = os.time()<br />
<br />
print(textutils.formatTime(time, false))<br />
|-<br />
|[[textutils.tabulate|textutils.tabulate]]([[table (type)|table]] table, [[table (type)|table]] table2, ...)<br />
|Prints tables in an ordered form. Each table is a row, columns' width is auto-adjusted.<br />
|-<br />
|[[textutils.pagedTabulate|textutils.pagedTabulate]]([[table (type)|table]] table, [[table (type)|table]]table2, ...)<br />
|<no description given><br />
|-<br />
|[[textutils.pagedPrint|textutils.pagedPrint]]([[string (type)|string]] string, [[string (type)|string]] confirmation_lines)<br />
|Prints a string onto the screen, but waits for confirmation before scrolling down.<br />
|-<br />
|[[textutils.serialize|textutils.serialize]]([[table (type)|table]] table)<br />
|Returns a string representation of the table t for storage or transmission.<br />
|-<br />
|[[textutils.unserialize|textutils.unserialize]]([[string (type)|string]] text)<br />
|Returns a table reassembled from the string s.<br />
|-<br />
|[[textutils.urlEncode|textutils.urlEncode]]([[string (type)|string]] text)<br />
|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].<br />
|}<br />
<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Bit_(API)&diff=3838Bit (API)2012-11-25T08:55:38Z<p>Watcher7: /* Methods: type listing inconsistencie fix. Bleh. */</p>
<hr />
<div>The Bit API is for manipulating numbers using bitwise binary operations.<br />
<br />
==Methods==<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[bit.tobits]]([[number (type)|number]] n)<br />
|Converts a number to an array (numerically-indexed table) containing the corresponding binary bit values<br />
|-<br />
|[[bit.blshift]]([[number (type)|number]] n, [[number (type)|number]] bits)<br />
|Shifts a number left by a specified number of bits<br />
|-<br />
|[[bit.brshift]]([[number (type)|number]] n, [[number (type)|number]] bits)<br />
|Shifts a number right by a specified number of bits<br />
|-<br />
|[[bit.bxor]]([[number (type)|number]] m, [[number (type)|number]] n)<br />
|Computes the bitwise exclusive OR of two numbers<br />
|-<br />
|[[bit.bor]]([[number (type)|number]] m, [[number (type)|number]] n)<br />
|Computes the bitwise inclusive OR of two numbers<br />
|-<br />
|[[bit.band]]([[number (type)|number]] m, [[number (type)|number]] n)<br />
|Computes the bitwise AND of two numbers<br />
|-<br />
|[[bit.bnot]]([[number (type)|number]] n)<br />
|Computes the bitwise NOT of a number<br />
|-<br />
|[[bit.tonumb]]([[table (type)|table]] bit_tbl)<br />
|Converts an array (numerically-indexed table) of 0 and 1 values representing a number in binary into that number<br />
|}<br />
<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Term_(API)&diff=3837Term (API)2012-11-25T08:48:06Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>The Terminal API provides functions for ASCII graphics.<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[term.write|term.write]](text)<br />
|Writes text to the screen.<br />
|-<br />
|[[term.clear|term.clear]]()<br />
|Clears the entire screen<br />
|-<br />
|[[term.clearLine|term.clearLine]]()<br />
|Clears the line the cursor is on<br />
|-<br />
|[[term.getCursorPos|term.getCursorPos]]()<br />
|Returns two arguments containing the x and the y position of the cursor.<br />
|-<br />
|[[Term.setCursorPos|term.setCursorPos]](x, y)<br />
|Sets the cursor's position.<br />
|-<br />
|[[Term.setCursorBlink|term.setCursorBlink]]()<br />
|Disables the blinking or turns it on.<br />
|-<br />
|[[Term.isColor|term.isColor]]()<br />
|Returns if the computer supports color. (Used to determine whether or not an advanced computer is being used)<br />
|-<br />
|[[term.getSize|term.getSize]]()<br />
|Returns two arguments containing the x and the y values stating the size of the screen. (Good for if you're making something to be compatible with both [[Turtles]] and [[Consoles]].)<br />
|-<br />
|[[term.scroll|term.scroll]](n)<br />
|Scrolls the terminal ''n'' lines.<br />
|-<br />
|[[term.redirect|term.redirect]](target)<br />
|Redirects terminal output to a monitor or other redirect target. (Use [[peripheral.wrap]] to acquire a monitor "object".)<br />
|-<br />
|[[term.restore|term.restore]]()<br />
|Restores terminal output to the previous target.<br />
|-<br />
|[[term.setTextColor|term.setTextColor]]([[Colors#Colors|color]])<br />
|Sets the foreground color for text subsequently written to the terminal. '''Note:''' only available on [[Advanced Computer|Advanced Computers]].<br />
|-<br />
|[[term.setBackgroundColor]]([[Colors#Colors|color]])<br />
|Sets the background color for text subsequently written to the terminal. '''Note:''' only available on [[Advanced Computer|Advanced Computers]].<br />
|-<br />
|}<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Shell_(API)&diff=3836Shell (API)2012-11-25T08:45:46Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell].<br />
<br />
==Methods==<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[shell.exit]]()<br />
|Exits the current shell<br />
|-<br />
|[[shell.dir]]()<br />
|Returns the directory<br />
|-<br />
|[[shell.setDir]](path)<br />
|Sets the directory<br />
|-<br />
|[[shell.path]]()<br />
|Returns the path<br />
|-<br />
|[[shell.setPath]](path)<br />
|Sets the path<br />
|-<br />
|[[shell.resolve]](localpath)<br />
|Resolves a local path to an absolute path.<br />
|-<br />
|[[shell.resolveProgram]](name)<br />
|Resolves the absolute path to the program whose name you provided.<br />
<br />
|-<br />
|[[shell.aliases]]()<br />
|Returns aliases.<br />
|-<br />
|[[shell.setAlias]](alias, command)<br />
|Sets an alias.<br />
|-<br />
|[[shell.clearAlias]](alias, command)<br />
|Clears an alias.<br />
|-<br />
|[[shell.programs]]()<br />
|Returns programs.<br />
|-<br />
|[[shell.run]](program, arguments)<br />
|Runs a program.<br />
|-<br />
|[[shell.getRunningProgram]]()<br />
|Returns the absolute path to the currently-executing program.<br />
|-<br />
|}<br />
<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Rednet_(API)&diff=3835Rednet (API)2012-11-25T08:43:46Z<p>Watcher7: /* Events fix. */</p>
<hr />
<div>The rednet API allows computers to communicate between themselves without using redstone wires. In order to send and receive data, a [[modem]] is required. The data is received immediately after sending it, but only by computers within a certain range. That range depends on the altitude of the sending computer increasing with higher altitudes to a max of 384.<br />
<br />
==History==<br />
Before the creation of the in-game wireless networking API, the term "Rednet" referred to a system created by one of the ComputerCraft users based on bundled cables from a popular Minecraft mod - RedPower. It also allowed communication between computers, but the data was transferred slowly - every bit was converted to redstone signal, that lasted about 0,1 seconds. On the release of ComputerCraft 1.3, the system became useless, as the wireless networking was officially implemented to the mod.<br />
<br />
==Methods==<br />
{| border="1" cellpadding="5" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
!style="background:#EEE" width="80px"|Return type<br />
|-<br />
|[[rednet.open]](side)<br />
|Tells the computer that the side can be used for networking.<br />
|nil<br />
|-<br />
|[[rednet.close]](side)<br />
|Tells the computer that the side can no longer be used for networking.<br />
|nil<br />
|-<br />
|[[rednet.announce]]()<br />
|Broadcasts an empty rednet message.<br />
|success<br />
|-<br />
|[[rednet.send]](receiverID, message)<br />
|Sends a message to the computer using the opened sides. The receiver ID is the ID (number, not string) of the computer you're sending the message to. ID as nil will do the same as a broadcast.<br />
|success<br />
|-<br />
|[[rednet.broadcast]](message)<br />
|Sends the message to ALL connected and open computers.<br />
|success<br />
|-<br />
|[[rednet.receive]](timeout)<br />
|Waits until it received a rednet message or <var>timeout</var> has passed. Leave args empty to wait for a message forever.<br />
|senderId, message, distance<br />
|-<br />
|rednet.isOpen(side)<br />
|Returns true if the wireless modem is open or nil if not. Returns 1 always.<br />
|Boolean, integer<br />
|}<br />
<br />
==Events==<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Event name<br />
!style="background:#EEE" width="*"|Description<br />
!style="background:#EEE" width="*"|Parameters<br />
|-<br />
|rednet_message<br />
|Fired when a rednet message is received (can be used as alternative for rednet.receive())<br />
|senderId, message, distance<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Peripheral_(API)&diff=3834Peripheral (API)2012-11-25T08:41:34Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>The peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the disk drive and monitor.<br /><br />
[[Console|Consoles]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''shutdown'', ''reboot'', ''getID''.<br />
<br />
==Methods==<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[peripheral.isPresent]](side)<br />
|Returns '''true''' if a peripheral is present on ''side''.<br />
|-<br />
|[[peripheral.getType]](side)<br />
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.<br />
|-<br />
|[[peripheral.getMethods]](side)<br />
|Returns a table containing all methods for peripheral on ''side''.<br />
|-<br />
|[[peripheral.call]](side, methodName, param1, param2, ...)<br />
|Sends a function call to peripheral located on ''side''. Return values match those of called method.<br /><br />
'''Note:''' ''methodName'' is a string.<br />
|-<br />
|[[peripheral.wrap]](side)<br />
|Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available from that peripheral, as if calling '''peripheral.call()''', e.g.:<br /><br />
m = [[peripheral.wrap]]("left")<br /><br />
m.someMethod()<br /><br />
''- is the same as -''<br /><br />
[[peripheral.call]]("left","someMethod")<br />
|}<br />
<br />
==Events==<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Event name<br />
!style="background:#EEE" width="*"|Description<br />
!style="background:#EEE" width="*"|Parameters<br />
|-<br />
|peripheral<br />
|Fired when peripheral is attached<br />
|side<br />
|-<br />
|peripheral_detach<br />
|Fired when peripheral is removed<br />
|side<br />
|}<br />
==Monitor==<br />
List of methods:<br />
<br />
'''''monitor'' stands for the variable you wrapped the monitor to.'''<br />
''Example:'' monitor = peripheral.wrap( "top" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[term.write|''monitor''.write]]()<br />
|Write to the Monitor's screen.<br />
|-<br />
|[[term.scroll|''monitor''.scroll]](n)<br />
|Scrolls the monitor screen.<br />
|-<br />
|[[term.setCursorPos|''monitor''.setCursorPos]](x, y)<br />
|Sets the cursor position on the Monitor.<br />
|-<br />
|[[term.setCursorBlink|''monitor''.setCursorBlink]](b)<br />
|Enables or disables cursor blinking.<br />
|-<br />
|[[term.getCursorPos|''monitor''.getCursorPos]]()<br />
|Returns two arguments containing the x and the y position of the cursor on the Monitor.<br />
|-<br />
|[[term.getSize|''monitor''.getSize]]()<br />
|Returns two arguments containing the x and the y values stating the size of the Monitor. <br />
|-<br />
|[[term.clear|''monitor''.clear]]()<br />
|Clears the Monitor.<br />
|-<br />
|[[term.clearLine|''monitor''.clearLine]]()<br />
|Clears the line the cursor is on.<br />
|-<br />
|[[monitor.setTextScale|''monitor''.setTextScale]](scale)<br />
|Sets the size of the text on the Monitor. Textscale can be between 0.5 and 5.0, with increments of 0.5<br />
|}<br />
<br />
==Printer==<br />
List of methods:<br />
<br />
'''''printer'' stands for the variable you wrapped the printer to.'''<br />
''Example:'' printer = peripheral.wrap( "right" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[printer.newPage]]()<br />
|Starts a new page. Returns true if page got started, false if not.<br />
|-<br />
|[[printer.endPage]]()<br />
|Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.<br />
|-<br />
|[[printer.write]](text)<br />
|Writes text to the paper, works the same way as [[term.write()]]<br />
|-<br />
|[[printer.setPageTitle]](text)<br />
|Sets the title of the page.<br />
|-<br />
|[[printer.getPaperLevel]]()<br />
|Returns the amount of paper available in the paper tray.<br />
|-<br />
|[[printer.getInkLevel]]()<br />
|Returns the amount of ink in the ink slot.<br />
|-<br />
|[[printer.getCursorPos]]()<br />
|Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos()]]<br />
|-<br />
|[[printer.setCursorPos]](x, y)<br />
|Sets the cursor pos, works the same way as [[term.setCursorPos()]]<br />
|-<br />
|[[printer.getPageSize]]()<br />
|Returns the size of the paper, works the same way as [[term.getSize()]]<br />
|}<br />
<br />
==Computers==<br />
List of methods:<br />
<br />
'''''computer'' stands for the variable you wrapped the computer to.'''<br />
''Example:'' computer = peripheral.wrap( "top" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|''computer''.turnOn()<br />
|Turns on the Computer or Turtle.<br />
|-<br />
|''computer''.shutdown()<br />
|Shuts off the Computer or Turtle.<br />
|-<br />
|''computer''.reboot()<br />
|Reboots the Computer or Turtle.<br />
|-<br />
|''computer''.getID()<br />
|Gets the ID of the Computer or Turtle.<br />
|}<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Peripheral_(API)&diff=3833Peripheral (API)2012-11-25T08:37:53Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>The peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the disk drive and monitor.<br /><br />
[[Console|Consoles]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''shutdown'', ''reboot'', ''getID''.<br />
<br />
==Methods==<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[peripheral.isPresent]](side)<br />
|Returns '''true''' if a peripheral is present on ''side''.<br />
|-<br />
|[[peripheral.getType]](side)<br />
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.<br />
|-<br />
|[[peripheral.getMethods]](side)<br />
|Returns a table containing all methods for peripheral on ''side''.<br />
|-<br />
|[[peripheral.call]](side, methodName, param1, param2, ...)<br />
|Sends a function call to peripheral located on ''side''. Return values match those of called method.<br /><br />
'''Note:''' ''methodName'' is a string.<br />
|-<br />
|[[peripheral.wrap]](side)<br />
|Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available from that peripheral, as if calling '''peripheral.call()''', e.g.:<br /><br />
m = [[peripheral.wrap]]("left")<br /><br />
m.someMethod()<br /><br />
''- is the same as -''<br /><br />
[[peripheral.call]]("left","someMethod")<br />
|}<br />
<br />
==Events==<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Event name<br />
!style="background:#EEE" width="*"|Description<br />
!style="background:#EEE" width="*"|Parameters<br />
|-<br />
|peripheral<br />
|Fired when peripheral is attached<br />
|side<br />
|-<br />
|peripheral_detach<br />
|Fired when peripheral is removed<br />
|side<br />
|}<br />
==Monitor==<br />
List of methods:<br />
<br />
'''''monitor'' stands for the variable you wrapped the monitor to.'''<br />
''Example:'' monitor = peripheral.wrap( "top" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[term.write|''monitor''.write]]()<br />
|Write to the Monitor's screen.<br />
|-<br />
|[[term.scroll|''monitor''.scroll]](n)<br />
|Scrolls the monitor screen.<br />
|-<br />
|[[term.setCursorPos|''monitor''.setCursorPos]](x, y)<br />
|Sets the cursor position on the Monitor.<br />
|-<br />
|[[term.setCursorBlink|''monitor''.setCursorBlink]](b)<br />
|Enables or disables cursor blinking.<br />
|-<br />
|[[term.getCursorPos|''monitor''.getCursorPos]]()<br />
|Returns two arguments containing the x and the y position of the cursor on the Monitor.<br />
|-<br />
|[[term.getSize|''monitor''.getSize]]()<br />
|Returns two arguments containing the x and the y values stating the size of the Monitor. <br />
|-<br />
|[[term.clear|''monitor''.clear]]()<br />
|Clears the Monitor.<br />
|-<br />
|[[term.clearLine|''monitor''.clearLine]]()<br />
|Clears the line the cursor is on.<br />
|-<br />
|[[monitor.setTextScale|''monitor''.setTextScale]](scale)<br />
|Sets the size of the text on the Monitor. Textscale can be between 0.5 and 5.0, with increments of 0.5<br />
|}<br />
<br />
==Printer==<br />
List of methods:<br />
<br />
'''''printer'' stands for the variable you wrapped the printer to.'''<br />
''Example:'' printer = peripheral.wrap( "right" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|''printer''.[[printer.newPage|newPage]]()<br />
|Starts a new page. Returns true if page got started, false if not.<br />
|-<br />
|''printer''.[[printer.endPage|endPage]]()<br />
|Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.<br />
|-<br />
|''printer''.[[printer.write|write]](text)<br />
|Writes text to the paper, works the same way as [[term.write()]]<br />
|-<br />
|''printer''.[[printer.setPageTitle|setPageTitle]](text)<br />
|Sets the title of the page.<br />
|-<br />
|''printer''.[[printer.getPaperLevel|getPaperLevel]]()<br />
|Returns the amount of paper available in the paper tray.<br />
|-<br />
|''printer''.[[printer.getInkLevel|getInkLevel]]()<br />
|Returns the amount of ink in the ink slot.<br />
|-<br />
|''printer''.[[printer.getCursorPos|getCursorPos]]()<br />
|Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos()]]<br />
|-<br />
|''printer''.[[printer.setCursorPos|setCursorPos]](x, y)<br />
|Sets the cursor pos, works the same way as [[term.setCursorPos()]]<br />
|-<br />
|''printer''.[[printer.getPageSize|getPageSize]]()<br />
|Returns the size of the paper, works the same way as [[term.getSize()]]<br />
|}<br />
<br />
==Computers==<br />
List of methods:<br />
<br />
'''''computer'' stands for the variable you wrapped the computer to.'''<br />
''Example:'' computer = peripheral.wrap( "top" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|''computer''.turnOn()<br />
|Turns on the Computer or Turtle.<br />
|-<br />
|''computer''.shutdown()<br />
|Shuts off the Computer or Turtle.<br />
|-<br />
|''computer''.reboot()<br />
|Reboots the Computer or Turtle.<br />
|-<br />
|''computer''.getID()<br />
|Gets the ID of the Computer or Turtle.<br />
|}<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Peripheral_(API)&diff=3832Peripheral (API)2012-11-25T08:37:10Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>The peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the disk drive and monitor.<br /><br />
[[Console|Consoles]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''shutdown'', ''reboot'', ''getID''.<br />
<br />
==Methods==<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[peripheral.isPresent]](side)<br />
|Returns '''true''' if a peripheral is present on ''side''.<br />
|-<br />
|[[peripheral.getType]](side)<br />
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.<br />
|-<br />
|[[peripheral.getMethods]](side)<br />
|Returns a table containing all methods for peripheral on ''side''.<br />
|-<br />
|[[peripheral.call]](side, methodName, param1, param2, ...)<br />
|Sends a function call to peripheral located on ''side''. Return values match those of called method.<br /><br />
'''Note:''' ''methodName'' is a string.<br />
|-<br />
|[[peripheral.wrap]](side)<br />
|Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available from that peripheral, as if calling '''peripheral.call()''', e.g.:<br /><br />
m = [[peripheral.wrap]]("left")<br /><br />
m.someMethod()<br /><br />
''- is the same as -''<br /><br />
[[peripheral.call]]("left","someMethod")<br />
|}<br />
<br />
==Events==<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Event name<br />
!style="background:#EEE" width="*"|Description<br />
!style="background:#EEE" width="*"|Parameters<br />
|-<br />
|peripheral<br />
|Fired when peripheral is attached<br />
|side<br />
|-<br />
|peripheral_detach<br />
|Fired when peripheral is removed<br />
|side<br />
|}<br />
==Monitor==<br />
List of methods:<br />
<br />
'''''monitor'' stands for the variable you wrapped the monitor to.'''<br />
''Example:'' monitor = peripheral.wrap( "top" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[term.write|''monitor''.write]]()<br />
|Write to the Monitor's screen.<br />
|-<br />
|[[term.scroll|''monitor''.scroll]](n)<br />
|Scrolls the monitor screen.<br />
|-<br />
|[[term.setCursorPos|''monitor''.setCursorPos]](x, y)<br />
|Sets the cursor position on the Monitor.<br />
|-<br />
|[[term.setCursorBlink|''monitor''.setCursorBlink]](b)<br />
|Enables or disables cursor blinking.<br />
|-<br />
|[[term.getCursorPos|''monitor''.getCursorPos]]()<br />
|Returns two arguments containing the x and the y position of the cursor on the Monitor.<br />
|-<br />
|[[term.getSize|''monitor''.getSize]]()<br />
|Returns two arguments containing the x and the y values stating the size of the Monitor. <br />
|-<br />
|[[term.clear|''monitor''.clear]]()<br />
|Clears the Monitor.<br />
|-<br />
|[[term.clearLine|''monitor''.clearLine]]()<br />
|Clears the line the cursor is on.<br />
|-<br />
|[[monitor.setTextScale|''monitor''.setTextScale]](scale)<br />
|Sets the size of the text on the Monitor. Textscale can be between 0.5 and 5.0, with increments of 0.5<br />
|}<br />
<br />
==Printer==<br />
List of methods:<br />
<br />
'''''printer'' stands for the variable you wrapped the printer to.'''<br />
''Example:'' printer = peripheral.wrap( "right" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|''printer''.[[printer.newPage|newPage]]()<br />
|Starts a new page. Returns true if page got started, false if not.<br />
|-<br />
|''printer''.[[printer.endPage|endPage]]()<br />
|Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.<br />
|-<br />
|''printer''.[[printer.write|write]]( text )<br />
|Writes text to the paper, works the same way as [[term.write()]]<br />
|-<br />
|''printer''.[[printer.setPageTitle|setPageTitle]]( text )<br />
|Sets the title of the page.<br />
|-<br />
|''printer''.[[printer.getPaperLevel|getPaperLevel]]()<br />
|Returns the amount of paper available in the paper tray.<br />
|-<br />
|''printer''.[[printer.getInkLevel|getInkLevel]]()<br />
|Returns the amount of ink in the ink slot.<br />
|-<br />
|''printer''.[[printer.getCursorPos|getCursorPos]]()<br />
|Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos()]]<br />
|-<br />
|''printer''.[[printer.setCursorPos|setCursorPos]]( x, y )<br />
|Sets the cursor pos, works the same way as [[term.setCursorPos()]]<br />
|-<br />
|''printer''.[[printer.getPageSize|getPageSize]]()<br />
|Returns the size of the paper, works the same way as [[term.getSize()]]<br />
|}<br />
<br />
==Computers==<br />
List of methods:<br />
<br />
'''''computer'' stands for the variable you wrapped the computer to.'''<br />
''Example:'' computer = peripheral.wrap( "top" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|''computer''.turnOn()<br />
|Turns on the Computer or Turtle.<br />
|-<br />
|''computer''.shutdown()<br />
|Shuts off the Computer or Turtle.<br />
|-<br />
|''computer''.reboot()<br />
|Reboots the Computer or Turtle.<br />
|-<br />
|''computer''.getID()<br />
|Gets the ID of the Computer or Turtle.<br />
|}<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Peripheral_(API)&diff=3831Peripheral (API)2012-11-25T08:36:29Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>The peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the disk drive and monitor.<br /><br />
[[Console|Consoles]] and [[Turtle|Turtles]] are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to [[Rednet (API)|rednet]]. Both Computers and Turtles provide the same methods: ''turnOn'', ''shutdown'', ''reboot'', ''getID''.<br />
<br />
==Methods==<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[peripheral.isPresent]](side)<br />
|Returns '''true''' if a peripheral is present on ''side''.<br />
|-<br />
|[[peripheral.getType]](side)<br />
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.<br />
|-<br />
|[[peripheral.getMethods]](side)<br />
|Returns a table containing all methods for peripheral on ''side''.<br />
|-<br />
|[[peripheral.call]](side, methodName, param1, param2, ...)<br />
|Sends a function call to peripheral located on ''side''. Return values match those of called method.<br /><br />
'''Note:''' ''methodName'' is a string.<br />
|-<br />
|[[peripheral.wrap]](side)<br />
|Returns a handle to the peripheral located on ''side''. If assigned to a variable, it can be used to call all methods available from that peripheral, as if calling '''peripheral.call()''', e.g.:<br /><br />
m = [[peripheral.wrap]]("left")<br /><br />
m.someMethod()<br /><br />
''- is the same as -''<br /><br />
[[peripheral.call]]("left","someMethod")<br />
|}<br />
<br />
==Events==<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Event name<br />
!style="background:#EEE" width="*"|Description<br />
!style="background:#EEE" width="*"|Parameters<br />
|-<br />
|peripheral<br />
|Fired when peripheral is attached<br />
|side<br />
|-<br />
|peripheral_detach<br />
|Fired when peripheral is removed<br />
|side<br />
|}<br />
==Monitor==<br />
List of methods:<br />
<br />
'''''monitor'' stands for the variable you wrapped the monitor to.'''<br />
''Example:'' monitor = peripheral.wrap( "top" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[term.write|''monitor''.write]]()<br />
|Write to the Monitor's screen.<br />
|-<br />
|[[term.scroll|''monitor''.scroll]]( n )<br />
|Scrolls the monitor screen.<br />
|-<br />
|[[term.setCursorPos|''monitor''.setCursorPos]]( x, y )<br />
|Sets the cursor position on the Monitor.<br />
|-<br />
|[[term.setCursorBlink|''monitor''.setCursorBlink]]( b )<br />
|Enables or disables cursor blinking.<br />
|-<br />
|[[term.getCursorPos|''monitor''.getCursorPos]]()<br />
|Returns two arguments containing the x and the y position of the cursor on the Monitor.<br />
|-<br />
|[[term.getSize|''monitor''.getSize]]()<br />
|Returns two arguments containing the x and the y values stating the size of the Monitor. <br />
|-<br />
|[[term.clear|''monitor''.clear]]()<br />
|Clears the Monitor.<br />
|-<br />
|[[term.clearLine|''monitor''.clearLine]]()<br />
|Clears the line the cursor is on.<br />
|-<br />
|[[monitor.setTextScale|''monitor''.setTextScale]]( scale )<br />
|Sets the size of the text on the Monitor. Textscale can be between 0.5 and 5.0, with increments of 0.5<br />
|}<br />
<br />
==Printer==<br />
List of methods:<br />
<br />
'''''printer'' stands for the variable you wrapped the printer to.'''<br />
''Example:'' printer = peripheral.wrap( "right" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|''printer''.[[printer.newPage|newPage]]()<br />
|Starts a new page. Returns true if page got started, false if not.<br />
|-<br />
|''printer''.[[printer.endPage|endPage]]()<br />
|Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.<br />
|-<br />
|''printer''.[[printer.write|write]]( text )<br />
|Writes text to the paper, works the same way as [[term.write()]]<br />
|-<br />
|''printer''.[[printer.setPageTitle|setPageTitle]]( text )<br />
|Sets the title of the page.<br />
|-<br />
|''printer''.[[printer.getPaperLevel|getPaperLevel]]()<br />
|Returns the amount of paper available in the paper tray.<br />
|-<br />
|''printer''.[[printer.getInkLevel|getInkLevel]]()<br />
|Returns the amount of ink in the ink slot.<br />
|-<br />
|''printer''.[[printer.getCursorPos|getCursorPos]]()<br />
|Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos()]]<br />
|-<br />
|''printer''.[[printer.setCursorPos|setCursorPos]]( x, y )<br />
|Sets the cursor pos, works the same way as [[term.setCursorPos()]]<br />
|-<br />
|''printer''.[[printer.getPageSize|getPageSize]]()<br />
|Returns the size of the paper, works the same way as [[term.getSize()]]<br />
|}<br />
<br />
==Computers==<br />
List of methods:<br />
<br />
'''''computer'' stands for the variable you wrapped the computer to.'''<br />
''Example:'' computer = peripheral.wrap( "top" )<br />
<br />
{| class="wikitable"<br />
!style="background:#EEE" width="210px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|''computer''.turnOn()<br />
|Turns on the Computer or Turtle.<br />
|-<br />
|''computer''.shutdown()<br />
|Shuts off the Computer or Turtle.<br />
|-<br />
|''computer''.reboot()<br />
|Reboots the Computer or Turtle.<br />
|-<br />
|''computer''.getID()<br />
|Gets the ID of the Computer or Turtle.<br />
|}<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Parallel_(API)&diff=3830Parallel (API)2012-11-25T08:35:16Z<p>Watcher7: </p>
<hr />
<div>Parallel is an API which allows you to multitask.<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[parallel.waitForAny]](function1, function2, ...)<br />
|Runs all the functions at the same time, and stops when any of them returns.<br />
|-<br />
|[[parallel.waitForAll]](function1, function2, ...)<br />
|Runs all the functions at the same time, and stops when all of them have returned.<br />
|}<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Paintutils_(API)&diff=3829Paintutils (API)2012-11-25T08:33:26Z<p>Watcher7: /* Methods fix, shit was all over the place. */</p>
<hr />
<div>Paintutils is an API to draw and load images<br />
<br />
==Methods==<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="300px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[paintutils.loadImage]](path)<br />
|Returns an image object.<br />
|-<br />
|[[paintutils.drawImage]](image, x, y)<br />
|Draws an image at (x, y) where image is an image object.<br />
|-<br />
|[[paintutils.drawPixel]](x, y, colour)<br />
|Draws a pixel at (x, y) in the colour specified.<br />
|-<br />
|[[paintutils.drawLine]](startX, startY, endX, endY, colour)<br />
|Draws a line from (startX, startY) to (endX, endY) in the colour specified.<br />
<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Help_(API)&diff=3828Help (API)2012-11-25T08:29:48Z<p>Watcher7: /* Methods fix. */</p>
<hr />
<div>The Help API allows you to mess around with the help files.<br />
<br />
==Methods==<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[help.path]]()<br />
|Returns the path the help API has been set to <br />
|-<br />
|[[help.setPath]]([[string (type)|string]] path)<br />
|Sets the path of the API to ''path''<br />
|-<br />
|[[help.lookup]]([[string (type)|string]] topic)<br />
|Looks up the help file for ''topic''<br />
|-<br />
|[[help.topics]]()<br />
|Returns a table of valid help topics<br />
|}<br />
[[Category:APIs]]</div>Watcher7https://www.computercraft.info/wiki/index.php?title=Term_(API)&diff=3823Term (API)2012-11-24T10:04:49Z<p>Watcher7: Paran-spacing.</p>
<hr />
<div>The Terminal API provides functions for ASCII graphics.<br />
{| border="1" cellpadding="2" cellspacing="0"<br />
!style="background:#EEE" width="200px"|Method name<br />
!style="background:#EEE" width="*"|Description<br />
|-<br />
|[[term.write|term.write( text )]]<br />
|Writes text to the screen.<br />
|-<br />
|[[term.clear|term.clear()]]<br />
|Clears the entire screen<br />
|-<br />
|[[term.clearLine|term.clearLine()]]<br />
|Clears the line the cursor is on<br />
|-<br />
|[[term.getCursorPos|term.getCursorPos()]]<br />
|Returns two arguments containing the x and the y position of the cursor.<br />
|-<br />
|[[Term.setCursorPos|term.setCursorPos( x, y )]]<br />
|Sets the cursor's position.<br />
|-<br />
|[[Term.setCursorBlink|term.setCursorBlink( b )]]<br />
|Disables the blinking or turns it on.<br />
|-<br />
|[[Term.isColor|term.isColor()]]<br />
|Returns if the computer supports color. (Used to determine whether or not an advanced computer is being used)<br />
|-<br />
|[[term.getSize|term.getSize()]]<br />
|Returns two arguments containing the x and the y values stating the size of the screen. (Good for if you're making something to be compatible with both [[Turtles]] and [[Consoles]].)<br />
|-<br />
|[[term.scroll|term.scroll( n )]]<br />
|Scrolls the terminal ''n'' lines.<br />
|-<br />
|[[term.redirect|term.redirect( target )]]<br />
|Redirects terminal output to a monitor or other redirect target. (Use [[peripheral.wrap]] to acquire a monitor "object".)<br />
|-<br />
|[[term.restore|term.restore()]]<br />
|Restores terminal output to the previous target.<br />
|-<br />
|[[term.setTextColor|term.setTextColor]]( [[Colors#Colors|color]] )<br />
|Sets the foreground color for text subsequently written to the terminal. '''Note:''' only available on [[Advanced Computer|Advanced Computers]].<br />
|-<br />
|[[term.setBackgroundColor]]( [[Colors#Colors|color]] )<br />
|Sets the background color for text subsequently written to the terminal. '''Note:''' only available on [[Advanced Computer|Advanced Computers]].<br />
|-<br />
|}<br />
[[Category:APIs]]</div>Watcher7