AdjustColour
Script function

world.AdjustColour

DOC_scripting Read about scripting

Type

Method

Summary

Adjust an RGB colour

Prototype

long AdjustColour(long Colour, short Method);

DOC_data_types View list of 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.



See Also ...

Topics

DOC_colours Colour management
DOC_defaults Default triggers/aliases/timers/macros/colours

Functions

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_MapColourList MapColourList (Returns an array of all the mapped colours)
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=AdjustColour)

DOC_contents Documentation contents page