Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.WindowHotspotInfo

Name WindowHotspotInfo
Type Method
Summary Returns information about a hotspot
Prototype VARIANT WindowHotspotInfo(BSTR WindowName, BSTR HotspotId, long InfoType);

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

Note: Available in version 4.34 onwards.
Lua example 
WindowHotspotInfo(win, "hs1", 5)
Lua notes 
Lua returns nil instead of a NULL or EMPTY variant.
Returns 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.
Introduced in version 4.34

See also ...

Function Description
WindowAddHotspot Adds a hotspot to a miniwindow
WindowCreate Creates a miniwindow
WindowDeleteAllHotspots Deletes all hotspots from a miniwindow
WindowDeleteHotspot Deletes a hotspot from a miniwindow
WindowHotspotList Lists all hotspots installed into a miniwindow

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]

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

Home