Script function

world.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);

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

Available in MUSHclient 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

Return value

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

See Also ...

Topics

Scripting
Utilities

Functions

(AddFont) Adds a custom font for use by MUSHclient
(Base64Decode) Takes a base-64 encoded string and decodes it.
(Base64Encode) Encodes a string using base-64 encoding.
(BlendPixel) Blends a single pixel with another, using a specified blending mode
(ChangeDir) Changes the MUSHclient working directory
(CreateGUID) Creates a GUID - Global Unique Identifier
(EditDistance) Returns the Levenshtein Edit Distance between two words
(ErrorDesc) Converts a MUSHclient script error code into an human-readable description
(ExportXML) Exports a world item in XML format
(FilterPixel) Performs a filtering operation on one pixel
(FixupEscapeSequences) Converts "escape sequences" like \t to their equivalent codes.
(FixupHTML) Fixes up text for writing as HTML
(FlashIcon) Flashes the MUSHclient icon on the Windows taskbar
(GenerateName) Generates a random character name
(GetClipboard) Gets the clipboard contents
(GetMainWindowPosition) Returns the position and size of the main MUSHclient window
(GetNotepadWindowPosition) Returns the position and size of the specified notepad window
(GetScriptTime) Returns the amount of time spent in script routines
(GetSoundStatus) Gets the status of a sound started by PlaySound
(GetUniqueID) Creates a unique ID for general use, or for making Plugin IDs
(GetUniqueNumber) Returns a unique number
(GetWorldWindowPosition) Returns the position and size of the current world window
(Hash) Produces a hash (checksum) of a specified piece of text
(Help) Shows help for a script function, or a list of functions
(ImportXML) Imports configuration data in XML format
(Menu) Creates a pop-up menu inside the command window
(Metaphone) Returns the metaphone code for the supplied word
(MoveMainWindow) Move and resize the main MUSHclient window
(MoveNotepadWindow) Move and resize the specified notepad window
(MoveWorldWindow) Move and resize a world window
(MoveWorldWindowX) Move and resize a specific world window
(MtRand) Returns pseudo-random number using the Mersenne Twister algorithm
(MtSrand) Seed the Mersenne Twister pseudo-random number generator
(PlaySound) Plays a sound using DirectSound
(ReadNamesFile) Loads in a file for generating character names
(Replace) Replaces one substring with another
(SetBackgroundColour) Sets a background colour for the output window
(SetBackgroundImage) Sets a background image for the output window
(SetClipboard) Sets the clipboard contents
(SetCommandWindowHeight) Set the height of the command (input) window
(SetForegroundImage) Sets a foreground image for the output window
(SetMainTitle) Sets the main output window title
(SetSelection) Sets a selection range in the output window
(SetStatus) Sets the status line text
(SetTitle) Sets the world window title
(SetUnseenLines) Sets the number of "unseen lines" for this world
(ShiftTabCompleteItem) Adds an item to the list shown for Shift+Tab completion
(Simulate) Simulate input from the MUD, for debugging purposes
(Sound) Plays a sound
(StopSound) Stop playing a sound started by PlaySound
(StripANSI) Strips ANSI colour sequences from a string
(Trace) Trace mode property
(TraceOut) Outputs the supplied message to the world Trace
(TranslateDebug) Sends a debugging message to the localizing translator script
(TranslateGerman) Translate German umluat sequences
(Transparency) Sets the transparency of the main MUSHclient window under Windows XP
(Trim) Trims leading and trailing spaces from a string

(Help topic: function=SetToolBarPosition)