MUSHclient script functions

Click on a link to see details about that function.

Function	Description	Version
ANSI	Generates an ANSI colour sequence	3.37
ChatAcceptCalls	Accepts incoming chat calls	3.37
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
ChatEverybody	Sends a chat message to every connected chat user	3.37
ChatGetID	Looks up what chat ID (identifier) corresponds to a particular chat name	3.37
ChatGroup	Sends a chat message to every connected chat user in the specified group	3.37
ChatID	Sends a chat message to a particular chat session	3.37
ChatMessage	Sends a message to a chat user (raw format)	3.37
ChatNameChange	Changes your chat name	3.37
ChatNote	Does a note using ANSI codes for the chat system	3.37
ChatPasteEverybody	Pastes the clipboard contents to every connected person	3.37
ChatPasteText	Pastes the clipboard contents to that person	3.37
ChatPeekConnections	Sends a "peek connections" message to the specified chat user	3.37
ChatPersonal	Sends a chat message to a particular person	3.37
ChatPing	Sends a ping message to the specified chat user	3.37
ChatRequestConnections	Sends a "request connections" message to the specified chat user	3.37
ChatSendFile	Starts sending a file to the specified chat user	3.37
ChatStopAcceptingCalls	Stops this world from accepting chat calls	3.37
ChatStopFileTransfer	Stops a file transfer in progress to that chat user	3.37
DoCommand	Queues a MUSHclient menu command	3.39
Execute	Executes a command as if you had typed it into the command window	3.35
ExportXML	Exports a world item in XML format	3.41
GetChatInfo	Get information about a chat connection	3.37
GetChatList	Gets the list of chat sessions	3.37
GetChatOption	Gets the value of a chat session option	3.37
GetHostAddress	Returns a list of IP addresses that correspond to a host name on the Internet	3.39
Hyperlink	Creates a hyperlink in the output window	3.41
ReloadPlugin	Reloads an installed plugin	3.50
SetChatOption	Sets the value of a chat session option	3.37
StripANSI	Strips ANSI colour sequences from a string	3.37
UnloadPlugin	Unloads an installed plugin	4.73

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

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