Register forum user name Search FAQ

MUSHclient scripting

Description of MUSHclient world function: world.SetChatOption

Name SetChatOption
Type Method
Summary Sets the value of a chat session option
Prototype long SetChatOption(long ID, BSTR OptionName, BSTR Value);

View list of data type meanings
Description

Sets 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 described for the routine GetChatOption.

For numeric options (such as the flags) the supplied string will be converted to a number. It is an error if the string does not consist of digits (0 to 9).

For boolean options (such as "ignore") the supplied string may be:

"y", "Y", or "1" for true
"n", "N", or "0" for false

Also if you are using Lua you can supply simply true or false.


Note that because chat sessions are transitory the option is not remembered in the world file or anywhere else for future sessions. Thus, any options must be set on a per-session basis.

See the supplied Chat.xml plugin for an example of how you can do that automatically as a new session is started.

Note: Available in version 3.37 onwards.
VBscript example 
SetChatOption ChatGetID ("nick"), "group", "friends"
Jscript example 
SetChatOption (ChatGetID ("nick"), "group", "friends");
PerlScript example 
SetChatOption (ChatGetID ("nick"), "group", "friends");
Python example 
world.SetChatOption (world.ChatGetID ("nick"), "group", "friends")
Lua example 
SetChatOption (ChatGetID ("nick"), "group", "friends")
Lua notes 
You can use true or false for boolean options, as these are converted to 1 or 0.
Returns eChatIDNotFound: That chat ID is not a current chat session.
eOptionOutOfRange: The numeric option is out of range.
ePluginCannotSetOption: The option is marked as non-settable (in a plugin or not)
eUnknownOption: Option name is not known.
eOK: Set the option OK.

View list of return code meanings
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

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

[Back]

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

Home