world.InfoBackground

MUSHclient script function (Method) — introduced in version 3.29

Sets the background colour for the info bar

Prototype

void InfoBackground(BSTR Name);

Data type meanings

Description

Sets the backkground colour for the info bar. Because of the way the info bar is implemented (as a RichEdit control) the entire background colour is changed. You cannot change the background for individual parts of the bar.

The colours can either be named (eg. "red", "blue", "green", "brown") or supplied as HTML colour codes (eg. "#010203"). For HTML colours, the leading "#" is required.

The list of colour names recognised can be found by using MUSHclient's "colour picker" (Ctrl+Alt+P), or by using the function:

world.Debug "colours"

VBscript example

world.InfoBackground "red"

Jscript example

world.InfoBackground ("red");

PerlScript example

$world->InfoBackground ("red");

Python example

world.InfoBackground ("red")

Lua example

InfoBackground ("red")

Return value

Nothing.

Related topic

Info bar - programmable information bar

See also

FunctionDescription
InfoAdds text to the "info" tool bar
InfoClearClears all text from the info bar
InfoColourSets the colour of the foreground (text color) for the info bar
InfoFontChanges the font, font size and style for text on the info bar
SetStatusSets the status line text
ShowInfoBarShows or hides the "info" tool bar