Script function

world.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);

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

Available in MUSHclient 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.

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

See Also ...

Topics

Chat system
Getting started

Functions

(ChatAcceptCalls) Accepts incoming chat calls
(ChatCall) Calls a chat server (makes an outgoing call) using the MudMaster chat protocol
(ChatCallzChat) Calls a zChat chat server (makes an outgoing call)
(ChatDisconnect) Disconnects a current chat call
(ChatDisconnectAll) Disconnects all current chat calls
(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
(ChatMessage) Sends a message to a chat user (raw format)
(ChatNameChange) Changes your chat name
(ChatNote) Does a note using ANSI codes for the chat system
(ChatPasteEverybody) Pastes the clipboard contents to every connected person
(ChatPasteText) Pastes the clipboard contents to that person
(ChatPeekConnections) Sends a "peek connections" message to the specified chat user
(ChatPersonal) Sends a chat message to a particular person
(ChatPing) Sends a ping message to the specified chat user
(ChatRequestConnections) Sends a "request connections" message to the specified chat user
(ChatSendFile) Starts sending a file to the specified chat user
(ChatStopAcceptingCalls) Stops this world from accepting chat calls
(ChatStopFileTransfer) Stops a file transfer in progress to that chat user
(GetChatInfo) Get information about a chat connection
(GetChatList) Gets the list of chat sessions
(GetChatOption) Gets the value of a chat session option
(SetChatOption) Sets the value of a chat session option

(Help topic: function=ChatGroup)