Achievements

In Flock, an achievement is a kind of config/template — defined alongside your game config and player templates — that auto-generates a player data entry to track each player’s progress. You don’t call a separate achievements API: you configure the achievement, and Flock provisions the matching player data for you to read and update.

Scope: achievements are configured per game version (as game config + player templates).

Dashboard
Unity
Unreal

Define achievements on the Achievement Config page — this is the source of truth. Each achievement becomes part of your game config and player templates, and Flock creates a player data entry to hold progress.

UnlockAchievementAsync takes the achievement name, or a generated enum after Sync Schemas (Code Generation tab) so it cannot be mistyped. The SDK resolves the achievement-tagged row for you. The examples run inside an async method.

using Flock;
using Flock.Generated.Achievements;
using Flock.Models;

PlayerData row = await FlockClient.Instance.Commands.UnlockAchievementAsync("first_win");

// After a sync — typed, so a name the server doesn't have fails at compile time:
row = await FlockClient.Instance.Commands.UnlockAchievementAsync(FlockAchievementId.FirstWin);

The typed overload is additive — the raw-string one stays public — but prefer it.The achievements record comes from registration. The server makes a player’s achievements record when the player registers, from the Game Version’s achievement template (a player-data template tagged achievement). A player who registered before that template existed, or under another Game Version, has none, and UnlockAchievementAsync throws FlockValidationException saying so: create the template first, then register players under this build’s Game Version.If you keep achievement details (display name, description, reward) in a game config tagged achievement, codegen wires them to the same enum, so you award and look up details with one value. The type is generated from your own config: here a config named achievements with a list field achievements whose entries have name and description.

using Flock;
using Flock.Generated.Achievements;
using Flock.Generated.Configs;
using UnityEngine;

// Returns the matching entry, or null when the config has none for it.
AchievementsConfigAchievementsItem firstWin =
    await FlockClient.Instance.Config.GetAchievementDetailsAsync(FlockAchievementId.FirstWin);
if (firstWin != null)
    Debug.Log(firstWin.Description);

Unlocks queue offline and replay when the connection returns.

Flock Unlock Achievement takes the achievement name, or a generated dropdown after a schema sync so it cannot be mistyped. The SDK resolves the achievement-tagged row for you.

#include "FlockSubsystem.h"

UFlockSubsystem* Sdk = UFlockSubsystem::Get(this);   // this: any object in the game's world

Sdk->GetCommandProvider()->UnlockAchievement(TEXT("first_win"), [](TFlockResult<FFlockPlayerData> Unlocked) {});

// After Code Generation's sync, with the id baked in:
FFlockGenerated::UnlockAchievement(this, EFlockAchievementId::FirstWin, [](TFlockResult<FFlockPlayerData> Unlocked) {});

Unlocks queue offline and replay when the connection returns.

Achievements are configured, not coded. Define them on the Achievement Config page; the SDK then surfaces them through game config and player data.

Getting Started

Concepts

Features

Reference