FQuestInfoStatus Struct Reference

#include <QuestData.h>

Public Member Functions
void	StartQuest (const UObject *Owner)
void	SetStatus (const EQuestStatus NewQuestStatus)
bool	GetIsActive () const
EQuestStatus	GetQuestStatus () const
TArray< FString >	GetAllObjectiveIDs () const
int32	GetObjectivesNum () const
int32	GetTotalProgress () const
int32	GetTotalRequiredProgress () const
float	SaveQuestTime (const UObject *Owner)
void	ResumeFromElapsedTime ()
bool	GetDidCompleteInTime (const float TimeToComplete) const
bool	GetCanBeCompleted (const UObject *Owner, EQuestStatus &QuestOutcome)
float	GetElapsedTime () const
float	GetStartTime () const
int32	GetUniqueID () const
void	SetUniqueID (const int32 ID)
TArray< FString >	GetActiveObjectiveIDs () const
TArray< FString >	GetNotStartedObjectiveIDs () const
TArray< FString >	GetActiveObjectiveIDsWithMarkers () const

Public Attributes
TArray< const FQuestObjectives * >	ObjectiveReferences

Protected Attributes
EQuestStatus	QuestStatus = EQuestStatus::NotStarted
int32	UniqueID = 0
float	StartTimeInSeconds = -1.0f
float	ElapsedTime = -1.0f

Member Function Documentation

GetActiveObjectiveIDs()

TArray< FString > FQuestInfoStatus::GetActiveObjectiveIDs ( ) const

inline

    {
        TArray<FString> ActiveObjectiveIDs;
        for(const auto& Objective : ObjectiveReferences)
        {
            if(Objective != nullptr)
            {
                if(Objective->GetIsActive())
                {
                    ActiveObjectiveIDs.Add(Objective->ObjectiveID);
                }
            }
        }
        return ActiveObjectiveIDs;
    }

GetActiveObjectiveIDsWithMarkers()

TArray< FString > FQuestInfoStatus::GetActiveObjectiveIDsWithMarkers ( ) const

inline

    {
        TArray<FString> ActiveObjectiveIDs;
        for(const auto& Objective : ObjectiveReferences)
        {
            if(Objective != nullptr)
            {
                if(Objective->GetIsActive())
                {
                    if(Objective->bHasWorldMarker)
                    {
                        ActiveObjectiveIDs.Add(Objective->ObjectiveID);
                    }
                }
            }
        }
        return ActiveObjectiveIDs;
    }

GetAllObjectiveIDs()

TArray< FString > FQuestInfoStatus::GetAllObjectiveIDs ( ) const

inline

    {
        TArray<FString> AllObjectiveIDs;
        for(const auto& Objective: ObjectiveReferences)
        {
            if(Objective == nullptr){continue;}
            AllObjectiveIDs.AddUnique(Objective->ObjectiveID);
        }
        return AllObjectiveIDs;
    }

GetCanBeCompleted()

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

inline

    {
        //- Sets Elapsed Time   //
        SaveQuestTime(Owner);
        QuestOutcome = QuestStatus;
        if(QuestOutcome != EQuestStatus::Active){return false;}
        //@ TODO add this function to Player Quest Status, which can check Objectives too 
        for(const FQuestObjectives* QuestObjective : ObjectiveReferences)
        {
            //- Don't Check Optional Objectives //
            if(QuestObjective->bIsOptional){continue;}
            if(QuestObjective->GetIsFailed())
            {
                QuestOutcome = EQuestStatus::Failed;
                return true;
            }
            if(QuestObjective->bObjectiveTimed && !QuestObjective->GetDidCompleteInTime())
            {
                QuestOutcome = EQuestStatus::Failed;
                return true;
            }
            //- If any of the non optional Objectives aren't complete   //
            if(QuestObjective->GetIsFinished() == false)
            {
                QuestOutcome = EQuestStatus::Active;
                return false;
            }
        }
        //- All Objectives Complete //
        QuestOutcome = EQuestStatus::Completed;
        return true;
    }

GetDidCompleteInTime()

bool FQuestInfoStatus::GetDidCompleteInTime ( const float TimeToComplete ) const

inline

    {
        //- Sets ElapsedTime    //
        if(StartTimeInSeconds >= 0.0f)
        {
            return ElapsedTime <= TimeToComplete;
        }
        return false;
    }

GetElapsedTime()

float FQuestInfoStatus::GetElapsedTime ( ) const

inline

    {
        return ElapsedTime;
    }

GetIsActive()

bool FQuestInfoStatus::GetIsActive ( ) const

inline

    {
        return QuestStatus == EQuestStatus::Active;
    }

GetNotStartedObjectiveIDs()

TArray< FString > FQuestInfoStatus::GetNotStartedObjectiveIDs ( ) const

inline

    {
        TArray<FString> NotStartedObjectiveIDs;
        for(const auto& Objective : ObjectiveReferences)
        {
            if(Objective != nullptr)
            {
                if(Objective->GetIsNotYetStarted())
                {
                    NotStartedObjectiveIDs.Add(Objective->ObjectiveID);
                }
            }
        }
        return NotStartedObjectiveIDs;
    }

GetObjectivesNum()

int32 FQuestInfoStatus::GetObjectivesNum ( ) const

inline

    {
        return ObjectiveReferences.Num();
    }

GetQuestStatus()

EQuestStatus FQuestInfoStatus::GetQuestStatus ( ) const

inline

    {
        return QuestStatus;
    }

GetStartTime()

float FQuestInfoStatus::GetStartTime ( ) const

inline

    {
        return StartTimeInSeconds;
    }

GetTotalProgress()

int32 FQuestInfoStatus::GetTotalProgress ( ) const

inline

    {
        int32 TotalProgress = 0;
        for(const auto& Objective : ObjectiveReferences)
        {
            if(Objective == nullptr){continue;}
            if(!Objective->bIsOptional)
            {
                TotalProgress += Objective->GetCurrentProgress();
            }
        }
        return TotalProgress;
    }

GetTotalRequiredProgress()

int32 FQuestInfoStatus::GetTotalRequiredProgress ( ) const

inline

    {
        int32 TotalRequired = 0;
        for(const auto& Objective : ObjectiveReferences)
        {
            if(Objective == nullptr){continue;}
            if(!Objective->bIsOptional)
            {
                TotalRequired += Objective->RequiredProgress;
            }
        }
        return TotalRequired;
    }

GetUniqueID()

int32 FQuestInfoStatus::GetUniqueID ( ) const

inline

    {
        return UniqueID;
    }

ResumeFromElapsedTime()

void FQuestInfoStatus::ResumeFromElapsedTime ( )

inline

    {
        if(QuestStatus != EQuestStatus::Active){return;}
        StartTimeInSeconds = -ElapsedTime;
    }

SaveQuestTime()

float FQuestInfoStatus::SaveQuestTime ( const UObject * Owner )

inline

    {
        if(GetIsActive())
        {
            if(const UWorld* World = GEngine->GetWorldFromContextObject(Owner, EGetWorldErrorMode::LogAndReturnNull))
            {
                const float CurrentTimeInSeconds = World->GetTimeSeconds();
                ElapsedTime = CurrentTimeInSeconds - StartTimeInSeconds;
            }
        }
        return ElapsedTime;
    }

SetStatus()

void FQuestInfoStatus::SetStatus ( const EQuestStatus NewQuestStatus )

inline

    {
        QuestStatus = NewQuestStatus;
    }

SetUniqueID()

void FQuestInfoStatus::SetUniqueID ( const int32 ID )

inline

    {
        UniqueID = ID;
    }

StartQuest()

void FQuestInfoStatus::StartQuest ( const UObject * Owner )

inline

    {
        if(GetQuestStatus() == EQuestStatus::Active){return;}
        SetStatus(EQuestStatus::Active);
        if(const UWorld* World = GEngine->GetWorldFromContextObject(Owner, EGetWorldErrorMode::LogAndReturnNull))
        {
            StartTimeInSeconds = World->GetTimeSeconds();
        }
    }

Member Data Documentation

ElapsedTime

float FQuestInfoStatus::ElapsedTime = -1.0f

protected

ObjectiveReferences

TArray<const FQuestObjectives*> FQuestInfoStatus::ObjectiveReferences

QuestStatus

EQuestStatus FQuestInfoStatus::QuestStatus = EQuestStatus::NotStarted

protected

StartTimeInSeconds

float FQuestInfoStatus::StartTimeInSeconds = -1.0f

protected

UniqueID

int32 FQuestInfoStatus::UniqueID = 0

protected

---

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