Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.RGBColourToName

Name RGBColourToName
Type Method
Summary Converts an RGB colour code to its equivalent name
Prototype BSTR RGBColourToName(long Colour);

View list of data type meanings
Description

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"

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

Note: Available in version 3.22 onwards.
VBscript example 
world.note world.RGBColourToName (255)
Jscript example 
world.note (world.RGBColourToName (255));
PerlScript example 
$world->note ($world->RGBColourToName (255));
Python example 
world.note (world.RGBColourToName (255))
Lua example 
Note (RGBColourToName (255))
Returns The colour name (eg. "red", "blue"), or an RGB code (eg. "#FFE4E1).
Introduced in version 3.22

See also ...

Function Description
BoldColour Gets/sets the RGB colour for one of the 8 ANSI bold colours
ColourNameToRGB Converts a named colour to a RGB colour code.
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

Search for script function

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.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

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

View all functions

[Back]

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

Home