Leaderboards

1
2
3
4
5
6
7

userID := "userId"
categories := []string{"Tournament"} // pass nil or empty slice to return all

leaderboards, err := systems.GetLeaderboardsSystem().ListLeaderboard(ctx, logger, nk, userID, categories)
if err != nil {
    return err
}

1
2
3
4
5
6
7

userID := "userId"
leaderboardID := "GalacticChampions"

leaderboard, err := systems.GetLeaderboardsSystem().GetLeaderboard(ctx, logger, nk, userID, leaderboardID)
if err != nil {
    return err
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

userID := "userId"
leaderboardID := "GalacticChampions"
region := "EU"       // pass empty string for the global leaderboard
ownerIds := []string{"userId1", "userId2"}
limit := 100
cursor := ""
expiry := int64(0)

scoreList, err := systems.GetLeaderboardsSystem().ListLeaderboardScores(ctx, logger, nk, userID, leaderboardID, region, ownerIds, limit, cursor, expiry)
if err != nil {
    return err
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

userID := "userId"
leaderboardID := "GalacticChampions"
region := ""
ownerId := "userId"
limit := 10
cursor := ""
expiry := int64(0)

scoreList, err := systems.GetLeaderboardsSystem().ListLeaderboardScoresAroundOwner(ctx, logger, nk, userID, leaderboardID, region, ownerId, limit, cursor, expiry)
if err != nil {
    return err
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

userID := "userId"
username := "username"
leaderboardID := "GalacticChampions"
score := int64(1500)
subscore := int64(0)
metadata := map[string]interface{}{"region": "EU"}

leaderboardScore, err := systems.GetLeaderboardsSystem().UpdateLeaderboard(ctx, logger, db, nk, userID, username, leaderboardID, score, subscore, metadata, nil)
if err != nil {
    return err
}

1
2
3
4

systems.GetLeaderboardsSystem().SetOnBeforeUpdateScore(func(ctx context.Context, logger runtime.Logger, db *sql.DB, nk runtime.NakamaModule, userID, leaderboardID string, score, subscore int64, metadata map[string]interface{}) (int64, int64, map[string]interface{}, error) {
    // Validate or modify score before write.
    return score, subscore, metadata, nil
})

1
2
3
4

systems.GetLeaderboardsSystem().SetOnAfterUpdateScore(func(ctx context.Context, logger runtime.Logger, db *sql.DB, nk runtime.NakamaModule, userID, leaderboardID string, score, subscore int64, metadata map[string]interface{}) (int64, int64, map[string]interface{}, error) {
    // React to the score being written.
    return score, subscore, metadata, nil
})

1
2
3
4
5
6

userID := "userId"

leaderboardConfigList, err := systems.GetLeaderboardsSystem().Get(ctx, logger, nk, userID)
if err != nil {
    return err
}