ModernUO/Projects/UOContent/Items/Misc/WarningItem.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

156 lines
4 KiB
C#

using System;
using ModernUO.Serialization;
using Server.Collections;
namespace Server.Items;
[SerializationGenerator(1, false)]
public partial class WarningItem : Item
{
private bool m_Broadcasting;
[SerializableField(0)]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private TextDefinition _warningMessage;
// Field 1
[SerializableField(1, allowFieldChange: nameof(AllowRangeChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private int _range;
private bool AllowRangeChange(ref int value)
{
value = Math.Min(value, 18);
return true;
}
[SerializableField(2)]
private TimeSpan _resetDelay;
private DateTime m_LastBroadcast;
[Constructible]
public WarningItem(int itemID, int range, int warning) : base(itemID)
{
Movable = false;
_warningMessage = warning;
_range = Math.Min(range, 18);
}
[Constructible]
public WarningItem(int itemID, int range, string warning) : base(itemID)
{
Movable = false;
_warningMessage = warning;
_range = Math.Min(range, 18);
}
public virtual bool OnlyToTriggerer => false;
public virtual int NeighborRange => 5;
public override bool HandlesOnMovement => true;
public virtual void SendMessage(Mobile triggerer, bool onlyToTriggerer, TextDefinition warningMessage)
{
if (onlyToTriggerer)
{
warningMessage.SendMessageTo(triggerer);
}
else
{
warningMessage.PublicOverheadMessage(this, MessageType.Regular, 0x3B2);
}
}
public virtual void Broadcast(Mobile triggerer)
{
if (m_Broadcasting || Core.Now < m_LastBroadcast + ResetDelay)
{
return;
}
m_LastBroadcast = Core.Now;
m_Broadcasting = true;
SendMessage(triggerer, OnlyToTriggerer, _warningMessage);
if (NeighborRange >= 0)
{
using var queue = PooledRefQueue<WarningItem>.Create();
foreach (var warningItem in GetItemsInRange<WarningItem>(NeighborRange))
{
if (warningItem != this)
{
queue.Enqueue(warningItem);
}
}
while (queue.Count > 0)
{
queue.Dequeue().Broadcast(triggerer);
}
}
Timer.StartTimer(StopBroadcasting);
}
private void StopBroadcasting()
{
m_Broadcasting = false;
}
public override void OnMovement(Mobile m, Point3D oldLocation)
{
if (m.Player && Utility.InRange(m.Location, Location, _range) &&
!Utility.InRange(oldLocation, Location, _range))
{
Broadcast(m);
}
}
public void Deserialize(IGenericReader reader, int version)
{
var warningMessageString = reader.ReadString();
var warningMessageInt = reader.ReadInt();
_range = reader.ReadInt();
ResetDelay = reader.ReadTimeSpan();
_warningMessage = warningMessageInt > 0 ? warningMessageInt : warningMessageString;
}
}
[SerializationGenerator(1, false)]
public partial class HintItem : WarningItem
{
[SerializableField(0)]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private TextDefinition _hintMessage;
[Constructible]
public HintItem(int itemID, int range, int warning, int hint) : base(itemID, range, warning) =>
_hintMessage = hint;
[Constructible]
public HintItem(int itemID, int range, string warning, string hint) : base(itemID, range, warning) =>
_hintMessage = hint;
public override bool OnlyToTriggerer => true;
public override void OnDoubleClick(Mobile from)
{
SendMessage(from, true, _hintMessage);
}
private void Deserialize(IGenericReader reader, int version)
{
var hintMessageString = reader.ReadString();
var hintMessageInt = reader.ReadInt();
_hintMessage = hintMessageInt > 0 ? hintMessageInt : hintMessageString;
}
}