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

MUSHclient scripting

Description of MUSHclient world function: world.SetToolBarPosition


Name SetToolBarPosition
Type Method
Summary Sets the position of the game toolbars on the screen.
Prototype long SetToolBarPosition(short Which, BOOL Float, short Side, long Top, long Left);

View list of 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


Note: Available in version 4.29 onwards.


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
Returns eBadParameter: A parameter was of range.
eOK: Successfully completed

View list of return code meanings

Introduced in version 4.29

See also ...

Function Description
GetMainWindowPosition Returns the position and size of the main MUSHclient window
GetNotepadWindowPosition Returns the position and size of the specified notepad window
GetWorldWindowPosition Returns the position and size of the current world window
MoveMainWindow Move and resize the main MUSHclient window
MoveNotepadWindow Move and resize the specified notepad window
MoveWorldWindow Move and resize a world window
SetCommandWindowHeight Set the height of the command (input) window

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]

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.

[Home]


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]