refactor: fold hand-written serializable property setters into field hooks (#2587)

## Summary Folds **113** hand-written `[SerializableProperty]` members into plain `[SerializableField]` declarations using the v4 setter hooks — value coercion/vetoes via `allowFieldChange`, post-change side effects via `fieldChanged` (whose `oldValue` parameter covers the old-house/old-sender unsubscribe patterns). Net **-450 lines** of setter boilerplate. ```cs // before [SerializableProperty(1)] [CommandProperty(AccessLevel.GameMaster)] public int Charges { get => _charges; set { _charges = Math.Clamp(value, 0, MaxCharges); InvalidateProperties(); this.MarkDirty(); } } // after [SerializableField(1, allowFieldChange: nameof(AllowChargesChange))] [SerializedCommandProperty(AccessLevel.GameMaster)] [InvalidateProperties] private int _charges; private bool AllowChargesChange(ref int value) { value = Math.Clamp(value, 0, MaxCharges); return true; } ``` ## How sites were selected A classifier parsed all 204 `[SerializableProperty]` sites and converted only those matching strict shapes: getter is exactly `get => _field;`, the assignment comes first (after at most an equality guard), and relocated side effects contain no `return`, no `value` mutation, and no field re-assignment. Everything else was left alone deliberately: - **~34 custom getters** (fallback defaults like `_x == -1 ? Default : _x`, self-healing refs) — no setter hook can express these. - **~35 pre-assignment logic** (durability Unscale/Scale sandwiches, old-state captures like PotionKeg's pile weight). - **virtual/override members, name-mismatched backing fields (`m_`), exotic semantics** (guards' `Focus` does work on *equal* assignment; `ChampionSpawn.Active` never assigns its field). Five sites the classifier refused were converted by hand where the hooks fit cleanly: `ReceiverCrystal.Sender`, `PlayerVendor.House`, `PlayerBarkeeper.House` (old-value unsubscribe via `oldValue`), `BaseSuit.AccessLevel` (its existing virtual `OnAccessLevelChanged` already had the exact callback shape), and `DyeTub.DyedHue` (a true veto: `AllowDyedHueChange(ref int value) => _redyable`). ## Verification - Build: **0 errors, 0 warnings**. - **Schema regeneration produces zero Migrations changes** — the conversion is wire- and schema-neutral by construction (same orders, types, and property names), and CI's schema diff check enforces it. - **835 + 708 tests green.** ## Behavioral notes (all strict improvements, called out for review) - Generated setters skip everything when the incoming value equals the current one; a few converted setters previously re-ran side effects on equal assignment (redundant `Update()`-style refreshes). - Generated setters always `MarkDirty()` on change; several converted setters never did (e.g. `DyeTub.DyedHue`, `MorphItem` ranges) — their changes only persisted if something else dirtied the entity. Those latent persistence bugs are fixed by construction.
2026-08-22 18:20:39 -07:00 · 2026-08-22 18:20:39 -07:00 · b042edcf0b
commit b042edcf0b
parent 73f9688083
73 changed files with 893 additions and 1340 deletions
--- a/Projects/UOContent/Mobiles/Animals/Misc/Sheep.cs
+++ b/Projects/UOContent/Mobiles/Animals/Misc/Sheep.cs
@ -43,18 +43,14 @@ namespace Server.Mobiles

        public override string CorpseName => "a sheep corpse";

+        [SerializableField(0, fieldChanged: nameof(OnNextWoolTimeChanged))]
        [DeltaDateTime]
-        [SerializableProperty(0)]
-        [CommandProperty(AccessLevel.GameMaster)]
-        public DateTime NextWoolTime
+        [SerializedCommandProperty(AccessLevel.GameMaster)]
+        private DateTime _nextWoolTime;
+
+        private void OnNextWoolTimeChanged(DateTime oldValue, DateTime newValue)
        {
-            get => _nextWoolTime;
-            set
-            {
-                _nextWoolTime = value;
-                SheepBody();
-                this.MarkDirty();
-            }
+            SheepBody();
        }

        [MethodImpl(MethodImplOptions.AggressiveInlining)]
--- a/Projects/UOContent/Mobiles/Animals/Mounts/Ethereals.cs
+++ b/Projects/UOContent/Mobiles/Animals/Mounts/Ethereals.cs
@ -40,43 +40,27 @@ namespace Server.Mobiles

        public override double DefaultWeight => 1.0;

-        [SerializableProperty(2)]
-        [CommandProperty(AccessLevel.GameMaster)]
-        public int MountedID
-        {
-            get => _mountedID;
-            set
-            {
-                if (_mountedID != value)
-                {
-                    _mountedID = value;
+        [SerializableField(2, fieldChanged: nameof(OnMountedIDChanged))]
+        [SerializedCommandProperty(AccessLevel.GameMaster)]
+        private int _mountedID;

-                    if (_rider != null)
-                    {
-                        ItemID = value;
-                    }
-                    this.MarkDirty();
-                }
+        private void OnMountedIDChanged(int oldValue, int newValue)
+        {
+            if (_rider != null)
+            {
+                ItemID = newValue;
            }
        }

-        [SerializableProperty(3)]
-        [CommandProperty(AccessLevel.GameMaster)]
-        public int RegularID
-        {
-            get => _regularID;
-            set
-            {
-                if (_regularID != value)
-                {
-                    _regularID = value;
+        [SerializableField(3, fieldChanged: nameof(OnRegularIDChanged))]
+        [SerializedCommandProperty(AccessLevel.GameMaster)]
+        private int _regularID;

-                    if (_rider == null)
-                    {
-                        ItemID = value;
-                    }
-                    this.MarkDirty();
-                }
+        private void OnRegularIDChanged(int oldValue, int newValue)
+        {
+            if (_rider == null)
+            {
+                ItemID = newValue;
            }
        }

@ -127,17 +111,15 @@ namespace Server.Mobiles

        private bool ShouldSerializeRider() => _rider != null;

-        [CommandProperty(AccessLevel.GameMaster)]
-        [SerializableProperty(5)]
+        [SerializableField(5, allowFieldChange: nameof(AllowStepsChange))]
+        [SerializedCommandProperty(AccessLevel.GameMaster)]
        [SaveFlag(nameof(ShouldSerializeSteps))]
-        public int Steps
+        private int _steps;
+
+        private bool AllowStepsChange(ref int value)
        {
-            get => _steps;
-            set
-            {
-                _steps = Math.Clamp(value, 0, StepsMax);
-                this.MarkDirty();
-            }
+            value = Math.Clamp(value, 0, StepsMax);
+            return true;
        }

        private bool ShouldSerializeSteps() => _steps != StepsMax;
--- a/Projects/UOContent/Mobiles/Animals/Mounts/SwampDragon.cs
+++ b/Projects/UOContent/Mobiles/Animals/Mounts/SwampDragon.cs
@ -62,48 +62,37 @@ namespace Server.Mobiles
        [SerializableField(3)]
        private int _bardingHP;

-        [CommandProperty(AccessLevel.GameMaster)]
-        [SerializableProperty(2)]
-        public bool HasBarding
-        {
-            get => _hasBarding;
-            set
-            {
-                _hasBarding = value;
+        [SerializableField(2, fieldChanged: nameof(OnHasBardingChanged))]
+        [SerializedCommandProperty(AccessLevel.GameMaster)]
+        [InvalidateProperties]
+        private bool _hasBarding;

-                if (_hasBarding)
-                {
-                    Hue = CraftResources.GetHue(_bardingResource);
-                    Body = 0x31F;
-                    ItemID = 0x3EBE;
-                }
-                else
-                {
-                    Hue = 0x851;
-                    Body = 0x31A;
-                    ItemID = 0x3EBD;
-                }
-                InvalidateProperties();
-                this.MarkDirty();
+        private void OnHasBardingChanged(bool oldValue, bool newValue)
+        {
+            if (_hasBarding)
+            {
+                Hue = CraftResources.GetHue(_bardingResource);
+                Body = 0x31F;
+                ItemID = 0x3EBE;
+            }
+            else
+            {
+                Hue = 0x851;
+                Body = 0x31A;
+                ItemID = 0x3EBD;
            }
        }

-        [CommandProperty(AccessLevel.GameMaster)]
-        [SerializableProperty(4)]
-        public CraftResource BardingResource
+        [SerializableField(4, fieldChanged: nameof(OnBardingResourceChanged))]
+        [SerializedCommandProperty(AccessLevel.GameMaster)]
+        [InvalidateProperties]
+        private CraftResource _bardingResource;
+
+        private void OnBardingResourceChanged(CraftResource oldValue, CraftResource newValue)
        {
-            get => _bardingResource;
-            set
+            if (_hasBarding)
            {
-                _bardingResource = value;
-
-                if (_hasBarding)
-                {
-                    Hue = CraftResources.GetHue(value);
-                }
-
-                InvalidateProperties();
-                this.MarkDirty();
+                Hue = CraftResources.GetHue(newValue);
            }
        }

--- a/Projects/UOContent/Mobiles/Hireables/BaseHire.cs
+++ b/Projects/UOContent/Mobiles/Hireables/BaseHire.cs
@ -23,19 +23,14 @@ public partial class BaseHire : BaseCreature

    public int GoldOnDeath { get; set; }

-    [SerializableProperty(1)]
-    [CommandProperty(AccessLevel.GameMaster)]
-    public bool IsHired
-    {
-        get => _isHired;
-        set
-        {
-            _isHired = value;
+    [SerializableField(1, fieldChanged: nameof(OnIsHiredChanged))]
+    [SerializedCommandProperty(AccessLevel.GameMaster)]
+    [InvalidateProperties]
+    private bool _isHired;

-            Delta(MobileDelta.Noto);
-            InvalidateProperties();
-            this.MarkDirty();
-        }
+    private void OnIsHiredChanged(bool oldValue, bool newValue)
+    {
+        Delta(MobileDelta.Noto);
    }

    public BaseHire(AIType AI) : base(AI, FightMode.Aggressor)
--- a/Projects/UOContent/Mobiles/Vendors/Barkeeper/PlayerBarkeeper.cs
+++ b/Projects/UOContent/Mobiles/Vendors/Barkeeper/PlayerBarkeeper.cs
@ -148,18 +148,13 @@ public partial class PlayerBarkeeper : BaseVendor
        LoadSBInfo();
    }

-    [SerializableProperty(0)]
-    public BaseHouse House
-    {
-        get => _house;
-        set
-        {
-            _house?.PlayerBarkeepers.Remove(this);
-            value?.PlayerBarkeepers.Add(this);
+    [SerializableField(0, fieldChanged: nameof(OnHouseChanged))]
+    private BaseHouse _house;

-            _house = value;
-            this.MarkDirty();
-        }
+    private void OnHouseChanged(BaseHouse oldValue, BaseHouse newValue)
+    {
+        oldValue?.PlayerBarkeepers.Remove(this);
+        newValue?.PlayerBarkeepers.Add(this);
    }

    public override bool IsActiveBuyer => false;
--- a/Projects/UOContent/Mobiles/Vendors/PlayerVendor.cs
+++ b/Projects/UOContent/Mobiles/Vendors/PlayerVendor.cs
@ -94,18 +94,13 @@ public partial class PlayerVendor : Mobile

    public PlayerVendorPlaceholder Placeholder { get; set; }

-    [SerializableProperty(2)]
-    public BaseHouse House
-    {
-        get => _house;
-        set
-        {
-            _house?.PlayerVendors.Remove(this);
-            value?.PlayerVendors.Add(this);
+    [SerializableField(2, fieldChanged: nameof(OnHouseChanged))]
+    private BaseHouse _house;

-            _house = value;
-            this.MarkDirty();
-        }
+    private void OnHouseChanged(BaseHouse oldValue, BaseHouse newValue)
+    {
+        oldValue?.PlayerVendors.Remove(this);
+        newValue?.PlayerVendors.Add(this);
    }

    public int ChargePerDay
--- a/Projects/UOContent/Mobiles/Vendors/VendorItem.cs
+++ b/Projects/UOContent/Mobiles/Vendors/VendorItem.cs
@ -32,18 +32,20 @@ public partial class VendorItem
    public string FormattedPrice =>
        Core.ML ? Price.ToString("N0", CultureInfo.GetCultureInfo("en-US")) : Price.ToString();

-    [SerializableProperty(2)]
-    public string Description
-    {
-        get => _description;
-        set
-        {
-            _description = value ?? "";
+    [SerializableField(2, fieldChanged: nameof(OnDescriptionChanged), allowFieldChange: nameof(AllowDescriptionChange))]
+    private string _description;

-            if (Valid)
-            {
-                Item.InvalidateProperties();
-            }
+    private bool AllowDescriptionChange(ref string value)
+    {
+        value = value ?? "";
+        return true;
+    }
+
+    private void OnDescriptionChanged(string oldValue, string newValue)
+    {
+        if (Valid)
+        {
+            Item.InvalidateProperties();
        }
    }