Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.WindowMoveHotspot

Name WindowMoveHotspot
Type Method
Summary Moves a hotspot in a miniwindow
Prototype long WindowMoveHotspot(BSTR WindowName, BSTR HotspotId, long Left, long Top, long Right, long Bottom);

View list of data type meanings
Description

Moves a hotspot in a miniwindow. The miniwindow must already exist. The hotspot must already exist.

This lets you reposition a hotspot (for example, if the window is resized).


For more information about hotspots 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 of this particular hotspot. Hotspot IDs are case-sensitive.

Left, Top, Right, Bottom - describes the new hotspot rectangle.

Note: Available in version 4.58 onwards.
Lua example 
WindowMoveHotspot(win, "hs1",  
                 20, 20, 80, 40)   -- new rectangle
Returns eNoSuchWindow - no such miniwindow
eHotspotNotInstalled - this hotspot has not been defined for this window
eOK - completed OK

View list of return code meanings
Introduced in version 4.58

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
WindowHotspotTooltip Changes the tooltip text for a hotspot in 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