world.SetCustomColourName

MUSHclient script function (Method) — introduced in version 4.03

Sets the name of a custom colour

Prototype

long SetCustomColourName(short WhichColour, BSTR Name);

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.

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")

Return value

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

Return code meanings

Related topic

Colour management

See also