world.WindowMoveHotspot

MUSHclient script function (Method) — introduced in version 4.58

Moves a hotspot in a miniwindow

Prototype

long WindowMoveHotspot(BSTR WindowName, BSTR HotspotId, long Left, long Top, long Right, long Bottom);

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.

Lua example

WindowMoveHotspot(win, "hs1",  
                 20, 20, 80, 40)   -- new rectangle

Return value

eNoSuchWindow - no such miniwindow
eHotspotNotInstalled - this hotspot has not been defined for this window
eOK - completed OK

Return code meanings

Related topic

MiniWindows

See also