world.GetMapColour

MUSHclient script function (Method) — introduced in version 3.54

Returns the mapping for how a particular colour will be displayed

Prototype

long GetMapColour(long Which);

Data type meanings

Description

Returns the RGB code for how a particular colour is going to be displayed.

VBscript example

colour = MapColour (ColourNameToRGB ("red"))

Jscript example

colour = MapColour (ColourNameToRGB ("red"))

Lua example

colour = MapColour (ColourNameToRGB ("red"))

Return value

The RGB code corresponding to the colour in the colour mapping table. If the colour is not present, the supplied argument will be returned.

Related topic

Colour management

See also

FunctionDescription
ColourNameToRGBConverts a named colour to a RGB colour code.
MapColourListReturns an array of all the mapped colours
RGBColourToNameConverts an RGB colour code to its equivalent name