Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.GetNotepadWindowPosition

Name GetNotepadWindowPosition
Type Method
Summary Returns the position and size of the specified notepad window
Prototype BSTR GetNotepadWindowPosition(BSTR Title);

View list of 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.

Note: Available in version 3.56 onwards.
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.
Returns 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.
Introduced in version 3.56

See also ...

Function Description
GetMainWindowPosition Returns the position and size of the main MUSHclient window
GetNotepadList Gets the list of open notepads - returning their titles
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

[Back]

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

Home