Script function
world.WindowHotspotInfo
Read about scripting
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
Available in MUSHclient version 4.34 onwards.
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.
See Also ...
Topic
MiniWindows
Functions
(GetDeviceCaps) Gets screen device capabilities
(SetCursor) Changes the shape of the mouse cursor
(TextRectangle) Specifies the size of the rectangle in which text is displayed in the output window.
(WindowAddHotspot) Adds a hotspot to a miniwindow
(WindowArc) Draws an arc in a miniwindow
(WindowBezier) Draws a Bézier curve in a miniwindow
(WindowBlendImage) Blends an image into a miniwindow, using a specified blending mode
(WindowCircleOp) Draws ellipses, filled rectangles, round rectangles, chords, pies in a miniwindow
(WindowCreate) Creates a miniwindow
(WindowCreateImage) Creates an image in a miniwindow
(WindowDelete) Deletes a miniwindow
(WindowDeleteAllHotspots) Deletes all hotspots from a miniwindow
(WindowDeleteHotspot) Deletes a hotspot from a miniwindow
(WindowDragHandler) Adds a drag handler to a miniwindow hotspot
(WindowDrawImage) Draws an image into a miniwindow
(WindowDrawImageAlpha) Draws an image into a miniwindow respecting the alpha channel
(WindowFilter) Performs a filtering operation over part of the miniwindow.
(WindowFont) Loads a font into a miniwindow
(WindowFontInfo) Returns information about a font
(WindowFontList) Lists all fonts loaded into a miniwindow
(WindowGetImageAlpha) Draws the alpha channel of an image into a miniwindow
(WindowGetPixel) Gets the colour of a single pixel in a miniwindow
(WindowGradient) Draws a gradient in a rectangle
(WindowHotspotList) Lists all hotspots installed into a miniwindow
(WindowHotspotTooltip) Changes the tooltip text for a hotspot in a miniwindow
(WindowImageFromWindow) Creates an image from another miniwindow
(WindowImageInfo) Returns information about an image
(WindowImageList) Lists all images installed into a miniwindow
(WindowImageOp) Draws an ellipse, rectangle or round rectangle, filled with an image
(WindowInfo) Returns information about a miniwindow
(WindowLine) Draws a line in a miniwindow
(WindowList) Lists all miniwindows
(WindowLoadImage) Loads an image into a miniwindow from a disk file
(WindowMenu) Creates a pop-up menu inside a miniwindow
(WindowMergeImageAlpha) Merges an image into a miniwindow based on an alpha mask
(WindowMoveHotspot) Moves a hotspot in a miniwindow
(WindowPolygon) Draws a polygon in a miniwindow
(WindowPosition) Moves a miniwindow
(WindowRectOp) Draws a rectangle in a miniwindow
(WindowResize) Resizes a miniwindow
(WindowScrollwheelHandler) Adds a scroll-wheel handler to a miniwindow hotspot
(WindowSetPixel) Sets a single pixel in a miniwindow to the specified colour
(WindowSetZOrder) Sets the Z-Order for a miniwindow
(WindowShow) Shows or hides a miniwindow
(WindowText) Draws text into a miniwindow
(WindowTextWidth) Calculates the width of text in a miniwindow
(WindowTransformImage) Draws an image into a miniwindow with optional rotation, scaling, reflection and shearing
(WindowWrite) Writes the contents of a miniwindow to disk as a graphics file
(Help topic: function=WindowHotspotInfo)