TextColor

Namespace Mc.Scripting.Text · Kind struct (readonly)

public readonly struct TextColor : IEquatable<TextColor>

A named or RGB text colour.

Properties

Member	Description
bool IsSet { get; }	Whether a colour is set.
int Rgb { get; }	The colour as 0xRRGGBB (0 when unset).
static TextColor Aqua { get; }	Aqua (&b).
static TextColor Black { get; }	Black (&0).
static TextColor Blue { get; }	Blue (&9).
static TextColor DarkAqua { get; }	Dark aqua (&3).
static TextColor DarkBlue { get; }	Dark blue (&1).
static TextColor DarkGray { get; }	Dark gray (&8).
static TextColor DarkGreen { get; }	Dark green (&2).
static TextColor DarkPurple { get; }	Dark purple (&5).
static TextColor DarkRed { get; }	Dark red (&4).
static TextColor Gold { get; }	Gold (&6).
static TextColor Gray { get; }	Gray (&7).
static TextColor Green { get; }	Green (&a).
static TextColor LightPurple { get; }	Light purple (&d).
static TextColor None { get; }	No colour (inherit).
static TextColor Red { get; }	Red (&c).
static TextColor White { get; }	White (&f).
static TextColor Yellow { get; }	Yellow (&e).

IsSet

public bool IsSet { get; }

Whether a colour is set.

Rgb

public int Rgb { get; }

The colour as 0xRRGGBB (0 when unset).

Aqua

public static TextColor Aqua { get; }

Aqua (&b).

Black

public static TextColor Black { get; }

Black (&0).

Blue

public static TextColor Blue { get; }

Blue (&9).

DarkAqua

public static TextColor DarkAqua { get; }

Dark aqua (&3).

DarkBlue

public static TextColor DarkBlue { get; }

Dark blue (&1).

DarkGray

public static TextColor DarkGray { get; }

Dark gray (&8).

DarkGreen

public static TextColor DarkGreen { get; }

Dark green (&2).

DarkPurple

public static TextColor DarkPurple { get; }

Dark purple (&5).

DarkRed

public static TextColor DarkRed { get; }

Dark red (&4).

Gold

public static TextColor Gold { get; }

Gold (&6).

Gray

public static TextColor Gray { get; }

Gray (&7).

Green

public static TextColor Green { get; }

Green (&a).

LightPurple

public static TextColor LightPurple { get; }

Light purple (&d).

None

public static TextColor None { get; }

No colour (inherit).

Red

public static TextColor Red { get; }

Red (&c).

White

public static TextColor White { get; }

White (&f).

Yellow

public static TextColor Yellow { get; }

Yellow (&e).

Methods

Member	Description
bool Equals(TextColor other)
override bool Equals(object? obj)
override int GetHashCode()
override string ToString()	The vanilla serialisation: a colour name for the 16 named colours, “#RRGGBB” otherwise.
static TextColor FromRgb(int rgb)	A custom 24-bit colour.
static TextColor Parse(string text)	Parses a vanilla colour name (“red”) or “#RRGGBB”.

Equals

public bool Equals(TextColor other)

Parameters

Name	Type	Description
other	TextColor

Returns bool

Equals

public override bool Equals(object? obj)

Parameters

Name	Type	Description
obj	object?

Returns bool

GetHashCode

public override int GetHashCode()

Returns int

ToString

public override string ToString()

The vanilla serialisation: a colour name for the 16 named colours, “#RRGGBB” otherwise.

Returns string

FromRgb

public static TextColor FromRgb(int rgb)

A custom 24-bit colour.

Parameters

Name	Type	Description
rgb	int	0xRRGGBB.

Returns TextColor

Parse

public static TextColor Parse(string text)

Parses a vanilla colour name (“red”) or “#RRGGBB”.

Parameters

Name	Type	Description
text	string

Returns TextColor: The colour, or TextColor.None when the text is not a colour.

Operators

Member	Description
static bool operator !=(TextColor a, TextColor b)	Inequality.
static bool operator ==(TextColor a, TextColor b)	Equality.

operator !=

public static bool operator !=(TextColor a, TextColor b)

Inequality.

Parameters

Name	Type	Description
a	TextColor
b	TextColor

Returns bool

operator ==

public static bool operator ==(TextColor a, TextColor b)

Equality.

Parameters

Name	Type	Description
a	TextColor
b	TextColor

Returns bool