Make towners initialization more dynamic

yuripourre · yuripourre · commit aaa46a4b9e4b · 2025-11-27T12:28:14.000-08:00
diff --git a/Source/lua/modules/towners.cpp b/Source/lua/modules/towners.cpp
@@ -1,6 +1,7 @@
 #include "lua/modules/towners.hpp"
 
 #include <optional>
+#include <unordered_map>
 #include <utility>
 
 #include <sol/sol.hpp>
@@ -13,20 +14,21 @@
 namespace devilution {
 namespace {
 
-const char *const TownerTableNames[NUM_TOWNER_TYPES] {
-	"griswold",
-	"pepin",
-	"deadguy",
-	"ogden",
-	"cain",
-	"farnham",
-	"adria",
-	"gillian",
-	"wirt",
-	"cow",
-	"lester",
-	"celia",
-	"nut",
+// Map from towner type enum to Lua table name
+const std::unordered_map<_talker_id, const char *> TownerTableNames = {
+	{ TOWN_SMITH, "griswold" },
+	{ TOWN_HEALER, "pepin" },
+	{ TOWN_DEADGUY, "deadguy" },
+	{ TOWN_TAVERN, "ogden" },
+	{ TOWN_STORY, "cain" },
+	{ TOWN_DRUNK, "farnham" },
+	{ TOWN_WITCH, "adria" },
+	{ TOWN_BMAID, "gillian" },
+	{ TOWN_PEGBOY, "wirt" },
+	{ TOWN_COW, "cow" },
+	{ TOWN_FARMER, "lester" },
+	{ TOWN_GIRL, "celia" },
+	{ TOWN_COWFARM, "nut" },
 };
 
 void PopulateTownerTable(_talker_id townerId, sol::table &out)
@@ -44,10 +46,15 @@ void PopulateTownerTable(_talker_id townerId, sol::table &out)
 sol::table LuaTownersModule(sol::state_view &lua)
 {
 	sol::table table = lua.create_table();
-	for (uint8_t townerId = TOWN_SMITH; townerId < NUM_TOWNER_TYPES; ++townerId) {
+	// Iterate over all towner types found in TSV data
+	for (const auto &[townerId, name] : TownerLongNames) {
+		auto tableNameIt = TownerTableNames.find(townerId);
+		if (tableNameIt == TownerTableNames.end())
+			continue; // Skip if no table name mapping
+
 		sol::table townerTable = lua.create_table();
-		PopulateTownerTable(static_cast<_talker_id>(townerId), townerTable);
-		LuaSetDoc(table, TownerTableNames[townerId], /*signature=*/"", TownerLongNames[townerId], std::move(townerTable));
+		PopulateTownerTable(townerId, townerTable);
+		LuaSetDoc(table, tableNameIt->second, /*signature=*/"", name.c_str(), std::move(townerTable));
 	}
 	return table;
 }
diff --git a/Source/msg.cpp b/Source/msg.cpp
@@ -1953,7 +1953,7 @@ size_t OnTalkXY(const TCmdLocParam1 &message, Player &player)
 	const Point position { message.x, message.y };
 	const uint16_t townerIdx = Swap16LE(message.wParam1);
 
-	if (gbBufferMsgs != 1 && player.isOnActiveLevel() && InDungeonBounds(position) && townerIdx < NUM_TOWNERS) {
+	if (gbBufferMsgs != 1 && player.isOnActiveLevel() && InDungeonBounds(position) && townerIdx < GetNumTowners()) {
 		MakePlrPath(player, position, false);
 		player.destAction = ACTION_TALK;
 		player.destParam1 = townerIdx;
diff --git a/Source/townerdat.cpp b/Source/townerdat.cpp
@@ -20,7 +20,7 @@
 namespace devilution {
 
 std::vector<TownerDataEntry> TownersDataEntries;
-std::vector<std::array<_speech_id, MAXQUESTS>> TownerQuestDialogTable;
+std::unordered_map<_talker_id, std::array<_speech_id, MAXQUESTS>> TownerQuestDialogTable;
 
 namespace {
 
@@ -135,12 +135,8 @@ void LoadQuestDialogFromFile()
 	const std::string_view filename = "txtdata\\towners\\quest_dialog.tsv";
 	DataFile dataFile = DataFile::loadOrDie(filename);
 
-	// Initialize table with TEXT_NONE
+	// Initialize table (will be populated as we read rows)
 	TownerQuestDialogTable.clear();
-	TownerQuestDialogTable.resize(NUM_TOWNER_TYPES);
-	for (auto &row : TownerQuestDialogTable) {
-		row.fill(TEXT_NONE);
-	}
 
 	// Parse header to find which quest columns exist
 	DataFileRecord headerRecord = *dataFile.begin();
@@ -155,21 +151,19 @@ void LoadQuestDialogFromFile()
 	dataFile.skipHeaderOrDie(filename);
 
 	// Find the towner_type column index
-	auto townerTypeColIt = columnMap.find("towner_type");
-	if (townerTypeColIt == columnMap.end()) {
+	if (!columnMap.contains("towner_type")) {
 		return; // Invalid file format
 	}
-	unsigned townerTypeColIndex = townerTypeColIt->second;
+	unsigned townerTypeColIndex = columnMap["towner_type"];
 
 	// Build quest column index map
 	std::unordered_map<quest_id, unsigned> questColumnMap;
 	for (quest_id quest : magic_enum::enum_values<quest_id>()) {
 		if (quest == Q_INVALID || quest >= MAXQUESTS) continue;
 
-		auto questName = magic_enum::enum_name(quest);
-		auto questColIt = columnMap.find(std::string(questName));
-		if (questColIt != columnMap.end()) {
-			questColumnMap[quest] = questColIt->second;
+		auto questName = std::string(magic_enum::enum_name(quest));
+		if (columnMap.contains(questName)) {
+			questColumnMap[quest] = columnMap[questName];
 		}
 	}
 
@@ -182,31 +176,30 @@ void LoadQuestDialogFromFile()
 		}
 
 		// Read towner_type
-		auto townerTypeFieldIt = fields.find(townerTypeColIndex);
-		if (townerTypeFieldIt == fields.end()) {
+		if (!fields.contains(townerTypeColIndex)) {
 			continue; // Invalid row
 		}
 
-		auto townerTypeResult = ParseEnum<_talker_id>(townerTypeFieldIt->second);
+		auto townerTypeResult = ParseEnum<_talker_id>(fields[townerTypeColIndex]);
 		if (!townerTypeResult.has_value()) {
 			continue; // Invalid towner type
 		}
 		_talker_id townerType = townerTypeResult.value();
 
-		if (static_cast<size_t>(townerType) >= TownerQuestDialogTable.size()) {
-			continue;
+		// Initialize row if it doesn't exist, then get reference
+		auto [it, inserted] = TownerQuestDialogTable.try_emplace(townerType);
+		if (inserted) {
+			it->second.fill(TEXT_NONE);
 		}
-
-		auto &dialogRow = TownerQuestDialogTable[static_cast<size_t>(townerType)];
+		auto &dialogRow = it->second;
 
 		// Read quest columns that exist in this file
 		for (const auto &[quest, colIndex] : questColumnMap) {
-			auto fieldIt = fields.find(colIndex);
-			if (fieldIt == fields.end()) {
+			if (!fields.contains(colIndex)) {
 				continue; // Column missing in this row
 			}
 
-			auto speechResult = ParseSpeechId(fieldIt->second);
+			auto speechResult = ParseSpeechId(fields[colIndex]);
 			if (speechResult.has_value()) {
 				dialogRow[quest] = speechResult.value();
 			}
@@ -224,24 +217,27 @@ void LoadTownerData()
 
 _speech_id GetTownerQuestDialog(_talker_id type, quest_id quest)
 {
-	if (static_cast<size_t>(type) >= TownerQuestDialogTable.size()) {
+	if (quest < 0 || quest >= MAXQUESTS) {
 		return TEXT_NONE;
 	}
-	if (quest < 0 || quest >= MAXQUESTS) {
+	auto it = TownerQuestDialogTable.find(type);
+	if (it == TownerQuestDialogTable.end()) {
 		return TEXT_NONE;
 	}
-	return TownerQuestDialogTable[static_cast<size_t>(type)][quest];
+	return it->second[quest];
 }
 
 void SetTownerQuestDialog(_talker_id type, quest_id quest, _speech_id speech)
 {
-	if (static_cast<size_t>(type) >= TownerQuestDialogTable.size()) {
-		return;
-	}
 	if (quest < 0 || quest >= MAXQUESTS) {
 		return;
 	}
-	TownerQuestDialogTable[static_cast<size_t>(type)][quest] = speech;
+	// Initialize row if it doesn't exist
+	auto [it, inserted] = TownerQuestDialogTable.try_emplace(type);
+	if (inserted) {
+		it->second.fill(TEXT_NONE);
+	}
+	it->second[quest] = speech;
 }
 
 } // namespace devilution
diff --git a/Source/townerdat.hpp b/Source/townerdat.hpp
@@ -7,6 +7,7 @@
 
 #include <cstdint>
 #include <string>
+#include <unordered_map>
 #include <vector>
 
 #include "engine/direction.hpp"
@@ -21,7 +22,7 @@ namespace devilution {
  * @brief Data for a single towner entry loaded from TSV.
  */
 struct TownerDataEntry {
-	_talker_id type;
+	_talker_id type; // Parsed from TSV using magic_enum
 	std::string name;
 	Point position;
 	Direction direction;
@@ -37,7 +38,7 @@ struct TownerDataEntry {
 extern std::vector<TownerDataEntry> TownersDataEntries;
 
 /** Contains the quest dialog table loaded from TSV. Indexed by [towner_type][quest_id]. */
-extern std::vector<std::array<_speech_id, MAXQUESTS>> TownerQuestDialogTable;
+extern std::unordered_map<_talker_id, std::array<_speech_id, MAXQUESTS>> TownerQuestDialogTable;
 
 /**
  * @brief Loads towner data from TSV files.
diff --git a/Source/towners.cpp b/Source/towners.cpp
@@ -2,6 +2,7 @@
 
 #include <algorithm>
 #include <cstdint>
+#include <unordered_map>
 
 #include "cursor.h"
 #include "engine/clx_sprite.hpp"
@@ -50,7 +51,7 @@ struct TownerData {
  *
  * Populated during InitTowners() from the TownersData array.
  */
-const TownerData *TownerBehaviors[NUM_TOWNER_TYPES];
+std::unordered_map<_talker_id, const TownerData *> TownerBehaviors;
 
 /**
  * @brief Default towner initialization using TSV data.
@@ -88,7 +89,8 @@ void NewTownerAnim(Towner &towner, ClxSpriteList sprites, uint8_t numFrames, int
 void InitTownerInfo(Towner &towner, const TownerData &townerData, const TownerDataEntry &entry)
 {
 	towner._ttype = townerData.type;
-	towner.name = _(TownerLongNames[townerData.type]);
+	auto nameIt = TownerLongNames.find(townerData.type);
+	towner.name = nameIt != TownerLongNames.end() ? _(nameIt->second.c_str()) : std::string_view(entry.name);
 	towner.position = entry.position;
 	towner.talk = townerData.talk;
 
@@ -99,14 +101,6 @@ void InitTownerInfo(Towner &towner, const TownerData &townerData, const TownerDa
 	}
 }
 
-void InitTownerInfo(int16_t i, const TownerData &townerData, const TownerDataEntry &entry)
-{
-	// It's necessary to assign this before invoking townerData.init()
-	// specifically for the cows that need to read this value to fill adjacent tiles
-	dMonster[entry.position.x][entry.position.y] = i + 1;
-	InitTownerInfo(Towners[i], townerData, entry);
-}
-
 void LoadTownerAnimations(Towner &towner, const char *path, int frames, int delay)
 {
 	towner.ownedAnim = std::nullopt;
@@ -704,23 +698,19 @@ const TownerData TownersData[] = {
 
 } // namespace
 
-Towner Towners[NUM_TOWNERS];
-
-const char *const TownerLongNames[NUM_TOWNER_TYPES] {
-	N_("Griswold the Blacksmith"),
-	N_("Pepin the Healer"),
-	N_("Wounded Townsman"),
-	N_("Ogden the Tavern owner"),
-	N_("Cain the Elder"),
-	N_("Farnham the Drunk"),
-	N_("Adria the Witch"),
-	N_("Gillian the Barmaid"),
-	N_("Wirt the Peg-legged boy"),
-	N_("Cow"),
-	N_("Lester the farmer"),
-	N_("Celia"),
-	N_("Complete Nut")
-};
+std::vector<Towner> Towners;
+
+std::unordered_map<_talker_id, std::string> TownerLongNames;
+
+size_t GetNumTownerTypes()
+{
+	return TownerLongNames.size();
+}
+
+size_t GetNumTowners()
+{
+	return Towners.size();
+}
 
 bool IsTownerPresent(_talker_id npc)
 {
@@ -756,23 +746,36 @@ void InitTowners()
 	TownerAnimOrderStorage.clear();
 
 	// Build lookup table for towner behaviors
-	std::fill(std::begin(TownerBehaviors), std::end(TownerBehaviors), nullptr);
+	TownerBehaviors.clear();
 	for (const auto &behavior : TownersData) {
 		TownerBehaviors[behavior.type] = &behavior;
 	}
 
+	// Build TownerLongNames from TSV data (first occurrence of each type wins)
+	TownerLongNames.clear();
+	for (const auto &entry : TownersDataEntries) {
+		TownerLongNames.try_emplace(entry.type, entry.name);
+	}
+
 	CowSprites.emplace(LoadCelSheet("towners\\animals\\cow", 128));
 
+	Towners.clear();
+	Towners.reserve(TownersDataEntries.size());
 	int16_t i = 0;
 	for (const auto &entry : TownersDataEntries) {
 		if (!IsTownerPresent(entry.type))
 			continue;
 
-		const TownerData *behavior = TownerBehaviors[entry.type];
-		if (behavior == nullptr)
+		auto behaviorIt = TownerBehaviors.find(entry.type);
+		if (behaviorIt == TownerBehaviors.end() || behaviorIt->second == nullptr)
 			continue;
 
-		InitTownerInfo(i, *behavior, entry);
+		// It's necessary to assign this before invoking townerData.init()
+		// specifically for the cows that need to read this value to fill adjacent tiles
+		dMonster[entry.position.x][entry.position.y] = i + 1;
+
+		Towners.emplace_back();
+		InitTownerInfo(Towners.back(), *behaviorIt->second, entry);
 		i++;
 	}
 }
@@ -852,7 +855,7 @@ bool DebugTalkToTowner(_talker_id type)
 {
 	if (!IsTownerPresent(type))
 		return false;
-	// Cows have special init logic that isn't compatible with this debug function
+		// cows have an init function that differs from the rest and isn't compatible with this code, skip them :(
 	if (type == TOWN_COW)
 		return false;
 
diff --git a/Source/towners.h b/Source/towners.h
diff --git a/test/townerdat_test.cpp b/test/townerdat_test.cpp
