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

MUSHclient scripting

Description of MUSHclient world function: world.ChatPing

Name ChatPing
Type Method
Summary Sends a ping message to the specified chat user
Prototype long ChatPing(long ID);

View list of data type meanings


This sends a "ping request" chat message (26) (not an ICMP message) to the specified chat user. They should response by echoing the message back with a "ping response" message type (27).

MUSHclient makes a note of the time the ping message was sent, so that when the ping response arrives, it can work out how long the ping took for the round trip.

Note: Available in version 3.37 onwards.

VBscript example
ChatPing ChatGetID ("john")
Jscript example
ChatPing (ChatGetID ("john"));
PerlScript example
ChatPing (ChatGetID ("john"));
Python example
world.ChatPing (world.ChatGetID ("john"))
Lua example
ChatPing (ChatGetID ("john"))
Returns eChatIDNotFound: The chat ID was not connected.
eOK: Ping message sent.

View list of return code meanings

Introduced in version 3.37

See also ...

Function Description
ChatGetID Looks up what chat ID (identifier) corresponds to a particular chat name
ChatMessage Sends a message to a chat user (raw format)

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


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.


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]