Help
Script function world.Help Read about scripting 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` VBscript example
    Help "colournote"
Jscript example
    Help ("colournote")
Lua example
    Help "colournote"
    Help "lua io"
Lua notes
    The argument is optional.
Return value
    Nothing.
See Also ... Topics Scripting Utilities Functions Base64Decode (Takes a base-64 encoded string and decodes it.) Base64Encode (Encodes a string using base-64 encoding.) ChangeDir (Changes the MUSHclient working directory) CreateGUID (Creates a GUID - Global Unique Identifier) EditDistance (Returns the Levenshtein Edit Distance between two words) ErrorDesc (Converts a MUSHclient script error code into an human-readable description) ExportXML (Exports a world item in XML format) FixupEscapeSequences (Converts "escape sequences" like &#x5C;t to their equivalent codes.) FixupHTML (Fixes up text for writing as HTML) GenerateName (Generates a random character name) GetClipboard (Gets the clipboard contents) GetScriptTime (Returns the amount of time spent in script routines) GetUniqueID (Creates a unique ID for general use, or for making Plugin IDs) GetUniqueNumber (Returns a unique number) Hash (Produces a hash (checksum) of a specified piece of text) ImportXML (Imports configuration data in XML format) Metaphone (Returns the metaphone code for the supplied word) MtRand (Returns pseudo-random number using the Mersenne Twister algorithm) MtSrand (Seed the Mersenne Twister pseudo-random number generator) ReadNamesFile (Loads in a file for generating character names) Replace (Replaces one substring with another) SetClipboard (Sets the clipboard contents) SetStatus (Sets the status line text) Simulate (Simulate input from the MUD, for debugging purposes) Sound (Plays a sound) StripANSI (Strips ANSI colour sequences from a string) Trace (Trace mode property) TraceOut (Outputs the supplied message to the world Trace) TranslateGerman (Translate German umluat sequences) Transparency (Sets the transparency of the main MUSHclient window under Windows XP) Trim (Trims leading and trailing spaces from a string) (Help topic: function=Help) Documentation contents page