SetPCChatMessage(string)

Sets the last player chat message before it gets sent to other players.

void SetPCChatMessage(
    string sNewChatMessage = ""
);

Parameters

sNewChatMessage

The new chat text to be sent to other players. (Default: "")

Description

Sets the last player chat (text) message before it gets sent to other players.

Remarks

Setting sNewChatMessage to an empty string ("") will cause the chat message to be discarded, i.e., it will not be sent to other players.

Note: The new chat message gets sent after the OnPlayerChat script exits.

Should only be called from a module's OnPlayerChat event script.

Version

1.69

Example

See OnPlayerChat.