MUSHclient scripting

Description of MUSHclient world function: world.ChatID

Name	ChatID
Type	Method
Summary	Sends a chat message to a particular chat session
Prototype	`long ChatID(long ID, BSTR Message, BOOL Emote);` 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. Note: Available in 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.`
Returns	`eChatIDNotFound: No person of that ID is connected eOK: Sent to at least one person` View list of return code meanings
Introduced in version	3.37

See also ...

Function	Description
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
ChatPasteEverybody	Pastes the clipboard contents to every connected person
ChatPersonal	Sends a chat message to a particular person
GetChatList	Gets the list of chat sessions

Search for script function

Enter a word or phrase in the box below to narrow the list down to those that match.

The function name, prototype, summary, and description are searched.

Leave blank to show all functions.

Return codes

Many functions return a "code" which indicates the success or otherwise of the function.

You can view a list of the return codes

Function prototypes

The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).

You can view a list of the data types used in function prototypes

View all functions

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.