world.GetChatOption

MUSHclient script function (Method) — introduced in version 3.37

Gets the value of a chat session option

Prototype

VARIANT GetChatOption(long ID, BSTR OptionName);

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.

Related topic

Chat system

See also