ModernUO/Projects/UOContent/Engines/ConPVP/Trophy.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

137 lines
3.2 KiB
C#

using System;
using ModernUO.Serialization;
namespace Server.Items;
public enum TrophyRank
{
Bronze,
Silver,
Gold
}
public static class TrophyRankExtensions
{
/// <summary>
/// Returns a static lowercase string for the given <see cref="TrophyRank"/> value.
/// Avoids the two-allocation <c>rank.ToString().ToLower()</c> pattern at interpolation sites.
/// </summary>
public static string LowerName(this TrophyRank rank) =>
rank switch
{
TrophyRank.Bronze => "bronze",
TrophyRank.Silver => "silver",
TrophyRank.Gold => "gold",
_ => rank.ToString().ToLowerInvariant()
};
}
[Flippable(5020, 4647)]
[SerializationGenerator(2, false)]
public partial class Trophy : Item
{
[SerializableField(0)]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private string _title;
[SerializableField(2)]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private Mobile _owner;
[SerializableField(3, setter: "private")]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private DateTime _date;
public override string DefaultName => $"{GetRankName(_rank)} trophy";
private static string GetRankName(TrophyRank rank) =>
rank switch
{
TrophyRank.Silver => "silver",
TrophyRank.Gold => "gold",
_ => "bronze"
};
[Constructible]
public Trophy(string title, TrophyRank rank) : base(5020)
{
_title = title;
_rank = rank;
_date = Core.Now;
LootType = LootType.Blessed;
UpdateStyle();
}
[SerializableField(1, fieldChanged: nameof(OnRankChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private TrophyRank _rank;
private void OnRankChanged(TrophyRank oldValue, TrophyRank newValue)
{
UpdateStyle();
}
private void Deserialize(IGenericReader reader, int version)
{
_title = reader.ReadString();
_rank = (TrophyRank)reader.ReadInt();
_owner = reader.ReadEntity<Mobile>();
_date = reader.ReadDateTime();
}
public override void OnAdded(IEntity parent)
{
base.OnAdded(parent);
Owner ??= RootParent as Mobile;
}
public override void GetProperties(IPropertyList list)
{
if (Owner != null)
{
list.Add($"{Title} -- {Owner.RawName}");
}
else if (Title != null)
{
list.Add(Title);
}
if (Date != DateTime.MinValue)
{
list.Add(Date.ToString("d"));
}
}
public override void OnSingleClick(Mobile from)
{
base.OnSingleClick(from);
if (Owner != null)
{
LabelTo(from, $"{Title} -- {Owner.RawName}");
}
else if (Title != null)
{
LabelTo(from, Title);
}
if (Date != DateTime.MinValue)
{
LabelTo(from, Date.ToString("d"));
}
}
public void UpdateStyle()
{
Hue = _rank switch
{
TrophyRank.Gold => 2213,
TrophyRank.Silver => 0,
_ => 2206, // bronze
};
}
}