world.WindowHotspotInfo

MUSHclient script function (Method) — introduced in version 4.34

Returns information about a hotspot

Prototype

VARIANT WindowHotspotInfo(BSTR WindowName, BSTR HotspotId, long InfoType);

Data type meanings

Description

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

WindowName - the name of an existing miniwindow.

HotspotId - the hotspot id you used when you created the hotspot.

InfoType - the information you want:

1: Rectangle: Left
2: Rectangle: Top
3: Rectangle: Right
4: Rectangle: Bottom
5: MouseOver function name
6: CancelMouseOver function name
7: MouseDown function name
8: CancelMouseDown function name
9: MouseUp function name
10: TooltipText
11: Cursor
12: Flags
13: MoveCallback function name (from DragHandler call)
14: ReleaseCallback function name (from DragHandler call)
15: DragHandler flags (from DragHandler call)

For more information, see:

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

Lua example

WindowHotspotInfo(win, "hs1", 5)

Lua notes

Lua returns nil instead of a NULL or EMPTY variant.

Return value

The specified information about the hotspot, as described above.
An EMPTY variant, if the hotspot does not exist.
A NULL variant if the InfoType is not a valid type.

Related topic

MiniWindows

See also