Functions
Accelerator (Add or modify an accelerator key (keystroke to command mapping))
AcceleratorList (List defined accelerators)
Activate (Activates the world window)
ActivateClient (Activates the main MUSHclient window)
ActivateNotepad (Activates a notepad window)
AddAlias (Adds an alias)
AddMapperComment (Adds a comment to the auto-map sequence)
AddSpellCheckWord (Adds a word to the user spell check dictionary)
AddTimer (Adds a timer)
AddToMapper (Adds a mapping direction to the auto-map sequence)
AddTrigger (Adds a trigger)
AddTriggerEx (Adds a trigger - extended arguments)
AdjustColour (Adjust an RGB colour)
ANSI (Generates an ANSI colour sequence)
AnsiNote (Make a note in the output window from text with ANSI colour codes imbedded)
AppendToNotepad (Appends text to a notepad window)
ArrayClear (Clears an array)
ArrayCount (Returns the number of arrays)
ArrayCreate (Creates an array)
ArrayDelete (Deletes an array)
ArrayDeleteKey (Deletes a key/value pair from an array)
ArrayExists (Tests to see if the specified array exists)
ArrayExport (Exports values from an array into a single string)
ArrayExportKeys (Exports keys from an array into a single string)
ArrayGet (Gets the value of an array item)
ArrayGetFirstKey (Gets the key of the first element in the array (if any))
ArrayGetLastKey (Gets the key of the last element in the array (if any))
ArrayImport (Imports values into an array from a single string)
ArrayKeyExists (Tests to see if the specified array key exists)
ArrayListAll (Gets the list of arrays)
ArrayListKeys (Gets the list of all the keys in an array)
ArrayListValues (Gets the list of all the values in an array)
ArraySet (Sets the value of an array item)
ArraySize (Returns the number of elements in a specified array)
Base64Decode (Takes a base-64 encoded string and decodes it.)
Base64Encode (Encodes a string using base-64 encoding.)
BoldColour (Gets/sets the RGB colour for one of the 8 ANSI bold colours)
BroadcastPlugin (Broadcasts a message to all installed plugins)
CallPlugin (Calls a routine in a plugin)
ChangeDir (Changes the MUSHclient working directory)
ChatAcceptCalls (Accepts incoming chat calls)
ChatCall (Calls a chat server (makes an outgoing call) using the MudMaster chat protocol)
ChatCallzChat (Calls a zChat chat server (makes an outgoing call))
ChatDisconnect (Disconnects a current chat call)
ChatDisconnectAll (Disconnects all current chat calls)
ChatEverybody (Sends a chat message to every connected chat user)
ChatGetID (Looks up what chat ID (identifier) corresponds to a particular chat name)
ChatGroup (Sends a chat message to every connected chat user in the specified group)
ChatID (Sends a chat message to a particular chat session)
ChatMessage (Sends a message to a chat user (raw format))
ChatNameChange (Changes your chat name)
ChatNote (Does a note using ANSI codes for the chat system)
ChatPasteEverybody (Pastes the clipboard contents to every connected person)
ChatPasteText (Pastes the clipboard contents to that person)
ChatPeekConnections (Sends a "peek connections" message to the specified chat user)
ChatPersonal (Sends a chat message to a particular person)
ChatPing (Sends a ping message to the specified chat user)
ChatRequestConnections (Sends a "request connections" message to the specified chat user)
ChatSendFile (Starts sending a file to the specified chat user)
ChatStopAcceptingCalls (Stops this world from accepting chat calls)
ChatStopFileTransfer (Stops a file transfer in progress to that chat user)
CloseLog (Closes the log file)
CloseNotepad (Closes a notepad window)
ColourNameToRGB (Converts a named colour to a RGB colour code.)
ColourNote (Sends a message to the output window in specified colours)
ColourTell (Sends a message to the output window in specified colours - not terminated by a newline)
Connect (Connects the world to the MUD server)
CreateGUID (Creates a GUID - Global Unique Identifier)
CustomColourBackground (Sets the RGB value for the background of a custom colour)
CustomColourText (Sets the RGB value for the text of a custom colour)
Debug (Displays debugging information about the world)
DeleteAlias (Deletes an alias)
DeleteAliasGroup (Deletes a group of aliases)
DeleteAllMapItems (Deletes the all items from the auto-mapper sequence.)
DeleteCommandHistory (Deletes command history list.)
DeleteGroup (Deletes a group of triggers, aliases and timers)
DeleteLastMapItem (Deletes the most recently-added item from the auto-mapper sequence.)
DeleteLines (Clears some recent lines from the output window.)
DeleteOutput (Clears all output from the output window.)
DeleteTemporaryAliases (Deletes all temporary aliases)
DeleteTemporaryTimers (Deletes all temporary timers)
DeleteTemporaryTriggers (Deletes all temporary triggers)
DeleteTimer (Deletes a timer)
DeleteTimerGroup (Deletes a group of timers)
DeleteTrigger (Deletes a trigger)
DeleteTriggerGroup (Deletes a group of triggers)
DeleteVariable (Deletes a variable)
DiscardQueue (Discards the speed walk queue)
Disconnect (Disconnects the world from the MUD server)
DoAfter (Adds a one-shot, temporary timer - simplified interface)
DoAfterNote (Adds a one-shot, temporary note timer - simplified interface)
DoAfterSpecial (Adds a one-shot, temporary, timer to carry out some special action)
DoAfterSpeedWalk (Adds a one-shot, temporary speedwalk timer - simplified interface)
DoCommand (Queues a MUSHclient menu command)
EchoInput (A flag to indicate whether we are echoing command input to the output window)
EditDistance (Returns the Levenshtein Edit Distance between two words)
EnableAlias (Enables or disables an alias)
EnableAliasGroup (Enables/disables a group of aliases)
EnableGroup (Enables/disables a group of triggers, aliases and timers)
EnableMapping (Enables or disables the auto-mapper)
EnablePlugin (Enables or disables the specified plugin)
EnableTimer (Enables or disables an timer)
EnableTimerGroup (Enables/disables a group of timers)
EnableTrigger (Enables or disables a trigger)
EnableTriggerGroup (Enables/disables a group of triggers)
ErrorDesc (Converts a MUSHclient script error code into an human-readable description)
EvaluateSpeedwalk (Evaluates a speed walk string)
Execute (Executes a command as if you had typed it into the command window)
ExportXML (Exports a world item in XML format)
FixupEscapeSequences (Converts "escape sequences" like \t to their equivalent codes.)
FixupHTML (Fixes up text for writing as HTML)
FlushLog (Flushes the log file to disk)
GenerateName (Generates a random character name)
GetAlias (Gets details about an alias)
GetAliasInfo (Gets details about an alias)
GetAliasList (Gets the list of aliases)
GetAliasOption (Gets the value of a named alias option)
GetAliasWildcard (Returns the contents of the specified wildcard for the named alias)
GetAlphaOption (Gets the value of an alphanumeric configuration option)
GetAlphaOptionList (Gets the list of world alphanumeric options)
GetChatInfo (Get information about a chat connection)
GetChatList (Gets the list of chat sessions)
GetChatOption (Gets the value of a chat session option)
GetClipboard (Gets the clipboard contents)
GetCommand (Gets the current command in the command window)
GetCommandList (Returns some or all commands from the command history)
GetConnectDuration (Returns the number of seconds this world has been connected.)
GetCurrentValue (Gets the current value of a named world option)
GetCustomColourName (Gets the name of a custom colour)
GetDefaultValue (Gets the default value of a named world option)
GetEntity (Retrieves the value of an MXP server-defined entity)
GetFrame (Returns the address of the main MUSHclient frame window)
GetHostAddress (Returns a list of IP addresses that correspond to a host name on the Internet)
GetHostName (Returns the host name that corresponds to an IP address on the Internet)
GetInfo (Gets information about the current world)
GetInternalCommandsList (Returns a list of the internal MUSHclient command names)
GetLineCount (Gets count of lines received)
GetLineInfo (Gets details about a specified line in the output window)
GetLinesInBufferCount (Returns the number of lines in the output window)
GetLoadedValue (Gets value of a named world option, as loaded from the world file)
GetMainWindowPosition (Returns the position and size of the main MUSHclient window)
GetMapColour (Returns the mapping for how a particular colour will be displayed)
GetMappingCount (Gets a count of the number of items in the auto-map sequence)
GetMappingItem (Gets one item from the auto-map sequence)
GetMappingString (Returns the speedwalk string generated by the auto-mapper.)
GetNotepadLength (Gets the length of the text in a notepad window)
GetNotepadText (Gets the text from a notepad window)
GetNotepadWindowPosition (Returns the position and size of the specified notepad window)
GetNotes (Gets the world's notes)
GetNoteStyle (Gets the style for notes)
GetOption (Gets value of a named world option)
GetOptionList (Gets the list of world options)
GetPluginAliasInfo (Gets details about a named alias for a specified plugin)
GetPluginAliasList (Gets the list of aliases in a specified plugin)
GetPluginID (Returns the 24-character ID of the current plugin)
GetPluginInfo (Gets details about a specified plugin)
GetPluginList (Gets a list of installed plugins.)
GetPluginName (Returns the name of the current plugin)
GetPluginTimerInfo (Gets details about a named timer for a specified plugin)
GetPluginTimerList (Gets the list of timers in a specified plugin)
GetPluginTriggerInfo (Gets details about a named trigger for a specified plugin)
GetPluginTriggerList (Gets the list of triggers in a specified plugin)
GetPluginVariable (Gets the contents of a variable belonging to a plugin)
GetPluginVariableList (Gets the list of variables in a specified plugin)
GetQueue (Returns a variant array which is a list of queued commands)
GetReceivedBytes (Returns the number of bytes received from the world)
GetRecentLines (Assembles a block of text from recent MUD output)
GetScriptTime (Returns the amount of time spent in script routines)
GetSelectionEndColumn (Returns the endling column of the selection in the output window)
GetSelectionEndLine (Returns the last line of the selection in the output window)
GetSelectionStartColumn (Returns the starting column of the selection in the output window)
GetSelectionStartLine (Returns the starting line of the selection in the output window)
GetSentBytes (Returns the number of bytes sent to the world)
GetStyleInfo (Gets details about a specified style run for a specified line in the output window)
GetSysColor (Gets the colour of various windows items)
GetSystemMetrics (Returns selected system information from Windows)
GetTimer (Gets details about a timer)
GetTimerInfo (Gets details about a timer)
GetTimerList (Gets the list of timers)
GetTimerOption (Gets the value of a named timer option)
GetTrigger (Gets details about a named trigger)
GetTriggerInfo (Gets details about a named trigger)
GetTriggerList (Gets the list of triggers)
GetTriggerOption (Gets the value of a named trigger option)
GetTriggerWildcard (Returns the contents of the specified wildcard for the named trigger)
GetUdpPort (Find a free port for UDP listening)
GetUniqueID (Creates a unique ID for general use, or for making Plugin IDs)
GetUniqueNumber (Returns a unique number)
GetVariable (Gets the contents of a variable)
GetVariableList (Gets the list of variables)
GetWorld (Gets an object reference to the named world)
GetWorldById (Gets an object reference to the world given its unique ID)
GetWorldID (Returns the 24-character ID of the current world)
GetWorldIdList (Gets the list of open worlds - returning their world IDs)
GetWorldList (Gets the list of open worlds - returning their world names)
GetWorldWindowPosition (Returns the position and size of the current world window)
GetWorldWindowPositionX (Returns the position and size of a specific world window)
GetXMLEntity (Retrieves the value of a standard entity)
Hash (Produces a hash (checksum) of a specified piece of text)
Help (Shows help for a script function, or a list of functions)
Hyperlink (Creates a hyperlink in the output window)
ImportXML (Imports configuration data in XML format)
Info (Adds text to the "info" tool bar)
InfoBackground (Sets the background colour for the info bar)
InfoClear (Clears all text from the info bar)
InfoColour (Sets the colour of the foreground (text color) for the info bar)
InfoFont (Changes the font, font size and style for text on the info bar)
IsAlias (Tests to see if an alias exists)
IsConnected (Tests to see if the world is connected to the MUD server)
IsLogOpen (Tests to see if a log file is open)
IsPluginInstalled (Checks to see if a particular plugin is installed)
IsTimer (Tests to see if a timer exists)
IsTrigger (Tests to see if a trigger exists)
LoadPlugin (Loads a plugin from disk)
LogInput (The property of whether commands are logged to the log file)
LogNotes (The property of whether notes are logged to the log file)
LogOutput (The property of whether MUD output is logged to the log file)
LogSend (Sends a message to the MUD and logs it)
MakeRegularExpression (Converts wildcard matching text to a regular expression)
MapColour (Changes the colour mapping - the way colours are displayed)
MapColourList (Returns an array of all the mapped colours)
Mapping (A flag to indicate whether we are mapping the world)
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)
NormalColour (Gets/sets the RGB colour for one of the 8 ANSI normal colours)
Note (Sends a note to the output window)
NoteColour (Chooses which custom colour will be used for world notes.)
NoteColourBack (Chooses which RGB colour will be used for world notes - background colour)
NoteColourFore (Chooses which RGB colour will be used for world notes - text colour)
NoteColourName (Chooses which RGB colour name will be used for world notes - text and background)
NoteColourRGB (Chooses which RGB colour will be used for world notes - text and background)
NoteHr (Draws a horizontal rule in the output window)
NotepadColour (Changes the text and background colour of the selected notepad window)
NotepadFont (Changes the font and style of the selected notepad window)
NotepadSaveMethod (Changes the save method for this notepad window)
NoteStyle (Sets the style for notes)
Open (Opens a named document)
OpenBrowser (Opens a supplied URL in your default web browser)
OpenLog (Opens a log file.)
PasteCommand (Pastes text into the command window, replacing the current selection)
Pause (Turns pause mode on or off)
PickColour (Invokes the MUSHclient colour picker dialog)
PluginSupports (Checks if a plugin supports a particular routine)
PushCommand (Pushes the current command into the command history list)
Queue (Queues a command for sending at the "speed walk" rate.)
ReadNamesFile (Loads in a file for generating character names)
Redraw (Redraws all windows for this world)
ReloadPlugin (Reloads an installed plugin)
RemoveBacktracks (Removes backtracks from a speed walk string)
RemoveMapReverses (A flag to indicate whether we backtracks are removed during mapping)
Replace (Replaces one substring with another)
ReplaceNotepad (Replaces text in a notepad window)
Reset (Resets all outstanding MXP/Pueblo tags)
ResetIP (Resets the cached IP address of the world and proxy server)
ResetStatusTime (Resets the time elapsed shown on the status bar)
ResetTimer (Resets a named timer)
ResetTimers (Resets all timers)
ReverseSpeedwalk (Reverses a speed walk string)
RGBColourToName (Converts an RGB colour code to its equivalent name)
Save (Saves world configuration.)
SaveNotepad (Saves a notepad window to disk)
SaveState (Saves the state of the current plugin)
SelectCommand (Selects (highlights) the current command in the command window)
Send (Sends a message to the MUD)
SendImmediate (Sends a message to the MUD immediately, bypassing the speedwalk queue)
SendNoEcho (Sends a message to the MUD without echoing in the output window)
SendPkt (Sends a low-level packet of data to the MUD)
SendPush (Sends a message to the MUD and saves it in the command history buffer)
SendToNotepad (Creates a notepad and sends text to it)
SetAliasOption (Sets the value of a named alias option)
SetAlphaOption (Sets value of a named world alphanumeric option)
SetChanged (Sets or clears the "document has changed" flag)
SetChatOption (Sets the value of a chat session option)
SetClipboard (Sets the clipboard contents)
SetCommand (Sends text to the command window)
SetCustomColourName (Sets the name of a custom colour)
SetEntity (Sets the value of an MXP entity)
SetInputFont (Sets the font for the input window)
SetNotes (Sets the notes for the world.)
SetOption (Sets value of a named world option)
SetOutputFont (Sets the font for the output window.)
SetStatus (Sets the status line text)
SetTimerOption (Sets the value of a named timer option)
SetTriggerOption (Sets the value of a named trigger option)
SetVariable (Sets the value of a variable)
SetWorldWindowStatus (Changes the status of the main world window (maximize/minimize/restore))
ShowInfoBar (Shows or hides the "info" tool bar)
Simulate (Simulate input from the MUD, for debugging purposes)
Sound (Plays a sound)
SpeedWalkDelay (The number of milliseconds delay between speed walk commands)
SpellCheck (Spell checks an arbitrary string of text)
SpellCheckCommand (Spell checks the text in the command window)
SpellCheckDlg (Spell checks an arbitrary string of text, invloking the spell-checker dialog)
StripANSI (Strips ANSI colour sequences from a string)
Tell (Sends a message to the output window - not terminated by a newline)
Trace (Trace mode property)
TraceOut (Outputs the supplied message to the world Trace)
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)
UdpListen (Listens for incoming packets using the UDP protocol)
UdpPortList (Returns an array of all the UDP ports in use by this world)
UdpSend (Sends a packet over the network using the UDP protocol)
Version (Gets the MUSHclient version string.)
WorldAddress (Returns the TCP/IP address of the current world.)
WorldName (Gets the world's name)
WorldPort (Returns the port number of the current world.)
WriteLog (Writes to the log file)See also ...
Data types
Scripting return codes list
See Also ...
Topics
Lua script extensions
Scripting(Help topic: general=function_list)
Documentation contents page