Documentation - orcfoss/roblox-name-colors Wiki

Members

basePalette

The base name color palette.

modernPalette

The modern name color palette (2014+).

oldPalette

The older name color palette (2006-2014).

Functions

mod(a, b)number

A modulus function, in accordance with Lua spec.

hex(color)string

Converts a name color to a hexadecimal value.

compute(text, [rgb], [useModernPalette])string

Computes a name color.

describedBy(describer, [rgb], [useModernPalette])array | string | boolean

Finds a color in the name color palette by a short description (i.e. "modern bright red".)

basePalette

The base name color palette.

Kind: global variable

modernPalette

The modern name color palette (2014+).

Kind: global variable

oldPalette

The older name color palette (2006-2014).

Kind: global variable

mod(a, b) ⇒ number

A modulus function, in accordance with Lua spec.

Kind: global function Returns: number - Modulo of a and b.

Param Type
a number
b number

hex(color) ⇒ string

Converts a name color to a hexadecimal value.

Kind: global function Returns: string - Computed name color hex code.

Param Type Description
color array Computed name color array with "red", "green", and "blue" keys.

compute(text, [rgb], [useModernPalette]) ⇒ string

Computes a name color.

Kind: global function Returns: string - Computed name color.

Param Type Default Description
text string Text to compute a name color of.
[rgb] boolean true Whether to return the color represented as an array with "red", "green", and "blue" keys, or to return it as a hexadecimal color code.
[useModernPalette] boolean true Whether to use the modern color palette.
⚠️ **GitHub.com Fallback** ⚠️