MapColourList
Script function world.MapColourList Read about scripting Type Method Summary Returns an array of all the mapped colours Prototype `VARIANT MapColourList();` View list of data type meanings Description `Returns a variant array of all the colours that have been mapped for this world. eg. black = red blue = gold` VBscript example
    dim mapList

    mapList= world.MapColourList

    If Not IsEmpty (mapList) Then

      For Each v In mapList
        world.note v
      Next

    End If
Lua example
    -- show all colours and their values (RGB values)

    for k, v in pairs (MapColourList()) do
      Note (k, " = ", v)
    end
Lua notes
    Under Lua this function returns a table of all mapped colours and their values,
    keyed by the RGB colour code.

    Thus you can directly access colours from the table, like this:

    -- show value for colour 255...

    print (MapColourList() [255])

    Note that since this will return only colours in the table, if the colour doesn't exist in the mapping table, you will get nil from this example.
Return value
    If there are no colours mapped then the return value is empty. Use "IsEmpty" to test for this possibility.

    Otherwise, it returns a variant array containing the source and destination colours with an " = " symbol between them.

    However for Lua, it returns a table where the key is the original colour and the value is the replacement colour.

    Use "lbound" and "ubound" to find the bounds of the array of variables (ie. the number of colours in the list).
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) 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=MapColourList) Documentation contents page