world.WindowHotspotTooltip

MUSHclient script function (Method) — introduced in version 4.41

Changes the tooltip text for a hotspot in a miniwindow

Prototype

long WindowHotspotTooltip(BSTR WindowName, BSTR HotspotId, BSTR TooltipText);

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.

Lua example

WindowHotspotTooltip (win, "hs1",  "Click here to be cured")

Return value

eNoSuchWindow - no such miniwindow
eHotspotNotInstalled - no such hotspot
eOK - completed OK

Return code meanings

Related topic

MiniWindows

See also