world.GetMainWindowPosition

MUSHclient script function (Method) — introduced in version 3.56

Returns the position and size of the main MUSHclient window

Prototype

BSTR GetMainWindowPosition();

Data type meanings

Description

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.

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:

top=18
height=654
left=89
width=825

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.

eg.

GetMainWindowPosition (true)

The default is false, the original behaviour.

Return value

Returns a string in the form:

left,top,width,height

eg. "89,18,825,654"

For Lua, returns a table containing:

top=(value)
height=(value)
left=(value)
width=(value)

Related topic

Information

See also