[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.WindowImageList


Name WindowImageList
Type Method
Summary Lists all images installed into a miniwindow
Prototype VARIANT WindowImageList(BSTR WindowName);

View list of 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


Note: Available in version 4.34 onwards.


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.
Returns 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.
Introduced in version 4.34

See also ...

Function Description
WindowBlendImage Blends an image into a miniwindow, using a specified blending mode
WindowCreate Creates a miniwindow
WindowCreateImage Creates an image in a miniwindow
WindowDrawImage Draws an image into a miniwindow
WindowImageInfo Returns information about an image
WindowImageOp Draws an ellipse, rectangle or round rectangle, filled with an image
WindowLoadImage Loads an image into a miniwindow from a disk file

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]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]