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

MUSHclient scripting

Description of MUSHclient world function: world.ChatPeekConnections


Name ChatPeekConnections
Type Method
Summary Sends a "peek connections" message to the specified chat user
Prototype long ChatPeekConnections(long ID);

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.


Note: Available in version 3.37 onwards.


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"))
Returns eChatIDNotFound: That chat ID is not currently connected.
eOK: Peek message sent.

View list of return code meanings

Introduced in version 3.37

See also ...

Function Description
ChatMessage Sends a message to a chat user (raw format)
ChatRequestConnections Sends a "request connections" message to the specified chat user

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]