[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.GetCustomColourName

Name GetCustomColourName
Type Method
Summary Gets the name of a custom colour
Prototype BSTR GetCustomColourName(short WhichColour);

View list of data type meanings


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.

Note: Available in version 4.03 onwards.

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))
Returns 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.
Introduced in version 4.03

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
NormalColour Gets/sets the RGB colour for one of the 8 ANSI normal colours
SetCustomColourName Sets the name of a custom colour

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


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]