SetCustomColourName
Script function

world.SetCustomColourName

DOC_scripting Read about scripting

Type

Method

Summary

Sets the name of a custom colour

Prototype

long SetCustomColourName(short WhichColour, BSTR Name);

DOC_data_types 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.

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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_colours Colour management
DOC_defaults Default triggers/aliases/timers/macros/colours

Functions

FNC_AdjustColour AdjustColour (Adjust an RGB colour)
FNC_ANSI ANSI (Generates an ANSI colour sequence)
FNC_BoldColour BoldColour (Gets/sets the RGB colour for one of the 8 ANSI bold colours)
FNC_ColourNameToRGB ColourNameToRGB (Converts a named colour to a RGB colour code.)
FNC_ColourNote ColourNote (Sends a message to the output window in specified colours)
FNC_ColourTell ColourTell (Sends a message to the output window in specified colours - not terminated by a newline)
FNC_CustomColourBackground CustomColourBackground (Sets the RGB value for the background of a custom colour)
FNC_CustomColourText CustomColourText (Sets the RGB value for the text of a custom colour)
FNC_GetCustomColourName GetCustomColourName (Gets the name of a custom colour)
FNC_GetMapColour GetMapColour (Returns the mapping for how a particular colour will be displayed)
FNC_MapColour MapColour (Changes the colour mapping - the way colours are displayed)
FNC_MapColourList MapColourList (Returns an array of all the mapped colours)
FNC_NormalColour NormalColour (Gets/sets the RGB colour for one of the 8 ANSI normal colours)
FNC_NoteColour NoteColour (Chooses which custom colour will be used for world notes.)
FNC_NoteColourBack NoteColourBack (Chooses which RGB colour will be used for world notes - background colour)
FNC_NoteColourFore NoteColourFore (Chooses which RGB colour will be used for world notes - text colour)
FNC_NoteColourName NoteColourName (Chooses which RGB colour name will be used for world notes - text and background)
FNC_NoteColourRGB NoteColourRGB (Chooses which RGB colour will be used for world notes - text and background)
FNC_PickColour PickColour (Invokes the MUSHclient colour picker dialog)
FNC_RGBColourToName RGBColourToName (Converts an RGB colour code to its equivalent name)

(Help topic: function=SetCustomColourName)

DOC_contents Documentation contents page