Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SetFrameBackgroundColour


Name SetFrameBackgroundColour
Type Method
Summary Sets the background colour of the overall MUSHclient frame
Prototype void SetFrameBackgroundColour(long Colour);
Description

This lets you change the "main frame" background colour. This is, the colour of the area outside all windows. For example:

SetFrameBackgroundColour (ColourNameToRGB ("powderblue"))

The default is the default Windows background window colour, whatever that is (grey for me). You can go back to the default by setting the colour to 0xFFFFFFFF.


Note: Available in version 5.07 onwards.


Lua example
SetFrameBackgroundColour (ColourNameToRGB ("powderblue"))
Lua notes
The same functionality is available in the Lua utils function:

utils.setbackgroundcolour (ColourNameToRGB ("powderblue"))
Returns Nothing.
Introduced in version 5.07

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]

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