Description of MUSHclient world function: world.GetChatInfo
||Get information about a chat connection
VARIANT GetChatInfo(long ChatID, short InfoType);
View list of data type meanings
Gets details about the specified chat session.
You can obtain one of 41 "types" of information about the chat session by specifying an "InfoType". The possible InfoTypes are:
1: Server name
2: User (ie. their chat name)
3: Group name
4: Client version
5: Call IP (address to call to get them)
6: Address (address they actually are)
7: Port (incoming port)
8: Call port (port to call them on)
10: Type (0 = MudMaster protocol)
11: ID (internal chat ID)
12: Incoming (true = they called us, false = we called them)
13: Can snoop flag
14: Snooping flag
15: They are snooping us flag
16: Send commands flag
17: Private flag
18: Can send files flag
19: Ignore them flag
20: Recent ping time
21: Started at time
22: Last message in time
23: Last message out time
24: Started file transfer time
25: We are transferring a file flag
26: File transfer is a send (false = receive)
27: File name being transferred
28: Full file path (on our disk)
29: File size bytes
30: File blocks
31: Blocks already transferred
32: Block size
33: Incoming personal count
34: Incoming all count
35: Incoming group count
36: Outgoing personal count
37: Outgoing all count
38: Outgoing group count
39: Messages count
40: File xfer bytes in count
41: File xfer bytes out count
42: zChat stamp ID
43: Email address (from zChat)
44: PGP key (from zChat) - not used by MUSHclient
45: Status number (from zChat)
46: User option value (long)
Note: Available in version 3.37 onwards.
Note "Version: " & GetChatInfo (id, 4)
Note ("Version: " + GetChatInfo (id, 4));
Note ("Version: " . GetChatInfo (id, 4));
world.Note ("Version: " + str (world.GetChatInfo (id, 4)))
Note ("Version: " .. GetChatInfo (id, 4))
The specified information about the chat session, as described above.
A NULL variant if the chat session does not exist.
An EMPTY variant if the InfoType is not a valid type.
|Introduced in version
See also ...
||Looks up what chat ID (identifier) corresponds to a particular chat name
||Gets the value of a chat session option
||Sets the value of a chat session option
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.
Leave blank to show all functions.
Many functions return a "code" which indicates the success or otherwise
of the function.
view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
view a list of the data types used in function prototypes
View all functions
Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.
Gammon Software support
Forum RSS feed ( https://gammon.com.au/rss/forum.xml )