warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
ModernUO/Projects/UOContent/Items/Addons/SHTeleporter.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

354 lines
12 KiB
C#
Raw Permalink Blame History

using ModernUO.Serialization;
using Server.Mobiles;
namespace Server.Items
{
[SerializationGenerator(0, false)]
public partial class SHTeleComponent : AddonComponent
{
[SerializableField(2)]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private Point3D _teleOffset;
[Constructible]
public SHTeleComponent(int itemID = 0x1775) : this(itemID, new Point3D(0, 0, 0))
{
}
[Constructible]
public SHTeleComponent(int itemID, Point3D offset) : base(itemID)
{
Movable = false;
Hue = 1;
_active = true;
_teleOffset = offset;
}
[SerializableField(0, fieldChanged: nameof(OnActiveChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private bool _active;
private void OnActiveChanged(bool oldValue, bool newValue)
{
if (Addon is SHTeleporter sourceAddon)
{
sourceAddon.ChangeActive(newValue);
}
}
[SerializableField(1, fieldChanged: nameof(OnTeleDestChanged))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private SHTeleComponent _teleDest;
private void OnTeleDestChanged(SHTeleComponent oldValue, SHTeleComponent newValue)
{
if (Addon is SHTeleporter sourceAddon)
{
sourceAddon.ChangeDest(newValue);
}
}
[CommandProperty(AccessLevel.GameMaster)]
public Point3D TelePoint
{
get => new(Location.X + TeleOffset.X, Location.Y + TeleOffset.Y, Location.Z + TeleOffset.Z);
set => TeleOffset = new Point3D(value.X - Location.X, value.Y - Location.Y, value.Z - Location.Z);
}
public override string DefaultName => "a hole";
public override void OnDoubleClick(Mobile m)
{
if (!_active || _teleDest?.Deleted != false || _teleDest.Map == Map.Internal)
{
return;
}
if (m.InRange(this, 3))
{
var map = _teleDest.Map;
var p = _teleDest.TelePoint;
BaseCreature.TeleportPets(m, p, map);
m.MoveToWorld(p, map);
}
else
{
m.SendLocalizedMessage(1019045); // I can't reach that.
}
}
public override void OnDoubleClickDead(Mobile m)
{
OnDoubleClick(m);
}
}
[SerializationGenerator(0, false)]
public partial class SHTeleporter : BaseAddon
{
private bool m_Changing;
[SerializableField(0, setter: "private")]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private bool _external;
[SerializableField(1, setter: "private")]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private SHTeleComponent _upTele;
[SerializableField(2, setter: "private")]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private SHTeleComponent _rightTele;
[SerializableField(3, setter: "private")]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private SHTeleComponent _downTele;
[SerializableField(4, setter: "private")]
[SerializedCommandProperty(AccessLevel.GameMaster)]
private SHTeleComponent _leftTele;
[Constructible]
public SHTeleporter(bool external = true)
{
_external = external;
if (external)
{
AddComponent(new AddonComponent(0x549), -1, -1, 0);
AddComponent(new AddonComponent(0x54D), 0, -1, 0);
AddComponent(new AddonComponent(0x54E), 1, -1, 0);
AddComponent(new AddonComponent(0x548), 2, -1, 0);
AddComponent(new AddonComponent(0x54B), -1, 0, 0);
AddComponent(new AddonComponent(0x53B), 0, 0, 0);
AddComponent(new AddonComponent(0x53B), 1, 0, 0);
AddComponent(new AddonComponent(0x544), 2, 0, 0);
AddComponent(new AddonComponent(0x54C), -1, 1, 0);
AddComponent(new AddonComponent(0x53B), 0, 1, 0);
AddComponent(new AddonComponent(0x53B), 1, 1, 0);
AddComponent(new AddonComponent(0x545), 2, 1, 0);
AddComponent(new AddonComponent(0x547), -1, 2, 0);
AddComponent(new AddonComponent(0x541), 0, 2, 0);
AddComponent(new AddonComponent(0x543), 1, 2, 0);
AddComponent(new AddonComponent(0x540), 2, 2, 0);
}
var upOS = external ? new Point3D(-1, 0, 0) : new Point3D(-2, -1, 0);
UpTele = new SHTeleComponent(external ? 0x1775 : 0x495, upOS);
AddComponent(UpTele, 0, 0, 0);
var rightOS = external ? new Point3D(-2, 0, 0) : new Point3D(2, -1, 0);
RightTele = new SHTeleComponent(external ? 0x1775 : 0x495, rightOS);
AddComponent(RightTele, 1, 0, 0);
var downOS = external ? new Point3D(-2, -1, 0) : new Point3D(2, 2, 0);
DownTele = new SHTeleComponent(external ? 0x1776 : 0x495, downOS);
AddComponent(DownTele, 1, 1, 0);
var leftOS = external ? new Point3D(-1, -1, 0) : new Point3D(-1, 2, 0);
LeftTele = new SHTeleComponent(external ? 0x1775 : 0x495, leftOS);
AddComponent(LeftTele, 0, 1, 0);
}
public override bool ShareHue => false;
public static void Configure()
{
CommandSystem.Register("SHTelGen", AccessLevel.Developer, SHTelGen_OnCommand);
}
[Usage("SHTelGen"), Description("Generates solen hives teleporters.")]
public static void SHTelGen_OnCommand(CommandEventArgs e)
{
CreateSHTeleporters();
e.Mobile.SendMessage("Solen Hive teleporters have been created.");
}
public void ChangeActive(bool active)
{
if (m_Changing)
{
return;
}
m_Changing = true;
UpTele.Active = active;
RightTele.Active = active;
DownTele.Active = active;
LeftTele.Active = active;
m_Changing = false;
}
public void ChangeDest(SHTeleComponent dest)
{
if (m_Changing)
{
return;
}
m_Changing = true;
if (!(dest?.Addon is SHTeleporter))
{
UpTele.TeleDest = dest;
RightTele.TeleDest = dest;
DownTele.TeleDest = dest;
LeftTele.TeleDest = dest;
}
else
{
var destAddon = (SHTeleporter)dest.Addon;
UpTele.TeleDest = destAddon.UpTele;
RightTele.TeleDest = destAddon.RightTele;
DownTele.TeleDest = destAddon.DownTele;
LeftTele.TeleDest = destAddon.LeftTele;
}
m_Changing = false;
}
public void ChangeDest(SHTeleporter destAddon)
{
if (m_Changing)
{
return;
}
m_Changing = true;
if (destAddon != null)
{
UpTele.TeleDest = destAddon.UpTele;
RightTele.TeleDest = destAddon.RightTele;
DownTele.TeleDest = destAddon.DownTele;
LeftTele.TeleDest = destAddon.LeftTele;
}
else
{
UpTele.TeleDest = null;
RightTele.TeleDest = null;
DownTele.TeleDest = null;
LeftTele.TeleDest = null;
}
m_Changing = false;
}
public static SHTeleporter FindSHTeleporter(Map map, Point3D p)
{
foreach (var teleporter in map.GetItemsAt<SHTeleporter>(p))
{
if (teleporter.Z == p.Z)
{
return teleporter;
}
}
return null;
}
public static SHTeleporter AddSHT(Map map, bool ext, int x, int y, int z)
{
var p = new Point3D(x, y, z);
var tele = FindSHTeleporter(map, p);
if (tele == null)
{
tele = new SHTeleporter(ext);
tele.MoveToWorld(p, map);
}
return tele;
}
public static void Link(SHTeleporter tele1, SHTeleporter tele2)
{
tele1.ChangeDest(tele2);
tele2.ChangeDest(tele1);
}
public static void AddSHTCouple(Map map, bool ext1, int x1, int y1, int z1, bool ext2, int x2, int y2, int z2)
{
var tele1 = AddSHT(map, ext1, x1, y1, z1);
var tele2 = AddSHT(map, ext2, x2, y2, z2);
Link(tele1, tele2);
}
public static void AddSHTCouple(bool ext1, int x1, int y1, int z1, bool ext2, int x2, int y2, int z2)
{
AddSHTCouple(Map.Trammel, ext1, x1, y1, z1, ext2, x2, y2, z2);
AddSHTCouple(Map.Felucca, ext1, x1, y1, z1, ext2, x2, y2, z2);
}
public static void CreateSHTeleporters()
{
AddSHTCouple(true, 2608, 763, 0, false, 5918, 1794, 0);
AddSHTCouple(false, 5897, 1877, 0, false, 5871, 1867, 0);
AddSHTCouple(false, 5852, 1848, 0, false, 5771, 1867, 0);
var tele1 = AddSHT(Map.Trammel, false, 5747, 1895, 0);
tele1.LeftTele.TeleOffset = new Point3D(-1, 3, 0);
var tele2 = AddSHT(Map.Trammel, false, 5658, 1898, 0);
Link(tele1, tele2);
tele1 = AddSHT(Map.Felucca, false, 5747, 1895, 0);
tele1.LeftTele.TeleOffset = new Point3D(-1, 3, 0);
tele2 = AddSHT(Map.Felucca, false, 5658, 1898, 0);
Link(tele1, tele2);
AddSHTCouple(false, 5727, 1894, 0, false, 5756, 1794, 0);
AddSHTCouple(false, 5784, 1929, 0, false, 5700, 1929, 0);
tele1 = AddSHT(Map.Trammel, false, 5711, 1952, 0);
tele1.LeftTele.TeleOffset = new Point3D(-1, 3, 0);
tele2 = AddSHT(Map.Trammel, false, 5657, 1954, 0);
Link(tele1, tele2);
tele1 = AddSHT(Map.Felucca, false, 5711, 1952, 0);
tele1.LeftTele.TeleOffset = new Point3D(-1, 3, 0);
tele2 = AddSHT(Map.Felucca, false, 5657, 1954, 0);
Link(tele1, tele2);
tele1 = AddSHT(Map.Trammel, false, 5655, 2018, 0);
tele1.LeftTele.TeleOffset = new Point3D(-1, 3, 0);
tele2 = AddSHT(Map.Trammel, true, 1690, 2789, 0);
Link(tele1, tele2);
tele1 = AddSHT(Map.Felucca, false, 5655, 2018, 0);
tele1.LeftTele.TeleOffset = new Point3D(-1, 3, 0);
tele2 = AddSHT(Map.Felucca, true, 1690, 2789, 0);
Link(tele1, tele2);
AddSHTCouple(false, 5809, 1905, 0, false, 5876, 1891, 0);
tele1 = AddSHT(Map.Trammel, false, 5814, 2015, 0);
tele1.LeftTele.TeleOffset = new Point3D(-1, 3, 0);
tele2 = AddSHT(Map.Trammel, false, 5913, 1893, 0);
Link(tele1, tele2);
tele1 = AddSHT(Map.Felucca, false, 5814, 2015, 0);
tele1.LeftTele.TeleOffset = new Point3D(-1, 3, 0);
tele2 = AddSHT(Map.Felucca, false, 5913, 1893, 0);
Link(tele1, tele2);
AddSHTCouple(false, 5919, 2021, 0, true, 1724, 814, 0);
tele1 = AddSHT(Map.Trammel, false, 5654, 1791, 0);
tele2 = AddSHT(Map.Trammel, true, 730, 1451, 0);
Link(tele1, tele2);
AddSHT(Map.Trammel, false, 5734, 1859, 0).ChangeDest(tele2);
tele1 = AddSHT(Map.Felucca, false, 5654, 1791, 0);
tele2 = AddSHT(Map.Felucca, true, 730, 1451, 0);
Link(tele1, tele2);
AddSHT(Map.Felucca, false, 5734, 1859, 0).ChangeDest(tele2);
}
}
}
Reference in a new issue View git blame Copy permalink