MUSHclient script functions
Click on a link to see details about that function.
| Function | Description | Version |
|---|---|---|
| AcceleratorTo | Add or modify an accelerator key - with "Send To" parameter | 4.27 |
| ArrayCount | Returns the number of arrays | 3.46 |
| ArrayDelete | Deletes an array | 3.46 |
| BroadcastPlugin | Broadcasts a message to all installed plugins | 3.67 |
| CallPlugin | Calls a routine in a plugin | 3.23 |
| ChangeDir | Changes the MUSHclient working directory | 3.80 |
| ChatCall | Calls a chat server (makes an outgoing call) using the MudMaster chat protocol | 3.37 |
| ChatCallzChat | Calls a zChat chat server (makes an outgoing call) | 3.39 |
| ChatDisconnect | Disconnects a current chat call | 3.37 |
| ChatDisconnectAll | Disconnects all current chat calls | 3.37 |
| ChatMessage | Sends a message to a chat user (raw format) | 3.37 |
| ChatNote | Does a note using ANSI codes for the chat system | 3.37 |
| Debug | Displays debugging information about the world | |
| DeleteAliasGroup | Deletes a group of aliases | 3.29 |
| DeleteGroup | Deletes a group of triggers, aliases and timers | 3.29 |
| DeleteLines | Clears some recent lines from the output window. | 3.76 |
| DeleteTimerGroup | Deletes a group of timers | 3.29 |
| DeleteTriggerGroup | Deletes a group of triggers | 3.29 |
| DoCommand | Queues a MUSHclient menu command | 3.39 |
| EnableAliasGroup | Enables/disables a group of aliases | 3.27 |
| EnableGroup | Enables/disables a group of triggers, aliases and timers | 3.27 |
| EnablePlugin | Enables or disables the specified plugin | |
| EnableTimerGroup | Enables/disables a group of timers | 3.27 |
| EnableTriggerGroup | Enables/disables a group of triggers | 3.27 |
| GetAliasOption | Gets the value of a named alias option | 3.29 |
| GetInfo | Gets information about the current world | 3.18 |
| GetPluginAliasInfo | Gets details about a named alias for a specified plugin | 3.23 |
| GetPluginAliasList | Gets the list of aliases in a specified plugin | 3.23 |
| GetPluginAliasOption | Gets the value of a named alias option for a specified plugin | 4.21 |
| GetPluginID | Returns the 24-character ID of the current plugin | 3.23 |
| GetPluginInfo | Gets details about a specified plugin | 3.23 |
| GetPluginList | Gets a list of installed plugins. | 3.23 |
| GetPluginName | Returns the name of the current plugin | 3.23 |
| GetPluginTimerInfo | Gets details about a named timer for a specified plugin | 3.23 |
| GetPluginTimerList | Gets the list of timers in a specified plugin | 3.23 |
| GetPluginTimerOption | Gets the value of a named timer option for a specified plugin | 4.21 |
| GetPluginTriggerInfo | Gets details about a named trigger for a specified plugin | 3.23 |
| GetPluginTriggerList | Gets the list of triggers in a specified plugin | 3.23 |
| GetPluginTriggerOption | Gets the value of a named trigger option for a specified plugin | 4.21 |
| GetPluginVariable | Gets the contents of a variable belonging to a plugin | 3.23 |
| GetPluginVariableList | Gets the list of variables in a specified plugin | 3.23 |
| GetTimerOption | Gets the value of a named timer option | 3.29 |
| GetTriggerInfo | Gets details about a named trigger | |
| GetTriggerList | Gets the list of triggers | |
| GetTriggerOption | Gets the value of a named trigger option | 3.29 |
| GetUdpPort | Find a free port for UDP listening | 3.66 |
| GetUniqueID | Creates a unique ID for general use, or for making Plugin IDs | 3.23 |
| GetVariable | Gets the contents of a variable | |
| Hyperlink | Creates a hyperlink in the output window | 3.41 |
| ImportXML | Imports configuration data in XML format | 3.39 |
| IsPluginInstalled | Checks to see if a particular plugin is installed | 3.23 |
| LoadPlugin | Loads a plugin from disk | 3.23 |
| MtRand | Returns pseudo-random number using the Mersenne Twister algorithm | 3.57 |
| NotepadSaveMethod | Changes the save method for this notepad window | 3.76 |
| PluginSupports | Checks if a plugin supports a particular routine | 3.23 |
| ReloadPlugin | Reloads an installed plugin | 3.50 |
| Save | Saves world configuration. | |
| SaveState | Saves the state of the current plugin | |
| SendPkt | Sends a low-level packet of data to the MUD | 3.81 |
| SetAliasOption | Sets the value of a named alias option | 3.29 |
| SetChatOption | Sets the value of a chat session option | 3.37 |
| SetTimerOption | Sets the value of a named timer option | 3.29 |
| SetTriggerOption | Sets the value of a named trigger option | 3.29 |
| SetVariable | Sets the value of a variable | |
| SpellCheckCommand | Spell checks the text in the command window | 3.54 |
| StopEvaluatingTriggers | Stops trigger evaluation | 4.89 |
| TraceOut | Outputs the supplied message to the world Trace | 3.68 |
| UdpListen | Listens for incoming packets using the UDP protocol | 3.56 |
| UdpPortList | Returns an array of all the UDP ports in use by this world | 3.60 |
| UnloadPlugin | Unloads an installed plugin | 4.73 |
| WindowAddHotspot | Adds a hotspot to a miniwindow | 4.34 |
| WindowCreate | Creates a miniwindow | 4.34 |
| WindowInfo | Returns information about a miniwindow | 4.34 |
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.
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
![[Back]](/images/back.gif){kind=small}
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.