world.ColourNameToRGB

MUSHclient script function (Method) — introduced in version 3.22

Converts a named colour to a RGB colour code.

Prototype

long ColourNameToRGB(BSTR Name);

Data type meanings

Description

Converts a named colour (eg. "brown") to an RGB colour code (eg. 2763429).

The colours can either be named (eg. "red", "blue", "green", "brown") or supplied as HTML colour codes (eg. "#010203"). For HTML colours, the leading "#" is required.

The list of colour names recognised can be found by using MUSHclient's "colour picker" (Ctrl+Alt+P), or by using the function:

world.Debug "colours"

Converts an RGB colour code (eg. 255) to its HTML name (eg. "red").

If the name is not in the list of names recognised by MUSHclient, the colour is represented as a hex HTML colour (eg. "#010203").

The list of colour names recognised can be found by using MUSHclient's "colour picker" (Ctrl+Alt+P), or by using the function:

world.Debug "colours"

Note that the RGB colour code is internally in the form BBGGRR. In other words:

print (string.format ("%06X", ColourNameToRGB ("red"))) --> 0000FF

The value for red is in the low-order byte, green is in the middle byte, and blue is in the high-order byte. This is the opposite to the order used in HTML colour codes, where the order is: #RRGGBB

VBscript example

world.note world.colourNameToRGB ("brown")

Jscript example

world.note (world.colourNameToRGB ("brown"));

PerlScript example

$world->note ($world->colourNameToRGB ("brown"));

Python example

world.note (world.colourNameToRGB ("brown"))

Lua example

Note (ColourNameToRGB ("brown"))

Return value

The RGB code of the converted colour, or -1 if the colour name is not recognised. Note that -1 cannot be an RGB colour (-1 is the hex sequence 0xFFFFFFFF, whereas the "highest" colour (white) is hex 0x00FFFFFF).

Related topic

Colour management

See also