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);
|
Description | Gets the current value of a chat session option. Note: Available in version 3.37 onwards. |
VBscript example |
|
Jscript example |
|
PerlScript example |
|
Python example |
|
Lua example |
|
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 |
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.
You can 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).
You can view a list of the data types used in function prototypes
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.
Comments to:
Gammon Software support
Forum RSS feed ( https://gammon.com.au/rss/forum.xml )