Script function

world.ChatID

Type

Method

Summary

Sends a chat message to a particular chat session

Prototype

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

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.

Available in MUSHclient version 3.37 onwards.

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

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
(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
(GetChatList) Gets the list of chat sessions
(GetChatOption) Gets the value of a chat session option
(SetChatOption) Sets the value of a chat session option

(Help topic: function=ChatID)