water_fill_zone.h

Go to the documentation of this file.

#ifndef YAZE_APP_ZELDA3_DUNGEON_WATER_FILL_ZONE_H
#define YAZE_APP_ZELDA3_DUNGEON_WATER_FILL_ZONE_H
 
#include <cstdint>
#include <string>
#include <vector>
 
#include "absl/status/status.h"
#include "absl/status/statusor.h"
 
namespace yaze {
class Rom;
}
 
namespace yaze::zelda3 {
 
struct WaterFillZoneEntry {
  int room_id = -1;
  uint8_t sram_bit_mask = 0;           // Bit in $7EF411 (e.g. 0x01)
  std::vector<uint16_t> fill_offsets;  // Each offset = Y*64 + X (0..4095)
};
 
// Load the editor-authored water fill table from the reserved ROM region.
// Returns an empty list if the table is not present.
absl::StatusOr<std::vector<WaterFillZoneEntry>> LoadWaterFillTable(Rom* rom);
 
// Write the editor-authored water fill table into the reserved ROM region.
// This overwrites the reserved region (kWaterFillTableStart..kWaterFillTableEnd)
// and leaves collision data untouched.
absl::Status WriteWaterFillTable(Rom* rom,
                                 const std::vector<WaterFillZoneEntry>& zones);
 
// Best-effort import of legacy WaterGate_* tables from an asar-generated .sym
// file (WLA symbol format). This is intended as a one-time migration aid.
//
// Returns an empty list if the symbol file cannot be read or the symbols are
// not present.
absl::StatusOr<std::vector<WaterFillZoneEntry>> LoadLegacyWaterGateZones(
    Rom* rom, const std::string& symbol_path);
 
// JSON import/export helpers for authoring workflows.
//
// Format (v1):
// {
//   "version": 1,
//   "zones": [
//     { "room_id": "0x25", "mask": "0x02", "offsets": [ 0, 1, 2 ] }
//   ]
// }
//
// `mask` may be 0x00 ("Auto") or a single bit (0x01..0x80). Room IDs and masks
// may also be provided as integers.
absl::StatusOr<std::string> DumpWaterFillZonesToJsonString(
    const std::vector<WaterFillZoneEntry>& zones);
 
absl::StatusOr<std::vector<WaterFillZoneEntry>> LoadWaterFillZonesFromJsonString(
    const std::string& json_content);
 
// Assigns deterministic, unique SRAM bit masks (0x01..0x80) to all zones.
//
// Any zone with a mask of 0x00, an invalid (non-single-bit) mask, or a mask
// duplicated by an earlier room will be treated as "unassigned" and receive
// the next available free bit. Zones are processed in ascending room_id order
// to keep results stable.
//
// Returns InvalidArgument if there are more than 8 zones. Returns
// ResourceExhausted if no free bits are available.
absl::Status NormalizeWaterFillZoneMasks(
    std::vector<WaterFillZoneEntry>* zones);
 
}  // namespace yaze::zelda3
 
#endif  // YAZE_APP_ZELDA3_DUNGEON_WATER_FILL_ZONE_H