ChatDisconnect
Script function

world.ChatDisconnect

DOC_scripting Read about scripting

Type

Method

Summary

Disconnects a current chat call

Prototype

long ChatDisconnect(long ID);

DOC_data_types View list of data type meanings

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.

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


DOC_errors View list of return code meanings

See Also ...

Topics

DOC_chat Chat system
DOC_starting Getting started

Functions

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

(Help topic: function=ChatDisconnect)

DOC_contents Documentation contents page