Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SetCustomColourName

Name SetCustomColourName
Type Method
Summary Sets the name of a custom colour
Prototype long SetCustomColourName(short WhichColour, BSTR Name);

View list of data type meanings
Description

Use this to set 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.

The name can be any string, which must be from 1 to 30 characters long.

Note: Available in version 4.03 onwards.
VBscript example 
SetCustomColourName(5, "combat")
Jscript example 
SetCustomColourName(5, "combat");
PerlScript example 
$world->SetCustomColourName (5, "combat");
Python example 
world.SetCustomColourName (5, "combat")
Lua example 
SetCustomColourName (5, "combat")
Returns eOK - colour name set OK
eOptionOutOfRange - custom colour number out of the range 1 to 16
eNoNameSpecified - name was empty
eInvalidObjectLabel - name was more than 30 characters long

View list of return code meanings
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
GetCustomColourName Gets the name of a custom colour
NormalColour Gets/sets the RGB colour for one of the 8 ANSI normal colours

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