Achievements

Read more about the Achievements system in Hiro here.

Functions #

ClaimAchievements #

Claim one or more achievements by their IDs whose progress has been completed.

1
2
3
4
5
6
7
8
userId := "userId"
achievementIds := []string{"<achievementId1>", "<achievementId2>"}
claimTotal := true

achievements, repeatAchievements, err := systems.GetAchievementsSystem().ClaimAchievements(ctx, logger, nk, userId, achievementIds, claimTotal)
if err != nil {
  return err
}

DeleteAchievements #

Delete the achievement storage for one or more achievements by their IDs. Use this to reset a user’s achievement progress.

1
2
3
4
5
6
7
userId := "userId"
achievementIds := []string{"<achievementId1>", "<achievementId2>"}

err := systems.GetAchievementsSystem().DeleteAchievements(ctx, logger, nk, userId, achievementIds)
if err != nil {
  return err
}

GetAchievements #

Get all achievements available to the user, and their progress on them.

1
2
3
4
5
6
userId := "userId"

achievements, repeatAchievements, err := systems.GetAchievementsSystem().GetAchievements(ctx, logger, nk, userId)
if err != nil {
  return err
}

UpdateAchievements #

Update progress on one or more achievements by their IDs.

1
2
3
4
5
6
7
userId := "userId"
achievementUpdates := map[string]int64{"<achievementId1>": 5, "<achievementId2>": 10}

achievements, repeatAchievements, err := systems.GetAchievementsSystem().UpdateAchievements(ctx, logger, nk, userId, achievementUpdates)
if err != nil {
  return err
}

ResetAchievements #

Reset one or more achievements by their IDs, deleting the user’s progress and any unclaimed rewards from storage. No rewards are granted. Resetting a parent achievement also resets its sub-achievements, and IDs with no stored progress are ignored. You can reset an achievement using this method to discard uncollected rewards before a new cycle of a recurring achievement starts.

1
2
3
4
5
6
7
userId := "userId"
achievementIds := []string{"<achievementId1>", "<achievementId2>"}

achievements, repeatAchievements, err := systems.GetAchievementsSystem().ResetAchievements(ctx, logger, nk, userId, achievementIds)
if err != nil {
  return err
}

Hooks #

SetOnAchievementReward #

Set a custom reward function which will run after an achievement’s reward is rolled.

1
2
3
4
5
6
systems.GetAchievementsSystem().SetOnAchievementReward(OnAchievementReward)

func OnAchievementReward(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, sourceID string, source *hiro.AchievementsConfigAchievement, rewardConfig *hiro.EconomyConfigReward, reward *hiro.Reward) (*hiro.Reward, error) {
	// Modify reward or take additional actions.
	return reward, nil
}

SetOnSubAchievementReward #

Set a custom reward function which will run after a sub-achievement’s reward is rolled.

1
2
3
4
5
6
systems.GetAchievementsSystem().SetOnSubAchievementReward(OnSubAchievementReward)

func OnSubAchievementReward(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, sourceID string, source *hiro.AchievementsConfigSubAchievement, rewardConfig *hiro.EconomyConfigReward, reward *hiro.Reward) (*hiro.Reward, error) {
	// Modify reward or take additional actions.
	return reward, nil
}

SetOnAchievementTotalReward #

Set a custom reward function which will run after an achievement’s total reward is rolled.

1
2
3
4
5
6
systems.GetAchievementsSystem().SetOnAchievementTotalReward(OnAchievementTotalReward)

func OnAchievementTotalReward(ctx context.Context, logger runtime.Logger, nk runtime.NakamaModule, userID, sourceID string, source *hiro.AchievementsConfigAchievement, rewardConfig *hiro.EconomyConfigReward, reward *hiro.Reward) (*hiro.Reward, error) {
	// Modify reward or take additional actions.
	return reward, nil
}

Heroic Cloud