ModernUO/Projects/UOContent/Items/Skill Items/Magical/Misc/RecallRune.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

310 lines
8.3 KiB
C#

using ModernUO.Serialization;
using Server.Multis;
using Server.Prompts;
using Server.Regions;
namespace Server.Items;
[Flippable(0x1f14, 0x1f15, 0x1f16, 0x1f17)]
[SerializationGenerator(2, false)]
public partial class RecallRune : Item
{
[InvalidateProperties]
[SerializableField(1)]
[SerializedCommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
private string _description;
[SerializableField(3)]
[SerializedCommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
private Point3D _target;
[Constructible]
public RecallRune() : base(0x1F14)
{
CalculateHue();
}
public override double DefaultWeight => 1.0;
[SerializableProperty(0)]
[CommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
public BaseHouse House
{
get
{
if (_house?.Deleted == true)
{
House = null;
}
return _house;
}
set
{
_house = value;
CalculateHue();
InvalidateProperties();
}
}
[SerializableField(2, fieldChanged: nameof(OnMarkedChanged))]
[SerializedCommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
[InvalidateProperties]
private bool _marked;
private void OnMarkedChanged(bool oldValue, bool newValue)
{
CalculateHue();
}
[SerializableField(4, fieldChanged: nameof(OnTargetMapChanged))]
[SerializedCommandProperty(AccessLevel.Counselor, AccessLevel.GameMaster)]
[InvalidateProperties]
private Map _targetMap;
private void OnTargetMapChanged(Map oldValue, Map newValue)
{
CalculateHue();
}
private void Deserialize(IGenericReader reader, int version)
{
switch (version)
{
case 1:
{
_house = reader.ReadEntity<BaseHouse>();
goto case 0;
}
case 0:
{
_description = reader.ReadString();
_marked = reader.ReadBool();
Target = reader.ReadPoint3D();
_targetMap = reader.ReadMap();
CalculateHue();
break;
}
}
}
private void CalculateHue()
{
if (!_marked)
{
Hue = 0;
}
else if (_targetMap == Map.Trammel)
{
Hue = House != null ? 0x47F : 50;
}
else if (_targetMap == Map.Felucca)
{
Hue = House != null ? 0x66D : 0;
}
else if (_targetMap == Map.Ilshenar)
{
Hue = House != null ? 0x55F : 1102;
}
else if (_targetMap == Map.Malas)
{
Hue = House != null ? 0x55F : 1102;
}
else if (_targetMap == Map.Tokuno)
{
Hue = House != null ? 0x47F : 1154;
}
}
public void Mark(Mobile m)
{
_marked = true;
var setDesc = false;
if (Core.AOS)
{
_house = BaseHouse.FindHouseAt(m);
if (_house == null)
{
Target = m.Location;
_targetMap = m.Map;
}
else
{
var sign = _house.Sign;
_description = (sign?.Name?.Trim()).DefaultIfNullOrEmpty("an unnamed house");
setDesc = true;
var x = _house.BanLocation.X;
var y = _house.BanLocation.Y + 2;
var z = _house.BanLocation.Z;
var map = _house.Map;
if (map?.CanFit(x, y, z, 16, false, false) == false)
{
z = map.GetAverageZ(x, y);
}
Target = new Point3D(x, y, z);
_targetMap = map;
}
}
else
{
_house = null;
Target = m.Location;
_targetMap = m.Map;
}
if (!setDesc)
{
_description = BaseRegion.GetRuneNameFor(Region.Find(Target, _targetMap));
}
CalculateHue();
InvalidateProperties();
}
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
if (_marked)
{
string desc;
if ((desc = _description) == null || (desc = desc.Trim()).Length == 0)
{
desc = "an unknown location";
}
if (_targetMap == Map.Tokuno)
{
list.Add(House != null ? 1063260 : 1063259, $"a recall rune for {desc}"); // ~1_val~ (Tokuno Islands)[(House)]
}
else if (_targetMap == Map.Malas)
{
list.Add(House != null ? 1062454 : 1060804, $"a recall rune for {desc}"); // ~1_val~ (Malas)[(House)]
}
else if (_targetMap == Map.Felucca)
{
list.Add(House != null ? 1062452 : 1060805, $"a recall rune for {desc}"); // ~1_val~ (Felucca)[(House)]
}
else if (_targetMap == Map.Trammel)
{
list.Add(House != null ? 1062453 : 1060806, $"a recall rune for {desc}"); // ~1_val~ (Trammel)[(House)]
}
else if (House != null)
{
list.Add($"a recall rune for {desc} ({_targetMap})(House)");
}
else
{
list.Add($"a recall rune for {desc} ({_targetMap})");
}
}
}
public override void OnSingleClick(Mobile from)
{
if (_marked)
{
var desc = (_description?.Trim()).DefaultIfNullOrEmpty("an unknown location");
if (_targetMap == Map.Tokuno)
{
LabelTo(
from,
House != null ? 1063260 : 1063259, // ~1_val~ (Tokuno Islands)[(House)]
$"a recall rune for {desc}"
);
}
else if (_targetMap == Map.Malas)
{
LabelTo(
from,
House != null ? 1062454 : 1060804, // ~1_val~ (Malas)[(House)]
$"a recall rune for {desc}"
);
}
else if (_targetMap == Map.Felucca)
{
LabelTo(
from,
House != null ? 1062452 : 1060805, // ~1_val~ (Felucca)[(House)]
$"a recall rune for {desc}"
);
}
else if (_targetMap == Map.Trammel)
{
LabelTo(
from,
House != null ? 1062453 : 1060806, // ~1_val~ (Trammel)[(House)]
$"a recall rune for {desc}"
);
}
else
{
if (House != null)
{
LabelTo(from, $"a recall rune for {desc} ({_targetMap})(House)");
}
else
{
LabelTo(from, $"a recall rune for {desc} ({_targetMap})");
}
}
}
else
{
LabelTo(from, "an unmarked recall rune");
}
}
public override void OnDoubleClick(Mobile from)
{
int number;
if (!IsChildOf(from.Backpack))
{
number = 1042001; // That must be in your pack for you to use it.
}
else if (House != null)
{
number = 1062399; // You cannot edit the description for this rune.
}
else if (_marked)
{
number = 501804; // Please enter a description for this marked object.
from.Prompt = new RenamePrompt(this);
}
else
{
number = 501805; // That rune is not yet marked.
}
from.SendLocalizedMessage(number);
}
private class RenamePrompt : Prompt
{
private RecallRune _rune;
public RenamePrompt(RecallRune rune) => _rune = rune;
public override void OnResponse(Mobile from, string text)
{
if (_rune.House == null && _rune.Marked)
{
_rune.Description = text;
from.SendLocalizedMessage(1010474); // The etching on the rune has been changed.
}
}
}
}