ModernUO/Projects/UOContent/Items/Misc/ProjectedItem.cs
Kamron Batman 392c4e16d5
refactor: Changes BaseCreature to the SerializationGenerator (delta save requirement) (#2611)
The pure SerializationGenerator conversion of `BaseCreature`, split out of #2592 so it can serve as the reference for converting every other large hand-written class in the Delta Saves project (#7, phase 3). Two behaviour changes from #2592 are deliberately not here and follow in their own PRs on top of this one: `SpeedClass`, and the collapse of `ControlMaster`/`SummonMaster` into one reference (a creature can lose or keep either independently: Blade Spirits and Energy Vortexes are summoned but never controlled, EnragedCreature and talisman summons keep a summon master with neither flag set).

## What this is

- `BaseCreature` becomes `[SerializationGenerator(23, false)]` with a `[SerializableField]` per serialized slot and `[SaveFlag]` elision on nearly every field, so a stock creature serializes to its version plus flags. Field orders run 0..53 with no gaps (54 fields).
- The hand-written reader stays as `private void Deserialize(IGenericReader reader, int version)` for every pre-codegen version (0..22); post-codegen bumps use `MigrateFrom` from here on. `[AfterDeserialization]` carries the post-load fixups main did after reading (stat timers, AI type, followers, reacquire seeding).
- `ControlMaster` and `SummonMaster` stay two independent fields with main's semantics, each elided when null.
- `DamageMin`/`DamageMax`/`ActiveSpeed`/`PassiveSpeed` are no longer virtual (nothing in the tree overrode them); comments swept to the constraints that matter.
- Direct writes to serialized backing fields outside the generated setters (`SetDamage`, `SetResistance`, the move-speed helpers, the loot flag, feed loyalty, the delete timer) call `this.MarkDirty()`, matching the #2609 standard, so the class is ready for delta saves once `Mobile` is audited.
- Schema `Server.Mobiles.BaseCreature.v23.json` regenerated by the tool (a second run produces no diff).

## Deferred to follow-up PRs

SpeedClass: the serialized `_speedClass` field, `DefaultSpeedClass` replacing the type constant, `ApplySpeedClass`/`OnSpeedClassChange`, "None means custom", the four-speeds-as-one-block elision, `NPCSpeeds.FindEntry(SpeedLevel)`, the constructor fallback to Medium, and their tests.

Master references: serializing one `Master` with a `Controlled`/`Summoned` fan-out and the `SetControlMaster` lockstep.

## Tests

UOContent.Tests 776 / Server.Tests 855 green. `BaseCreatureSerializationTests` covers: a default creature elides to version + flags; a populated creature round-trips with exact byte consumption; back-to-back saves are byte-identical; an uncontrolled summon keeps its SummonMaster; byte-authentic v22 legacy streams (replicas of main's `Serialize`) load through the legacy reader for a wild tamable, a controlled pet, a controlled summon with an anchored `SummonEnd`, and a summon-master-only creature (the EnragedCreature shape); a running delete timer round-trips through `[DeserializeTimer]`; `Friends`, `CurrentWayPoint` and `HomeMap` round-trip; a `BaseVendor` stub round-trips the generated BaseVendor v2 → generated BaseCreature v23 chain.

## Behaviour notes for reviewers

- `ActiveMoveSpeed`/`PassiveMoveSpeed` getters return the raw override (0 = inherit); `CurrentMoveSpeed` is the resolved pace.
- Speeds elided as table defaults re-snap to the current `npc-speeds.json` on load, so table edits reach unmodified spawns on restart.
- `GetSpeeds` no longer throws on the save/load path when the table has no entry for the type: saves elide against the creature's own values and loads keep the stream. Construction still throws (`InvalidOperationException`, was `KeyNotFoundException`). An elided load with no table entry would otherwise resume at speed 0, so `[AfterDeserialization]` logs once and paces it at Medium.
- `virtual` removed from `ActiveSpeed`, `PassiveSpeed`, `DamageMin`, `DamageMax` (no overrides in the tree; forks may have some).
- `ControlMaster`, `SummonMaster`, `ControlOrder`, `Tamable`, `IsParagon` are `[SerializableProperty]` over hand-written setters because follower bookkeeping must run before the assignment, which a `fieldChanged` hook cannot express; the wire format is identical.

## Prerequisites for cherry-picking
#2609 (BaseVendor is already generated on top of BaseCreature) and SerializationGenerator 4.1.0.
2026-09-06 14:11:51 -07:00

182 lines
4 KiB
C#

using System;
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Network;
namespace Server.Items;
[SerializationGenerator(0)]
public partial class ProjectedItem : Item
{
private static readonly HashSet<ProjectedItem> _active = [];
private static Timer _timer;
[SerializedCommandProperty(AccessLevel.GameMaster)]
[SerializableField(0)]
private int _effectItemId;
[SerializedCommandProperty(AccessLevel.Developer)]
[SerializableField(1)]
private AccessLevel _minimumVisible;
private bool _oldVisible;
[Constructible]
public ProjectedItem(int effectItemId) : base(1)
{
Movable = false;
Visible = false;
_effectItemId = effectItemId;
}
public override bool HandlesOnMovement => true;
public override bool CanSeeStaffOnly(Mobile from) => from.AccessLevel >= _minimumVisible;
public override void ProcessDelta()
{
if (_oldVisible != Visible)
{
Timer.DelayCall(
TimeSpan.Zero,
i =>
{
i.ItemID = i.Visible ? i._effectItemId : 1;
i._oldVisible = i.Visible;
i.Activate();
},
this
);
}
base.ProcessDelta();
}
public override void SendInfoTo(NetState ns, ReadOnlySpan<byte> world = default)
{
base.SendInfoTo(ns, world);
var m = ns.Mobile;
if (m != null && !Visible && m.AccessLevel >= _minimumVisible && !_active.Contains(this))
{
Activate();
}
}
public override void OnLocationChange(Point3D oldLocation)
{
base.OnLocationChange(oldLocation);
Activate();
}
public override void OnMapChange()
{
base.OnMapChange();
Activate();
}
public override void OnDelete()
{
Deactivate();
base.OnDelete();
}
[AfterDeserialization]
private void AfterDeserialization()
{
_oldVisible = Visible;
}
public override void OnMovement(Mobile m, Point3D oldLocation)
{
base.OnMovement(m, oldLocation);
if (!Visible && m.AccessLevel >= _minimumVisible && !_active.Contains(this))
{
Activate();
}
}
private void Activate()
{
if (!_active.Add(this))
{
return;
}
if (_timer == null)
{
_timer = Timer.DelayCall(TimeSpan.Zero, TimeSpan.FromSeconds(1.0), OnTick);
}
else if (!_timer.Running)
{
_timer.Interval = TimeSpan.FromSeconds(1.0);
_timer.Start();
}
}
private void Deactivate()
{
if (_active.Remove(this) && _active.Count == 0)
{
_timer?.Stop();
}
}
private static void OnTick()
{
foreach (var item in _active)
{
if (!item.SendEffect())
{
_active.Remove(item);
}
}
if (_active.Count == 0)
{
_timer?.Stop();
}
}
protected virtual bool SendEffect()
{
if (_oldVisible)
{
return false;
}
var found = false;
Span<byte> buffer = new byte[OutgoingEffectPackets.HuedEffectLength].InitializePacket();
OutgoingEffectPackets.CreateHuedEffect(
buffer,
EffectType.FixedXYZ,
Serial,
Serial,
_effectItemId,
Location,
Location,
1,
20,
true,
false,
Hue - 1,
3
);
foreach (var ns in GetClientsInRange(GetMaxUpdateRange()))
{
found = true;
var from = ns.Mobile;
if (ns.CannotSendPackets() || from == null || from.AccessLevel < _minimumVisible)
{
continue;
}
from.ProcessDelta();
ns.Send(buffer);
}
return found;
}
}