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

MUSHclient scripting

Description of MUSHclient world function: world.InfoBackground


Name InfoBackground
Type Method
Summary Sets the background colour for the info bar
Prototype void InfoBackground(BSTR Name);

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"


Note: Available in version 3.29 onwards.


VBscript example
world.InfoBackground "red"
Jscript example
world.InfoBackground ("red");
PerlScript example
$world->InfoBackground ("red");
Python example
world.InfoBackground ("red")
Lua example
InfoBackground ("red")
Returns Nothing.
Introduced in version 3.29

See also ...

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

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]