Peripheral (API)

From ComputerCraft Wiki
Revision as of 16:51, 10 July 2012 by Thesbros (Talk | contribs) (Add correct parameters, add newlines, link to pages)

Jump to: navigation, search

The peripheral API is for interacting with external peripherals, such as the disk drive and monitor.
Consoles and Turtles are also considered peripherals and you can interface two adjacent computers, although in a more limited fashion compared to rednet. Both Computers and Turtles provide the same methods: turnOn, shutdown, reboot, getID.

Methods

Method name 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.

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.:

fdd = peripheral.wrap("left")
fdd.someMethod()
- is the same as -
peripheral.call("left","someMethod")

Events

Event name Description Parameters
peripheral Fired when peripheral is attached side
peripheral_detach Fired when peripheral is removed side

Monitor

List of methods: write()
scroll()
setCursorPos(x, y)
setCursorBlink(boolean)
getCursorPos()
getSize()
clear()
clearLine(line)
setTextScale(scale)