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

Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.Debug

Name Debug
Type Method
Summary Displays debugging information about the world
Prototype VARIANT Debug(BSTR Command);

You can use this to quickly list things of interest about the world.

You can currently get the following information:

"actions" - things like hyperlinks that do something

"aliases" - list of world aliases

"alpha_options" - the world's alpha (string) options, and their values

"ansi" - lists the ANSI colours defined in the ANSI configuration tab (with swatches)

"arrays" - list of world arrays (see ArrayCreate)

"colours" - known colour names, (with swatches) and RGB codes etc.

"colours256" - list of extended ANSI colours (with swatches)

"commands" - lists command history

"custom_colours - lists the 16 custom colours along with their names (with swatches)

"entities" - lists known MXP entities with what the translate to

"global_options" - list of global options and their values

"included_options" - list of options set by included files

"info" - lists all GetInfo items and associated values

"internal_commands" - lists commands that can be done with DoCommand

"options" - the world's numeric options, and their values

"option_info" - list of alpha/numeric options and their ranges

"plugins" - lists information for each plugin (aliases, triggers, etc.)

"server_elements" - lists MXP elements defined by the MUD server

"server_entities" - lists MXP entities defined by the MUD server

"summary" - summarizes triggers, aliases, world info, plugins, miniwindows

"triggers" - list of world triggers

"variables" - list of world variables

eg. /world.Debug "aliases"

To find the list without referring to this web page, just type:

/world.Debug ""

VBscript example
/world.Debug "colours"
Jscript example
/world.Debug ("colours");
PerlScript example
/$world->Debug ("colours");
Python example
world.Debug ("colours")
Lua example
Debug ("colours")
Returns Returns a variant, however it is not used at present. The debug information is displayed in the world window.

See also ...

Function Description
Simulate Simulate input from the MUD, for debugging purposes

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


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.


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 HostDash]