Description of MUSHclient world function: world.ChatID
||Sends a chat message to a particular chat session
long ChatID(long ID, BSTR Message, BOOL Emote);
View list of data type meanings
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.
ChatID 5, "hi there", 0 ' say it
ChatID 5, "laughs", 1 ' emote it
ChatID (5, "hi there", 0); // say it
ChatID (5, "laughs", 1); // emote it
ChatID (5, "hi there", 0); # say it
ChatID (5, "laughs", 1); # emote it
world.ChatID (5, "hi there", 0) # say it
world.ChatID (5, "laughs", 1) # emote it
ChatID (5, "hi there") -- say it
ChatID (5, "laughs", true) -- emote it
The Emote argument is optional and defaults to false.
eChatIDNotFound: No person of that ID is connected
eOK: Sent to at least one person
View list of return code meanings
|Introduced in version
See also ...
||Sends a chat message to every connected chat user
||Looks up what chat ID (identifier) corresponds to a particular chat name
||Sends a chat message to every connected chat user in the specified group
||Pastes the clipboard contents to every connected person
||Sends a chat message to a particular person
||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.
Many functions return a "code" which indicates the success or otherwise
of the function.
view a list of the return codes
The "prototype" part of each function description lists exactly how the function is called (what arguments, if any, to pass to it).
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.
Gammon Software support
Forum RSS feed ( https://gammon.com.au/rss/forum.xml )