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

ChatCall

Script function

world.ChatCall

Read about scripting

Type

Method

Summary

Calls a chat server (makes an outgoing call) using the MudMaster chat protocol

Prototype

long ChatCall(BSTR Server, long Port);

View list of data type meanings

Description

Attempts to establish a chat call to another client. If you know the other client is using zChat you may wish to use ChatCallzChat instead which uses the zChat protocol.

You specify the TCP/IP address and the port number. If the port number is zero the default chat port of 4050 is used.

Because of the asynchronous nature of TCP/IP a "good" status from this call does not necessarily mean you will establish a chat session, it just means it has succeeded in starting the process.

In order to establish a chat session, MUSHclient must:

1. Look up the name using the Domain Name Server (DNS) unless a dotted-decimal name was given - this may take a few seconds.
2. Connect to the chat server - this may take a few more seconds
3. Attempt to negotiate a chat session by sending "CHAT:" to the chat server
4. Await a response - this may take a while if the player at the other end is deciding whether to accept the connection or not.
5. Finally, if all goes well, the chat session is established.

To know if the session was really established you need to use the plugin callback routine "OnPluginChatNewUser" - this notifies you when a new user is established.


Available in MUSHclient version 3.37 onwards.



VBscript example

ChatCall "123.45.67.89", 0     ' call on default port
ChatCall "123.45.67.89", 4060  ' call on port 4060
ChatCall "myfriend.hisdomain.com", 0    ' call on default port using name


Jscript example

ChatCall ("123.45.67.89", 0);     // call on default port
ChatCall ("123.45.67.89", 4060);  // call on port 4060
ChatCall ("myfriend.hisdomain.com", 0);    // call on default port using name


PerlScript example

ChatCall ("123.45.67.89", 0);     # call on default port
ChatCall ("123.45.67.89", 4060);  # call on port 4060
ChatCall ("myfriend.hisdomain.com", 0);    # call on default port using name


Python example

world.ChatCall ("123.45.67.89", 0)     # call on default port
world.ChatCall ("123.45.67.89", 4060)  # call on port 4060
world.ChatCall ("myfriend.hisdomain.com", 0)    # call on default port using name


Lua example

ChatCall ("123.45.67.89")     -- call on default port
ChatCall ("123.45.67.89", 4060)  -- call on port 4060
ChatCall ("myfriend.hisdomain.com")    -- call on default port using name


Lua notes

The Port argument is optional. If omitted it defaults to 4050.


Return value

eCannotCreateChatSocket: Cannot start call - perhaps all sockets are in use?
eCannotLookupDomainName: Cannot start looking up domain name
eOK: Call process started OK

View list of return code meanings

See Also ...

Topics

Chat system
Getting started

Functions

(ChatAcceptCalls) Accepts incoming chat calls
(ChatCallzChat) Calls a zChat chat server (makes an outgoing call)
(ChatDisconnect) Disconnects a current chat 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=ChatCall)

Documentation contents page


Search ...

Enter a search string to find matching documentation.

Search for:   

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]