ModernUO/Projects/UOContent/Spells/Ninjitsu/MirrorImage.cs
Kamron Batman 843a29e7dc
refactor: master views over BaseCreature's one master reference (#2674)
## Summary

After #2670, `BaseCreature` stores one master. Callers still reached it through three differently gated names plus hand-rolled combinations of the `Controlled`/`Summoned` flags. Each gate is now one named view:

| Member | Definition | Meaning |
|---|---|---|
| `Master` | the reference; its setter does the follower bookkeeping; serialized as before | whoever the creature answers to |
| `ControlMaster` | `Controlled ? Master : null` | the owner |
| `SummonMaster` | `Summoned ? Master : null` | the summoner |
| `GetMaster()` | `ControlMaster ?? SummonMaster` | who answers for the creature |

`ControlMaster` and `SummonMaster` stay settable so custom code keeps compiling: both setters assign `Master`. There is no guard, so a write through either one can read back as null until the matching flag is set.

An enraged creature is the one shape with a master and neither flag. It keeps its meer through `Master`, while `GetMaster()` stays null, so the meer never answers for it (notoriety, kill credit).

Readers move onto the view they mean:
- "Owner or summoner" pairs and `ControlMaster ?? SummonMaster` collapse into `GetMaster()`: pack instinct, familiars, golem, house access, mounts, pack horse, Solen friendship, spell target and guild checks, and the `[` pet command.
- Checks such as `Controlled && ControlMaster == from` drop the flag the view already applies. Checks that don't reduce keep it: `Controlled && ControlMaster != from`, a possibly-null `from`, and `MageAI.CanDispel`'s `Summoned &&`.

**No behavior change, save format unchanged** (the schema generator produces no diff). Edge cases for custom code and shard operators:
- `SummonMaster = x` on a plain pet now replaces its owner (#2670 made that a no-op), and `ControlMaster = null` on an uncontrolled summon now clears its caster (it did nothing before).
- `SpellHelper.GetGuildFor` no longer falls back to an enraged creature's meer. Meer mages have no guild.

## Docs

- `dev-docs/content-patterns.md` § Masters: which view answers which question, how to set a master, and which flag checks are redundant.
- `dev-docs/runuo-migration-docs/09-items-mobiles-creatures.md` § Masters: RunUO's two-field reads mapped onto the views, plus the gotcha for creatures that set `SummonMaster` without `Summoned` (the write compiles, the read now returns null; use `Master`).
- The `modernuo-content-patterns` and `migrate-items-mobiles` skills point at both.

## Test plan

- [x] `MasterViewsTests`: all four views across wild, pet, controlled summon, uncontrolled summon and enraged shapes; reassigning `Master` moves follower slots; `SetControlMaster(null)` keeps an uncontrolled summon's caster; deleting a summon returns the caster's slots
- [x] Serialization tests updated to the new views (round-trip, legacy v22, v23 migration)
- [x] UOContent.Tests (1178 passed, 2 skipped) and Server.Tests (907) green
2026-09-24 22:45:24 -07:00

251 lines
6.8 KiB
C#

using System;
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Items;
using Server.Mobiles;
using Server.Spells;
using Server.Spells.Necromancy;
using Server.Spells.Ninjitsu;
namespace Server.Spells.Ninjitsu
{
public class MirrorImage : NinjaSpell
{
private static readonly Dictionary<Mobile, int> _cloneCount = new();
private static readonly SpellInfo _info = new(
"Mirror Image",
null,
-1,
9002
);
public MirrorImage(Mobile caster, Item scroll) : base(caster, scroll, _info)
{
}
public override TimeSpan CastDelayBase => TimeSpan.FromSeconds(1.5);
public override double RequiredSkill => Core.ML ? 20.0 : 40.0;
public override int RequiredMana => 10;
public override bool BlockedByAnimalForm => false;
public static bool HasClone(Mobile m) => _cloneCount.ContainsKey(m);
public static void AddClone(Mobile m)
{
if (m != null)
{
_cloneCount[m] = 1 + _cloneCount.GetValueOrDefault(m, 0);
}
}
public static void RemoveClone(Mobile m)
{
_cloneCount.Remove(m, out var count);
if (m == null || count <= 0)
{
return;
}
_cloneCount[m] = count - 1;
}
public override bool CheckCast()
{
if (Caster.Mounted)
{
Caster.SendLocalizedMessage(1063132); // You cannot use this ability while mounted.
return false;
}
if (Caster.Followers + 1 > Caster.FollowersMax)
{
// You cannot summon a mirror image because you have too many followers.
Caster.SendLocalizedMessage(1063133);
return false;
}
if (TransformationSpellHelper.UnderTransformation(Caster, typeof(HorrificBeastSpell)))
{
Caster.SendLocalizedMessage(1061091); // You cannot cast that spell in this form.
return false;
}
return base.CheckCast();
}
public override bool CheckDisturb(DisturbType type, bool firstCircle, bool resistable) => false;
public override void OnBeginCast()
{
base.OnBeginCast();
Caster.SendLocalizedMessage(1063134); // You begin to summon a mirror image of yourself.
}
public override void OnCast()
{
if (Caster.Mounted)
{
Caster.SendLocalizedMessage(1063132); // You cannot use this ability while mounted.
}
else if (Caster.Followers + 1 > Caster.FollowersMax)
{
// You cannot summon a mirror image because you have too many followers.
Caster.SendLocalizedMessage(1063133);
}
else if (TransformationSpellHelper.UnderTransformation(Caster, typeof(HorrificBeastSpell)))
{
Caster.SendLocalizedMessage(1061091); // You cannot cast that spell in this form.
}
else if (CheckSequence())
{
Caster.FixedParticles(0x376A, 1, 14, 0x13B5, EffectLayer.Waist);
Caster.PlaySound(0x511);
new Clone(Caster).MoveToWorld(Caster.Location, Caster.Map);
}
FinishSequence();
}
}
}
namespace Server.Mobiles
{
[SerializationGenerator(0)]
public partial class Clone : BaseCreature
{
[SerializableField(0)]
private Mobile _caster;
public Clone(Mobile caster) : base(AIType.AI_Melee, FightMode.None)
{
_caster = caster;
Body = caster.Body;
Hue = caster.Hue;
Female = caster.Female;
Name = caster.Name;
NameHue = caster.NameHue;
Title = caster.Title;
Kills = caster.Kills;
HairItemID = caster.HairItemID;
HairHue = caster.HairHue;
FacialHairItemID = caster.FacialHairItemID;
FacialHairHue = caster.FacialHairHue;
for (var i = 0; i < caster.Skills.Length; ++i)
{
var skill = Skills[i];
var casterSkill = caster.Skills[i];
skill.Base = casterSkill.Base;
skill.Cap = casterSkill.Cap;
}
for (var i = 0; i < caster.Items.Count; i++)
{
AddItem(CloneItem(caster.Items[i]));
}
Warmode = true;
Summoned = true;
Master = caster;
ControlOrder = OrderType.Follow;
ControlTarget = caster;
AddClone();
}
private void AddClone()
{
var duration = TimeSpan.FromSeconds(30.0 + _caster.Skills.Ninjitsu.Value / 4.0);
new UnsummonTimer(this, duration).Start();
SummonEnd = Core.Now + duration;
MirrorImage.AddClone(_caster);
}
protected override BaseAI ForcedAI => new CloneAI(this);
public override bool DeleteCorpseOnDeath => true;
public override bool IsDispellable => false;
public override bool Commandable => false;
public override bool IsHumanInTown() => false;
private static Item CloneItem(Item item)
{
var newItem = new Item(item.ItemID);
newItem.Hue = item.Hue;
newItem.Layer = item.Layer;
return newItem;
}
public override void OnDamage(int amount, Mobile from, bool willKill)
{
Delete();
}
public override void OnDelete()
{
Effects.SendLocationParticles(
EffectItem.Create(Location, Map, EffectItem.DefaultDuration),
0x3728,
10,
15,
5042
);
base.OnDelete();
}
public override void OnAfterDelete()
{
MirrorImage.RemoveClone(_caster);
base.OnAfterDelete();
}
[AfterDeserialization]
private void AfterDeserialization()
{
AddClone();
}
}
public class CloneAI : BaseAI
{
public CloneAI(Clone m) : base(m) => m.SetCurrentSpeedToActive();
public override bool CanDetectHidden => false;
public override bool Think()
{
// Clones only follow their owners
var master = Mobile.SummonMaster;
if (master?.Map == Mobile.Map && master?.InRange(Mobile, Mobile.RangePerception) == true)
{
WalkMobileRange(master, 2, 0, 1);
}
else
{
WalkRandom(2, 2, 1);
}
return true;
}
}
}