[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.AdjustColour


Name AdjustColour
Type Method
Summary Adjust an RGB colour
Prototype long AdjustColour(long Colour, short Method);

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.


Note: Available in version 3.41 onwards.


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
Returns The RGB code of the adjusted colour. If the method is out of range the original colour is returned.
Introduced in version 3.41

See also ...

Function Description
ColourNameToRGB Converts a named colour to a RGB colour code.
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

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes


View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]