Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SetMainTitle


Name SetMainTitle
Type Method
Summary Sets the main output window title
Prototype void SetMainTitle(BSTR Title);
Description

This sets the window title (for the whole client window) to the nominated text. You could use this to make the tile reflect the character name, world name, or whatever you want.

Setting the title to an empty string (ie. "") will revert back to the default title line (the world name, plus connection status).


Note: Available in version 4.87 onwards.


VBscript example
SetMainTitle "TinyMUX - admin login"
Lua example
SetMainTitle "TinyMUX - admin login"
Lua notes
You can supply multiple arguments, which are concatenated together.
Returns Nothing.
Introduced in version 4.87

See also ...

Function Description
Note Sends a note to the output window
Send Sends a message to the MUD
SetCommand Sends text to the command window
SetStatus Sets the status line text
SetTitle Sets the world window title

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.