GetChatList
Script function

world.GetChatList

DOC_scripting Read about scripting

Type

Method

Summary

Gets the list of chat sessions

Prototype

VARIANT GetChatList();

DOC_data_types 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

DOC_chat Chat system
DOC_starting Getting started

Functions

FNC_ChatAcceptCalls ChatAcceptCalls (Accepts incoming chat calls)
FNC_ChatCall ChatCall (Calls a chat server (makes an outgoing call) using the MudMaster chat protocol)
FNC_ChatCallzChat ChatCallzChat (Calls a zChat chat server (makes an outgoing call))
FNC_ChatDisconnect ChatDisconnect (Disconnects a current chat call)
FNC_ChatDisconnectAll ChatDisconnectAll (Disconnects all current chat calls)
FNC_ChatEverybody ChatEverybody (Sends a chat message to every connected chat user)
FNC_ChatGetID ChatGetID (Looks up what chat ID (identifier) corresponds to a particular chat name)
FNC_ChatGroup ChatGroup (Sends a chat message to every connected chat user in the specified group)
FNC_ChatID ChatID (Sends a chat message to a particular chat session)
FNC_ChatMessage ChatMessage (Sends a message to a chat user (raw format))
FNC_ChatNameChange ChatNameChange (Changes your chat name)
FNC_ChatNote ChatNote (Does a note using ANSI codes for the chat system)
FNC_ChatPasteEverybody ChatPasteEverybody (Pastes the clipboard contents to every connected person)
FNC_ChatPasteText ChatPasteText (Pastes the clipboard contents to that person)
FNC_ChatPeekConnections ChatPeekConnections (Sends a "peek connections" message to the specified chat user)
FNC_ChatPersonal ChatPersonal (Sends a chat message to a particular person)
FNC_ChatPing ChatPing (Sends a ping message to the specified chat user)
FNC_ChatRequestConnections ChatRequestConnections (Sends a "request connections" message to the specified chat user)
FNC_ChatSendFile ChatSendFile (Starts sending a file to the specified chat user)
FNC_ChatStopAcceptingCalls ChatStopAcceptingCalls (Stops this world from accepting chat calls)
FNC_ChatStopFileTransfer ChatStopFileTransfer (Stops a file transfer in progress to that chat user)
FNC_GetChatInfo GetChatInfo (Get information about a chat connection)
FNC_GetChatOption GetChatOption (Gets the value of a chat session option)
FNC_SetChatOption SetChatOption (Sets the value of a chat session option)

(Help topic: function=GetChatList)

DOC_contents Documentation contents page