GetWorldWindowPosition
Script function

world.GetWorldWindowPosition

DOC_scripting Read about scripting

Type

Method

Summary

Returns the position and size of the current world window

Prototype

BSTR GetWorldWindowPosition();

DOC_data_types 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.

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.


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

DOC_info Information

Functions

FNC_Debug Debug (Displays debugging information about the world)
FNC_EchoInput EchoInput (A flag to indicate whether we are echoing command input to the output window)
FNC_GetConnectDuration GetConnectDuration (Returns the number of seconds this world has been connected.)
FNC_GetEntity GetEntity (Retrieves the value of an MXP server-defined entity)
FNC_GetHostAddress GetHostAddress (Returns a list of IP addresses that correspond to a host name on the Internet)
FNC_GetHostName GetHostName (Returns the host name that corresponds to an IP address on the Internet)
FNC_GetInfo GetInfo (Gets information about the current world)
FNC_GetInternalCommandsList GetInternalCommandsList (Returns a list of the internal MUSHclient command names)
FNC_GetLineCount GetLineCount (Gets count of lines received)
FNC_GetLineInfo GetLineInfo (Gets details about a specified line in the output window)
FNC_GetLinesInBufferCount GetLinesInBufferCount (Returns the number of lines in the output window)
FNC_GetMainWindowPosition GetMainWindowPosition (Returns the position and size of the main MUSHclient window)
FNC_GetNotepadWindowPosition GetNotepadWindowPosition (Returns the position and size of the specified notepad window)
FNC_GetNotes GetNotes (Gets the world's notes)
FNC_GetQueue GetQueue (Returns a variant array which is a list of queued commands)
FNC_GetReceivedBytes GetReceivedBytes (Returns the number of bytes received from the world)
FNC_GetRecentLines GetRecentLines (Assembles a block of text from recent MUD output)
FNC_GetSelectionEndColumn GetSelectionEndColumn (Returns the endling column of the selection in the output window)
FNC_GetSelectionEndLine GetSelectionEndLine (Returns the last line of the selection in the output window)
FNC_GetSelectionStartColumn GetSelectionStartColumn (Returns the starting column of the selection in the output window)
FNC_GetSelectionStartLine GetSelectionStartLine (Returns the starting line of the selection in the output window)
FNC_GetSentBytes GetSentBytes (Returns the number of bytes sent to the world)
FNC_GetStyleInfo GetStyleInfo (Gets details about a specified style run for a specified line in the output window)
FNC_GetSysColor GetSysColor (Gets the colour of various windows items)
FNC_GetSystemMetrics GetSystemMetrics (Returns selected system information from Windows)
FNC_GetWorldID GetWorldID (Returns the 24-character ID of the current world)
FNC_GetWorldWindowPositionX GetWorldWindowPositionX (Returns the position and size of a specific world window)
FNC_GetXMLEntity GetXMLEntity (Retrieves the value of a standard entity)
FNC_IsConnected IsConnected (Tests to see if the world is connected to the MUD server)
FNC_MoveMainWindow MoveMainWindow (Move and resize the main MUSHclient window)
FNC_MoveNotepadWindow MoveNotepadWindow (Move and resize the specified notepad window)
FNC_MoveWorldWindow MoveWorldWindow (Move and resize a world window)
FNC_MoveWorldWindowX MoveWorldWindowX (Move and resize a specific world window)
FNC_SetChanged SetChanged (Sets or clears the "document has changed" flag)
FNC_SetEntity SetEntity (Sets the value of an MXP entity)
FNC_UdpPortList UdpPortList (Returns an array of all the UDP ports in use by this world)
FNC_Version Version (Gets the MUSHclient version string.)
FNC_WorldAddress WorldAddress (Returns the TCP/IP address of the current world.)
FNC_WorldName WorldName (Gets the world's name)
FNC_WorldPort WorldPort (Returns the port number of the current world.)

(Help topic: function=GetWorldWindowPosition)

DOC_contents Documentation contents page