UGetAchievementData Class Reference

#include <GetAchievementData.h>

Inheritance diagram for UGetAchievementData:

Static Public Member Functions
static int32	GetNumAchievements ()
static FString	GetAchievementAPIName (int32 AchievementIndex)
static UTexture2D *	GetAchievementIcon (FString AchievementAPIName)
static void	GetAchievementUnlockStatusAndUnlockTime (FString AchievementAPIName, bool &AchievementUnlocked, FDateTime &UnlockTime)
static float	GetGlobalAchievementAchievedPercent (FString AchievementAPIName)
static FString	GetAchievementDisplayAttribute (FString AchievementAPIName, EAchievementDisplayAttributeUE4 Attribute)

Member Function Documentation

GetAchievementAPIName()

FString UGetAchievementData::GetAchievementAPIName ( int32 AchievementIndex )

static

{
    if (SteamAPI_Init())
    {
        return FString(SteamUserStats()->GetAchievementName(AchievementIndex));
    }
    else
    {
        return "";
    }
}

GetAchievementDisplayAttribute()

FString UGetAchievementData::GetAchievementDisplayAttribute ( FString AchievementAPIName, EAchievementDisplayAttributeUE4 Attribute )

static

{
    const char* displayAttributeValue;
    
    switch (Attribute)
    {
        case EAchievementDisplayAttributeUE4::ADA_EAttributeName:
            displayAttributeValue = SteamUserStats()->GetAchievementDisplayAttribute(TCHAR_TO_ANSI(*AchievementAPIName), "name");
            break;
        case EAchievementDisplayAttributeUE4::ADA_EAttributeDescription:
            displayAttributeValue = SteamUserStats()->GetAchievementDisplayAttribute(TCHAR_TO_ANSI(*AchievementAPIName), "desc");
            break;
        case EAchievementDisplayAttributeUE4::ADA_EAttributeHidden:
            displayAttributeValue = SteamUserStats()->GetAchievementDisplayAttribute(TCHAR_TO_ANSI(*AchievementAPIName), "hidden");
            break;
        default: 
            displayAttributeValue = "";
    }
 
    return FString(displayAttributeValue);
}

GetAchievementIcon()

UTexture2D * UGetAchievementData::GetAchievementIcon ( FString AchievementAPIName )

static

{
    if (SteamAPI_Init())
    {
        int iconIndex = SteamUserStats()->GetAchievementIcon(TCHAR_TO_ANSI(*AchievementAPIName));
 
        if (iconIndex != 0)
        {
            uint32 achievementIconWidth, achievementIconHeight;
            if (!SteamUtils()->GetImageSize(iconIndex, &achievementIconWidth, &achievementIconHeight))
            {
                return nullptr;
            }
 
            const int iconSizeinBytes = achievementIconWidth * achievementIconHeight * 4;
            BYTE* iconBuffer = new BYTE[iconSizeinBytes];
 
            if (!SteamUtils()->GetImageRGBA(iconIndex, (uint8*)iconBuffer, iconSizeinBytes))
            {
                return nullptr;
            }
 
            return ConvertToTexture2D(iconBuffer, achievementIconWidth, achievementIconHeight);
        }
    }
        
    return nullptr;
}

GetAchievementUnlockStatusAndUnlockTime()

void UGetAchievementData::GetAchievementUnlockStatusAndUnlockTime ( FString AchievementAPIName, bool & AchievementUnlocked, FDateTime & UnlockTime )

static

{
    bool achievementUnlockStatus;
    uint32 achievementUnlockTime;
 
    if (SteamUserStats()->GetAchievementAndUnlockTime(TCHAR_TO_ANSI(*AchievementAPIName), &achievementUnlockStatus, &achievementUnlockTime))
    {
        AchievementUnlocked = achievementUnlockStatus;
        UnlockTime = FDateTime::FromUnixTimestamp(achievementUnlockTime);
    }
}

GetGlobalAchievementAchievedPercent()

float UGetAchievementData::GetGlobalAchievementAchievedPercent ( FString AchievementAPIName )

static

{
    float achievementAchievedPercent;
 
    if (SteamUserStats()->GetAchievementAchievedPercent(TCHAR_TO_ANSI(*AchievementAPIName), &achievementAchievedPercent))
    {
        return (float)achievementAchievedPercent;
    }
 
    return 0.f;
}

GetNumAchievements()

int32 UGetAchievementData::GetNumAchievements ( )

static

{
    if (SteamAPI_Init())
    {
        return SteamUserStats()->GetNumAchievements();
    }
    else
    {
        return 0;
    }
}

---

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

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