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