ModernUO/Projects/UOContent/Engines/Virtues/VirtueContext.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

221 lines
7.3 KiB
C#

using System;
using ModernUO.Serialization;
using Server.Mobiles;
namespace Server.Engines.Virtues;
[PropertyObject]
[SerializationGenerator(1)]
public partial class VirtueContext
{
[DirtyTrackingEntity]
private PlayerMobile _player;
public PlayerMobile Player => _player;
public VirtueContext(PlayerMobile player) => _player = player;
private void MigrateFrom(V0Content content)
{
// Save-flagged values arrive as nullables; unset flags fall back to the same
// defaults the old deserialize left in place.
_lastSacrificeGain = content.LastSacrificeGain ?? default;
_lastSacrificeLoss = content.LastSacrificeLoss ?? default;
_availableResurrects = content.AvailableResurrects ?? 0;
_lastJusticeLoss = content.LastJusticeLoss ?? default;
_lastCompassionLoss = content.LastCompassionLoss ?? default;
_nextCompassionDay = content.NextCompassionDay ?? default;
_compassionGains = content.CompassionGains ?? 0;
_lastValorLoss = content.LastValorLoss ?? default;
_lastHonorUse = content.LastHonorUse ?? default;
_honorActive = content.HonorActive;
_justiceProtection = content.JusticeProtection;
_justiceStatus = content.JusticeStatus ?? JusticeProtectorStatus.None;
_values = content.Values;
}
[AnchoredDateTime]
[SerializableField(0)]
[SaveFlag(nameof(ShouldSerializeLastSacrificeGain))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private DateTime _lastSacrificeGain;
private bool ShouldSerializeLastSacrificeGain() => !SacrificeVirtue.CanGain(this);
[AnchoredDateTime]
[SerializableField(1)]
[SaveFlag(nameof(ShouldSerializeLastSacrificeLoss))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private DateTime _lastSacrificeLoss;
private bool ShouldSerializeLastSacrificeLoss() => !SacrificeVirtue.CanAtrophy(this);
[SerializableField(2)]
[SaveFlag(nameof(ShouldSerializeAvailableResurrects))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private int _availableResurrects;
private bool ShouldSerializeAvailableResurrects() => _availableResurrects > 0;
[AnchoredDateTime]
[SerializableField(3)]
[SaveFlag(nameof(ShouldSerializeLastJusticeLoss))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private DateTime _lastJusticeLoss;
private bool ShouldSerializeLastJusticeLoss() => !JusticeVirtue.CanAtrophy(this);
[AnchoredDateTime]
[SerializableField(4)]
[SaveFlag(nameof(ShouldSerializeLastCompassionLoss))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private DateTime _lastCompassionLoss;
private bool ShouldSerializeLastCompassionLoss() => !CompassionVirtue.CanAtrophy(this);
[AnchoredDateTime]
[SerializableField(5)]
[SaveFlag(nameof(ShouldSerializeNextCompassionDay))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private DateTime _nextCompassionDay;
private bool ShouldSerializeNextCompassionDay() => _nextCompassionDay > Core.Now;
[SerializableField(6)]
[SaveFlag(nameof(ShouldSerializeCompassionGains))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private int _compassionGains;
private bool ShouldSerializeCompassionGains() => _compassionGains > 0;
[AnchoredDateTime]
[SerializableField(7)]
[SaveFlag(nameof(ShouldSerializeValorLoss))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private DateTime _lastValorLoss;
private bool ShouldSerializeValorLoss() => !ValorVirtue.CanAtrophy(this);
[AnchoredDateTime]
[SerializableField(8)]
[SaveFlag(nameof(ShouldSerializeLastHonorUse))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private DateTime _lastHonorUse;
private bool ShouldSerializeLastHonorUse() => !HonorVirtue.CanUse(this);
[SerializableField(9)]
[SaveFlag(nameof(ShouldSerializeHonorActive))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Administrator)]
private bool _honorActive;
private bool ShouldSerializeHonorActive() => _honorActive;
[SerializableField(10)]
[SaveFlag(nameof(ShouldSerializeJusticeProtection))]
private PlayerMobile _justiceProtection;
private bool ShouldSerializeJusticeProtection() => _justiceProtection != null && _justiceStatus != JusticeProtectorStatus.None;
[SerializableField(11)]
[SaveFlag(nameof(ShouldSerializeJusticeStatus))]
private JusticeProtectorStatus _justiceStatus;
private bool ShouldSerializeJusticeStatus() => _justiceProtection != null && _justiceStatus != JusticeProtectorStatus.None;
[SerializableField(12, setter: "private")]
[SaveFlag(nameof(ShouldSerializeValues))]
private int[] _values;
private bool ShouldSerializeValues()
{
if (_values == null)
{
return false;
}
for (var i = 0; i < _values.Length; i++)
{
if (_values[i] > 0)
{
return true;
}
}
return false;
}
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public int Humility
{
get => GetValue(0);
set => SetValue(0, value);
}
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public int Sacrifice
{
get => GetValue(1);
set => SetValue(1, value);
}
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public int Compassion
{
get => GetValue(2);
set => SetValue(2, value);
}
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public int Spirituality
{
get => GetValue(3);
set => SetValue(3, value);
}
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public int Valor
{
get => GetValue(4);
set => SetValue(4, value);
}
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public int Honor
{
get => GetValue(5);
set => SetValue(5, value);
}
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public int Justice
{
get => GetValue(6);
set => SetValue(6, value);
}
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public int Honesty
{
get => GetValue(7);
set => SetValue(7, value);
}
public int GetValue(int index) => _values?[index] ?? 0;
public void SetValue(int index, int value)
{
_values ??= new int[8];
_values[index] = value;
}
public override string ToString() => "...";
// Used to invalidate and delete the VirtueContext, usually during world load
public bool IsUsed() => ShouldSerializeLastSacrificeGain() || ShouldSerializeLastSacrificeLoss() ||
ShouldSerializeAvailableResurrects() || ShouldSerializeLastJusticeLoss() ||
ShouldSerializeJusticeStatus() || ShouldSerializeNextCompassionDay() ||
ShouldSerializeCompassionGains() || ShouldSerializeValorLoss() ||
ShouldSerializeLastHonorUse() || ShouldSerializeHonorActive() ||
ShouldSerializeValues() || ShouldSerializeLastCompassionLoss();
}