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

MUSHclient scripting

Description of MUSHclient world function: world.GetWorldWindowPositionX


Name GetWorldWindowPositionX
Type Method
Summary Returns the position and size of a specific world window
Prototype BSTR GetWorldWindowPositionX(short Which);

View list of data type meanings

Description

This function returns the size of one of the current world's window, in pixels.

For normal scripting languages these return a string, like this: "0,0,669,479".

The first window is window number 1, the second one is 2, and so on. You create new windows by using Window menu -> New Window.


Note: Available in version 3.66 onwards.


VBscript example
Note GetWorldWindowPositionX (2)
Jscript example
Note (GetWorldWindowPositionX (2))
Lua example
Not available in Lua - use GetWorldWindowPosition with a window number argument instead.
Lua notes
Lua has an optional argument to GetWorldWindowPosition which is the window number to get.
Returns Returns a string in the form:

left,top,width,height

eg. "0,0,669,479"
Introduced in version 3.66

See also ...

Function Description
GetMainWindowPosition Returns the position and size of the main MUSHclient window
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
MoveWorldWindowX Move and resize a specific 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]

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.

[Home]


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]