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

GetWorldWindowPosition

Script function

world.GetWorldWindowPosition

Read about scripting

Type

Method

Summary

Returns the position and size of the current world window

Prototype

BSTR GetWorldWindowPosition();

View list of data type meanings

Description

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

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


To specify a window other than the first window either use Lua (see below) or the function GetWorldWindowPositionX.


Available in MUSHclient version 3.60 onwards.



VBscript example

Note GetWorldWindowPosition


Jscript example

Note (GetWorldWindowPosition ())


Lua example

table.foreach (GetWorldWindowPosition(), print)


Lua notes

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

top 0
height 479
left 0
width 669

Lua has an optional argument which is the window number to examine. The first (main) window is window 1.

If you do Window -> New Window then you will get more windows, these will be 2, 3, 4 and so on.

You can use GetInfo (235) to find how many windows are currently open.

If you specify a window that does not exist you will get a nil result.

------------------

When using Lua the function GetWorldWindowPosition can take an optional second argument. If true, the world window position is reported in screen co-ordinates (that is, relative to the top-left corner of your monitor) rather than the default of relative to the main MUSHclient window. This lets you write plugins (like graphical status bars) that know where the world window is actually on the screen, so they can be drawn to be nearby.

------------------

When using Lua the function GetWorldWindowPosition can take an optional third 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.

Also the top and left positions, when the third argument is true, are slightly different to those supplied when it is false, for reasons that are not completely obvious, but might be the height of the title bar and the width of the scroll bars.


Return value

Returns a string in the form:

left,top,width,height

eg. "0,0,669,479"

For Lua, returns a table containing:

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


See Also ...

Topic

Information

Functions

(Debug) Displays debugging information about the world
(EchoInput) A flag to indicate whether we are echoing command input to the output window
(GetConnectDuration) Returns the number of seconds this world has been connected.
(GetEntity) Retrieves the value of an MXP server-defined entity
(GetHostAddress) Returns a list of IP addresses that correspond to a host name on the Internet
(GetHostName) Returns the host name that corresponds to an IP address on the Internet
(GetInfo) Gets information about the current world
(GetInternalCommandsList) Returns a list of the internal MUSHclient command names
(GetLineCount) Gets count of lines received
(GetLineInfo) Gets details about a specified line in the output window
(GetLinesInBufferCount) Returns the number of lines in the output window
(GetMainWindowPosition) Returns the position and size of the main MUSHclient window
(GetNotepadWindowPosition) Returns the position and size of the specified notepad window
(GetNotes) Gets the world's notes
(GetQueue) Returns a variant array which is a list of queued commands
(GetReceivedBytes) Returns the number of bytes received from the world
(GetRecentLines) Assembles a block of text from recent MUD output
(GetSelectionEndColumn) Returns the endling column of the selection in the output window
(GetSelectionEndLine) Returns the last line of the selection in the output window
(GetSelectionStartColumn) Returns the starting column of the selection in the output window
(GetSelectionStartLine) Returns the starting line of the selection in the output window
(GetSentBytes) Returns the number of bytes sent to the world
(GetStyleInfo) Gets details about a specified style run for a specified line in the output window
(GetSysColor) Gets the colour of various windows items
(GetSystemMetrics) Returns selected system information from Windows
(GetWorldID) Returns the 24-character ID of the current world
(GetWorldWindowPositionX) Returns the position and size of a specific world window
(GetXMLEntity) Retrieves the value of a standard entity
(IsConnected) Tests to see if the world is connected to the MUD server
(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
(SetChanged) Sets or clears the "document has changed" flag
(SetEntity) Sets the value of an MXP entity
(UdpPortList) Returns an array of all the UDP ports in use by this world
(Version) Gets the MUSHclient version string.
(WorldAddress) Returns the TCP/IP address of the current world.
(WorldName) Gets the world's name
(WorldPort) Returns the port number of the current world.

(Help topic: function=GetWorldWindowPosition)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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]