Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SetWorldWindowStatus


Name SetWorldWindowStatus
Type Method
Summary Changes the status of the current world window
Prototype void SetWorldWindowStatus(short Parameter)
Description

The parameter lets you change the status of the world window as follows:

1: Activates the window and displays it as a maximized window. (SW_SHOWMAXIMIZED)
2: Minimizes the window and activates the top-level window in the system’s list. (SW_MINIMIZE)
3: Activates and displays the window. If the window is minimized or maximized, restores it to its original size and position. (SW_RESTORE)
4: Activates and displays the window. If the window is minimized or maximized, restores it to its original size and position. (SW_SHOWNORMAL)

Any other value: Does nothing.


Note: Available in version 4.60 onwards.


Lua example
SetWorldWindowStatus (1) -- maximize

SetWorldWindowStatus (4) -- show as normal
Returns Nothing.
Introduced in version 4.60

See also ...

Function Description
GetInfo Gets information about the current world

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.