Chat Base

Here you will find the documentation on the features in the Chat Base part of the framework.

Documentation may be incomplete and might need additions, we will update this when we can.

Usage:

            
        using Eco.EM.Framework.ChatBase;
        

The Chat Base is what we use when sending messages to the chats/players, we made this as it simplifies the whole proccess by using optional paramaters. here is how its used and what features are in it:

Sending To The Chat.

Sending To Users:
            
        //Will send a temporary message to the user
            ChatBase.Send(new ChatBase.Message(string content, user, ChatBase.MessageType.Temporary));
        // Will send a permanent message to the user
            ChatBase.Send(new ChatBase.Message(string content, user, ChatBase.MessageType.Permanent));
        //Will default to a temporary message to the user
            ChatBase.Send(new ChatBase.Message(string content, user));
        //Will send an Info Panel to a user
            ChatBase.Send(new ChatBase.Message(string title, string content, user));
        //Will send a Popup Ok box to the user
            ChatBase.Send(new ChatBase.Message(null | "", string content, user));
            
    

Sending To The Server:
            
        //Will send a temporary message to all users on the Server
            ChatBase.Send(new ChatBase.Message(string content ChatBase.MessageType.Temporary));
        // Will send a permanent message to all users on the Server
            ChatBase.Send(new ChatBase.Message(string content ChatBase.MessageType.Permanent));
        //Will default to a temporary message
            ChatBase.Send(new ChatBase.Message(string content));
        //Will send an Info Panel to all users on the Server
            ChatBase.Send(new ChatBase.Message(string title, string content));
        //Will send a Popup Ok box to all users on the Server
            ChatBase.Send(new ChatBase.Message(null | "", string content));
        //Sends a global annoucement to all players on the server ( or think of it as adding a new notification in the notifications section ) 
        //this is great for leaving notifications for offline users
            ChatBase.Send(new ChatBase.Message(string content, ChatBase.MessageType.GlobalAnnoucement));
            
    

All optional Paramters:

string title, string content, User user || Player player, MessageCategory chatCategory, DefaultChatTags defaultChatTags, MessageType messageType - in this order


Message Types

Usage For the message types:

ChatBase.MessageType.Type - Types Listed Below.

For Users:

            
        Temporary - This is the default selection if ChatBase.MessageType is left blank
        Permanent
        Announcement
        Popup
        

For the server

            
        Temporary - This is the default selection if ChatBase.MessageType is left blank
        Permanent
        Announcement
        Popup
        GlobalAnnoucement
            
    

Available Chat Tags

To use these it requires a refrence to the Eco.Shared.Services Namespace

using Eco.Shared.Services;

DefaultChatTags.ChatTag

            
        Welcome
        General
        Notifications - We use Notifications by default
        Government
        Elections
        Crafting
        Meteor
        Trades
        YourTrades
        Tax
        Property
        Skills
        Logins
        Auth
        Reputation
        Objectives
        Contracts
        YourContracts
        ServerErrors
        Finance
        Wages
        Transfers
        Demographics
        

Available Message Categories

To use these it requires a refrence to the Eco.Shared.Services Namespace

using Eco.Shared.Services;

MessageCategory.Category

            
        Chat - We use Chat By Default
        Whisper
        Error
        Info
        Mail
        Warning
        Popup
        InfoBox