world.ChatPeekConnections

MUSHclient script function (Method) — introduced in version 3.37

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

Prototype

long ChatPeekConnections(long ID);

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.

Return code meanings

Related topic

Chat system

See also

FunctionDescription
ChatMessageSends a message to a chat user (raw format)
ChatRequestConnectionsSends a "request connections" message to the specified chat user