## 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
150 lines
3.7 KiB
C#
150 lines
3.7 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using Server;
|
|
using Server.Mobiles;
|
|
using Xunit;
|
|
|
|
namespace UOContent.Tests.Mobiles;
|
|
|
|
// One stored master, read through gates on Controlled and Summoned.
|
|
[Collection("Sequential UOContent Tests")]
|
|
public class MasterViewsTests : IDisposable
|
|
{
|
|
private readonly List<Mobile> _created = [];
|
|
|
|
public void Dispose()
|
|
{
|
|
for (var i = 0; i < _created.Count; i++)
|
|
{
|
|
_created[i].Delete();
|
|
}
|
|
}
|
|
|
|
private sealed class Stub : BaseCreature
|
|
{
|
|
public Stub() : base(AIType.AI_Melee) => Body = 0xC9;
|
|
|
|
public Stub(Serial serial) : base(serial)
|
|
{
|
|
}
|
|
}
|
|
|
|
private Stub NewCreature()
|
|
{
|
|
var bc = new Stub();
|
|
_created.Add(bc);
|
|
return bc;
|
|
}
|
|
|
|
private PlayerMobile NewPlayer()
|
|
{
|
|
var pm = new PlayerMobile(World.NewMobile);
|
|
pm.DefaultMobileInit();
|
|
World.AddEntity(pm);
|
|
_created.Add(pm);
|
|
return pm;
|
|
}
|
|
|
|
public enum Shape
|
|
{
|
|
Wild,
|
|
Pet,
|
|
ControlledSummon,
|
|
UncontrolledSummon,
|
|
Enraged
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(Shape.Wild)]
|
|
[InlineData(Shape.Pet)]
|
|
[InlineData(Shape.ControlledSummon)]
|
|
[InlineData(Shape.UncontrolledSummon)]
|
|
[InlineData(Shape.Enraged)]
|
|
public void Views_ByShape(Shape shape)
|
|
{
|
|
var bc = NewCreature();
|
|
var master = NewPlayer();
|
|
|
|
switch (shape)
|
|
{
|
|
case Shape.Pet:
|
|
{
|
|
bc.SetControlMaster(master);
|
|
break;
|
|
}
|
|
case Shape.ControlledSummon:
|
|
{
|
|
bc.SetControlMaster(master);
|
|
bc.Summoned = true;
|
|
break;
|
|
}
|
|
case Shape.UncontrolledSummon:
|
|
{
|
|
bc.Summoned = true;
|
|
bc.Master = master;
|
|
break;
|
|
}
|
|
case Shape.Enraged:
|
|
{
|
|
bc.Master = master;
|
|
break;
|
|
}
|
|
}
|
|
|
|
var controlled = shape is Shape.Pet or Shape.ControlledSummon;
|
|
var summoned = shape is Shape.ControlledSummon or Shape.UncontrolledSummon;
|
|
|
|
Assert.Equal(shape == Shape.Wild ? null : master, bc.Master);
|
|
Assert.Equal(controlled ? master : null, bc.ControlMaster);
|
|
Assert.Equal(summoned ? master : null, bc.SummonMaster);
|
|
Assert.Equal(controlled || summoned ? master : null, bc.GetMaster());
|
|
}
|
|
|
|
[Fact]
|
|
public void Master_Reassignment_MovesFollowerSlots()
|
|
{
|
|
var bc = NewCreature();
|
|
bc.ControlSlots = 2;
|
|
var first = NewPlayer();
|
|
var second = NewPlayer();
|
|
|
|
bc.Master = first;
|
|
Assert.Equal(2, first.Followers);
|
|
|
|
bc.Master = second;
|
|
Assert.Equal(0, first.Followers);
|
|
Assert.Equal(2, second.Followers);
|
|
Assert.Null(bc.ControlMaster); // not Controlled
|
|
|
|
bc.Master = null;
|
|
Assert.Equal(0, second.Followers);
|
|
}
|
|
|
|
[Fact]
|
|
public void SetControlMasterNull_KeepsAnUncontrolledSummonsCaster()
|
|
{
|
|
var bc = NewCreature();
|
|
var caster = NewPlayer();
|
|
bc.Summoned = true;
|
|
bc.Master = caster;
|
|
|
|
bc.SetControlMaster(null);
|
|
|
|
Assert.Equal(caster, bc.SummonMaster);
|
|
Assert.Equal(bc.ControlSlots, caster.Followers);
|
|
}
|
|
|
|
[Fact]
|
|
public void Delete_ReturnsTheCastersFollowerSlots()
|
|
{
|
|
var bc = NewCreature();
|
|
var caster = NewPlayer();
|
|
bc.Summoned = true;
|
|
bc.Master = caster;
|
|
|
|
bc.Delete();
|
|
|
|
Assert.Equal(0, caster.Followers);
|
|
Assert.Null(bc.Master);
|
|
}
|
|
}
|