FQuestObjectives Struct Reference

#include <QuestData.h>

Inheritance diagram for FQuestObjectives:

Public Member Functions
	FQuestObjectives ()
bool	AddProgress (const int32 Amount)
bool	AddFailProgress (const int32 Amount)
void	StartObjective (const UObject *Owner)
void	StartObjective (const UObject *Owner, const int32 QuestProgress)
void	ResumeFromElapsedTime ()
float	SaveObjectiveTime (const UObject *Owner)
void	SetUniqueID (const int32 ID)
FUniqueID	GetUniqueID () const
float	GetElapsedTime () const
float	GetStartTime () const
bool	GetDidCompleteInTime () const
int32	GetCurrentProgress () const
int32	GetFailProgress () const
float	GetCurrentProgressPercent () const
float	GetFailProgressPercent () const
bool	CanStart (const int32 TotalProgress) const
bool	GetIsFailed () const
bool	GetIsActive () const
bool	GetIsStarted () const
bool	GetIsNotYetStarted () const
bool	GetIsFinished () const
bool	GetIsSuccessful () const
bool	GetIsComplete () const
EQuestStatus	GetStatus () const
bool	operator== (const FQuestObjectives &Other) const
bool	operator!= (const FQuestObjectives &Other) const
bool	operator== (const FUniqueID &OtherID) const
bool	operator!= (const FUniqueID &OtherID) const

Public Attributes
FString	ObjectiveID = "Default Quest Objective"
FString	ObjectiveDescription = "Default Description"
TArray< FString >	ObjectiveHints = {"Objective","Hint"}
bool	bHasWorldMarker = false
bool	bIsOptional = false
int32	RequiredFailProgress = 100
int32	RequiredProgress = 100
bool	bShowProgress = true
bool	bShowFailProgress = true
bool	bDynamicProgress = false
bool	bIsUnlockedAtCertainProgress = false
int32	UnlockProgressNeeded = 15
bool	bObjectiveTimed = false
float	TimeToComplete = 10.0f
FQuestReward	RewardBonus
FQuestObjectivesStatus	ObjectiveStatus
bool	bBranchObjective = false

Constructor & Destructor Documentation

FQuestObjectives()

FQuestObjectives::FQuestObjectives ( )

inline

    {
    
    }

Member Function Documentation

AddFailProgress()

bool FQuestObjectives::AddFailProgress ( const int32 Amount )

inline

Returns if Completed

    {
        return ObjectiveStatus.AddFailProgress(Amount, RequiredFailProgress);
    }

AddProgress()

bool FQuestObjectives::AddProgress ( const int32 Amount )

inline

Returns if Completed

    {
        return ObjectiveStatus.AddProgress(Amount, RequiredProgress);
    }

CanStart()

bool FQuestObjectives::CanStart ( const int32 TotalProgress ) const

inline

    {
        if(bIsUnlockedAtCertainProgress)
        {
            return TotalProgress >= UnlockProgressNeeded;
        }
        return true;
    }

GetCurrentProgress()

int32 FQuestObjectives::GetCurrentProgress ( ) const

inline

    {
        return ObjectiveStatus.GetCurrentProgress();
    }

GetCurrentProgressPercent()

float FQuestObjectives::GetCurrentProgressPercent ( ) const

inline

Percent between 1-0, * 100 for full percent

    {
        return static_cast<float>(GetCurrentProgress()) / static_cast<float>(RequiredProgress);
    }

GetDidCompleteInTime()

bool FQuestObjectives::GetDidCompleteInTime ( ) const

inline

    {
        return ObjectiveStatus.GetDidCompleteInTime(bObjectiveTimed, TimeToComplete);
    }

GetElapsedTime()

float FQuestObjectives::GetElapsedTime ( ) const

inline

    {
        return ObjectiveStatus.GetElapsedTime();
    }

GetFailProgress()

int32 FQuestObjectives::GetFailProgress ( ) const

inline

    {
        return ObjectiveStatus.GetFailProgress();
    }

GetFailProgressPercent()

float FQuestObjectives::GetFailProgressPercent ( ) const

inline

    {
        return static_cast<float>(GetFailProgress()) / static_cast<float>(RequiredFailProgress);
    }

GetIsActive()

bool FQuestObjectives::GetIsActive ( ) const

inline

    {
        return ObjectiveStatus.IsActive();
    }

GetIsComplete()

bool FQuestObjectives::GetIsComplete ( ) const

inline

    {
        return ObjectiveStatus.Complete(RequiredFailProgress, RequiredProgress);
    }

GetIsFailed()

bool FQuestObjectives::GetIsFailed ( ) const

inline

    {
        return ObjectiveStatus.GetIsFailed(RequiredFailProgress);
    }

GetIsFinished()

bool FQuestObjectives::GetIsFinished ( ) const

inline

    {
        return ObjectiveStatus.IsFinished(RequiredFailProgress, RequiredProgress);
    }

GetIsNotYetStarted()

bool FQuestObjectives::GetIsNotYetStarted ( ) const

inline

    {
        return ObjectiveStatus.GetIsNotYetStarted();
    }

GetIsStarted()

bool FQuestObjectives::GetIsStarted ( ) const

inline

    {
        return ObjectiveStatus.GetIsStarted();
    }

GetIsSuccessful()

bool FQuestObjectives::GetIsSuccessful ( ) const

inline

    {
        return ObjectiveStatus.IsSuccessful(RequiredFailProgress, RequiredProgress);
    }

GetStartTime()

float FQuestObjectives::GetStartTime ( ) const

inline

    {
        return ObjectiveStatus.GetStartTime();
    }

GetStatus()

EQuestStatus FQuestObjectives::GetStatus ( ) const

inline

    {
        return ObjectiveStatus.GetStatus();
    }

GetUniqueID()

FUniqueID FQuestObjectives::GetUniqueID ( ) const

inline

    {
        FUniqueID ID = FUniqueID(ObjectiveID);
        ID.SetUniqueNumber(ObjectiveStatus.GetUniqueID());
        return ID;
    }

operator!=() [1/2]

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

inline

    {
        return (ObjectiveID != Other.ObjectiveID) || ((ObjectiveID == Other.ObjectiveID) && (GetUniqueID() != Other.GetUniqueID()));
    }

operator!=() [2/2]

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

inline

    {
        return (GetUniqueID() != OtherID);
        // if(bUnique){return (GetUniqueID() != OtherID);}
        // return (ObjectiveID != OtherID.ID);
    }

operator==() [1/2]

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

inline

    {
        return (ObjectiveID == Other.ObjectiveID) && (GetUniqueID() == Other.GetUniqueID());
    }

operator==() [2/2]

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

inline

    {
        return (GetUniqueID() == OtherID);
        // if(bUnique){return (GetUniqueID() == OtherID);}
        // return (ObjectiveID == OtherID.ID);
    }

ResumeFromElapsedTime()

void FQuestObjectives::ResumeFromElapsedTime ( )

inline

    {
        ObjectiveStatus.ResumeFromElapsedTime();
    }

SaveObjectiveTime()

float FQuestObjectives::SaveObjectiveTime ( const UObject * Owner )

inline

    {
        return ObjectiveStatus.SaveObjectiveTime(Owner);
    }

SetUniqueID()

void FQuestObjectives::SetUniqueID ( const int32 ID )

inline

    {
        ObjectiveStatus.SetUniqueID(ID);
    }

StartObjective() [1/2]

void FQuestObjectives::StartObjective ( const UObject * Owner )

inline

    {
        if(bIsUnlockedAtCertainProgress && CanStart(GetCurrentProgress()) == false)
        {
            ObjectiveStatus.SetObjectiveNotYetStarted();
            return;
        }
        ObjectiveStatus.StartObjective(Owner);
    }

StartObjective() [2/2]

void FQuestObjectives::StartObjective ( const UObject * Owner, const int32 QuestProgress )

inline

    {
        if(bIsUnlockedAtCertainProgress && CanStart(QuestProgress) == false)
        {
            ObjectiveStatus.SetObjectiveNotYetStarted();
            return;
        }
        ObjectiveStatus.StartObjective(Owner);
    }

Member Data Documentation

bBranchObjective

bool FQuestObjectives::bBranchObjective = false

bDynamicProgress

bool FQuestObjectives::bDynamicProgress = false

Progress can be based on how many items in the world

bHasWorldMarker

bool FQuestObjectives::bHasWorldMarker = false

bIsOptional

bool FQuestObjectives::bIsOptional = false

bIsUnlockedAtCertainProgress

bool FQuestObjectives::bIsUnlockedAtCertainProgress = false

this should only be applied to Unique Objectives

bObjectiveTimed

bool FQuestObjectives::bObjectiveTimed = false

bShowFailProgress

bool FQuestObjectives::bShowFailProgress = true

bShowProgress

bool FQuestObjectives::bShowProgress = true

ObjectiveDescription

FString FQuestObjectives::ObjectiveDescription = "Default Description"

ObjectiveHints

TArray<FString> FQuestObjectives::ObjectiveHints = {"Objective","Hint"}

{"Objective","Hint"};

ObjectiveID

FString FQuestObjectives::ObjectiveID = "Default Quest Objective"

ObjectiveStatus

FQuestObjectivesStatus FQuestObjectives::ObjectiveStatus

RequiredFailProgress

int32 FQuestObjectives::RequiredFailProgress = 100

RequiredProgress

int32 FQuestObjectives::RequiredProgress = 100

RewardBonus

FQuestReward FQuestObjectives::RewardBonus

TimeToComplete

float FQuestObjectives::TimeToComplete = 10.0f

UnlockProgressNeeded

int32 FQuestObjectives::UnlockProgressNeeded = 15

---

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