world.GetCustomColourName

MUSHclient script function (Method) — introduced in version 4.03

Gets the name of a custom colour

Prototype

BSTR GetCustomColourName(short WhichColour);

Data type meanings

Description

Use this to get the name of one of the 16 custom colours in the world's custom colour configuration. You must specify *which* colour you want to get/set, in the range 1 to 16.

VBscript example

Note GetCustomColourName (5)

Jscript example

Note (GetCustomColourName (5));

PerlScript example

$world->Note($world->GetCustomColourName (5));

Python example

world.Note(world.GetCustomColourName (5))

Lua example

Note(GetCustomColourName (5))

Return value

It returns the name of the specified custom colour, or an empty string if the colour number is out of the range 1 to 16.

Related topic

Colour management

See also