UQuestSystemObjectiveWidget Class Reference

A widget class used to display quest objectives. More...

#include <QuestSystemObjectiveWidget.h>

Inheritance diagram for UQuestSystemObjectiveWidget:

Public Member Functions
	UQuestSystemObjectiveWidget (const FObjectInitializer &ObjectInitializer)
void	SetObjective (const FQuestObjectives &Objective)
FQuestObjectives	GetQuestObjective () const

Public Attributes
bool	bShortObjectiveDescription = false
int32	ShortenedLength = 17

Protected Member Functions
virtual void	NativeConstruct () override
virtual bool	Initialize () override
void	SetValues ()

Protected Attributes
FQuestObjectives	QuestObjective
FLinearColor	CompleteColor = FLinearColor::Blue
FLinearColor	InProgressColor = FLinearColor::Yellow
FLinearColor	OptionalColor = FLinearColor::White
FLinearColor	FailedColor = FLinearColor::Red
class UTextBlock *	ObjectiveNameText = nullptr
class UTextBlock *	ObjectiveProgressText = nullptr
TSubclassOf< class UBaseQuestSystemWidget >	ObjectiveTipTextClass = nullptr
class UImage *	StatusImage = nullptr
class UProgressBar *	ProgressBar = nullptr
class UProgressBar *	FailProgressBar = nullptr
class UOverlay *	ProgressOverlay = nullptr
class UScrollBox *	QuestObjectiveTipBox = nullptr

Detailed Description

A widget class used to display quest objectives.

Constructor & Destructor Documentation

UQuestSystemObjectiveWidget()

UQuestSystemObjectiveWidget::UQuestSystemObjectiveWidget

(

const FObjectInitializer &

ObjectInitializer

)

    :Super(ObjectInitializer)
{
    const ConstructorHelpers::FClassFinder<UBaseQuestSystemWidget> ObjectiveTipBP(TEXT("/QuestSystem/Widgets/WBP_QuestSystemObjectiveTip"));
    if (!ensure(ObjectiveTipBP.Class != nullptr)) return;
    ObjectiveTipTextClass = ObjectiveTipBP.Class;
}

Member Function Documentation

GetQuestObjective()

FQuestObjectives UQuestSystemObjectiveWidget::GetQuestObjective

(

)

const

{
    return QuestObjective;
}

Initialize()

bool UQuestSystemObjectiveWidget::Initialize ( )

overrideprotectedvirtual

{
    const bool Success = Super::Initialize();
    if (!ensure(ObjectiveNameText != nullptr)) return false;
    if (!ensure(ObjectiveProgressText != nullptr)) return false;    
    if (!ensure(StatusImage != nullptr)) return false;    
    if (!ensure(QuestObjectiveTipBox != nullptr)) return false;
    if (!ensure(ProgressBar != nullptr)) return false;
    if (!ensure(FailProgressBar != nullptr)) return false;
    if(!Success) return false;
    return true;
}

NativeConstruct()

void UQuestSystemObjectiveWidget::NativeConstruct ( )

overrideprotectedvirtual

{
    Super::NativeConstruct();
    SetValues();
}

SetObjective()

void UQuestSystemObjectiveWidget::SetObjective

(

const FQuestObjectives &

Objective

)

{
    QuestObjective = Objective;
    SetValues();
}

SetValues()

void UQuestSystemObjectiveWidget::SetValues ( )

protected

{
    // if(QuestObjective == nullptr){return;}
    //- Set Objective Text, Shorten if needed   //
    FString ObjectiveText;
    if(bShortObjectiveDescription)
    {
        if(QuestObjective.ObjectiveDescription.Len() > ShortenedLength)
        {
            FString ObjectiveSubString = UKismetStringLibrary::GetSubstring(QuestObjective.ObjectiveDescription, 0, ShortenedLength);
            ObjectiveText = ObjectiveSubString.Append("...");
        }
        else
        {
            ObjectiveText = QuestObjective.ObjectiveDescription;
        }
    }
    else
    {
        ObjectiveText = QuestObjective.ObjectiveDescription;
    }
    // if (!ensure(QuestObjective != nullptr)) return;
    // if (!ensure(QuestObjective.ObjectiveDescription.Len() >= 0)) return;
    // UE_LOG(LogTemp, Warning, TEXT("ObjectiveDescription: %s"), *QuestObjective->ObjectiveDescription);
 
    if(ObjectiveNameText == nullptr){return;}
    ObjectiveNameText->SetText(FText::FromString(ObjectiveText));
 
    //- Set Objective Progress  //
    if(QuestObjective.bShowProgress)
    {
        ObjectiveProgressText->SetVisibility(ESlateVisibility::Visible);
        const FText FormattedProgress = FText::Format(  NSLOCTEXT("","","{0}/{1}"),
        FText::AsNumber(QuestObjective.GetCurrentProgress()),
        FText::AsNumber(QuestObjective.RequiredProgress));
        // UE_LOG(LogQuestSystem,Warning,TEXT("%s Current Progress %i"), *QuestObjective.ObjectiveDescription, QuestObjective.CurrentProgress);
        ObjectiveProgressText->SetText(FormattedProgress);
    }
    else
    {
        ObjectiveProgressText->SetVisibility(ESlateVisibility::Collapsed);
    }
    
    QuestObjectiveTipBox->ClearChildren();
 
    if(ObjectiveTipTextClass != nullptr && QuestObjective.GetIsActive())
    {
        for(const FString& QuestObjectiveTip : QuestObjective.ObjectiveHints)
        {
            UBaseQuestSystemWidget* ObjectiveTipText = CreateWidget<UBaseQuestSystemWidget>(GetOwningPlayer(), ObjectiveTipTextClass);
            if(ObjectiveTipText == nullptr){continue;}
            ObjectiveTipText->TitleText = QuestObjectiveTip;
            if(QuestObjectiveTipBox == nullptr){continue;}
            QuestObjectiveTipBox->AddChild(ObjectiveTipText);
        }
    }
    if(ProgressOverlay != nullptr)
    {
        if(QuestObjective.bShowProgress)
        {
            ProgressOverlay->SetVisibility(ESlateVisibility::Visible);
        }
        else
        {
            ProgressOverlay->SetVisibility(ESlateVisibility::Collapsed);
        }
        
    }
    if(ProgressBar != nullptr)
    {
        if(QuestObjective.bShowProgress)
        {
            ProgressBar->SetVisibility(ESlateVisibility::Visible);
            ProgressBar->SetPercent(QuestObjective.GetCurrentProgressPercent());
        }
        else
        {
            ProgressBar->SetVisibility(ESlateVisibility::Collapsed);
        }
    }
    if(FailProgressBar != nullptr)
    {
        if(QuestObjective.bShowFailProgress)
        {
            FailProgressBar->SetVisibility(ESlateVisibility::Visible);
            FailProgressBar->SetPercent(QuestObjective.GetFailProgressPercent());
        }
        else
        {
            FailProgressBar->SetVisibility(ESlateVisibility::Collapsed);
        }
 
    }
    if(QuestObjective.GetStatus() == EQuestStatus::Active)
    {
        StatusImage->SetBrushTintColor(InProgressColor);
    }
    if(QuestObjective.bIsOptional)
    {
        StatusImage->SetBrushTintColor(OptionalColor);
    }
    if(QuestObjective.GetIsComplete())
    {
        StatusImage->SetBrushTintColor(CompleteColor);
        QuestObjectiveTipBox->ClearChildren();
        if(QuestObjective.GetIsSuccessful() == false)
        {
            StatusImage->SetBrushTintColor(FailedColor);
            QuestObjectiveTipBox->ClearChildren();
        }
    }
 
}

Member Data Documentation

bShortObjectiveDescription

bool UQuestSystemObjectiveWidget::bShortObjectiveDescription = false

CompleteColor

FLinearColor UQuestSystemObjectiveWidget::CompleteColor = FLinearColor::Blue

protected

FailedColor

FLinearColor UQuestSystemObjectiveWidget::FailedColor = FLinearColor::Red

protected

FailProgressBar

class UProgressBar* UQuestSystemObjectiveWidget::FailProgressBar = nullptr

protected

InProgressColor

FLinearColor UQuestSystemObjectiveWidget::InProgressColor = FLinearColor::Yellow

protected

ObjectiveNameText

class UTextBlock* UQuestSystemObjectiveWidget::ObjectiveNameText = nullptr

protected

ObjectiveProgressText

class UTextBlock* UQuestSystemObjectiveWidget::ObjectiveProgressText = nullptr

protected

ObjectiveTipTextClass

TSubclassOf<class UBaseQuestSystemWidget> UQuestSystemObjectiveWidget::ObjectiveTipTextClass = nullptr

protected

OptionalColor

FLinearColor UQuestSystemObjectiveWidget::OptionalColor = FLinearColor::White

protected

ProgressBar

class UProgressBar* UQuestSystemObjectiveWidget::ProgressBar = nullptr

protected

ProgressOverlay

class UOverlay* UQuestSystemObjectiveWidget::ProgressOverlay = nullptr

protected

QuestObjective

FQuestObjectives UQuestSystemObjectiveWidget::QuestObjective

protected

QuestObjectiveTipBox

class UScrollBox* UQuestSystemObjectiveWidget::QuestObjectiveTipBox = nullptr

protected

ShortenedLength

int32 UQuestSystemObjectiveWidget::ShortenedLength = 17

StatusImage

class UImage* UQuestSystemObjectiveWidget::StatusImage = nullptr

protected

---

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

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