[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.GetChatOption

Name GetChatOption
Type Method
Summary Gets the value of a chat session option
Prototype VARIANT GetChatOption(long ID, BSTR OptionName);

View list of data type meanings


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).


"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

Note: Available in version 3.37 onwards.

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"))
Returns As described above.
Introduced in version 3.37

See also ...

Function Description
ChatGetID Looks up what chat ID (identifier) corresponds to a particular chat name
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

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.

Search for:   

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions


Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]