Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.WindowList

Name WindowList
Type Method
Summary Lists all miniwindows
Prototype VARIANT WindowList();

View list of data type meanings
Description

This returns a list of all miniwindows created for this world. You could use this to find which windows have been created, and then use WindowInfo to find information about each one.

For more information, see:

http://www.gammon.com.au/mushclient/mw_creation.htm

Note: Available in version 4.34 onwards.
Lua example 
-- show all windows
windows = WindowList()

if windows then
  for _, v in ipairs (windows) do 
    Note (v) 
  end
end -- if any
Lua notes 
Lua returns nil if there are no miniwindows.
Returns If there are no miniwindows then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the names of all the miniwindows. Use "ubound" to find the number of miniwindows in the list. You can then use "WindowInfo" to find details about each miniwindow.
Introduced in version 4.34

See also ...

Function Description
WindowCreate Creates a miniwindow
WindowInfo Returns information about a miniwindow
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