Script function
world.ChatPing
Read about scripting
Type
Method
Summary
Sends a ping message to the specified chat user
Prototype
long ChatPing(long ID);
View list of data type meanings
Description
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.
Available in MUSHclient 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"))
Return value
eChatIDNotFound: The chat ID was not connected.
eOK: Ping message sent.
View list of return code meanings
See Also ...
Topics
Chat system
Getting started
Functions
(ChatAcceptCalls) Accepts incoming chat calls
(ChatCall) Calls a chat server (makes an outgoing call) using the MudMaster chat protocol
(ChatCallzChat) Calls a zChat chat server (makes an outgoing call)
(ChatDisconnect) Disconnects a current chat call
(ChatDisconnectAll) Disconnects all current chat calls
(ChatEverybody) Sends a chat message to every connected chat user
(ChatGetID) Looks up what chat ID (identifier) corresponds to a particular chat name
(ChatGroup) Sends a chat message to every connected chat user in the specified group
(ChatID) Sends a chat message to a particular chat session
(ChatMessage) Sends a message to a chat user (raw format)
(ChatNameChange) Changes your chat name
(ChatNote) Does a note using ANSI codes for the chat system
(ChatPasteEverybody) Pastes the clipboard contents to every connected person
(ChatPasteText) Pastes the clipboard contents to that person
(ChatPeekConnections) Sends a "peek connections" message to the specified chat user
(ChatPersonal) Sends a chat message to a particular person
(ChatRequestConnections) Sends a "request connections" message to the specified chat user
(ChatSendFile) Starts sending a file to the specified chat user
(ChatStopAcceptingCalls) Stops this world from accepting chat calls
(ChatStopFileTransfer) Stops a file transfer in progress to that chat user
(GetChatInfo) Get information about a chat connection
(GetChatList) Gets the list of chat sessions
(GetChatOption) Gets the value of a chat session option
(SetChatOption) Sets the value of a chat session option
(Help topic: function=ChatPing)