UChatBoxWidget Class Reference

#include <ChatBoxWidget.h>

Inheritance diagram for UChatBoxWidget:

Public Member Functions
virtual void	NativeConstruct () override
void	SetHintChatText (FString HintText)
void	OnSentChatMessage (const FString &Text)
void	ToggleChat (bool bOpen)
void	MessageReceived ()

Public Attributes
FOnChatToggled	OnChatToggled
FOnExecuteCommand	OnExecuteCommand
FOnSendMessage	OnSendMessage
EChatSystemCategory	ChatSystemCategory = EChatSystemCategory::All
FString	CommandsPrefix = "/"
TArray< FString >	AllChatCommands
FString	CleanCommandString
FString	RawCommandString
class UScrollBox *	ChatScrollBox
class UChatTextFieldWidget *	ChatTextFieldWidget

Protected Member Functions
bool	GetCommandAndArguments (const FString &Text, EChatSystemCommandType &Command, FString &Arguments)

Member Function Documentation

GetCommandAndArguments()

bool UChatBoxWidget::GetCommandAndArguments ( const FString & Text, EChatSystemCommandType & Command, FString & Arguments )

protected

{
    if(UKismetStringLibrary::ParseIntoArray(Text).IsEmpty()){return false;}
    RawCommandString = UKismetStringLibrary::ParseIntoArray(Text)[0];
    CleanCommandString = UKismetStringLibrary::Replace(RawCommandString, CommandsPrefix, "").ToLower();
    if(AllChatCommands.Contains(CleanCommandString))
    {
        uint8 EnumByte = UKismetMathLibrary::Conv_IntToByte(AllChatCommands.Find(CleanCommandString));
        Command = static_cast<EChatSystemCommandType>(EnumByte);
        Arguments = UKismetStringLibrary::Trim(UKismetStringLibrary::Replace(Text, RawCommandString, ""));
        return true;
    }
    return false;
}

MessageReceived()

void UChatBoxWidget::MessageReceived

(

)

NativeConstruct()

void UChatBoxWidget::NativeConstruct ( )

overridevirtual

{
    Super::NativeConstruct();
    ToggleChat(false);
    if(ChatScrollBox != nullptr)
    {
        ChatScrollBox->ScrollToEnd();
    }
 
    //-     Fill the Array with all Chat Commands   //
    const UEnum* ChatSystemCommandsEnum = StaticEnum<EChatSystemCommandType>();
    if(ChatSystemCommandsEnum == nullptr){return;}
    for(int32 i = 0; i < ChatSystemCommandsEnum->NumEnums() -1; ++i)
    {
        //- Convert the enum value to a string  //
        FString ChatSystemCommand = ChatSystemCommandsEnum->GetDisplayNameTextByIndex(i).ToString();
        AllChatCommands.Add(ChatSystemCommand.ToLower());
    }
}

OnSentChatMessage()

void UChatBoxWidget::OnSentChatMessage

(

const FString &

Text

)

{
    EChatSystemCommandType CommandType;
    FString CommandArguments;
    if(GetCommandAndArguments(Text, CommandType, CommandArguments))
    {
        OnExecuteCommand.Broadcast(CommandType, CommandArguments);
    }
    else
    {
        if(!Text.IsEmpty())
        {
            OnSendMessage.Broadcast(Text, EChatSystemMessageType::Default, ChatSystemCategory);
        }
        else
        {
            OnChatToggled.Broadcast(false);
        }
    }
}

SetHintChatText()

void UChatBoxWidget::SetHintChatText

(

FString

HintText

)

{
    if(ChatTextFieldWidget != nullptr)
    {
        ChatTextFieldWidget->SetHintChatText(HintText);
    }
}

ToggleChat()

void UChatBoxWidget::ToggleChat

(

bool

bOpen

)

{
    if(ChatTextFieldWidget != nullptr)
    {
        ChatTextFieldWidget->ToggleChat(bOpen);
    }
    OnChatToggled.Broadcast(bOpen);
}

Member Data Documentation

AllChatCommands

TArray<FString> UChatBoxWidget::AllChatCommands

ChatScrollBox

class UScrollBox* UChatBoxWidget::ChatScrollBox

ChatSystemCategory

EChatSystemCategory UChatBoxWidget::ChatSystemCategory = EChatSystemCategory::All

ChatTextFieldWidget

class UChatTextFieldWidget* UChatBoxWidget::ChatTextFieldWidget

CleanCommandString

FString UChatBoxWidget::CleanCommandString

CommandsPrefix

FString UChatBoxWidget::CommandsPrefix = "/"

OnChatToggled

FOnChatToggled UChatBoxWidget::OnChatToggled

OnExecuteCommand

FOnExecuteCommand UChatBoxWidget::OnExecuteCommand

OnSendMessage

FOnSendMessage UChatBoxWidget::OnSendMessage

RawCommandString

FString UChatBoxWidget::RawCommandString

---

The documentation for this class was generated from the following files:

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/ChatSystem/Source/ChatSystem/Public/Widgets/ChatBoxWidget.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/ChatSystem/Source/ChatSystem/Private/Widgets/ChatBoxWidget.cpp