world.WindowHotspotList

MUSHclient script function (Method) — introduced in version 4.34

Lists all hotspots installed into a miniwindow

Prototype

VARIANT WindowHotspotList(BSTR WindowName);

Data type meanings

Description

This returns a list of all hotspots loaded into this miniwindow. You could use this to find which hotspots have been created, and then use WindowHotspotInfo to find information about each one.

WindowName - the name of the miniwindow to check for hotspots.

For more information, see:

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

Lua example

-- show all hotspots
hotspots = WindowHotspotList(win)

if hotspots then
  for _, v in ipairs (hotspots) do 
    Note (v) 
  end
end -- if any

Lua notes

Lua returns nil if there are no hotspots.

Return value

If there are no hotspots installed then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the hotspot ids of all the hotspots. Use "ubound" to find the number of hotspots in the list. You can then use "WindowHotspotList" to find details about each hotspot.

Related topic

MiniWindows

See also