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

MUSHclient scripting

Description of MUSHclient world function: world.ChatDisconnect


Name ChatDisconnect
Type Method
Summary Disconnects a current chat call
Prototype long ChatDisconnect(long ID);

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.


Note: Available in 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
Returns eChatIDNotFound: That chat ID was not found
eOK: Disconnected OK

View list of return code meanings

Introduced in version 3.37

See also ...

Function Description
ChatAcceptCalls Accepts incoming chat calls
ChatCall Calls a chat server (makes an outgoing call) using the MudMaster chat protocol
ChatDisconnectAll Disconnects all current chat calls
ChatGetID Looks up what chat ID (identifier) corresponds to a particular chat name
ChatStopAcceptingCalls Stops this world from accepting chat calls
GetChatList Gets the list of chat sessions

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

[Back]

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.

[Home]


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