Script function

world.ChatDisconnect

Type

Method

Summary

Disconnects a current chat call

Prototype

long ChatDisconnect(long ID);

Description

Disconnects an existing chat call.

The call is identified by its "chat ID" - each chat session has a unique ID, which starts at one, and is incremented by one, per world.

You can use GetChatList to find a list of chat IDs that is current.

You can use ChatGetID to find the chat ID corresponding to a particular chat name.

If a file transfer is in progress it is aborted.

The plugin callback routine "OnPluginChatUserDisconnect" will be called for this user.

Available in MUSHclient version 3.37 onwards.

VBscript example

ChatDisconnect 5  ' disconnect chat user 5
ChatDisconnect ChatGetID ("nick")  ' disconnect nick

Jscript example

ChatDisconnect (5);  // disconnect chat user 5
ChatDisconnect (ChatGetID ("nick"));  // disconnect nick

PerlScript example

ChatDisconnect (5);  #/ disconnect chat user 5
ChatDisconnect (ChatGetID ("nick"));  # disconnect nick

Python example

world.ChatDisconnect (5)  # disconnect chat user 5
world.ChatDisconnect (world.ChatGetID ("nick"))  # disconnect nick

Lua example

ChatDisconnect (5)  -- disconnect chat user 5
ChatDisconnect (ChatGetID ("nick"))  -- disconnect nick

Return value

eChatIDNotFound: That chat ID was not found
eOK: Disconnected OK

See Also ...

Topics

Chat system
Getting started

Functions

(ChatAcceptCalls) Accepts incoming chat calls
(ChatCall) Calls a chat server (makes an outgoing call) using the MudMaster chat protocol
(ChatCallzChat) Calls a zChat chat server (makes an outgoing call)
(ChatDisconnectAll) Disconnects all current chat calls
(ChatEverybody) Sends a chat message to every connected chat user
(ChatGetID) Looks up what chat ID (identifier) corresponds to a particular chat name
(ChatGroup) Sends a chat message to every connected chat user in the specified group
(ChatID) Sends a chat message to a particular chat session
(ChatMessage) Sends a message to a chat user (raw format)
(ChatNameChange) Changes your chat name
(ChatNote) Does a note using ANSI codes for the chat system
(ChatPasteEverybody) Pastes the clipboard contents to every connected person
(ChatPasteText) Pastes the clipboard contents to that person
(ChatPeekConnections) Sends a "peek connections" message to the specified chat user
(ChatPersonal) Sends a chat message to a particular person
(ChatPing) Sends a ping message to the specified chat user
(ChatRequestConnections) Sends a "request connections" message to the specified chat user
(ChatSendFile) Starts sending a file to the specified chat user
(ChatStopAcceptingCalls) Stops this world from accepting chat calls
(ChatStopFileTransfer) Stops a file transfer in progress to that chat user
(GetChatInfo) Get information about a chat connection
(GetChatList) Gets the list of chat sessions
(GetChatOption) Gets the value of a chat session option
(SetChatOption) Sets the value of a chat session option

(Help topic: function=ChatDisconnect)