Script function

world.SetChatOption

Type

Method

Summary

Sets the value of a chat session option

Prototype

long SetChatOption(long ID, BSTR OptionName, BSTR Value);

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.

Available in MUSHclient 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.

Return value

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.

See Also ...

Topics

Chat system
Getting started

Functions

(ChatAcceptCalls) Accepts incoming chat calls
(ChatCall) Calls a chat server (makes an outgoing call) using the MudMaster chat protocol
(ChatCallzChat) Calls a zChat chat server (makes an outgoing call)
(ChatDisconnect) Disconnects a current chat call
(ChatDisconnectAll) Disconnects all current chat calls
(ChatEverybody) Sends a chat message to every connected chat user
(ChatGetID) Looks up what chat ID (identifier) corresponds to a particular chat name
(ChatGroup) Sends a chat message to every connected chat user in the specified group
(ChatID) Sends a chat message to a particular chat session
(ChatMessage) Sends a message to a chat user (raw format)
(ChatNameChange) Changes your chat name
(ChatNote) Does a note using ANSI codes for the chat system
(ChatPasteEverybody) Pastes the clipboard contents to every connected person
(ChatPasteText) Pastes the clipboard contents to that person
(ChatPeekConnections) Sends a "peek connections" message to the specified chat user
(ChatPersonal) Sends a chat message to a particular person
(ChatPing) Sends a ping message to the specified chat user
(ChatRequestConnections) Sends a "request connections" message to the specified chat user
(ChatSendFile) Starts sending a file to the specified chat user
(ChatStopAcceptingCalls) Stops this world from accepting chat calls
(ChatStopFileTransfer) Stops a file transfer in progress to that chat user
(GetChatInfo) Get information about a chat connection
(GetChatList) Gets the list of chat sessions
(GetChatOption) Gets the value of a chat session option

(Help topic: function=SetChatOption)