MapColourList
Script function

world.MapColourList

DOC_scripting Read about scripting

Type

Method

Summary

Returns an array of all the mapped colours

Prototype

VARIANT MapColourList();

DOC_data_types 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

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_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)
FNC_SetCustomColourName SetCustomColourName (Sets the name of a custom colour)

(Help topic: function=MapColourList)

DOC_contents Documentation contents page