ModernUO/Projects/UOContent/Items/Containers/MarkContainer.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

234 lines
5.9 KiB
C#

using System;
using ModernUO.Serialization;
namespace Server.Items;
[SerializationGenerator(1, false)]
public partial class MarkContainer : LockableContainer
{
[SerializableField(1, getter: "private", setter: "private")]
[DeserializeTimer(nameof(DeserializeRelockTimer))]
private InternalTimer _relockTimer;
private void DeserializeRelockTimer(TimeSpan delay)
{
if (!Locked && _autoLock)
{
_relockTimer = new InternalTimer(this, delay);
}
}
private void MigrateFrom(V0Content content)
{
_autoLock = content.AutoLock;
_targetMap = content.TargetMap;
_target = content.Target;
_description = content.Description;
if (content.RelockTimerDelay != TimeSpan.MinValue)
{
DeserializeRelockTimer(content.RelockTimerDelay);
}
}
[SerializableField(2)]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private Map _targetMap;
[SerializableField(3)]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private Point3D _target;
[SerializableField(4)]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private string _description;
[Constructible]
public MarkContainer(bool bone = false, bool locked = false) : base(bone ? 0xECA : 0xE79)
{
Movable = false;
if (bone)
{
Hue = 1102;
}
_autoLock = locked;
Locked = locked;
if (locked)
{
LockLevel = ILockpickable.MagicLock;
}
}
[SerializableField(0, fieldChanged: nameof(OnAutoLockChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private bool _autoLock;
private void OnAutoLockChanged(bool oldValue, bool newValue)
{
if (!_autoLock)
{
StopTimer();
}
else if (!Locked)
{
_relockTimer ??= new InternalTimer(this);
}
}
[CommandProperty(AccessLevel.GameMaster)]
public bool Bone
{
get => ItemID == 0xECA;
set
{
ItemID = value ? 0xECA : 0xE79;
Hue = value ? 1102 : 0;
}
}
public override bool IsDecoContainer => false;
[CommandProperty(AccessLevel.GameMaster)]
public override bool Locked
{
get => base.Locked;
set
{
base.Locked = value;
if (_autoLock)
{
StopTimer();
if (!Locked)
{
_relockTimer = new InternalTimer(this);
}
}
}
}
[CommandProperty(AccessLevel.GameMaster)]
public DateTime NextRelock => _relockTimer.Next;
public static void Configure()
{
CommandSystem.Register("SecretLocGen", AccessLevel.Developer, SecretLocGen_OnCommand);
}
[Usage("SecretLocGen")]
[Description("Generates mark containers to Malas secret locations.")]
public static void SecretLocGen_OnCommand(CommandEventArgs e)
{
CreateMalasPassage(951, 546, -70, 1006, 994, -70, false, false);
CreateMalasPassage(914, 192, -79, 1019, 1062, -70, false, false);
CreateMalasPassage(1614, 143, -90, 1214, 1313, -90, false, false);
CreateMalasPassage(2176, 324, -90, 1554, 172, -90, false, false);
CreateMalasPassage(864, 812, -90, 1061, 1161, -70, false, false);
CreateMalasPassage(1051, 1434, -85, 1076, 1244, -70, false, true);
CreateMalasPassage(1326, 523, -87, 1201, 1554, -70, false, false);
CreateMalasPassage(424, 189, -1, 2333, 1501, -90, true, false);
CreateMalasPassage(1313, 1115, -85, 1183, 462, -45, false, false);
e.Mobile.SendMessage("Secret mark containers have been created.");
}
private static bool FindMarkContainer(Point3D p, Map map)
{
foreach (var item in map.GetItemsAt<MarkContainer>(p))
{
if (item.Z == p.Z)
{
return true;
}
}
return false;
}
private static void CreateMalasPassage(
int x, int y, int z, int xTarget, int yTarget, int zTarget, bool bone, bool locked
)
{
var location = new Point3D(x, y, z);
if (FindMarkContainer(location, Map.Malas))
{
return;
}
var cont = new MarkContainer(bone, locked)
{
TargetMap = Map.Malas,
Target = new Point3D(xTarget, yTarget, zTarget),
Description = "strange location"
};
cont.MoveToWorld(location, Map.Malas);
}
public void StopTimer()
{
_relockTimer?.Stop();
_relockTimer = null;
}
public void Mark(RecallRune rune)
{
if (_targetMap != null)
{
rune.Marked = true;
rune.TargetMap = _targetMap;
rune.Target = _target;
rune.Description = _description;
rune.House = null;
}
}
public override bool OnDragDrop(Mobile from, Item dropped)
{
if (dropped is RecallRune rune && base.OnDragDrop(from, dropped))
{
Mark(rune);
return true;
}
return false;
}
public override bool OnDragDropInto(Mobile from, Item dropped, Point3D p)
{
if (dropped is RecallRune rune && base.OnDragDropInto(from, dropped, p))
{
Mark(rune);
return true;
}
return false;
}
private class InternalTimer : Timer
{
public InternalTimer(MarkContainer container) : this(container, TimeSpan.FromMinutes(5.0))
{
}
public InternalTimer(MarkContainer container, TimeSpan delay) : base(delay)
{
Container = container;
Start();
}
public MarkContainer Container { get; }
protected override void OnTick()
{
Container.Locked = true;
Container.LockLevel = ILockpickable.MagicLock;
}
}
}