FQuestInfo Struct Reference

#include <QuestData.h>

Inheritance diagram for FQuestInfo:

Public Member Functions
	FQuestInfo ()
	FQuestInfo (const FQuestInfoStatus &QuestStatus)
bool	operator== (const FQuestInfo &Other) const
bool	operator!= (const FQuestInfo &Other) const
bool	operator== (const FUniqueID &OtherID) const
bool	operator!= (const FUniqueID &OtherID) const
bool	IsValid () const
bool	GetIsActive () const
EQuestStatus	GetQuestStatus () const
void	SetUniqueID (const int32 ID)
FUniqueID	GetUniqueID () const
void	SetStatus (const EQuestStatus NewQuestStatus)
int32	GetObjectivesNum () const
int32	GetTotalProgress () const
int32	GetTotalRequiredProgress () const
float	GetElapsedTime () const
float	GetStartTime () const
void	StartQuest (const UObject *Owner)
float	SaveQuestTime (const UObject *Owner)
void	ResumeFromElapsedTime ()
bool	GetIsQuestInTime () const
TArray< FQuestObjectives >	GetCompletedObjectives () const
TArray< FString >	GetActiveObjectiveIDs () const
TArray< FString >	GetNotStartedObjectiveIDs () const
TArray< FString >	GetActiveObjectiveIDsWithMarkers () const
FQuestReward	GetFullQuestReward () const
TArray< FQuestObjectives >	GetObjectives () const
bool	GetCanBeCompleted (const UObject *Owner, EQuestStatus &QuestOutcome)

Static Public Member Functions
static FQuestInfo	Empty ()

Public Attributes
FString	QuestID = "QID_01"
FString	QuestName = "Quest Name"
FString	Description = "Quest Description"
TArray< FString >	ObjectiveIDs = {"QOID_01", "QOID_02"}
bool	bUniqueObjectives = true
bool	bShowOverallProgress = false
FQuestReward	Reward = FQuestReward()
TArray< FString >	RequiredQuests
TArray< FString >	QuestsToBeAddedAfterCompletion
bool	bCanQuestBeAbandoned = false
bool	bCanQuestFail = false
bool	bCanRetry = false
bool	bRepeatable = false
FQuestInfoStatus	Status
bool	bQuestTimed = false
float	TimeToComplete = 10.0f
FGameplayTag	CategoryTag
EFilterQuestType	Category = EFilterQuestType::Main
EQuestLocation	Location = EQuestLocation::PlayerShip
FGameplayTag	LocationTag
int32	RecommendedLevel = 0

Constructor & Destructor Documentation

FQuestInfo() [1/2]

FQuestInfo::FQuestInfo ( )

inline

    {
        
    }

FQuestInfo() [2/2]

FQuestInfo::FQuestInfo ( const FQuestInfoStatus & QuestStatus )

inlineexplicit

    {
        Status = QuestStatus;
    }

Member Function Documentation

Empty()

static FQuestInfo FQuestInfo::Empty ( )

inlinestatic

    {
        FQuestInfo EmptyQuestInfo;
        return EmptyQuestInfo;
    }

GetActiveObjectiveIDs()

TArray< FString > FQuestInfo::GetActiveObjectiveIDs ( ) const

inline

    {
        return Status.GetActiveObjectiveIDs();
    }

GetActiveObjectiveIDsWithMarkers()

TArray< FString > FQuestInfo::GetActiveObjectiveIDsWithMarkers ( ) const

inline

    {
        return Status.GetActiveObjectiveIDsWithMarkers();
    }

GetCanBeCompleted()

bool FQuestInfo::GetCanBeCompleted ( const UObject * Owner, EQuestStatus & QuestOutcome )

inline

    {
        //- Sets Elapsed Time   //
        SaveQuestTime(Owner);
        if(GetIsQuestInTime())
        {
            return Status.GetCanBeCompleted(Owner, QuestOutcome);
        }
        QuestOutcome = EQuestStatus::Failed;
        return true;
    }

GetCompletedObjectives()

TArray< FQuestObjectives > FQuestInfo::GetCompletedObjectives ( ) const

inline

    {
        TArray<FQuestObjectives> CompletedObjectives;
        for(const auto& Objective : Status.ObjectiveReferences)
        {
            if(Objective == nullptr){continue;}
            if(Objective->GetIsComplete())
            {
                CompletedObjectives.AddUnique(*Objective);
            }
        }
        return CompletedObjectives;
    }

GetElapsedTime()

float FQuestInfo::GetElapsedTime ( ) const

inline

    {
        return Status.GetElapsedTime();
    }

GetFullQuestReward()

FQuestReward FQuestInfo::GetFullQuestReward ( ) const

inline

    {
        FQuestReward FullReward = Reward;
        for(const auto& Objective : GetCompletedObjectives())
        {
            FullReward.Credits += Objective.RewardBonus.Credits;
            FullReward.Experience += Objective.RewardBonus.Experience;
        }
        return FullReward;
    }

GetIsActive()

bool FQuestInfo::GetIsActive ( ) const

inline

    {
        return Status.GetIsActive();
    }

GetIsQuestInTime()

bool FQuestInfo::GetIsQuestInTime ( ) const

inline

Returns if the Quest was completed in time, returns true if not a timed quest, NOT if finished

    {
        if(bQuestTimed)
        {
            return Status.GetDidCompleteInTime(TimeToComplete);
        }
        return true;
    }

GetNotStartedObjectiveIDs()

TArray< FString > FQuestInfo::GetNotStartedObjectiveIDs ( ) const

inline

    {
        return Status.GetNotStartedObjectiveIDs();
    }

GetObjectives()

TArray< FQuestObjectives > FQuestInfo::GetObjectives ( ) const

inline

    {
        TArray<FQuestObjectives> Objectives;
        for(const auto Objective : Status.ObjectiveReferences)
        {
            if(Objective == nullptr || Objective->ObjectiveID.IsEmpty())
            {
                UE_LOG(LogTemp, Warning, TEXT("Null objective pointer"));
                continue;
            }
            const FQuestObjectives ObjectiveCopy = *Objective;
            Objectives.Add(ObjectiveCopy);
        }
        return Objectives;
    }

GetObjectivesNum()

int32 FQuestInfo::GetObjectivesNum ( ) const

inline

    {
        return Status.ObjectiveReferences.Num();
    }

GetQuestStatus()

EQuestStatus FQuestInfo::GetQuestStatus ( ) const

inline

    {
        return Status.GetQuestStatus();
    }

GetStartTime()

float FQuestInfo::GetStartTime ( ) const

inline

    {
        return Status.GetStartTime();
    }

GetTotalProgress()

int32 FQuestInfo::GetTotalProgress ( ) const

inline

    {
        return Status.GetTotalProgress();
    }

GetTotalRequiredProgress()

int32 FQuestInfo::GetTotalRequiredProgress ( ) const

inline

    {
        return Status.GetTotalRequiredProgress();
    }

GetUniqueID()

FUniqueID FQuestInfo::GetUniqueID ( ) const

inline

    {
        FUniqueID ID = FUniqueID(QuestID);
        ID.SetUniqueNumber(Status.GetUniqueID());
        return ID;
    }

IsValid()

bool FQuestInfo::IsValid ( ) const

inline

    {
        if(QuestID == "Default Quest"){return false;}
        if(QuestName == "Default Name"){return false;}
        if(Status.GetObjectivesNum() == 0){return false;}
        return true;
    }

operator!=() [1/2]

bool FQuestInfo::operator!= ( const FQuestInfo & Other ) const

inline

    {
        // Define what makes two FQuestInfo structs equal.
        // In this example, we assume two FQuestInfo are equal if their QuestIDs are equal.
        // You may need to adjust this based on what makes sense for your use case.
        return (QuestID != Other.QuestID) || (GetUniqueID() != Other.GetUniqueID());
    }

operator!=() [2/2]

bool FQuestInfo::operator!= ( const FUniqueID & OtherID ) const

inline

    {
        if(bUniqueObjectives){return (GetUniqueID() != OtherID);}
        return (QuestID != OtherID.ID);
    }

operator==() [1/2]

bool FQuestInfo::operator== ( const FQuestInfo & Other ) const

inline

    {
        // Define what makes two FQuestInfo structs equal.
        // In this example, we assume two FQuestInfo are equal if their QuestIDs are equal.
        // You may need to adjust this based on what makes sense for your use case.
        return (QuestID == Other.QuestID) && (GetUniqueID() == Other.GetUniqueID());
    }

operator==() [2/2]

bool FQuestInfo::operator== ( const FUniqueID & OtherID ) const

inline

    {
        if(bUniqueObjectives){return (GetUniqueID() == OtherID);}
        return (QuestID == OtherID.ID);
    }

ResumeFromElapsedTime()

void FQuestInfo::ResumeFromElapsedTime ( )

inline

    {
        Status.ResumeFromElapsedTime();
    }

SaveQuestTime()

float FQuestInfo::SaveQuestTime ( const UObject * Owner )

inline

    {
        const float ElapsedTime = Status.SaveQuestTime(Owner);
        return ElapsedTime;
    }

SetStatus()

void FQuestInfo::SetStatus ( const EQuestStatus NewQuestStatus )

inline

    {
        Status.SetStatus(NewQuestStatus);
    }

SetUniqueID()

void FQuestInfo::SetUniqueID ( const int32 ID )

inline

    {
        Status.SetUniqueID(ID);
    }

StartQuest()

void FQuestInfo::StartQuest ( const UObject * Owner )

inline

    {
        Status.StartQuest(Owner);
    }

Member Data Documentation

bCanQuestBeAbandoned

bool FQuestInfo::bCanQuestBeAbandoned = false

bCanQuestFail

bool FQuestInfo::bCanQuestFail = false

bCanRetry

bool FQuestInfo::bCanRetry = false

bQuestTimed

bool FQuestInfo::bQuestTimed = false

bRepeatable

bool FQuestInfo::bRepeatable = false

This Quest can be done Multiple Times

bShowOverallProgress

bool FQuestInfo::bShowOverallProgress = false

bUniqueObjectives

bool FQuestInfo::bUniqueObjectives = true

Category

EFilterQuestType FQuestInfo::Category = EFilterQuestType::Main

CategoryTag

FGameplayTag FQuestInfo::CategoryTag

Description

FString FQuestInfo::Description = "Quest Description"

Location

EQuestLocation FQuestInfo::Location = EQuestLocation::PlayerShip

LocationTag

FGameplayTag FQuestInfo::LocationTag

ObjectiveIDs

TArray<FString> FQuestInfo::ObjectiveIDs = {"QOID_01", "QOID_02"}

{"QOID_01", "QOID_02"};

QuestID

FString FQuestInfo::QuestID = "QID_01"

QuestName

FString FQuestInfo::QuestName = "Quest Name"

QuestsToBeAddedAfterCompletion

TArray<FString> FQuestInfo::QuestsToBeAddedAfterCompletion

RecommendedLevel

int32 FQuestInfo::RecommendedLevel = 0

RequiredQuests

TArray<FString> FQuestInfo::RequiredQuests

Reward

FQuestReward FQuestInfo::Reward = FQuestReward()

Status

FQuestInfoStatus FQuestInfo::Status

TimeToComplete

float FQuestInfo::TimeToComplete = 10.0f

---

The documentation for this struct was generated from the following file:

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/QuestSystem/Source/QuestSystem/Public/Data/QuestData.h