world.ChatGroup

MUSHclient script function (Method) — introduced in version 3.37

Sends a chat message to every connected chat user in the specified group

Prototype

long ChatGroup(BSTR Group, BSTR Message, BOOL Emote);

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

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.

Return value

eBadParameter: No group name specified
eNoChatConnections: No connections in that group (that are not being ignored)
eOK: Sent to at least one person

Return code meanings

Related topic

Chat system

See also