ModernUO/Projects/UOContent/Items/Clothing/Shoes.cs
Kamron Batman b042edcf0b
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

227 lines
6 KiB
C#

using System.Runtime.CompilerServices;
using ModernUO.Serialization;
namespace Server.Items
{
[SerializationGenerator(0, false)]
public abstract partial class BaseShoes : BaseClothing
{
public BaseShoes(int itemID, int hue = 0) : base(itemID, Layer.Shoes, hue)
{
}
public override bool Scissor(Mobile from, Scissors scissors)
{
if (DefaultResource == CraftResource.None)
{
return base.Scissor(from, scissors);
}
from.SendLocalizedMessage(502440); // Scissors can not be used on that to produce anything.
return false;
}
}
[Flippable(0x2307, 0x2308)]
[SerializationGenerator(0, false)]
public partial class FurBoots : BaseShoes
{
[Constructible]
public FurBoots(int hue = 0) : base(0x2307, hue)
{
}
public override double DefaultWeight => 3.0;
}
[Flippable(0x170b, 0x170c)]
[SerializationGenerator(0, false)]
public partial class Boots : BaseShoes
{
[Constructible]
public Boots(int hue = 0) : base(0x170B, hue)
{
}
public override double DefaultWeight => 3.0;
public override CraftResource DefaultResource => CraftResource.RegularLeather;
}
[Flippable]
[SerializationGenerator(2, false)]
public partial class ThighBoots : BaseShoes, IArcaneEquip
{
[EncodedInt]
[InvalidateProperties]
[SerializableField(0, fieldChanged: nameof(OnCurArcaneChargesChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private int _curArcaneCharges;
[MethodImpl(MethodImplOptions.AggressiveInlining)]
private void OnCurArcaneChargesChanged(int oldValue, int newValue) => Update();
[Constructible]
public ThighBoots(int hue = 0) : base(0x1711, hue)
{
}
public override double DefaultWeight => 4.0;
public override CraftResource DefaultResource => CraftResource.RegularLeather;
[SerializableField(1, fieldChanged: nameof(OnMaxArcaneChargesChanged))]
[EncodedInt]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _maxArcaneCharges;
private void OnMaxArcaneChargesChanged(int oldValue, int newValue)
{
Update();
}
[CommandProperty(AccessLevel.GameMaster)]
public bool IsArcane => _maxArcaneCharges > 0 && _curArcaneCharges >= 0;
private void Deserialize(IGenericReader reader, int version)
{
if (reader.ReadBool())
{
_curArcaneCharges = reader.ReadInt();
_maxArcaneCharges = reader.ReadInt();
}
}
public override void OnSingleClick(Mobile from)
{
base.OnSingleClick(from);
if (IsArcane)
{
LabelTo(from, 1061837, $"{_curArcaneCharges}\t{_maxArcaneCharges}");
}
}
public void Update()
{
if (IsArcane)
{
ItemID = 0x26AF;
}
else if (ItemID == 0x26AF)
{
ItemID = 0x1711;
}
if (IsArcane && CurArcaneCharges == 0)
{
Hue = 0;
}
}
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
if (IsArcane)
{
list.Add(1061837, $"{_curArcaneCharges}\t{_maxArcaneCharges}"); // arcane charges: ~1_val~ / ~2_val~
}
}
public void Flip()
{
ItemID = ItemID switch
{
0x1711 => 0x1712,
0x1712 => 0x1711,
_ => ItemID
};
}
}
[Flippable(0x170f, 0x1710)]
[SerializationGenerator(0, false)]
public partial class Shoes : BaseShoes
{
[Constructible]
public Shoes(int hue = 0) : base(0x170F, hue)
{
}
public override double DefaultWeight => 2.0;
public override CraftResource DefaultResource => CraftResource.RegularLeather;
}
[Flippable(0x170d, 0x170e)]
[SerializationGenerator(0, false)]
public partial class Sandals : BaseShoes
{
[Constructible]
public Sandals(int hue = 0) : base(0x170D, hue)
{
}
public override double DefaultWeight => 1.0;
public override CraftResource DefaultResource => CraftResource.RegularLeather;
public override bool Dye(Mobile from, DyeTub sender) => false;
}
[Flippable(0x2797, 0x27E2)]
[SerializationGenerator(0, false)]
public partial class NinjaTabi : BaseShoes
{
[Constructible]
public NinjaTabi(int hue = 0) : base(0x2797, hue)
{
}
public override double DefaultWeight => 2.0;
}
[Flippable(0x2796, 0x27E1)]
[SerializationGenerator(0, false)]
public partial class SamuraiTabi : BaseShoes
{
[Constructible]
public SamuraiTabi(int hue = 0) : base(0x2796, hue)
{
}
public override double DefaultWeight => 2.0;
}
[Flippable(0x2796, 0x27E1)]
[SerializationGenerator(0, false)]
public partial class Waraji : BaseShoes
{
[Constructible]
public Waraji(int hue = 0) : base(0x2796, hue)
{
}
public override double DefaultWeight => 2.0;
}
[Flippable(0x2FC4, 0x317A)]
[SerializationGenerator(0)]
public partial class ElvenBoots : BaseShoes
{
[Constructible]
public ElvenBoots(int hue = 0) : base(0x2FC4, hue)
{
}
public override double DefaultWeight => 2.0;
public override CraftResource DefaultResource => CraftResource.RegularLeather;
public override int RequiredRaces => Race.AllowElvesOnly;
public override bool Dye(Mobile from, DyeTub sender) => false;
}
}