Files
DarkflameServer/tests/dGameTests/dComponentsTests/CharacterSaveFieldsTests.cpp
Aaron Kimbrell dc5f13cdbc feat: write the character attributes live saved and the client reads
LWOCharacterComponent::LoadFromSaveData (0x00ca4910) reads them, and live
saves had every one (450 of 450 characters saved at least once):
- cm, the most coins a character can hold: 9223372036854775807 on every
  live save, the client's own value without it. Written when missing, an
  existing one is kept, and nothing caps the coins by it.
- edit (editor level), gid and gn (guild id and name).
- mldt (when the property moderation notice was last shown): 0 when
  missing, as most live saves.
- v and vd: the votes left and the day they are for (GetVotesLeft /
  AdjustVotesLeft). Read back; a new day fills them up to the 3 of
  WorldConfig's character_votes_per_day.
- lrx.. lrrw: the last respawn point reached, once one was reached in the
  world.
- lzcs: the checksum of the zone in lzid.

Saves without them load as before. stime is not written: live kept the
session's seconds in it and the time before the session in time, which
would change what time means in existing saves.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-10 14:50:43 -06:00

259 lines
12 KiB
C++

// Charxml fields the client reads on load that DLU now saves. The formats are the ones live wrote (2011/2012 live
// captures of the charxml the world server sent) and the client reads (legouniverse.exe 1.10.64).
#include "GameDependencies.h"
#include "CDClientDatabase.h"
#include "Character.h"
#include "CharacterComponent.h"
#include "Entity.h"
#include "GameMessages.h"
#include "MissionComponent.h"
#include "SkillComponent.h"
#include "InventoryComponent.h"
#include "DatabasePet.h"
#include "CDSkillBehaviorTable.h"
#include "CDClientManager.h"
#include "eMissionLockState.h"
#include "tinyxml2.h"
#include <ctime>
#include <string>
#include <gtest/gtest.h>
namespace {
std::string Print(const tinyxml2::XMLDocument& doc) {
tinyxml2::XMLPrinter printer(nullptr, true);
doc.Print(&printer);
return printer.CStr();
}
void Parse(tinyxml2::XMLDocument& doc, const std::string& xml) {
ASSERT_EQ(doc.Parse(xml.c_str()), tinyxml2::XML_SUCCESS);
}
}
class CharacterSaveFieldsTests : public GameDependenciesTest {
protected:
void SetUp() override {
SetUpDependencies();
CDClientDatabase::Connect(":memory:"); // MissionComponent counts the achievements
CDClientDatabase::ExecuteDML("CREATE TABLE Missions (id INTEGER, isMission INTEGER);");
}
void TearDown() override { TearDownDependencies(); }
};
// <mis><ts>: the states of the mission journal tabs, written after <cur> the way live wrote them.
TEST_F(CharacterSaveFieldsTests, MissionTypeStatesRoundTrip) {
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"><mis><done/><cur/><ts><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 player(20, info);
auto* const missions = player.AddComponent<MissionComponent>(-1);
missions->LoadFromSaveData(doc);
const auto& states = missions->GetMissionTypeStates();
ASSERT_EQ(states.size(), 2);
EXPECT_EQ(states.at("Build").at(""), eMissionLockState::NEW);
EXPECT_EQ(states.at("Location").at("Avant Gardens"), eMissionLockState::NEW);
EXPECT_EQ(states.at("Location").at("Nimbus Station"), eMissionLockState::UNLOCKED);
missions->SetMissionTypeState("Battle", "General", eMissionLockState::NEW);
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->LoadFromSaveData(doc);
EXPECT_EQ(reloadedMissions->GetMissionTypeStates(), states);
}
// Saves from before <ts> was written load with no states and gain an empty <ts>.
TEST_F(CharacterSaveFieldsTests, MissionTypeStatesMissingInOldSave) {
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"><mis><done/><cur/></mis></obj>)");
Entity player(22, info);
auto* const missions = player.AddComponent<MissionComponent>(-1);
missions->LoadFromSaveData(doc);
EXPECT_TRUE(missions->GetMissionTypeStates().empty());
missions->WriteSaveData(doc);
EXPECT_EQ(Print(doc), R"(<obj v="1"><mis><done/><cur/><ts/></mis></obj>)");
}
// char@ttip: the tooltip bits (the client reads it with GetLongLongValue). Live wrote it on every character.
TEST_F(CharacterSaveFieldsTests, TooltipFlagsRoundTrip) {
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"><mf/><char ls="0" ttip="16777216"/></obj>)");
Character character(1, nullptr);
Entity player(23, info);
auto* const characterComponent = player.AddComponent<CharacterComponent>(-1, &character, UNASSIGNED_SYSTEM_ADDRESS);
characterComponent->LoadFromSaveData(doc);
EXPECT_EQ(characterComponent->GetTooltipFlags(), 16777216u);
characterComponent->SetTooltipFlag(2, true);
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->LoadFromSaveData(doc);
EXPECT_EQ(reloadedComponent->GetTooltipFlags(), 16777220u);
}
// Saves from before ttip was written load with no tooltips flagged and gain ttip="0".
TEST_F(CharacterSaveFieldsTests, TooltipFlagsMissingInOldSave) {
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"><mf/><char ls="0"/></obj>)");
Character character(1, nullptr);
Entity player(25, info);
auto* const characterComponent = player.AddComponent<CharacterComponent>(-1, &character, UNASSIGNED_SYSTEM_ADDRESS);
characterComponent->LoadFromSaveData(doc);
EXPECT_EQ(characterComponent->GetTooltipFlags(), 0u);
characterComponent->WriteSaveData(doc);
EXPECT_STREQ(doc.FirstChildElement("obj")->FirstChildElement("char")->Attribute("ttip"), "0");
}
// The <char> attributes live wrote on every character and the client reads: cm, edit, mldt, gid, gn, v, vd and the
// last respawn point. A save that has them keeps what the server does not own, and nothing touches the coins.
TEST_F(CharacterSaveFieldsTests, LiveCharacterAttributesRoundTrip) {
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"><mf/><char cc="22609" cm="5000" ls="0" mldt="1301715419" v="1" vd="1" lrx="1" lry="2" lrz="3" lrrx="0" lrry="0.5" lrrz="0" lrrw="0.5" stime="349" lzcs="2233038349"/></obj>)");
Character character(1, nullptr);
Entity player(40, info);
auto* const characterComponent = player.AddComponent<CharacterComponent>(-1, &character, UNASSIGNED_SYSTEM_ADDRESS);
characterComponent->LoadFromSaveData(doc);
EXPECT_EQ(characterComponent->GetVotesLeft(), 1);
EXPECT_EQ(characterComponent->GetVoteDay(), 1u);
characterComponent->WriteSaveData(doc);
const auto* const saved = doc.FirstChildElement("obj")->FirstChildElement("char");
EXPECT_STREQ(saved->Attribute("cc"), "22609");
EXPECT_STREQ(saved->Attribute("cm"), "5000"); // kept, not replaced and not applied
EXPECT_STREQ(saved->Attribute("mldt"), "1301715419");
EXPECT_STREQ(saved->Attribute("edit"), "0");
EXPECT_STREQ(saved->Attribute("gid"), "0");
EXPECT_STREQ(saved->Attribute("gn"), "");
// A new day: the votes are filled up
const uint64_t today = static_cast<uint64_t>(std::time(nullptr)) / 86400;
EXPECT_LE(saved->Unsigned64Attribute("vd") - today, 1u); // (the day may turn during the test)
EXPECT_STREQ(saved->Attribute("v"), "3");
// No respawn point was reached in this world: the saved one stays
EXPECT_STREQ(saved->Attribute("lrx"), "1");
EXPECT_STREQ(saved->Attribute("lrrw"), "0.5");
// Not written by the server: left alone
EXPECT_STREQ(saved->Attribute("stime"), "349");
EXPECT_STREQ(saved->Attribute("lzcs"), "2233038349");
// The same day: the votes left are kept
Entity reloaded(41, info);
auto* const reloadedComponent = reloaded.AddComponent<CharacterComponent>(-1, &character, UNASSIGNED_SYSTEM_ADDRESS);
doc.FirstChildElement("obj")->FirstChildElement("char")->SetAttribute("v", 2);
reloadedComponent->LoadFromSaveData(doc);
EXPECT_EQ(reloadedComponent->GetVotesLeft(), 2);
reloadedComponent->SetGuild(77, u"Builders");
reloadedComponent->WriteSaveData(doc);
EXPECT_STREQ(saved->Attribute("v"), "2");
EXPECT_STREQ(saved->Attribute("gid"), "77");
EXPECT_STREQ(saved->Attribute("gn"), "Builders");
}
// Saves from before they were written load as before and gain them with the values live had: the coins are not
// touched and cm is the client's own "no limit".
TEST_F(CharacterSaveFieldsTests, LiveCharacterAttributesMissingInOldSave) {
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"><mf/><char acct="1" cc="123456789012" gm="0" ls="15700" ttip="4" time="54390"/></obj>)");
Character character(1, nullptr);
Entity player(42, info);
auto* const characterComponent = player.AddComponent<CharacterComponent>(-1, &character, UNASSIGNED_SYSTEM_ADDRESS);
characterComponent->LoadFromSaveData(doc);
EXPECT_EQ(characterComponent->GetVotesLeft(), 3);
EXPECT_EQ(characterComponent->GetTooltipFlags(), 4u);
EXPECT_EQ(characterComponent->GetUScore(), 15700);
characterComponent->WriteSaveData(doc);
const auto* const saved = doc.FirstChildElement("obj")->FirstChildElement("char");
EXPECT_STREQ(saved->Attribute("cc"), "123456789012");
EXPECT_STREQ(saved->Attribute("acct"), "1");
EXPECT_STREQ(saved->Attribute("ls"), "15700");
EXPECT_STREQ(saved->Attribute("cm"), "9223372036854775807");
EXPECT_STREQ(saved->Attribute("edit"), "0");
EXPECT_STREQ(saved->Attribute("mldt"), "0");
EXPECT_STREQ(saved->Attribute("gid"), "0");
EXPECT_STREQ(saved->Attribute("gn"), "");
EXPECT_STREQ(saved->Attribute("v"), "3");
EXPECT_NE(saved->Attribute("vd"), nullptr);
EXPECT_EQ(saved->Attribute("lrx"), nullptr); // no respawn point reached yet
EXPECT_EQ(saved->Attribute("stime"), nullptr);
}
// <skil sc>: the cooldown groups still running and the seconds left, as live wrote them (sc="17:15.6958;") and the
// client reads them (split on ';' and ':').
TEST_F(CharacterSaveFieldsTests, SkillCooldownsRoundTrip) {
CDSkillBehavior skill{};
skill.skillID = 394;
skill.cooldowngroup = 17;
skill.cooldown = 30.0f;
CDClientManager::GetEntriesMutable<CDSkillBehaviorTable>()[394] = skill;
CDSkillBehavior ungrouped{};
ungrouped.skillID = 395;
ungrouped.cooldowngroup = static_cast<uint32_t>(-1);
ungrouped.cooldown = 30.0f;
CDClientManager::GetEntriesMutable<CDSkillBehaviorTable>()[395] = ungrouped;
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"><skil sc="8:26.6559;78:30.7363;"/></obj>)");
Entity player(26, info);
auto* const skills = player.AddComponent<SkillComponent>(-1);
skills->LoadFromSaveData(doc);
ASSERT_EQ(skills->GetCooldownGroups().size(), 2u);
EXPECT_FLOAT_EQ(skills->GetCooldownGroups().at(8), 26.6559f);
skills->Run(26.7f); // group 8 runs out
skills->StartCooldown(394);
skills->StartCooldown(395); // no group: not saved
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->LoadFromSaveData(doc);
EXPECT_EQ(reloadedSkills->GetCooldownGroups().size(), 2u);
EXPECT_FLOAT_EQ(reloadedSkills->GetCooldownGroups().at(17), 30.0f);
CDClientManager::GetEntriesMutable<CDSkillBehaviorTable>().clear();
}
// Saves without <skil> load with no cooldowns and gain <skil/>, as live wrote it with none running.
TEST_F(CharacterSaveFieldsTests, SkillCooldownsMissingInOldSave) {
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"/>)");
Entity player(28, info);
auto* const skills = player.AddComponent<SkillComponent>(-1);
skills->LoadFromSaveData(doc);
EXPECT_TRUE(skills->GetCooldownGroups().empty());
skills->WriteSaveData(doc);
EXPECT_EQ(Print(doc), R"(<obj v="1"><skil/></obj>)");
}
// <pet a="0">: live wrote the active pet as 0 on every character (the charxml is read at load, before any pet is out),
// and each pet's taming type t as 0. Old saves without a load as before.
TEST_F(CharacterSaveFieldsTests, PetsAsLiveWroteThem) {
CDClientDatabase::ExecuteDML("CREATE TABLE ComponentsRegistry (id INTEGER, component_type INTEGER, component_id INTEGER);");
tinyxml2::XMLDocument doc;
Parse(doc, R"(<obj v="1"><pet><p id="1152921510000000001" l="3254" t="0" n="Fluffy" m="2"/></pet></obj>)");
Entity player(29, info);
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->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>)");
}