world.WindowImageList

MUSHclient script function (Method) — introduced in version 4.34

Lists all images installed into a miniwindow

Prototype

VARIANT WindowImageList(BSTR WindowName);

Data type meanings

Description

This returns a list of all images loaded into this miniwindow. You could use this to find which images have been loaded, and then use WindowImageInfo to find information about each one.

WindowName - the name of the miniwindow to check for images.

For more information, see:

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

Lua example

-- show all images
images = WindowImageList(win)

if images then
  for _, v in ipairs (images) do 
    Note (v) 
  end
end -- if any

Lua notes

Lua returns nil if there are no images.

Return value

If there are no images installed then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the image ids of all the hotspots. Use "ubound" to find the number of images in the list. You can then use "WindowImageInfo" to find details about each image.

Related topic

MiniWindows

See also