phaneron/Kelsidavis-WoWee
1
0
Fork 0
mirror of https://github.com/Kelsidavis/WoWee.git synced 2026-05-11 03:23:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

feat(editor): add WAUR (Spell Aura Type) — companion to WSEF, CLI flag count breaks 1000

Browse source 
Open replacement for the SpellEffect.EffectAuraType field
meanings used when SpellEffect.Effect=APPLY_AURA. Defines what
each aura-type integer value actually does once an aura is
attached to a unit — PERIODIC_DAMAGE ticks damage every N
seconds, MOD_STAT adds a stat bonus, MOD_INCREASE_SPEED scales
movement, MOD_DAMAGE_PERCENT_DONE scales spell power, etc.

Companion to WSEF — together they cover the full spell-effect
classification space:
  WSEF: outer effect ID — what does the effect DO?
        (APPLY_AURA, SCHOOL_DAMAGE, HEAL, etc)
  WAUR: inner aura type — when WSEF=APPLY_AURA, what KIND
        of aura is applied? (PERIODIC_DAMAGE, MOD_STAT,
        STUN, ROOT, etc)

Nine auraKind values (Periodic / StatMod / DamageMod /
Movement / Visual / Trigger / Resource / Control / Misc)
classify the major behavior families. Periodic auras carry an
updateFrequencyMs (canonical 3s for DoT/HoT, 2s for energize,
1s for fast triggers). Stackable auras carry a maxStackCount.

Cross-references back to WSEF (this catalog is the secondary
classification that WSEF entry id 6 (APPLY_AURA) dispatches
into) and forward to WSPL (spell entries with effect=APPLY_AURA
reference an auraTypeId here).

Three preset emitters: --gen-aur (5 periodic auras with
canonical tick intervals), --gen-aur-stats (5 stat-modifier
auras instantly applied on attach), --gen-aur-movement (4
movement-impairing CC auras typical of crowd-control spells).

Validation enforces name presence, auraKind 0..8, targetingHint
0..3, no duplicate ids; errors on Periodic kind without
updateFrequencyMs (would never tick); warns on:
  - non-Periodic/Trigger kinds with updateFrequencyMs > 0
    (engine ignores tick interval)
  - maxStackCount > 0 with isStackable=false (cap unreachable)

Wired through the cross-format table; WAUR appears automatically
in all 15 cross-format utilities. Format count 82 -> 83;
CLI flag count 996 -> 1001 — broke the 1000-flag mark.
This commit is contained in:
Kelsi 2026-05-09 22:54:53 -07:00
parent 9f5678f67e
commit 7d3430c8fe
10 changed files with 643 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

2
tools/editor/cli_arg_required.cpp
View file

@ -254,6 +254,8 @@ const char* const kArgRequired[] = {
"--gen-sef", "--gen-sef-healing", "--gen-sef-aura",
"--info-wsef", "--validate-wsef",
"--export-wsef-json", "--import-wsef-json",
"--gen-aur", "--gen-aur-stats", "--gen-aur-movement",
"--info-waur", "--validate-waur",
"--gen-weather-temperate", "--gen-weather-arctic",
"--gen-weather-desert", "--gen-weather-stormy",
"--gen-zone-atmosphere",

2
tools/editor/cli_dispatch.cpp
View file

@ -124,6 +124,7 @@
#include "cli_spell_reagents_catalog.hpp"
#include "cli_achievement_criteria_catalog.hpp"
#include "cli_spell_effect_types_catalog.hpp"
#include "cli_spell_aura_types_catalog.hpp"
#include "cli_quest_objective.hpp"
#include "cli_quest_reward.hpp"
#include "cli_clone.hpp"
@ -289,6 +290,7 @@ constexpr DispatchFn kDispatchTable[] = {
handleSpellReagentsCatalog,
handleAchievementCriteriaCatalog,
handleSpellEffectTypesCatalog,
handleSpellAuraTypesCatalog,
handleQuestObjective,
handleQuestReward,
handleClone,

1
tools/editor/cli_format_table.cpp
View file

@ -85,6 +85,7 @@ constexpr FormatMagicEntry kFormats[] = {
{{'W','S','P','R'}, ".wspr", "spells", "--info-wspr", "Spell reagent set catalog"},
{{'W','A','C','R'}, ".wacr", "achieve", "--info-wacr", "Achievement criteria catalog"},
{{'W','S','E','F'}, ".wsef", "spells", "--info-wsef", "Spell effect type catalog"},
{{'W','A','U','R'}, ".waur", "spells", "--info-waur", "Spell aura type catalog"},
{{'W','F','A','C'}, ".wfac", "factions", nullptr, "Faction catalog"},
{{'W','L','C','K'}, ".wlck", "locks", nullptr, "Lock catalog"},
{{'W','S','K','L'}, ".wskl", "skills", nullptr, "Skill catalog"},

10
tools/editor/cli_help.cpp
View file

@ -1909,6 +1909,16 @@ void printUsage(const char* argv0) {
std::printf(" Export binary .wsef to a human-editable JSON sidecar (defaults to <base>.wsef.json)\n");
std::printf(" --import-wsef-json <json-path> [out-base]\n");
std::printf(" Import a .wsef.json sidecar back into binary .wsef (accepts effectKind int OR effectKindName string; behaviorFlags int OR pipe-separated label string)\n");
std::printf(" --gen-aur <waur-base> [name]\n");
std::printf(" Emit .waur 5 periodic auras (PeriodicDamage / PeriodicHeal / PeriodicEnergize / PeriodicLeech / PeriodicTriggerSpell) at canonical 3s tick\n");
std::printf(" --gen-aur-stats <waur-base> [name]\n");
std::printf(" Emit .waur 5 stat-modifier auras (ModStat / ModResistance / ModDamageDone / ModHaste / ModCritPercent) — non-periodic, instantly applied\n");
std::printf(" --gen-aur-movement <waur-base> [name]\n");
std::printf(" Emit .waur 4 movement-impairing auras (Stun / ModDecreaseSpeed / ModConfuse / Root) typically applied by CC spells\n");
std::printf(" --info-waur <waur-base> [--json]\n");
std::printf(" Print WAUR entries (id / kind / targeting / stack flag / max stack / tick interval / name)\n");
std::printf(" --validate-waur <waur-base> [--json]\n");
std::printf(" Static checks: name required, auraKind 0..8, targetingHint 0..3, no duplicate ids; errors on Periodic without tick interval; warns on non-periodic with tick interval, maxStackCount without isStackable\n");
std::printf(" --gen-weather-temperate <wow-base> [zoneName]\n");
std::printf(" Emit .wow weather schedule: clear-dominant + occasional rain + fog (forest / grassland)\n");
std::printf(" --gen-weather-arctic <wow-base> [zoneName]\n");

1
tools/editor/cli_list_formats.cpp
View file

@ -107,6 +107,7 @@ constexpr FormatRow kFormats[] = {
{"WSPR", ".wspr", "spells", "Spell.dbc Reagent[8]+Count[8]", "Spell reagent set catalog"},
{"WACR", ".wacr", "achieve", "Achievement_Criteria.dbc", "Achievement criteria catalog"},
{"WSEF", ".wsef", "spells", "SpellEffect.Effect dispatch", "Spell effect type catalog"},
{"WAUR", ".waur", "spells", "SpellEffect.EffectAuraType", "Spell aura type catalog"},
// Additional pipeline catalogs without the alternating
// gen/info/validate CLI surface (loaded by the engine

245
tools/editor/cli_spell_aura_types_catalog.cpp Normal file
View file

@ -0,0 +1,245 @@
#include "cli_spell_aura_types_catalog.hpp"
#include "cli_arg_parse.hpp"
#include "cli_box_emitter.hpp"
#include "pipeline/wowee_spell_aura_types.hpp"
#include <nlohmann/json.hpp>
#include <cstdint>
#include <cstdio>
#include <cstring>
#include <fstream>
#include <string>
#include <vector>
namespace wowee {
namespace editor {
namespace cli {
namespace {
std::string stripWaurExt(std::string base) {
stripExt(base, ".waur");
return base;
}
bool saveOrError(const wowee::pipeline::WoweeSpellAuraType& c,
const std::string& base, const char* cmd) {
if (!wowee::pipeline::WoweeSpellAuraTypeLoader::save(c, base)) {
std::fprintf(stderr, "%s: failed to save %s.waur\n",
cmd, base.c_str());
return false;
}
return true;
}
void printGenSummary(const wowee::pipeline::WoweeSpellAuraType& c,
const std::string& base) {
std::printf("Wrote %s.waur\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" auras : %zu\n", c.entries.size());
}
int handleGenPeriodic(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "PeriodicAuras";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWaurExt(base);
auto c = wowee::pipeline::WoweeSpellAuraTypeLoader::makePeriodic(name);
if (!saveOrError(c, base, "gen-aur")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenStatMod(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "StatModAuras";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWaurExt(base);
auto c = wowee::pipeline::WoweeSpellAuraTypeLoader::makeStatMod(name);
if (!saveOrError(c, base, "gen-aur-stats")) return 1;
printGenSummary(c, base);
return 0;
}
int handleGenMovement(int& i, int argc, char** argv) {
std::string base = argv[++i];
std::string name = "MovementCCAuras";
if (parseOptArg(i, argc, argv)) name = argv[++i];
base = stripWaurExt(base);
auto c = wowee::pipeline::WoweeSpellAuraTypeLoader::makeMovement(name);
if (!saveOrError(c, base, "gen-aur-movement")) return 1;
printGenSummary(c, base);
return 0;
}
int handleInfo(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWaurExt(base);
if (!wowee::pipeline::WoweeSpellAuraTypeLoader::exists(base)) {
std::fprintf(stderr, "WAUR not found: %s.waur\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeSpellAuraTypeLoader::load(base);
if (jsonOut) {
nlohmann::json j;
j["waur"] = base + ".waur";
j["name"] = c.name;
j["count"] = c.entries.size();
nlohmann::json arr = nlohmann::json::array();
for (const auto& e : c.entries) {
arr.push_back({
{"auraTypeId", e.auraTypeId},
{"name", e.name},
{"description", e.description},
{"auraKind", e.auraKind},
{"auraKindName", wowee::pipeline::WoweeSpellAuraType::auraKindName(e.auraKind)},
{"targetingHint", e.targetingHint},
{"targetingHintName", wowee::pipeline::WoweeSpellAuraType::targetingHintName(e.targetingHint)},
{"isStackable", e.isStackable != 0},
{"maxStackCount", e.maxStackCount},
{"updateFrequencyMs", e.updateFrequencyMs},
{"iconColorRGBA", e.iconColorRGBA},
});
}
j["entries"] = arr;
std::printf("%s\n", j.dump(2).c_str());
return 0;
}
std::printf("WAUR: %s.waur\n", base.c_str());
std::printf(" catalog : %s\n", c.name.c_str());
std::printf(" auras : %zu\n", c.entries.size());
if (c.entries.empty()) return 0;
std::printf(" id kind target stack max tickMs name\n");
for (const auto& e : c.entries) {
std::printf(" %4u %-10s %-10s %s %3u %6u %s\n",
e.auraTypeId,
wowee::pipeline::WoweeSpellAuraType::auraKindName(e.auraKind),
wowee::pipeline::WoweeSpellAuraType::targetingHintName(e.targetingHint),
e.isStackable ? "yes" : "no ",
e.maxStackCount, e.updateFrequencyMs,
e.name.c_str());
}
return 0;
}
int handleValidate(int& i, int argc, char** argv) {
std::string base = argv[++i];
bool jsonOut = consumeJsonFlag(i, argc, argv);
base = stripWaurExt(base);
if (!wowee::pipeline::WoweeSpellAuraTypeLoader::exists(base)) {
std::fprintf(stderr,
"validate-waur: WAUR not found: %s.waur\n", base.c_str());
return 1;
}
auto c = wowee::pipeline::WoweeSpellAuraTypeLoader::load(base);
std::vector<std::string> errors;
std::vector<std::string> warnings;
if (c.entries.empty()) {
warnings.push_back("catalog has zero entries");
}
std::vector<uint32_t> idsSeen;
for (size_t k = 0; k < c.entries.size(); ++k) {
const auto& e = c.entries[k];
std::string ctx = "entry " + std::to_string(k) +
" (id=" + std::to_string(e.auraTypeId);
if (!e.name.empty()) ctx += " " + e.name;
ctx += ")";
if (e.name.empty())
errors.push_back(ctx + ": name is empty");
if (e.auraKind > wowee::pipeline::WoweeSpellAuraType::Misc) {
errors.push_back(ctx + ": auraKind " +
std::to_string(e.auraKind) + " not in 0..8");
}
if (e.targetingHint > wowee::pipeline::WoweeSpellAuraType::BeneficialOnly) {
errors.push_back(ctx + ": targetingHint " +
std::to_string(e.targetingHint) + " not in 0..3");
}
// Periodic kind requires updateFrequencyMs > 0.
if (e.auraKind == wowee::pipeline::WoweeSpellAuraType::Periodic &&
e.updateFrequencyMs == 0) {
errors.push_back(ctx +
": Periodic kind requires updateFrequencyMs > 0 "
"— aura would never tick");
}
// Non-periodic with updateFrequencyMs > 0 is suspicious.
if (e.auraKind != wowee::pipeline::WoweeSpellAuraType::Periodic &&
e.auraKind != wowee::pipeline::WoweeSpellAuraType::Trigger &&
e.updateFrequencyMs != 0) {
warnings.push_back(ctx +
": " +
wowee::pipeline::WoweeSpellAuraType::auraKindName(e.auraKind) +
" kind with updateFrequencyMs=" +
std::to_string(e.updateFrequencyMs) +
" — non-periodic auras don't tick, engine ignores");
}
// maxStackCount > 0 with isStackable=0 is contradictory.
if (e.isStackable == 0 && e.maxStackCount > 0) {
warnings.push_back(ctx +
": maxStackCount=" + std::to_string(e.maxStackCount) +
" set but isStackable=false — stack cap is "
"unreachable");
}
for (uint32_t prev : idsSeen) {
if (prev == e.auraTypeId) {
errors.push_back(ctx + ": duplicate auraTypeId");
break;
}
}
idsSeen.push_back(e.auraTypeId);
}
bool ok = errors.empty();
if (jsonOut) {
nlohmann::json j;
j["waur"] = base + ".waur";
j["ok"] = ok;
j["errors"] = errors;
j["warnings"] = warnings;
std::printf("%s\n", j.dump(2).c_str());
return ok ? 0 : 1;
}
std::printf("validate-waur: %s.waur\n", base.c_str());
if (ok && warnings.empty()) {
std::printf(" OK — %zu auras, all auraTypeIds unique\n",
c.entries.size());
return 0;
}
if (!warnings.empty()) {
std::printf(" warnings (%zu):\n", warnings.size());
for (const auto& w : warnings)
std::printf(" - %s\n", w.c_str());
}
if (!errors.empty()) {
std::printf(" ERRORS (%zu):\n", errors.size());
for (const auto& e : errors)
std::printf(" - %s\n", e.c_str());
}
return ok ? 0 : 1;
}
} // namespace
bool handleSpellAuraTypesCatalog(int& i, int argc, char** argv,
int& outRc) {
if (std::strcmp(argv[i], "--gen-aur") == 0 && i + 1 < argc) {
outRc = handleGenPeriodic(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-aur-stats") == 0 && i + 1 < argc) {
outRc = handleGenStatMod(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--gen-aur-movement") == 0 && i + 1 < argc) {
outRc = handleGenMovement(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--info-waur") == 0 && i + 1 < argc) {
outRc = handleInfo(i, argc, argv); return true;
}
if (std::strcmp(argv[i], "--validate-waur") == 0 && i + 1 < argc) {
outRc = handleValidate(i, argc, argv); return true;
}
return false;
}
} // namespace cli
} // namespace editor
} // namespace wowee

12
tools/editor/cli_spell_aura_types_catalog.hpp Normal file
View file

@ -0,0 +1,12 @@
#pragma once
namespace wowee {
namespace editor {
namespace cli {
bool handleSpellAuraTypesCatalog(int& i, int argc, char** argv,
int& outRc);
} // namespace cli
} // namespace editor
} // namespace wowee