MUSHclient scripting

Description of MUSHclient world function: world.SetBackgroundColour

Name	SetBackgroundColour
Type	Method
Summary	Sets a background colour for the output window
Prototype	`long SetBackgroundColour(long Colour);` View list of data type meanings
Description	This changes the default background colour of the output window. This is intended to be used to make "mood" changes to the output window. For example, if you are currently playing in a watery zone, the background colour could change from black to a deep blue. You simply specify the RGB code for the desired colour, or the constant 0xFFFFFFFF to indicate to use the default behaviour. Normally MUSHclient draws the background in ANSI colour "normal black". If you have set a colour, then any time the background colour for text would have been "normal black", then the background is not drawn and thus the background colour you chose is allowed to stay. This function cannot fail, and returns the previous background colour. Note: Available in version 4.35 onwards.
Lua example	`SetBackgroundColour (0x000055)`
Returns	`The RGB colour which was the previous background colour.`
Introduced in version	4.35

See also ...

Function	Description
SetBackgroundImage	Sets a background image for the output window
SetForegroundImage	Sets a foreground image for the output window

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.

Leave blank to show all functions.

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

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

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