Class ChatSettings

Client's chat settings are stored on the server within this class (instead of UserPrefs) Client can reorder tabs but can't add or remove tabs (using ChatManager's RPCs instead)

Inheritance
System.Object
ChatSettings
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: Eco.Gameplay.Systems.Messaging.Chat
Assembly: Eco.Gameplay.dll
Syntax
public class ChatSettings : Object, INotifyPropertyChanged, IHasClientControlledContainers, IController, IViewController, IHasUniversalID

Constructors

ChatSettings()

Declaration
public ChatSettings()

Properties

ChatTabSettings

Declaration
public ControllerList<ChatTabSettingsBase> ChatTabSettings { get; set; }
Property Value
Type Description
ControllerList<ChatTabSettingsBase>

ControllerID

Declaration
public ref int ControllerID { get; }
Property Value
Type Description
System.Int32

WhisperTabForEachPlayer

Declaration
public bool WhisperTabForEachPlayer { get; set; }
Property Value
Type Description
System.Boolean

Methods

AddTab(Player, Int32)

Requests client to open draft chat tab editor, tab will be added only if pressed Apply button

Declaration
public void AddTab(Player player, int index)
Parameters
Type Name Description
Player player
System.Int32 index

CreateNotificationTab(Player, NotificationCategory)

Create a chat tab for notifications from category

Declaration
public void CreateNotificationTab(Player player, NotificationCategory category)
Parameters
Type Name Description
Player player
NotificationCategory category

EditTab(Player, Int32)

Requests client to open draft chat tab editor.

Declaration
public void EditTab(Player player, int index)
Parameters
Type Name Description
Player player
System.Int32 index

EnsureTabExistsForReceiver(User, IChatReceiver, Boolean, Boolean)

Ensure we have a tab for IChatReceiver and if not - try to create this tab

Declaration
public void EnsureTabExistsForReceiver(User user, IChatReceiver receiver, bool activateTab, bool activateChat = false)
Parameters
Type Name Description
User user
IChatReceiver receiver
System.Boolean activateTab

Should we set the tab as active ?
System.Boolean activateChat

HideTab(Player, ChatTabSettingsBase)

Requests client to move the tab to the Hidden Tabs list.

Declaration
public void HideTab(Player player, ChatTabSettingsBase settings)
Parameters
Type Name Description
Player player
ChatTabSettingsBase settings

Events

PropertyChanged

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged

Extension Methods