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

155 lines
4.2 KiB
C#

using System;
using ModernUO.Serialization;
using Server.Engines.Craft;
using Server.Multis;
using Server.Spells;
using Server.Targeting;
namespace Server.Items;
[Flippable(0x14F0, 0x14EF)]
[SerializationGenerator(2)]
public abstract partial class BaseAddonContainerDeed : Item, ICraftable
{
public BaseAddonContainerDeed() : base(0x14F0)
{
if (!Core.AOS)
{
LootType = LootType.Newbied;
}
}
public override double DefaultWeight => 1.0;
public abstract BaseAddonContainer Addon { get; }
[SerializableField(0, fieldChanged: nameof(OnResourceChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private CraftResource _resource;
private void OnResourceChanged(CraftResource oldValue, CraftResource newValue)
{
Hue = CraftResources.GetHue(_resource);
}
public virtual int OnCraft(
int quality, bool makersMark, Mobile from, CraftSystem craftSystem, Type typeRes,
BaseTool tool, CraftItem craftItem, int resHue
)
{
var resourceType = typeRes ?? craftItem.Resources[0].ItemType;
Resource = CraftResources.GetFromType(resourceType);
var context = craftSystem.GetContext(from);
if (context?.DoNotColor == true)
{
Hue = 0;
}
return quality;
}
private void Deserialize(IGenericReader reader, int version)
{
_resource = (CraftResource)reader.ReadInt();
}
public override void OnDoubleClick(Mobile from)
{
if (IsChildOf(from.Backpack))
{
from.Target = new InternalTarget(this);
}
else
{
from.SendLocalizedMessage(1062334); // This item must be in your backpack to be used.
}
}
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
if (!CraftResources.IsStandard(_resource))
{
list.Add(CraftResources.GetLocalizationNumber(_resource));
}
}
private class InternalTarget : Target
{
private readonly BaseAddonContainerDeed m_Deed;
public InternalTarget(BaseAddonContainerDeed deed) : base(-1, true, TargetFlags.None)
{
m_Deed = deed;
CheckLOS = false;
}
protected override void OnTarget(Mobile from, object targeted)
{
var p = targeted as IPoint3D;
var map = from.Map;
if (p == null || map == null || m_Deed.Deleted)
{
return;
}
if (!m_Deed.IsChildOf(from.Backpack))
{
from.SendLocalizedMessage(1042001); // That must be in your pack for you to use it.
return;
}
var addon = m_Deed.Addon;
addon.Resource = m_Deed.Resource;
SpellHelper.GetSurfaceTop(ref p);
BaseHouse house = null;
var res = addon.CouldFit(p, map, from, ref house);
if (res == AddonFitResult.Valid)
{
addon.MoveToWorld(new Point3D(p), map);
}
else if (res == AddonFitResult.Blocked)
{
from.SendLocalizedMessage(500269); // You cannot build that there.
}
else if (res == AddonFitResult.NotInHouse)
{
from.SendLocalizedMessage(500274); // You can only place this in a house that you own!
}
else if (res == AddonFitResult.DoorsNotClosed)
{
from.SendMessage("You must close all house doors before placing this.");
}
else if (res == AddonFitResult.DoorTooClose)
{
from.SendLocalizedMessage(500271); // You cannot build near the door.
}
else if (res == AddonFitResult.NoWall)
{
from.SendLocalizedMessage(500268); // This object needs to be mounted on something.
}
if (res == AddonFitResult.Valid)
{
m_Deed.Delete();
house.Addons.Add(addon);
house.AddSecure(from, addon);
}
else
{
addon.Delete();
}
}
}
}