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

Register forum user name Search FAQ


Script function


Read about scripting




Adds an item to the list shown for Shift+Tab completion


long ShiftTabCompleteItem(BSTR Item);

View list of data type meanings


Lets you add an item to the menu that pops up when you type a partial word and hit Shift+Tab in the command window.

The default is, if you type a partial script function name and hit Shift+Tab it will complete the function, as an aid to writing scripts, eg.

col<Shift+Tab> suggests ColourNameToRGB, ColourNote and ColourTell.

Now you can add items of your own to the list (for example, Python functions).

To do this, use this function for each additional word.

For example:

ShiftTabCompleteItem ("repeat")
ShiftTabCompleteItem ("until")
ShiftTabCompleteItem ("while")

You should use the correct capitalization that you want in the finished word.

Words must start with a letter, and then be alphanumeric (A-Z, a-z, 0-9) plus period, underscore, hyphen.

You can use three special words for additional control:

ShiftTabCompleteItem ("<clear>") --> clears the list of user-added items
ShiftTabCompleteItem ("<nofunctions>") --> suppresses the completion of script function names (like ColourTell)
ShiftTabCompleteItem ("<functions>") --> allows the completion of script function names

These items are not saved in the world file, they should be loaded each time.

You might use the "<nofunctions>" action if you were simply planning to play the MUD, and didn't want script functions popping up in the menu.

Available in MUSHclient version 4.30 onwards.

VBscript example

ShiftTabCompleteItem "Function"
ShiftTabCompleteItem "While"
ShiftTabCompleteItem "vbTrue"
ShiftTabCompleteItem "vbFalse"

Lua example

ShiftTabCompleteItem ("repeat")
ShiftTabCompleteItem ("until")
ShiftTabCompleteItem ("while")

-- special strings

ShiftTabCompleteItem ("<clear>")   --> clears the list of user-added items
ShiftTabCompleteItem ("<nofunctions>")  -->  suppresses the completion of script function names (like ColourTell)
ShiftTabCompleteItem ("<functions>")  --> allows the completion of script function names

Return value

eBadParameter: Empty string supplied, string > 30 characters, or string contains invalid characters
eOK: Added OK

View list of return code meanings

See Also ...




(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 &#x5C;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
(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
(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
(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
(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
(SetToolBarPosition) Sets the position of the game toolbars on the screen.
(SetUnseenLines) Sets the number of "unseen lines" for this world
(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=ShiftTabCompleteItem)

Documentation contents page

Search ...

Enter a search string to find matching documentation.

Search for:   

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.


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 HostDash]