ModernUO/Projects/UOContent/Items/Talismans/BaseTalisman.Migrations.cs
Kamron Batman 84153fba58
fix: Fixes dirty-tracking gaps in generated content: setters, sub-object owners, BaseVendor (#2609)
## Why

Delta world saves re-serialize an entity only when it has been marked dirty. An audit of the generated classes found three ways serialized state changes without a mark; this PR closes the ones that do not need a new generator package.

## What

- **Custom `[SerializableProperty]` setters mark dirty.** Twelve hand-written setters assigned their backing field without `this.MarkDirty()`. `PlagueBeastLord.OpenedBy` was an auto-property carrying the attribute with no backing field at all; it is now a generated field with the same name, order and command-property exposure.
- **Generated sub-objects are linked to their owner.** Without a `[DirtyTrackingEntity]` member the generator emits setters that mark nothing. Eight entity-owned sub-objects now carry the link and receive the owner through the constructor the generator calls: `BOBFilter` (owner is `IEntity`: a `PlayerMobile` or a `BulkOrderBook`), `BOBLargeSubEntry`, `PuzzleChestSolution` and `PuzzleChestSolutionAndTime`, `TalismanAttribute` (the random factories now take the talisman), `VendorItem`, `PlayerBBMessage`, `RaffleEntry`, `ShardPollOption`. Migration schemas were regenerated with the pinned tool; the only change is the value rule argument becoming `DeserializationRequiresParent`.
- **BaseVendor uses the generator; restock amounts are no longer persisted.** The only state it wrote was which buy entries had grown restock amounts, packed by index into the live `SBInfos` tables. Restock is transient now and rebuilds on load; version 1 records are read and discarded through the legacy path. Every vendor subclass now serializes through a generated chain.

## Generator 4.1.0

This PR adopts SerializationGenerator 4.1.0 (modernuo/SerializationGenerator#55): SG3019/SG3020 diagnostics, `[VolatileSerializedState]`, `StopXxx()` timer helpers, and owner-constructor preference for sub-objects (so dictionary values are constructed with their owner; the 4.0.0 relink fallback is gone). `PlayerVendor.v3.json` gains `DeserializationRequiresParent` for its `VendorItem` values so the migration content struct constructs them with their vendor.

SG3019 is an error under `TreatWarningsAsErrors` and generator diagnostics ignore pragmas, so the five contexts that live in whole-file player-keyed persistences (`ChampionTitle`, `ChampionTitleContext`, `MurderContext`, `VirtueContext`, `JailRecord`) now carry a `[DirtyTrackingEntity]` link to their `PlayerMobile`, which is where they will live once those blobs move onto the player record. `JailSystem.EmptyRecord` keeps a null player (`[CanBeNull]`). `ChampionTitle` needs both a context and a player constructor because the generator resolves the rule against the containing type but emits the call with the parent field; a comment in the file records this.

## Wire format

Unchanged. No version bumps except `BaseVendor` 1 to 2 (which now writes nothing of its own). Schema diffs are rule-argument only (`DeserializationRequiresParent`).

## Testing

Server.Tests 848 passed, UOContent.Tests 759 passed.
2026-09-06 09:43:44 -07:00

124 lines
3.3 KiB
C#

using System;
namespace Server.Items;
public partial class BaseTalisman
{
private void Deserialize(IGenericReader reader, int version)
{
var flags = (OldSaveFlag)reader.ReadEncodedInt();
Attributes = new AosAttributes(this);
if (GetOldSaveFlag(flags, OldSaveFlag.Attributes))
{
Attributes.Deserialize(reader);
}
SkillBonuses = new AosSkillBonuses(this);
if (GetOldSaveFlag(flags, OldSaveFlag.SkillBonuses))
{
SkillBonuses.Deserialize(reader);
}
// Backward compatibility
if (GetOldSaveFlag(flags, OldSaveFlag.Owner))
{
BlessedFor = reader.ReadEntity<Mobile>();
}
_protection = new TalismanAttribute(this);
if (GetOldSaveFlag(flags, OldSaveFlag.Protection))
{
_protection.Deserialize(reader);
}
_killer = new TalismanAttribute(this);
if (GetOldSaveFlag(flags, OldSaveFlag.Killer))
{
_killer.Deserialize(reader);
}
_summoner = new TalismanAttribute(this);
if (GetOldSaveFlag(flags, OldSaveFlag.Summoner))
{
_summoner.Deserialize(reader);
}
if (GetOldSaveFlag(flags, OldSaveFlag.Removal))
{
_removal = (TalismanRemoval)reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.OldKarmaLoss))
{
Attributes.IncreasedKarmaLoss = reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.Skill))
{
_skill = (SkillName)reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.SuccessBonus))
{
_successBonus = reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.ExceptionalBonus))
{
_exceptionalBonus = reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.MaxCharges))
{
_maxCharges = reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.Charges))
{
_charges = reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.MaxChargeTime))
{
_maxChargeTime = reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.ChargeTime))
{
_chargeTime = reader.ReadEncodedInt();
}
if (GetOldSaveFlag(flags, OldSaveFlag.Slayer))
{
_slayer = (TalismanSlayerName)reader.ReadEncodedInt();
}
_blessed = GetOldSaveFlag(flags, OldSaveFlag.Blessed);
}
private static bool GetOldSaveFlag(OldSaveFlag flags, OldSaveFlag toGet) => (flags & toGet) != 0;
[Flags]
private enum OldSaveFlag
{
None = 0x00000000,
Attributes = 0x00000001,
SkillBonuses = 0x00000002,
Owner = 0x00000004,
Protection = 0x00000008,
Killer = 0x00000010,
Summoner = 0x00000020,
Removal = 0x00000040,
OldKarmaLoss = 0x00000080,
Skill = 0x00000100,
SuccessBonus = 0x00000200,
ExceptionalBonus = 0x00000400,
MaxCharges = 0x00000800,
Charges = 0x00001000,
MaxChargeTime = 0x00002000,
ChargeTime = 0x00004000,
Blessed = 0x00008000,
Slayer = 0x00010000
}
}