ComputerCraft Wiki - User contributions [en]

IO (API)

2016-07-31T22:12:57Z

Negamartin: Undo revision 7446 by Negamartin (talk)

IO is a reimplementation of the default Lua input / output API defined [http://www.lua.org/manual/5.1/manual.html#5.7 here], with some features trimmed. Most features should work. If you find a non-working feature, please list it here.

List of non-working features from IO as of ComputerCraft 1.55:

* io.open: Modes “a+”, “r+”, and “w+” are not supported.
* io.write: Does not accept multiple arguments.
* io.popen: Doesn’t exist.
* io.read: Only allows format string “*l”.
* io.tmpfile: Doesn’t exist.
* file:read: Doesn’t support format string “*n” or a character count.
* file:seek: Doesn’t exist.
* file:setvbuf: Doesn’t exist.

All of the capabilities in this API are also available in the [[Fs (API)|Fs API]], along with some other functions not directly related to reading and writing individual files.
[[Category:APIs]]

IO (API)

2016-07-31T22:12:26Z

Negamartin: Added supported format "*a"

IO is a reimplementation of the default Lua input / output API defined [http://www.lua.org/manual/5.1/manual.html#5.7 here], with some features trimmed. Most features should work. If you find a non-working feature, please list it here.

List of non-working features from IO as of ComputerCraft 1.55:

* io.open: Modes “a+”, “r+”, and “w+” are not supported.
* io.write: Does not accept multiple arguments.
* io.popen: Doesn’t exist.
* io.read: Only allows format string “*l” and “*a”.
* io.tmpfile: Doesn’t exist.
* file:read: Doesn’t support format string “*n” or a character count.
* file:seek: Doesn’t exist.
* file:setvbuf: Doesn’t exist.

All of the capabilities in this API are also available in the [[Fs (API)|Fs API]], along with some other functions not directly related to reading and writing individual files.
[[Category:APIs]]

User:Negamartin

2015-06-09T19:27:52Z

Negamartin: Created page with "You should really do something useful."

You should really do something useful.

Turtle.craft

2015-06-09T19:23:54Z

Negamartin: Added turtle.craft(0) functionality (please add min. version if it exists)

{{lowercase}}
{{Function
|name=turtle.craft
|args={{type|number}} quantity ( if not supplied will craft as many as possible )
|returns={{type|boolean}} if an item was crafted
|api=turtle
|addon=ComputerCraft
|desc=Requires a [[Turtle|Crafty Turtle]].
Crafts an item if items in the turtle's inventory matches a valid recipe. The items can be placed anywhere as long as they are oriented properly with respect to one another.
Can craft a maximum of one stack of items at a time; for example, if you put three stacks of 64 reed in a line and craft them, only 63 paper will be crafted, and three piles of 43 reed will remain in the turtle.
Will not craft if there are any items in the turtle's inventory that are not part of the recipe, including in the slots not used for crafting.
The produced items will appear in the selected slot, if that slot is free. If not, it will try the next available slot.
A parameter can also be supplied to specify the quantity of items to craft. If the quantity specified is 0, will return true if a valid recipe has been found in the turtle's inventory, and false otherwise.
|examples=
{{Example
|desc=Crafts as many items as possible
|code=print( turtle.craft() )
|output=prints a {{type|boolean}} representing if any items were crafted
}}
{{Example
|desc=Crafts 5 items
|code=print(turtle.craft(5))
|output=prints a {{type|boolean}} representing if any items were crafted
}}
{{Example
|desc=Checks if the recipe is valid
|code=print(turtle.craft(0))
|output=prints a {{type|boolean}} representing if the recipe is valid
}}
}}

[[Category:Lua_Core_Functions]]

Wireless Modem

2013-04-04T09:40:07Z

Negamartin: /* Modem as a Peripheral */

{{NeedsWork|The behaviour of Rednet has changed as of 1.5 - please consider updating this page with information. (Please don't add prerelease info!)}}
:''This page is for the Modem blocks. For the modem API, see [[Modem_(API)|Modem (API)]]''
{{Block
|name=Modem
|image=WirelessModem.png
|id=4094
|damage-value=1
|is-peripheral=Yes
|peripheral-api=Modem (API)
}}
Modems are blocks which can be used to wirelessly transfer data between [[Computer|computers]] and [[Turtle|turtles]], using the [[Rednet_(API)|Rednet API]] or the [[Modem_(API)|Modem API]].
To place a modem on a side of a computer, right-click to place the modem while sneaking.

It is also possible to turn the modem on and off by typing "rednet.open ( side )" to open and "rednet.close ( side )" to close.

Modems can send messages to other modems located up to 64 meters away, or 16 meters during a thunderstorm.
As of 1.4 Modem range is increased with higher altitudes. If there is no thunderstorm, the range will always be higher than 64, and at max altitude you would have a range of 384 meters.

In 1.4 and 1.41 there is a miscalculation that causes the range to only be 381 meters at max altitude.

== Recipe ==
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=ender_pearl |C2=stone
|A3=stone |B3=stone |C3=stone
|Output=Modem
}}

== Example (Rednet API)==
* Place 2 computers and add modems to them by clicking the right mouse button while sneaking.
* Access them, and start Lua.
* Once Lua has started, type "[[rednet_(API)|rednet]].[[rednet.open|open]] ("<relative location to modem, e.g. left, right>")" on both computers.
* Check if there exists a connection: a dim, red light should be found on the modem.
* Type on one computer "[[rednet_(API)|rednet]].[[rednet.receive|receive]] (60)". This will make the computer freeze for 60 seconds, or until it has received a signal from the other computers.
* Now, type "[[rednet_(API)|rednet]].[[rednet.broadcast|broadcast]] ('<your message>')" on the other computer. This should send your message to all computers connected.
* Opening the first computer should show the message written on the second computer.

==Modem as a Peripheral==
To use a Modem as a peripheral, you need to either call a method directly using [[peripheral.call]](), or, wrap the modem using the [[Peripheral_(API)|Peripheral API]]. Wrapped modems provide all functions listed in the [[Modem_(API)|Modem API]].

For this example, we have a Modem connected to the top of our [[Computer]], we are going to open channel 5:

-- Immediately invoke a method without wrapping
peripheral.call("top", "open",5)

-- You can also "wrap" the peripheral side to a variable:
local modem = peripheral.wrap("top")
modem.open(5)

[[Category:Peripherals]]

Wireless Modem

2013-04-04T09:39:47Z

Negamartin: /* Modem as a Peripheral */

{{NeedsWork|The behaviour of Rednet has changed as of 1.5 - please consider updating this page with information. (Please don't add prerelease info!)}}
:''This page is for the Modem blocks. For the modem API, see [[Modem_(API)|Modem (API)]]''
{{Block
|name=Modem
|image=WirelessModem.png
|id=4094
|damage-value=1
|is-peripheral=Yes
|peripheral-api=Modem (API)
}}
Modems are blocks which can be used to wirelessly transfer data between [[Computer|computers]] and [[Turtle|turtles]], using the [[Rednet_(API)|Rednet API]] or the [[Modem_(API)|Modem API]].
To place a modem on a side of a computer, right-click to place the modem while sneaking.

It is also possible to turn the modem on and off by typing "rednet.open ( side )" to open and "rednet.close ( side )" to close.

Modems can send messages to other modems located up to 64 meters away, or 16 meters during a thunderstorm.
As of 1.4 Modem range is increased with higher altitudes. If there is no thunderstorm, the range will always be higher than 64, and at max altitude you would have a range of 384 meters.

In 1.4 and 1.41 there is a miscalculation that causes the range to only be 381 meters at max altitude.

== Recipe ==
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=ender_pearl |C2=stone
|A3=stone |B3=stone |C3=stone
|Output=Modem
}}

== Example (Rednet API)==
* Place 2 computers and add modems to them by clicking the right mouse button while sneaking.
* Access them, and start Lua.
* Once Lua has started, type "[[rednet_(API)|rednet]].[[rednet.open|open]] ("<relative location to modem, e.g. left, right>")" on both computers.
* Check if there exists a connection: a dim, red light should be found on the modem.
* Type on one computer "[[rednet_(API)|rednet]].[[rednet.receive|receive]] (60)". This will make the computer freeze for 60 seconds, or until it has received a signal from the other computers.
* Now, type "[[rednet_(API)|rednet]].[[rednet.broadcast|broadcast]] ('<your message>')" on the other computer. This should send your message to all computers connected.
* Opening the first computer should show the message written on the second computer.

==Modem as a Peripheral==
To use a Modem as a peripheral, you need to either call a method directly using [[peripheral.call]](), or, wrap the modem using the [[Peripheral_(API)|Peripheral API]]. Wrapped modems provide all functions listed in the [[Modem_(API)|Modem API]].

For this example, we have a Modem connected to the top of our [[Computer]]:

-- Immediately invoke a method without wrapping
peripheral.call("top", "open",5)

-- You can also "wrap" the peripheral side to a variable:
local modem = peripheral.wrap("top")
modem.open(5)

[[Category:Peripherals]]

Command Block (API)

2013-03-30T06:10:16Z

Negamartin:

The Command Block API allows you to run commands in a Command Block, using it as a peripheral.
(The peripheral can only be used if allowed in the config, which is default to false)

Functions exposed by the Command Block:
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="200px"|Function
!style="background:#EEE" width="*"|Description
|-
|getCommand( )
|Returns a string containing the command currently inside the Command Block.
|-
|setCommand( [[string_(type)|string]] command )
|Sets the command in the Command Block. '''This does not run it.'''
|-
|runCommand( )
|Runs the command inside the Command Block previously set by setCommand( )
|}

==Note==
All Command Block functions are to be used ''after'' wrapping the block in a peripheral.
'''example''':
<span>
command = peripheral.wrap("left")
command.setCommand("time set 1000")
command.runCommand()
local currentCommand = command.getCommand()
</span>

[[Category:Peripheral APIs]]

Command Block (API)

2013-03-30T06:02:08Z

Negamartin: Created the page

The Command Block API allows you to run commands in a Command Block, using it as a peripheral.
(The peripheral can only be used if allowed in the config, which is default to false)

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<tr><td colspan="2" style="font-weight: bold; font-size: large; padding-bottom: .3em; border-bottom: solid #C9C9C9 1px; background: #D3FFC2; line-height:28px;">
[[File:Grid_disk.png|24px]]  
Command Block (API)
</td></tr>
<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[command.getCommand]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the command in the Command Block as a string.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[command.setCommand]]([[string]] command)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the command currently in the Command Block.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[command.runCommand]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs the command currently in the Command Block.</td></tr>
</table>

==Note==
All Command Block functions are to be used ''after'' wrapping the block in a peripheral.
'''example''': command = peripheral.wrap("left")

[[Category:Peripheral APIs]]