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

MUSHclient scripting

Description of MUSHclient world function: world.ChatGroup


Name ChatGroup
Type Method
Summary Sends a chat message to every connected chat user in the specified group
Prototype long ChatGroup(BSTR Group, BSTR Message, BOOL Emote);

View list of data type meanings

Description

This sends a "say" or "emote" to all connected chat users in the specified group, excepting the ones you are ignoring, if any.

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 other people's clients:

Nick chats to the group, 'hi'

If you "emote" the message, it will appear like this on other people's clients:

To the group, Nick laughs

To put a particular chat user into a group, use SetChatOption, like this:

world.SetChatOption 5, "group", "friends" ' put user 5 into group friends


Note: Available in version 3.37 onwards.


VBscript example
ChatGroup "friends", "hi there", 0  ' say it
ChatGroup "friends", "laughs", 1  ' emote it
Jscript example
ChatGroup ("friends", "hi there", 0);  // say it
ChatGroup ("friends", "laughs", 1);  // emote it
PerlScript example
ChatGroup ("friends", "hi there", 0);  # say it
ChatGroup ("friends", "laughs", 1);  # emote it
Python example
world.ChatGroup ("friends", "hi there", 0)  # say it
world.ChatGroup ("friends", "laughs", 1)  # emote it
Lua example
ChatGroup ("friends", "hi there")  -- say it
ChatGroup ("friends", "laughs", true)  -- emote it
Lua notes
The Emote argument is optional and defaults to false.
Returns eBadParameter: No group name specified
eNoChatConnections: No connections in that group (that are not being ignored)
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
ChatID Sends a chat message to a particular chat session
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
SetChatOption Sets the value of a chat session option

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]