Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.WindowResize

Name WindowResize
Type Method
Summary Resizes a miniwindow
Prototype long WindowResize(BSTR WindowName, long Width, long Height, long BackgroundColour);

View list of data type meanings
Description

This resizes an existing miniwindow of the given name.

If the new size is larger than the existing size the BackgroundColour is used to fill any newly exposed area.

Any existing contents of the miniwindow are copied to the top-left corner of the new window.

The output window is not automatically redrawn. Call Redraw or WindowShow to cause the new size to become visible.

Any existing hotspots, images, and fonts are preserved. All other window parameters for this miniwindow are unchanged.


PARAMETERS:

WindowName - the name of an existing miniwindow. The name may not be the empty string.

NOTE: Window names are case-sensitive.

Width, Height - the width and height of the window, in pixels. The minimum size is 0, 0.


BackgroundColour - this is the RGB code for the colour is used to replace any pixels which are now visible, which were not previously (if the new size is larger than the old one).

Note: Available in version 4.58 onwards.
Lua example 
WindowResize ("inventory", 300, 400, ColourNameToRGB ("red"))  -- resize window to 300 x 400
Returns eNoNameSpecified - miniwindow name must be specified
eBadParameter - width or height less than zero
eOK - success

View list of return code meanings
Introduced in version 4.58

See also ...

Function Description
WindowCreate Creates a miniwindow
WindowDelete Deletes a miniwindow
WindowInfo Returns information about a miniwindow
WindowList Lists all miniwindows
WindowShow Shows or hides a miniwindow

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.

Home