achievement_manager.h

Go to the documentation of this file.

 
#pragma once
 
#include <cstddef>
#include <memory>
#include <unordered_map>
#include <vector>
#include <format>
#include <string>
#include <filesystem>
#include <optional>
#include <string_view>
#include <functional>
 
#include <rex/utility.h>
#include <span>
 
#include <rex/platform.h>
#include <rex/types.h>
#include <rex/memory.h>
#include <rex/kernel/types/status.h>
#include <rex/memory/stream.h>
#include <rex/kernel/types/content.h>
#include <rex/result.h>
#include <rex/filesystem/xdbf.h>
#include <rex/utility.h>
#include <rex/title.h>
 
namespace rex::xam {
 
struct AchievementEvent {
  Achievement achievement;
};

enum class AchievementNotification : u8 {
  kShow,
  kSuppress, 
};
 
enum class AchievementUnlockResult : u8 {
  kUnlocked,
  kAlreadyUnlocked,
  kUnknownAchievement,
};
 
using AchievementCallback = std::function<void(const AchievementEvent&)>;
 
class IAchievementManager : public NonCopyable {
 public:
  virtual ~IAchievementManager() = default;

  [[nodiscard]] virtual Result<void> RegisterAchievement(Achievement info) = 0;

  [[nodiscard]] virtual Result<void> RegisterAchievements(
      std::span<const Achievement> achievements) = 0;

  virtual void ReplaceAchievements(std::vector<Achievement> achievements) = 0;

  [[nodiscard]] virtual Result<void> LoadMetadataFile(const std::filesystem::path& path) = 0;

  [[nodiscard]] virtual std::vector<Achievement> ListAchievements() const = 0;

  virtual AchievementUnlockResult UnlockAchievement(
      u32 id, AchievementNotification notification = AchievementNotification::kSuppress) = 0;
 
  [[nodiscard]] virtual bool IsUnlocked(u32 id) const = 0;

  [[nodiscard]] virtual std::optional<u64> GetUnlockTime(u32 id) const = 0;

  [[nodiscard]] virtual ScopeGuard RegisterNotificationCallback(AchievementCallback callback) = 0;
 
  virtual void SetUnlockSavePath(std::filesystem::path path) = 0;
 
  virtual void LoadUnlockState() = 0;

  virtual void LoadUnlockStateFrom(const std::filesystem::path& user_root, u32 title_id) = 0;
 
  virtual void SaveUnlockState() const = 0;
};
 
}  // namespace rex::xam