ChatGetID
Script function

world.ChatGetID

DOC_scripting Read about scripting

Type

Method

Summary

Looks up what chat ID (identifier) corresponds to a particular chat name

Prototype

long ChatGetID(BSTR Who);

DOC_data_types View list of data type meanings

Description

Each call is identified by its "chat ID" - each chat session has a unique ID, which starts at one, and is incremented by one, per world.

You can use ChatGetID to find the chat ID corresponding to a particular chat name.

If more than one person has that name the first one (earliest connection) is returned.

If no person has that name zero is returned.

A message is sent to the output window, so you can use ChatGetID in scripts and have them automatically notify you if that person cannot be found.

VBscript example

ChatID ChatGetID ("nick"), "hi there", 0


Jscript example

ChatID (ChatGetID ("nick"), "hi there", 0);


PerlScript example

ChatID (ChatGetID ("nick"), "hi there", 0);


Python example

world.ChatID (world.ChatGetID ("nick"), "hi there", 0)


Lua example

ChatID (ChatGetID ("nick"), "hi there", 0)


Return value

The chat ID corresponding to that name, or zero if none is found.



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_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_GetChatList GetChatList (Gets the list of chat sessions)
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=ChatGetID)

DOC_contents Documentation contents page