Redstone (API) - Revision history

Magiczocker at 07:04, 4 August 2020

2020-08-04T07:04:59Z

Smiley43210: Changed "MineCraft" to "Minecraft"

2015-08-14T12:11:34Z

Changed "MineCraft" to "Minecraft"

Bomb Bloke: /* Bundled Cables */

2015-07-23T13:35:14Z

‎Bundled Cables

Bomb Bloke at 13:32, 23 July 2015

2015-07-23T13:32:39Z

Bomb Bloke: Details on bundled cable compatibility.

2015-07-23T13:31:03Z

Details on bundled cable compatibility.

Turkey: /* Data exchange */

2014-11-22T18:37:44Z

‎Data exchange

Turkey: Adding a note about usage in data exchange

2014-11-20T03:20:55Z

Adding a note about usage in data exchange

Bomb Bloke: 1.6 removes MFR rednet cable compatibility, replacing it with an API any mod developer should be able to tap into.

2014-03-29T04:08:03Z

1.6 removes MFR rednet cable compatibility, replacing it with an API any mod developer should be able to tap into.

Alekso56 at 14:11, 16 January 2014

2014-01-16T14:11:02Z

Bomb Bloke at 19:00, 15 December 2013

2013-12-15T19:00:23Z

@@ Line 51: / Line 51: @@
 == Data exchange ==
-The redstone API can be used to exchange data between adjacent [[computer]]s and [[turtle]]s. Four bits of data can be transmitted and received with each use of redstone signals to send analog output and receive the input. One redstone signal can be sent at each tick [http://minecraft.gamepedia.com/Tick tick], and there are 20 ticks per second in Minecraft. This limits data transmission over redstone to a maximum of 80 bits per second (bps).
+The redstone API can be used to exchange data between adjacent [[computer]]s and [[turtle]]s. Four bits of data can be transmitted and received with each use of redstone signals to send analog output and receive the input. One redstone signal can be sent at each tick [https://minecraft.gamepedia.com/Tick tick], and there are 20 ticks per second in Minecraft. This limits data transmission over redstone to a maximum of 80 bits per second (bps).
 This makes large-scale data transmission over the redstone API exceedingly slow. For example, using the redstone API, transmitting a colored bitmap image for a maximum [[resolution]] computercraft monitor cluster (162x80 pixels) would require 10 minutes and 48 seconds (this would be a 6.48 kB image). For reference, there are 16 colors available for monitors and terminals in computercraft, so a single color for a pixel can be represented in a 4-bit signal.

@@ Line 51: / Line 51: @@
 == Data exchange ==
-The redstone API can be used to exchange data between adjacent [[computer]]s and [[turtle]]s. Four bits of data can be transmitted and received with each use of redstone signals to send analog output and receive the input. One redstone signal can be sent at each tick [http://minecraft.gamepedia.com/Tick tick], and there are 20 ticks per second in minecraft. This limits data transmission over redstone to a maximum of 80 bits per second (bps).
+The redstone API can be used to exchange data between adjacent [[computer]]s and [[turtle]]s. Four bits of data can be transmitted and received with each use of redstone signals to send analog output and receive the input. One redstone signal can be sent at each tick [http://minecraft.gamepedia.com/Tick tick], and there are 20 ticks per second in Minecraft. This limits data transmission over redstone to a maximum of 80 bits per second (bps).
 This makes large-scale data transmission over the redstone API exceedingly slow. For example, using the redstone API, transmitting a colored bitmap image for a maximum [[resolution]] computercraft monitor cluster (162x80 pixels) would require 10 minutes and 48 seconds (this would be a 6.48 kB image). For reference, there are 16 colors available for monitors and terminals in computercraft, so a single color for a pixel can be represented in a 4-bit signal.
@@ Line 59: / Line 59: @@
 ==Bundled Cables==
-A "bundled cable" contains multiple wires, one for each of the basic 16 dye colors present in MineCraft. Each acts as a redstone dust line, allowing multiple redstone signals to pass through a space without interfering with each other. They are extremely handy for building complex control mechanisms, and can be dealt with using the [[redstone.getBundledInput|rs.getBundledInput]], [[redstone.getBundledOutput|rs.getBundledOutput]], [[redstone.setBundledOutput|rs.setBundledOutput]] and [[redstone.testBundledInput|rs.testBundledInput]] functions.
+A "bundled cable" contains multiple wires, one for each of the basic 16 dye colors present in Minecraft. Each acts as a redstone dust line, allowing multiple redstone signals to pass through a space without interfering with each other. They are extremely handy for building complex control mechanisms, and can be dealt with using the [[redstone.getBundledInput|rs.getBundledInput]], [[redstone.getBundledOutput|rs.getBundledOutput]], [[redstone.setBundledOutput|rs.setBundledOutput]] and [[redstone.testBundledInput|rs.testBundledInput]] functions.
 ComputerCraft itself does not offer any form of bundled cable - rather, such 16-wire leads are provided by other mods, and they aren't always specifically called "bundled cables", either. Compatibility has changed over time.
-ComputerCraft 1.1 (for MineCraft 1.0) through to 1.5 (for MC 1.4.7) users have access to [http://ftbwiki.org/Bundled_Cable bundled cables], provided by [http://www.eloraam.com RedPower/RedPower 2].
+ComputerCraft 1.1 (for Minecraft 1.0) through to 1.5 (for MC 1.4.7) users have access to [http://ftbwiki.org/Bundled_Cable bundled cables], provided by [http://www.eloraam.com RedPower/RedPower 2].
 .51 (for MC 1.5) through to 1.58 (for MC 1.6.4) users can switch to [http://ftbwiki.org/RedNet_Cable RedNet cables] (nothing to do with [[Rednet_(API)|ComputerCraft's Rednet]]!) from [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1292152-powercrystals-mods-minefactoryreloaded#mfr MineFactory Reloaded].
-.6 introduced an API allowing other mod authors to code support into their mods, while at the same time dropping in-built support for RedNet cables. No known leads are compatible with ComputerCraft 1.6 to 1.63 (for MC 1.6.4) - stick to 1.58 and its RedNet cable compatibility if you wish to use them under that build of MineCraft.
+.6 introduced an API allowing other mod authors to code support into their mods, while at the same time dropping in-built support for RedNet cables. No known leads are compatible with ComputerCraft 1.6 to 1.63 (for MC 1.6.4) - stick to 1.58 and its RedNet cable compatibility if you wish to use them under that build of Minecraft.
 Under 1.64 through to the present 1.74 (all for MC 1.7.10), a number of cables are now available - [http://projectredwiki.com/wiki/Bundled_Cable bundled cables] from [http://projectredwiki.com/wiki/Main_Page Project Red], [http://wiki.enderio.com/Insulated_Redstone_Conduit Insulated Redstone Conduits] from [http://wiki.enderio.com/Main_Page Ender IO], and it's believed current versions of MineFactory Reloaded also work again via their RedNet cables. Others may be available too, so experiment with what you've got, and remember to try updating your mods if you're having trouble!

@@ Line 69: / Line 69: @@
 .6 introduced an API allowing other mod authors to code support into their mods, while at the same time dropping in-built support for RedNet cables. No known leads are compatible with ComputerCraft 1.6 to 1.63 (for MC 1.6.4) - stick to 1.58 and its RedNet cable compatibility if you wish to use them under that build of MineCraft.
-Under 1.64 through to the present 1.74 (all for MC 1.7.10), a number of cables are now available - [http://projectredwiki.com/wiki/Bundled_Cable bundled cables] from [http://projectredwiki.com/wiki/Main_Page Project Red], [http://wiki.enderio.com/Insulated_Redstone_Conduit Insulated Redstone Conduits] from [http://wiki.enderio.com/Main_Page Ender IO], and it's believed current versions of MineFactory Reloaded also work again via their RedNet cables. Others may be available to, so experiment with what you've got, and remember to try updating your mods if you're having trouble!
+Under 1.64 through to the present 1.74 (all for MC 1.7.10), a number of cables are now available - [http://projectredwiki.com/wiki/Bundled_Cable bundled cables] from [http://projectredwiki.com/wiki/Main_Page Project Red], [http://wiki.enderio.com/Insulated_Redstone_Conduit Insulated Redstone Conduits] from [http://wiki.enderio.com/Main_Page Ender IO], and it's believed current versions of MineFactory Reloaded also work again via their RedNet cables. Others may be available too, so experiment with what you've got, and remember to try updating your mods if you're having trouble!
 Mod authors wishing to make their cables compatible can inspect api/doc/index.html, within the ComputerCraft mod archive, for details.
 [[Category:APIs]]

@@ Line 67: / Line 67: @@
 .51 (for MC 1.5) through to 1.58 (for MC 1.6.4) users can switch to [http://ftbwiki.org/RedNet_Cable RedNet cables] (nothing to do with [[Rednet_(API)|ComputerCraft's Rednet]]!) from [http://www.minecraftforum.net/forums/mapping-and-modding/minecraft-mods/1292152-powercrystals-mods-minefactoryreloaded#mfr MineFactory Reloaded].
-.6 introduced an API allowing other mod authors to code support into their mods, while at the same time dropping support for RedNet cables. No known leads are compatible with ComputerCraft 1.6 to 1.63 (for MC 1.6.4) - stick to 1.58 and its RedNet cable compatibility if you wish to use them under that build of MineCraft.
+.6 introduced an API allowing other mod authors to code support into their mods, while at the same time dropping in-built support for RedNet cables. No known leads are compatible with ComputerCraft 1.6 to 1.63 (for MC 1.6.4) - stick to 1.58 and its RedNet cable compatibility if you wish to use them under that build of MineCraft.
 Under 1.64 through to the present 1.74 (all for MC 1.7.10), a number of cables are now available - [http://projectredwiki.com/wiki/Bundled_Cable bundled cables] from [http://projectredwiki.com/wiki/Main_Page Project Red], [http://wiki.enderio.com/Insulated_Redstone_Conduit Insulated Redstone Conduits] from [http://wiki.enderio.com/Main_Page Ender IO], and it's believed current versions of MineFactory Reloaded also work again via their RedNet cables. Others may be available to, so experiment with what you've got, and remember to try updating your mods if you're having trouble!

@@ 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.
-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.
+In addition to regular redstone / RedPower cables for regular signals, [[Redstone_(API)#Bundled_Cables|bundled cables]] may be used to send/receive "combined" signals through the one face. The [[Colors (API)|Colors API]] offers functions that're helpful information in dealing 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;">
@@ Line 35: / Line 33: @@
 <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getBundledInput]]({{type|string}} side)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the state (as a number) of a RedPower bundled / Minefactory Reloaded RedNet cable connected to ''side''.</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the state (as a number) of a [[Redstone_(API)#Bundled_Cables|bundled cable]] connected to ''side''.</td></tr>
 <tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.getBundledOutput]]({{type|string}} side)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the set of RedPower wires in the RedPower bundled / Minefactory Reloaded RedNet cable which are being activated by the terminal on ''side''.</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns the set of wires in a [[Redstone_(API)#Bundled_Cables|bundled cable]] which are being activated by the terminal on ''side''.</td></tr>
 <tr style="background-color: #FFFFFF;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.setBundledOutput]]({{type|string}} side, {{type|number}} colors)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">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.</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Sets one or multiple colored signals in a [[Redstone_(API)#Bundled_Cables|bundled cable]] attached to ''side''. ''colors'' will determine which signals are activated. In order to set multiple signals, [[colors.combine|add the color values of the colors]] you want to activate. To turn off all of the colors, use 0.</td></tr>
 <tr style="background-color: #E8E8E8;"><td style="border-top: solid #C9C9C9 1px; padding: .4em;">[[redstone.testBundledInput]]({{type|string}} side, {{type|number}} color)</td>
-<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns true if ''color'' is active in a RedPower bundled / Minefactory Reloaded RedNet cable attached to ''side''. Else, returns false.</td></tr>
+<td style="border-top: solid #C9C9C9 1px; padding: .4em;">Returns true if ''color'' is active in a [[Redstone_(API)#Bundled_Cables|bundled cable]] attached to ''side''. Else, returns false.</td></tr>
 </table>
@@ Line 58: / Line 56: @@
 Despite the slowness, the redstone API can be useful when other options are not available. For example, it can be used to allow [[turtle]]s to communicate with each other and coordinate their work even if they do not have [[Wireless Modem]]s. Exchanging instructions can be done with much less total data than exchanges of image files and the like.
 [[Category:APIs]]

← Older revision		Revision as of 03:20, 20 November 2014
Line 52:		Line 52:
	\|}		\|}

		+	== Data exchange ==
		+	The redstone API can be used to exchange data between adjacent [[computer]]s and [[turtle]]s. Four bits of data can be transmitted and received with each use of analog input and output. One redstone signal can be sent at each tick [http://minecraft.gamepedia.com/Tick tick], and there are 20 ticks per second in minecraft. This limits data transmission over redstone to a maximum of 80 bits per second (bps).
		+
		+	This makes large-scale data transmission over the redstone API exceedingly slow. For example, using the redstone API, transmitting a colored bitmap image for a maximum [[resolution]] computercraft monitor cluster (162x80 pixels) would require 10 minutes and 48 seconds (this would be a 6.48 kB image). For reference, there are 16 colors available for monitors and terminals in computercraft, so a single color for a pixel can be represented in a 4-bit signal.
		+
		+	Nonetheless, the redstone API can be useful when other options are not available. For example, it can be used to allow [[turtle]]s to communicate with each other and coordinate their work even if they do not have [[Wireless Modem]]s.
	[[Category:APIs]]		[[Category:APIs]]

← Older revision		Revision as of 14:11, 16 January 2014
Line 45:		Line 45:

	</table>		</table>
		+
		+	:{\|class="wikitable"
		+	\| ''[[Usage_of_the_bundled_cable_using_the_Redstone_API\|Bundled cable code snippet. (You might want to take a look at this if you are doing bundledcable related things.)]]''
		+	\|}

	[[Category:APIs]]		[[Category:APIs]]