ComputerCraft Wiki - User contributions [en]

Peripheral (API)

2012-09-23T13:54:06Z

SandroHc:

The peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the disk drive and monitor.<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''.

==Methods==
{| class="wikitable"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[peripheral.isPresent]]( side )
|Returns '''true''' if a peripheral is present on ''side''.
|-
|[[peripheral.getType]]( side )
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.
|-
|[[peripheral.getMethods]]( side )
|Returns a table containing all methods for peripheral on ''side''.
|-
|[[peripheral.call]]( side, methodName, param1, param2, ... )
|Sends a function call to peripheral located on ''side''. Return values match those of called method.<br />
'''Note:''' ''methodName'' is a string.
|-
|[[peripheral.wrap]]( side )
|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 />
m = [[peripheral.wrap]]("left")<br />
m.someMethod()<br />
''- is the same as -''<br />
[[peripheral.call]]("left","someMethod")
|}

==Events==
{| class="wikitable"
!style="background:#EEE" width="210px"|Event name
!style="background:#EEE" width="*"|Description
!style="background:#EEE" width="*"|Parameters
|-
|peripheral
|Fired when peripheral is attached
|side
|-
|peripheral_detach
|Fired when peripheral is removed
|side
|}
==Monitor==
List of methods:

'''''mon'' stands for the variable you wrapped the monitor to.'''
''Example:'' mon = peripheral.wrap( "top" )

{| class="wikitable"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[term.write|''mon''.write]]()
|Write to the Monitor's screen.
|-
|[[term.scroll|''mon''.scroll]]( n )
|Scrolls the monitor screen.
|-
|[[term.setCursorPos|''mon''.setCursorPos]]( x, y )
|Sets the cursor position on the Monitor.
|-
|[[term.setCursorBlink|''mon''.setCursorBlink]]( b )
|Enables or disables cursor blinking.
|-
|[[term.getCursorPos|''mon''.getCursorPos]]()
|Returns two arguments containing the x and the y position of the cursor on the Monitor.
|-
|[[term.getSize|''mon''.getSize]]()
|Returns two arguments containing the x and the y values stating the size of the Monitor.
|-
|[[term.clear|''mon''.clear]]()
|Clears the Monitor.
|-
|[[term.clearLine|''mon''.clearLine]]()
|Clears the line the cursor is on.
|-
|''mon''.setTextScale( scale )
|Sets the size of the text on the Monitor. Textscale can be between 1.0 and 5.0, with increments of 0.5
|}
==Printer==
'''printer''' stands for the variable you wrapped the printer to. Example:
<pre>printer = peripheral.wrap( "right" )

printer.newPage()</pre>

List of methods:
{| class="wikitable"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|printer.[[printer.newPage|newPage]]()
|Starts a new page. Returns true if page got started, false if not.
|-
|printer.[[printer.endPage|endPage]]()
|Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.
|-
|printer.[[printer.write|write]]( text )
|Writes text to the paper, works the same way as [[term.write()]]
|-
|printer.[[printer.setPageTitle|setPageTitle]]( text )
|Sets the title of the page.
|-
|printer.[[printer.getPaperLevel|getPaperLevel]]()
|Returns the amount of paper available in the paper tray.
|-
|printer.[[printer.getInkLevel|getInkLevel]]()
|Returns the amount of ink in the ink slot.
|-
|printer.[[printer.getCursorPos|getCursorPos]]()
|Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos()]]
|-
|printer.[[printer.setCursorPos|setCursorPos]]( x, y )
|Sets the cursor pos.
|-
|printer.[[printer.getPageSize|getPageSize]]()
|Returns the size of the paper, works the same way as [[term.getSize()]]
|}

==Computers==
List of methods:

'''''computer'' stands for the variable you wrapped the computer to.'''
''Example:'' computer = peripheral.wrap( "top" )

{| class="wikitable"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|''computer''.turnOn()
|Turns on the Computer or Turtle.
|-
|''computer''.shutdown()
|Shuts off the Computer or Turtle.
|-
|''computer''.reboot()
|Reboots the Computer or Turtle.
|-
|''computer''.getID()
|Gets the ID of the Computer or Turtle.
|}
[[Category:APIs]]

Peripheral (API)

2012-09-23T13:53:03Z

SandroHc: /* Printer */

The peripheral API is for interacting with external [http://en.wikipedia.org/wiki/Peripheral peripherals], such as the disk drive and monitor.<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''.

==Methods==
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[peripheral.isPresent]]( side )
|Returns '''true''' if a peripheral is present on ''side''.
|-
|[[peripheral.getType]]( side )
|Returns the type or peripheral present on ''side'', nothing returned if ''side'' is empty.
|-
|[[peripheral.getMethods]]( side )
|Returns a table containing all methods for peripheral on ''side''.
|-
|[[peripheral.call]]( side, methodName, param1, param2, ... )
|Sends a function call to peripheral located on ''side''. Return values match those of called method.<br />
'''Note:''' ''methodName'' is a string.
|-
|[[peripheral.wrap]]( side )
|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 />
m = [[peripheral.wrap]]("left")<br />
m.someMethod()<br />
''- is the same as -''<br />
[[peripheral.call]]("left","someMethod")
|}

==Events==
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="210px"|Event name
!style="background:#EEE" width="*"|Description
!style="background:#EEE" width="*"|Parameters
|-
|peripheral
|Fired when peripheral is attached
|side
|-
|peripheral_detach
|Fired when peripheral is removed
|side
|}
==Monitor==
List of methods:

'''''mon'' stands for the variable you wrapped the monitor to.'''
''Example:'' mon = peripheral.wrap( "top" )

{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[term.write|''mon''.write]]()
|Write to the Monitor's screen.
|-
|[[term.scroll|''mon''.scroll]]( n )
|Scrolls the monitor screen.
|-
|[[term.setCursorPos|''mon''.setCursorPos]]( x, y )
|Sets the cursor position on the Monitor.
|-
|[[term.setCursorBlink|''mon''.setCursorBlink]]( b )
|Enables or disables cursor blinking.
|-
|[[term.getCursorPos|''mon''.getCursorPos]]()
|Returns two arguments containing the x and the y position of the cursor on the Monitor.
|-
|[[term.getSize|''mon''.getSize]]()
|Returns two arguments containing the x and the y values stating the size of the Monitor.
|-
|[[term.clear|''mon''.clear]]()
|Clears the Monitor.
|-
|[[term.clearLine|''mon''.clearLine]]()
|Clears the line the cursor is on.
|-
|''mon''.setTextScale( scale )
|Sets the size of the text on the Monitor. Textscale can be between 1.0 and 5.0, with increments of 0.5
|}
==Printer==
'''printer''' stands for the variable you wrapped the printer to. Example:
<pre>printer = peripheral.wrap( "right" )

printer.newPage()</pre>

List of methods:
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|printer.[[printer.newPage|newPage]]()
|Starts a new page. Returns true if page got started, false if not.
|-
|printer.[[printer.endPage|endPage]]()
|Ends the page and prints the page to the output tray. Returns true if page was ended, false if not.
|-
|printer.[[printer.write|write]]( text )
|Writes text to the paper, works the same way as [[term.write()]]
|-
|printer.[[printer.setPageTitle|setPageTitle]]( text )
|Sets the title of the page.
|-
|printer.[[printer.getPaperLevel|getPaperLevel]]()
|Returns the amount of paper available in the paper tray.
|-
|printer.[[printer.getInkLevel|getInkLevel]]()
|Returns the amount of ink in the ink slot.
|-
|printer.[[printer.getCursorPos|getCursorPos]]()
|Returns the coordinates of the cursor on the paper, works the same way as [[term.getCursorPos()]]
|-
|printer.[[printer.setCursorPos|setCursorPos]]( x, y )
|Sets the cursor pos.
|-
|printer.[[printer.getPageSize|getPageSize]]()
|Returns the size of the paper, works the same way as [[term.getSize()]]
|}

==Computers==
List of methods:

'''''computer'' stands for the variable you wrapped the computer to.'''
''Example:'' computer = peripheral.wrap( "top" )

{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="210px"|Method name
!style="background:#EEE" width="*"|Description
|-
|''computer''.turnOn()
|Turns on the Computer or Turtle.
|-
|''computer''.shutdown()
|Shuts off the Computer or Turtle.
|-
|''computer''.reboot()
|Reboots the Computer or Turtle.
|-
|''computer''.getID()
|Gets the ID of the Computer or Turtle.
|}
[[Category:APIs]]

Template:News

2012-09-22T18:09:55Z

SandroHc:

'''September 22, 2012''':
*ComputerCraft 1.42 is out for Minecraft 1.3.2!

Template:Changelog

2012-09-22T18:06:21Z

SandroHc: Updating

{| class="wikitable sortable" style="width: 100%"
! style="width: 15%" | Version
! class="unsortable" | New Features or Changes
! style="width: 15%" | Minecraft Version
|-
|align=center|ComputerCraft 1.42
|
*Ported to Minecraft 1.3.2 and the Forge mod system
*Added Printers
*Floppy Disks can now be dyed different colours
*Wireless Crafty Turtles can now be crafted
*All new textures
*New Forge config file
*Various tweaks and bug fixes
|align=center|1.3.2
|-
|align=center|ComputerCraft 1.41
|
*Fixed labelled Computers not keeping their data when destroyed
*Fixed the “excavate” program outputting lots of spam
*File system size limits now take into account empty files and directories
*Some small changes to the Turtle Upgrade API ahead of it’s impending release.(Update: The API has now been released)
|align=center|1.2.5
|-
|align=center|ComputerCraft 1.4
|
*Ported to Forge Mod Loader: ComputerCraft can now be ran directly from the .zip without extraction
*Added Farming Turtles
*Added Felling Turtles
*Added Digging Turtles
*Added Melee Turtles
*Added Crafty Turtles
*Added 14 new Turtle Combinations accessible by combining the turtle upgrades above
*Labelled computers and turtles can now be crafted into turtles or other turtle types without losing their ID, label and data
*Added a “Turtle Upgrade API” for mod developers to create their own tools and peripherals for turtles
*Turtles can now attack entities with turtle.attack(), and collect their dropped items
*Turtles can now use turtle.place() with any item the player can, and can interact with entities
*Turtles can now craft items with turtle.craft()
*Turtles can now place items into inventories with turtle.drop()
*Changed the behaviour of turtle.place() and turtle.drop() to only consider the currently selected slot
*Turtles can now pick up items from the ground, or from inventories, with turtle.suck()
*Turtles can now compare items in their inventories
*Turtles can place signs with text on them with turtle.place( [signText] )
*Turtles now optionally require fuel items to move, and can refuel themselves
*The size of the the turtle inventory has been increased to 16
*The size of the turtle screen has been increased
*New turtle functions: turtle.compareTo( [slotNum] ), turtle.craft(), turtle.attack(), turtle.attackUp(), turtle.attackDown(), turtle.dropUp(), turtle.dropDown(), turtle.getFuelLevel(), turtle.refuel()
*New disk function: disk.getDiskID()
*New turtle programs: craft, refuel
*“excavate” program now much smarter: Will return items to a chest when full, attack mobs, and refuel itself automatically
*New API: keys
*Added optional Floppy Disk and Hard Drive space limits for computers and turtles
*New fs function: fs.getFreeSpace( path ), also fs.getDrive() works again
*The send and receive range of wireless modems now increases with altitude, allowing long range networking from high-altitude computers (great for GPS networks)
*http.request() now supports https:// URLs
*Right clicking a Disk Drive with a Floppy Disk or a Record when sneaking will insert the item into the Disk Drive automatically
*The default size of the computer screen has been increased
*Several stability and security fixes: LuaJ can now no longer leave dangling threads when a computer is unloaded, turtles can no longer be destroyed by tree leaves or walking off the edge of the loaded map. Computers no longer crash when used with RedPower frames
|align=center|1.2.5
|-
|align=center|ComputerCraft 1.33
|
*Ported to Minecraft 1.2.5
|align=center|1.2.5
|-
|align=center|ComputerCraft 1.32
|
*Ported to Minecraft 1.2.4
*Fixed a big memory leak in LuaJ that caused extra threads to stay around forever when computers were shut down.
|align=center|1.2.4
|-
|align=center|ComputerCraft 1.31
|
*Ported to Minecraft 1.2.3
*Added Monitors (thanks to Cloudy). Build huge external displays for your computers!
*New positioning capabilities for computers and turtles. Build GPS networks and triangulate the positions of your turtles position so they never get lost!
*New turtle.compare() function for turtles for more intelligent mining.
*New programs and APIs: gps, monitor, vector
*New program: pastebin (requires enableAPI_HTTP=1 in mod_ComputerCraft.cfg), upload and download programs made by other users ingame!
*Added a new top secret program designed for use with Monitors, see if you can find it.
*Lots of additions to existing APIs and programs. Type "help whatsnew" in game for the full details.
|align=center|1.2.3
|-
|align=center|ComputerCraft 1.3
|
*Ported to Minecraft Forge.
*Added Turtles, Mining Turtles, Wireless Turtles and Wireless Mining Turtles (Block ID 209).
*Added a Peripheral API to allow mod developers to create custom peripherals for ComputerCraft. Details on this will be posted in the next few days.
*Added Wireless Modems. Use the rednet API to send data wirelessly between computers and turtles!
*Computers and Disk Drives no longer get destroyed by water.
*Computers and Turtles can now be labelled, destroyed, and moved around, keeping their state.
*Computers and Turtles can connect to adjacent devices, and turn them on or off.
*User programs now give line numbers in their error messages, for easier debugging.
*New APIs and programs for Turtles: turtle, excavate, tunnel, go, turn and dance.
*Lots of additions to existing APIs and programs. Type "help whatsnew" in game for the full details.
|align=center|1.1
|-
|align=center|ComputerCraft 1.21
|
*Added shortcut key to shutdown the computer.
*Added a help API add-on pack.
*Various bug fixes.
|align=center|1.1
|-
|align=center|ComputerCraft 1.2
|
*Added Disk Drives
*Added shortcut keys to terminate the current program and reboot the computer.
*Added a new system for user created APIs.
*Added RedNet.
*Added shell.setPath() and shell.setAlias().
*Added a new ROM startup script.
*Added os.clock(), os.time(), and os.setAlarm().
*Added game: "Worm!"
*Added programs: alias, apis, copy, delete, dj, drive, eject, id, label, list, move, reboot, redset, rename, time, worm.
*Added APIs: bit, colours, disk, help, rednet, parallel, textutils
*Text can be edited with left and right arrow keys.
*Many bug fixes
|align=center|1.0
|-
|align=center|ComputerCraft 1.11
|
*Fixed bug where [[Console|Computers]] could not read input from RedPower cables which had a bend in the immediately adjacent square.
|align=center|1.0
|-
|align=center|ComputerCraft 1.1
|
*Changed the default block ID for the [[Console|Computer]] to 207.
*Added multiplayer support.
*Added connectivity with RedPower bundled cables.
*Added HTTP API
*Fixed support for HD textures on the front of [[Console|Computers]].
*Added command history to the [[Console]].
*Added config options to change the size of the [[Console]] GUI and the text color.
*Programs with infinite loops that don't yield will no longer freeze Minecraft and will terminate after 10 seconds.
*Extended Help and fixed typos/small errors in various programs.
|align=center|1.0
|-
|align=center|ComputerCraft 1.02
|
*Fixed the MCPatcher HD textures incompatibility that was causing the computer texture to replace cobblestone blocks.
|align=center|1.0
|-
|align=center|ComputerCraft 1.01
|
*Added a ModLoader configuration file, so the computers block ID can be changed.
*Made the error message that displays when Lua files are not correctly installed much more clear, no more "Assertion failed."
|align=center|1.0
|-
|align=center|ComputerCraft 1.0
|
*First Release
|align=center|1.0
|}

Template:Version

2012-09-22T18:02:55Z

SandroHc: Updating

Current SSP/SMP Version: '''1.42''' for Minecraft 1.3.2<br />
Current Bukkit Version: '''1.41''' for Bukkit MCPC build 177+

<center>'''[[Changelog]]'''</center>

Template:Heading

2012-09-13T21:54:16Z

SandroHc: Reverting

Template:Heading

2012-09-13T21:53:22Z

SandroHc:

Template:Heading

2012-09-13T21:52:45Z

SandroHc:

Wiki Todo

2012-07-08T01:15:22Z

SandroHc:

=== '''This page lists where work is needed to be done on the wiki. If you would like to help, we ask that you please make an account and help wherever you can.''' ===

''Page currently incomplete, but being worked on.''

== API Pages (Highest priorities are to finish function/method pages for APIs) ==


*[[Peripheral_(API)|Peripheral]] (Needs pages for functions)

*[[Redstone_(API)|Redstone]] (Needs page for 1 function)
*[[Term_(API)|Term]] (Needs pages for 2 functions)
*[[Textutils_(API)|Textutils]] (Needs function pages)
*[[Vector_(API)|Vector]] (Needs link to page explaining or description explaining what a vector is and function pages)
[[Category:Lists]]

Textutils (API)

2012-07-08T01:15:07Z

SandroHc: Add links

Text utilities is used to mess around with text easier.

Its functions include:
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Method name
!style="background:#EEE" width="*"|Description
|-
|[[textutils.slowPrint|textutils.slowPrint( text )]]
|Slowly prints the text.
|-
|[[textutils.slowWrite|textutils.slowWrite( text )]]
|Slowly writes the text.
|-
|[[textutils.formatTime|textutils.formatTime( time, bTwentyFourHour)]]
|Put a time into it, and it spews it out in a different format. For example:
local nTime = os.time()

print(textutils.formatTime( nTime, false ))
|-
|[[textutils.tabulate|textutils.tabulate( table, table2, so on)]]
|Prints tables in an ordered form. Each table is a row, columns' width is auto-adjusted.
|-
|[[textutils.pagedTabulate|textutils.pagedTabulate( table, table2, so on)]]
|<no description given>
|-
|[[textutils.serialize|textutils.serialize( t )]]
|Returns a string representation of the table t for storage or transmission.
|-
|[[textutils.unserialize|textutils.unserialize( s )]]
|Returns a table reassembled from the string s.
|-
|[[textutils.urlEncode|textutils.urlEncode( str )]]
|<no description given>
|}

[[Category:APIs]]

Template:Images

2012-03-12T14:50:43Z

SandroHc:

<center>
[[File:ComputerCraft 1.31 preview.png|85px|One preview from the upcomming version 1.31!]]
[[File:CraftOS 1.2.png|85px|A image when a computer is turned on.]]
[[File:Program in computer.png|85px|A complex program in a computer.]]
[[File:Computers.png|85px|A lot of computers side by side.]]
</center>

Template:Images

2012-03-12T14:49:34Z

SandroHc:

[[File:ComputerCraft 1.31 preview.png|100px|One preview from the upcomming version 1.31!]]
[[File:CraftOS 1.2.png|100px|A image when a computer is turned on.]]<br>
[[File:Program in computer.png|100px|A complex program in a computer.]]
[[File:Computers.png|100px|A lot of computers side by side.]]

Template:Images

2012-03-12T14:49:02Z

SandroHc:

[[File:ComputerCraft 1.31 preview.png|70px|One preview from the upcomming version 1.31!]]
[[File:CraftOS 1.2.png|70px|A image when a computer is turned on.]]<br>
[[File:Program in computer.png|70px|A complex program in a computer.]]
[[File:Computers.png|70px|A lot of computers side by side.]]

File:Program in computer.png

2012-03-12T14:48:08Z

SandroHc:

File:CraftOS 1.2.png

2012-03-12T14:48:04Z

SandroHc:

File:Computers.png

2012-03-12T14:48:01Z

SandroHc:

File:ComputerCraft 1.31 preview.png

2012-03-12T14:47:48Z

SandroHc:

Template:Images

2012-03-12T14:44:26Z

SandroHc: Created page with "<choose> <option>[[File:ComputerCraft 1.31 preview.png|One preview from the upcomming version 1.31!</option> <option>[[File:CraftOS 1.2.png|A image when a computer is turned o..."

<choose>
<option>[[File:ComputerCraft 1.31 preview.png|One preview from the upcomming version 1.31!</option>
<option>[[File:CraftOS 1.2.png|A image when a computer is turned on.</option>
<option>[[File:Program.png|A complex program in a computer.</option>
<option>[[File:Computers.png|A lot of computers side by side.</option>
</choose>

Startup

2012-03-12T14:31:04Z

SandroHc:

==Startup Scripts==
If, upon booting, a computer terminal detects a script named "startup" in its root directory, this script will be run. Similarly, if a disk is present in an attached disk drive containing a script named "startup" that script will be run.

===Very simple auto-install script to set up a single-use terminal (e.g. password-protected door):===
Disk contents:
/disk/startup (installer script)
/disk/startup.file (program to be installed on terminal)

The script could look like:
fs.copy("/disk/startup.file", "/startup")
shell.run("startup")

When the disk is placed into a drive attached to a terminal, and the terminal is rebooted - the startup file on the disk will run. This startup file serves only to copy the program you've named "startup.file" to the root directory of the terminal with the new name "startup" - this will then run each time the terminal is booted, eliminating the need for the disk drive.

[[Category:Lists]]

Startup

2012-03-12T14:29:15Z

SandroHc: Reverted

[[Category:Lists]]
== Startup Scripts ==

If, upon booting, a computer terminal detects a script named "startup" in its root directory, this script will be run.

Similarly, if a disk is present in an attached disk drive containing a script named "startup" that script will be run.

=== Very simple auto-install script to set up a single-use terminal (e.g. password-protected door): ===
Disk contents:

/disk/startup (installer script)

/disk/startup.file (program to be installed on terminal)

The script could look like:

fs.copy("/disk/startup.file", "/startup")
shell.run("startup")

When the disk is placed into a drive attached to a terminal, and the terminal is rebooted - the startup file on the disk will run. This startup file serves only to copy the program you've named "startup.file" to the root directory of the terminal with the new name "startup" - this will then run each time the terminal is booted, eliminating the need for the disk drive.

File:DiskDriveGUI.png

2012-03-12T14:27:55Z

SandroHc: uploaded a new version of "File:DiskDriveGUI.png": Reverted to version as of 23:46, 13 February 2012 -- what is bad in the real size?

GUI of the Disk Drive

Template:News

2012-03-12T14:21:17Z

SandroHc:

ComputerCraft is currently at version '''1.3''' for Minecraft '''1.1'''.
----

Template:News

2012-03-12T14:15:49Z

SandroHc: Created page with "ComputerCraft is currently at version '''1.3''' for Minecraft '''1.1'''."

ComputerCraft is currently at version '''1.3''' for Minecraft '''1.1'''.