ChatPeekConnections
Script function

world.ChatPeekConnections

DOC_scripting Read about scripting

Type

Method

Summary

Sends a "peek connections" message to the specified chat user

Prototype

long ChatPeekConnections(long ID);

DOC_data_types View list of data type meanings

Description

Requests the specified chat user to send a list of its public connections. This is the same as doing this:

ChatMessage ID, 28, ""

The chat user who receives that will (should) respond with a list of their current chat connections that they have (excluding the connection to you), so you can see who else they are chatting with.

If you want to connect to those users automatically, use ChatRequestConnections.

VBscript example

ChatPeekConnections ChatGetID ("nick")


Jscript example

ChatPeekConnections (ChatGetID ("nick"));


PerlScript example

ChatPeekConnections (ChatGetID ("nick"));


Python example

world.ChatPeekConnections (world.ChatGetID ("nick"))


Lua example

ChatPeekConnections (ChatGetID ("nick"))


Return value

eChatIDNotFound: That chat ID is not currently connected.
eOK: Peek message sent.


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_ChatDisconnect ChatDisconnect (Disconnects a current chat 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_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=ChatPeekConnections)

DOC_contents Documentation contents page