world.ChatID

MUSHclient script function (Method) — introduced in version 3.37

Sends a chat message to a particular chat session

Prototype

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

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

Return code meanings

Related topic

Chat system

See also