[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.Help


Name Help
Type Method
Summary Shows help for a script function, or a list of functions
Prototype void Help(BSTR Name);

View list of data type meanings

Description

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.

eg.

/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.

eg.

/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.

eg.

/Help "lua"

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.


VBscript example
Help "colournote"
Jscript example
Help ("colournote")
Lua example
Help "colournote"
Help "lua io"
Lua notes
The argument is optional.
Returns Nothing.
Introduced in version 3.70

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.

Search for:   

Leave blank to show all functions.


Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes


Function prototypes

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


View all functions

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]