Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.WindowDeleteAllHotspots

Name WindowDeleteAllHotspots
Type Method
Summary Deletes all hotspots from a miniwindow
Prototype long WindowDeleteAllHotspots(BSTR WindowName);

View list of data type meanings
Description

This deletes all hotspots from the miniwindow.

WindowName - the name of an existing miniwindow.

For more information, see:

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

Note: Available in version 4.34 onwards.
Lua example 
WindowDeleteAllHotspots (win);
Returns eNoSuchWindow - no such miniwindow
eOK - completed OK

View list of return code meanings
Introduced in version 4.34

See also ...

Function Description
WindowAddHotspot Adds a hotspot to a miniwindow
WindowCreate Creates a miniwindow
WindowDeleteHotspot Deletes a hotspot from a miniwindow
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