Colors (API)

From ComputerCraft Wiki
Revision as of 00:37, 12 July 2013 by AfterLifeLochie (Talk | contribs) ({{Type|Int}} -> {{Type|Number}} (I may make Template:Type allow only certain datatypes.))

Jump to: navigation, search

The Colors API allows you to utilize Bundled Cables from the RedPower mod, and colors on Advanced Computers and Advanced Monitors.

For the non-American English version just replace 'colors' with 'colours' and it will use the other API, colours—which is exactly the same, except in non-American English (e.g. gray is spelt grey and lightGray is spelt lightGrey).

Grid disk.png   colors (API)

ReturnMethod NameDescription
number value colors.combine(number color1, number color2, …) Combines a set of colors (or sets of colors) into a larger set.
number value colors.subtract(number colors, number color1, number color2, …) Removes one or more colors (or sets of colors) from an initial set.
boolean value colors.test(number colors, number color) Tests whether color is contained within colors.

Note: Since the colors are just integers, the standard addition (+) and subtraction (-) operators may be used on colors instead of colors.combine and colors.subtract.

Furthermore, the Bit (API) may be used on sets of colors. For example,

bCableLeft  = rs.getBundledInput("left")
bCableRight = rs.getBundledInput("right")

-- Get a number representing colors on in both right and left bundled cables
commonColors    =, bCableRight)

-- Get all the colors active on either right or left
totalColors     = bit.bor(bCableLeft, bCableRight)

-- Get the colors which are active on right, or left, but not both at the same time
exclusiveColors = bit.bxor(bCableLeft, bCableRight)

-- Get the colors that are not active on the left
offColorsA      = bit.bnot(bCableLeft)


Color constants include, in ascending bit order:

Color Decimal Hexadecimal Binary
colors.white 1 0x1 0000000000000001 2 0x2 0000000000000010
colors.magenta 4 0x4 0000000000000100
colors.lightBlue 8 0x8 0000000000001000
colors.yellow 16 0x10 0000000000010000
colors.lime 32 0x20 0000000000100000 64 0x40 0000000001000000
colors.gray 128 0x80 0000000010000000
colors.lightGray 256 0x100 0000000100000000
colors.cyan 512 0x200 0000001000000000
colors.purple 1024 0x400 0000010000000000 2048 0x800 0000100000000000
colors.brown 4096 0x1000 0001000000000000 8192 0x2000 0010000000000000 16384 0x4000 0100000000000000 32768 0x8000 1000000000000000