ModernUO/Projects/UOContent/Engines/Doom/LeverPuzzle/LeverPuzzleRegions.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

113 lines
3.3 KiB
C#

using ModernUO.CodeGeneratedEvents;
using Server.Mobiles;
using Server.Regions;
namespace Server.Engines.Doom
{
public class LampRoomRegion : BaseRegion
{
private readonly LeverPuzzleController m_Controller;
public LampRoomRegion(LeverPuzzleController controller)
: base(null, Map.Malas, Find(LeverPuzzleController.lr_Enter, Map.Malas), LeverPuzzleController.lr_Rect)
{
m_Controller = controller;
Register();
}
[OnEvent(nameof(PlayerMobile.PlayerLoginEvent))]
public static void OnLogin(PlayerMobile pm)
{
var rect = LeverPuzzleController.lr_Rect;
if (pm.X >= rect.X && pm.X <= rect.X + 10 && pm.Y >= rect.Y && pm.Y <= rect.Y + 10 && pm.Map == Map.Internal)
{
Timer kick = new LeverPuzzleController.LampRoomKickTimer(pm);
kick.Start();
}
}
public override void OnEnter(Mobile m)
{
if (m is null or WandererOfTheVoid)
{
return;
}
if (m.AccessLevel > AccessLevel.Player)
{
return;
}
if (m_Controller.Successful != null)
{
if (m is PlayerMobile)
{
if (m == m_Controller.Successful)
{
return;
}
}
else if (m is BaseCreature bc && (bc.ControlMaster == m_Controller.Successful ||
bc.Summoned))
{
return;
}
}
Timer kick = new LeverPuzzleController.LampRoomKickTimer(m);
kick.Start();
}
public override void OnExit(Mobile m)
{
if (m != null && m == m_Controller.Successful)
{
m_Controller.RemoveSuccessful();
}
}
public override void OnDeath(Mobile m)
{
if (m?.Deleted != false || m is WandererOfTheVoid)
{
return;
}
Timer kick = new LeverPuzzleController.LampRoomKickTimer(m);
kick.Start();
}
public override bool OnSkillUse(Mobile m, int Skill) /* just in case */ => m_Controller.Successful != null &&
(m.AccessLevel != AccessLevel.Player || m == m_Controller.Successful);
}
public class LeverPuzzleRegion : BaseRegion
{
public Mobile m_Occupant;
public LeverPuzzleRegion(int[] loc)
: base(null, Map.Malas, Find(LeverPuzzleController.lr_Enter, Map.Malas), new Rectangle2D(loc[0], loc[1], 1, 1))
{
Register();
}
[CommandProperty(AccessLevel.GameMaster)]
public Mobile Occupant => m_Occupant?.Alive == true ? m_Occupant : null;
public override void OnEnter(Mobile m)
{
if (m != null && m_Occupant == null && m is PlayerMobile && m.Alive)
{
m_Occupant = m;
}
}
public override void OnExit(Mobile m)
{
if (m != null && m == m_Occupant)
{
m_Occupant = null;
}
}
}
}