ModernUO/Projects/UOContent/Items/Skill Items/Lumberjack/Log.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

161 lines
4.1 KiB
C#

using ModernUO.Serialization;
namespace Server.Items;
[SerializationGenerator(2, false)]
[Flippable(0x1bdd, 0x1be0)]
public partial class Log : Item, ICommodity, IAxe
{
[Constructible]
public Log(int amount = 1) : this(CraftResource.RegularWood, amount)
{
}
[Constructible]
public Log(CraftResource resource) : this(resource, 1)
{
}
[Constructible]
public Log(CraftResource resource, int amount) : base(0x1BDD)
{
Stackable = true;
Amount = amount;
_resource = resource;
Hue = CraftResources.GetHue(resource);
}
public override double DefaultWeight => 2.0;
[SerializableField(0, fieldChanged: nameof(OnResourceChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private CraftResource _resource;
private void OnResourceChanged(CraftResource oldValue, CraftResource newValue)
{
Hue = CraftResources.GetHue(newValue);
}
public virtual bool Axe(Mobile from, BaseAxe axe) => TryCreateBoards(from, 0, new Board());
int ICommodity.DescriptionNumber => CraftResources.IsStandard(_resource)
? LabelNumber
: 1075062 + ((int)_resource - (int)CraftResource.RegularWood);
bool ICommodity.IsDeedable => true;
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
if (!CraftResources.IsStandard(_resource))
{
var num = CraftResources.GetLocalizationNumber(_resource);
if (num > 0)
{
list.Add(num);
}
else
{
list.Add(CraftResources.GetName(_resource));
}
}
}
private void Deserialize(IGenericReader reader, int version)
{
_resource = version switch
{
1 => (CraftResource)reader.ReadInt(),
_ => CraftResource.RegularWood
};
}
public virtual bool TryCreateBoards(Mobile from, double skill, Item item)
{
if (Deleted || !from.CanSee(this))
{
return false;
}
if (from.Skills.Carpentry.Value < skill &&
from.Skills.Lumberjacking.Value < skill)
{
item.Delete();
from.SendLocalizedMessage(1072652); // You cannot work this strange and unusual wood.
return false;
}
ScissorHelper(from, item, 1, false);
return true;
}
}
[SerializationGenerator(0, false)]
public partial class HeartwoodLog : Log
{
[Constructible]
public HeartwoodLog(int amount = 1) : base(CraftResource.Heartwood, amount)
{
}
public override bool Axe(Mobile from, BaseAxe axe) => TryCreateBoards(from, 100, new HeartwoodBoard());
}
[SerializationGenerator(0, false)]
public partial class BloodwoodLog : Log
{
[Constructible]
public BloodwoodLog(int amount = 1) : base(CraftResource.Bloodwood, amount)
{
}
public override bool Axe(Mobile from, BaseAxe axe) => TryCreateBoards(from, 100, new BloodwoodBoard());
}
[SerializationGenerator(0, false)]
public partial class FrostwoodLog : Log
{
[Constructible]
public FrostwoodLog(int amount = 1) : base(CraftResource.Frostwood, amount)
{
}
public override bool Axe(Mobile from, BaseAxe axe) => TryCreateBoards(from, 100, new FrostwoodBoard());
}
[SerializationGenerator(0, false)]
public partial class OakLog : Log
{
[Constructible]
public OakLog(int amount = 1) : base(CraftResource.OakWood, amount)
{
}
public override bool Axe(Mobile from, BaseAxe axe) => TryCreateBoards(from, 65, new OakBoard());
}
[SerializationGenerator(0, false)]
public partial class AshLog : Log
{
[Constructible]
public AshLog(int amount = 1) : base(CraftResource.AshWood, amount)
{
}
public override bool Axe(Mobile from, BaseAxe axe) => TryCreateBoards(from, 80, new AshBoard());
}
[SerializationGenerator(0, false)]
public partial class YewLog : Log
{
[Constructible]
public YewLog(int amount = 1) : base(CraftResource.YewWood, amount)
{
}
public override bool Axe(Mobile from, BaseAxe axe) => TryCreateBoards(from, 95, new YewBoard());
}