world.MapColourList

MUSHclient script function (Method) — introduced in version 3.54

Returns an array of all the mapped colours

Prototype

VARIANT MapColourList();

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

Related topic

Colour management

See also