Difference between revisions of "Redstone (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(1.6 removes MFR rednet cable compatibility, replacing it with an API any mod developer should be able to tap into.)
Line 1: Line 1:
 
The Redstone API contains methods to control attached redstone. All methods from the redstone API can also be called using "rs", which points to the same library. For example, instead of redstone.getSides(), rs.getSides() can be used.
 
The Redstone API contains methods to control attached redstone. All methods from the redstone API can also be called using "rs", which points to the same library. For example, instead of redstone.getSides(), rs.getSides() can be used.
  
In addition to regular redstone / RedPower cables for regular signals, RedPower bundled or Minefactory Reloaded RedNet cables may be used to send "bundled" signals out the one face. Refer to the [[Colors]] API for more information on interacting with these.
+
In addition to regular redstone / RedPower cables for regular signals, RedPower bundled (for MineCraft 1.4.x) or Minefactory Reloaded RedNet cables (for MineCraft 1.5.x up) may be used to send "bundled" signals out the one face. Refer to the [[Colors]] API for more information on interacting with these.
 +
 
 +
As of ComputerCraft 1.6, the previous support for bundled cables has been replaced with an API allowing other mod developers to provide the support themselves. '''At this time, bundled cables cannot be used with this build - please update this page if and when any mods add compatibility!'''
  
 
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">
 
<table style="width: 100%; border: solid 1px black; margin: 2px; border-spacing: 0px;">

Revision as of 04:08, 29 March 2014

The Redstone API contains methods to control attached redstone. All methods from the redstone API can also be called using "rs", which points to the same library. For example, instead of redstone.getSides(), rs.getSides() can be used.

In addition to regular redstone / RedPower cables for regular signals, RedPower bundled (for MineCraft 1.4.x) or Minefactory Reloaded RedNet cables (for MineCraft 1.5.x up) may be used to send "bundled" signals out the one face. Refer to the Colors API for more information on interacting with these.

As of ComputerCraft 1.6, the previous support for bundled cables has been replaced with an API allowing other mod developers to provide the support themselves. At this time, bundled cables cannot be used with this build - please update this page if and when any mods add compatibility!

Grid disk.png   Redstone (API)

Method NameDescription
redstone.getSides() Returns a table of possible sides.
redstone.getInput(string side) Returns the current redstone input signal state on side.
redstone.setOutput(string side, boolean value) Sets or resets a redstone signal on side.
redstone.getOutput(string side) Returns the current redstone output signal on side.
redstone.getAnalogInput(string side) (Requires CC1.51 and above) Returns the current redstone input signal strength on side. If no input is present, returns 0. If a redstone source (such as a redstone torch or block) is directly adjacent to the computer, returns 15.
redstone.setAnalogOutput(string side, number strength) (Requires CC1.51 and above) Sets or resets a redstone signal on side to strength (where strength is a positive integer).
redstone.getAnalogOutput(string side) (Requires CC1.51 and above) Returns the current redstone output signal strength on side.
redstone.getBundledInput(string side) Returns the state (as a number) of a RedPower bundled / Minefactory Reloaded RedNet cable connected to side.
redstone.getBundledOutput(string side) Returns the set of RedPower wires in the RedPower bundled / Minefactory Reloaded RedNet cable which are being activated by the terminal on side.
redstone.setBundledOutput(string side, number colors) Sets one or multiple colored signals in a RedPower bundled / Minefactory Reloaded RedNet cable attached to side. colors will determine which signals are activated. In order to set multiple signals, add the color values of the colors you want to activate. To turn off all of the colors, use 0.
redstone.testBundledInput(string side, number color) Returns true if color is active in a RedPower bundled / Minefactory Reloaded RedNet cable attached to side. Else, returns false.
Bundled cable code snippet. (You might want to take a look at this if you are doing bundledcable related things.)