GetChatOption
Script function world.GetChatOption Read about scripting Type Method Summary Gets the value of a chat session option Prototype `VARIANT GetChatOption(long ID, BSTR OptionName);` View list of 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.
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) SetChatOption (Sets the value of a chat session option) (Help topic: function=GetChatOption) Documentation contents page