CompositeChat.h

Go to the documentation of this file.

 
// CompositeChat.h
 
// Declares the cCompositeChat class used to wrap a chat message with multiple parts (text, url, cmd)
 
#pragma once
 
#include "Defines.h"
#include "json/json.h"
 
 
 
 
 
// tolua_begin
class cCompositeChat
{
public:
    // tolua_end
 
 
    struct BasePart
    {
        AString Text;
        AString Style;
        AString AdditionalStyleData;
    } ;
 
 
 
    struct TextPart:
        public BasePart
    {
    } ;
 
 
 
    struct ClientTranslatedPart:
        public BasePart
    {
        AStringVector Parameters;
    } ;
 
 
 
    struct UrlPart:
        public BasePart
    {
        AString Url;
    } ;
 
 
 
    struct CommandPart:
        public BasePart
    {
        AString Command;
    } ;
 
 
 
    struct RunCommandPart:
        public CommandPart
    {
    } ;
 
 
 
    struct SuggestCommandPart:
        public CommandPart
    {
    } ;
 
 
 
    struct ShowAchievementPart:
        public BasePart
    {
        AString PlayerName;
    } ;
 
 
 
    cCompositeChat(void);
 
    cCompositeChat(const AString & a_ParseText, eMessageType a_MessageType = mtCustom);
 
    // The following are exported in ManualBindings in order to support chaining - they return "self" in Lua (#755)
 
    void Clear(void);
 
    void AddTextPart(const AString & a_Message, const AString & a_Style = "");
 
    void AddClientTranslatedPart(const AString & a_TranslationID, const AStringVector & a_Parameters, const AString & a_Style = "");
 
    void AddUrlPart(const AString & a_Text, const AString & a_Url, const AString & a_Style = "nc");
 
    void AddRunCommandPart(const AString & a_Text, const AString & a_Command, const AString & a_Style = "na");
 
    void AddSuggestCommandPart(const AString & a_Text, const AString & a_SuggestedCommand, const AString & a_Style = "nb");
 
    void AddShowAchievementPart(const AString & a_PlayerName, const AString & a_Achievement, const AString & a_Style = "");
 
    void ParseText(const AString & a_ParseText);
 
    void UnderlineUrls(void);
 
    void SetMessageType(eMessageType a_MessageType, const AString & a_AdditionalMessageTypeData = "");
 
    // tolua_begin
 
    eMessageType GetMessageType(void) const { return m_MessageType; }
 
    AString GetAdditionalMessageTypeData(void) const { return m_AdditionalMessageTypeData; }
 
    AString ExtractText(void) const;
 
    AString CreateJsonString(bool a_ShouldUseChatPrefixes = true) const;
 
    // tolua_end
 
    const auto & GetParts(void) const { return m_Parts; }
 
    static eLogLevel MessageTypeToLogLevel(eMessageType a_MessageType);
 
    void AddChatPartStyle(Json::Value & a_Value, const AString & a_PartStyle) const;
 
protected:
 
    std::vector<std::variant<TextPart, ClientTranslatedPart, UrlPart, RunCommandPart, SuggestCommandPart, ShowAchievementPart>> m_Parts;
 
    eMessageType m_MessageType;
 
    AString m_AdditionalMessageTypeData;
 
} ;  // tolua_export