Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.WindowHotspotTooltip

Name WindowHotspotTooltip
Type Method
Summary Changes the tooltip text for a hotspot in a miniwindow
Prototype long WindowHotspotTooltip(BSTR WindowName, BSTR HotspotId, BSTR TooltipText);

View list of data type meanings
Description

This function lets you change the tooltip text for an existing hotspot.

For more information, see:

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

WindowName - the name of an existing miniwindow. Names are case-sensitive.

HotspotId - the hotspot id associated with this particular hotspot. Hotspot IDs are case-sensitive.

TooltipText - the text here is shown automatically if you "hover" the mouse over the hotspot for about a second. It is then removed after a few seconds. This is intended for help messages (maximum 999 characters). If there is a tab character (0x09) in the tooltip text, the text before the tab is considered the tooltip title (shown in bold on a separate line), and the rest of the text is the non-bold tooltip text.

Note: Available in version 4.41 onwards.
Lua example 
WindowHotspotTooltip (win, "hs1",  "Click here to be cured")
Returns eNoSuchWindow - no such miniwindow
eHotspotNotInstalled - no such hotspot
eOK - completed OK

View list of return code meanings
Introduced in version 4.41

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
WindowDragHandler Adds a drag handler to a miniwindow hotspot
WindowHotspotInfo Returns information about a hotspot
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