refactor(component): the client's component lifecycle

Components get the client's per-component functions: LoadDataFromTemplate,
PrepareConfigData, LoadConfigData, LoadFromSaveData, Startup, Run,
OnEnterScope, OnLeaveScope, Preshutdown and Shutdown, called by the entity in
the client's order. Update is renamed Run, LoadFromXml LoadFromSaveData and
UpdateXml WriteSaveData. Nothing sent changes.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
Aaron Kimbrell
2026-10-01 07:45:16 -05:00
parent e8406cc829
commit 50bfa623ca
58 changed files with 181 additions and 132 deletions

View File

@@ -50,7 +50,7 @@ TEST_F(CharacterSaveFieldsTests, MissionTypeStatesRoundTrip) {
Entity player(20, info);
auto* const missions = player.AddComponent<MissionComponent>(-1);
missions->LoadFromXml(doc);
missions->LoadFromSaveData(doc);
const auto& states = missions->GetMissionTypeStates();
ASSERT_EQ(states.size(), 2);
EXPECT_EQ(states.at("Build").at(""), eMissionLockState::NEW);
@@ -58,12 +58,12 @@ TEST_F(CharacterSaveFieldsTests, MissionTypeStatesRoundTrip) {
EXPECT_EQ(states.at("Location").at("Nimbus Station"), eMissionLockState::UNLOCKED);
missions->SetMissionTypeState("Battle", "General", eMissionLockState::NEW);
missions->UpdateXml(doc);
missions->WriteSaveData(doc);
EXPECT_EQ(Print(doc), R"(<obj v="1"><mis><done/><cur/><ts><type v="Battle"><st sub="General" val="1"/></type><type v="Build"><st sub="" val="1"/></type><type v="Location"><st sub="Avant Gardens" val="1"/><st sub="Nimbus Station" val="2"/></type></ts></mis></obj>)");
Entity reloaded(21, info);
auto* const reloadedMissions = reloaded.AddComponent<MissionComponent>(-1);
reloadedMissions->LoadFromXml(doc);
reloadedMissions->LoadFromSaveData(doc);
EXPECT_EQ(reloadedMissions->GetMissionTypeStates(), states);
}
@@ -74,9 +74,9 @@ TEST_F(CharacterSaveFieldsTests, MissionTypeStatesMissingInOldSave) {
Entity player(22, info);
auto* const missions = player.AddComponent<MissionComponent>(-1);
missions->LoadFromXml(doc);
missions->LoadFromSaveData(doc);
EXPECT_TRUE(missions->GetMissionTypeStates().empty());
missions->UpdateXml(doc);
missions->WriteSaveData(doc);
EXPECT_EQ(Print(doc), R"(<obj v="1"><mis><done/><cur/><ts/></mis></obj>)");
}
@@ -88,16 +88,16 @@ TEST_F(CharacterSaveFieldsTests, TooltipFlagsRoundTrip) {
Character character(1, nullptr);
Entity player(23, info);
auto* const characterComponent = player.AddComponent<CharacterComponent>(-1, &character, UNASSIGNED_SYSTEM_ADDRESS);
characterComponent->LoadFromXml(doc);
characterComponent->LoadFromSaveData(doc);
EXPECT_EQ(characterComponent->GetTooltipFlags(), 16777216u);
characterComponent->SetTooltipFlag(2, true);
characterComponent->UpdateXml(doc);
characterComponent->WriteSaveData(doc);
EXPECT_STREQ(doc.FirstChildElement("obj")->FirstChildElement("char")->Attribute("ttip"), "16777220");
Entity reloaded(24, info);
auto* const reloadedComponent = reloaded.AddComponent<CharacterComponent>(-1, &character, UNASSIGNED_SYSTEM_ADDRESS);
reloadedComponent->LoadFromXml(doc);
reloadedComponent->LoadFromSaveData(doc);
EXPECT_EQ(reloadedComponent->GetTooltipFlags(), 16777220u);
}
@@ -109,9 +109,9 @@ TEST_F(CharacterSaveFieldsTests, TooltipFlagsMissingInOldSave) {
Character character(1, nullptr);
Entity player(25, info);
auto* const characterComponent = player.AddComponent<CharacterComponent>(-1, &character, UNASSIGNED_SYSTEM_ADDRESS);
characterComponent->LoadFromXml(doc);
characterComponent->LoadFromSaveData(doc);
EXPECT_EQ(characterComponent->GetTooltipFlags(), 0u);
characterComponent->UpdateXml(doc);
characterComponent->WriteSaveData(doc);
EXPECT_STREQ(doc.FirstChildElement("obj")->FirstChildElement("char")->Attribute("ttip"), "0");
}
@@ -134,19 +134,19 @@ TEST_F(CharacterSaveFieldsTests, SkillCooldownsRoundTrip) {
Entity player(26, info);
auto* const skills = player.AddComponent<SkillComponent>(-1);
skills->LoadFromXml(doc);
skills->LoadFromSaveData(doc);
ASSERT_EQ(skills->GetCooldownGroups().size(), 2u);
EXPECT_FLOAT_EQ(skills->GetCooldownGroups().at(8), 26.6559f);
skills->Update(26.7f); // group 8 runs out
skills->Run(26.7f); // group 8 runs out
skills->StartCooldown(394);
skills->StartCooldown(395); // no group: not saved
skills->UpdateXml(doc);
skills->WriteSaveData(doc);
EXPECT_EQ(Print(doc), R"(<obj v="1"><skil sc="17:30;78:4.0363;"/></obj>)");
Entity reloaded(27, info);
auto* const reloadedSkills = reloaded.AddComponent<SkillComponent>(-1);
reloadedSkills->LoadFromXml(doc);
reloadedSkills->LoadFromSaveData(doc);
EXPECT_EQ(reloadedSkills->GetCooldownGroups().size(), 2u);
EXPECT_FLOAT_EQ(reloadedSkills->GetCooldownGroups().at(17), 30.0f);
@@ -160,9 +160,9 @@ TEST_F(CharacterSaveFieldsTests, SkillCooldownsMissingInOldSave) {
Entity player(28, info);
auto* const skills = player.AddComponent<SkillComponent>(-1);
skills->LoadFromXml(doc);
skills->LoadFromSaveData(doc);
EXPECT_TRUE(skills->GetCooldownGroups().empty());
skills->UpdateXml(doc);
skills->WriteSaveData(doc);
EXPECT_EQ(Print(doc), R"(<obj v="1"><skil/></obj>)");
}
@@ -177,6 +177,6 @@ TEST_F(CharacterSaveFieldsTests, PetsAsLiveWroteThem) {
auto* const inventory = player.AddComponent<InventoryComponent>(-1);
inventory->LoadXml(doc); // the pets load first; there is no <inv> here
EXPECT_EQ(inventory->GetDatabasePet(1152921510000000001LL).lot, 3254);
inventory->UpdateXml(doc);
inventory->WriteSaveData(doc);
EXPECT_EQ(Print(doc), R"(<obj v="1"><pet a="0"><p id="1152921510000000001" l="3254" m="2" n="Fluffy" t="0"/></pet></obj>)");
}

View File

@@ -49,7 +49,7 @@ protected:
tinyxml2::XMLDocument doc;
const std::string xml = std::string(R"(<obj v="1"><mis><done/><cur><m id="2040" state=")") + state + R"("/></cur></mis></obj>)";
ASSERT_EQ(doc.Parse(xml.c_str()), tinyxml2::XML_SUCCESS);
missions.LoadFromXml(doc);
missions.LoadFromSaveData(doc);
}
};

View File

@@ -577,7 +577,7 @@ TEST_F(DestroyableTest, DestroyableComponentDamageCooldownTest) {
ASSERT_TRUE(destroyableComponent->IsCooldownImmune());
// Test that the Update() function correctly decrements the damage cooldown timer
destroyableComponent->Update(0.5f);
destroyableComponent->Run(0.5f);
EXPECT_FLOAT_EQ(destroyableComponent->GetDamageCooldownTimer(), 0.5f);
ASSERT_TRUE(destroyableComponent->IsCooldownImmune());

View File

@@ -61,7 +61,7 @@ protected:
// The "eq" attribute the save wrote for an item
bool SavedEquipped(const LWOOBJID id) {
inventory->UpdateXml(doc);
inventory->WriteSaveData(doc);
for (auto* bag = doc.FirstChildElement("obj")->FirstChildElement("inv")->FirstChildElement("items")->FirstChildElement("in"); bag; bag = bag->NextSiblingElement("in")) {
for (auto* element = bag->FirstChildElement("i"); element; element = element->NextSiblingElement("i")) {
if (element->Int64Attribute("id") == id) return element->BoolAttribute("eq");

View File

@@ -60,7 +60,7 @@ TEST_F(ItemRemovalTests, ARemovedItemIsUsableUntilTheNextUpdate) {
EXPECT_EQ(item->GetId(), id);
EXPECT_EQ(item->GetCount(), 0u);
inventoryComponent->Update(0.0f);
inventoryComponent->Run(0.0f);
EXPECT_FALSE(items->HasRetiredItems());
}
@@ -75,7 +75,7 @@ TEST_F(ItemRemovalTests, RemovingSeveralItemsInALoop) {
for (auto* const item : held | std::views::values) EXPECT_EQ(item->GetCount(), 0u);
EXPECT_TRUE(items->GetItems().empty());
inventoryComponent->Update(0.0f);
inventoryComponent->Run(0.0f);
EXPECT_FALSE(items->HasRetiredItems());
}

View File

@@ -182,14 +182,14 @@ TEST_F(MovingPlatformComponentTest, MoverRunsLikeLive) {
EXPECT_EQ(mover->mCurrentWaypointIndex, 0u);
EXPECT_EQ(mover->mNextWaypointIndex, 1u);
platform->Update(1.9f);
platform->Run(1.9f);
EXPECT_EQ(mover->mState, 25u);
EXPECT_FLOAT_EQ(mover->mIdleTimeElapsed, 1.9f);
platform->Update(0.2f);
platform->Run(0.2f);
EXPECT_EQ(mover->mState, 2u);
// 5 units a second over 10
platform->Update(1.0f);
platform->Run(1.0f);
EXPECT_NEAR(mover->mPercentBetweenPoints, 0.5f, 0.001f);
EXPECT_NEAR(mover->mPosition.x, 5.0f, 0.01f);
GameMessages::PlatformResync resync;
@@ -199,7 +199,7 @@ TEST_F(MovingPlatformComponentTest, MoverRunsLikeLive) {
EXPECT_EQ(resync.iNextIndex, 1);
EXPECT_NEAR(resync.fPercentBetweenPoints, 0.5f, 0.001f);
platform->Update(1.1f);
platform->Run(1.1f);
EXPECT_EQ(mover->mState, 25u);
EXPECT_EQ(mover->mCurrentWaypointIndex, 1u);
EXPECT_EQ(mover->mNextWaypointIndex, 0u);
@@ -210,23 +210,23 @@ TEST_F(MovingPlatformComponentTest, MoverRunsLikeLive) {
platform->GotoWaypoint(0, true);
EXPECT_EQ(mover->mState, 2u);
EXPECT_EQ(mover->mDesiredWaypointIndex, 0);
platform->Update(2.5f);
platform->Run(2.5f);
EXPECT_EQ(mover->mState, 25u);
EXPECT_EQ(mover->mCurrentWaypointIndex, 0u);
EXPECT_EQ(mover->mDesiredWaypointIndex, -1);
platform->Update(10.0f);
platform->Run(10.0f);
EXPECT_EQ(mover->mState, 25u);
// Started at a waypoint it first waits there (issue 964), then stopped mid way and started again
platform->StartPathing();
EXPECT_EQ(mover->mState, 25u);
platform->Update(2.1f);
platform->Run(2.1f);
EXPECT_EQ(mover->mState, 2u);
platform->Update(1.0f);
platform->Run(1.0f);
platform->StopPathing();
EXPECT_EQ(mover->mState & 1u, 1u);
const auto percent = mover->mPercentBetweenPoints;
platform->Update(1.0f);
platform->Run(1.0f);
EXPECT_EQ(mover->mPercentBetweenPoints, percent);
platform->StartPathing();
EXPECT_EQ(mover->mState, 2u);

View File

@@ -62,7 +62,7 @@ protected:
std::vector<CapturedPacket> Build() {
quickBuild->OnUse(player.get());
return Capture([&] {
for (int i = 0; i < 3 && quickBuild->GetState() != eQuickBuildState::COMPLETED; i++) quickBuild->Update(0.1f);
for (int i = 0; i < 3 && quickBuild->GetState() != eQuickBuildState::COMPLETED; i++) quickBuild->Run(0.1f);
});
}

View File

@@ -33,7 +33,7 @@ protected:
character->_doQuickXMLDataParse();
character->LoadXmlRespawnCheckpoints();
entity->AddComponent<CharacterComponent>(-1, character.get(), UNASSIGNED_SYSTEM_ADDRESS)->LoadFromXml(entity->GetCharacter()->GetXMLDoc());
entity->AddComponent<CharacterComponent>(-1, character.get(), UNASSIGNED_SYSTEM_ADDRESS)->LoadFromSaveData(entity->GetCharacter()->GetXMLDoc());
}
void TearDown() override {
@@ -63,7 +63,7 @@ TEST_F(SavingTest, CharacterComponentTest) {
const auto prevTotalTime = characterComponent->GetTotalTimePlayed();
character->_doQuickXMLDataParse();
entity->AddComponent<CharacterComponent>(-1, character.get(), UNASSIGNED_SYSTEM_ADDRESS);
characterComponent->LoadFromXml(entity->GetCharacter()->GetXMLDoc());
characterComponent->LoadFromSaveData(entity->GetCharacter()->GetXMLDoc());
// Check that the buff component is the same as before which means resaving data and loading it back in didn't change anything
ASSERT_EQ("32114;69;343;13;163;2;181;2;388;252;146;24451;25;9022;41898;42186;42524;4404;0;0;0;0;0;0;0;0;0;", characterComponent->StatisticsToString());