world.ChatPersonal

MUSHclient script function (Method) — introduced in version 3.37

Sends a chat message to a particular person

Prototype

long ChatPersonal(BSTR Who, BSTR Message, BOOL Emote);

Data type meanings

Description

This sends a "say" or "emote" to the person(s) of that name.

If more than one person has the specified name, all will get the message. If this is a problem, use ChatID to send a message to a specific user by number rather than 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

ChatPersonal "Nick", "hi there", 0  ' say it
ChatPersonal "Nick", "laughs", 1  ' emote it

Jscript example

ChatPersonal ("nick", "hi there", 0);  // say it
ChatPersonal ("nick", "laughs", 1);  // emote it

PerlScript example

ChatPersonal ("nick", "hi there", 0);  # say it
ChatPersonal ("nick", "laughs", 1);  # emote it

Python example

world.ChatPersonal ("nick", "hi there", 0)  # say it
world.ChatPersonal ("nick", "laughs", 1)  # emote it

Lua example

ChatPersonal ("nick", "hi there")  -- say it
ChatPersonal ("nick", "laughs", true)  -- emote it

Lua notes

The Emote argument is optional and defaults to false.

Return value

eChatPersonNotFound: No person of that name connected
eOK: Sent to at least one person

Return code meanings

Related topic

Chat system

See also