ChatID
Script function

world.ChatID

DOC_scripting Read about scripting

Type

Method

Summary

Sends a chat message to a particular chat session

Prototype

long ChatID(long ID, BSTR Message, BOOL Emote);

DOC_data_types View list of data type meanings

Description

This sends a "say" or "emote" to the with that Chat ID.

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 GetChatList to find a list of chat IDs that is current.

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

If the "emote" parameter is zero (false) then you will "say" the message, otherwise you will emote it.

If you "say" the message, it will appear like this on that person's client:

Nick chats to you, 'hi there'

If you "emote" the message, it will appear like this on that person's client:

To you, Nick laughs

The different message (compared to ChatEverybody or ChatGroup) is so you can tell the message was addressed to you personally.

The message will be sent even if you have set the "ignore" flag on that person, as presumably you want to override it, if you are addressing a message to them directly.

VBscript example

ChatID 5, "hi there", 0  ' say it
ChatID 5, "laughs", 1  ' emote it


Jscript example

ChatID (5, "hi there", 0);  // say it
ChatID (5, "laughs", 1);  // emote it


PerlScript example

ChatID (5, "hi there", 0);  # say it
ChatID (5, "laughs", 1);  # emote it


Python example

world.ChatID (5, "hi there", 0)  # say it
world.ChatID (5, "laughs", 1)  # emote it


Lua example

ChatID (5, "hi there")  -- say it
ChatID (5, "laughs", true)  -- emote it


Lua notes

The Emote argument is optional and defaults to false.


Return value

eChatIDNotFound: No person of that ID is connected
eOK: Sent to at least one person


DOC_errors View list of return code meanings

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_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=ChatID)

DOC_contents Documentation contents page