Player Data

Player data lets you persist arbitrary JSON for a player: level, coins, unlocked content, preferences — whatever your game needs. Documents are scoped to the signed-in player.

Scope: player data is per player; its template is defined per game version.

A typical setup has two sides: define the shape in the dashboard, then read and write it from the SDK.

Dashboard
Unity
Unreal

A player data template defines the structure and defaults for a kind of document, keeping records consistent across players and versions. Define templates in the dashboard; players inherit them automatically.

Player data templates — Define player data templates in the dashboard.

Open the Code Generation tab of Flock → Settings and click Sync Schemas to turn each template into a typed C# class, then read and write the signed-in player’s document directly. The example assumes a template named PlayerProgress with the fields level, xp and class, and runs inside an async method:

using Flock;
using Flock.Generated.Templates;
using UnityEngine;

// Read (paginates and caches the player's documents on first call)
PlayerProgressTemplate progress = await FlockClient.Instance.Player.GetPlayerProgressAsync();
if (progress == null)
{
    Debug.Log("This player has no PlayerProgress record yet.");
    return;
}

// Mutate the typed object and save it back
progress.Level = 2;
progress.Xp += 100;
await progress.UpdateAsync();

The method and field names come from your template (PlayerProgress → GetPlayerProgressAsync), and exist only after Sync Schemas. The read returns null when the player has no record for the template yet: the server makes a player’s records when the player registers, so a player who registered before the template existed has none.Writes queue offline and replay automatically when the connection returns.

Read a player’s rows with the Flock | Player nodes, or the player provider in C++, and write them with the Flock | Commands nodes, or the command provider. You never pass a player ID — calls act for the signed-in player.

#include "FlockSubsystem.h"
#include "Providers/FlockCommandProvider.h"
#include "Providers/FlockPlayerProvider.h"

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

// ProgressTemplateId: the player template's Id, shown on the dashboard.
const TWeakObjectPtr<UFlockSubsystem> Flock = Sdk;
Sdk->GetPlayerProvider()->GetMyDataByTemplate(ProgressTemplateId, [Flock](TFlockResult<FFlockPlayerData> Row)
{
    // An empty Id: the player has no row for this template yet.
    if (!Row.bSuccess || Row.Value.Id.IsEmpty() || !Flock.IsValid())
    {
        return;
    }

    int32 Level = 1;
    Row.Value.Data.TryGetInt(TEXT("level"), Level);

    // Write one field. UpdatePlayerData replaces the whole row: it needs every field the template declares.
    Flock->GetCommandProvider()->UpdatePlayerDataField(Row.Value.Id, TEXT("level"), Level + 1,
        [](TFlockResult<FFlockPlayerData> Saved)
        {
            if (!Saved.bSuccess)
            {
                UE_LOG(LogTemp, Warning, TEXT("%s"), *Saved.Error.ToDisplayText());
            }
        });
});

Change one field with UpdatePlayerDataField (Flock Update Player Data Field), giving it the row’s Id. UpdatePlayerData (Flock Update Player Data) replaces the whole row: the server needs every field the template declares, nullable ones included, and refuses a row missing one with game_command.template_validation_failed, naming the field.After a schema sync this collapses to one node returning a typed struct with real pins, and writing back is a second node — see Work with your game data.

Get Player Level into Set members into Save Player Level — Get, change, and save a player's row — no strings, no IDs typed by hand.

Writes queue offline and replay automatically when the connection returns.

Keep documents small and purpose-scoped (e.g. a progression doc and a settings doc) rather than one giant blob — it makes partial updates and debugging far easier.

Getting Started

Concepts

Features

Reference