Description of MUSHclient world function: world.ColourNameToRGB
Name | ColourNameToRGB |
---|---|
Type | Method |
Summary | Converts a named colour to a RGB colour code. |
Prototype | long ColourNameToRGB(BSTR Name);
|
Description | Converts a named colour (eg. "brown") to an RGB colour code (eg. 2763429). Note: Available in version 3.22 onwards. |
VBscript example |
|
Jscript example |
|
PerlScript example |
|
Python example |
|
Lua example |
|
Returns | 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). |
Introduced in version | 3.22 |
See also ...
Function | Description |
---|---|
BoldColour | Gets/sets the RGB colour for one of the 8 ANSI bold colours |
CustomColourBackground | Sets the RGB value for the background of a custom colour |
CustomColourText | Sets the RGB value for the text of a custom colour |
Debug | Displays debugging information about the world |
MapColour | Changes the colour mapping - the way colours are displayed |
NormalColour | Gets/sets the RGB colour for one of the 8 ANSI normal colours |
NoteColourBack | Chooses which RGB colour will be used for world notes - background colour |
NoteColourFore | Chooses which RGB colour will be used for world notes - text colour |
NoteColourName | Chooses which RGB colour name will be used for world notes - text and background |
NoteColourRGB | Chooses which RGB colour will be used for world notes - text and background |
PickColour | Invokes the MUSHclient colour picker dialog |
RGBColourToName | Converts an RGB colour code to its equivalent name |
Enter a word or phrase in the box below to narrow the list down to those that match.
The function name, prototype, summary, and description are searched.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise of the function.
You can view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
You can view a list of the data types used in function prototypes
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.