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

MUSHclient scripting

Description of MUSHclient world function: world.ChatCallzChat


Name ChatCallzChat
Type Method
Summary Calls a zChat chat server (makes an outgoing call)
Prototype long ChatCallzChat(BSTR Server, long Port);

View list of data type meanings

Description

Attempts to establish a chat call to another client using the zChat protocol.

Use ChatCall to call using the MudMaster chat 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 "ZCHAT:" 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.


Note: Available in version 3.39 onwards.


VBscript example
ChatCallzChat "123.45.67.89", 0     ' call on default port
ChatCallzChat "123.45.67.89", 4060  ' call on port 4060
ChatCallzChat "myfriend.hisdomain.com", 0    ' call on default port using name
Jscript example
ChatCallzChat ("123.45.67.89", 0);     // call on default port
ChatCallzChat ("123.45.67.89", 4060);  // call on port 4060
ChatCallzChat ("myfriend.hisdomain.com", 0);    // call on default port using name
PerlScript example
ChatCallzChat ("123.45.67.89", 0);     # call on default port
ChatCallzChat ("123.45.67.89", 4060);  # call on port 4060
ChatCallzChat ("myfriend.hisdomain.com", 0);    # call on default port using name
Python example
world.ChatCallzChat ("123.45.67.89", 0)     # call on default port
world.ChatCallzChat ("123.45.67.89", 4060)  # call on port 4060
world.ChatCallzChat ("myfriend.hisdomain.com", 0)    # call on default port using name
Lua example
ChatCallzChat ("123.45.67.89")     -- call on default port
ChatCallzChat ("123.45.67.89", 4060)  -- call on port 4060
ChatCallzChat ("myfriend.hisdomain.com")    -- call on default port using name
Lua notes
The Port argument is optional. If omitted it defaults to 4050.
Returns 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

Introduced in version 3.39

See also ...

Function Description
ChatAcceptCalls Accepts incoming chat calls
ChatCall Calls a chat server (makes an outgoing call) using the MudMaster chat protocol
ChatDisconnect Disconnects a current chat call
ChatDisconnectAll Disconnects all current chat calls
ChatStopAcceptingCalls Stops this world from accepting chat calls

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]