GetChatOption
Script function

world.GetChatOption

DOC_scripting Read about scripting

Type

Method

Summary

Gets the value of a chat session option

Prototype

VARIANT GetChatOption(long ID, BSTR OptionName);

DOC_data_types View list of data type meanings

Description

Gets the current value of a chat session option.

You must specify the identifier of a current chat session, and a chat option from the list below.

The return type is Variant, so the returned value will be the appropriate type for the data (ie. string or number (long)).

If the option name is not known, or is not allowed to be retrieved, a NULL variant is returned.

If the chat session does not exist, EMPTY is returned. If the name given is invalid, NULL is returned. If the option name is not known, EMPTY is returned. (Use "IsEmpty" and "IsNull" to test for these possibilities).

OPTION NAMES

"address" - TCP/IP address of remote user (address to call them)
"can_send_commands" - can that user send us commands?
"can_send_files" - can that user send us files?
"can_snoop" - can that user snoop on our session?
"group" - their group name
"ignore" - ignore them?
"private" - private session?
"served" - incoming call?
"server" - TCP/IP address of remote user
"user" - user value (for scripting, is not used by MUSHclient)
"username" - their chat name
"version" - what version client they are using

VBscript example

Note GetChatOption (ChatGetID ("nick"), "group")


Jscript example

Note (GetChatOption (ChatGetID ("nick"), "group"));


PerlScript example

Note (GetChatOption (ChatGetID ("nick"), "group"));


Python example

world.Note (world.GetChatOption (world.ChatGetID ("nick"), "group"))


Lua example

Note (GetChatOption (ChatGetID ("nick"), "group"))


Return value

As described above.



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_GetChatInfo GetChatInfo (Get information about a chat connection)
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=GetChatOption)

DOC_contents Documentation contents page