world.WindowList

MUSHclient script function (Method) — introduced in version 4.34

Lists all miniwindows

Prototype

VARIANT WindowList();

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

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.

Return value

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.

Related topic

MiniWindows

See also