world.ChatEverybody

MUSHclient script function (Method) — introduced in version 3.37

Sends a chat message to every connected chat user

Prototype

long ChatEverybody(BSTR Message, BOOL Emote);

Data type meanings

Description

This sends a "say" or "emote" to all connected chat users, 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 everybody, 'hi there'

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

Nick laughs

VBscript example

ChatEverybody "hi there", 0  ' say it
ChatEverybody "laughs", 1  ' emote it

Jscript example

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

PerlScript example

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

Python example

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

Lua example

ChatEverybody ("hi there", 0)  -- say it
ChatEverybody ("laughs", 1)  -- emote it

Lua notes

The Emote argument is optional and defaults to false.

Return value

eNoChatConnections: No connections (that are not being ignored)
eOK: Sent to at least one person

Return code meanings

Related topic

Chat system

See also