Display player achievements using AGS SDK

Last updated on October 24, 2024

Overview

The AccelByte Gaming Services (AGS) Achievements service allows you to display available achievements and user achievements in various ways. Displaying achievements within the game will add more motivation and a sense of accomplishment for the player experience, as well as encouraging them to engage and keep making progress to unlock them all.

This article walks you through how to display all available achievement configurations and a specific player's achievements.

Goals

• Explain how to utilize AccelByte SDK to display available achievements based on the configuration that is set.
• Explain how to utilize AccelByte SDK to display user achievements.

Prerequisites

• Access to the AGS Admin Portal.
• AccelByte Unreal, Unity, or Extend SDK, including the permissions:
  • Client ID
  • Client Secret
• Access to AccelByte Achievement API documentation.
• Access to the AccelByte Statistics API to configure the required information.
• Achievement configuration should exist in the related namespace.

Display available achievements

With AGS, you have the ability to display only a single achievement or multiple achievements at the same time, depending on your game UI.

Displaying a single achievement

To display a single achievement, you are required to know the achievementCode. You can use that achievementCode and this function to retrieve achievement info, such as an achievement's name, description, goalValue, and icons.

Unreal

FString AchievementCode = FString("MyAchievementCode");

FRegistry::Achievement.GetAchievement(AchievementCode, THandler<FAccelByteModelsMultiLanguageAchievement>::CreateLambda([](const FAccelByteModelsMultiLanguageAchievement& Result)
{
    // Do something if GetAchievement is successful
}), FErrorHandler::CreateLambda([](int32 ErrorCode, const FString& ErrorMessage)
{
    // Do something if GetAchievement has an error
}));

Unity

var achievement = AccelByteSDK.GetClientRegistry().GetApi().GetAchievement();

string achievementCode = "MyAchievementCode";

achievement.GetAchievement(achievementCode, result =>
{
    if (result.IsError)
    {
        // Do something if GetAchievement has an error
        Debug.Log($"Error GetAchievement, Error Code: {result.Error.Code} Error Message: {result.Error.Message}");

        return;
    }

    // Do something if GetAchievement is successful
});

Go Extend SDK

achievementsService := &achievement.AchievementsService{
    Client:          factory.NewAchievementClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
achievementCode := "achievementCode"
namespace := "mygame"
language := "en"
input := &achievements.PublicGetAchievementParams{
    AchievementCode: achievementCode,
    Namespace:       namespace,
    Language:        language,
}
result, err := achievementsService.PublicGetAchievementShort(input)

Python Extend SDK

import accelbyte_py_sdk.api.achievement as achievement_service
import accelbyte_py_sdk.api.achievement.models as achievement_models

result, error = achievement_service.public_get_achievement(
    achievement_code="MyAchievementCode",
    language="en",
)
if error:
    exit(error)

Java Extend SDK

final Achievements achievementsWrapper = new Achievements(sdk);

String achievementCode = "<achievement-code>";
String language = "en";
ModelsPublicAchievementResponse response;
try {
    response = achievementsWrapper.publicGetAchievement(PublicGetAchievement.builder()
        .namespace("<namespace>")
        .achievementCode(achievementCode)
        .language(language)
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // Null response from server
} else {
    // Do something when success
}

C# Extend SDK

string achievementCode = "<achievement-code>";
string language = "en";

var response = sdk.Achievement.Achievements.PublicGetAchievementOp
    .Execute(achievementCode, sdk.Namespace, language);
if (response != null)
{
    //do something when success
}

Display all available achievements

As opposed to displaying a single achievement, displaying all available achievements within the related namespace does not require you to provide any information. You can use this function to retrieve a list of all achievements in the related namespace, as well as its info, such as the achievement's name, description, goalValue, and icons.

Unreal

FString Language = FString("en");
EAccelByteAchievementListSortBy SortBy = EAccelByteAchievementListSortBy::LISTORDER;
int32 Offset = 0;
int32 Limit = 50;

FRegistry::Achievement.QueryAchievements(Language, SortBy, THandler<FAccelByteModelsPaginatedPublicAchievement>::CreateLambda([](const FAccelByteModelsPaginatedPublicAchievement& Result)
{
    // Do something if QueryAchievements is successful
}), FErrorHandler::CreateLambda([](int32 ErrorCode, const FString& ErrorMessage)
{
    // Do something if QueryAchievements has an error
}), Offset, Limit);

Unity

var achievement = AccelByteSDK.GetClientRegistry().GetApi().GetAchievement();

string language = "en";
AchievementSortBy sortBy = AchievementSortBy.LISTORDER;
int offset = 0;
int limit = 50;

achievement.QueryAchievements(language, sortBy, result =>
{
    if (result.IsError)
    {
        // Do something if QueryAchievements has an error
        Debug.Log($"Error QueryAchievements, Error Code: {result.Error.Code} Error Message: {result.Error.Message}");

        return;
    }
        
    // Do something if QueryAchievements is successful
}, offset, limit);

Go Extend SDK

achievementsService := &achievement.AchievementsService{
    Client:          factory.NewAchievementClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
namespace := "mygame"
language := "en"
limit := int64(50)
offset := int64(0)
sortBy := achievements.AdminListAchievementsListOrderConstant
input := &achievements.PublicListAchievementsParams{
    Namespace: namespace,
    Limit:     &limit,
    Offset:    &offset,
    SortBy:    &sortBy,
    Language:  language,
}
result, err := achievementsService.PublicListAchievementsShort(input)

Python Extend SDK

import accelbyte_py_sdk.api.achievement as achievement_service
import accelbyte_py_sdk.api.achievement.models as achievement_models

result, error = achievement_service.public_list_achievements(
    limit=50,
    offset=0,
    sort_by="listOrder",
    language="en",
)
if error:
    exit(error)

Java Extend SDK

final UserAchievements userAchievementsWrapper = new UserAchievements(sdk);

String userId = "<user-id>";
ModelsPaginatedUserAchievementResponse response;
try {
    response = userAchievementsWrapper.publicListUserAchievements(PublicListUserAchievements.builder()
        .namespace("<namespace>")
        .userId(userId)
        .offset(0)
        .limit(50)
        .sortBy("listOrder")
        .build());
} catch (Exception e) {
    // Do something when failed
    return;
}

if (response == null) {
    // Null response from server
} else {
    // Do something when success
}

C# Extend SDK

var response = sdk.Achievement.Achievements.PublicListAchievementsOp
    .SetOffset(0)
    .SetLimit(50)
    .SetSortBy(PublicListAchievementsSortBy.ListOrder)
    .Execute(sdk.Namespace, language);
if (response != null)
{
    //do something when success
}

Display user achievements

Displaying a player's progress and unlocked achievements allows them to see and appreciate their progress and accomplishments within the game. You can use this function to query a player's unlocked and in-progress achievements. This function is called from a specific player who is already logged in to AccelByte IAM.

Unreal

EAccelByteAchievementListSortBy SortBy = EAccelByteAchievementListSortBy::LISTORDER;
int32 Offset = 0;
int32 Limit = 50;

FRegistry::Achievement.QueryUserAchievements(SortBy, THandler<FAccelByteModelsPaginatedUserAchievement>::CreateLambda([](const FAccelByteModelsPaginatedUserAchievement& Result)
{
    // Do something if QueryUserAchievements is successful
}), FErrorHandler::CreateLambda([](int32 ErrorCode, const FString& ErrorMessage)
{
    // Do something if QueryUserAchievements has an error
}), Offset, Limit);

Unity

var achievement = AccelByteSDK.GetClientRegistry().GetApi().GetAchievement();

AchievementSortBy sortBy = AchievementSortBy.LISTORDER;
int offset = 0;
int limit = 50;

achievement.QueryUserAchievements(sortBy, result =>
{
    if (result.IsError)
    {
        // Do something if QueryUserAchievements has an error
        Debug.Log($"Error QueryUserAchievements, Error Code: {result.Error.Code} Error Message: {result.Error.Message}");
        
        return;
    }

        // Do something if QueryUserAchievements is successful
}, offset, limit);

Go Extend SDK

userAchievementsService := &achievement.UserAchievementsService{
    Client:          factory.NewAchievementClient(&repository.ConfigRepositoryImpl{}),
    TokenRepository: &repository.TokenRepositoryImpl{},
}
namespace := "mygame"
userId := "myuserid"
limit := int64(50)
offset := int64(0)
sortBy := "listOrder"
input := &user_achievements.PublicListUserAchievementsParams{
    Namespace:      namespace,
    UserID:         userId,
    Limit:          &limit,
    Offset:         &offset,
    SortBy:         &sortBy,
}
result, err := userAchievementsService.PublicListUserAchievementsShort(input)

Python Extend SDK

import accelbyte_py_sdk.api.achievement as achievement_service
import accelbyte_py_sdk.api.achievement.models as achievement_models

result, error = achievement_service.public_list_user_achievements(
    user_id="********************************",
    limit=50,
    offset=0,
    sort_by="listOrder",
)
if error:
    exit(error)

Java Extend SDK

C# Extend SDK

string userId = "<user-id>";

var response = sdk.Achievement.UserAchievements.PublicListUserAchievementsOp
    .SetOffset(0)
    .SetLimit(50)
    .SetSortBy("listOrder")
    .Execute(sdk.Namespace, userId);
if (response != null)
{
    //do something when success
}