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

MUSHclient scripting

Description of MUSHclient world function: world.WindowImageInfo


Name WindowImageInfo
Type Method
Summary Returns information about an image
Prototype VARIANT WindowImageInfo(BSTR WindowName, BSTR ImageId, long InfoType);

View list of data type meanings

Description

This returns information about a loaded image. You need to specify the name of the miniwindow, and the image id you used when loading the image.

WindowName - the name of an existing miniwindow.

ImageId - the image id you used when you loaded the image.

InfoType - the information you want:

1: Type - Specifies the bitmap type.

2: Width - Specifies the width, in pixels, of the bitmap.

3: Height - Specifies the height, in pixels, of the bitmap.

4: WidthBytes - Specifies the number of bytes in each scan line.

5: Planes - Specifies the count of color planes.

6: BitsPixel - Specifies the number of bits required to indicate the color of a pixel.

For more information, see:

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


Note: Available in version 4.34 onwards.


Lua example
WindowImageInfo(win, "im1", 6)
Lua notes
Lua returns nil instead of a NULL or EMPTY variant.
Returns The specified information about the image, as described above.
An EMPTY variant, if the image does not exist.
A NULL variant if the InfoType is not a valid type.
Introduced in version 4.34

See also ...

Function Description
WindowCreate Creates a miniwindow
WindowCreateImage Creates an image in a miniwindow
WindowDrawImage Draws an image into a miniwindow
WindowImageList Lists all images installed into a miniwindow
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]