Color

Defined in: client/api.d.ts:2815

Mutable RGBA color, with components stored from 0 to 1.

Constructors

Constructor

new Color(r, g, b, a?): Color

Defined in: client/api.d.ts:2823

Creates a color from normalized RGBA components.

Parameters

r

number

Initial red component from 0 to 1.

g

number

Initial green component from 0 to 1.

b

number

Initial blue component from 0 to 1.

a?

number

Optional alpha component from 0 to 1; defaults to 1.

Returns

Color

Methods

clone()

clone(): Color

Defined in: client/api.d.ts:2867

Creates an independent copy of this color.

Returns

Color

New color with the same components.

---

lerp()

lerp(target, t): this

Defined in: client/api.d.ts:2851

Linearly interpolates every component toward a target in place.

Parameters

target

Color

Destination color.

t

number

Interpolation factor; 0 keeps this color and 1 reaches target.

Returns

this

This mutated color for chaining.

---

set()

set(r, g, b, a?): this

Defined in: client/api.d.ts:2861

Replaces this color’s normalized components in place.

Parameters

r

number

Replacement red component from 0 to 1.

g

number

Replacement green component from 0 to 1.

b

number

Replacement blue component from 0 to 1.

a?

number

Optional replacement alpha; defaults to 1 when omitted.

Returns

this

This mutated color for chaining.

---

toHex()

toHex(includeAlpha?): string

Defined in: client/api.d.ts:2874

Converts normalized components to a hexadecimal CSS-style string.

Parameters

includeAlpha?

boolean

Whether to append the alpha byte; defaults to false.

Returns

string

Lowercase #rrggbb or #rrggbbaa string.

---

toJSON()

toJSON(): object

Defined in: client/api.d.ts:2886

Converts this color to a plain object for JSON.stringify.

Returns

object

Object containing the current normalized components.

a

a: number

b

b: number

g

g: number

r

r: number

---

toString()

toString(): string

Defined in: client/api.d.ts:2880

Formats this color for logging and debugging.

Returns

string

Text in Color(r, g, b, a) form.

---

black()

static black(): Color

Defined in: client/api.d.ts:2915

Creates opaque black.

Returns

Color

New Color(0, 0, 0, 1).

---

blue()

static blue(): Color

Defined in: client/api.d.ts:2933

Creates opaque blue.

Returns

Color

New Color(0, 0, 1, 1).

---

cyan()

static cyan(): Color

Defined in: client/api.d.ts:2945

Creates opaque cyan.

Returns

Color

New Color(0, 1, 1, 1).

---

fromHex()

static fromHex(hex): Color

Defined in: client/api.d.ts:2893

Parses a hexadecimal color string.

Parameters

hex

string

Hexadecimal color in #RRGGBB or #RRGGBBAA form; the leading # is optional. Three- and four-digit shorthands are not supported.

Returns

Color

Parsed color, or opaque white when the input is invalid.

---

fromRGB()

static fromRGB(r, g, b, a?): Color

Defined in: client/api.d.ts:2903

Creates a normalized color from byte components.

Parameters

r

number

Red byte from 0 to 255.

g

number

Green byte from 0 to 255.

b

number

Blue byte from 0 to 255.

a?

number

Optional alpha byte from 0 to 255; defaults to 255.

Returns

Color

New normalized color.

---

green()

static green(): Color

Defined in: client/api.d.ts:2927

Creates opaque green.

Returns

Color

New Color(0, 1, 0, 1).

---

magenta()

static magenta(): Color

Defined in: client/api.d.ts:2951

Creates opaque magenta.

Returns

Color

New Color(1, 0, 1, 1).

---

red()

static red(): Color

Defined in: client/api.d.ts:2921

Creates opaque red.

Returns

Color

New Color(1, 0, 0, 1).

---

transparent()

static transparent(): Color

Defined in: client/api.d.ts:2957

Creates fully transparent black.

Returns

Color

New Color(0, 0, 0, 0).

---

white()

static white(): Color

Defined in: client/api.d.ts:2909

Creates opaque white.

Returns

Color

New Color(1, 1, 1, 1).

---

yellow()

static yellow(): Color

Defined in: client/api.d.ts:2939

Creates opaque yellow.

Returns

Color

New Color(1, 1, 0, 1).

Properties

a

a: number

Defined in: client/api.d.ts:2843

Mutable normalized alpha component.

---

b

b: number

Defined in: client/api.d.ts:2838

Mutable normalized blue component.

---

g

g: number

Defined in: client/api.d.ts:2833

Mutable normalized green component.

---

r

r: number

Defined in: client/api.d.ts:2828

Mutable normalized red component.