SetCustomColourName
Script function world.SetCustomColourName Read about scripting 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.` 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
View list of return code meanings 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) GetCustomColourName (Gets the name 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) (Help topic: function=SetCustomColourName) Documentation contents page