SetChatSettings

From The KillerJim Mod Wiki

PlayerProxy::SetChatSettings

SetChatSettings.png

Client Only Function - This API call can only be called on clients.

Description

By default players will be able to communicate with other players using either chat (text) or VOIP (voice). This API function allows you to modify the chat (text) settings to control how players can chat with other players. Normally you will use this to add players to a group so they can communicate with a other team members in private.

As chat settings are set on the client (and not the server), normally you will send a message from all clients (such as a multi-cast event) that are on a particular team to inform them that they should set-up private group chat. For example; in TTT game-mode the server will set a replicating variable (RepNotify) on each client to say whether they are innocent or or a terrorist; based on this value we then can set the private chat for terrorists.

By default global chat is on, and private (group) chat is disabled.

Arguments
1 PlayerProxyChatSettings params
A structure representing the chat settings for the "current" user.

bool AllowChat (default : true) - Disable or enable chat for this player; nothing can be sent or received if disabled.

bool AllowChatInSpectator (default : false) - If enabled, spectators can use the chat system

bool SeperateChatForSpectators (default : false) - If enabled, spectators won't be able to talk to alive players.

int GroupID (default : 0) - Set to any value great than 1 to have the player talk via "group chat" to this group

string GroupName (default : "") - The name players see when sending or receiving message to their group

color GroupNameColor (default : white) - Messages from the group are color coded using this color.

vector2 ChatOffset (default 0,0) - Move the chat window by X and Y pixels from it's CURRENT location (note: negative number move up and to the left. positive numbers down and to the right)

Playing

Developers

Developer Reference