ModernUO/Projects/UOContent/Mobiles/Abilities/Summon Undead/SummonUndeadCounter.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

72 lines
2.6 KiB
C#

using System;
namespace Server.Mobiles;
public abstract class SummonUndeadCounter : MonsterAbility
{
public override MonsterAbilityType AbilityType => MonsterAbilityType.SummonCounter;
public override MonsterAbilityTrigger AbilityTrigger => MonsterAbilityTrigger.TakeDamage;
public override double ChanceToTrigger => 0.05;
public override TimeSpan MinTriggerCooldown => TimeSpan.FromMinutes(5);
public override TimeSpan MaxTriggerCooldown => TimeSpan.FromMinutes(5);
public virtual double ChanceToPolymorph => 0.25;
public virtual TimeSpan PolymorphDuration => TimeSpan.FromMinutes(5);
public virtual int GetTransformBodyValue() => Utility.RandomBool() ? 50 : 56;
public virtual int AmountToSummon => 4;
public virtual int SummonRange => 4;
public abstract BaseCreature CreateSummon(BaseCreature source);
public override bool CanTrigger(BaseCreature source, MonsterAbilityTrigger trigger) =>
source.Followers < AmountToSummon && base.CanTrigger(source, trigger);
public override void Trigger(MonsterAbilityTrigger trigger, BaseCreature source, Mobile target)
{
var amount = AmountToSummon - source.Followers;
var distance = SummonRange;
var willTransform = !source.Paralyzed && ChanceToPolymorph > 0 && ChanceToPolymorph > Utility.RandomDouble()
? Utility.Random(amount)
: -1;
for (var i = 0; i < amount; i++)
{
var loc = Utility.GetValidLocationInLOS(source.Map, source, distance);
BaseCreature summon;
if (i == willTransform)
{
summon = source;
source.BodyMod = GetTransformBodyValue();
source.HueMod = 0;
// Name is not changed
Timer.DelayCall(PolymorphDuration, EndPolymorph, source);
}
else
{
summon = CreateSummon(source);
summon.Team = source.Team;
summon.Summoned = true;
summon.Master = source;
summon.FightMode = FightMode.Closest;
summon.Combatant = target;
summon.Home = source.Home;
summon.RangeHome = source.RangeHome;
}
summon.MoveToWorld(loc, source.Map);
Effects.SendLocationEffect(summon.Location, summon.Map, 0x3728, 10);
summon.PlaySound(0x48F);
summon.PlaySound(summon.GetAttackSound());
}
base.Trigger(trigger, source, target);
}
private static void EndPolymorph(BaseCreature source)
{
source.BodyMod = 0;
source.HueMod = -1;
}
}