SteamAchievements

Namespace: Vortex.Steam.SteamAchievements Сборка: ru.vortex.steam.achievements Платформа: Unity 2021.3+, Steamworks.NET Условная компиляция: defineConstraints: ["USING_STEAM"] — сборка компилируется только при наличии символа

---

Назначение

Управление Steam-достижениями. Загружает индекс достижений из SteamUserStats, предоставляет API для разблокировки и чтения через extension-методы на SteamUserData.

Возможности:

• AchievementsController — внутренний статический контроллер: загрузка индекса достижений при инициализации Steam
• AchievementsExtensions — extension-методы на SteamUserData: UnlockAchievement(), GetAchievement(), GetAllAchievementsID()
• Achievement — модель данных: ID, Name, Description, IsUnlocked, IsHidden
• AchievementsManager — Editor-only MonoBehaviour: отображение и переключение достижений в Inspector
• AchievementHandler — Editor-only модель элемента для Inspector с [ToggleButton] и [ClassLabel]

Вне ответственности:

• Подключение к Steam, инициализация API — пакет SteamConnectionSystem
• Статистика Steam (leaderboards, stats) — не реализовано
• Runtime UI достижений — реализуется в проектном слое

---

Зависимости

---

Архитектура

AchievementsController (internal static)
  ├── _achievementsIndex: Dictionary<string, Achievement>
  ├── [RuntimeInitializeOnLoadMethod] Run()
  │   ├── SteamBus.IsInitialized → LoadAllAchievements()
  │   └── иначе → SteamBus.OnCallServices += LoadAllAchievements
  └── LoadAllAchievements()
      ├── SteamUserStats.GetNumAchievements()
      └── foreach → Achievement { ID, Name, Description, IsUnlocked, IsHidden }

AchievementsExtensions (static, extension на SteamUserData)
  ├── UnlockAchievement(id)
  │   ├── SteamUserStats.SetAchievement(id)
  │   └── TimeController.Accumulate(() => StoreStats(), "AchievementsExtensions")
  ├── GetAchievement(id) → Achievement
  ├── GetAllAchievementsID() → string[]
  ├── ClearAchievement(id)          ← Editor-only
  └── ResetAllAchievements()        ← Editor-only

Achievement
  ├── ID: string
  ├── Name: string
  ├── Description: string
  ├── IsUnlocked: bool
  └── IsHidden: bool

AchievementsManager : MonoBehaviour (Editor-only singleton)
  ├── index: AchievementHandler[]    ← [LabelText("Ачивки")]
  ├── [RuntimeInitializeOnLoadMethod] Init() → создаёт тестовый GameObject
  ├── Start() → SteamBus.User.OnUpdated += Refresh
  └── Refresh() → заполняет index из SteamBus

AchievementHandler (Editor-only, Serializable)
  ├── isUnlocked: bool               ← [ToggleButton] + [OnValueChanged("UpdateAchievements")]
  ├── Id, Name, Description
  ├── Label() → [ClassLabel]
  └── UpdateAchievements() → Unlock/Clear

Загрузка индекса

1. AchievementsController.Run() вызывается через RuntimeInitializeOnLoadMethod
2. Если SteamBus.IsInitialized — загрузка сразу, иначе — подписка на OnCallServices
3. LoadAllAchievements() итерирует SteamUserStats.GetNumAchievements(), заполняет _achievementsIndex
4. Для каждого достижения читаются: ID, name, desc, unlocked, hidden

Батчинг StoreStats

UnlockAchievement() вызывает SteamUserStats.SetAchievement() немедленно, но StoreStats() откладывается через TimeController.Accumulate(). При нескольких разблокировках за кадр StoreStats() вызовется один раз.

Editor-инструмент

AchievementsManager создаётся автоматически (RuntimeInitializeOnLoadMethod) только в Editor при USING_STEAM. Отображает массив AchievementHandler в Inspector с toggle-кнопками для разблокировки/сброса достижений. Подписывается на SteamBus.User.OnUpdated для обновления состояния.

---

Контракт

Вход

• SteamBus.IsInitialized = true — Steam API инициализирован
• Достижения настроены в Steamworks (App Admin → Achievements)
• SteamUserStats.RequestCurrentStats() вызван (неявно через SteamManager)

Выход

• Achievement модели с актуальным состоянием (IsUnlocked)
• Разблокировка через SteamBus.User.UnlockAchievement(id)
• Список всех ID через SteamBus.User.GetAllAchievementsID()

API

Ограничения

---

Использование

Разблокировка достижения

#if USING_STEAM
if (SteamBus.IsLoaded)
    SteamBus.User.UnlockAchievement("ACH_WIN_FIRST_BATTLE");
#endif

Проверка состояния

#if USING_STEAM
var ach = SteamBus.User.GetAchievement("ACH_WIN_FIRST_BATTLE");
if (ach != null && !ach.IsUnlocked)
    ShowAchievementHint();
#endif

Получение всех достижений

#if USING_STEAM
var ids = SteamBus.User.GetAllAchievementsID();
foreach (var id in ids)
{
    var ach = SteamBus.User.GetAchievement(id);
    Debug.Log($"{ach.Name}: {(ach.IsUnlocked ? "Unlocked" : "Locked")}");
}
#endif

Тестирование в Editor

1. Запустите Play Mode с включённым isEnabled и isTestBuild в SteamConnectionSettings
2. Найдите объект AchievementsManager [TEST] в Hierarchy
3. В Inspector используйте toggle-кнопки для разблокировки/сброса

---

Граничные случаи