ModernUO/Projects/UOContent/Items/Addons/FlourMillSouthAddon.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

174 lines
4.8 KiB
C#

using System;
using ModernUO.Serialization;
namespace Server.Items
{
[SerializationGenerator(0, false)]
public partial class FlourMillSouthAddon : BaseAddon, IFlourMill
{
private static readonly int[][] m_StageTable =
{
new[] { 0x192C, 0x192D, 0x1931 },
new[] { 0x192E, 0x192F, 0x1932 },
new[] { 0x1930, 0x1930, 0x1934 }
};
[Constructible]
public FlourMillSouthAddon()
{
AddComponent(new AddonComponent(0x192C), 0, -1, 0);
AddComponent(new AddonComponent(0x192E), 0, 0, 0);
AddComponent(new AddonComponent(0x1930), 0, 1, 0);
}
public override BaseAddonDeed Deed => new FlourMillSouthDeed();
[CommandProperty(AccessLevel.GameMaster)]
public bool HasFlour => _curFlour > 0;
[CommandProperty(AccessLevel.GameMaster)]
public bool IsFull => _curFlour >= MaxFlour;
[CommandProperty(AccessLevel.GameMaster)]
public bool IsWorking { get; private set; }
[CommandProperty(AccessLevel.GameMaster)]
public int MaxFlour => 2;
[SerializableField(0, fieldChanged: nameof(OnCurFlourChanged), allowFieldChange: nameof(AllowCurFlourChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private int _curFlour;
private bool AllowCurFlourChange(ref int value)
{
value = Math.Max(0, Math.Min(value, MaxFlour));
return true;
}
private void OnCurFlourChanged(int oldValue, int newValue)
{
UpdateStage();
}
public void StartWorking(Mobile from)
{
if (IsWorking)
{
return;
}
Timer.StartTimer(TimeSpan.FromSeconds(5.0), () => FinishWorking_Callback(from));
IsWorking = true;
UpdateStage();
}
private void FinishWorking_Callback(Mobile from)
{
IsWorking = false;
if (from?.Deleted == false && !Deleted && IsFull)
{
var flour = new SackFlour();
flour.ItemID = Utility.RandomBool() ? 4153 : 4165;
if (from.PlaceInBackpack(flour))
{
_curFlour = 0;
}
else
{
flour.Delete();
from.SendLocalizedMessage(500998); // There is not enough room in your backpack! You stop grinding.
}
}
UpdateStage();
}
private int[] FindItemTable(int itemID)
{
for (var i = 0; i < m_StageTable.Length; ++i)
{
var itemTable = m_StageTable[i];
for (var j = 0; j < itemTable.Length; ++j)
{
if (itemTable[j] == itemID)
{
return itemTable;
}
}
}
return null;
}
public void UpdateStage()
{
if (IsWorking)
{
UpdateStage(FlourMillStage.Working);
}
else if (HasFlour)
{
UpdateStage(FlourMillStage.Filled);
}
else
{
UpdateStage(FlourMillStage.Empty);
}
}
public void UpdateStage(FlourMillStage stage)
{
var components = Components;
for (var i = 0; i < components.Count; ++i)
{
var component = components[i];
var itemTable = FindItemTable(component.ItemID);
if (itemTable != null)
{
component.ItemID = itemTable[(int)stage];
}
}
}
public override void OnComponentUsed(AddonComponent c, Mobile from)
{
if (!from.InRange(GetWorldLocation(), 4) || !from.InLOS(this))
{
from.LocalOverheadMessage(MessageType.Regular, 0x3B2, 1019045); // I can't reach that.
}
else if (!IsFull)
{
from.SendLocalizedMessage(500997); // You need more wheat to make a sack of flour.
}
else
{
StartWorking(from);
}
}
[AfterDeserialization]
private void AfterDeserialization()
{
UpdateStage();
}
}
[SerializationGenerator(0, false)]
public partial class FlourMillSouthDeed : BaseAddonDeed
{
[Constructible]
public FlourMillSouthDeed()
{
}
public override BaseAddon Addon => new FlourMillSouthAddon();
public override int LabelNumber => 1044348; // flour mill (south)
}
}