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

MUSHclient scripting

Description of MUSHclient world function: world.GetMainWindowPosition

Name GetMainWindowPosition
Type Method
Summary Returns the position and size of the main MUSHclient window
Prototype BSTR GetMainWindowPosition();

View list of data type meanings


This function returns the size of the main MUSHclient window (the frame window inside which all world windows reside), in pixels.

For normal scripting languages these return a string, like this: "89,18,825,654". For Lua, see below.

Note: Available in version 3.56 onwards.

VBscript example
Note GetMainWindowPosition
Jscript example
Note (GetMainWindowPosition ())
Lua example
table.foreach (GetMainWindowPosition (), print)
Lua notes
In Lua it returns a table with four entries, like this:


In Lua you can supply an optional boolean argument. If true, a different method of calculating the window position is used (calling GetWindowRect rather than GetWindowPlacement). This method gives a more accurate result if you use "Aero Snap" under Windows 7 or higher. However it may return inaccurate results if the window is minimized.


GetMainWindowPosition (true)

The default is false, the original behaviour.
Returns Returns a string in the form:


eg. "89,18,825,654"

For Lua, returns a table containing:

Introduced in version 3.56

See also ...

Function Description
GetNotepadWindowPosition Returns the position and size of the specified notepad window
GetWorldWindowPosition Returns the position and size of the current world window
MoveMainWindow Move and resize the main MUSHclient window
MoveNotepadWindow Move and resize the specified notepad window
MoveWorldWindow Move and resize a world window

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


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.


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]