GetCustomColourName
Script function world.GetCustomColourName Read about scripting Type Method Summary Gets the name of a custom colour Prototype `BSTR GetCustomColourName(short WhichColour);` View list of data type meanings Description `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.` 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))
Return value
    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.
See Also ... Topics Colour management Default triggers/aliases/timers/macros/colours Functions AdjustColour (Adjust an RGB colour) ANSI (Generates an ANSI colour sequence) BoldColour (Gets/sets the RGB colour for one of the 8 ANSI bold colours) ColourNameToRGB (Converts a named colour to a RGB colour code.) ColourNote (Sends a message to the output window in specified colours) ColourTell (Sends a message to the output window in specified colours - not terminated by a newline) CustomColourBackground (Sets the RGB value for the background of a custom colour) CustomColourText (Sets the RGB value for the text of a custom colour) GetMapColour (Returns the mapping for how a particular colour will be displayed) MapColour (Changes the colour mapping - the way colours are displayed) MapColourList (Returns an array of all the mapped colours) NormalColour (Gets/sets the RGB colour for one of the 8 ANSI normal colours) NoteColour (Chooses which custom colour will be used for world notes.) NoteColourBack (Chooses which RGB colour will be used for world notes - background colour) NoteColourFore (Chooses which RGB colour will be used for world notes - text colour) NoteColourName (Chooses which RGB colour name will be used for world notes - text and background) NoteColourRGB (Chooses which RGB colour will be used for world notes - text and background) PickColour (Invokes the MUSHclient colour picker dialog) RGBColourToName (Converts an RGB colour code to its equivalent name) SetCustomColourName (Sets the name of a custom colour) (Help topic: function=GetCustomColourName) Documentation contents page