oracle_progression.h

Go to the documentation of this file.

#ifndef YAZE_CORE_ORACLE_PROGRESSION_H
#define YAZE_CORE_ORACLE_PROGRESSION_H
 
#include <cstddef>
#include <cstdint>
#include <string>
 
namespace yaze::core {
 
struct OracleProgressionState {
  uint8_t crystal_bitfield = 0;  // $7EF37A
  uint8_t game_state = 0;        // $7EF3C5
  uint8_t oosprog = 0;           // $7EF3D6
  uint8_t oosprog2 = 0;          // $7EF3C6
  uint8_t side_quest = 0;        // $7EF3D7
  uint8_t pendants = 0;          // $7EF374
 
  // ─── SRAM offsets (relative to save file start at $7EF000) ────
 
  static constexpr uint16_t kCrystalOffset = 0x37A;
  static constexpr uint16_t kGameStateOffset = 0x3C5;
  static constexpr uint16_t kOosProgOffset = 0x3D6;
  static constexpr uint16_t kOosProg2Offset = 0x3C6;
  static constexpr uint16_t kSideQuestOffset = 0x3D7;
  static constexpr uint16_t kPendantOffset = 0x374;
 
  // ─── Crystal bit constants ─────────────────────────────────────
 
  static constexpr uint8_t kCrystalD1 = 0x01;  // Mushroom Grotto
  static constexpr uint8_t kCrystalD6 = 0x02;  // Goron Mines
  static constexpr uint8_t kCrystalD5 = 0x04;  // Glacia Estate
  static constexpr uint8_t kCrystalD7 = 0x08;  // Dragon Ship
  static constexpr uint8_t kCrystalD2 = 0x10;  // Tail Palace
  static constexpr uint8_t kCrystalD4 = 0x20;  // Zora Temple
  static constexpr uint8_t kCrystalD3 = 0x40;  // Kalyxo Castle
 
  // ─── Parsing ───────────────────────────────────────────────────
 
  static OracleProgressionState ParseFromSRAM(const uint8_t* data, size_t len);
 
  // ─── Queries ───────────────────────────────────────────────────
 
  [[nodiscard]] int GetCrystalCount() const;
 
  [[nodiscard]] bool IsDungeonComplete(int dungeon_number) const;
 
  [[nodiscard]] std::string GetGameStateName() const;
 
  [[nodiscard]] static std::string GetDungeonName(int dungeon_number);
 
  [[nodiscard]] static uint8_t GetCrystalMask(int dungeon_number);
};
 
}  // namespace yaze::core
 
#endif  // YAZE_CORE_ORACLE_PROGRESSION_H