Difference between revisions of "Colors (API)"

From ComputerCraft Wiki
Jump to: navigation, search
(Updated hex colours to 1.6)
(→‎Colors: Remove binary value column. This column took up tons of space and was not very useful, since people usually use hex values when dealing with binary ops.)
 
(One intermediate revision by one other user not shown)
Line 41: Line 41:
  
 
==Colors==
 
==Colors==
−
The following table includes; the variable name to use in ComputerCraft programs, the decimal, hexadecimal, and binary values of the color, the number used in the 'paint' programs save files, and the actual color used to display in the ComputerCraft mod (provided in web hexadecimal format).
+
The following table includes; the variable name to use in ComputerCraft programs, the decimal, and hexadecimal values of the color, the number used in the 'paint' programs save files, and the actual color used to display in the ComputerCraft mod (provided in web hexadecimal format).
  
 
{| class="wikitable" style="text-align:right;"
 
{| class="wikitable" style="text-align:right;"
Line 47: Line 47:
 
! Decimal
 
! Decimal
 
! Hexadecimal
 
! Hexadecimal
−
! Binary
 
 
! Paint
 
! Paint
 
! Display
 
! Display
Line 54: Line 53:
 
| 1
 
| 1
 
| 0x1
 
| 0x1
−
| 0000000000000001
 
 
| 0
 
| 0
 
| style="background-color:#F0F0F0;" | #F0F0F0
 
| style="background-color:#F0F0F0;" | #F0F0F0
Line 61: Line 59:
 
| 2
 
| 2
 
| 0x2
 
| 0x2
−
| 0000000000000010
 
 
| 1
 
| 1
 
| style="background-color:#F2B233;" | #F2B233
 
| style="background-color:#F2B233;" | #F2B233
Line 68: Line 65:
 
| 4
 
| 4
 
| 0x4
 
| 0x4
−
| 0000000000000100
 
 
| 2
 
| 2
 
| style="background-color:#E57FD8;" | #E57FD8
 
| style="background-color:#E57FD8;" | #E57FD8
Line 75: Line 71:
 
| 8
 
| 8
 
| 0x8
 
| 0x8
−
| 0000000000001000
 
 
| 3
 
| 3
 
| style="background-color:#99B2F2;" | #99B2F2
 
| style="background-color:#99B2F2;" | #99B2F2
Line 82: Line 77:
 
| 16
 
| 16
 
| 0x10
 
| 0x10
−
| 0000000000010000
 
 
| 4
 
| 4
 
| style="background-color:#DEDE6C;" | #DEDE6C
 
| style="background-color:#DEDE6C;" | #DEDE6C
Line 89: Line 83:
 
| 32
 
| 32
 
| 0x20
 
| 0x20
−
| 0000000000100000
 
 
| 5
 
| 5
 
| style="background-color:#7FCC19;" | #7FCC19
 
| style="background-color:#7FCC19;" | #7FCC19
Line 96: Line 89:
 
| 64
 
| 64
 
| 0x40
 
| 0x40
−
| 0000000001000000
 
 
| 6
 
| 6
 
| style="background-color:#F2B2CC;" | #F2B2CC
 
| style="background-color:#F2B2CC;" | #F2B2CC
Line 103: Line 95:
 
| 128
 
| 128
 
| 0x80
 
| 0x80
−
| 0000000010000000
 
 
| 7
 
| 7
 
| style="background-color:#4C4C4C;" | #4C4C4C
 
| style="background-color:#4C4C4C;" | #4C4C4C
Line 110: Line 101:
 
| 256
 
| 256
 
| 0x100
 
| 0x100
−
| 0000000100000000
 
 
| 8
 
| 8
 
| style="background-color:#999999;" | #999999
 
| style="background-color:#999999;" | #999999
Line 117: Line 107:
 
| 512
 
| 512
 
| 0x200
 
| 0x200
−
| 0000001000000000
 
 
| 9
 
| 9
 
| style="background-color:#4C99B2;" | #4C99B2
 
| style="background-color:#4C99B2;" | #4C99B2
Line 124: Line 113:
 
| 1024
 
| 1024
 
| 0x400
 
| 0x400
−
| 0000010000000000
 
 
| a
 
| a
 
| style="background-color:#B266E5;" | #B266E5
 
| style="background-color:#B266E5;" | #B266E5
Line 131: Line 119:
 
| 2048
 
| 2048
 
| 0x800
 
| 0x800
−
| 0000100000000000
 
 
| b
 
| b
 
| style="background-color:#3366CC;" | #3366CC
 
| style="background-color:#3366CC;" | #3366CC
Line 138: Line 125:
 
| 4096
 
| 4096
 
| 0x1000
 
| 0x1000
−
| 0001000000000000
 
 
| c
 
| c
 
| style="background-color:#7F664C;" | #7F664C
 
| style="background-color:#7F664C;" | #7F664C
Line 145: Line 131:
 
| 8192
 
| 8192
 
| 0x2000
 
| 0x2000
−
| 0010000000000000
 
 
| d
 
| d
 
| style="background-color:#57A64E;" | #57A64E
 
| style="background-color:#57A64E;" | #57A64E
Line 152: Line 137:
 
| 16384
 
| 16384
 
| 0x4000
 
| 0x4000
−
| 0100000000000000
 
 
| e
 
| e
 
| style="background-color:#CC4C4C;" | #CC4C4C
 
| style="background-color:#CC4C4C;" | #CC4C4C
Line 159: Line 143:
 
| 32768
 
| 32768
 
| 0x8000
 
| 0x8000
−
| 1000000000000000
 
 
| f
 
| f
−
| style="background-color:#000000; color:#FFFFFF;" | #191919 (text)<br/>#000000 (background)
+
| style="background-color:#191919; color:#FFFFFF;" | #191919
 
|}
 
|}
 
[[Category:APIs]]
 
[[Category:APIs]]

Latest revision as of 16:35, 12 January 2019

The Colors API allows you to manipulate sets of colors. This is useful in conjunction with Bundled Cables from the RedPower mod, RedNet Cables from the MineFactory Reloaded 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)
Function Return values Description
colors.combine(number color1, number color2, ...) number value

Combines one or more colors (or sets of colors) into a larger set.

colors.subtract(number colors, number color1, number color2, ...) number value

Removes one or more colors (or sets of colors) from an initial set.

colors.test(number colors, number color) boolean contained

Tests whether color is contained within colors.


Note: The standard addition (+) and subtraction (-) operators while able to be used on colors instead of colors.combine and colors.subtract should be avoided due to the nature of the colour format. For example
print(colors.white + colors.white)
will output 2 which is orange as opposed to
print(colors.combine(colors.white, colors.white))
will output 1 which is white.

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    = bit.band(bCableLeft, 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)

Colors

The following table includes; the variable name to use in ComputerCraft programs, the decimal, and hexadecimal values of the color, the number used in the 'paint' programs save files, and the actual color used to display in the ComputerCraft mod (provided in web hexadecimal format).

Color Decimal Hexadecimal Paint Display
colors.white 1 0x1 0 #F0F0F0
colors.orange 2 0x2 1 #F2B233
colors.magenta 4 0x4 2 #E57FD8
colors.lightBlue 8 0x8 3 #99B2F2
colors.yellow 16 0x10 4 #DEDE6C
colors.lime 32 0x20 5 #7FCC19
colors.pink 64 0x40 6 #F2B2CC
colors.gray 128 0x80 7 #4C4C4C
colors.lightGray 256 0x100 8 #999999
colors.cyan 512 0x200 9 #4C99B2
colors.purple 1024 0x400 a #B266E5
colors.blue 2048 0x800 b #3366CC
colors.brown 4096 0x1000 c #7F664C
colors.green 8192 0x2000 d #57A64E
colors.red 16384 0x4000 e #CC4C4C
colors.black 32768 0x8000 f #191919
Retrieved from "https://www.computercraft.info/wiki/index.php?title=Colors_(API)&oldid=7497"