Interface IChatManager

Namespace: Eco.Gameplay.Systems.Messaging.Chat
Assembly: Eco.Gameplay.dll
Syntax
public interface IChatManager

Methods

AddCommandHandler(Type)

Adds command handler type which should contains one or more methods with ChatCommandAttribute or ChatSubCommandAttribute. This method should be called before ChatManager initialization finished.

Declaration
void AddCommandHandler(Type commandHandler)
Parameters
Type Name Description
System.Type commandHandler

ExecuteCommand(IChatClient, String, SupportedLanguage)

Executes command (starting from slash), commands are defined in IChatCommandHandler classes

Declaration
void ExecuteCommand(IChatClient user, string command, SupportedLanguage language)
Parameters
Type Name Description
IChatClient user
System.String command
SupportedLanguage language

ExecuteCommandAsync(IChatClient, String, SupportedLanguage)

Executes command (starting from slash), commands are defined in IChatCommandHandler classes

Declaration
Task ExecuteCommandAsync(IChatClient user, string command, SupportedLanguage language)
Parameters
Type Name Description
IChatClient user
System.String command
SupportedLanguage language
Returns
Type Description
System.Threading.Tasks.Task

GetAllCommands()

Get list of all chat commands (from all IChatCommandHandler classes)

Declaration
IEnumerable<ChatCommand> GetAllCommands()
Returns
Type Description
System.Collections.Generic.IEnumerable<ChatCommand>

GetSettingsForUser(User)

Get chat settings and chat tabs for user, which are stored on server

Declaration
ChatSettings GetSettingsForUser(User user)
Parameters
Type Name Description
User user
Returns
Type Description
ChatSettings

Send(User, IChatReceiver, String)

Declaration
Result Send(User from, IChatReceiver to, string message)
Parameters
Type Name Description
User from
IChatReceiver to
System.String message
Returns
Type Description
Result

SetChatReceiver(Player, IChatReceiver, Boolean)

Set client's current chat receiver (user or channel) (instead previous OutputTag), it also can include activation of the chat log

Declaration
void SetChatReceiver(Player player, IChatReceiver receiver, bool activateChat)
Parameters
Type Name Description
Player player
IChatReceiver receiver
System.Boolean activateChat

Extension Methods