Torch/Torch.API/Managers/IChatManagerClient.cs

using System;
using Sandbox.Engine.Multiplayer;
using Sandbox.Game.Gui;
using Torch.Utils;
using VRage.Game;
using VRageMath;

namespace Torch.API.Managers
{
    /// <summary>
    /// Represents a scripted or user chat message.
    /// </summary>
    public readonly struct TorchChatMessage
    {
        private const string DEFAULT_FONT = MyFontEnum.Blue;

        #region Backwards compatibility

        [Obsolete]
        public TorchChatMessage(string author, string message, string font = DEFAULT_FONT) 
            : this(author, message, default, font) { }

        [Obsolete]
        public TorchChatMessage(string author, ulong authorSteamId, string message, ChatChannel channel, long target, string font = DEFAULT_FONT)
            : this(author, authorSteamId, message, channel, target, default, font) { }

        [Obsolete]
        public TorchChatMessage(ulong authorSteamId, string message, ChatChannel channel, long target, string font = DEFAULT_FONT)
            : this(authorSteamId, message, channel, target, default, font) { }

        #endregion
        
        /// <summary>
        /// Creates a new torch chat message with the given author and message.
        /// </summary>
        /// <param name="author">Author's name</param>
        /// <param name="message">Message</param>
        /// <param name="font">Font</param>
        public TorchChatMessage(string author, string message, Color color, string font = DEFAULT_FONT)
        {
            Timestamp = DateTime.Now;
            AuthorSteamId = null;
            Author = author;
            Message = message;
            Channel = ChatChannel.Global;
            Target = 0;
            Font = font;
            Color = color == default ? ColorUtils.TranslateColor(font) : color;
        }

        /// <summary>
        /// Creates a new torch chat message with the given author and message.
        /// </summary>
        /// <param name="author">Author's name</param>
        /// <param name="authorSteamId">Author's steam ID</param>
        /// <param name="message">Message</param>
        /// <param name="font">Font</param>
        public TorchChatMessage(string author, ulong authorSteamId, string message, ChatChannel channel, long target, Color color, string font = DEFAULT_FONT)
        {
            Timestamp = DateTime.Now;
            AuthorSteamId = authorSteamId;
            Author = author;
            Message = message;
            Channel = channel;
            Target = target;
            Font = font;
            Color = color == default ? ColorUtils.TranslateColor(font) : color;
        }

        /// <summary>
        /// Creates a new torch chat message with the given author and message.
        /// </summary>
        /// <param name="authorSteamId">Author's steam ID</param>
        /// <param name="message">Message</param>
        /// <param name="font">Font</param>
        public TorchChatMessage(ulong authorSteamId, string message, ChatChannel channel, long target, Color color, string font = DEFAULT_FONT)
        {
            Timestamp = DateTime.Now;
            AuthorSteamId = authorSteamId;
            Author = MyMultiplayer.Static?.GetMemberName(authorSteamId) ?? "Player";
            Message = message;
            Channel = channel;
            Target = target;
            Font = font;
            Color = color == default ? ColorUtils.TranslateColor(font) : color;
        }

        /// <summary>
        /// This message's timestamp.
        /// </summary>
        public readonly DateTime Timestamp;
        /// <summary>
        /// The author's steam ID, if available.  Else, null.
        /// </summary>
        public readonly ulong? AuthorSteamId;
        /// <summary>
        /// The author's name, if available.  Else, null.
        /// </summary>
        public readonly string Author;
        /// <summary>
        /// The message contents.
        /// </summary>
        public readonly string Message;
        /// <summary>
        /// The chat channel the message is part of.
        /// </summary>
        public readonly ChatChannel Channel;
        /// <summary>
        /// The intended recipient of the message.
        /// </summary>
        public readonly long Target;
        /// <summary>
        /// The font, or null if default.
        /// </summary>
        public readonly string Font;
        /// <summary>
        /// The chat message color.
        /// </summary>
        public readonly Color Color;
    }

    /// <summary>
    /// Callback used to indicate that a messaage has been recieved.
    /// </summary>
    /// <param name="msg"></param>
    /// <param name="consumed">If true, this event has been consumed and should be ignored</param>
    public delegate void MessageRecievedDel(TorchChatMessage msg, ref bool consumed);

    /// <summary>
    /// Callback used to indicate the user is attempting to send a message locally.
    /// </summary>
    /// <param name="msg">Message the user is attempting to send</param>
    /// <param name="consumed">If true, this event has been consumed and should be ignored</param>
    public delegate void MessageSendingDel(string msg, ref bool consumed);

    public interface IChatManagerClient : IManager
    {
        /// <summary>
        /// Event that is raised when a message addressed to us is recieved.  <see cref="MessageRecievedDel"/>
        /// </summary>
        event MessageRecievedDel MessageRecieved;

        /// <summary>
        /// Event that is raised when we are attempting to send a message.  <see cref="MessageSendingDel"/>
        /// </summary>
        event MessageSendingDel MessageSending;

        /// <summary>
        /// Triggers the <see cref="MessageSending"/> event,
        /// typically raised by the user entering text into the chat window.
        /// </summary>
        /// <param name="message">The message to send</param>
        void SendMessageAsSelf(string message);

        /// <summary>
        /// Displays a message on the UI given an author name and a message.
        /// </summary>
        /// <param name="author">Author name</param>
        /// <param name="message">Message content</param>
        /// <param name="font">font to use</param>
        void DisplayMessageOnSelf(string author, string message, string font = "Blue" );
    }
}