Kelsidavis-WoWee/src/pipeline/wowee_locks.cpp
Kelsi 81b1897a24 feat(pipeline): add WLCK (Wowee Lock Template) format
Novel open replacement for Blizzard's Lock.dbc. The 18th
open format added to the editor. Closes the cross-reference
gap from WGOT.entry.lockId — until now that field pointed
to a format that didn't exist yet.

A lock is a multi-channel security check. Each lock has up
to 5 independent channels; a player can open the lock by
satisfying ANY ONE channel:
  • Item     — requires a specific key item (WIT cross-ref)
  • Lockpick — requires the lockpicking skill at minimum rank
                (rogue / engineering profession)
  • Spell    — requires casting a specific spell
  • Damage   — can be forced open with attack damage

Cross-references with previously-added formats:
  WGOT.entry.lockId               -> WLCK.entry.lockId
  WLCK.channel.targetId (Item)    -> WIT.entry.itemId
  WLCK.channel.targetId (Lockpick) -> future WSKL skillId
  WLCK.channel.targetId (Spell)   -> future WSPL spellId

The starter and dungeon presets' lockIds (1 and 2)
deliberately match WGOT.makeDungeon's iron-door lockId=1
and bandit-strongbox lockId=2, so the demo content stack
already wires together: WSPN spawn -> WGOT object template
-> WLCK lock template -> WIT key items.

Format:
  • magic "WLCK", version 1, little-endian
  • per lock: lockId / name / flags / 5 fixed channel slots
  • per channel: kind / skillRequired / targetId
  • all 5 slots written even when unused (kind=None +
    zeroed fields), keeping the per-entry size constant for
    fast random access

Enums:
  • ChannelKind: None / Item / Lockpick / Spell / Damage
  • Flags:       DestructOnOpen / RespawnOnKey / TrapOnFail

API: WoweeLockLoader::save / load / exists / findById;
presets makeStarter (Iron Door + Wooden Chest), makeDungeon
(matches WGOT cross-references; light/heavy lockpicks +
boss-key-only seal), makeProfessions (4-tier rogue lockpick
progression at ranks 1/100/175/250).

CLI added (5 flags, 521 documented total now):
  --gen-locks / --gen-locks-dungeon / --gen-locks-professions
  --info-wlck / --validate-wlck

Validator catches: lockId=0 + duplicates, all-None channels
(lock can never open), Item/Spell/Lockpick channels with
targetId=0 (no resource referenced), unknown channel kind,
skillRequired set on non-Lockpick channel (silently ignored
at runtime — flag as warning).
2026-05-09 15:44:26 -07:00

211 lines
6.5 KiB
C++

#include "pipeline/wowee_locks.hpp"
#include <cstdio>
#include <cstring>
#include <fstream>
namespace wowee {
namespace pipeline {
namespace {
constexpr char kMagic[4] = {'W', 'L', 'C', 'K'};
constexpr uint32_t kVersion = 1;
// SkillLine canonical ID for lockpicking (matches AzerothCore).
constexpr uint32_t kLockpickingSkill = 633;
template <typename T>
void writePOD(std::ofstream& os, const T& v) {
os.write(reinterpret_cast<const char*>(&v), sizeof(T));
}
template <typename T>
bool readPOD(std::ifstream& is, T& v) {
is.read(reinterpret_cast<char*>(&v), sizeof(T));
return is.gcount() == static_cast<std::streamsize>(sizeof(T));
}
void writeStr(std::ofstream& os, const std::string& s) {
uint32_t n = static_cast<uint32_t>(s.size());
writePOD(os, n);
if (n > 0) os.write(s.data(), n);
}
bool readStr(std::ifstream& is, std::string& s) {
uint32_t n = 0;
if (!readPOD(is, n)) return false;
if (n > (1u << 20)) return false;
s.resize(n);
if (n > 0) {
is.read(s.data(), n);
if (is.gcount() != static_cast<std::streamsize>(n)) {
s.clear();
return false;
}
}
return true;
}
std::string normalizePath(std::string base) {
if (base.size() < 5 || base.substr(base.size() - 5) != ".wlck") {
base += ".wlck";
}
return base;
}
} // namespace
const WoweeLock::Entry* WoweeLock::findById(uint32_t lockId) const {
for (const auto& e : entries) {
if (e.lockId == lockId) return &e;
}
return nullptr;
}
const char* WoweeLock::channelKindName(uint8_t k) {
switch (k) {
case ChannelNone: return "-";
case ChannelItem: return "item";
case ChannelLockpick: return "lockpick";
case ChannelSpell: return "spell";
case ChannelDamage: return "damage";
default: return "?";
}
}
bool WoweeLockLoader::save(const WoweeLock& cat,
const std::string& basePath) {
std::ofstream os(normalizePath(basePath), std::ios::binary);
if (!os) return false;
os.write(kMagic, 4);
writePOD(os, kVersion);
writeStr(os, cat.name);
uint32_t entryCount = static_cast<uint32_t>(cat.entries.size());
writePOD(os, entryCount);
for (const auto& e : cat.entries) {
writePOD(os, e.lockId);
writeStr(os, e.name);
writePOD(os, e.flags);
for (int k = 0; k < WoweeLock::kChannelSlots; ++k) {
const auto& ch = e.channels[k];
writePOD(os, ch.kind);
uint8_t pad = 0;
writePOD(os, pad);
writePOD(os, ch.skillRequired);
writePOD(os, ch.targetId);
}
}
return os.good();
}
WoweeLock WoweeLockLoader::load(const std::string& basePath) {
WoweeLock out;
std::ifstream is(normalizePath(basePath), std::ios::binary);
if (!is) return out;
char magic[4];
is.read(magic, 4);
if (std::memcmp(magic, kMagic, 4) != 0) return out;
uint32_t version = 0;
if (!readPOD(is, version) || version != kVersion) return out;
if (!readStr(is, out.name)) return out;
uint32_t entryCount = 0;
if (!readPOD(is, entryCount)) return out;
if (entryCount > (1u << 20)) return out;
out.entries.resize(entryCount);
for (auto& e : out.entries) {
if (!readPOD(is, e.lockId)) { out.entries.clear(); return out; }
if (!readStr(is, e.name)) { out.entries.clear(); return out; }
if (!readPOD(is, e.flags)) { out.entries.clear(); return out; }
for (int k = 0; k < WoweeLock::kChannelSlots; ++k) {
auto& ch = e.channels[k];
if (!readPOD(is, ch.kind)) {
out.entries.clear(); return out;
}
uint8_t pad = 0;
if (!readPOD(is, pad)) {
out.entries.clear(); return out;
}
if (!readPOD(is, ch.skillRequired) ||
!readPOD(is, ch.targetId)) {
out.entries.clear(); return out;
}
}
}
return out;
}
bool WoweeLockLoader::exists(const std::string& basePath) {
std::ifstream is(normalizePath(basePath), std::ios::binary);
return is.good();
}
WoweeLock WoweeLockLoader::makeStarter(const std::string& catalogName) {
WoweeLock c;
c.name = catalogName;
{
// lockId 1 matches the WGOT.makeDungeon Iron Door lock.
WoweeLock::Entry e;
e.lockId = 1; e.name = "Iron Door Lock";
e.channels[0] = {WoweeLock::ChannelItem, 0, 5001}; // requires key item 5001
e.channels[1] = {WoweeLock::ChannelDamage, 0, 0}; // OR force open
c.entries.push_back(e);
}
{
WoweeLock::Entry e;
e.lockId = 100; e.name = "Wooden Chest Lock";
e.channels[0] = {WoweeLock::ChannelDamage, 0, 0}; // forceable
c.entries.push_back(e);
}
return c;
}
WoweeLock WoweeLockLoader::makeDungeon(const std::string& catalogName) {
WoweeLock c;
c.name = catalogName;
{
// lockId 2 matches WGOT.makeDungeon's bandit strongbox.
WoweeLock::Entry e;
e.lockId = 2; e.name = "Light Bandit Strongbox";
e.channels[0] = {WoweeLock::ChannelLockpick,
1, kLockpickingSkill}; // any skill rank
c.entries.push_back(e);
}
{
WoweeLock::Entry e;
e.lockId = 200; e.name = "Steel Chest Lock";
// Either heavy lockpick OR a specific key.
e.channels[0] = {WoweeLock::ChannelLockpick,
175, kLockpickingSkill};
e.channels[1] = {WoweeLock::ChannelItem, 0, 5101};
c.entries.push_back(e);
}
{
WoweeLock::Entry e;
e.lockId = 300; e.name = "Boss Vault Seal";
e.flags = WoweeLock::DestructOnOpen;
// Quest key only — no lockpick option (story-gated).
e.channels[0] = {WoweeLock::ChannelItem, 0, 5200};
c.entries.push_back(e);
}
return c;
}
WoweeLock WoweeLockLoader::makeProfessions(const std::string& catalogName) {
WoweeLock c;
c.name = catalogName;
auto add = [&](uint32_t id, const char* name, uint16_t skillReq) {
WoweeLock::Entry e;
e.lockId = id; e.name = name;
e.channels[0] = {WoweeLock::ChannelLockpick,
skillReq, kLockpickingSkill};
c.entries.push_back(e);
};
add(401, "Battered Junkbox", 1);
add(402, "Worn Junkbox", 100);
add(403, "Sturdy Junkbox", 175);
add(404, "Heavy Junkbox", 250);
return c;
}
} // namespace pipeline
} // namespace wowee