Description of MUSHclient world function: world.ErrorDesc
Name | ErrorDesc |
---|---|
Type | Method |
Summary | Converts a MUSHclient script error code into an human-readable description |
Prototype | BSTR ErrorDesc(long Code);
|
Description | This function converts a return code (such as 30008) into a human-readable form ("The name of this object is invalid"). Note: Available in version 3.68 onwards. |
VBscript example |
|
Jscript example |
|
Lua example |
|
Lua notes |
|
Returns | 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. |
Introduced in version | 3.68 |
Enter a word or phrase in the box below to narrow the list down to those that match.
The function name, prototype, summary, and description are searched.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise of the function.
You can view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
You can view a list of the data types used in function prototypes
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.