Description of MUSHclient world function: world.Help
||Shows help for a script function, or a list of functions
void Help(BSTR Name);
View list of data type meanings
This function is to help scripters quickly get information about script functions.
You can optionally supply a string argument. If the argument exactly matches a script function (case is not important) then the help for that function is shown.
/Help "colournote" --> show help for world.ColourNote
If the argument partially matches a script function, then the "functions help" dialog box will be displayed with that text as the filter.
/Help "trigger" --> show list of trigger-related functions
If the argument is empty then all script functions will be displayed.
The argument "lua" is a special case, and will show the help for all Lua-specific functions in MUSHclient.
You can also get help on Lua libraries by supplying "lua x" where x is the first letter of one of the standard Lua libraries, namely:
b - Base (not in a library)
c - Coroutines
d - Debug
i - Io
m - Math
o - Os
p - Package
r - Rex
s - String
t - Table
u - Utils
You can type more letters if you want, but only the first 5 are checked. eg.
/Help "lua io" -- (same as /Help "lua i")
In addition it also recognises:
/Help "lua bc" -- bc (bignum) library
Note: Available in version 3.70 onwards.
Help "lua io"
The argument is optional.
|Introduced in version
Search for script function
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.
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).
view a list of the data types used in function prototypes
View all functions
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.
Gammon Software support
Forum RSS feed ( https://gammon.com.au/rss/forum.xml )