InfoBackground
Script function

world.InfoBackground

DOC_scripting Read about scripting

Type

Method

Summary

Sets the background colour for the info bar

Prototype

void InfoBackground(BSTR Name);

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



See Also ...

Topic

DOC_infobar Info bar - programmable information bar

Functions

FNC_Info Info (Adds text to the "info" tool bar)
FNC_InfoClear InfoClear (Clears all text from the info bar)
FNC_InfoColour InfoColour (Sets the colour of the foreground (text color) for the info bar)
FNC_InfoFont InfoFont (Changes the font, font size and style for text on the info bar)
FNC_SetStatus SetStatus (Sets the status line text)
FNC_ShowInfoBar ShowInfoBar (Shows or hides the "info" tool bar)

(Help topic: function=InfoBackground)

DOC_contents Documentation contents page