mirror of
https://github.com/Kelsidavis/WoWee.git
synced 2026-05-11 19:43:52 +00:00
Novel open replacement for Blizzard's PlayerCondition.dbc +
the AzerothCore-style condition_template SQL tables. The
37th open format added to the editor.
Defines reusable boolean conditions that other formats can
reference for gating: "player has quest X completed",
"player level >= N", "player class is mage", "player has
item Y in inventory", "WSEA event Z is active".
Conditions can be grouped and combined with AND/OR
aggregators on a per-group basis: a quest-giver gossip
option that says "show only to level 60 alliance mages
who completed quest 1234" composes 4 conditions sharing
the same groupId with AND aggregation. The runtime walks
each group, applies the group's aggregator, and returns
the boolean result to the caller.
Cross-references with previously-added formats — the
targetId field has a polymorphic interpretation by kind:
WPCD.targetId (kind=QuestCompleted/Active) -> WQT.questId
WPCD.targetId (kind=HasItem) -> WIT.itemId
WPCD.targetId (kind=HasSpell) -> WSPL.spellId
WPCD.targetId (kind=HasAchievement) -> WACH.achievementId
WPCD.targetId (kind=AreaId) -> WMS.areaId
WPCD.targetId (kind=EventActive) -> WSEA.eventId
WPCD.targetId (kind=HasTitle) -> WTIT.titleId
WPCD.targetId (kind=FactionRep) -> WFAC.factionId
WPCD.targetId (kind=Class/Race) -> WCHC class/race id
Future format extensions can reference WPCD.conditionId in
their own gating fields — WTRG triggers gated by player
state, WGSP options visible only when conditions are met,
WMOU summon spells condition-gated by quest progress, etc.
Format:
• magic "WPCD", version 1, little-endian
• per condition: conditionId / groupId (0 = standalone) /
name / description / kind / aggregator / negated /
targetId / minValue / maxValue
Enums:
• Kind (17): AlwaysTrue / AlwaysFalse / QuestCompleted /
QuestActive / HasItem / HasSpell / MinLevel /
MaxLevel / ClassMatch / RaceMatch /
FactionRep / HasAchievement / TeamSize /
GuildLevel / EventActive / AreaId / HasTitle
• Aggregator (2): And / Or
API: WoweeConditionLoader::save / load / exists / findById.
Three preset emitters showcase typical usage:
• makeStarter — 4 standalone conditions covering the most
common kinds (quest-done / has-item /
min-level / class)
• makeGated — 5 conditions in 2 groups demonstrating
AND-aggregation (alliance + mage + lvl 60)
and OR-aggregation (did quest 1 OR quest 100)
• makeEvent — 3 event-gated conditions cross-referencing
WSEA event IDs (Hallow's End / Brewfest /
Winter's Veil)
CLI added (5 flags, 656 documented total now):
--gen-conditions / --gen-conditions-gated / --gen-conditions-event
--info-wpcd / --validate-wpcd
Validator catches: conditionId=0 + duplicates, kind /
aggregator out of range, kinds requiring targetId having
target=0 (skips AlwaysTrue/False, MinLevel/MaxLevel,
TeamSize, GuildLevel which use min/max instead), TeamSize
with min > max.
129 lines
4.8 KiB
C++
129 lines
4.8 KiB
C++
#pragma once
|
|
|
|
#include <cstdint>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
namespace wowee {
|
|
namespace pipeline {
|
|
|
|
// Wowee Open Player Condition catalog (.wpcd) — novel
|
|
// replacement for Blizzard's PlayerCondition.dbc + the
|
|
// AzerothCore-style condition_template SQL tables. The
|
|
// 37th open format added to the editor.
|
|
//
|
|
// Defines reusable boolean conditions that other formats
|
|
// reference for gating: "player has quest X completed",
|
|
// "player level >= N", "player class is mage", "player
|
|
// has item Y in inventory", "event is currently active".
|
|
//
|
|
// Conditions can be grouped and combined with AND/OR
|
|
// aggregators on a per-group basis: a quest-giver gossip
|
|
// option that says "show only to level 60 alliance mages
|
|
// who completed quest 1234" composes 4 conditions sharing
|
|
// the same groupId with AND aggregation.
|
|
//
|
|
// Cross-references with previously-added formats:
|
|
// WPCD.targetId (kind=QuestCompleted/Active) → WQT.questId
|
|
// WPCD.targetId (kind=HasItem) → WIT.itemId
|
|
// WPCD.targetId (kind=HasSpell) → WSPL.spellId
|
|
// WPCD.targetId (kind=HasAchievement) → WACH.achievementId
|
|
// WPCD.targetId (kind=AreaId) → WMS.areaId
|
|
// WPCD.targetId (kind=EventActive) → WSEA.eventId
|
|
// WPCD.targetId (kind=HasTitle) → WTIT.titleId
|
|
// WPCD.targetId (kind=FactionRep) → WFAC.factionId
|
|
//
|
|
// Other formats can reference WPCD.conditionId in future
|
|
// extensions to gate triggers, gossip options, quest
|
|
// availability, vendor visibility, mount summons, etc.
|
|
//
|
|
// Binary layout (little-endian):
|
|
// magic[4] = "WPCD"
|
|
// version (uint32) = current 1
|
|
// nameLen + name (catalog label)
|
|
// entryCount (uint32)
|
|
// entries (each):
|
|
// conditionId (uint32)
|
|
// groupId (uint32)
|
|
// nameLen + name
|
|
// descLen + description
|
|
// kind (uint8) / aggregator (uint8) / negated (uint8) / pad[1]
|
|
// targetId (uint32)
|
|
// minValue (int32) / maxValue (int32)
|
|
struct WoweeCondition {
|
|
enum Kind : uint8_t {
|
|
AlwaysTrue = 0,
|
|
AlwaysFalse = 1,
|
|
QuestCompleted = 2,
|
|
QuestActive = 3,
|
|
HasItem = 4, // qty >= minValue
|
|
HasSpell = 5, // spell known
|
|
MinLevel = 6, // player.level >= minValue
|
|
MaxLevel = 7, // player.level <= minValue
|
|
ClassMatch = 8, // player.classId in raceMask sense
|
|
RaceMatch = 9,
|
|
FactionRep = 10, // player.rep[targetId] >= minValue
|
|
HasAchievement = 11,
|
|
TeamSize = 12, // group size in [minValue, maxValue]
|
|
GuildLevel = 13, // player's guild level >= minValue
|
|
EventActive = 14, // WSEA event currently running
|
|
AreaId = 15, // player in WMS.areaId
|
|
HasTitle = 16,
|
|
};
|
|
|
|
enum Aggregator : uint8_t {
|
|
And = 0, // all siblings in groupId must be true
|
|
Or = 1, // any sibling in groupId being true is enough
|
|
};
|
|
|
|
struct Entry {
|
|
uint32_t conditionId = 0;
|
|
uint32_t groupId = 0; // 0 = standalone (no group)
|
|
std::string name;
|
|
std::string description;
|
|
uint8_t kind = AlwaysTrue;
|
|
uint8_t aggregator = And;
|
|
uint8_t negated = 0; // 1 = invert the result
|
|
uint32_t targetId = 0;
|
|
int32_t minValue = 0;
|
|
int32_t maxValue = 0;
|
|
};
|
|
|
|
std::string name;
|
|
std::vector<Entry> entries;
|
|
|
|
bool isValid() const { return !entries.empty(); }
|
|
|
|
const Entry* findById(uint32_t conditionId) const;
|
|
|
|
static const char* kindName(uint8_t k);
|
|
static const char* aggregatorName(uint8_t a);
|
|
};
|
|
|
|
class WoweeConditionLoader {
|
|
public:
|
|
static bool save(const WoweeCondition& cat,
|
|
const std::string& basePath);
|
|
static WoweeCondition load(const std::string& basePath);
|
|
static bool exists(const std::string& basePath);
|
|
|
|
// Preset emitters used by --gen-conditions* variants.
|
|
//
|
|
// makeStarter — 4 standalone conditions covering common
|
|
// kinds (quest completed / has item /
|
|
// min level / class match).
|
|
// makeGated — 5 conditions in 2 groups demonstrating
|
|
// AND aggregation (group 100: alliance
|
|
// AND mage AND lvl 60+) and OR
|
|
// aggregation (group 200: completed
|
|
// quest 1 OR completed quest 2).
|
|
// makeEvent — 3 event-gated conditions (Brewfest /
|
|
// Hallow's End / Winter's Veil)
|
|
// cross-referencing WSEA event IDs.
|
|
static WoweeCondition makeStarter(const std::string& catalogName);
|
|
static WoweeCondition makeGated(const std::string& catalogName);
|
|
static WoweeCondition makeEvent(const std::string& catalogName);
|
|
};
|
|
|
|
} // namespace pipeline
|
|
} // namespace wowee
|