world.GetChatList

MUSHclient script function (Method) — introduced in version 3.37

Gets the list of chat sessions

Prototype

VARIANT GetChatList();

Data type meanings

Description

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.

VBscript example

dim chatList

chatList = GetChatList

If Not IsEmpty (chatList) then

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

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) 
end

Return value

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.

Related topic

Chat system

See also