world.AdjustColour

MUSHclient script function (Method) — introduced in version 3.41

Adjust an RGB colour

Prototype

long AdjustColour(long Colour, short Method);

Data type meanings

Description

This lets you play with colours in a script. You pass to it a colour and an adjustment method. The methods are:

1: invert
2: lighter
3: darker
4: less colour
5: more colour

This lets you do in a script what can be done on the ANSI colour page - fiddle with colour values.

VBscript example

mycolour = world.AdjustColour (ColourNameToRGB ("red"), 1) ' get inverse of red

Jscript example

mycolour = AdjustColour (ColourNameToRGB ("red"), 1); // get inverse of red

PerlScript example

mycolour = AdjustColour (ColourNameToRGB ("red"), 1); # get inverse of red

Python example

mycolour = world.AdjustColour (world.ColourNameToRGB ("red"), 1) # get inverse of red

Lua example

mycolour = AdjustColour (ColourNameToRGB ("red"), 1) -- get inverse of red

Return value

The RGB code of the adjusted colour. If the method is out of range the original colour is returned.

Related topic

Colour management

See also