GetChatInfo
Script function

world.GetChatInfo

DOC_scripting Read about scripting

Type

Method

Summary

Get information about a chat connection

Prototype

VARIANT GetChatInfo(long ChatID, short InfoType);

DOC_data_types View list of data type meanings

Description

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)
9: Status
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)

VBscript example

Note "Version: " & GetChatInfo (id, 4)


Jscript example

Note ("Version: " + GetChatInfo (id, 4));


PerlScript example

Note ("Version: " . GetChatInfo (id, 4));


Python example

world.Note ("Version: " + str (world.GetChatInfo (id, 4)))


Lua example

Note ("Version: " .. GetChatInfo (id, 4))


Return value

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.



See Also ...

Topics

DOC_chat Chat system
DOC_starting Getting started

Functions

FNC_ChatAcceptCalls ChatAcceptCalls (Accepts incoming chat calls)
FNC_ChatCall ChatCall (Calls a chat server (makes an outgoing call) using the MudMaster chat protocol)
FNC_ChatCallzChat ChatCallzChat (Calls a zChat chat server (makes an outgoing call))
FNC_ChatDisconnect ChatDisconnect (Disconnects a current chat call)
FNC_ChatDisconnectAll ChatDisconnectAll (Disconnects all current chat calls)
FNC_ChatEverybody ChatEverybody (Sends a chat message to every connected chat user)
FNC_ChatGetID ChatGetID (Looks up what chat ID (identifier) corresponds to a particular chat name)
FNC_ChatGroup ChatGroup (Sends a chat message to every connected chat user in the specified group)
FNC_ChatID ChatID (Sends a chat message to a particular chat session)
FNC_ChatMessage ChatMessage (Sends a message to a chat user (raw format))
FNC_ChatNameChange ChatNameChange (Changes your chat name)
FNC_ChatNote ChatNote (Does a note using ANSI codes for the chat system)
FNC_ChatPasteEverybody ChatPasteEverybody (Pastes the clipboard contents to every connected person)
FNC_ChatPasteText ChatPasteText (Pastes the clipboard contents to that person)
FNC_ChatPeekConnections ChatPeekConnections (Sends a "peek connections" message to the specified chat user)
FNC_ChatPersonal ChatPersonal (Sends a chat message to a particular person)
FNC_ChatPing ChatPing (Sends a ping message to the specified chat user)
FNC_ChatRequestConnections ChatRequestConnections (Sends a "request connections" message to the specified chat user)
FNC_ChatSendFile ChatSendFile (Starts sending a file to the specified chat user)
FNC_ChatStopAcceptingCalls ChatStopAcceptingCalls (Stops this world from accepting chat calls)
FNC_ChatStopFileTransfer ChatStopFileTransfer (Stops a file transfer in progress to that chat user)
FNC_GetChatList GetChatList (Gets the list of chat sessions)
FNC_GetChatOption GetChatOption (Gets the value of a chat session option)
FNC_SetChatOption SetChatOption (Sets the value of a chat session option)

(Help topic: function=GetChatInfo)

DOC_contents Documentation contents page