ErrorDesc
Script function

world.ErrorDesc

DOC_scripting Read about scripting

Type

Method

Summary

Converts a MUSHclient script error code into an human-readable description

Prototype

BSTR ErrorDesc(long Code);

DOC_data_types 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

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

DOC_scripting Scripting
DOC_utils Utilities

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_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: function=ErrorDesc)

DOC_contents Documentation contents page