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

MUSHclient scripting

Description of MUSHclient world function: world.GetChatList

Name GetChatList
Type Method
Summary Gets the list of chat sessions
Prototype VARIANT GetChatList();

View list of data type meanings


Returns an array of all the chat sessions which are currently connected. You can then use various "chat" routines to do something with that list.

Note: Available in version 3.37 onwards.

VBscript example
dim chatList

chatList = GetChatList

If Not IsEmpty (chatList) then

  For Each c In chatList
    Note c & " = " & GetChatInfo (c, 2)

End If
Jscript example
chatList = new VBArray(GetChatList()).toArray();

if (chatList)  // if not empty
 for (i = 0; i < chatList.length; i++)
   world.note(chatList [i] + " = " + GetChatInfo (chatList [i], 2));
PerlScript example
foreach $item (Win32::OLE::in ($world->GetChatList))
 Note($item . " = " . GetChatInfo ($item, 2));
Python example
chatList = world.GetChatList
if (chatList ):
  for c in chatList : world.Note (str (c) + " = " + 
              world.GetChatInfo (c, 2))
Lua example
for k, v in pairs (GetChatList ()) do 
  Note (v) 
Returns If there are no chat sessions then the return value is empty. Use "IsEmpty" to test for this possibility.

Otherwise, it returns a variant array containing the IDs of all the chat sessions. Use "ubound" to find the number of chat sessions in the list. You can then use "GetChatInfo" to find details about each session. See the example for how to do this. You can paste this example into an "Immediate" window (CTRL+I) to test it.
Introduced in version 3.37

See also ...

Function Description
ChatDisconnect Disconnects a current chat call
ChatEverybody Sends a chat message to every connected chat user
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)
ChatPasteEverybody Pastes the clipboard contents to every connected 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
ChatStopFileTransfer Stops a file transfer in progress to that chat user
GetChatInfo Get information about a chat connection
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]