UAchievementWidget Class Reference

#include <AchievementWidget.h>

Inheritance diagram for UAchievementWidget:

Public Member Functions
	UAchievementWidget (const FObjectInitializer &ObjectInitializer)
void	CreateAchievement (const FString &APIName)
void	SetAchievementProgress (const int32 Value)
FString	GetStatName () const
int32	GetStatMax () const
float	GetAchievementProgress (const int32 Value) const

Protected Member Functions
virtual bool	Initialize () override
void	OnAchievementDataSet (const bool bGetProgress)

Protected Attributes
FString	AchievementAPIName = ""
FString	AchievementName = ""
FString	AchievementDescription = ""
bool	bHidden = false
bool	bUnlocked = false
FDateTime	UnlockedTime
FString	ProgressKey = "PROGRESS_"
FString	ValueKey = "_"
class UTextBlock *	NameTextBlock = nullptr
class UTextBlock *	DateTextBlock = nullptr
class UTextBlock *	DescriptionTextBlock = nullptr
class UImage *	AchievementImage = nullptr
class UTextBlock *	PercentTextBlock = nullptr
class UTextBlock *	GlobalPercentTextBlock = nullptr
UProgressBar *	ProgressBar = nullptr

Constructor & Destructor Documentation

UAchievementWidget()

UAchievementWidget::UAchievementWidget ( const FObjectInitializer & ObjectInitializer )

explicit

    :Super(ObjectInitializer)
{
    
}

Member Function Documentation

CreateAchievement()

void UAchievementWidget::CreateAchievement

(

const FString &

APIName

)

Parameters

APIName

The Achievement Name on STEAM

{
    AchievementAPIName = APIName;
    AchievementName = UGetAchievementData::GetAchievementDisplayAttribute(AchievementAPIName, EAchievementDisplayAttributeUE4::ADA_EAttributeName);
    NameTextBlock->SetText(FText::FromString(AchievementName));
    AchievementDescription = UGetAchievementData::GetAchievementDisplayAttribute(AchievementAPIName, EAchievementDisplayAttributeUE4::ADA_EAttributeDescription);
    DescriptionTextBlock->SetText(FText::FromString(AchievementDescription));
    bHidden = UGetAchievementData::GetAchievementDisplayAttribute(AchievementAPIName, EAchievementDisplayAttributeUE4::ADA_EAttributeHidden) == "1";
    UGetAchievementData::GetAchievementUnlockStatusAndUnlockTime(AchievementAPIName, bUnlocked, UnlockedTime);
    if(bUnlocked)
    {
        const FText UnlockedTimeText = FText::AsDate(UnlockedTime.GetDate());
        const FText FormattedTime = FText::Format(NSLOCTEXT("","","Unlocked On: {0}"),
        UnlockedTimeText);
        DateTextBlock->SetText(FormattedTime);
        DateTextBlock->SetVisibility(ESlateVisibility::Visible);
    }
    else
    {
        DateTextBlock->SetVisibility(ESlateVisibility::Collapsed);
    }
    AchievementImage->SetBrushFromTexture(UGetAchievementData::GetAchievementIcon(AchievementAPIName));
    const float GlobalPercent = UGetAchievementData::GetGlobalAchievementAchievedPercent(AchievementAPIName);
    const FText FormattedGlobalPercent = FText::Format(NSLOCTEXT("","","{0} / 100%"),
    FText::AsNumber(GlobalPercent));
    GlobalPercentTextBlock->SetText(FormattedGlobalPercent);
    //@TODO Get Percent of Achievement
    
    if(AchievementAPIName.Contains(ProgressKey))
    {
        OnAchievementDataSet(true);
    }
    else
    {
        PercentTextBlock->SetVisibility(ESlateVisibility::Collapsed);
        ProgressBar->SetVisibility(ESlateVisibility::Collapsed);
        OnAchievementDataSet(false);
    }
}

GetAchievementProgress()

float UAchievementWidget::GetAchievementProgress

(

const int32

Value

)

const

{
    const float StatMax = static_cast<float>(GetStatMax());
    if(StatMax == 0)
    {
        UE_LOG(LogTemp, Warning, TEXT("UAchievementWidget::GetStatMax() returned zero."));
        return 0.0f;
    }
    return static_cast<float>(Value) / static_cast<float>(GetStatMax());
}

GetStatMax()

int32 UAchievementWidget::GetStatMax

(

)

const

{
    FString RightString;
    FString LeftString;
    AchievementAPIName.Split(ProgressKey, &LeftString, &RightString, ESearchCase::CaseSensitive);
    FString StatName;
    FString StatTotal;
    RightString.Split(ValueKey, &StatName, &StatTotal, ESearchCase::CaseSensitive);
    return UKismetStringLibrary::Conv_StringToInt(StatTotal);
}

GetStatName()

FString UAchievementWidget::GetStatName

(

)

const

{
    FString RightString;
    FString LeftString;
    AchievementAPIName.Split(ProgressKey, &LeftString, &RightString, ESearchCase::CaseSensitive);
    FString StatName;
    FString StatTotal;
    RightString.Split(ValueKey, &StatName, &StatTotal, ESearchCase::CaseSensitive);
    FString StatNameUnderscore = StatName;
    StatNameUnderscore.Append("_");
    StatNameUnderscore.Append(StatName);
    return StatNameUnderscore;
}

Initialize()

bool UAchievementWidget::Initialize ( )

overrideprotectedvirtual

{
    const bool bSuccess = Super::Initialize();
    if (!ensure(NameTextBlock != nullptr)) return false;
    if (!ensure(DateTextBlock != nullptr)) return false;
    if (!ensure(DescriptionTextBlock != nullptr)) return false;
    if (!ensure(AchievementImage != nullptr)) return false;
    if (!ensure(PercentTextBlock != nullptr)) return false;
    if (!ensure(GlobalPercentTextBlock != nullptr)) return false;
    if (!ensure(ProgressBar != nullptr)) return false;
    if(!bSuccess) return false;
    return true;
}

OnAchievementDataSet()

void UAchievementWidget::OnAchievementDataSet ( const bool bGetProgress )

protected

SetAchievementProgress()

void UAchievementWidget::SetAchievementProgress

(

const int32

Value

)

{
    const FText FormattedProgress = FText::Format(NSLOCTEXT("","","{0} / {1}"),
    FText::AsNumber(Value),
    FText::AsNumber(GetStatMax()));
 
    PercentTextBlock->SetText(FormattedProgress);
    PercentTextBlock->SetVisibility(ESlateVisibility::Visible);
    ProgressBar->SetPercent(GetAchievementProgress(Value));
    ProgressBar->SetVisibility(ESlateVisibility::Visible);
}

Member Data Documentation

AchievementAPIName

FString UAchievementWidget::AchievementAPIName = ""

protected

AchievementDescription

FString UAchievementWidget::AchievementDescription = ""

protected

AchievementImage

class UImage* UAchievementWidget::AchievementImage = nullptr

protected

AchievementName

FString UAchievementWidget::AchievementName = ""

protected

bHidden

bool UAchievementWidget::bHidden = false

protected

bUnlocked

bool UAchievementWidget::bUnlocked = false

protected

DateTextBlock

class UTextBlock* UAchievementWidget::DateTextBlock = nullptr

protected

DescriptionTextBlock

class UTextBlock* UAchievementWidget::DescriptionTextBlock = nullptr

protected

GlobalPercentTextBlock

class UTextBlock* UAchievementWidget::GlobalPercentTextBlock = nullptr

protected

NameTextBlock

class UTextBlock* UAchievementWidget::NameTextBlock = nullptr

protected

PercentTextBlock

class UTextBlock* UAchievementWidget::PercentTextBlock = nullptr

protected

ProgressBar

UProgressBar* UAchievementWidget::ProgressBar = nullptr

protected

ProgressKey

FString UAchievementWidget::ProgressKey = "PROGRESS_"

protected

UnlockedTime

FDateTime UAchievementWidget::UnlockedTime

protected

ValueKey

FString UAchievementWidget::ValueKey = "_"

protected

---

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

• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/SteamStats/Source/StatsIntegration/Public/Widgets/AchievementWidget.h
• T:/Unreal/Unreal Projects/SpaceAdventure52/SpaceAdventure/Plugins/SteamStats/Source/StatsIntegration/Private/Widgets/AchievementWidget.cpp