MUSHclient scripting
Description of MUSHclient world function: world.GetMapColour
| Name | GetMapColour |
|---|---|
| Type | Method |
| Summary | Returns the mapping for how a particular colour will be displayed |
| Prototype | long GetMapColour(long Which);
|
| Description | Returns the RGB code for how a particular colour is going to be displayed. Note: Available in version 3.54 onwards. |
| VBscript example | |
| Jscript example | |
| Lua example | |
| Returns | The RGB code corresponding to the colour in the colour mapping table. If the colour is not present, the supplied argument will be returned. |
| Introduced in version | 3.54 |
See also ...
| Function | Description |
|---|---|
| ColourNameToRGB | Converts a named colour to a RGB colour code. |
| MapColourList | Returns an array of all the mapped colours |
| RGBColourToName | Converts an RGB colour code to its equivalent name |
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.
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
![[Back]](/images/back.gif){kind=small}
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.