MUSHclient script functions

All world functions available to MUSHclient scripts, in every supported scripting language. Click a function name for its prototype, description and examples. See also the script return codes and the data types used in prototypes.

FunctionDescriptionVersion
AcceleratorAdd or modify an accelerator key (keystroke to command mapping)3.53
AcceleratorListList defined accelerators3.53
AcceleratorToAdd or modify an accelerator key - with "Send To" parameter4.27
ActivateActivates the world window
ActivateClientActivates the main MUSHclient window3.48
ActivateNotepadActivates a notepad window
AddAliasAdds an alias
AddFontAdds a custom font for use by MUSHclient4.32
AddMapperCommentAdds a comment to the auto-map sequence
AddSpellCheckWordAdds a word to the user spell check dictionary3.74
AddTimerAdds a timer
AddToMapperAdds a mapping direction to the auto-map sequence
AddTriggerAdds a trigger
AddTriggerExAdds a trigger - extended arguments3.18
AdjustColourAdjust an RGB colour3.41
ANSIGenerates an ANSI colour sequence3.37
AnsiNoteMake a note in the output window from text with ANSI colour codes imbedded3.37
AppendToNotepadAppends text to a notepad window
ArrayClearClears an array3.46
ArrayCountReturns the number of arrays3.46
ArrayCreateCreates an array3.46
ArrayDeleteDeletes an array3.46
ArrayDeleteKeyDeletes a key/value pair from an array3.46
ArrayExistsTests to see if the specified array exists3.46
ArrayExportExports values from an array into a single string3.46
ArrayExportKeysExports keys from an array into a single string3.46
ArrayGetGets the value of an array item3.46
ArrayGetFirstKeyGets the key of the first element in the array (if any)3.46
ArrayGetLastKeyGets the key of the last element in the array (if any)3.46
ArrayImportImports values into an array from a single string3.46
ArrayKeyExistsTests to see if the specified array key exists3.46
ArrayListAllGets the list of arrays3.46
ArrayListKeysGets the list of all the keys in an array3.46
ArrayListValuesGets the list of all the values in an array3.46
ArraySetSets the value of an array item3.46
ArraySizeReturns the number of elements in a specified array3.46
Base64DecodeTakes a base-64 encoded string and decodes it.3.22
Base64EncodeEncodes a string using base-64 encoding.3.22
BlendPixelBlends a single pixel with another, using a specified blending mode4.36
BoldColourGets/sets the RGB colour for one of the 8 ANSI bold colours
BookmarkSets of clears a bookmark on the nominated line4.83
BroadcastPluginBroadcasts a message to all installed plugins3.67
CallPluginCalls a routine in a plugin3.23
ChangeDirChanges the MUSHclient working directory3.80
ChatAcceptCallsAccepts incoming chat calls3.37
ChatCallCalls a chat server (makes an outgoing call) using the MudMaster chat protocol3.37
ChatCallzChatCalls a zChat chat server (makes an outgoing call)3.39
ChatDisconnectDisconnects a current chat call3.37
ChatDisconnectAllDisconnects all current chat calls3.37
ChatEverybodySends a chat message to every connected chat user3.37
ChatGetIDLooks up what chat ID (identifier) corresponds to a particular chat name3.37
ChatGroupSends a chat message to every connected chat user in the specified group3.37
ChatIDSends a chat message to a particular chat session3.37
ChatMessageSends a message to a chat user (raw format)3.37
ChatNameChangeChanges your chat name3.37
ChatNoteDoes a note using ANSI codes for the chat system3.37
ChatPasteEverybodyPastes the clipboard contents to every connected person3.37
ChatPasteTextPastes the clipboard contents to that person3.37
ChatPeekConnectionsSends a "peek connections" message to the specified chat user3.37
ChatPersonalSends a chat message to a particular person3.37
ChatPingSends a ping message to the specified chat user3.37
ChatRequestConnectionsSends a "request connections" message to the specified chat user3.37
ChatSendFileStarts sending a file to the specified chat user3.37
ChatStopAcceptingCallsStops this world from accepting chat calls3.37
ChatStopFileTransferStops a file transfer in progress to that chat user3.37
CloseLogCloses the log file
CloseNotepadCloses a notepad window3.29
ColourNameToRGBConverts a named colour to a RGB colour code.3.22
ColourNoteSends a message to the output window in specified colours3.23
ColourTellSends a message to the output window in specified colours - not terminated by a newline3.23
ConnectConnects the world to the MUD server
CreateGUIDCreates a GUID - Global Unique Identifier3.23
CustomColourBackgroundSets the RGB value for the background of a custom colour
CustomColourTextSets the RGB value for the text of a custom colour
DatabaseChangesReturns a count of the changes to the database by the most recent SQL statement4.40
DatabaseCloseCloses an SQLite database4.40
DatabaseColumnNameFind the name of a specified column returned by an SQL statement4.40
DatabaseColumnNamesReturn a table of all the columns returned by an SQL statement4.40
DatabaseColumnsFind how many columns will be returned by an SQL statement4.40
DatabaseColumnTextReturns the contents of an SQL column, as text4.40
DatabaseColumnTypeReturns the type of data in an SQL column4.40
DatabaseColumnValueReturns the contents of an SQL column, as text, float, integer, or null4.40
DatabaseColumnValuesReturns the contents of all the SQL columns after a step4.40
DatabaseErrorReturns an English string describing the most recent SQL error4.40
DatabaseExecExecutes SQL code against an SQLite database4.40
DatabaseFinalizeFinalizes (wraps up) a previously-prepared SQL statement4.40
DatabaseGetFieldReturns a single field from an SQL database4.65
DatabaseInfoReturns information about a database4.40
DatabaseLastInsertRowidReturns the most recently automatically allocated database key4.40
DatabaseListLists all databases4.40
DatabaseOpenOpens an SQLite database4.40
DatabasePreparePrepares an SQL statement for execution4.40
DatabaseResetResets a previously-prepared SQL statement to the start4.40
DatabaseStepExecutes a previously-prepared SQL statement4.40
DatabaseTotalChangesReturns a count of the total changes to the database4.40
DebugDisplays debugging information about the world
DeleteAliasDeletes an alias
DeleteAliasGroupDeletes a group of aliases3.29
DeleteAllMapItemsDeletes the all items from the auto-mapper sequence.
DeleteCommandHistoryDeletes command history list.
DeleteGroupDeletes a group of triggers, aliases and timers3.29
DeleteLastMapItemDeletes the most recently-added item from the auto-mapper sequence.
DeleteLinesClears some recent lines from the output window.3.76
DeleteOutputClears all output from the output window.
DeleteTemporaryAliasesDeletes all temporary aliases3.18
DeleteTemporaryTimersDeletes all temporary timers3.18
DeleteTemporaryTriggersDeletes all temporary triggers3.18
DeleteTimerDeletes a timer
DeleteTimerGroupDeletes a group of timers3.29
DeleteTriggerDeletes a trigger
DeleteTriggerGroupDeletes a group of triggers3.29
DeleteVariableDeletes a variable
DiscardQueueDiscards the speed walk queue
DisconnectDisconnects the world from the MUD server
DoAfterAdds a one-shot, temporary timer - simplified interface3.18
DoAfterNoteAdds a one-shot, temporary note timer - simplified interface3.18
DoAfterSpecialAdds a one-shot, temporary, timer to carry out some special action3.35
DoAfterSpeedWalkAdds a one-shot, temporary speedwalk timer - simplified interface3.18
DoCommandQueues a MUSHclient menu command3.39
EchoInputA flag to indicate whether we are echoing command input to the output window
EditDistanceReturns the Levenshtein Edit Distance between two words3.82
EnableAliasEnables or disables an alias
EnableAliasGroupEnables/disables a group of aliases3.27
EnableGroupEnables/disables a group of triggers, aliases and timers3.27
EnableMappingEnables or disables the auto-mapper3.47
EnablePluginEnables or disables the specified plugin
EnableTimerEnables or disables an timer
EnableTimerGroupEnables/disables a group of timers3.27
EnableTriggerEnables or disables a trigger
EnableTriggerGroupEnables/disables a group of triggers3.27
ErrorDescConverts a MUSHclient script error code into an human-readable description3.68
EvaluateSpeedwalkEvaluates a speed walk string
ExecuteExecutes a command as if you had typed it into the command window3.35
ExportXMLExports a world item in XML format3.41
FilterPixelPerforms a filtering operation on one pixel4.36
FixupEscapeSequencesConverts "escape sequences" like \t to their equivalent codes.
FixupHTMLFixes up text for writing as HTML
FlashIconFlashes the MUSHclient icon on the Windows taskbar4.41
FlushLogFlushes the log file to disk3.82
GenerateNameGenerates a random character name
GetAliasGets details about an alias
GetAliasInfoGets details about an alias
GetAliasListGets the list of aliases
GetAliasOptionGets the value of a named alias option3.29
GetAliasWildcardReturns the contents of the specified wildcard for the named alias3.48
GetAlphaOptionGets the value of an alphanumeric configuration option3.22
GetAlphaOptionListGets the list of world alphanumeric options3.22
GetChatInfoGet information about a chat connection3.37
GetChatListGets the list of chat sessions3.37
GetChatOptionGets the value of a chat session option3.37
GetClipboardGets the clipboard contents3.39
GetCommandGets the current command in the command window3.18
GetCommandListReturns some or all commands from the command history3.18
GetConnectDurationReturns the number of seconds this world has been connected.
GetCurrentValueGets the current value of a named world option3.23
GetCustomColourNameGets the name of a custom colour4.03
GetDefaultValueGets the default value of a named world option3.23
GetDeviceCapsGets screen device capabilities4.34
GetEntityRetrieves the value of an MXP server-defined entity3.30
GetFrameReturns the address of the main MUSHclient frame window
GetGlobalOptionGets the value of a global configuration option4.18
GetGlobalOptionListGets the list of global options4.18
GetHostAddressReturns a list of IP addresses that correspond to a host name on the Internet3.39
GetHostNameReturns the host name that corresponds to an IP address on the Internet3.39
GetInfoGets information about the current world3.18
GetInternalCommandsListReturns a list of the internal MUSHclient command names3.39
GetLineCountGets count of lines received
GetLineInfoGets details about a specified line in the output window3.18
GetLinesInBufferCountReturns the number of lines in the output window3.18
GetLoadedValueGets value of a named world option, as loaded from the world file3.23
GetMainWindowPositionReturns the position and size of the main MUSHclient window3.56
GetMapColourReturns the mapping for how a particular colour will be displayed3.54
GetMappingCountGets a count of the number of items in the auto-map sequence
GetMappingItemGets one item from the auto-map sequence
GetMappingStringReturns the speedwalk string generated by the auto-mapper.
GetNotepadLengthGets the length of the text in a notepad window3.40
GetNotepadListGets the list of open notepads - returning their titles4.08
GetNotepadTextGets the text from a notepad window3.40
GetNotepadWindowPositionReturns the position and size of the specified notepad window3.56
GetNotesGets the world's notes
GetNoteStyleGets the style for notes3.42
GetOptionGets value of a named world option
GetOptionListGets the list of world options
GetPluginAliasInfoGets details about a named alias for a specified plugin3.23
GetPluginAliasListGets the list of aliases in a specified plugin3.23
GetPluginAliasOptionGets the value of a named alias option for a specified plugin4.21
GetPluginIDReturns the 24-character ID of the current plugin3.23
GetPluginInfoGets details about a specified plugin3.23
GetPluginListGets a list of installed plugins.3.23
GetPluginNameReturns the name of the current plugin3.23
GetPluginTimerInfoGets details about a named timer for a specified plugin3.23
GetPluginTimerListGets the list of timers in a specified plugin3.23
GetPluginTimerOptionGets the value of a named timer option for a specified plugin4.21
GetPluginTriggerInfoGets details about a named trigger for a specified plugin3.23
GetPluginTriggerListGets the list of triggers in a specified plugin3.23
GetPluginTriggerOptionGets the value of a named trigger option for a specified plugin4.21
GetPluginVariableGets the contents of a variable belonging to a plugin3.23
GetPluginVariableListGets the list of variables in a specified plugin3.23
GetQueueReturns a variant array which is a list of queued commands3.18
GetReceivedBytesReturns the number of bytes received from the world
GetRecentLinesAssembles a block of text from recent MUD output3.48
GetScriptTimeReturns the amount of time spent in script routines
GetSelectionEndColumnReturns the endling column of the selection in the output window3.18
GetSelectionEndLineReturns the last line of the selection in the output window3.18
GetSelectionStartColumnReturns the starting column of the selection in the output window3.18
GetSelectionStartLineReturns the starting line of the selection in the output window3.18
GetSentBytesReturns the number of bytes sent to the world
GetSoundStatusGets the status of a sound started by PlaySound4.28
GetStyleInfoGets details about a specified style run for a specified line in the output window3.18
GetSysColorGets the colour of various windows items3.56
GetSystemMetricsReturns selected system information from Windows3.56
GetTimerGets details about a timer
GetTimerInfoGets details about a timer
GetTimerListGets the list of timers
GetTimerOptionGets the value of a named timer option3.29
GetTriggerGets details about a named trigger
GetTriggerInfoGets details about a named trigger
GetTriggerListGets the list of triggers
GetTriggerOptionGets the value of a named trigger option3.29
GetTriggerWildcardReturns the contents of the specified wildcard for the named trigger3.48
GetUdpPortFind a free port for UDP listening3.66
GetUniqueIDCreates a unique ID for general use, or for making Plugin IDs3.23
GetUniqueNumberReturns a unique number
GetVariableGets the contents of a variable
GetVariableListGets the list of variables
GetWorldGets an object reference to the named world
GetWorldByIdGets an object reference to the world given its unique ID3.39
GetWorldIDReturns the 24-character ID of the current world3.52
GetWorldIdListGets the list of open worlds - returning their world IDs3.39
GetWorldListGets the list of open worlds - returning their world names
GetWorldWindowPositionReturns the position and size of the current world window3.60
GetWorldWindowPositionXReturns the position and size of a specific world window3.66
GetXMLEntityRetrieves the value of a standard entity3.66
HashProduces a hash (checksum) of a specified piece of text3.23
HelpShows help for a script function, or a list of functions3.70
HyperlinkCreates a hyperlink in the output window3.41
ImportXMLImports configuration data in XML format3.39
InfoAdds text to the "info" tool bar3.29
InfoBackgroundSets the background colour for the info bar3.29
InfoClearClears all text from the info bar3.29
InfoColourSets the colour of the foreground (text color) for the info bar3.29
InfoFontChanges the font, font size and style for text on the info bar3.29
IsAliasTests to see if an alias exists
IsConnectedTests to see if the world is connected to the MUD server
IsLogOpenTests to see if a log file is open
IsPluginInstalledChecks to see if a particular plugin is installed3.23
IsTimerTests to see if a timer exists
IsTriggerTests to see if a trigger exists
LoadPluginLoads a plugin from disk3.23
LogInputThe property of whether commands are logged to the log file
LogNotesThe property of whether notes are logged to the log file
LogOutputThe property of whether MUD output is logged to the log file
LogSendSends a message to the MUD and logs it3.25
MakeRegularExpressionConverts wildcard matching text to a regular expression3.54
MapColourChanges the colour mapping - the way colours are displayed3.54
MapColourListReturns an array of all the mapped colours3.54
MappingA flag to indicate whether we are mapping the world
MenuCreates a pop-up menu inside the command window4.64
MetaphoneReturns the metaphone code for the supplied word3.81
MoveMainWindowMove and resize the main MUSHclient window3.54
MoveNotepadWindowMove and resize the specified notepad window3.54
MoveWorldWindowMove and resize a world window3.54
MoveWorldWindowXMove and resize a specific world window3.66
MtRandReturns pseudo-random number using the Mersenne Twister algorithm3.57
MtSrandSeed the Mersenne Twister pseudo-random number generator3.57
NormalColourGets/sets the RGB colour for one of the 8 ANSI normal colours
NoteSends a note to the output window
NoteColourChooses which custom colour will be used for world notes.
NoteColourBackChooses which RGB colour will be used for world notes - background colour
NoteColourForeChooses which RGB colour will be used for world notes - text colour
NoteColourNameChooses which RGB colour name will be used for world notes - text and background
NoteColourRGBChooses which RGB colour will be used for world notes - text and background
NoteHrDraws a horizontal rule in the output window3.66
NotepadColourChanges the text and background colour of the selected notepad window3.57
NotepadFontChanges the font and style of the selected notepad window3.57
NotepadReadOnlyMake a selected notepad window read-only4.30
NotepadSaveMethodChanges the save method for this notepad window3.76
NoteStyleSets the style for notes3.42
OpenOpens a named document
OpenBrowserOpens a supplied URL in your default web browser3.74
OpenLogOpens a log file.
PasteCommandPastes text into the command window, replacing the current selection3.69
PauseTurns pause mode on or off
PickColourInvokes the MUSHclient colour picker dialog3.22
PlaySoundPlays a sound using DirectSound4.28
PluginSupportsChecks if a plugin supports a particular routine3.23
PushCommandPushes the current command into the command history list3.18
QueueQueues a command for sending at the "speed walk" rate.
ReadNamesFileLoads in a file for generating character names
RedrawSchedules a redraw for all windows for this world
ReloadPluginReloads an installed plugin3.50
RemoveBacktracksRemoves backtracks from a speed walk string3.48
RemoveMapReversesA flag to indicate whether we backtracks are removed during mapping
RepaintForces an immediate redraw for all windows for this world4.35
ReplaceReplaces one substring with another
ReplaceNotepadReplaces text in a notepad window
ResetResets all outstanding MXP/Pueblo tags
ResetIPResets the cached IP address of the world and proxy server3.73
ResetStatusTimeResets the time elapsed shown on the status bar3.46
ResetTimerResets a named timer
ResetTimersResets all timers
ReverseSpeedwalkReverses a speed walk string
RGBColourToNameConverts an RGB colour code to its equivalent name3.22
SaveSaves world configuration.
SaveNotepadSaves a notepad window to disk3.29
SaveStateSaves the state of the current plugin
SelectCommandSelects (highlights) the current command in the command window3.18
SendSends a message to the MUD
SendImmediateSends a message to the MUD immediately, bypassing the speedwalk queue3.41
SendNoEchoSends a message to the MUD without echoing in the output window3.41
SendPktSends a low-level packet of data to the MUD3.81
SendPushSends a message to the MUD and saves it in the command history buffer3.27
SendSpecialSends a message to the MUD with various options4.14
SendToNotepadCreates a notepad and sends text to it
SetAliasOptionSets the value of a named alias option3.29
SetAlphaOptionSets value of a named world alphanumeric option3.22
SetBackgroundColourSets a background colour for the output window4.35
SetBackgroundImageSets a background image for the output window4.35
SetChangedSets or clears the "document has changed" flag3.60
SetChatOptionSets the value of a chat session option3.37
SetClipboardSets the clipboard contents3.66
SetCommandSends text to the command window
SetCommandSelectionSelects specified columns in the command window4.38
SetCommandWindowHeightSet the height of the command (input) window4.28
SetCursorChanges the shape of the mouse cursor4.40
SetCustomColourNameSets the name of a custom colour4.03
SetEntitySets the value of an MXP entity3.66
SetForegroundImageSets a foreground image for the output window4.35
SetFrameBackgroundColourSets the background colour of the overall MUSHclient frame5.07
SetInputFontSets the font for the input window
SetMainTitleSets the main output window title4.87
SetNotesSets the notes for the world.
SetOptionSets value of a named world option
SetOutputFontSets the font for the output window.
SetScrollSets the scroll bar position, and hides or shows it4.60
SetSelectionSets a selection range in the output window5.07
SetStatusSets the status line text
SetTimerOptionSets the value of a named timer option3.29
SetTitleSets the world window title4.87
SetToolBarPositionSets the position of the game toolbars on the screen.4.29
SetTriggerOptionSets the value of a named trigger option3.29
SetUnseenLinesSets the number of "unseen lines" for this world5.06
SetVariableSets the value of a variable
SetWorldWindowStatusChanges the status of the current world window4.60
ShiftTabCompleteItemAdds an item to the list shown for Shift+Tab completion4.30
ShowInfoBarShows or hides the "info" tool bar3.29
SimulateSimulate input from the MUD, for debugging purposes3.73
SoundPlays a sound
SpeedWalkDelayThe number of milliseconds delay between speed walk commands
SpellCheckSpell checks an arbitrary string of text3.54
SpellCheckCommandSpell checks the text in the command window3.54
SpellCheckDlgSpell checks an arbitrary string of text, invloking the spell-checker dialog3.85
StopEvaluatingTriggersStops trigger evaluation4.89
StopSoundStop playing a sound started by PlaySound4.28
StripANSIStrips ANSI colour sequences from a string3.37
TellSends a message to the output window - not terminated by a newline
TextRectangleSpecifies the size of the rectangle in which text is displayed in the output window.4.35
TraceTrace mode property
TraceOutOutputs the supplied message to the world Trace3.68
TranslateDebugSends a debugging message to the localizing translator script4.12
TranslateGermanTranslate German umluat sequences3.50
TransparencySets the transparency of the main MUSHclient window under Windows XP3.83
TrimTrims leading and trailing spaces from a string
UdpListenListens for incoming packets using the UDP protocol3.56
UdpPortListReturns an array of all the UDP ports in use by this world3.60
UdpSendSends a packet over the network using the UDP protocol3.56
UnloadPluginUnloads an installed plugin4.73
VersionGets the MUSHclient version string.
WindowAddHotspotAdds a hotspot to a miniwindow4.34
WindowArcDraws an arc in a miniwindow4.34
WindowBezierDraws a Bézier curve in a miniwindow4.34
WindowBlendImageBlends an image into a miniwindow, using a specified blending mode4.35
WindowCircleOpDraws ellipses, filled rectangles, round rectangles, chords, pies in a miniwindow4.34
WindowCreateCreates a miniwindow4.34
WindowCreateImageCreates an image in a miniwindow4.34
WindowDeleteDeletes a miniwindow4.37
WindowDeleteAllHotspotsDeletes all hotspots from a miniwindow4.34
WindowDeleteHotspotDeletes a hotspot from a miniwindow4.34
WindowDragHandlerAdds a drag handler to a miniwindow hotspot4.40
WindowDrawImageDraws an image into a miniwindow4.34
WindowDrawImageAlphaDraws an image into a miniwindow respecting the alpha channel4.42
WindowFilterPerforms a filtering operation over part of the miniwindow.4.35
WindowFontLoads a font into a miniwindow4.34
WindowFontInfoReturns information about a font4.34
WindowFontListLists all fonts loaded into a miniwindow4.34
WindowGetImageAlphaDraws the alpha channel of an image into a miniwindow4.52
WindowGetPixelGets the colour of a single pixel in a miniwindow4.36
WindowGradientDraws a gradient in a rectangle4.35
WindowHotspotInfoReturns information about a hotspot4.34
WindowHotspotListLists all hotspots installed into a miniwindow4.34
WindowHotspotTooltipChanges the tooltip text for a hotspot in a miniwindow4.41
WindowImageFromWindowCreates an image from another miniwindow4.35
WindowImageInfoReturns information about an image4.34
WindowImageListLists all images installed into a miniwindow4.34
WindowImageOpDraws an ellipse, rectangle or round rectangle, filled with an image4.34
WindowInfoReturns information about a miniwindow4.34
WindowLineDraws a line in a miniwindow4.34
WindowListLists all miniwindows4.34
WindowLoadImageLoads an image into a miniwindow from a disk file4.34
WindowMenuCreates a pop-up menu inside a miniwindow4.37
WindowMergeImageAlphaMerges an image into a miniwindow based on an alpha mask4.36
WindowMoveHotspotMoves a hotspot in a miniwindow4.58
WindowPolygonDraws a polygon in a miniwindow4.34
WindowPositionMoves a miniwindow4.34
WindowRectOpDraws a rectangle in a miniwindow4.34
WindowResizeResizes a miniwindow4.58
WindowScrollwheelHandlerAdds a scroll-wheel handler to a miniwindow hotspot4.52
WindowSetPixelSets a single pixel in a miniwindow to the specified colour4.36
WindowSetZOrderSets the Z-Order for a miniwindow4.73
WindowShowShows or hides a miniwindow4.34
WindowTextDraws text into a miniwindow4.34
WindowTextWidthCalculates the width of text in a miniwindow4.34
WindowTransformImageDraws an image into a miniwindow with optional rotation, scaling, reflection and shearing4.59
WindowWriteWrites the contents of a miniwindow to disk as a graphics file4.36
WorldAddressReturns the TCP/IP address of the current world.
WorldNameGets the world's name
WorldPortReturns the port number of the current world.
WriteLogWrites to the log file