ChatEverybody
Script function

world.ChatEverybody

DOC_scripting Read about scripting

Type

Method

Summary

Sends a chat message to every connected chat user

Prototype

long ChatEverybody(BSTR Message, BOOL Emote);

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


DOC_errors View list of return code meanings


See Also ...

Topics

DOC_chat Chat system
DOC_starting Getting started

Functions

FNC_ChatAcceptCalls ChatAcceptCalls (Accepts incoming chat calls)
FNC_ChatCall ChatCall (Calls a chat server (makes an outgoing call) using the MudMaster chat protocol)
FNC_ChatCallzChat ChatCallzChat (Calls a zChat chat server (makes an outgoing call))
FNC_ChatDisconnect ChatDisconnect (Disconnects a current chat call)
FNC_ChatDisconnectAll ChatDisconnectAll (Disconnects all current chat calls)
FNC_ChatGetID ChatGetID (Looks up what chat ID (identifier) corresponds to a particular chat name)
FNC_ChatGroup ChatGroup (Sends a chat message to every connected chat user in the specified group)
FNC_ChatID ChatID (Sends a chat message to a particular chat session)
FNC_ChatMessage ChatMessage (Sends a message to a chat user (raw format))
FNC_ChatNameChange ChatNameChange (Changes your chat name)
FNC_ChatNote ChatNote (Does a note using ANSI codes for the chat system)
FNC_ChatPasteEverybody ChatPasteEverybody (Pastes the clipboard contents to every connected person)
FNC_ChatPasteText ChatPasteText (Pastes the clipboard contents to that person)
FNC_ChatPeekConnections ChatPeekConnections (Sends a "peek connections" message to the specified chat user)
FNC_ChatPersonal ChatPersonal (Sends a chat message to a particular person)
FNC_ChatPing ChatPing (Sends a ping message to the specified chat user)
FNC_ChatRequestConnections ChatRequestConnections (Sends a "request connections" message to the specified chat user)
FNC_ChatSendFile ChatSendFile (Starts sending a file to the specified chat user)
FNC_ChatStopAcceptingCalls ChatStopAcceptingCalls (Stops this world from accepting chat calls)
FNC_ChatStopFileTransfer ChatStopFileTransfer (Stops a file transfer in progress to that chat user)
FNC_GetChatInfo GetChatInfo (Get information about a chat connection)
FNC_GetChatList GetChatList (Gets the list of chat sessions)
FNC_GetChatOption GetChatOption (Gets the value of a chat session option)
FNC_SetChatOption SetChatOption (Sets the value of a chat session option)

(Help topic: function=ChatEverybody)

DOC_contents Documentation contents page