Script function
world.ErrorDesc
Read about scripting
Type
Method
Summary
Converts a MUSHclient script error code into an human-readable description
Prototype
BSTR ErrorDesc(long Code);
View list of data type meanings
Description
This function converts a return code (such as 30008) into a human-readable form ("The name of this object is invalid").
The purpose is to allow scripts which fail to detect the reason and display it in human-readable form.
eg. (in VBscript)
result = SetVariable ("***", "abc")
if result <> 0 then
Note ErrorDesc (result)
end if
Available in MUSHclient version 3.68 onwards.
VBscript example
result = SetVariable ("***", "abc")
if result <> 0 then
Note ErrorDesc (result)
end if
Jscript example
result = SetVariable ("***", "abc");
if (result != 0)
{
Note (ErrorDesc (result))
}
Lua example
result = SetVariable ("***", "abc");
if result ~= 0 then
Note (ErrorDesc (result))
end -- if
Lua notes
In Lua, it is simpler to use the error_desc table, which is available in earlier versions of MUSHclient also.
eg.
result = SetVariable ("***", "abc");
if result ~= 0 then
Note (error_desc [result])
end -- if
This is simply a table-lookup in Lua, rather than a call to a MUSHclient function.
Return value
A string containing the code converted to human-readable form, or the supplied argument converted to a string if the code is not in MUSHclient's internal list of error codes. At present, the range of codes that will be converted is 0, and 30001 to 30062.
See Also ...
Topics
Scripting
Utilities
Functions
(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
(ExportXML) Exports a world item in XML format
(FilterPixel) Performs a filtering operation on one pixel
(FixupEscapeSequences) Converts "escape sequences" like \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
(ShiftTabCompleteItem) Adds an item to the list shown for Shift+Tab completion
(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=ErrorDesc)