SetWorldWindowStatus
Script function

world.SetWorldWindowStatus

DOC_scripting Read about scripting

Type

Method

Summary

Changes the status of the main world window (maximize/minimize/restore)

Prototype

void SetWorldWindowStatus(short Parameter);

DOC_data_types View list of data type meanings

Description

This function changes the status of the current world's window. It takes a single argument, which is interpreted as follows:


1: Maximize the window
2: Minimize the window
3: Restore the window
4: Return window to "normal"

If the argument is out of range, nothing happens.

VBscript example

SetWorldWindowStatus 1  ' maximize it


Lua example

SetWorldWindowStatus (1) -- maximize world window


Return value

None.



See Also ...

Functions

FNC_GetMainWindowPosition GetMainWindowPosition (Returns the position and size of the main MUSHclient window)
FNC_GetWorldWindowPosition GetWorldWindowPosition (Returns the position and size of the current world window)
FNC_MoveMainWindow MoveMainWindow (Move and resize the main MUSHclient window)
FNC_MoveWorldWindow MoveWorldWindow (Move and resize a world window)
FNC_MoveWorldWindowX MoveWorldWindowX (Move and resize a specific world window)

(Help topic: function=SetWorldWindowStatus)

DOC_contents Documentation contents page