[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.WindowHotspotList

Name WindowHotspotList
Type Method
Summary Lists all hotspots installed into a miniwindow
Prototype VARIANT WindowHotspotList(BSTR WindowName);

View list of data type meanings


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:


Note: Available in version 4.34 onwards.

Lua example
-- show all hotspots
hotspots = WindowHotspotList(win)

if hotspots then
  for _, v in ipairs (hotspots) do 
    Note (v) 
end -- if any
Lua notes
Lua returns nil if there are no hotspots.
Returns 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.
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


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]