ComputerCraft Wiki - User contributions [en]

OpenCCSensors

2015-09-12T03:12:58Z

Lyqyd: Update description of target keys.

[http://www.computercraft.info/forums2/index.php?/topic/5996-144-cc-147-openccsensors/ OpenCCSensors] is a new, open-source, up to date replacement for [[CcSensors|CcSensors (outdated)]], allowing monitoring and gathering information from the Minecraft environment - including players, entities, proximity, world info, IndustrialCraft 2, BuildCraft 2, liquids, inventories - and more!

OpenCCSensors comes with its own API, and automatically installs a new program for you at /ocs/programs/sensorview. sensorview is a handy program for very quickly looking at the information gathered from your sensors.

Forum thread and download: [http://www.computercraft.info/forums2/index.php?/topic/5996-144-cc-147-openccsensors/ OpenCCSensors]

http://www.youtube.com/watch?v=i8Bv7uKkIOM&feature=youtu.be

<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]]  
OpenCCSensors Peripherals
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sensor Peripheral</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">

The Sensor Peripheral needs to be placed next to a computer and it has a single slot to insert a Sensor Card

{{Crafting grid
|A1=Obsidian |B1=Obsidian |C1=Obsidian
|A2=Redstone |B2=Obsidian |C2=Redstone
|A3=Stone |B3=Stone |C3=Stone
|Output=Sensor Peripheral
|Output-link=OpenCCSensors
}}
<table style="width: 100%; border-spacing: 0px;">

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">os.loadAPI("ocs/apis/sensor")</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Load the sensor API</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">mySensor = sensor.wrap(side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the wrapped sensor on the side specified.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">mySensor.getTargets()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a a table of all the targets for mySensor, where the keys are usually strings (either an entity name or a relative coordinate for blocks), and the values are each a table of basic details.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">mySensor.getTargetDetails(key)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table of full details for that particular target from the sensor mySensor - where the the "key" is the key returned from getTargets()</td></tr>

</table>
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gauge Peripheral</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">

The Gauge Peripheral can be placed onto the side of certain machines to get instant readings from them. Right now this only supports Batboxes, MFE's, MFSU, Mass fabricators and Nuclear reactors. We hope to expand this in the future as well as offer an API to re-program the gauge from a computer.

{{Crafting grid
|A1=glass_pane |B1=Redstone |C1=Monitor
|Output=Gauge Peripheral
|Output-link=OpenCCSensors
}}

</td></tr>
</table>

<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]]  
OpenCCSensors Blocks
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Proximity Sensor Block</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">

This block outputs a redstone signal if players/mobs are within 16 blocks. The strength of the signal depends on how close the entity is to the block.

This block has 3 different modes: "Any Living Entity", "Any Player" or "Owner Only". To switch between modes, the owner of the block must right click on the block.

{{Crafting grid
|A1= |B1= |C1=
|A2=Comparator |B2=Proximity Sensor Card MKIV |C2=Comparator
|A3=Redstone |B3=Block of Iron |C3=Redstone
|Output=Proximity Sensor Block
|Output-link=OpenCCSensors
|B2-link=OpenCCSensors
}}
</td></tr>
</table>
<br />
<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]]  
OpenCCSensors Sensor Cards
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Inventory Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Inventory Sensor Card is capable of reading inventories of any chests or machines around the sensor. It gives full information about what item is in each slot.

{{Crafting grid
|A1=Redstone |B1=chest |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Inventory Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Proximity Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Proximity Sensor Card is capable of detecting players and entities within it's range.

{{Crafting grid
|A1=Redstone |B1=pressure_plate |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Proximity Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Machine Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Machine Sensor Card can read information from IC2 devices.

{{Crafting grid
|A1=Redstone |B1=Redstone |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Buildcraft Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Power Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Power Sensor Card can read power information from IC2 and Applied Energistics devices.

{{Crafting grid
|A1=Redstone |B1=Coal |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Power Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Tank Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Tank sensor card is far more powerful than it first seems. This card not only reads actual tanks, but reads internal tanks within a variety of different machines, such as:

Railcraft: Iron Tanks, Buildcraft: Tanks, Thermal Expansion: Aqueous Accumulator, Thermal Expansion: Igneous Extruder, Thermal Expansion: Glacial Precipitator, Thermal Expansion: Liquid Transposer, Thermal Expansion: Magma Crucible, Thermal Expansion: Magmatic Engine, Thermal Expansion: Steam Engine, Industrial Craft: Geothermal Generator, Thaumcraft: Crucible, Buildcraft: Tank, Buildcraft: Combustion Engine, Buildcraft: Pump, Buildcraft: Refinery, Forestry: Biogas Engine, Forestry: Fermenter, Forestry: Still, Forestry: Bottler, Forestry: Raintank, Forestry: Bio Generator, Forestry: Carpenter, Forestry: Moistener, Forestry: Squeezer, Forestry: Thermonic Fabricator, Extra Bees: Analyser, Extra Bees: Purifier, Extra Bees: Synthesizer, Extra Bees: Genepool, Extra Bees: Splicer, Railcraft: Hobbyist's Steam Engine, Railcraft: Commercial Steam Engine, Railcraft: Industrial Steam Engine, GregTech: Quantum Tank, GregTech: Thermal Generator

{{Crafting grid
|A1=Redstone |B1=Bucket |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Liquid Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">World Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The World Sensor Card is able to tell the time, weather, and more about the world.

{{Crafting grid
|A1=Redstone |B1=ender_pearl |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=World Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Dropped Item Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Dropped Item Sensor Card is able to locate and identify dropped items.

{{Crafting grid
|A1=Redstone |B1=slime_ball |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Dropped Item Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sign Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Sign Sensor Card is capable of reading signs within it's range.

{{Crafting grid
|A1=Redstone |B1=sign|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Sign Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Minecart Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Minecart Sensor Card can detect minecarts in the area and give basic information about them

{{Crafting grid
|A1=Redstone |B1=Minecart|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Minecart Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sonic Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Sonic Sensor Card can detect blocks in the area and report if they're solid or liquid.

{{Crafting grid
|A1=Redstone |B1=Jukebox|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Sonic Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Crop Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The crop sensor card can detect the growth status of crops within range. IndustrialCraft2 crops are also supported (+extra!)

{{Crafting grid
|A1=Redstone |B1=Wheat|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Crop Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

</table>

<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]]  
OpenCCSensors Sensor Card Upgrades
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Range Extension Antenna</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Range Extension Antenna is used to upgrade sensor cards to Mk1, Mk2, and Mk3.

{{Crafting grid
|B1=redstone_torch
|A2=stone |B2=Redstone |C2=stone
|A3=stone |B3=iron_ingot |C3=stone
|Output=Range Extension Antenna
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Signal Amplifier</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Signal Amplifier is used to upgrade sensor cards to Mk3 and Mk4.

{{Crafting grid
|A1=stone |B1=Gold_Ingot|C1=stone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=stone |B3=Gold_Ingot |C3=stone
|Output=Signal Amplifier
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Advanced Amplifier</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Advanced Amplifier is used to upgrade sensor cards to Mk4.

{{Crafting grid
|A1=iron_ingot |B1=Gold_Ingot|C1=iron_ingot
|A2=Redstone |B2=Diamond |C2=Redstone
|A3=iron_ingot |B3=Gold_Ingot |C3=iron_ingot
|Output=Advanced Amplifier
|Output-link=OpenCCSensors
}}
</td></tr>

</table>

<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]]  
Sensor Tiers
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">'''Mk 1'''</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The recipes for Mk 1 sensors are all different. (See above sensor card lists)
Special-type sensor cards (Currently only the World Sensor Card) only exist as Mk 1, as they do not have a range.

'''Ranges:'''

<table>
<tr><td>Type</td><td>Range</td><td>Sensor types</td></tr>
<tr><td>Block<td>'''1''' block away (3x3x3)</td><td>
[[File:Grid_Inventory_Sensor_Card.png|24px|Inventory Sensor]]
[[File:Grid_Industrial_Craft_2_Sensor_Card.png|24px|Industrial Craft 2 Sensor]]
[[File:Grid_Buildcraft_Sensor_Card.png|24px|Buildcraft Sensor]]
[[File:Grid_Liquid_Sensor_Card.png|24px|Liquid Sensor]]
[[File:Grid_Sign_Sensor_Card.png|24px|Sign Sensor]]
[[File:Grid_Thaumcraft_Sensor_Card.png|24px|Thaumcraft Sensor]]
[[File:Grid_Sonic_Sensor_Card.png|24px|Sonic Sensor]]
[[File:Grid_Crop_Sensor_Card.png|24px|Crop Sensor]]
</td></tr>
<tr><td>Entity<td>'''4''' block-radius sphere</td><td>
[[File:Grid_Proximity_Sensor_Card.png|24px|Proximity Sensor]]
[[File:Grid_Dropped_Item_Sensor_Card.png|24px|Dropped Item Sensor]]
[[File:Grid_Minecart_Sensor_Card.png|24px|Minecart Sensor]]
</td></tr>
<tr><td>Special</td><td>N/A</td><td>
[[File:Grid_World_Sensor_Card.png|24px|World Sensor]]
</td></tr>
</table>

</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">'''Mk 2'''</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Mk 2 is the first upgrade to sensor cards. Simply combine a Range Extension Antenna with a Mk 1 sensor card (The recipe is shapeless)

{{Crafting grid
|A1=Inventory Sensor Card |B1=Range Extension Antenna
|Output=Inventory Sensor Card Mk2
|Output-link=OpenCCSensors
|A1-link=OpenCCSensors
|B1-link=OpenCCSensors
}}

'''Ranges:'''
<table>
<tr><td>Type</td><td>Range</td><td>Sensor types</td></tr>
<tr><td>Block<td>'''3''' blocks away (7x7x7)</td><td>
[[File:Grid_Inventory_Sensor_Card.png|24px|Inventory Sensor]]
[[File:Grid_Industrial_Craft_2_Sensor_Card.png|24px|Industrial Craft 2 Sensor]]
[[File:Grid_Buildcraft_Sensor_Card.png|24px|Buildcraft Sensor]]
[[File:Grid_Liquid_Sensor_Card.png|24px|Liquid Sensor]]
[[File:Grid_Sign_Sensor_Card.png|24px|Sign Sensor]]
[[File:Grid_Thaumcraft_Sensor_Card.png|24px|Thaumcraft Sensor]]
[[File:Grid_Sonic_Sensor_Card.png|24px|Sonic Sensor]]
[[File:Grid_Crop_Sensor_Card.png|24px|Crop Sensor]]
</td></tr>
<tr><td>Entity<td>'''12''' block-radius sphere</td><td>
[[File:Grid_Proximity_Sensor_Card.png|24px|Proximity Sensor]]
[[File:Grid_Dropped_Item_Sensor_Card.png|24px|Dropped Item Sensor]]
[[File:Grid_Minecart_Sensor_Card.png|24px|Minecart Sensor]]
</td></tr>
</table>

</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">'''Mk 3'''</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Mk 3 is the second upgrade to sensor cards. Note that the recipe is no longer shapeless.

{{Crafting grid
|A1=Range Extension Antenna |B1=Inventory Sensor Card Mk2|C1=Range Extension Antenna
|B2=Signal Amplifier
|Output=Inventory Sensor Card Mk3
|Output-link=OpenCCSensors
|A1-link=OpenCCSensors
|B1-link=OpenCCSensors
|B2-link=OpenCCSensors
|C1-link=OpenCCSensors
}}

'''Ranges:'''
<table>
<tr><td>Type</td><td>Range</td><td>Sensor types</td></tr>
<tr><td>Block<td>'''5''' blocks away (11x11x11)</td><td>
[[File:Grid_Inventory_Sensor_Card.png|24px|Inventory Sensor]]
[[File:Grid_Industrial_Craft_2_Sensor_Card.png|24px|Industrial Craft 2 Sensor]]
[[File:Grid_Buildcraft_Sensor_Card.png|24px|Buildcraft Sensor]]
[[File:Grid_Liquid_Sensor_Card.png|24px|Liquid Sensor]]
[[File:Grid_Sign_Sensor_Card.png|24px|Sign Sensor]]
[[File:Grid_Thaumcraft_Sensor_Card.png|24px|Thaumcraft Sensor]]
[[File:Grid_Sonic_Sensor_Card.png|24px|Sonic Sensor]]
[[File:Grid_Crop_Sensor_Card.png|24px|Crop Sensor]]
</td></tr>
<tr><td>Entity<td>'''20''' block-radius sphere</td><td>
[[File:Grid_Proximity_Sensor_Card.png|24px|Proximity Sensor]]
[[File:Grid_Dropped_Item_Sensor_Card.png|24px|Dropped Item Sensor]]
[[File:Grid_Minecart_Sensor_Card.png|24px|Minecart Sensor]]
</td></tr>
</table>

</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">'''Mk 4'''</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Mk 4 is the highest tier of sensor card upgrades

{{Crafting grid
|B1=Range Extension Antenna
|A2=Range Extension Antenna |B2=Inventory Sensor Card Mk3|C2=Range Extension Antenna
|A3=Signal Amplifier|B3=Advanced Amplifier|C3=Signal Amplifier
|Output=Inventory Sensor Card Mk4
|Output-link=OpenCCSensors
|B1-link=OpenCCSensors
|A2-link=OpenCCSensors
|B2-link=OpenCCSensors
|C2-link=OpenCCSensors
|A3-link=OpenCCSensors
|B3-link=OpenCCSensors
|C3-link=OpenCCSensors
}}

'''Ranges:'''
<table>
<tr><td>Type</td><td>Range</td><td>Sensor types</td></tr>
<tr><td>Block<td>'''7''' blocks away (15x15x15)</td><td>
[[File:Grid_Inventory_Sensor_Card.png|24px|Inventory Sensor]]
[[File:Grid_Industrial_Craft_2_Sensor_Card.png|24px|Industrial Craft 2 Sensor]]
[[File:Grid_Buildcraft_Sensor_Card.png|24px|Buildcraft Sensor]]
[[File:Grid_Liquid_Sensor_Card.png|24px|Liquid Sensor]]
[[File:Grid_Sign_Sensor_Card.png|24px|Sign Sensor]]
[[File:Grid_Thaumcraft_Sensor_Card.png|24px|Thaumcraft Sensor]]
[[File:Grid_Sonic_Sensor_Card.png|24px|Sonic Sensor]]
[[File:Grid_Crop_Sensor_Card.png|24px|Crop Sensor]]
</td></tr>
<tr><td>Entity<td>'''28''' block-radius sphere</td><td>
[[File:Grid_Proximity_Sensor_Card.png|24px|Proximity Sensor]]
[[File:Grid_Dropped_Item_Sensor_Card.png|24px|Dropped Item Sensor]]
[[File:Grid_Minecart_Sensor_Card.png|24px|Minecart Sensor]]
</td></tr>
</table>

</td></tr>

</table>

= Usage Examples =
{{Example
|desc=List all available targets on a Proximity Sensor on the left of the Computer.
|code=os.loadAPI("ocs/apis/sensor")
local prox = sensor.wrap("left")
print(textutils.serialize(prox.getTargets()))
|output=A huge blob of text with all nearby available targets to the sensor, and some basic details.
}}
{{Example
|desc=Turn on a Redstone lamp when a player is within a certain distance from it. The sensor is placed to the left of the computer and the lamp is placed on top of the computer.
|code=
os.loadAPI("ocs/apis/sensor")

-- the location of the redstone lamp relative to the sensor
local offset = {
X = 1,
Y = 1,
Z = 0
}

-- how close a player has to be to activate the lamp
local radius = 5

-- find the distance from the player position to the offset
function distance(pos)
local xd = pos.X - offset.X
local yd = pos.Y - offset.Y
local zd = pos.Z - offset.Z
return math.sqrt(xd*xd + yd*yd + zd*zd)
end

local proximity = sensor.wrap("left")
while true do
local signal = false
local targets = proximity.getTargets()
for k, v in pairs(targets) do
if distance(v.Position) < radius then
signal = true
end
end
rs.setOutput("top", signal)
end
}}

[[Category:User_Created_Peripherals]][[Category:Unofficial_APIs]]

Term.restore

2015-08-24T05:55:25Z

Lyqyd: Removed bad advice.

{{lowercase}}

{{Deprecated
|type=term.restore
|version=1.6
}}

{{Function
|name=term.restore
|returns=Nothing
|api=term
|addon=ComputerCraft
|desc=Using versions of ComputerCraft prior to 1.6, this command switches the terminal back to whatever object it was using to output the display prior to the current one. For example, if you redirect from a computer's screen to an attached [[Monitor]], this command will revert back to the computer's own display.<br><br>

As of version 1.6, ComputerCraft no longer tracks this for you and so term.restore() has been removed. That build instead adds [[term.current|term.current()]] - this can be used to track the previous trail of displays yourself, hence still allowing you to manually [[term.redirect|term.redirect()]] back.
|examples=
{{Example
|desc=Wraps a monitor at the top of the computer, redirects to it, then restores back to the previous display. Uses term.restore() ''if available'', or [[term.current|term.current()]] if not.
|code= local mon = peripheral.wrap("top")

-- If using a build of ComputerCraft without term.restore, record the current terminal output object:
if not term.restore then mon.restoreTo = term.current() end

-- Redirect the terminal to the attached monitor:
term.redirect(mon)

-- Restore back:
if term.restore then
term.restore()
else
term.redirect(mon.restoreTo)
end
}}
|notes=
* term.restore() will return the monitor to the last used redirect target - meaning that if you have used [[term.redirect|term.redirect()]] on two different monitor objects, one use of term.restore() will only restore back to the first redirected monitor, whereas a second would restore back to the original display.
}}

[[Category:Deprecated API Functions]]

OS (API)

2015-01-04T06:54:17Z

Lyqyd: add cancelTimer and cancelAlarm calls.

The Operating System API allows for interfacing with the Lua based Operating System itself.

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

{{API table/row
|[[os.version]]()|{{type|string}} version
|Returns the version of the OS the computer is running, which (for CraftOS) also contains the version of ComputerCraft.
|odd}}

{{API table/row
|[[os.getComputerID]]()|{{type|number}} id
|Returns the unique ID of this computer. [[os.computerID]]() also behaves exactly the same as [[os.getComputerID]]().
|}}

{{API table/row
|[[os.getComputerLabel]]()|{{type|string}}/{{type|nil}} label
|Returns the label of this computer. [[os.computerLabel]]() also behaves exactly the same as [[os.getComputerLabel]]().
|odd}}

{{API table/row
|[[os.setComputerLabel]]({{type|string}}/{{type|nil}} label)|{{type|nil}}
|Set the label of this computer.
|}}

{{API table/row
|[[os.run]]({{type|table}} environment, {{type|string}} programPath [, {{type|string}} arguments])
|{{type|boolean}} success
|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.
|odd}}

{{API table/row
|[[os.loadAPI]]({{type|string}} path)
|{{type|boolean}} success
|Loads a Lua script as an API in its own namespace. It will be available to '''all''' programs that run on the terminal.}}

{{API table/row
|[[os.unloadAPI]]({{type|string}} name)|{{type|nil}}
|Unloads a previously loaded API.
|odd}}

{{API table/row
|[[os.pullEvent]]([<nowiki/>{{type|string}} target-event])
|{{type|string}} event, param1, param2, ...
|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]](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).
|}}

{{API table/row
|[[os.pullEventRaw]]([<nowiki/>{{type|string}} target-event])
|{{type|string}} event, param1, param2, ...
|Advanced version of pullEvent(). 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.pullEventRaw]](target-event) returns the event and any parameters the event may have. Unlike [[os.pullEvent]](target-event), this function will not raise an error if a [[terminate_(event)|'terminate' event]] is received.
|odd}}

{{API table/row
|[[os.queueEvent]]({{type|string}} event, param1, param2, ...)|{{type|nil}}
|Adds an event to the event queue with the name <var>event</var> and the given parameters.
|}}

{{API table/row
|[[os.clock]]()|{{type|number}} time
|Returns the amount of time since the in-game computer was started.
|odd}}

{{API table/row
|[[os.startTimer]]({{Type|number}} timeout)|{{type|number}} timerID
|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.
|}}

{{API table/row
|[[os.cancelTimer]]({{Type|number}} timerID)|{{type|nil}}
|Cancels a running timer, to prevent it throwing an event.
|}}

{{API table/row
|[[os.time]]()|{{type|number}} time
|Returns the current in-game time.
|odd}}

{{API table/row
|[[os.sleep]]({{Type|number}} time)|{{type|nil}}
|Makes the system wait a number of seconds before continuing in the program. [[os.sleep]](time) may also be used as simply "sleep(time)".
|}}

{{API table/row
|[[os.day]]()|{{type|number}} day
|Return the current in-game day (the number of in-game days since the world was created).
|odd}}

{{API table/row
|[[os.setAlarm]]({{type|number}} time)|{{type|number}} alarmID
|Queues an event to be triggered at the specified in-game <var>time</var>.
|}}

{{API table/row
|[[os.cancelAlarm]]({{Type|number}} alarmID)|{{type|nil}}
|Cancels a pending alarm, to prevent it throwing an event.
|}}

{{API table/row
|[[os.shutdown]]()|{{type|nil}}
|Turns off the computer.
|odd}}

{{API table/row
|[[os.reboot]]()|{{type|nil}}
|Reboots the computer.
|}}

}}

[[Category:APIs]]

== APIs ==

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.

The following is an example of a valid implementation of an API, and its usage after being registered:
<code>
-- "apiTest" file
function foo(bar)
print(bar)
end

-- "program" file
os.loadAPI("apiTest")
apiTest.foo("this is a test")
</code>

== <div id="pullEvent">os.pullEvent()</div> ==

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.

os.pullEvent() returns the name of the event that was read, as well as up to five parameters:
<code>
local event, p1, p2, p3, p4, p5 = os.pullEvent()
</code>

os.pullEvent() is usually run inside a 'while true do' loop.

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.

Talk:String (API)

2014-11-15T02:20:20Z

Lyqyd:

Looks like we need to add a note about balanced string searches ("%b()", for example), as well as noting that the string.sub/find interaction was fixed by re-implementing the functions to include the concatenation operation, in 1.6+.
[[User:Lyqyd|Lyqyd]] 02:20, 15 November 2014 (GMT)

Fs.getDrive

2014-11-08T18:34:58Z

Lyqyd:

{{lowercase}}
{{Function
|name=fs.getDrive
|args={{Type|string}} path
|api=fs
|returns={{Type|string}} the type of storage medium holding the path, or [[nil]] if the path does not exist
|desc=Returns the storage medium holding a path, or [[nil]] if the path does not exist. This is one of “hdd” if the path is stored on the computer’s local hard drive, “rom” if the path is in ROM, or the side on which a disk drive is attached if the path is on a [[Floppy Disk]]. From ComputerCraft 1.52 through ComputerCraft 1.64, a network-attached disk drive with a floppy in it returns the side of the computer on which the modem is attached, rather than the network name of the disk drive; this was a bug.[http://www.computercraft.info/forums2/index.php?/topic/12369-mc-151-cc-152-fsgetdrive-wrong-answer-for-network-drives/]
|examples=
{{Example
|desc=Checks that the standard "startup" file is stored in ROM
|code=print(fs.getDrive("rom/startup"))
|output=rom
}}
}}

[[Category:Lua_Core_Functions]]

Template:News

2014-09-27T21:49:44Z

Lyqyd: Add 1.64 full release.

'''September 27, 2014'''
* ComputerCraft 1.64 is released for Minecraft '''1.7.10'''.
'''April 16, 2014'''
* ComputerCraft 1.63 is released for Minecraft '''1.6.4'''.
'''April 4, 2014'''
* ComputerCraft 1.62 is released to fix game crashes.
'''April 1, 2014'''
* ComputerCraft 1.61 is released as a bug fix update for ComputerCraft 1.6.
'''March 27, 2014'''
* ComputerCraft 1.6 is released for Minecraft '''1.6.4'''.
<noinclude>
'''December 9, 2013'''
* ComputerCraft 1.58 is released for Minecraft '''1.6.4'''.
'''October 14, 2013'''
* ComputerCraft 1.57 is released for Minecraft '''1.6.4'''.
'''August 4, 2013'''
* ComputerCraft 1.56 is released for Minecraft '''1.6.2'''.
'''July 11, 2013'''
* ComputerCraft 1.55 is released for Minecraft '''1.6.2'''.
'''May 23, 2013'''
* ComputerCraft 1.53 is released for Minecraft '''1.5.2'''.
'''March 26, 2013'''
* ComputerCraft 1.52 is released for Minecraft '''1.5.1'''.
'''February 11, 2013'''
* ComputerCraft 1.5 is released for Minecraft '''1.4.7'''.
'''December 27, 2012'''
* ComputerCraft 1.481 is released as a quick hotfix for MiscPeripherals.
</noinclude>

Template:Version

2014-09-27T21:48:23Z

Lyqyd: Add 1.64 full release.

<table style="width:100%">
<tr><td style="background-color:#E5F9FF; text-align:center;">'''Latest:'''<br />ComputerCraft '''1.64''' for '''Minecraft 1.7.10''' ([http://www.computercraft.info/2014/09/27/computercraft-1-64/ download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.63''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2014/04/16/computercraft-1-63/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.62''' for '''Minecraft 1.6.4'''
([http://www.computercraft.info/2014/04/04/computercraft-1-62/ download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.61''' for '''Minecraft 1.6.4'''
([http://www.computercraft.info/2014/04/01/computercraft-1-61-bug-fix-update/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.6''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2014/03/27/computercraft-1-6-is-here/ download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.58''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2013/12/09/computercraft-1-58/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.57''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2013/10/14/new-versions/ download])</td></tr>
<noinclude> 
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.56''' for '''Minecraft 1.6.2''' ([http://www.computercraft.info/2013/08/04/computercraft-1-56/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.55''' for '''Minecraft 1.6.2''' ([http://www.computercraft.info/2013/07/11/computercraft-1-55/ download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.53''' for '''Minecraft 1.5.2''' ([http://www.computercraft.info/2013/05/23/computercraft-1-53/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.52''' for '''Minecraft 1.5.1''' ([http://www.computercraft.info/2013/03/26/computercraft-1-52/ download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.51''' for '''Minecraft 1.5''' ([http://www.computercraft.info/2013/03/15/computercraft-1-51/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.5''' for '''Minecraft 1.4.7''' ([http://www.computercraft.info/2013/02/11/computercraft-1-5/ download])</td></tr>
</noinclude>
</table>
<center>'''[[Changelog]]'''</center>

Disk Drive

2014-07-12T00:05:11Z

Lyqyd: Add note about disk and disk_eject events being fired.

{{Block
|name=Disk Drive
|image=Iso_DiskDrive.png
|id=4094
|damage-value=Un-used.
|is-peripheral=Yes
|peripheral-api=Disk (API)
}}
The Disk Drive arrived with the [[ComputerCraft]] 1.2 update and with that also came [[Floppy Disk]]s. The Disk Drive is an object that, when placed adjacently but not diagonally next to a [[computer]], does the same as a disk drive for real computers in the real world would do: they allow the access to portable data storage devices ([[Floppy Disk]]s). Since the [[ComputerCraft]] 1.6 update, both types of [[Pocket Computer]]s can also be inserted into disk drives, allowing access to their files.
== Recipe ==
{{Crafting grid
|A1=stone |B1=stone |C1=stone
|A2=stone |B2=Redstone |C2=stone
|A3=stone |B3=Redstone |C3=stone
|Output=Disk_Drive
}}
== Usage ==
[[File:Computer_w_DiskDrive_w_Monitor.png|frame|428x241px|right|A 2x2 [[Monitor]], connected to a [[Computer]], with a [[Disk Drive]] connected.]]
[[File:DiskDriveGUI.png|thumb|350px|GUI of the Disk Drive]]
To use a disk drive, place it adjacently but not diagonally next to a computer (left, right, top, bottom, front, or back side). Insert a disk by right-clicking on the disk drive and placing the disk in the slot above the inventory. When a disk is inserted, a [[Disk (event)|disk]] event is fired, and when a disk is removed or ejected, a [[Disk eject (event)|disk_eject]] event is fired.

If you sneak and right click the disk drive with a disk/music disc in 1.4+ it will place it into it without needing to open the disk drives interface.

In [[ComputerCraft]] 1.6 and above, [[Pocket Computer]]s can also be inserted into a disk drive to browse their files.

== API ==
See [[Disk (API)]] for the disk API.

{{BlocksItemsList}}
[[Category:Blocks]]

Shell (API)

2014-04-02T22:54:21Z

Lyqyd: clarify shell.run parameters.

The shell API allows you to interface with the [http://en.wikipedia.org/wiki/Shell_%28computing%29 shell].

<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]]  
Shell (API)
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Method Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.exit]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Exits the current shell</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.dir]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the directory</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.setDir]]({{type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the directory</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.path]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the path</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.setPath]]({{type|string}} path)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets the path</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.resolve]]({{type|string}} localpath)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Resolves a local path to an absolute path.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.resolveProgram]]({{type|string}} name)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Resolves the absolute path to the program whose name you provided.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.aliases]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns aliases.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.setAlias]]({{type|string}} alias, {{type|string}} program)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets an alias.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.clearAlias]]({{type|string}} alias)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Clears an alias.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.programs]]([<nowiki></nowiki>{{type|boolean}} hidden])</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a {{type|table}} of programs.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.run]]({{type|string}} command)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs a program.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.getRunningProgram]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the absolute path to the currently-executing program.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.openTab]]({{type|string}} command)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Runs a program in another [[multishell]] tab. ''Requires version 1.6 or newer and an advanced computer.''</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[shell.switchTab]]({{type|number}} tab ID)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Switches the [[multishell]] tab to tab with the given ID. ''Requires version 1.6 or newer and an advanced computer.''</td></tr>
</table>

Note that [[shell.run]] and [[shell.openTab]] concatenate any arguments they are given with single space separator characters before parsing the command. This is backwards compatible with scripts written when shell.run required one string argument for the program, and one per argument for that program, but accepts a single string with the entire command as well.

[[Category:APIs]]

Template:Version

2014-04-02T01:23:46Z

Lyqyd: 1.61 update.

<table style="width:100%">
<tr><td style="background-color:#E5F9FF; text-align:center;">'''Latest:'''<br />ComputerCraft '''1.61''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2014/04/01/computercraft-1-61-bug-fix-update/// download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.6''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2014/03/27/computercraft-1-6-is-here/// download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.58''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2013/12/09/computercraft-1-58/// download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.57''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2013/10/14/new-versions/// download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.56''' for '''Minecraft 1.6.2''' ([http://www.computercraft.info/2013/08/04/computercraft-1-56/// download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.55''' for '''Minecraft 1.6.2''' ([http://www.computercraft.info/2013/07/11/computercraft-1-55/// download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.53''' for '''Minecraft 1.5.2''' ([http://www.computercraft.info/2013/05/23/computercraft-1-53// download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.52''' for '''Minecraft 1.5.1''' ([http://www.computercraft.info/2013/03/26/computercraft-1-52/ download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.51''' for '''Minecraft 1.5''' ([http://www.computercraft.info/2013/03/15/computercraft-1-51/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.5''' for '''Minecraft 1.4.7''' ([http://www.computercraft.info/2013/02/11/computercraft-1-5/ download])</td></tr>
</table>
<center>'''[[Changelog]]'''</center>

Template:Version

2014-03-29T20:12:01Z

Lyqyd: Move 1.6 to latest from beta

<table style="width:100%">
<tr><td style="background-color:#E5F9FF; text-align:center;">'''Latest:'''<br />ComputerCraft '''1.6''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2014/03/27/computercraft-1-6-is-here//// download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.58''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2013/12/09/computercraft-1-58/// download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.57''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2013/10/14/new-versions/// download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.56''' for '''Minecraft 1.6.2''' ([http://www.computercraft.info/2013/08/04/computercraft-1-56/// download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.53''' for '''Minecraft 1.5.2''' ([http://www.computercraft.info/2013/05/23/computercraft-1-53// download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.52''' for '''Minecraft 1.5.1''' ([http://www.computercraft.info/2013/03/26/computercraft-1-52/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.51''' for '''Minecraft 1.5''' ([http://www.computercraft.info/2013/03/15/computercraft-1-51/ download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.5''' for '''Minecraft 1.4.7''' ([http://www.computercraft.info/2013/02/11/computercraft-1-5/ download])</td></tr>
</table>
<center>'''[[Changelog]]'''</center>

User talk:Thesbros

2014-03-26T05:14:39Z

Lyqyd: fix link

IRC Bot test

== Change "ComputerCraft‎; (+22)" (CID:4756) ==

Your change on the page "ComputerCraft" (CID:4756) deleted the redirect "ComputerCraft" to "Main Page". This is a critical redirect, as there are more than fifty pages that link to the ComputerCraft page.

In future, please check using the "What Links Here" tool on the left sidebar before marking pages for deletions, or, deleting redirects - and ultimately, check with an Administrator before completely removing the redirect. Tagging a redirect page with the <nowiki>{{delete}}</nowiki> does not prevent redirection (and helps retain integrity), but alerts us to the need (or not) to delete said page. ''[[User:AfterLifeLochie|AfterLifeLochie]] 00:18, 10 December 2012 (MSK)''

== Crafting Table ==

ThesBros, is there any chance of adding content to the crafting table page? Or just making it redirect to the MC wiki please?
[[User:Jonjon1234|Jonjon1234]] 01:18, 10 December 2012 (MSK)

== X is not an API ==

How do you define API? Something that can be loaded with <code>os.loadAPI</code>? Well, then [[Monitor (API)|<code>monitor</code>]] is not an API, nor is [[Printer (API)|<code>printer</code>]].

To me, it seems reasonable to say that anything returned by <code>peripheral.wrap</code> is a [[:Category:Peripheral APIs|Peripheral API]], and by association, an API. Both [[workbench (API)]] and [[modem (API)]] are returned by peripheral.wrap.
[[User:Eric|Eric]] 17:11, 20 January 2013 (MSK)

* The [[peripheral.wrap]] method provides access to native functions, and does '''not''' return an API - it returns ''access methods'' to the functions of the wrapped blocks and the API's provided by the block, and allows invoking of the block's API(s). For example, wrapping a modem does not create "modem" API - it provides native access to the Rednet API functions. ''[[User:AfterLifeLochie|AfterLifeLochie]] 17:38, 20 January 2013 (MSK)''

Template:News

2014-03-23T22:24:27Z

Lyqyd: Comment out older events.

'''December 9, 2013'''
* ComputerCraft 1.58 is released for Minecraft '''1.6.4'''.
'''October 14, 2013'''
* ComputerCraft 1.57 is released for Minecraft '''1.6.4'''.
'''August 4, 2013'''
* ComputerCraft 1.56 is released for Minecraft '''1.6.2'''.
'''May 23, 2013'''
* ComputerCraft 1.53 is released for Minecraft '''1.5.2'''.

Template:News

2014-03-23T22:23:02Z

Lyqyd: Add 1.56 - 1.58.

'''December 9, 2013'''
* ComputerCraft 1.58 is released for Minecraft '''1.6.4'''.
'''October 14, 2013'''
* ComputerCraft 1.57 is released for Minecraft '''1.6.4'''.
'''August 4, 2013'''
* ComputerCraft 1.56 is released for Minecraft '''1.6.2'''.
'''May 23, 2013'''
* ComputerCraft 1.53 is released for Minecraft '''1.5.2'''.
'''March 26, 2013'''
* ComputerCraft 1.52 is released for Minecraft '''1.5.1'''.
'''February 11, 2013'''
* ComputerCraft 1.5 is released for Minecraft '''1.4.7'''.
'''December 27, 2012'''
* ComputerCraft 1.481 is released as a quick hotfix for MiscPeripherals.

Template:Version

2014-03-23T22:18:19Z

Lyqyd: Add 1.57, 1.58, 1.6 beta; fix markup

<table style="width:100%">
<tr><td style="background-color:#FFE8A8; text-align:center;">ComputerCraft '''1.6''' ''Beta'' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/forums2/index.php?/topic/16881-computercraft-16-beta-download-and-discussion-pr7-released-march-21st/// download])</td></tr>
<tr><td style="background-color:#E5F9FF; text-align:center;">'''Latest:'''<br />ComputerCraft '''1.58''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2013/12/09/computercraft-1-58/// download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.57''' for '''Minecraft 1.6.4''' ([http://www.computercraft.info/2013/10/14/new-versions/// download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.56''' for '''Minecraft 1.6.2''' ([http://www.computercraft.info/2013/08/04/computercraft-1-56/// download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.53''' for '''Minecraft 1.5.2''' ([http://www.computercraft.info/2013/05/23/computercraft-1-53// download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.52''' for '''Minecraft 1.5.1''' ([http://www.computercraft.info/2013/03/26/computercraft-1-52/ download])</td></tr>
<tr><td style="background-color:#FFFFFF; text-align:center;">ComputerCraft '''1.51''' for '''Minecraft 1.5''' ([http://www.computercraft.info/2013/03/15/computercraft-1-51/ download])</td></tr>
<tr><td style="background-color:#D4D4D4; text-align:center;">ComputerCraft '''1.5''' for '''Minecraft 1.4.7''' ([http://www.computercraft.info/2013/02/11/computercraft-1-5/ download])</td></tr>
</table>
<center>'''[[Changelog]]'''</center>

Template:Event

2013-10-04T13:04:46Z

Lyqyd: Copy-pasta'd returns 4 and 5; important Cranium fix.

<includeonly><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: #DBE5FF; line-height:28px;">[[File:Grid_Modem.png|24px]]  Event {{{name}}}</td></tr>
<tr><td style="border-color: black; padding: .4em; padding-left: .4em;" colspan="2">{{{desc|No description provided.}}}</td></tr>
<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; border-right: solid #C9C9C9 1px; padding: .4em; width: 175px; font-weight: bold;">Returned Object 1</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em; padding-left: .4em;">{{{return1|[[nil|Nothing]]}}}</td></tr>
{{#if: {{{return2|}}} |
<tr style="background-color: #FFFFFF;"><td style="border-right: solid #C9C9C9 1px; padding: .4em; width: 175px; font-weight: bold;">Returned Object 2</td>
<td style="border-color: black; padding: .4em; padding-left: .4em;">{{{return2}}}</td></tr> |}}
{{#if: {{{return3|}}} |
<tr style="background-color: #E8E8E8;"><td style="border-right: solid #C9C9C9 1px; padding: .4em; width: 175px; font-weight: bold;">Returned Object 3</td>
<td style="border-color: black; padding: .4em; padding-left: .4em;">{{{return3}}}</td></tr> |}}
{{#if: {{{return4|}}} |
<tr style="background-color: #FFFFFF;"><td style="border-right: solid #C9C9C9 1px; padding: .4em; width: 175px; font-weight: bold;">Returned Object 4</td>
<td style="border-color: black; padding: .4em; padding-left: .4em;">{{{return4}}}</td></tr> |}}
{{#if: {{{return5|}}} |
<tr style="background-color: #E8E8E8;"><td style="border-right: solid #C9C9C9 1px; padding: .4em; width: 175px; font-weight: bold;">Returned Object 5</td>
<td style="border-color: black; padding: .4em; padding-left: .4em;">{{{return5}}}</td></tr> |}}
</table>

{{#if:{{{examples|}}}|
== Examples ==
{{{examples|}}}
|}}

{{#if:{{{notes|}}}|
== Additional Notes ==
{{{notes}}}
|}}

[[Category:Events]]
</includeonly>

Variables

2013-08-14T19:56:51Z

Lyqyd: Add modulus operator, fix formatting for other arithmetic operators.

[[Category:Tutorials]]
{{Tutorial
|name=Variables
|desc=This is a tutorial page for Variables and their function.
|objective=To gain an understanding of how Variables work.
|prereqs=[[Hello_World_Tutorial|A basic understanding of programming in ComputerCraft]].
}}

== What are Variables? ==

Variables are one of the fundamental building blocks of all coding languages. Variables are just as they sound, they can store a changeable value.

== What do variables look like? ==

Variables will usually be defined near the start of a script or function (Functions will be taught in a later tutorial), as this will make them easy to edit later if required. Variables can be defined in a number of different ways, reliant on the type of data that is being stored.

; String values
String variables can store any text or "string" that you will use in your script. Strings can be defined as follows
local Text = 'This is a string!'
local MoreText = "This is also a string!"
String values have the unique ability to be concatenated (One added to the end of the other). To do this, simply enter a ".." between the two strings or variables.
local Start = "This is"
local Middle = " all part of "
local End = "one sentence!\n"

Start = Start..Middle

write(Start..End)
This will write "This is all part of one sentence!"

; Number values
Number variables can store any number used in the script, as well as perform calculations with them.
Numbers can be defined as follows
local Number = 1
local AnotherNumber = 2
Lua supports the following mathematical functions:
*Addition (+) ''1+1 = 2''
*Subtraction (-) ''2-1 = 1''
*Multiplication (*) ''2*2 = 4''
*Division (/) ''2/2 = 1''
*Modulus (%) ''5%2 = 1''
*Power (^) ''2^3 = 8''

; Boolean values
Boolean variables are simply a "True or False?" variable. They can be either true or false, but nothing else. Boolean values are usually used for conditional statements, which will be covered in a later tutorial.
Boolean variables can be defined as follows
local Bool = true
local Bool2 = false
Note that "true" and "false" are case sensitive.

; Nil values
Nil values are values that are currently storing nothing. Usually you will not explicitly set a variable to nil, as it acts similar to a "false" boolean. All variables are nil by default.
local Variable = nil
Note that "nil" is case sensitive

; Table values
Table variables are variables that can store any other variables, including more tables. They will be described in more depth in a later tutorial.
Tables can be defined as follows
local EmptyTable = {}
local Table = {1,2,3,4}
local AnotherTable = {"This table", "Contains", 3, {"Types of variables!"} }

; Function values
Although not often considered variables, Lua functions can act the same way as other more standard variables. Functions will be described in more detail in a later tutorial.
functions can be defined as follows
local DoStuff = function() end
local function AnotherFunction() end

local DoStuff2 = function()
write("Function!\n")
end
local function AnotherFunction2()
write("Another function!\n")
end
Function and table variables are usually defined over multiple lines due to the length of them. In Lua, a new line does not mark any functionality and is used purely for readability.

Unlike many other languages, Lua allows for variable's data types to be changed as you go, easily overwriting, for example, a string with a number.
local Variable = "String!" --The variable is a string
Variable = 1 --The variable is now a number

== What is "local" and why is it useful? ==
You may have noticed the use of "local" in the above declarations. "local" simply states that the variable being defined should only be used in this script or function. You only need to write local for the first time you set a variable, then it will assume every other time you use the variable afterwards it is the local variable. If you use or set a variable without using local, it will try and use or set a global variable which can be used and modified by other scripts.

Although it likely won't be an issue when you are using ComputerCraft, it is advisable to use local variables and functions when possible, so they will not be unintentionally edited by other functions or scripts.

== Multiple assignments ==
Variables don't necessarily need to be defined one at a time, it is possible to assign multiple values in one operation through the use of commas.
local Var1, Var2 = "One", "Two"
write( Var1..Var2.."\n" )
This script will successfully assign the values "One" and "Two", then write "OneTwo"

==What have we learned?==
*Variables can store values
*Variables store different types of values
*Variables can be defined in different ways
*An overview of what different variable types do
*Use "local" to use variables locally
*Multiple values may be assigned at once

Coroutine (API)

2013-08-06T00:17:14Z

Lyqyd: Removal of NeedsWork following edits made to bottom section of page.

:{| border="1" class="wikitable"
| '''Bug'''
'''From ComputerCraft 1.3''' this API suffers from the problem of potentially spawning Java threads that live forever therefore, use of coroutines should be minimized. This is '''fixed in ComputerCraft 1.32+''', though.
|}

''This is for the Coroutine API. For the Coroutine Object, visit [[Coroutine (type)]].''

Coroutine is a default Lua 5.1 API defined [http://www.lua.org/manual/5.1/manual.html#5.2 here]. Please list any non-working functions on this page.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<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]]  
Coroutine (API)
</td></tr>

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

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[Coroutine (type)|coroutine]] coro</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.create]]({{type|function}} f)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Creates a new coroutine.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[Boolean (type)|boolean]] success, …</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.resume]]({{type|coroutine}} coro, [var1], [var2], ...)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Starts or resumes an existing coroutine.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[Coroutine (type)|coroutine]] coro</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.running]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the currently executing coroutine.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[String (type)|string]] status</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.status]]({{type|coroutine}} coroutine)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the status of the given coroutine.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[Function (type)|function]] coroutine wrapper</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.wrap]]({{type|function}} function)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Creates a new coroutine and wraps it in a function.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[var3], [var4], …</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.yield]]([var1], [var2], …)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Pauses the currently executing coroutine and passes control to its caller.</td></tr>
</table>

== Coroutine States and Ancestry ==
Every coroutine is in one of four states:
* A ''suspended'' coroutine is one that has not yet been started or that has yielded. A suspended coroutine can become running if it is passed to [[coroutine.resume]].
* A ''running'' coroutine is one that is currently executing code. Only one coroutine can be running at a time on a particular computer. A running coroutine can become suspended if it [[coroutine.yield]], normal if it calls [[coroutine.resume]] on another coroutine, or dead by if it returns from its body function.
* A ''normal'' coroutine is one that, while running, resumed another coroutine (the ''child coroutine''). A normal coroutine can become running if its child calls [[coroutine.yield]] or returns from its function body.
* A ''dead'' coroutine is one that, while running, returned from its function body. A dead coroutine can never change state.

While suspended and dead coroutines simply sit loose with no connections to other coroutines, normal and running coroutines have an ancestry relationship between them. Exactly one coroutine is running at any given time, and the running coroutine has no children. Every running or normal coroutine except the top-level BIOS coroutine has a parent, and this relationship forms a chain with one end (the furthest ancestor) being the top-level BIOS coroutine and the other end (the furthest descendant) being the running coroutine. Remember that only the running coroutine can actually execute code, so any functions invoked must be invoked by that coroutine. Then, calling [[coroutine.resume]] makes the chain longer by taking a previously suspended coroutine, hanging it underneath the current coroutine as a new child, and making the current coroutine normal and the new child running. Meanwhile, calling [[coroutine.yield]] makes the chain shorter by turning the currently executing coroutine into a suspended coroutine, detaching it from the chain, and letting its former parent become running.

It is important not to confuse this coroutine chain with the function call stack. Each individual coroutine contains a complete function call stack of its own, rooted at the coroutine’s body function, whether the coroutine is running, normal, or suspended; the chain described in the previous paragraph refers to how entire coroutines are connected together.

== Examples ==
As the coroutine API is very tightly coupled and many of its function must be used to get any interesting results, examples are shown here instead of on the individual function pages.

=== Using the Basic Coroutine Functions ===
This example demonstrates using the basic coroutine functions to pass control and data between coroutines. This example prints the numbers 1 through 17 in order, showing how control flow moves through the main program coroutine and the two created coroutines, while using assertions to show how data flows through the program:

-- These variables will hold the coroutine objects.
local c1 = nil
local c2 = nil

-- This function will be the body of the first coroutine.
local function f1(x)
-- The main code, below, starts c1 first, passing 1.
-- Thus c1 should be running, c2 should be suspended (not started yet), and x should receive the value from main, 1.
-- STEP 2: Check these assumptions.
print(2)
assert(coroutine.status(c1) == "running")
assert(coroutine.status(c2) == "suspended")
assert(x == 1)
-- STEP 3: Run c2 until it yields, start it off with the value 2.
print(3)
success, value = coroutine.resume(c2, 2)
assert(success)
-- In step 6, c2 yields and passes back the value 3.
-- Then c2, having yielded, should be suspended, and c1 should be running again.
-- STEP 7: Check all that.
print(7)
assert(coroutine.status(c1) == "running")
assert(coroutine.status(c2) == "suspended")
assert(value == 3)
-- STEP 8: Run c2 again, passing it the value 4.
-- Since c2 has already run before, this time the 4 will come out of the yield() instead of appear as a function parameter.
print(8)
success, value = coroutine.resume(c2, 4)
-- In step 10, c2 yields and passes back the value 5.
-- Then c2, having yielded, should be suspended, and c1 should be running again.
-- STEP 11: Check all that.
print(11)
assert(coroutine.status(c1) == "running")
assert(coroutine.status(c2) == "suspended")
assert(value == 5)
-- STEP 12: Yield, turning c1 back into a suspended coroutine and continuing execution of the main program, passing back value 6.
print(12)
value = coroutine.yield(6)
end

-- This function will be the body of the second coroutine.
local function f2(x)
-- The first time c2 is run, it is run from f1, which passes 2.
-- Thus c1 should be normal (as we are nested inside it), c2 should be running, and x should receive the value from f1, 2.
-- STEP 4: Check these assumptions.
print(4)
assert(coroutine.status(c1) == "normal")
assert(coroutine.status(c2) == "running")
assert(x == 2)
-- Because c1 is not suspended, we should not be able to resume it.
-- STEP 5: Check this is correct.
print(5)
success, value = coroutine.resume(c1)
assert(not success)
assert(value == "cannot resume normal coroutine")
-- STEP 6: Yield, turning c2 back into a suspended coroutine and continuing execution of c1, passing back value 3.
print(6)
value = coroutine.yield(3)
-- In step 8, c1 resumed c2 again and passed the value 4.
-- c2 should now be running again, and c1 normal again.
-- STEP 9: Check all that.
print(9)
assert(coroutine.status(c1) == "normal")
assert(coroutine.status(c2) == "running")
assert(value == 4)
-- STEP 10: Yield, turning c2 back into a suspended coroutine and continuing execution of c1, passing back value 5.
print(10)
value = coroutine.yield(5)
-- In step 14, the main program resumed c2 directly and passed the value 7, bypassing c1.
-- So c2 should be running and c1 should be suspended.
-- STEP 15: Check all that.
print(15)
assert(coroutine.status(c1) == "suspended")
assert(coroutine.status(c2) == "running")
assert(value == 7)
-- STEP 16: Now die, returning value 8 to the main program.
print(16)
return 8
end

-- Construct the two coroutines.
c1 = coroutine.create(f1)
c2 = coroutine.create(f2)

-- Newly constructed coroutines are always suspended.
assert(coroutine.status(c1) == "suspended")
assert(coroutine.status(c2) == "suspended")

-- STEP 1: Run c1 until it yields, starting it off with the value 1.
print(1)
success, value = coroutine.resume(c1, 1)
assert(success)

-- In step 12, c1 should have yielded and returned the value 6.
-- So now c1 and c2 should both be suspended.
-- STEP 13: Check all that.
print(13)
assert(coroutine.status(c1) == "suspended")
assert(coroutine.status(c2) == "suspended")
assert(value == 6)

-- STEP 14: Run c2 directly, NOT nested inside c1 this time, passing it the value 7.
print(14)
success, value = coroutine.resume(c2, 7)
assert(success)

-- c2 should have exited normally, returning the value 8.
-- Therefore c1 should still be suspended, but c2 should be dead.
-- STEP 17: Check all that.
print(17)
assert(coroutine.status(c1) == "suspended")
assert(coroutine.status(c2) == "dead")
assert(value == 8)

=== Using Coroutine Wrapper Functions ===
This second example is virtually identical, but shows using [[coroutine.wrap]] and wrapper functions instead of the basic coroutine functions (checks of [[coroutine.status]] have been removed as the raw coroutine objects are not available):

-- These variables will hold the coroutine wrapper functions.
local cw1 = nil
local cw2 = nil

-- This function will be the body of the first coroutine.
local function f1(x)
-- The main code, below, starts c1 first, passing 1.
-- Thus c1 should be running, c2 should be suspended (not started yet), and x should receive the value from main, 1.
-- STEP 2: Check these assumptions.
print(2)
assert(x == 1)
-- STEP 3: Run c2 until it yields, start it off with the value 2.
print(3)
value = cw2(2)
-- In step 6, c2 yields and passes back the value 3.
-- Then c2, having yielded, should be suspended, and c1 should be running again.
-- STEP 7: Check all that.
print(7)
assert(value == 3)
-- STEP 8: Run c2 again, passing it the value 4.
-- Since c2 has already run before, this time the 4 will come out of the yield() instead of appear as a function parameter.
print(8)
value = cw2(4)
-- In step 10, c2 yields and passes back the value 5.
-- Then c2, having yielded, should be suspended, and c1 should be running again.
-- STEP 11: Check all that.
print(11)
assert(value == 5)
-- STEP 12: Yield, turning c1 back into a suspended coroutine and continuing execution of the main program, passing back value 6.
print(12)
value = coroutine.yield(6)
end

-- This function will be the body of the second coroutine.
local function f2(x)
-- The first time c2 is run, it is run from f1, which passes 2.
-- Thus c1 should be normal (as we are nested inside it), c2 should be running, and x should receive the value from f1, 2.
-- STEP 4: Check these assumptions.
print(4)
assert(x == 2)
-- Because c1 is not suspended, we should not be able to resume it.
-- STEP 5: Check this is correct (we must use pcall because an error will be raised).
print(5)
success, value = pcall(cw1)
assert(not success)
-- STEP 6: Yield, turning c2 back into a suspended coroutine and continuing execution of c1, passing back value 3.
print(6)
value = coroutine.yield(3)
-- In step 8, c1 resumed c2 again and passed the value 4.
-- c2 should now be running again, and c1 normal again.
-- STEP 9: Check all that.
print(9)
assert(value == 4)
-- STEP 10: Yield, turning c2 back into a suspended coroutine and continuing execution of c1, passing back value 5.
print(10)
value = coroutine.yield(5)
-- In step 14, the main program resumed c2 directly and passed the value 7, bypassing c1.
-- So c2 should be running and c1 should be suspended.
-- STEP 15: Check all that.
print(15)
assert(value == 7)
-- STEP 16: Now die, returning value 8 to the main program.
print(16)
return 8
end

-- Construct the two coroutine wrappers.
cw1 = coroutine.wrap(f1)
cw2 = coroutine.wrap(f2)

-- STEP 1: Run cw1 until it yields, starting it off with the value 1.
print(1)
value = cw1(1)

-- In step 12, c1 should have yielded and returned the value 6.
-- So now c1 and c2 should both be suspended.
-- STEP 13: Check all that.
print(13)
assert(value == 6)

-- STEP 14: Run c2 directly, NOT nested inside c1 this time, passing it the value 7.
print(14)
value = cw2(7)

-- c2 should have exited normally, returning the value 8.
-- Therefore c1 should still be suspended, but c2 should be dead.
-- STEP 17: Check all that.
print(17)
assert(value == 8)

== Interaction with Other APIs ==
The [[OS (API)#pullEvent|os.pullEventRaw]] (and therefore [[os.pullEvent]]) functions are built on top of coroutines: <code>os.pullEventRaw</code> actually just calls [[coroutine.yield]], passing the event type filter up to the parent coroutine. The parent coroutine is expected to wait until an event of the required type arrives, then use [[coroutine.resume]] to pass the event to the suspended coroutine (where it will be returned from <code>os.pullEventRaw</code>). If you use the [[Parallel (API)|parallel API]], this is exactly what [[parallel.waitForAny]] and [[parallel.waitForAll]] do: they pull events from the system event queue (or even from a higher invocation of <code>parallel.waitForAny</code> or <code>parallel.waitForAll</code>!) and deliver them to all nested coroutines. Therefore, the easiest way to use coroutines is the parallel API, if it works for your situation. However, in the event that you are not able to use the parallel API (e.g. if you need to add and remove coroutines from the executing set dynamically), you can build your own dispatcher that delivers events in the same way as the parallel API—looking at the source code to the parallel API may be useful here.

If you choose to use coroutines in a different way, then <code>os.pullEventRaw</code> and <code>os.pullEvent</code> will not work. This in turn will break any other API function which is written on top of <code>os.pullEvent</code>. As a guideline, nearly any API function that can possibly take time to complete will fall into this category; some examples are:
* [[rednet.receive]] blocks until either a [[Rednet message (event)|rednet_message event]] or (if a timeout was requested) a matching [[Timer (event)|timer event]] occurs.
* [[Gps (API)|gps.locate]] blocks until either a number of [[Modem message (event)|modem_message events]] or (if a timeout was requested) a matching [[Timer (event)|timer event]] occurs.
* [[http.get]] blocks until an [[Http success (event)|HTTP success event]] or [[Http failure (event)|HTTP failure event]] occurs.
* [[IO (API)|io.read]] and the built-in [[read]] functions block waiting for, presumably, either [[Char (event)|char events]] or [[Key (event)|key events]].
* [[os.sleep]] blocks until a matching [[Timer (event)|timer event]] occurs.
* [[textutils.slowPrint]] calls [[os.sleep]].
* [[textutils.pagedPrint]] blocks until a [[Key (event)|key event]] occurs for each page.
* Most of the functions in the [[Turtle (API)|turtle API]] (with the exception of [[turtle.getItemCount]], [[turtle.getItemSpace]], and [[turtle.getFuelLevel]]) block waiting for a [[Turtle response (event)|turtle response event]].

Most of these can be worked around by using non-blocking equivalents that return immediately and then queue an event on completion (such as using [[http.request]]) or that deliver an event unconditionally (such as [[Char_(event)|char]] for keyboard input), then handling events in a way that is suitable for the application. However, if possible, it will often be easier to implement event dispatching instead, remembering that [[os.queueEvent]] can be used for inter-coroutine communication within an application. Another alternative, if you must use a custom protocol between your coroutines and dispatcher, might be to replace <code>os.pullEventRaw</code> with a new function that uses a mechanism appropriate to the application.

[[Category:APIs]]

Talk:Coroutine (API)

2013-05-28T14:04:39Z

Lyqyd:

Bottom section (Interaction with other APIs) is written upside-down. It would be more useful to start out talking about how the event-based model ComputerCraft uses actually utilizes coroutines and the .yield and .resume parameters and return values. That is the primary use case for coroutines in ComputerCraft, so it would be better to lead with that, as it will cause less confusion among new users. From there, it would be good to mention that if one does desire to deviate from the event-based model ComputerCraft uses, that one should avoid using (or add special handling for) all of the functions which wait for events. "Blocking" is also a misleading term, since it implies that the execution point gets stuck in that function (which would block other coroutines from running), when the truth of the matter is that it simply yields execution. "Yielding" would be a better term. [[User:Lyqyd|Lyqyd]] 15:53, 28 May 2013 (MSK)

:Better? [[User:Hawk777|Hawk777]] 17:41, 28 May 2013 (MSK)

::Much better, thanks! [[User:Lyqyd|Lyqyd]] 18:04, 28 May 2013 (MSK)

Talk:Coroutine (API)

2013-05-28T11:53:51Z

Lyqyd: Created page with "Bottom section (Interaction with other APIs) is written upside-down. It would be more useful to start out talking about how the event-based model ComputerCraft uses actually u..."

Wiki Todo

2013-05-26T21:44:32Z

Lyqyd:

<div style="padding-left: 8px; float: right">{{List of Administrators}}</div>
<span style='font-size: 132%; font-weight:bold;'>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.</span>

''If you need to contact an Administrator, please visit an admin's userpage, and leave a note on their talk page.''

'''If you make a change here, please give us as much detail as you can, and sign the end of your change using four tildes, like so: <nowiki>~~~~</nowiki>. This allows us to get back to you if we need more information.'''

__TOC__

== Missing & NeedsWork Pages ==
* The [[:Category:Pages_Needing_Changes|Pages Needing Changes]] list shows all the pages that have been tagged with <nowiki>{{NeedsWork}}</nowiki> or <nowiki>{{Stub}}</nowiki>. These pages either need more information, to be tidied, re-worded or adjusted, or just needs some TLC.
* The [[Special:WantedPages| Wanted Pages]] list shows all the pages that are missing (have been linked to, but aren't there). You should first check that the page being requested doesn't already exist (in case the person misspelled the page) and then, if you're feeling adventurous, put together a page. You can always come back, or tag the page with a <nowiki>{{NeedsWork}}</nowiki> or a <nowiki>{{Stub}}</nowiki> tag. If you need help, ask us! We don't bite.

== Additional Tasks ==
*[[Textutils_(API)|Textutils]] (Needs <s>5</s> 3 function pages, <s>2</s> 1 function description)
*[[Vector_(API)|Vector]] <s>(Needs link to page explaining or description explaining what a vector is and function pages)</s>
** <s>It now has a link to Wikipedia, but it doesn't use any of the method or example templates. Can we get this rectified? ''[[User:AfterLifeLochie|AfterLifeLochie]] 02:14, 29 November 2012 (MSK)''</s>
** Now has pages to every function in a standard template. May need to double check work for any broken links or missing pages. Examples and descriptions probably need work. ''[[User:MafiaMoe|MafiaMoe]] 18:38, 23 February 2013 (MSK)''
*[[Paintutils_(API)|Paintutils]] (Needs 3 function pages)
** <s>It also doesn't use any of the methods or example templates. Can we get this rectified? ''[[User:AfterLifeLochie|AfterLifeLochie]] 02:14, 29 November 2012 (MSK)''</s>
** Apparently the thre new functions have been added, and are waiting on approval? Do we need approval for these things? --[[User:Cranium|Cranium]] 15:49, 23 April 2013 (MSK)
* Some links don't link to their correct pages, resulting in page duplication and wasting time deleting pages. Can sometimes be found in the [[Special:WantedPages| Wanted Pages.]]
* Since {{type|int}} is intended to be deleted, are we to be switching those links to {{type|number}}? --[[User:Cranium|Cranium]] 19:57, 10 May 2013 (MSK)
*[[Coroutine_(API)|Coroutine]] (Bottom section on interaction with other APIs is completely misleading; needs either re-write or removal) [[User:Lyqyd|Lyqyd]] 01:44, 27 May 2013 (MSK)

== Wiki Admin Things ==
=== General Wiki Stuff ===
* <s>Random Links, such as mining_turtle via image links, any chance of removing them? </s>
** Uh, no. They're generated through templates doing weird things, and fixing them is a real pain (template re factorization, renaming files, etc). I have fixed some but not all. ''[[User:AfterLifeLochie|AfterLifeLochie]] 16:46, 29 December 2012 (MSK)''
[[Category:Lists]]

Coroutine (API)

2013-05-26T21:43:03Z

Lyqyd: 'Interactions' section at bottom is highly misleading.

{{NeedsWork}}
:{| border="1" class="wikitable"
| '''Bug'''
'''From ComputerCraft 1.3''' this API suffers from the problem of potentially spawning Java threads that live forever therefore, use of coroutines should be minimized. This is '''fixed in ComputerCraft 1.32+''', though.
|}

''This is for the Coroutine API. For the Coroutine Object, visit [[Coroutine (type)]].''

Coroutine is a default Lua 5.1 API defined [http://www.lua.org/manual/5.1/manual.html#5.2 here]. Please list any non-working functions on this page.

<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
<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]]  
Coroutine (API)
</td></tr>

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

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|coroutine}} coro</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.create]]({{Type|function}} f)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Creates a new coroutine.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|boolean}} success, …</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.resume]]({{Type|coroutine}} coro, [var1], [var2], ...)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Starts or resumes an existing coroutine.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|coroutine}} coro</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.running]]()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the currently executing coroutine.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|string}} status</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.status]]({{type|coroutine}} coroutine)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the status of the given coroutine.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">{{Type|function}} coroutine wrapper</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.wrap]]({{type|function}} function)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Creates a new coroutine and wraps it in a function.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[var3], [var4], …</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[coroutine.yield]]([var1], [var2], …)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Pauses the currently executing coroutine and passes control to its caller.</td></tr>
</table>

== Coroutine States and Ancestry ==
Every coroutine is in one of four states:
* A ''suspended'' coroutine is one that has not yet been started or that has yielded. A suspended coroutine can become running if it is passed to [[coroutine.resume]].
* A ''running'' coroutine is one that is currently executing code. Only one coroutine can be running at a time on a particular computer. A running coroutine can become suspended if it [[coroutine.yield]], normal if it calls [[coroutine.resume]] on another coroutine, or dead by if it returns from its body function.
* A ''normal'' coroutine is one that, while running, resumed another coroutine (the ''child coroutine''). A normal coroutine can become running if its child calls [[coroutine.yield]] or returns from its function body.
* A ''dead'' coroutine is one that, while running, returned from its function body. A dead coroutine can never change state.

While suspended and dead coroutines simply sit loose with no connections to other coroutines, normal and running coroutines have an ancestry relationship between them. Exactly one coroutine is running at any given time, and the running coroutine has no children. Every running or normal coroutine except the top-level BIOS coroutine has a parent, and this relationship forms a chain with one end (the furthest ancestor) being the top-level BIOS coroutine and the other end (the furthest descendant) being the running coroutine. Remember that only the running coroutine can actually execute code, so any functions invoked must be invoked by that coroutine. Then, calling [[coroutine.resume]] makes the chain longer by taking a previously suspended coroutine, hanging it underneath the current coroutine as a new child, and making the current coroutine normal and the new child running. Meanwhile, calling [[coroutine.yield]] makes the chain shorter by turning the currently executing coroutine into a suspended coroutine, detaching it from the chain, and letting its former parent become running.

It is important not to confuse this coroutine chain with the function call stack. Each individual coroutine contains a complete function call stack of its own, rooted at the coroutine’s body function, whether the coroutine is running, normal, or suspended; the chain described in the previous paragraph refers to how entire coroutines are connected together.

== Examples ==
As the coroutine API is very tightly coupled and many of its function must be used to get any interesting results, examples are shown here instead of on the individual function pages.

=== Using the Basic Coroutine Functions ===
This example demonstrates using the basic coroutine functions to pass control and data between coroutines. This example prints the numbers 1 through 17 in order, showing how control flow moves through the main program coroutine and the two created coroutines, while using assertions to show how data flows through the program:

-- These variables will hold the coroutine objects.
local c1 = nil
local c2 = nil

-- This function will be the body of the first coroutine.
local function f1(x)
-- The main code, below, starts c1 first, passing 1.
-- Thus c1 should be running, c2 should be suspended (not started yet), and x should receive the value from main, 1.
-- STEP 2: Check these assumptions.
print(2)
assert(coroutine.status(c1) == "running")
assert(coroutine.status(c2) == "suspended")
assert(x == 1)
-- STEP 3: Run c2 until it yields, start it off with the value 2.
print(3)
success, value = coroutine.resume(c2, 2)
assert(success)
-- In step 6, c2 yields and passes back the value 3.
-- Then c2, having yielded, should be suspended, and c1 should be running again.
-- STEP 7: Check all that.
print(7)
assert(coroutine.status(c1) == "running")
assert(coroutine.status(c2) == "suspended")
assert(value == 3)
-- STEP 8: Run c2 again, passing it the value 4.
-- Since c2 has already run before, this time the 4 will come out of the yield() instead of appear as a function parameter.
print(8)
success, value = coroutine.resume(c2, 4)
-- In step 10, c2 yields and passes back the value 5.
-- Then c2, having yielded, should be suspended, and c1 should be running again.
-- STEP 11: Check all that.
print(11)
assert(coroutine.status(c1) == "running")
assert(coroutine.status(c2) == "suspended")
assert(value == 5)
-- STEP 12: Yield, turning c1 back into a suspended coroutine and continuing execution of the main program, passing back value 6.
print(12)
value = coroutine.yield(6)
end

-- This function will be the body of the second coroutine.
local function f2(x)
-- The first time c2 is run, it is run from f1, which passes 2.
-- Thus c1 should be normal (as we are nested inside it), c2 should be running, and x should receive the value from f1, 2.
-- STEP 4: Check these assumptions.
print(4)
assert(coroutine.status(c1) == "normal")
assert(coroutine.status(c2) == "running")
assert(x == 2)
-- Because c1 is not suspended, we should not be able to resume it.
-- STEP 5: Check this is correct.
print(5)
success, value = coroutine.resume(c1)
assert(not success)
assert(value == "cannot resume normal coroutine")
-- STEP 6: Yield, turning c2 back into a suspended coroutine and continuing execution of c1, passing back value 3.
print(6)
value = coroutine.yield(3)
-- In step 8, c1 resumed c2 again and passed the value 4.
-- c2 should now be running again, and c1 normal again.
-- STEP 9: Check all that.
print(9)
assert(coroutine.status(c1) == "normal")
assert(coroutine.status(c2) == "running")
assert(value == 4)
-- STEP 10: Yield, turning c2 back into a suspended coroutine and continuing execution of c1, passing back value 5.
print(10)
value = coroutine.yield(5)
-- In step 14, the main program resumed c2 directly and passed the value 7, bypassing c1.
-- So c2 should be running and c1 should be suspended.
-- STEP 15: Check all that.
print(15)
assert(coroutine.status(c1) == "suspended")
assert(coroutine.status(c2) == "running")
assert(value == 7)
-- STEP 16: Now die, returning value 8 to the main program.
print(16)
return 8
end

-- Construct the two coroutines.
c1 = coroutine.create(f1)
c2 = coroutine.create(f2)

-- Newly constructed coroutines are always suspended.
assert(coroutine.status(c1) == "suspended")
assert(coroutine.status(c2) == "suspended")

-- STEP 1: Run c1 until it yields, starting it off with the value 1.
print(1)
success, value = coroutine.resume(c1, 1)
assert(success)

-- In step 12, c1 should have yielded and returned the value 6.
-- So now c1 and c2 should both be suspended.
-- STEP 13: Check all that.
print(13)
assert(coroutine.status(c1) == "suspended")
assert(coroutine.status(c2) == "suspended")
assert(value == 6)

-- STEP 14: Run c2 directly, NOT nested inside c1 this time, passing it the value 7.
print(14)
success, value = coroutine.resume(c2, 7)
assert(success)

-- c2 should have exited normally, returning the value 8.
-- Therefore c1 should still be suspended, but c2 should be dead.
-- STEP 17: Check all that.
print(17)
assert(coroutine.status(c1) == "suspended")
assert(coroutine.status(c2) == "dead")
assert(value == 8)

=== Using Coroutine Wrapper Functions ===
This second example is virtually identical, but shows using [[coroutine.wrap]] and wrapper functions instead of the basic coroutine functions (checks of [[coroutine.status]] have been removed as the raw coroutine objects are not available):

-- These variables will hold the coroutine wrapper functions.
local cw1 = nil
local cw2 = nil

-- This function will be the body of the first coroutine.
local function f1(x)
-- The main code, below, starts c1 first, passing 1.
-- Thus c1 should be running, c2 should be suspended (not started yet), and x should receive the value from main, 1.
-- STEP 2: Check these assumptions.
print(2)
assert(x == 1)
-- STEP 3: Run c2 until it yields, start it off with the value 2.
print(3)
value = cw2(2)
-- In step 6, c2 yields and passes back the value 3.
-- Then c2, having yielded, should be suspended, and c1 should be running again.
-- STEP 7: Check all that.
print(7)
assert(value == 3)
-- STEP 8: Run c2 again, passing it the value 4.
-- Since c2 has already run before, this time the 4 will come out of the yield() instead of appear as a function parameter.
print(8)
value = cw2(4)
-- In step 10, c2 yields and passes back the value 5.
-- Then c2, having yielded, should be suspended, and c1 should be running again.
-- STEP 11: Check all that.
print(11)
assert(value == 5)
-- STEP 12: Yield, turning c1 back into a suspended coroutine and continuing execution of the main program, passing back value 6.
print(12)
value = coroutine.yield(6)
end

-- This function will be the body of the second coroutine.
local function f2(x)
-- The first time c2 is run, it is run from f1, which passes 2.
-- Thus c1 should be normal (as we are nested inside it), c2 should be running, and x should receive the value from f1, 2.
-- STEP 4: Check these assumptions.
print(4)
assert(x == 2)
-- Because c1 is not suspended, we should not be able to resume it.
-- STEP 5: Check this is correct (we must use pcall because an error will be raised).
print(5)
success, value = pcall(cw1)
assert(not success)
-- STEP 6: Yield, turning c2 back into a suspended coroutine and continuing execution of c1, passing back value 3.
print(6)
value = coroutine.yield(3)
-- In step 8, c1 resumed c2 again and passed the value 4.
-- c2 should now be running again, and c1 normal again.
-- STEP 9: Check all that.
print(9)
assert(value == 4)
-- STEP 10: Yield, turning c2 back into a suspended coroutine and continuing execution of c1, passing back value 5.
print(10)
value = coroutine.yield(5)
-- In step 14, the main program resumed c2 directly and passed the value 7, bypassing c1.
-- So c2 should be running and c1 should be suspended.
-- STEP 15: Check all that.
print(15)
assert(value == 7)
-- STEP 16: Now die, returning value 8 to the main program.
print(16)
return 8
end

-- Construct the two coroutine wrappers.
cw1 = coroutine.wrap(f1)
cw2 = coroutine.wrap(f2)

-- STEP 1: Run cw1 until it yields, starting it off with the value 1.
print(1)
value = cw1(1)

-- In step 12, c1 should have yielded and returned the value 6.
-- So now c1 and c2 should both be suspended.
-- STEP 13: Check all that.
print(13)
assert(value == 6)

-- STEP 14: Run c2 directly, NOT nested inside c1 this time, passing it the value 7.
print(14)
value = cw2(7)

-- c2 should have exited normally, returning the value 8.
-- Therefore c1 should still be suspended, but c2 should be dead.
-- STEP 17: Check all that.
print(17)
assert(value == 8)

== Interaction with Other APIs ==
Raw coroutines are not always safe to use with other API functions. The reason is that [[os.pullEventRaw]] (and therefore [[os.pullEvent]], which calls it) are themselves built using coroutines: <code>os.pullEventRaw</code> actually invokes [[coroutine.yield]], passing the event type filter up to what it expects is the [[Parallel (API)|parallel API]], which would resume the coroutine once a matching event arrives. This is how the parallel API allows other code to run while one function is blocking waiting for an event. However, it means if you call <code>os.pullEventRaw</code> ''or any other function that uses it'' while managing coroutines yourself, you will see a coroutine unexpectedly yield, with the parent [[coroutine.resume]] being passed as a return value the filter string passed to <code>os.pullEventRaw</code>.

In this situation, it is essential that a developer carefully audit any APIs (s)he may wish to use to verify whether they could possibly block—many APIs, even those one might not expect, fall into this category. Some examples are:
* [[rednet.receive]] blocks until either a [[Rednet message (event)|rednet_message event]] or (if a timeout was requested) a matching [[Timer (event)|timer event]] occurs.
* [[Gps (API)|gps.locate]] blocks until either a number of [[Modem message (event)|modem_message events]] or (if a timeout was requested) a matching [[Timer (event)|timer event]] occurs.
* [[http.get]] blocks until an [[Http success (event)|HTTP success event]] or [[Http failure (event)|HTTP failure event]] occurs.
* [[IO (API)|io.read]] and the built-in [[read]] functions block waiting for, presumably, either [[Char (event)|char events]] or [[Key (event)|key events]].
* [[os.sleep]] blocks until a matching [[Timer (event)|timer event]] occurs.
* [[textutils.slowPrint]] calls [[os.sleep]].
* [[textutils.pagedPrint]] blocks until a [[Key (event)|key event]] occurs for each page.
* Most of the functions in the [[Turtle (API)|turtle API]] (with the exception of [[turtle.getItemCount]], [[turtle.getItemSpace]], and [[turtle.getFuelLevel]]) block waiting for a [[Turtle response (event)|turtle response event]].

Although it is not always practical to do so, in some situations, the [[Parallel (API)|parallel API]] may be preferable to using coroutines directly, as it handles event dispatching properly. However, it does not allow chaining coroutine invocations, nor does it allow adding coroutines to the parallel set after parallel execution has started. If coroutines are to be used directly, an application may either ensure it avoids any blocking API calls, or may arrange to handle event dispatch the same way that the parallel API does so that the blocking functions work properly. For example, one might arrange the convention that the top-level coroutine in the application will call [[os.pullEvent]] and deliver any returned events to sub-coroutines, the same way that the parallel API does, thus allowing those sub-coroutines to themselves call [[os.pullEvent]], while insisting on a convention that more deeply nested coroutines never call [[os.pullEvent]] at all.

[[Category:APIs]]

Command Block (API)

2013-03-30T21:16:19Z

Lyqyd: Fix typo (Where does peripheral "warping" come from, anyhow?)

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, where commandBlock is wrapped to a command block:
{| border="1" cellpadding="2" cellspacing="0"
!style="background:#EEE" width="*"|Function
!style="background:#EEE" width="*"|Description
|-
|[[commandBlock.getCommand]]( )
|Returns a string containing the command currently inside the Command Block.
|-
|[[commandBlock.setCommand]]( [[string_(type)|string]] command )
|Sets the command in the Command Block. '''This does not run it.'''
|-
|[[commandBlock.runCommand]]( )
|Runs the command inside the Command Block previously set by [[commandBlock.setCommand]]( )
|}

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

[[Category:Peripheral APIs]]

OpenCCSensors

2013-03-18T08:18:30Z

Lyqyd: Fix cubic dimension descriptions for block-based radii.

[http://www.computercraft.info/forums2/index.php?/topic/5996-144-cc-147-openccsensors/ OpenCCSensors] is a new, open-source, up to date replacement for [[CcSensors|CcSensors (outdated)]], allowing monitoring and gathering information from the Minecraft environment - including players, entities, proximity, world info, IndustrialCraft 2, BuildCraft 2, liquids, inventories - and more!

OpenCCSensors comes with its own API, and automatically installs a new program for you at /ocs/programs/sensorview. sensorview is a handy program for very quickly looking at the information gathered from your sensors.

http://www.youtube.com/watch?v=i8Bv7uKkIOM&feature=youtu.be

<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]]  
OpenCCSensors Peripherals
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sensor Peripheral</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">

The Sensor Peripheral needs to be placed next to a computer and it has a single slot to insert a Sensor Card

{{Crafting grid
|A1=Obsidian |B1=Obsidian |C1=Obsidian
|A2=Redstone |B2=Obsidian |C2=Redstone
|A3=Stone |B3=Stone |C3=Stone
|Output=Sensor Peripheral
|Output-link=OpenCCSensors
}}
<table style="width: 100%; border-spacing: 0px;">

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">os.loadAPI("ocs/apis/sensor")</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Load the sensor API</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">mySensor = sensor.wrap(side)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the wrapped sensor on the side specified.</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">mySensor.getTargets()</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a a table of all the targets for mySensor, where the keys are used as a numerical index, and the values are each a table of basic details.</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">mySensor.getTargetDetails(key)</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns a table of full details for that particular target from the sensor mySensor - where the the "key" is the key returned from getTargets()</td></tr>

</table>
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Gauge Peripheral</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">

The Gauge Peripheral can be placed onto the side of certain machines to get instant readings from them. Right now this only supports Batboxes, MFE's, MFSU, Mass fabricators and Nuclear reactors. We hope to expand this in the future as well as offer an API to re-program the gauge from a computer.

{{Crafting grid
|A1=glass_pane |B1=Redstone |C1=Monitor
|Output=Gauge Peripheral
|Output-link=OpenCCSensors
}}

</td></tr>
</table>

<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]]  
OpenCCSensors Sensor Cards
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Inventory Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Inventory Sensor Card is capable of reading inventories of any chests or machines around the sensor. It gives full information about what item is in each slot.

{{Crafting grid
|A1=Redstone |B1=wooden_plank |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Inventory Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Proximity Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Proximity Sensor Card is capable of detecting players and entities within it's range.

{{Crafting grid
|A1=Redstone |B1=pressure_plate |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Proximity Sensor Card
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Industrial Craft 2 Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The IndustrialCraft Sensor Card is capable of interfacing and reading IC2 machine values (eg, EU in storage, etc).

{{Crafting grid
|A1=Redstone |B1=copper_cable|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Industrial Craft 2 Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">BuildCraft Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">

{{Crafting grid
|A1=Redstone |B1=lever |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Buildcraft Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Tank Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Tank sensor card is far more powerful than it first seems. This card not only reads actual tanks, but reads internal tanks within a variety of different machines, such as:

Railcraft: Iron Tanks, Buildcraft: Tanks, Thermal Expansion: Aqueous Accumulator, Thermal Expansion: Igneous Extruder, Thermal Expansion: Glacial Precipitator, Thermal Expansion: Liquid Transposer, Thermal Expansion: Magma Crucible, Thermal Expansion: Magmatic Engine, Thermal Expansion: Steam Engine, Industrial Craft: Geothermal Generator, Thaumcraft: Crucible, Buildcraft: Tank, Buildcraft: Combustion Engine, Buildcraft: Pump, Buildcraft: Refinery, Forestry: Biogas Engine, Forestry: Fermenter, Forestry: Still, Forestry: Bottler, Forestry: Raintank, Forestry: Bio Generator, Forestry: Carpenter, Forestry: Moistener, Forestry: Squeezer, Forestry: Thermonic Fabricator, Extra Bees: Analyser, Extra Bees: Purifier, Extra Bees: Synthesizer, Extra Bees: Genepool, Extra Bees: Splicer, Railcraft: Hobbyist's Steam Engine, Railcraft: Commercial Steam Engine, Railcraft: Industrial Steam Engine, GregTech: Quantum Tank, GregTech: Thermal Generator

{{Crafting grid
|A1=Redstone |B1=Bucket |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Liquid Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">World Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The World Sensor Card is able to tell the time, weather, and more about the world.

{{Crafting grid
|A1=Redstone |B1=ender_pearl |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=World Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Dropped Item Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Dropped Item Sensor Card is able to locate and identify dropped items.

{{Crafting grid
|A1=Redstone |B1=slime_ball |C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Dropped Item Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sign Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Sign Sensor Card is capable of reading signs within it's range.

{{Crafting grid
|A1=Redstone |B1=sign|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Sign Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Thaumcraft Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Thaumcraft Card can read XP levels from a "brain in a jar" and read aspect levels from crucibles and jars

{{Crafting grid
|A1=Redstone |B1=Goggles of Revealing|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Thaumcraft Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Minecart Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Minecart Sensor Card can detect minecarts in the area and give basic information about them

{{Crafting grid
|A1=Redstone |B1=Minecart|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Minecart Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sonic Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Sonic Sensor Card can detect blocks in the area and report if they're solid or liquid.

{{Crafting grid
|A1=Redstone |B1=Note Block|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Sonic Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Applied Energistics Sensor Card</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">This sensor card is similar to the inventory sensor card, but can read information from a ME Wireless Access Point in Applied Energistics. It also gives some other information regarding AE. New in OpenCCSensors 0.1.4b.

{{Crafting grid
|A1=Redstone |B1=Quartz Crystal|C1=Redstone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=paper |B3=paper |C3=paper
|Output=Applied Energistics Sensor Card
|Output-link=OpenCCSensors
}}
</td></tr>

</table>

<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]]  
OpenCCSensors Sensor Card Upgrades
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Range Extension Antenna</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Range Extension Antenna is used to upgrade sensor cards to Mk1, Mk2, and Mk3.

{{Crafting grid
|B1=redstone_torch
|A2=stone |B2=Redstone |C2=stone
|A3=stone |B3=iron_ingot |C3=stone
|Output=Range Extension Antenna
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Signal Amplifier</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Signal Amplifier is used to upgrade sensor cards to Mk3 and Mk4.

{{Crafting grid
|A1=stone |B1=Gold_Ingot|C1=stone
|A2=Redstone |B2=Redstone |C2=Redstone
|A3=stone |B3=Gold_Ingot |C3=stone
|Output=Signal Amplifier
|Output-link=OpenCCSensors
}}
</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">Advanced Amplifier</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The Advanced Amplifier is used to upgrade sensor cards to Mk4.

{{Crafting grid
|A1=iron_ingot |B1=Gold_Ingot|C1=iron_ingot
|A2=Redstone |B2=Diamond |C2=Redstone
|A3=iron_ingot |B3=Gold_Ingot |C3=iron_ingot
|Output=Advanced Amplifier
|Output-link=OpenCCSensors
}}
</td></tr>

</table>

<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]]  
Sensor Tiers
</td></tr>

<tr><td style="width: 350px; background: #E0E0E0; padding: .4em; font-weight:bold;">Name</td><td style="background: #E0E0E0; padding: .4em; font-weight:bold;">Description</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">'''Mk 1'''</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">The recipes for Mk 1 sensors are all different. (See above sensor card lists)
Special-type sensor cards (Currently only the World Sensor Card) only exist as Mk 1, as they do not have a range.

'''Ranges:'''

<table>
<tr><td>Type</td><td>Range</td><td>Sensor types</td></tr>
<tr><td>Block<td>'''1''' block away (3x3x3)</td><td>
[[File:Grid_Inventory_Sensor_Card.png|24px|Inventory Sensor]]
[[File:Grid_Industrial_Craft_2_Sensor_Card.png|24px|Industrial Craft 2 Sensor]]
[[File:Grid_Buildcraft_Sensor_Card.png|24px|Buildcraft Sensor]]
[[File:Grid_Liquid_Sensor_Card.png|24px|Liquid Sensor]]
[[File:Grid_Sign_Sensor_Card.png|24px|Sign Sensor]]
[[File:Grid_Thaumcraft_Sensor_Card.png|24px|Thaumcraft Sensor]]
[[File:Grid_Sonic_Sensor_Card.png|24px|Sonic Sensor]]
</td></tr>
<tr><td>Entity<td>'''4''' block-radius sphere</td><td>
[[File:Grid_Proximity_Sensor_Card.png|24px|Proximity Sensor]]
[[File:Grid_Dropped_Item_Sensor_Card.png|24px|Dropped Item Sensor]]
[[File:Grid_Minecart_Sensor_Card.png|24px|Minecart Sensor]]
</td></tr>
<tr><td>Special</td><td>N/A</td><td>
[[File:Grid_World_Sensor_Card.png|24px|World Sensor]]
</td></tr>
</table>

</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">'''Mk 2'''</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Mk 2 is the first upgrade to sensor cards. Simply combine a Range Extension Antenna with a Mk 1 sensor card (The recipe is shapeless)

{{Crafting grid
|A1=Inventory Sensor Card |B1=Range Extension Antenna
|Output=Inventory Sensor Card Mk2
|Output-link=OpenCCSensors
}}

'''Ranges:'''
<table>
<tr><td>Type</td><td>Range</td><td>Sensor types</td></tr>
<tr><td>Block<td>'''3''' blocks away (7x7x7)</td><td>
[[File:Grid_Inventory_Sensor_Card.png|24px|Inventory Sensor]]
[[File:Grid_Industrial_Craft_2_Sensor_Card.png|24px|Industrial Craft 2 Sensor]]
[[File:Grid_Buildcraft_Sensor_Card.png|24px|Buildcraft Sensor]]
[[File:Grid_Liquid_Sensor_Card.png|24px|Liquid Sensor]]
[[File:Grid_Sign_Sensor_Card.png|24px|Sign Sensor]]
[[File:Grid_Thaumcraft_Sensor_Card.png|24px|Thaumcraft Sensor]]
[[File:Grid_Sonic_Sensor_Card.png|24px|Sonic Sensor]]
</td></tr>
<tr><td>Entity<td>'''12''' block-radius sphere</td><td>
[[File:Grid_Proximity_Sensor_Card.png|24px|Proximity Sensor]]
[[File:Grid_Dropped_Item_Sensor_Card.png|24px|Dropped Item Sensor]]
[[File:Grid_Minecart_Sensor_Card.png|24px|Minecart Sensor]]
</td></tr>
</table>

</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">'''Mk 3'''</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Mk 3 is the second upgrade to sensor cards. Note that the recipe is no longer shapeless.

{{Crafting grid
|A1=Range Extension Antenna |B1=Inventory Sensor Card Mk2|C1=Range Extension Antenna
|B2=Signal Amplifier
|Output=Inventory Sensor Card Mk3
|Output-link=OpenCCSensors
}}

'''Ranges:'''
<table>
<tr><td>Type</td><td>Range</td><td>Sensor types</td></tr>
<tr><td>Block<td>'''5''' blocks away (11x11x11)</td><td>
[[File:Grid_Inventory_Sensor_Card.png|24px|Inventory Sensor]]
[[File:Grid_Industrial_Craft_2_Sensor_Card.png|24px|Industrial Craft 2 Sensor]]
[[File:Grid_Buildcraft_Sensor_Card.png|24px|Buildcraft Sensor]]
[[File:Grid_Liquid_Sensor_Card.png|24px|Liquid Sensor]]
[[File:Grid_Sign_Sensor_Card.png|24px|Sign Sensor]]
[[File:Grid_Thaumcraft_Sensor_Card.png|24px|Thaumcraft Sensor]]
[[File:Grid_Sonic_Sensor_Card.png|24px|Sonic Sensor]]
</td></tr>
<tr><td>Entity<td>'''20''' block-radius sphere</td><td>
[[File:Grid_Proximity_Sensor_Card.png|24px|Proximity Sensor]]
[[File:Grid_Dropped_Item_Sensor_Card.png|24px|Dropped Item Sensor]]
[[File:Grid_Minecart_Sensor_Card.png|24px|Minecart Sensor]]
</td></tr>
</table>

</td></tr>

<tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">'''Mk 4'''</td>
<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Mk 4 is the highest tier of sensor card upgrades

{{Crafting grid
|B1=Range Extension Antenna
|A2=Range Extension Antenna |B2=Inventory Sensor Card Mk3|C2=Range Extension Antenna
|A3=Signal Amplifier|B3=Advanced Amplifier|C3=Signal Amplifier
|Output=Inventory Sensor Card Mk4
|Output-link=OpenCCSensors
}}

'''Ranges:'''
<table>
<tr><td>Type</td><td>Range</td><td>Sensor types</td></tr>
<tr><td>Block<td>'''7''' blocks away (15x15x15)</td><td>
[[File:Grid_Inventory_Sensor_Card.png|24px|Inventory Sensor]]
[[File:Grid_Industrial_Craft_2_Sensor_Card.png|24px|Industrial Craft 2 Sensor]]
[[File:Grid_Buildcraft_Sensor_Card.png|24px|Buildcraft Sensor]]
[[File:Grid_Liquid_Sensor_Card.png|24px|Liquid Sensor]]
[[File:Grid_Sign_Sensor_Card.png|24px|Sign Sensor]]
[[File:Grid_Thaumcraft_Sensor_Card.png|24px|Thaumcraft Sensor]]
[[File:Grid_Sonic_Sensor_Card.png|24px|Sonic Sensor]]
</td></tr>
<tr><td>Entity<td>'''28''' block-radius sphere</td><td>
[[File:Grid_Proximity_Sensor_Card.png|24px|Proximity Sensor]]
[[File:Grid_Dropped_Item_Sensor_Card.png|24px|Dropped Item Sensor]]
[[File:Grid_Minecart_Sensor_Card.png|24px|Minecart Sensor]]
</td></tr>
</table>

</td></tr>

</table>

= Usage Examples =
{{Example
|desc=List all available targets on a Proximity Sensor on the left of the Computer.
|code=os.loadAPI("ocs/apis/sensor")
local prox = sensor.wrap("left")
print(textutils.serialize(prox.getTargets()))
|output=A huge blob of text with all nearby available targets to the sensor, and some basic details.
}}
{{Example
|desc=Turn on a Redstone lamp when a player is within a certain distance from it. The sensor is placed to the left of the computer and the lamp is placed on top of the computer.
|code=
os.loadAPI("ocs/apis/sensor")

-- the location of the redstone lamp relative to the sensor
local offset = {
X = 1,
Y = 1,
Z = 0
}

-- how close a player has to be to activate the lamp
local radius = 5

-- find the distance from the player position to the offset
function distance(pos)
local xd = pos.X - offset.X
local yd = pos.Y - offset.Y
local zd = pos.Z - offset.Z
return math.sqrt(xd*xd + yd*yd + zd*zd)
end

local proximity = sensor.wrap("left")
while true do
local signal = false
local targets = proximity.getTargets()
for k, v in pairs(targets) do
if distance(v.Position) < radius then
signal = true
end
end
rs.setOutput("top", signal)
end
}}

[[Category:User_Created_Peripherals]][[Category:Unofficial_APIs]]

Talk:Fs.open/Mode:Read

2012-12-30T21:38:39Z

Lyqyd: Created page with "A-tab, what's going on with the formatting on this page? Should the = =Examples= = bit be showing up as a header? ~~~~"

A-tab, what's going on with the formatting on this page? Should the = =Examples= = bit be showing up as a header? [[User:Lyqyd|Lyqyd]] 01:38, 31 December 2012 (MSK)

Fs.open/Mode:Read

2012-12-30T21:37:48Z

Lyqyd:

== Opening A File For Reading ==

To read data from a saved file, one must use either of the read modes with [[fs.open]](). The two read modes are textual read mode ("r") and binary read mode ("rb"). Most work with reading data from files in ComputerCraft will be done with textual read mode.

All examples below will use a file at the path "file/name", which contains this text:

<pre>line 1
line 2
a third line</pre>

== Textual Read Mode ==

{{Function
|name=<var>handle</var>.readLine
|api=fs
|returns=[[string]] the next line read from the file, with the end-of-line character stripped; or nil if there are no more lines in the file
|desc=Reads the next line from the file
|examples=<pre>
local handle = fs.open("file/name", "r")
if handle then
text = handle.readLine()
--text now contains: line 1
text = handle.readLine()
--text now contains: line 2
text = handle.readLine()
--text now contains: a third line
handle.close()
end
</pre>
}}

Raw key events

2012-12-21T18:36:14Z

Lyqyd: Added left super, right super, and menu key codes.

The built-in os has a function to read incoming keystrokes. But it also implements the functions to move the cursor while typing. This is not always a desired feature; imagine a case in which you want to make a menu with a controllable cursor around the menu entries. The current read() function won't let you.

==Detecting keystrokes==
In case I made you think the OS sucks, it doesn't (all the time). Because this OS is not Windows, we can access lower-level functions, such as os.pullEvent(). And that's the one that we're going to use:
<pre>
function rawread()
bRead = true
while(bRead) do
local sEvent, param = os.pullEvent("key")
if(sEvent == "key") then
break
end
end
end
</pre>
This function waits for any key, then exits.

==Figuring out the key==
We can detect any key, but not which key. To find it out, we have to add some further logic to the code:
<pre>
function rawread()
while true do
local sEvent, param = os.pullEvent("key")
if sEvent == "key" then
if param == 28 then
print("Enter detected")
break
end
end
end
end
</pre>
This function waits for the Enter key to be pressed. If so, it writes "Enter detected" to the screen and exits.

==Key scan codes ==
The scan codes are typical DirectX numbers.
{|
|style="vertical-align: top"|
{| border="1" cellpadding="5" cellspacing="0"
|-
! |Key
! |Code
|-
| Escape
| 1
|-
| 1
| 2
|-
| 2
| 3
|-
| 3
| 4
|-
| 4
| 5
|-
| 5
| 6
|-
| 6
| 7
|-
| 7
| 8
|-
| 8
| 9
|-
| 9
| 10
|-
| 0
| 11
|-
| Minus
| 12
|-
| Equals
| 13
|-
| Backspace
| 14
|-
| Tab
| 15
|-
| Q
| 16
|-
| W
| 17
|-
| E
| 18
|-
| R
| 19
|-
| T
| 20
|-
| Y
| 21
|-
| U
| 22
|-
| I
| 23
|-
| O
| 24
|-
| P
| 25
|}
|style="vertical-align: top"|
{| border="1" cellpadding="5" cellspacing="0"
|-
! |Key
! |Code
|-
| Left Bracket
| 26
|-
| Right Bracket
| 27
|-
| Enter
| 28
|-
| Left Control
| 29
|-
| A
| 30
|-
| S
| 31
|-
| D
| 32
|-
| F
| 33
|-
| G
| 34
|-
| H
| 35
|-
| J
| 36
|-
| K
| 37
|-
| L
| 38
|-
| Semicolon
| 39
|-
| Apostrophe
| 40
|-
| Tilde (~)
| 41
|-
| Left Shift
| 42
|-
| Back Slash
| 43
|-
| Z
| 44
|-
| X
| 45
|-
| C
| 46
|-
| V
| 47
|}
|style="vertical-align: top"|
{| border="1" cellpadding="5" cellspacing="0"
|-
! |Key
! |Code
|-
| B
| 48
|-
| N
| 49
|-
| M
| 50
|-
| Comma
| 51
|-
| Period
| 52
|-
| Forward Slash
| 53
|-
| Right Shift
| 54
|-
| Numpad *
| 55
|-
| Left Alt
| 56
|-
| Spacebar
| 57
|-
| Caps Lock
| 58
|-
| F1
| 59
|-
| F2
| 60
|-
| F3
| 61
|-
| F4
| 62
|-
| F5
| 63
|-
| F6
| 64
|-
| F7
| 65
|-
| F8
| 66
|-
| F9
| 67
|-
| F10
| 68
|}
|style="vertical-align: top"|
{| border="1" cellpadding="5" cellspacing="0"
|-
! |Key
! |Code
|-
| Num Lock
| 69
|-
| Scroll Lock
| 70
|-
| Numpad 7
| 71
|-
| Numpad 8
| 72
|-
| Numpad 9
| 73
|-
| Numpad -
| 74
|-
| Numpad 4
| 75
|-
| Numpad 5
| 76
|-
| Numpad 6
| 77
|-
| Numpad +
| 78
|-
| Numpad 1
| 79
|-
| Numpad 2
| 80
|-
| Numpad 3
| 81
|-
| Numpad 0
| 82
|-
| Numpad .
| 83
|-
| F11
| 87
|-
| F12
| 88
|-
| Numpad Enter
| 28 <s>156</s> *
|-
| Right Control
| 157
|-
| Numpad /
| 181
|-
| Right Alt
| 184
|}
|style="vertical-align: top"|
{| border="1" cellpadding="5" cellspacing="0"
|-
! |Key
! |Code
|-
| Home
| 199
|-
| Up Arrow
| 200
|-
| Page Up
| 201
|-
| Left Arrow
| 203
|-
| Right Arrow
| 205
|-
| End
| 207
|-
| Down Arrow
| 208
|-
| Page Down
| 209
|-
| Insert
| 210
|-
| Delete
| 211
|-
| Left Super
| 219
|-
| Right Super
| 220
|-
| Menu
| 221
|-
|}
|}
Source: [http://wiki.tesnexus.com/index.php/DirectX_Scancodes_And_How_To_Use_Them Nexus Wiki]<br />
<i>Note: Items marked with * are not the correct keycode, but return a matching keycode for another button (eg, enter keys).</i>

[[Category:Tutorials]]

Fs.open/Mode:Read

2012-12-19T17:01:27Z

Lyqyd: Initial rough entry.

== Opening A File For Reading ==

To read data from a saved file, one must use either of the read modes with [[fs.open]](). The two read modes are textual read mode ("r") and binary read mode ("rb"). Most work with reading data from files in ComputerCraft will be done with textual read mode.

All examples below will use a file at the path "file/name", which contains this text:

<pre>line 1
line 2
a third line</pre>

== Textual Read Mode ==

{{Function
|name=<var>handle</var>.readLine
|api=fs
|returns=[[string]] the next line read from the file, with the end-of-line character stripped; or nil if there are no more lines in the file
|desc=Reads the next line from the file
}}

<pre>
local handle = fs.open("file/name", "r")
if handle then
text = handle.readLine()
--text now contains: line 1
text = handle.readLine()
--text now contains: line 2
text = handle.readLine()
--text now contains: a third line
handle.close()
end
</pre>

Talk:Fs.open

2012-12-17T20:06:04Z

Lyqyd: Created page with "AfterLifeLochie, have read/write subpages been created? I wouldn't mind starting to work on them if they exist, I just don't know what you want them named. ~~~~"

AfterLifeLochie, have read/write subpages been created? I wouldn't mind starting to work on them if they exist, I just don't know what you want them named. [[User:Lyqyd|Lyqyd]] 00:06, 18 December 2012 (MSK)

File:Advanced-program.png

2012-12-02T17:27:42Z

Lyqyd: An image of an advanced program on the screen.

An image of an advanced program on the screen.

IO (API)

2012-11-30T18:50:30Z

Lyqyd: FS linking fix.

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:

* file:seek(...) - Doesn't exist.
* io.lines(...) - Doesn't exist either.
* io.read("*all") - read() does not work with "*all" argument; use "*a" instead.
* io.open("FILE_NAME", "a+") - Append+ mode is unsupported.
* file:read(...) - Doesn't seem to exist in 1.43.
* file:read(number) - Doesn't exist as of 1.46.

If any functions don't exist try the [[Fs (API)|Fs]] API instead.
[[Category:APIs]]

Talk:Int (type)

2012-11-30T18:48:17Z

Lyqyd: int/number confusion

I hate to bring this up at this point, but is this a potential source of confusion? Lua uses the "number" type for all numbers. Perhaps mentioning this explicitly would be a good idea. [[User:Lyqyd|Lyqyd]] 22:48, 30 November 2012 (MSK)

Term.scroll

2012-11-30T18:46:30Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=term.scroll
|args=[[int (type)|int]] n
|returns=None
|api=term
|addon=ComputerCraft
|desc=Scrolls the terminal window.
|examples=
}}

[[Category:API_Functions]]

Turtle.getItemSpace

2012-11-30T18:46:06Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=turtle.getItemSpace
|args=
|api=turtle
|returns=[[int (type)|int]] the amount of room for items found in the specified slot.
|addon=ComputerCraft
|desc=Prints the number of spaces remaining in the specified slot.
|examples=
{{Example
|desc=Prints the number of spaces remaining in the specified slot.
|code=print(turtle.getItemSpace())
|output=Integer 0 through 64 depending on number of items.
}}
}}

[[Category:Lua_Core_Functions]]

Turtle.getItemCount

2012-11-30T18:45:51Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=turtle.getItemCount
|args=slot
|api=turtle
|returns=[[int (type)|int]] the number of items found in the specified slot.
|addon=ComputerCraft
|desc=Return the number of items in the specified slot.
|examples=
{{Example
|desc=Prints the number of items in the specified slot.
|code=print(turtle.getItemCount(1))
|output=An integer 0 through 64 depending on number of items in slot 1.
}}
}}

[[Category:Lua_Core_Functions]]

Fs.open

2012-11-30T18:37:13Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=fs.open
|args=[[string (type)|string]] path, [[string (type)|string]]
mode
|api=fs
|returns=[[table]] the file handle, or <code>nil</code> if the mode was read-only or the file did not exist
|desc=Opens a file; <var>mode</var> consists of a first character which is one of
"r" to open the file read-only,

"w" to open it for writing and remove any existing data, or

"a" to open for writing but keep existing data and append any writes to the end of the file, plus optionally the second character

"b" to open the file for binary access instead of text access
(text mode will perform end-of-line conversions necessary to move text files between Windows, Linux, and Mac OS systems; binary files should not have these conversions applied as they will be corrupted)
|examples=
{{Example
|desc=Creates the file "abcd" and holds a file handle to it
|code=h = fs.open("abcd", "w")
}}
}}

== File Handles ==

A file handle allows access to a file. A file handle is a table; the functions within the table are accessed with the dot operator (<em>not</em> the colon operator, as may be more intuitive!). The examples below assume a file has already been opened and the handle stored in the variable <var>h</var>.

=== Files opened in text read mode ===

A file opened in mode "r" (text read mode) exposes the following functions.

{{Function
|name=<var>h</var>.readLine
|api=fs
|returns=[[string]] the next line read from the file, with the end-of-line character stripped; or nil if there are no more lines in the file
|desc=Reads the next line from the file
}}
{{Function
|name=<var>h</var>.readAll
|api=fs
|returns=[[string]] the entire rest of the file, with the end-of-line character on the very last line (if present) stripped
|desc=Reads the rest of the text in the file
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in text write/append mode ===

A file opened in mode "w" (text write mode) or "a" (text append mode) exposes the following functions:

{{Function
|name=<var>h</var>.write
|args=[[string (type)|string]] data
|api=fs
|desc=Writes a string of characters to the file exactly as they appear in the string <var>data</var>
}}
{{Function
|name=<var>h</var>.writeLine
|args=[[string (type)|string]] data
|api=fs
|desc=Writes a string of characters to the file, then appends an end-of-line character
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in binary read mode ===

A file opened in mode "rb" (binary read mode) exposes the following functions:

{{Function
|name=<var>h</var>.read
|api=fs
|returns=[[int (type)|int]] the byte read from the file, or <code>nil</code> if there are no more bytes
|desc=Reads a single byte from the file and returns it
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

=== Files opened in binary write/append mode ===

A file opened in mode "wb" (binary write mode) or "ab" (binary append mode) exposes the following functions:

{{Function
|name=<var>h</var>.write
|args=[[int (type)|int]] byte
|api=fs
|desc=Writes a single byte into the file
}}
{{Function
|name=<var>h</var>.close
|api=fs
|desc=Closes the file handle, after which it can no longer be used
}}

[[Category:Lua_Core_Functions]]

Colors.subtract

2012-11-30T18:36:27Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=colors.subtract
|args=[[int (type)|int]] colors, [[int (type)|int]] color1, [[int (type)|int]] color2, …
|api=color
|returns=[[int (type)|int]] the set <var>colors</var> after removing sets <var>color1</var>, <var>color2</var>, …
|addon=ComputerCraft
|desc=Computes the difference of a set by removing colors from it; 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)
|examples=
{{Example
|desc=Beginning with white, magenta, and light blue, remove magenta to yield 9 (the bitwise combination of white and light blue)
|code=print(colors.subtract(colors.combine(colors.white, colors.magenta, colours.lightBlue), colors.magenta))
|output=9
}}
}}

[[Category:API_Functions]]

Colors.combine

2012-11-30T18:36:08Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=colors.combine
|args=[[int (type)|int]] color1, [[int (type)|int]] color2, …
|api=color
|returns=[[int (type)|int]] the union of sets <var>color1</var>, <var>color2</var>, …
|addon=ComputerCraft
|desc=Computes the union of sets of colors; each parameter may be a single color or may be a set of colors
|examples=
{{Example
|desc=Combine white, magenta, and light blue to yield 13 (the bitwise combination of the colors)
|code=print(colors.combine(colors.white, colors.magenta, colours.lightBlue))
|output=13
}}
}}

[[Category:API_Functions]]

Bit.bnot

2012-11-30T18:35:47Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=bit.bnot
|args=[[int (type)|int]] n
|api=bit
|returns=[[int (type)|int]] the value of NOT <var>n</var>
|addon=ComputerCraft
|desc=Computes the bitwise NOT of a number, taken in the domain and range of 32-bit unsigned integers
|examples=
{{Example
|desc=NOT the number 18 (10010), yielding 4294967277 (11111111111111111111111111101101, 32 bits in length)
|code=print(bit.bnot(18))
|output=4294967277
}}
}}

== Explanation ==
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:

{| class="wikitable"
|-
! Bit index:
| 31
| 30
| 29
| 28
| 27
| 26
| 25
| 24
| 23
| 22
| 21
| 20
| 19
| 18
| 17
| 16
| 15
| 14
| 13
| 12
| 11
| 10
| 9
| 8
| 7
| 6
| 5
| 4
| 3
| 2
| 1
| 0
|-
! Input (18):
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 0
| 1
| 0
| 0
| 1
| 0
|-
! Output (4294967277):
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 1
| 0
| 1
| 1
| 0
| 1
|}

[[Category:API_Functions]]

Bit.brshift

2012-11-30T18:35:24Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=bit.brshift
|args=[[int (type)|int]] n, [[int (type)|int]] bits
|api=bit
|returns=[[int (type)|int]] the value of <var>n</var> shifted right by <var>bits</var> bits, which is equivalent to ⌊<var>n</var>÷2<sup><var>bits</var></sup>⌋
|addon=ComputerCraft
|desc=Shifts a number right by a specified number of bits
|examples=
{{Example
|desc=Shift the number 73 (1001001) right by 2 bits, yielding 18 (10010)
|code=print(bit.brshift(73, 2))
|output=18
}}
}}

[[Category:API_Functions]]

Bit.blshift

2012-11-30T18:35:06Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=bit.blshift
|args=[[int (type)|int]] n, [[int (type)|int]] bits
|api=bit
|returns=[[int (type)|int]] 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>
|addon=ComputerCraft
|desc=Shifts a number left by a specified number of bits
|examples=
{{Example
|desc=Shift the number 18 (10010) left by 2 bits, yielding 72 (1001000)
|code=print(bit.blshift(18, 2))
|output=72
}}
}}

[[Category:API_Functions]]

User:MathManiac0/Templates

2012-11-30T18:34:16Z

Lyqyd: Int linking fix.

''Look in the source code to see how the tables are made.''

''These pieces of data isn't real; they are instead examples how the templates can be made.''


{{Function
|name=foo.Bar
|args= [[int (type)|int]] number
|returns=[[int (type)|int]] number
|api=[[peripherals]]
|addon=ComputerCraft
|desc=Returns the given number
|examples=
{{Example
|desc=Prints the number wrapped by foo.Bar()
|code=print(foo.Bar(2))
|output=2
}}
}}

Disk.getID

2012-11-30T18:33:32Z

Lyqyd: Int linking fix; awkward phrasing re-phrased.

{{lowercase}}
{{Function
|name=disk.getDiskID
|args=[[string (type)|string]] side
|api=disk
|returns=[[int (type)|int]] disk ID
|addon=ComputerCraft
|examples=
{{Example
|desc=Prints the ID of the disk.
|code=print(disk.getDiskID("bottom"))
|output=The ID of the disk (side varies).
}}
}}

[[Category:API_Functions]]

Monitor.setTextScale

2012-11-30T18:32:49Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=monitor.setTextScale
|args=[[int (type)|int]] scale
|api=peripheral
|addon=ComputerCraft
|desc=Sets the size of the text on the monitor.
|examples=
{{Example
|desc=Sets the monitor's text scale to 2.
|code=monitor.setTextScale(2)
|output=none
}}
}}

[[Category:API_Functions]]

Printer.setCursorPos

2012-11-30T18:32:29Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=printer.setCursorPos
|args=[[int (type)|int]] x, [[int (type)|int]] y
|returns=none
|api=peripheral
|addon=ComputerCraft
|desc=Sets the position of the printer cursor, similar to [[term.setCursorPos]], but on a printer.
|examples=
{{Example
|desc=Sets the cursor at the top of the page.
|code=printer.setCursorPos(1,1)
|output=none
}}
}}

[[Category:Lua_Core_Functions]]

Printer.getInkLevel

2012-11-30T18:31:57Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=printer.getInkLevel
|returns=[[int (type)|int]] Amount of ink in printer.
|api=peripheral
|addon=ComputerCraft
|desc=Tells you how much ink is in the printer.
|examples=
{{Example
|desc=Prints true if there's ink in the printer.
|code=print(printer.getInkLevel() > 0)
|output=true if there is ink in the printer, false if there isn't ink.
}}
}}

[[Category:Lua_Core_Functions]]

Term.setCursorPos

2012-11-30T18:31:25Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=term.setCursorPos
|args=[[int (type)|int]] x, [[int (type)|int]] y
|returns=none
|api=term
|addon=ComputerCraft
|desc=Sets the location of the cursor on screen.
|examples=
===Basic usage===
{{Example
|desc=Sets the location of the cursor on screen to the top
|code=term.setCursorPos(1,1)
}}
===Using the old cursor position to affect the new one===
{{Example
|desc=Sets the location of the cursor to the start of the line.
|code=oldx, oldy = term.getCursorPos()<br />term.setCursorPos(1,oldy)
}}
}}

[[Category:API_Functions]]

Rednet.send

2012-11-30T18:30:58Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=rednet.send
|args=[[int (type)|int]] receiverID, [[string]] message, [[boolean_(type)|boolean]] WaitUntilPortOpen
|returns=[[boolean_(type)|boolean]] success code. True if a message has been sent, false if not. "true" does not guarantee, that the destination was reachable!
|api=rednet
|addon=ComputerCraft
|desc=Sends a message to a specific Computer or Turtle. (see [[rednet.broadcast|rednet.broadcast( message )]] and [[rednet.receive|rednet.receive( timeout )]].<br />To get the id from a computer see [[os.computerID|os.computerID()]]. Setting WaitUntilPortOpen to True can help when the server is not receiving a response from the responding client.
|examples=
{{Example
|desc=Sends a Message to the Computer with the ID 22 (assuming a modem is attached and open), and will wait until the port is available to use.
|code=rednet.send(22,"ComputerCraft", true)
}}
}}

[[Category:API_Functions]]

Redstone.setBundledOutput

2012-11-30T18:29:45Z

Lyqyd: Int linking fix.

{{lowercase}}
{{Function
|name=redstone.setBundledOutput
|args=[[string]] side, [[int (type)|int]] colors
|api=redstone
|returns=?
|addon=ComputerCraft
|examples=
===Basic usage===
{{Example
|desc=Toggles between the black and white wires every two seconds
|code=while(true) do<br /> redstone.setBundledOutput("back", colors.black)<br /> sleep(2)<br /> redstone.setBundledOutput("back", colors.white)<br /> sleep(2)<br />end
|output=(nothing on the screen)
}}
===Combining outputs===
The value is passed as an integer, so sending multiple colors is as easy as adding them together:
{{Example
|desc=Toggles between the black/white and red/blue wires every two seconds
|code=while(true) do<br /> redstone.setBundledOutput("back", colors.black+colors.white)<br /> sleep(2)<br /> redstone.setBundledOutput("back", colors.red+colors.blue)<br /> sleep(2)<br />end
|output=(nothing on the screen)
}}
===Clearing the output===
{{Example
|desc=Unsets the output (removes all power)
|code=function unsetAll(sSide)<br /> redstone.setBundledOutput(sSide, 0)<br />end
|output=(nothing on the screen)
}}
}}

[[Category:Lua_Core_Functions]]

Tostring

2012-11-30T18:26:57Z

Lyqyd: Lua -> ComputerCraft, to match tonumber's entry.

{{lowercase}}
{{Function
|name=tostring
|args=Object o
|returns=[[string (type)|string]] representation of the Object <var>o</var>
|api=
|addon=ComputerCraft
|desc=Converts any passed object to it's string-representation.
|examples=
{{Example
|desc=Convert an [[int (type)|integer]] to a [[string (type)|string]]
|code=local a = tostring(1)
|output= a = "1" ([[string (type)|string]])
}}
{{Example
|desc=Convert a [[float (type)|float]] to a [[string (type)|string]]
|code=local b = tostring(3.1415)
|output= b = "3.1415" ([[string (type)|string]])
}}
}}

[[Category:Lua_Core_Functions]]