world.SetBackgroundColour

MUSHclient script function (Method) — introduced in version 4.35

Sets a background colour for the output window

Prototype

long SetBackgroundColour(long Colour);

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.

Lua example

SetBackgroundColour (0x000055)

Return value

The RGB colour which was the previous background colour.

Related topic

Utilities

See also