Utilities
There are various utility functions built into MUSHclient, some of which are in the built-in notepad.

Follow the links below for more details.


See Also ...

Topic

DOC_scripting Scripting

Commands

CMD_ID_CONVERT_BASE64DECODE Base64Decode (Decodes Base-64 coding)
CMD_ID_CONVERT_BASE64ENCODE Base64Encode (Encodes text into Base-64 coding)
CMD_ID_EDIT_CONVERTCLIPBOARDFORUMCODES ConvertForumCodes (Converts text on the clipboard for use in the forum)
CMD_ID_CONVERT_CONVERTHTMLSPECIAL ConvertHTMLspecial (Converts special HTML characters, eg. < to &lt;)
CMD_ID_CONVERT_DOSTOMAC DosToMac (Converts selection from DOS text to Mac text)
CMD_ID_CONVERT_DOSTOUNIX DosToUnix (Converts selection from DOS text to Unix text)
CMD_ID_GAME_FUNCTIONSLIST FunctionList (Shows a list of all scripting functions)
CMD_ID_EDIT_GENERATECHARACTERNAME GenerateCharacterName (Generates a random MUD character name)
CMD_ID_EDIT_GENERATEUNIQUEID GenerateUniqueID (Generates a 24-character hashed unique string)
CMD_ID_INPUT_KEYNAME KeyName (Converts a keypress into its name)
CMD_ID_CONVERT_MACTODOS MacToDos (Converts selection from Mac text to DOS text)
CMD_ID_CONVERT_QUOTEFORUMCODES QuoteForumCodes (Escapes the characters [, ], \ with a backslash.)
CMD_ID_CONVERT_QUOTELINES QuoteLines (Adds '> ' to the start of each line)
CMD_ID_CONVERT_UNIXTODOS UnixToDos (Converts selection from Unix text to DOS text)
CMD_ID_CONVERT_UPPERCASE UpperCase (Converts to all upper case)

Dialogs

DLG_IDD_LUA_CHOOSE Choose from combo-box
DLG_IDD_LUA_CHOOSE_LIST Choose from list box
DLG_IDD_COLOUR_PICKER Colour picker
DLG_IDD_FUNCTION_LIST Functions
DLG_IDD_GENERATE_UNIQUE_ID Generate Unique ID
DLG_IDD_LUA_INPUTBOX Input Box
DLG_IDD_LUA_INPUTEDIT Input Edit Box
DLG_IDD_KEY_NAME Key name

Functions

FNC_Base64Decode Base64Decode (Takes a base-64 encoded string and decodes it.)
FNC_Base64Encode Base64Encode (Encodes a string using base-64 encoding.)
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_FixupEscapeSequences FixupEscapeSequences (Converts "escape sequences" like &#x5C;t to their equivalent codes.)
FNC_FixupHTML FixupHTML (Fixes up text for writing as HTML)
FNC_GenerateName GenerateName (Generates a random character name)
FNC_GetClipboard GetClipboard (Gets the clipboard contents)
FNC_GetScriptTime GetScriptTime (Returns the amount of time spent in script routines)
FNC_GetUniqueID GetUniqueID (Creates a unique ID for general use, or for making Plugin IDs)
FNC_GetUniqueNumber GetUniqueNumber (Returns a unique number)
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_MtRand MtRand (Returns pseudo-random number using the Mersenne Twister algorithm)
FNC_MtSrand MtSrand (Seed the Mersenne Twister pseudo-random number generator)
FNC_ReadNamesFile ReadNamesFile (Loads in a file for generating character names)
FNC_Replace Replace (Replaces one substring with another)
FNC_SetClipboard SetClipboard (Sets the clipboard contents)
FNC_SetStatus SetStatus (Sets the status line text)
FNC_Simulate Simulate (Simulate input from the MUD, for debugging purposes)
FNC_Sound Sound (Plays a sound)
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_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: general=utils)

DOC_contents Documentation contents page