[Home] [Downloads] [Search] [Help/forum]

MUSHclient scripting

Description of MUSHclient world function: world.ChatPersonal


Name ChatPersonal
Type Method
Summary Sends a chat message to a particular person
Prototype long ChatPersonal(BSTR Who, BSTR Message, BOOL Emote);

View list of 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.


Note: Available in version 3.37 onwards.


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.
Returns eChatPersonNotFound: No person of that name 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
ChatID Sends a chat message to a particular chat session
ChatPasteEverybody Pastes the clipboard contents to every connected 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.

Search for:   

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

[Back]

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

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

[Home]


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]