world.ErrorDesc

MUSHclient script function (Method) — introduced in version 3.68

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

Prototype

BSTR ErrorDesc(long Code);

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.