colors

Constants and functions for colour values, suitable for working with term and redstone.

This is useful in conjunction with Bundled Cables from mods like Project Red, and colors on Advanced Computers and Advanced Monitors.

For the non-American English version just replace colors with colours. This alternative API is exactly the same, except the colours use British English (e.g. colors.gray is spelt colours.grey).

On basic terminals (such as the Computer and Monitor), all the colors are converted to grayscale. This means you can still use all 16 colors on the screen, but they will appear as the nearest tint of gray. You can check if a terminal supports color by using the function term.isColor.

Grayscale colors are calculated by taking the average of the three components, i.e. (red + green + blue) / 3.

See also

• colours

white = 0x1Source

White: Written as 0 in paint files and term.blit, has a default terminal colour of #F0F0F0.

orange = 0x2Source

Orange: Written as 1 in paint files and term.blit, has a default terminal colour of #F2B233.

magenta = 0x4Source

Magenta: Written as 2 in paint files and term.blit, has a default terminal colour of #E57FD8.

lightBlue = 0x8Source

Light blue: Written as 3 in paint files and term.blit, has a default terminal colour of #99B2F2.

yellow = 0x10Source

Yellow: Written as 4 in paint files and term.blit, has a default terminal colour of #DEDE6C.

lime = 0x20Source

Lime: Written as 5 in paint files and term.blit, has a default terminal colour of #7FCC19.

pink = 0x40Source

Pink: Written as 6 in paint files and term.blit, has a default terminal colour of #F2B2CC.

gray = 0x80Source

Gray: Written as 7 in paint files and term.blit, has a default terminal colour of #4C4C4C.

lightGray = 0x100Source

Light gray: Written as 8 in paint files and term.blit, has a default terminal colour of #999999.

cyan = 0x200Source

Cyan: Written as 9 in paint files and term.blit, has a default terminal colour of #4C99B2.

purple = 0x400Source

Purple: Written as a in paint files and term.blit, has a default terminal colour of #B266E5.

blue = 0x800Source

Blue: Written as b in paint files and term.blit, has a default terminal colour of #3366CC.

brown = 0x1000Source

Brown: Written as c in paint files and term.blit, has a default terminal colour of #7F664C.

green = 0x2000Source

Green: Written as d in paint files and term.blit, has a default terminal colour of #57A64E.

red = 0x4000Source

Red: Written as e in paint files and term.blit, has a default terminal colour of #CC4C4C.

black = 0x8000Source

Black: Written as f in paint files and term.blit, has a default terminal colour of #111111.

combine(...)Source

Combines a set of colors (or sets of colors) into a larger set. Useful for Bundled Cables.

Parameters

1. ... number The colors to combine.

Returns

1. number The union of the color sets given in ...

Usage

• colors.combine(colors.white, colors.magenta, colours.lightBlue)
  -- => 13

Changes

• New in version 1.2

subtract(colors, ...)Source

Removes one or more colors (or sets of colors) from an initial set. Useful for Bundled Cables.

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

Parameters

1. colors number The color from which to subtract.
2. ... number The colors to subtract.

Returns

1. number The resulting color.

Usage

• colours.subtract(colours.lime, colours.orange, colours.white)
  -- => 32

Changes

• New in version 1.2

test(colors, color)Source

Tests whether color is contained within colors. Useful for Bundled Cables.

Parameters

1. colors number A color, or color set
2. color number A color or set of colors that colors should contain.

Returns

1. boolean If colors contains all colors within color.

Usage

• colors.test(colors.combine(colors.white, colors.magenta, colours.lightBlue), colors.lightBlue)
  -- => true

Changes

• New in version 1.2

packRGB(r, g, b)Source

Combine a three-colour RGB value into one hexadecimal representation.

Parameters

1. r number The red channel, should be between 0 and 1.
2. g number The green channel, should be between 0 and 1.
3. b number The blue channel, should be between 0 and 1.

Returns

1. number The combined hexadecimal colour.

Usage

• colors.packRGB(0.7, 0.2, 0.6)
  -- => 0xb23399

Changes

• New in version 1.81.0

unpackRGB(rgb)Source

Separate a hexadecimal RGB colour into its three constituent channels.

Parameters

1. rgb number The combined hexadecimal colour.

Returns

1. number The red channel, will be between 0 and 1.
2. number The green channel, will be between 0 and 1.
3. number The blue channel, will be between 0 and 1.

Usage

• colors.unpackRGB(0xb23399)
  -- => 0.7, 0.2, 0.6

See also

• colors.packRGB

Changes

• New in version 1.81.0

rgb8(...)Source

🛈 Deprecated

Use packRGB or unpackRGB directly.

Either calls colors.packRGB or colors.unpackRGB, depending on how many arguments it receives.

Parameters

1. r number The red channel, as an argument to colors.packRGB.
2. g number The green channel, as an argument to colors.packRGB.
3. b number The blue channel, as an argument to colors.packRGB.

Or

1. rgb number The combined hexadecimal color, as an argument to colors.unpackRGB.

Returns

1. number The combined hexadecimal colour, as returned by colors.packRGB.

Or

1. number The red channel, as returned by colors.unpackRGB
2. number The green channel, as returned by colors.unpackRGB
3. number The blue channel, as returned by colors.unpackRGB

Usage

• colors.rgb8(0xb23399)
  -- => 0.7, 0.2, 0.6

• colors.rgb8(0.7, 0.2, 0.6)
  -- => 0xb23399

Changes

• New in version 1.80pr1
• Changed in version 1.81.0: Deprecated in favor of colors.(un)packRGB.

toBlit(color)Source

Converts the given color to a paint/blit hex character (0-9a-f).

This is equivalent to converting floor(log_2(color)) to hexadecimal. Values outside the range of a valid colour will error.

Parameters

1. color number The color to convert.

Returns

1. string The blit hex code of the color.

Usage

• colors.toBlit(colors.red)
  -- => "c"

See also

• colors.fromBlit

Changes

• New in version 1.94.0

fromBlit(hex)Source

Converts the given paint/blit hex character (0-9a-f) to a color.

This is equivalent to converting the hex character to a number and then 2 ^ decimal

Parameters

1. hex string The paint/blit hex character to convert

Returns

1. number The color

Usage

• colors.fromBlit("e")
  -- => 16384

See also

• colors.toBlit

Changes

• New in version 1.105.0