MUSHclient scripting functions

• Alphabetic list of all script methods and properties
• Return values
• Prototype meanings
• Plugin callback functions
• Script engines you can download

Search for script function

Enter a word (eg. "trigger") 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 have examples given that can be typed directly into the "command" window. To do this, precede the example with the "script prefix" character, which defaults to "/".

Lengthier examples are supplied in the files exampscript.vbs (VBscript), exampscript.jvs (JScript), exampscript.pl (PerlScript) and exampscript.pys (Python), which are part of the MUSHclient install.

Downloads

• VBscript and Javascript version 5.6 (Windows 95/98/ME/NT 4): http://download.microsoft.com/download/winscript56/Install/5.6/W9XNT4Me/EN-US/scr56en.exe
• VBscript and Javascript version 5.6 (Windows 2000): Vhttp://download.microsoft.com/download/winscript56/Install/5.6/NT5/EN-US/scripten.exe
• Help files for VBscript and Javascript version 5.6: http://download.microsoft.com/download/winscript56/Install/5.6/W982KMeXP/EN-US/scrdoc56en.exe
• PerlScript: http://www.ActiveState.com/ActivePerl/download.htm
• Python: http://www.ActiveState.com/ActivePython/download.htm

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

Comments to Gammon Software support