Add portal positions to town config

Author: yuripourre

Source/levels/town_data.cpp

@@ -9,7 +9,7 @@ namespace {
 TownRegistry g_townRegistry;
 
 /** @brief Spawn used when no TownEntryPoint matches (matches legacy hard-coded default). */
-constexpr Point kDefaultTownEntryPoint = { 75, 68 };
+constexpr Point DefaultTownEntryPoint = { 75, 68 };
 
 } // namespace
 
@@ -65,6 +65,16 @@ std::string TownRegistry::GetTownBySaveId(uint8_t saveId) const
 	return { TristramTownId };
 }
 
+Point GetPortalTownPosition(size_t portalIndex)
+{
+	if (portalIndex >= NumTownPortalSlots)
+		return DefaultTristramPortalPositions[0];
+	const std::string &townId = GetTownRegistry().GetCurrentTown();
+	if (GetTownRegistry().HasTown(townId))
+		return GetTownRegistry().GetTown(townId).portalPositions[portalIndex];
+	return DefaultTristramPortalPositions[portalIndex];
+}
+
 Point TownConfig::GetEntryPoint(lvl_entry entry, int warpFrom) const
 {
 	// For ENTRY_TWARPUP, match both entry type and warpFromLevel
@@ -74,7 +84,7 @@ Point TownConfig::GetEntryPoint(lvl_entry entry, int warpFrom) const
 				return ep.viewPosition;
 			}
 		}
-		return kDefaultTownEntryPoint;
+		return DefaultTownEntryPoint;
 	}
 
 	// For other entry types, just match the type
@@ -85,7 +95,7 @@ Point TownConfig::GetEntryPoint(lvl_entry entry, int warpFrom) const
 	}
 
 	// Default fallback
-	return kDefaultTownEntryPoint;
+	return DefaultTownEntryPoint;
 }
 
 void InitializeTristram()

Source/levels/town_data.h

@@ -1,5 +1,6 @@
 #pragma once
 
+#include <array>
 #include <optional>
 #include <string>
 #include <unordered_map>
@@ -15,6 +16,22 @@ namespace devilution {
 /** @brief Canonical town registry id for vanilla Tristram (lowercase). */
 inline constexpr char TristramTownId[] = "tristram";
 
+/** @brief Town portal spell anchor slots; must match MAXPORTAL in portal.h. */
+inline constexpr size_t NumTownPortalSlots = 4;
+
+/** @brief Legacy positions for town portal missiles (one per player slot). */
+inline constexpr std::array<Point, NumTownPortalSlots> DefaultTristramPortalPositions = { {
+	Point { 57, 40 },
+	Point { 59, 40 },
+	Point { 61, 40 },
+	Point { 63, 40 },
+} };
+
+/**
+ * @brief World position for the town portal missile / portal entry for player slot `portalIndex`.
+ */
+Point GetPortalTownPosition(size_t portalIndex);
+
 /**
  * @brief Represents a town sector (map piece)
  */
@@ -90,6 +107,7 @@ struct TownConfig {
 	std::vector<TownTrigger> triggers;
 	std::vector<TownWarpPatch> warpClosedPatches;
 	std::vector<TownerPositionOverride> townerOverrides;
+	std::array<Point, NumTownPortalSlots> portalPositions = DefaultTristramPortalPositions;
 
 	/**
 	 * @brief Gets the spawn point for a given entry type and warp source

Source/lua/modules/towns.cpp

@@ -139,6 +139,21 @@ std::string LuaRegisterTown(std::string_view townId, const sol::table &config)
 		}
 	}
 
+	if (sol::optional<sol::table> portals = config["portals"]) {
+		size_t slot = 0;
+		for (const auto &kv : *portals) {
+			if (slot >= NumTownPortalSlots) {
+				LogWarn("registerTown: portals list has more than {} entries; ignoring extras", NumTownPortalSlots);
+				break;
+			}
+			sol::table t = kv.second.as<sol::table>();
+			sol::optional<int> px = t["x"];
+			sol::optional<int> py = t["y"];
+			townConfig.portalPositions[slot] = { px.value_or(0), py.value_or(0) };
+			++slot;
+		}
+	}
+
 	std::string townIdStr(townId);
 	GetTownRegistry().RegisterTown(townIdStr, townConfig);
 	return townIdStr;
@@ -182,7 +197,8 @@ sol::table LuaTownsModule(sol::state_view &lua)
 	LuaSetDocFn(table, "register", "(townId: string, config: table) -> string",
 	    "Registers a new town from a config table. Returns town ID.\n"
 	    "Optional triggers: array of tables with x, y, kind (\"nextlevel\" or \"townwarp\").\n"
-	    "For townwarp, set level (dungeon level) and warp (\"catacombs\", \"caves\", \"hell\", \"nest\", \"crypt\") for IsWarpOpen gating.",
+	    "For townwarp, set level (dungeon level) and warp (\"catacombs\", \"caves\", \"hell\", \"nest\", \"crypt\") for IsWarpOpen gating.\n"
+	    "Optional portals: up to four { x, y } tables for town portal spell positions (defaults match Tristram).",
 	    LuaRegisterTown);
 
 	LuaSetDocFn(table, "travel", "(townId: string)",

Source/portal.cpp

@@ -5,6 +5,7 @@
  */
 #include "portal.h"
 
+#include "levels/town_data.h"
 #include "lighting.h"
 #include "missiles.h"
 #include "multi.h"
@@ -21,14 +22,6 @@ namespace {
 /** Current portal number (a portal array index). */
 size_t portalindex;
 
-/** Coordinate of each player's portal in town. */
-Point PortalTownPosition[MAXPORTAL] = {
-	{ 57, 40 },
-	{ 59, 40 },
-	{ 61, 40 },
-	{ 63, 40 },
-};
-
 } // namespace
 
 void InitPortals()
@@ -67,7 +60,7 @@ void SyncPortals()
 			continue;
 		const Player &player = Players[i];
 		if (leveltype == DTYPE_TOWN)
-			AddPortalMissile(player, PortalTownPosition[i], true);
+			AddPortalMissile(player, GetPortalTownPosition(static_cast<size_t>(i)), true);
 		else {
 			int lvl = currlevel;
 			if (setlevel)
@@ -80,7 +73,7 @@ void SyncPortals()
 
 void AddPortalInTown(const Player &player)
 {
-	AddPortalMissile(player, PortalTownPosition[player.getId()], false);
+	AddPortalMissile(player, GetPortalTownPosition(player.getId()), false);
 }
 
 void ActivatePortal(const Player &player, Point position, int lvl, dungeon_type dungeonType, bool isSetLevel)
@@ -163,7 +156,7 @@ void GetPortalLevel()
 void GetPortalLvlPos()
 {
 	if (leveltype == DTYPE_TOWN) {
-		ViewPosition = PortalTownPosition[portalindex] + Displacement { 1, 1 };
+		ViewPosition = GetPortalTownPosition(portalindex) + Displacement { 1, 1 };
 	} else {
 		ViewPosition = Portals[portalindex].position;
 

test/town_registry_test.cpp

@@ -14,19 +14,19 @@ using namespace devilution;
 
 namespace {
 
-constexpr size_t kTristramTriggerCount = 6;
-constexpr size_t kTristramWarpClosedPatchCount = 3;
-constexpr size_t kTristramEntryPointCount = 8;
+constexpr size_t TristramTriggerCount = 6;
+constexpr size_t TristramWarpClosedPatchCount = 3;
+constexpr size_t TristramEntryPointCount = 8;
 
-constexpr Point kTristramCathedralTrigPosition = { 25, 29 };
+constexpr Point TristramCathedralTrigPosition = { 25, 29 };
 
-constexpr Point kTownEntryDefaultFallback = { 75, 68 };
+constexpr Point TownEntryDefaultFallback = { 75, 68 };
 
-constexpr uint8_t kTestTownAlphaSaveId = 7;
-constexpr uint8_t kTestTownBetaSaveId = 11;
-constexpr uint8_t kUnknownSaveId = 99;
+constexpr uint8_t TestTownAlphaSaveId = 7;
+constexpr uint8_t TestTownBetaSaveId = 11;
+constexpr uint8_t UnknownSaveId = 99;
 
-constexpr int kNonMatchingWarpFromLevel = 999;
+constexpr int NonMatchingWarpFromLevel = 999;
 
 TEST(TownRegistry, HasTown_ReturnsFalseForUnregistered)
 {
@@ -64,27 +64,27 @@ TEST(TownRegistry, GetTownBySaveId_FindsBySaveId)
 	TownRegistry registry;
 	TownConfig alpha;
 	alpha.name = "Alpha";
-	alpha.saveId = kTestTownAlphaSaveId;
+	alpha.saveId = TestTownAlphaSaveId;
 	TownConfig beta;
 	beta.name = "Beta";
-	beta.saveId = kTestTownBetaSaveId;
+	beta.saveId = TestTownBetaSaveId;
 	registry.RegisterTown("alpha", alpha);
 	registry.RegisterTown("beta", beta);
-	EXPECT_EQ(registry.GetTownBySaveId(kTestTownAlphaSaveId), "alpha");
-	EXPECT_EQ(registry.GetTownBySaveId(kTestTownBetaSaveId), "beta");
+	EXPECT_EQ(registry.GetTownBySaveId(TestTownAlphaSaveId), "alpha");
+	EXPECT_EQ(registry.GetTownBySaveId(TestTownBetaSaveId), "beta");
 }
 
 TEST(TownRegistry, GetTownBySaveId_ReturnsTristramForUnknownNonZeroSaveId)
 {
 	TownRegistry registry;
-	EXPECT_EQ(registry.GetTownBySaveId(kUnknownSaveId), TristramTownId);
+	EXPECT_EQ(registry.GetTownBySaveId(UnknownSaveId), TristramTownId);
 }
 
 TEST(TownRegistry, GetTownBySaveId_ReturnsTristramWhenZeroNotRegistered)
 {
 	TownRegistry registry;
 	TownConfig cfg;
-	cfg.saveId = kTestTownAlphaSaveId;
+	cfg.saveId = TestTownAlphaSaveId;
 	registry.RegisterTown("only_alpha", cfg);
 	EXPECT_EQ(registry.GetTownBySaveId(0), TristramTownId);
 }
@@ -101,11 +101,11 @@ TEST(TownConfig, GetEntryPoint_ENTRY_MAIN)
 TEST(TownConfig, GetEntryPoint_ENTRY_TWARPUP_MatchesWarpFromLevel)
 {
 	TownConfig cfg;
-	constexpr int kWarpFromLevel = 5;
+	constexpr int WarpFromLevel = 5;
 	cfg.entries = {
-		{ ENTRY_TWARPUP, { 49, 22 }, kWarpFromLevel },
+		{ ENTRY_TWARPUP, { 49, 22 }, WarpFromLevel },
 	};
-	EXPECT_EQ(cfg.GetEntryPoint(ENTRY_TWARPUP, kWarpFromLevel), Point(49, 22));
+	EXPECT_EQ(cfg.GetEntryPoint(ENTRY_TWARPUP, WarpFromLevel), Point(49, 22));
 }
 
 TEST(TownConfig, GetEntryPoint_ENTRY_TWARPUP_NonMatchingWarpUsesDefault)
@@ -114,14 +114,14 @@ TEST(TownConfig, GetEntryPoint_ENTRY_TWARPUP_NonMatchingWarpUsesDefault)
 	cfg.entries = {
 		{ ENTRY_TWARPUP, { 49, 22 }, 5 },
 	};
-	EXPECT_EQ(cfg.GetEntryPoint(ENTRY_TWARPUP, kNonMatchingWarpFromLevel), kTownEntryDefaultFallback);
+	EXPECT_EQ(cfg.GetEntryPoint(ENTRY_TWARPUP, NonMatchingWarpFromLevel), TownEntryDefaultFallback);
 }
 
 TEST(TownConfig, GetEntryPoint_EmptyEntriesUsesDefault)
 {
 	TownConfig cfg;
 	cfg.entries.clear();
-	EXPECT_EQ(cfg.GetEntryPoint(ENTRY_MAIN), kTownEntryDefaultFallback);
+	EXPECT_EQ(cfg.GetEntryPoint(ENTRY_MAIN), TownEntryDefaultFallback);
 }
 
 class InitializeTristramTest : public ::testing::Test {
@@ -151,28 +151,57 @@ TEST_F(InitializeTristramTest, GetTownBySaveIdZeroReturnsTristram)
 TEST_F(InitializeTristramTest, TristramTriggerCount)
 {
 	const TownConfig &tristram = GetTownRegistry().GetTown(TristramTownId);
-	EXPECT_EQ(tristram.triggers.size(), kTristramTriggerCount);
+	EXPECT_EQ(tristram.triggers.size(), TristramTriggerCount);
 }
 
 TEST_F(InitializeTristramTest, TristramFirstTriggerIsCathedralStairs)
 {
 	const TownConfig &tristram = GetTownRegistry().GetTown(TristramTownId);
 	ASSERT_FALSE(tristram.triggers.empty());
 	const TownTrigger &first = tristram.triggers.front();
-	EXPECT_EQ(first.position, kTristramCathedralTrigPosition);
+	EXPECT_EQ(first.position, TristramCathedralTrigPosition);
 	EXPECT_EQ(first.msg, WM_DIABNEXTLVL);
 }
 
 TEST_F(InitializeTristramTest, TristramWarpClosedPatchCount)
 {
 	const TownConfig &tristram = GetTownRegistry().GetTown(TristramTownId);
-	EXPECT_EQ(tristram.warpClosedPatches.size(), kTristramWarpClosedPatchCount);
+	EXPECT_EQ(tristram.warpClosedPatches.size(), TristramWarpClosedPatchCount);
 }
 
 TEST_F(InitializeTristramTest, TristramEntryPointCount)
 {
 	const TownConfig &tristram = GetTownRegistry().GetTown(TristramTownId);
-	EXPECT_EQ(tristram.entries.size(), kTristramEntryPointCount);
+	EXPECT_EQ(tristram.entries.size(), TristramEntryPointCount);
+}
+
+TEST_F(InitializeTristramTest, TristramPortalPositionsMatchLegacy)
+{
+	const TownConfig &tristram = GetTownRegistry().GetTown(TristramTownId);
+	for (size_t i = 0; i < NumTownPortalSlots; ++i) {
+		EXPECT_EQ(tristram.portalPositions[i], DefaultTristramPortalPositions[i]);
+	}
+}
+
+TEST_F(InitializeTristramTest, GetPortalTownPositionMatchesTristramWhenCurrent)
+{
+	for (size_t i = 0; i < NumTownPortalSlots; ++i) {
+		EXPECT_EQ(GetPortalTownPosition(i), DefaultTristramPortalPositions[i]);
+	}
+}
+
+TEST_F(InitializeTristramTest, GetPortalTownPositionUsesTownOverrides)
+{
+	TownConfig c;
+	c.name = "PortTest";
+	c.saveId = 7;
+	c.portalPositions = DefaultTristramPortalPositions;
+	c.portalPositions[0] = { 99, 88 };
+	GetTownRegistry().RegisterTown("porttest", c);
+	GetTownRegistry().SetCurrentTown("porttest");
+	EXPECT_EQ(GetPortalTownPosition(0), Point(99, 88));
+	EXPECT_EQ(GetPortalTownPosition(1), DefaultTristramPortalPositions[1]);
+	GetTownRegistry().SetCurrentTown(TristramTownId);
 }
 
 } // namespace