warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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

Browse source 
## 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.
This commit is contained in:
Kamron Batman 2026-08-22 18:20:39 -07:00 • committed by GitHub
parent 73f9688083
commit b042edcf0b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
73 changed files with 893 additions and 1340 deletions
Download patch file Download diff file Expand all files Collapse all files

36
Projects/UOContent/Items/Special/8th Anniversary Items/FountainOfLife.cs
View file

@ -54,17 +54,15 @@ public partial class FountainOfLife : BaseAddonContainer
public override int DefaultDropSound => 66;
public override int DefaultMaxItems => 125;
[SerializableProperty(0)]
[CommandProperty(AccessLevel.GameMaster)]
public int Charges
[SerializableField(0, allowFieldChange: nameof(AllowChargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _charges;
private bool AllowChargesChange(ref int value)
{
get => _charges;
set
{
_charges = Math.Min(value, MaxCharges);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Min(value, MaxCharges);
return true;
}
public override bool OnDragLift(Mobile from) => false;
@ -183,16 +181,14 @@ public partial class FountainOfLifeDeed : BaseAddonContainerDeed
public override int LabelNumber => 1075197; // Fountain of Life
public override BaseAddonContainer Addon => new FountainOfLife(_charges);
[SerializableProperty(0)]
[CommandProperty(AccessLevel.GameMaster)]
public int Charges
[SerializableField(0, allowFieldChange: nameof(AllowChargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _charges;
private bool AllowChargesChange(ref int value)
{
get => _charges;
set
{
_charges = Math.Min(value, FountainOfLife.MaxCharges);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Min(value, FountainOfLife.MaxCharges);
return true;
}
}

12
Projects/UOContent/Items/Special/Heritage Items/FruitTrees.cs
View file

@ -14,12 +14,14 @@ public abstract partial class BaseFruitTreeAddon : BaseAddon
public abstract override BaseAddonDeed Deed { get; }
public abstract Item Fruit { get; }
[SerializableProperty(0)]
[CommandProperty(AccessLevel.GameMaster)]
public int Fruits
[SerializableField(0, allowFieldChange: nameof(AllowFruitsChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private int _fruits;
private bool AllowFruitsChange(ref int value)
{
get => _fruits;
set => _fruits = Math.Max(value, 0);
value = Math.Max(value, 0);
return true;
}
public override void OnComponentUsed(AddonComponent c, Mobile from)

56
Projects/UOContent/Items/Special/House Raffle/HouseRaffleStone.cs
View file

@ -146,34 +146,24 @@ public partial class HouseRaffleStone : Item
}
}
[SerializableProperty(3)]
[CommandProperty(AccessLevel.GameMaster, AccessLevel.Seer)]
public Rectangle2D PlotBounds
{
get => _plotBounds;
set
{
_plotBounds = value;
[SerializableField(3, fieldChanged: nameof(OnPlotBoundsChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Seer)]
[InvalidateProperties]
private Rectangle2D _plotBounds;
InvalidateRegion();
InvalidateProperties();
this.MarkDirty();
}
private void OnPlotBoundsChanged(Rectangle2D oldValue, Rectangle2D newValue)
{
InvalidateRegion();
}
[SerializableProperty(4)]
[CommandProperty(AccessLevel.GameMaster, AccessLevel.Seer)]
public Map PlotFacet
{
get => _plotFacet;
set
{
_plotFacet = value;
[SerializableField(4, fieldChanged: nameof(OnPlotFacetChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Seer)]
[InvalidateProperties]
private Map _plotFacet;
InvalidateRegion();
InvalidateProperties();
this.MarkDirty();
}
private void OnPlotFacetChanged(Map oldValue, Map newValue)
{
InvalidateRegion();
}
[CommandProperty(AccessLevel.GameMaster)]
@ -190,17 +180,15 @@ public partial class HouseRaffleStone : Item
}
}
[SerializableProperty(6)]
[CommandProperty(AccessLevel.GameMaster, AccessLevel.Seer)]
public int TicketPrice
[SerializableField(6, allowFieldChange: nameof(AllowTicketPriceChange))]
[SerializedCommandProperty(AccessLevel.GameMaster, AccessLevel.Seer)]
[InvalidateProperties]
private int _ticketPrice;
private bool AllowTicketPriceChange(ref int value)
{
get => _ticketPrice;
set
{
_ticketPrice = Math.Max(0, value);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Max(0, value);
return true;
}
public override string DefaultName => "a house raffle stone";

22
Projects/UOContent/Items/Special/MonsterStatuette.cs
View file

@ -162,21 +162,15 @@ public partial class MonsterStatuette : Item, IRewardItem, IGumpToggleItem
_ => fallback
};
[SerializableProperty(0)]
[CommandProperty(AccessLevel.GameMaster)]
public MonsterStatuetteType Type
[SerializableField(0, fieldChanged: nameof(OnTypeChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private MonsterStatuetteType _type;
private void OnTypeChanged(MonsterStatuetteType oldValue, MonsterStatuetteType newValue)
{
get => _type;
set
{
_type = value;
ItemID = MonsterStatuetteInfo.GetInfo(_type).ItemID;
Hue = GetStatuetteHue(_type, Hue);
InvalidateProperties();
this.MarkDirty();
}
ItemID = MonsterStatuetteInfo.GetInfo(_type).ItemID;
Hue = GetStatuetteHue(_type, Hue);
}
public override int LabelNumber => MonsterStatuetteInfo.GetInfo(_type).LabelNumber;

65
Projects/UOContent/Items/Special/Solen Items/BagOfSending.cs
View file

@ -36,50 +36,41 @@ public partial class BagOfSending : Item, TranslocationItem
public override int LabelNumber => 1054104; // a bag of sending
[SerializableProperty(0)]
[CommandProperty(AccessLevel.GameMaster)]
public BagOfSendingHue BagOfSendingHue
{
get => _bagOfSendingHue;
set
{
_bagOfSendingHue = value;
[SerializableField(0, fieldChanged: nameof(OnBagOfSendingHueChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private BagOfSendingHue _bagOfSendingHue;
Hue = value switch
{
BagOfSendingHue.Yellow => 0x8A5,
BagOfSendingHue.Blue => 0x8AD,
BagOfSendingHue.Red => 0x89B,
_ => Hue
};
this.MarkDirty();
}
private void OnBagOfSendingHueChanged(BagOfSendingHue oldValue, BagOfSendingHue newValue)
{
Hue = newValue switch
{
BagOfSendingHue.Yellow => 0x8A5,
BagOfSendingHue.Blue => 0x8AD,
BagOfSendingHue.Red => 0x89B,
_ => Hue
};
}
[SerializableProperty(1)]
[CommandProperty(AccessLevel.GameMaster)]
public int Charges
[SerializableField(1, allowFieldChange: nameof(AllowChargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _charges;
private bool AllowChargesChange(ref int value)
{
get => _charges;
set
{
_charges = Math.Clamp(value, 0, MaxCharges);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Clamp(value, 0, MaxCharges);
return true;
}
[SerializableProperty(2)]
[CommandProperty(AccessLevel.GameMaster)]
public int Recharges
[SerializableField(2, allowFieldChange: nameof(AllowRechargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _recharges;
private bool AllowRechargesChange(ref int value)
{
get => _recharges;
set
{
_recharges = Math.Clamp(value, 0, MaxRecharges);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Clamp(value, 0, MaxRecharges);
return true;
}
[CommandProperty(AccessLevel.GameMaster)]

36
Projects/UOContent/Items/Special/Solen Items/BallOfSummoning.cs
View file

@ -29,30 +29,26 @@ public partial class BallOfSummoning : Item, TranslocationItem
public override double DefaultWeight => 10.0;
[SerializableProperty(0)]
[CommandProperty(AccessLevel.GameMaster)]
public int Recharges
[SerializableField(0, allowFieldChange: nameof(AllowRechargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _recharges;
private bool AllowRechargesChange(ref int value)
{
get => _recharges;
set
{
_recharges = Math.Clamp(value, 0, MaxRecharges);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Clamp(value, 0, MaxRecharges);
return true;
}
[SerializableProperty(1)]
[CommandProperty(AccessLevel.GameMaster)]
public int Charges
[SerializableField(1, allowFieldChange: nameof(AllowChargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _charges;
private bool AllowChargesChange(ref int value)
{
get => _charges;
set
{
_charges = Math.Clamp(value, 0, MaxCharges);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Clamp(value, 0, MaxCharges);
return true;
}
[SerializableProperty(2)]

36
Projects/UOContent/Items/Special/Solen Items/BraceletOfBinding.cs
View file

@ -27,30 +27,26 @@ public partial class BraceletOfBinding : BaseBracelet, TranslocationItem
public override double DefaultWeight => 1.0;
[SerializableProperty(0)]
[CommandProperty(AccessLevel.GameMaster)]
public int Recharges
[SerializableField(0, allowFieldChange: nameof(AllowRechargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _recharges;
private bool AllowRechargesChange(ref int value)
{
get => _recharges;
set
{
_recharges = Math.Clamp(value, 0, MaxRecharges);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Clamp(value, 0, MaxRecharges);
return true;
}
[SerializableProperty(1)]
[CommandProperty(AccessLevel.GameMaster)]
public int Charges
[SerializableField(1, allowFieldChange: nameof(AllowChargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _charges;
private bool AllowChargesChange(ref int value)
{
get => _charges;
set
{
_charges = Math.Clamp(value, 0, MaxCharges);
InvalidateProperties();
this.MarkDirty();
}
value = Math.Clamp(value, 0, MaxCharges);
return true;
}
[SerializableProperty(3)]

20
Projects/UOContent/Items/Special/SoulStone.cs
View file

@ -83,20 +83,14 @@ public partial class SoulStone : Item, ISecurable
}
}
[SerializableProperty(6)]
[CommandProperty(AccessLevel.GameMaster)]
public double SkillValue
[SerializableField(6, fieldChanged: nameof(OnSkillValueChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private double _skillValue;
private void OnSkillValueChanged(double oldValue, double newValue)
{
get => _skillValue;
set
{
_skillValue = value;
ItemID = IsEmpty ? _inactiveItemID : _activeItemID;
InvalidateProperties();
this.MarkDirty();
}
ItemID = IsEmpty ? _inactiveItemID : _activeItemID;
}
[CommandProperty(AccessLevel.GameMaster)]