world.SetToolBarPosition

MUSHclient script function (Method) — introduced in version 4.29

Sets the position of the game toolbars on the screen.

Prototype

long SetToolBarPosition(short Which, BOOL Float, short Side, long Top, long Left);

Data type meanings

Description

Moves the toolbars around to your liking. The intention is to allow newly-distributed copies of MUSHclient to configure themselves appropriately.

Which: which toolbar, as follows:

1: Main toolbar (with the New, Open, Save, Print icons).
2: Game toolbar (with buttons for Edit Trigger, Edit Alias, log, etc.)
3: Activity toolbar (which shows the numbers 1 to 10)
4: Info toolbar (which lets you display informational messages)

Float: true or false

If true, the toolbar floats as a small independent window.
If false, the toolbar is docked to one side of the main client frame window

Side: which side to dock to, as follows:

1: top side
2: bottom side
3: left side
4: right side

If the style is set to "Float" then only "top" or "left" are valid (1 or 3), in which case the floating window has its icons arranged vertically or horizontally.

Top: Y co-ordinate of the top-left corner of the toolbar in client co-ordinates
Left: X co-ordinate of the top-left corner of the toolbar in client co-ordinates

(eg. 0, 0 would be the top-left corner).

Sizes of toolbars are:

1: 26 pixels high, 265 wide
2: 26 pixels high, 478 wide
3: 26 pixels high, 234 wide
4: 21 pixels high, 1007 wide

To place them side-by-side, you need to allow room for each one. For example:

SetToolBarPosition (1, false, 1, 0, 0) -- main toolbar
SetToolBarPosition (2, false, 1, 0, 264) -- game toolbar next to it
SetToolBarPosition (3, true, 1, 30, 500) -- float activity toolbar

VBscript example

SetToolBarPosition 1, false, 1, 0, 0    ' main toolbar
SetToolBarPosition 2, false, 1, 0, 264  ' game toolbar next to it
SetToolBarPosition 3, true, 1, 30, 500  ' float activity toolbar

Lua example

SetToolBarPosition (1, false, 1, 0, 0)    -- main toolbar
SetToolBarPosition (2, false, 1, 0, 264)  -- game toolbar next to it
SetToolBarPosition (3, true, 1, 30, 500)  -- float activity toolbar

Return value

eBadParameter: A parameter was of range.
eOK: Successfully completed

Return code meanings

Related topic

Utilities

See also