Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SetCommandWindowHeight


Name SetCommandWindowHeight
Type Method
Summary Set the height of the command (input) window
Prototype long SetCommandWindowHeight(short Height);
Description

Sets the height of the command window in pixels.


Note: Available in version 4.28 onwards.


VBscript example
SetCommandWindowHeight 15  ' enough for a line
SetCommandWindowHeight 0    ' not visible
Jscript example
SetCommandWindowHeight (15)  // enough for a line
SetCommandWindowHeight  (0)  // not visible
Lua example
SetCommandWindowHeight (15)  -- enough for a line
SetCommandWindowHeight  (0)  -- not visible
Returns eBadParameter: Specified height is < 0 or such that the output window would be < 20 pixels high.
eOK: Completed OK
Introduced in version 4.28

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
MoveWorldWindow Move and resize a world window
MoveWorldWindowX Move and resize a specific world window
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.