world.GetNotepadWindowPosition

MUSHclient script function (Method) — introduced in version 3.56

Returns the position and size of the specified notepad window

Prototype

BSTR GetNotepadWindowPosition(BSTR Title);

Data type meanings

Description

This function returns the size of the specified notepad's window, in pixels.

For normal scripting languages these return a string, like this: "66,66,637,356". For Lua, see below.

VBscript example

Note GetNotepadWindowPosition ("my_notepad")

Jscript example

Note (GetNotepadWindowPosition ("my_notepad"))

Lua example

table.foreach (GetNotepadWindowPosition ("my_notepad"), print)

Lua notes

In Lua it returns a table with four entries, like this:

top 66
height 356
left 66
width 637

If the notepad window does not exist, returns nil.

Return value

Returns a string in the form:

left,top,width,height

eg. "66,66,637,356"

For Lua, returns a table containing:

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

If the nominated notepad window does not exist, returns the empty string.

In Lua, if the notepad window does not exist, returns nil.

Related topic

Information

See also