Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.MoveWorldWindow


Name MoveWorldWindow
Type Method
Summary Move and resize a world window
Prototype void MoveWorldWindow(long Left, long Top, long Width, long Height);
Description

This function moves and resizes the current world's window.

Specify the left and top co-ordinates in pixels.

Specify the width and height of the window in pixels.

Note that if you move the window off the screen (eg. to -1000, -1000) it will become invisible.

No checking is performed on the arguments to this function.

The co-ordinates are relative to the client area of the main MUSHclient window.

In other words, position 1, 1 is the very top-left corner of the MUSHclient frame window.

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


Note: Available in version 3.54 onwards.


VBscript example
MoveWorldWindow 1, 1, 640, 480
Jscript example
MoveWorldWindow (1, 1, 640, 480)
Lua example
MoveWorldWindow (1, 1, 640, 480, 2) -- move 2nd window
Lua notes
Lua has an optional 5th argument which is the window number to move. 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.
Returns None.
Introduced in version 3.54

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
MoveWorldWindowX Move and resize a specific world window
SetCommandWindowHeight Set the height of the command (input) window
SetToolBarPosition Sets the position of the game toolbars on the screen.
SetWorldWindowStatus Changes the status of the current 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.