SetToolBarPosition
Script function

world.SetToolBarPosition

DOC_scripting Read about scripting

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

DOC_data_types 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

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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_scripting Scripting
DOC_utils Utilities

Functions

FNC_AddFont AddFont (Adds a custom font for use by MUSHclient)
FNC_Base64Decode Base64Decode (Takes a base-64 encoded string and decodes it.)
FNC_Base64Encode Base64Encode (Encodes a string using base-64 encoding.)
FNC_BlendPixel BlendPixel (Blends a single pixel with another, using a specified blending mode)
FNC_ChangeDir ChangeDir (Changes the MUSHclient working directory)
FNC_CreateGUID CreateGUID (Creates a GUID - Global Unique Identifier)
FNC_EditDistance EditDistance (Returns the Levenshtein Edit Distance between two words)
FNC_ErrorDesc ErrorDesc (Converts a MUSHclient script error code into an human-readable description)
FNC_ExportXML ExportXML (Exports a world item in XML format)
FNC_FilterPixel FilterPixel (Performs a filtering operation on one pixel)
FNC_FixupEscapeSequences FixupEscapeSequences (Converts "escape sequences" like \t to their equivalent codes.)
FNC_FixupHTML FixupHTML (Fixes up text for writing as HTML)
FNC_FlashIcon FlashIcon (Flashes the MUSHclient icon on the Windows taskbar)
FNC_GenerateName GenerateName (Generates a random character name)
FNC_GetClipboard GetClipboard (Gets the clipboard contents)
FNC_GetMainWindowPosition GetMainWindowPosition (Returns the position and size of the main MUSHclient window)
FNC_GetNotepadWindowPosition GetNotepadWindowPosition (Returns the position and size of the specified notepad window)
FNC_GetScriptTime GetScriptTime (Returns the amount of time spent in script routines)
FNC_GetSoundStatus GetSoundStatus (Gets the status of a sound started by PlaySound)
FNC_GetUniqueID GetUniqueID (Creates a unique ID for general use, or for making Plugin IDs)
FNC_GetUniqueNumber GetUniqueNumber (Returns a unique number)
FNC_GetWorldWindowPosition GetWorldWindowPosition (Returns the position and size of the current world window)
FNC_Hash Hash (Produces a hash (checksum) of a specified piece of text)
FNC_Help Help (Shows help for a script function, or a list of functions)
FNC_ImportXML ImportXML (Imports configuration data in XML format)
FNC_Metaphone Metaphone (Returns the metaphone code for the supplied word)
FNC_MoveMainWindow MoveMainWindow (Move and resize the main MUSHclient window)
FNC_MoveNotepadWindow MoveNotepadWindow (Move and resize the specified notepad window)
FNC_MoveWorldWindow MoveWorldWindow (Move and resize a world window)
FNC_MoveWorldWindowX MoveWorldWindowX (Move and resize a specific world window)
FNC_MtRand MtRand (Returns pseudo-random number using the Mersenne Twister algorithm)
FNC_MtSrand MtSrand (Seed the Mersenne Twister pseudo-random number generator)
FNC_PlaySound PlaySound (Plays a sound using DirectSound)
FNC_ReadNamesFile ReadNamesFile (Loads in a file for generating character names)
FNC_Replace Replace (Replaces one substring with another)
FNC_SetBackgroundColour SetBackgroundColour (Sets a background colour for the output window)
FNC_SetBackgroundImage SetBackgroundImage (Sets a background image for the output window)
FNC_SetClipboard SetClipboard (Sets the clipboard contents)
FNC_SetCommandWindowHeight SetCommandWindowHeight (Set the height of the command (input) window)
FNC_SetForegroundImage SetForegroundImage (Sets a foreground image for the output window)
FNC_SetStatus SetStatus (Sets the status line text)
FNC_ShiftTabCompleteItem ShiftTabCompleteItem (Adds an item to the list shown for Shift+Tab completion)
FNC_Simulate Simulate (Simulate input from the MUD, for debugging purposes)
FNC_Sound Sound (Plays a sound)
FNC_StopSound StopSound (Stop playing a sound started by PlaySound)
FNC_StripANSI StripANSI (Strips ANSI colour sequences from a string)
FNC_Trace Trace (Trace mode property)
FNC_TraceOut TraceOut (Outputs the supplied message to the world Trace)
FNC_TranslateDebug TranslateDebug (Sends a debugging message to the localizing translator script)
FNC_TranslateGerman TranslateGerman (Translate German umluat sequences)
FNC_Transparency Transparency (Sets the transparency of the main MUSHclient window under Windows XP)
FNC_Trim Trim (Trims leading and trailing spaces from a string)

(Help topic: function=SetToolBarPosition)

DOC_contents Documentation contents page