Kelsidavis-WoWee/src/pipeline/wowee_triggers.cpp
Kelsi 8c78f8aeb2 feat(pipeline): add WTRG (Wowee Area Trigger) format
Novel open replacement for Blizzard's AreaTrigger.dbc +
AreaTriggerTeleport.dbc + the AzerothCore-style
areatrigger_template / areatrigger_teleport SQL tables.
The 29th open format added to the editor.

Defines proximity-based event zones — when a player enters
a defined region (box or sphere), the runtime fires the
trigger's action: teleport to another map, award
exploration XP for a quest, run a server script, gate an
instance entrance behind a key item, mark a PvP boundary,
or simply display a "Discovered: {area name}" banner.

Cross-references with previously-added formats — every
trigger field has a real format target:
  WTRG.entry.mapId / areaId  -> WMS.map.mapId / WMS.area.areaId
  WTRG.actionTarget (Teleport)        -> WMS.mapId
  WTRG.actionTarget (QuestExploration) -> WQT.questId
  WTRG.requiredQuestId       -> WQT.entry.questId
  WTRG.requiredItemId        -> WIT.entry.itemId (key)

Format:
  • magic "WTRG", version 1, little-endian
  • per trigger: triggerId / mapId / areaId / name /
    center vec3 / shape / kind / boxDims vec3 / radius /
    actionTarget / dest vec3 / destOrientation /
    requiredQuestId / requiredItemId / minLevel

Enums:
  • Shape (2): Box / Sphere
  • Kind (7): Teleport / QuestExploration / Script /
              InstanceEntrance / AreaName / CombatStartZone /
              Waypoint

API: WoweeTriggerLoader::save / load / exists / findById.

Three preset emitters showcase common trigger shapes:
  • makeStarter    — area-name + quest-exploration with
                      cross-ref to WQT 100 ("Investigate the
                      Camp")
  • makeDungeon    — outdoor area-name + portal-style
                      InstanceEntrance with Deadmines key
                      gate (WIT itemId 5200, matches
                      WLCK.makeDungeon's Boss Vault Seal) +
                      interior exit teleport back outdoors
  • makeFlightPath — 2 sphere waypoints near flight masters
                      so the runtime can auto-open the
                      flight UI on proximity (matches WTAX
                      starter node positions)

CLI added (5 flags, 601 documented total now):
  --gen-triggers / --gen-triggers-dungeon / --gen-triggers-flightpath
  --info-wtrg / --validate-wtrg

Validator catches: triggerId=0 + duplicates, unknown shape /
kind, non-finite center, sphere with radius<=0, box with
all-zero half-extents, teleport / instance with dest=(0,0,0)
(silently does nothing — usually a typo), QuestExploration
without an actionTarget questId.
2026-05-09 17:01:43 -07:00

272 lines
8.8 KiB
C++

#include "pipeline/wowee_triggers.hpp"
#include <cstdio>
#include <cstring>
#include <fstream>
namespace wowee {
namespace pipeline {
namespace {
constexpr char kMagic[4] = {'W', 'T', 'R', 'G'};
constexpr uint32_t kVersion = 1;
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) != ".wtrg") {
base += ".wtrg";
}
return base;
}
} // namespace
const WoweeTrigger::Entry* WoweeTrigger::findById(uint32_t triggerId) const {
for (const auto& e : entries) if (e.triggerId == triggerId) return &e;
return nullptr;
}
const char* WoweeTrigger::shapeName(uint8_t s) {
switch (s) {
case ShapeBox: return "box";
case ShapeSphere: return "sphere";
default: return "unknown";
}
}
const char* WoweeTrigger::kindName(uint8_t k) {
switch (k) {
case KindTeleport: return "teleport";
case KindQuestExploration: return "quest-explore";
case KindScript: return "script";
case KindInstanceEntrance: return "instance";
case KindAreaName: return "area-name";
case KindCombatStartZone: return "pvp-zone";
case KindWaypoint: return "waypoint";
default: return "unknown";
}
}
bool WoweeTriggerLoader::save(const WoweeTrigger& 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.triggerId);
writePOD(os, e.mapId);
writePOD(os, e.areaId);
writeStr(os, e.name);
writePOD(os, e.center.x);
writePOD(os, e.center.y);
writePOD(os, e.center.z);
writePOD(os, e.shape);
writePOD(os, e.kind);
uint8_t pad2[2] = {0, 0};
os.write(reinterpret_cast<const char*>(pad2), 2);
writePOD(os, e.boxDims.x);
writePOD(os, e.boxDims.y);
writePOD(os, e.boxDims.z);
writePOD(os, e.radius);
writePOD(os, e.actionTarget);
writePOD(os, e.dest.x);
writePOD(os, e.dest.y);
writePOD(os, e.dest.z);
writePOD(os, e.destOrientation);
writePOD(os, e.requiredQuestId);
writePOD(os, e.requiredItemId);
writePOD(os, e.minLevel);
os.write(reinterpret_cast<const char*>(pad2), 2);
}
return os.good();
}
WoweeTrigger WoweeTriggerLoader::load(const std::string& basePath) {
WoweeTrigger 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.triggerId) ||
!readPOD(is, e.mapId) ||
!readPOD(is, e.areaId)) {
out.entries.clear(); return out;
}
if (!readStr(is, e.name)) {
out.entries.clear(); return out;
}
if (!readPOD(is, e.center.x) ||
!readPOD(is, e.center.y) ||
!readPOD(is, e.center.z) ||
!readPOD(is, e.shape) ||
!readPOD(is, e.kind)) {
out.entries.clear(); return out;
}
uint8_t pad2[2];
is.read(reinterpret_cast<char*>(pad2), 2);
if (is.gcount() != 2) { out.entries.clear(); return out; }
if (!readPOD(is, e.boxDims.x) ||
!readPOD(is, e.boxDims.y) ||
!readPOD(is, e.boxDims.z) ||
!readPOD(is, e.radius) ||
!readPOD(is, e.actionTarget) ||
!readPOD(is, e.dest.x) ||
!readPOD(is, e.dest.y) ||
!readPOD(is, e.dest.z) ||
!readPOD(is, e.destOrientation) ||
!readPOD(is, e.requiredQuestId) ||
!readPOD(is, e.requiredItemId) ||
!readPOD(is, e.minLevel)) {
out.entries.clear(); return out;
}
is.read(reinterpret_cast<char*>(pad2), 2);
if (is.gcount() != 2) { out.entries.clear(); return out; }
}
return out;
}
bool WoweeTriggerLoader::exists(const std::string& basePath) {
std::ifstream is(normalizePath(basePath), std::ios::binary);
return is.good();
}
WoweeTrigger WoweeTriggerLoader::makeStarter(const std::string& catalogName) {
WoweeTrigger c;
c.name = catalogName;
{
WoweeTrigger::Entry e;
e.triggerId = 1; e.mapId = 0; e.areaId = 87; // WMS Goldshire
e.name = "Goldshire entrance";
e.center = {-9460.0f, 60.0f, 56.0f};
e.shape = WoweeTrigger::ShapeSphere;
e.radius = 60.0f;
e.kind = WoweeTrigger::KindAreaName;
c.entries.push_back(e);
}
{
WoweeTrigger::Entry e;
e.triggerId = 2; e.mapId = 0; e.areaId = 12; // Elwynn Forest
e.name = "Bandit Camp clearing";
e.center = {-9700.0f, 50.0f, 200.0f};
e.shape = WoweeTrigger::ShapeSphere;
e.radius = 30.0f;
e.kind = WoweeTrigger::KindQuestExploration;
e.actionTarget = 100; // matches WQT.makeChain quest id
c.entries.push_back(e);
}
return c;
}
WoweeTrigger WoweeTriggerLoader::makeDungeon(const std::string& catalogName) {
WoweeTrigger c;
c.name = catalogName;
// Outdoor approach area-name marker.
{
WoweeTrigger::Entry e;
e.triggerId = 100; e.mapId = 0; e.areaId = 40; // Westfall
e.name = "Approaching Deadmines";
e.center = {-11000.0f, 50.0f, 1500.0f};
e.shape = WoweeTrigger::ShapeSphere;
e.radius = 25.0f;
e.kind = WoweeTrigger::KindAreaName;
c.entries.push_back(e);
}
// Portal-style instance entrance with key requirement.
{
WoweeTrigger::Entry e;
e.triggerId = 101; e.mapId = 0; e.areaId = 40;
e.name = "Deadmines Portal";
e.center = {-11200.0f, 60.0f, 1600.0f};
e.shape = WoweeTrigger::ShapeBox;
e.boxDims = {3.0f, 5.0f, 3.0f};
e.kind = WoweeTrigger::KindInstanceEntrance;
e.actionTarget = 36; // WMS Deadmines mapId
e.dest = {-15.0f, 20.0f, 0.0f};
e.destOrientation = 0.0f;
e.requiredItemId = 5200; // matches WLCK.makeDungeon "Boss Vault Seal" key
e.minLevel = 17;
c.entries.push_back(e);
}
// Inside-instance exit teleport back to the outdoor portal.
{
WoweeTrigger::Entry e;
e.triggerId = 102; e.mapId = 36; e.areaId = 0;
e.name = "Deadmines Exit";
e.center = {-15.0f, 20.0f, 5.0f};
e.shape = WoweeTrigger::ShapeBox;
e.boxDims = {3.0f, 5.0f, 3.0f};
e.kind = WoweeTrigger::KindTeleport;
e.actionTarget = 0; // back to Eastern Kingdoms
e.dest = {-11200.0f, 60.0f, 1605.0f};
e.destOrientation = 3.14159265f; // facing south on exit
c.entries.push_back(e);
}
return c;
}
WoweeTrigger WoweeTriggerLoader::makeFlightPath(const std::string& catalogName) {
WoweeTrigger c;
c.name = catalogName;
auto add = [&](uint32_t id, uint32_t mapId, uint32_t areaId,
const char* name, glm::vec3 center) {
WoweeTrigger::Entry e;
e.triggerId = id; e.mapId = mapId; e.areaId = areaId;
e.name = name; e.center = center;
e.shape = WoweeTrigger::ShapeSphere; e.radius = 8.0f;
e.kind = WoweeTrigger::KindWaypoint;
c.entries.push_back(e);
};
add(200, 0, 1, "Stormwind Gryphon Master proximity",
{-9000.0f, 100.0f, 50.0f});
add(201, 0, 87, "Goldshire Gryphon Master proximity",
{-9460.0f, 60.0f, 56.0f});
return c;
}
} // namespace pipeline
} // namespace wowee