warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

refactor: master views over BaseCreature's one master reference (#2674)

Browse source 
## 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
This commit is contained in:
Kamron Batman 2026-09-24 22:45:24 -07:00 • committed by GitHub
parent 37970a4811
commit 843a29e7dc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
41 changed files with 346 additions and 213 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Projects/UOContent.Tests/Tests/Mobiles/AI/GuardFriendlyFireTests.cs
View file

@ -123,7 +123,7 @@ public class GuardFriendlyFireTests : IDisposable
var (owner, pet) = Spawn();
var summon = OtherPet(owner, new Point3D(1498, 1600, owner.Z));
summon.Summoned = true;
summon.SummonMaster = owner;
summon.Master = owner;
summon.Combatant = owner;
Assert.Same(owner, summon.Combatant);
pet.AggressiveAction(summon, false);
@ -136,7 +136,7 @@ public class GuardFriendlyFireTests : IDisposable
public void GuardDefendsAgainstOwnUncontrolledSummonAttackingOwner()
{
var (owner, pet) = Spawn();
var vortex = new PetTestStub { Summoned = true, SummonMaster = owner };
var vortex = new PetTestStub { Summoned = true, Master = owner };
_created.Add(vortex);
vortex.MoveToWorld(new Point3D(1498, 1600, owner.Z), owner.Map);
vortex.AIObject.AITimer.Stop();

2
Projects/UOContent.Tests/Tests/Mobiles/AI/PetOrderTests.cs
View file

@ -762,7 +762,7 @@ public class PetOrderTests : IDisposable
{
var (master, pet) = Spawn(new Point3D(1000, 1000, 0), new Point3D(1001, 1000, 0));
pet.Summoned = true;
pet.SummonMaster = master;
pet.Master = master;
pet.ControlOrder = OrderType.Release;

2
Projects/UOContent.Tests/Tests/Mobiles/AI/PetRetaliationTests.cs
View file

@ -197,7 +197,7 @@ public class PetRetaliationTests : IDisposable
var summon = new StandDownPet();
summon.Summoned = true;
summon.SummonMaster = caster;
summon.Master = caster;
summon.MoveToWorld(new Point3D(1001, 1000, 0), Map.Felucca);
summon.AIObject.AITimer?.Stop();
_created.Add(summon);

2
Projects/UOContent.Tests/Tests/Mobiles/AI/SummonAcquireRulesTests.cs
View file

@ -24,7 +24,7 @@ public class SummonAcquireRulesTests : IDisposable
{
_created.Add(summon);
summon.Summoned = true;
summon.SummonMaster = caster;
summon.Master = caster;
summon.MoveToWorld(new Point3D(x, 1600, caster.Map.GetAverageZ(x, 1600)), caster.Map);
summon.AIObject.AITimer.Stop();
return summon;

28
Projects/UOContent.Tests/Tests/Mobiles/BaseCreatureSerializationTests.cs
View file

@ -201,31 +201,16 @@ public class BaseCreatureSerializationTests : IDisposable
}
else
{
bc.SummonMaster = master;
bc.Master = master;
}
var copy = Load(Snapshot(bc));
Assert.Equal(controlled, copy.Controlled);
Assert.Equal(summoned, copy.Summoned);
Assert.Equal(master, copy.Master);
Assert.Equal(controlled ? master : null, copy.ControlMaster);
Assert.Equal(controlled && !summoned ? null : master, copy.SummonMaster);
}
[Fact]
public void SummonMaster_OnPlainPet_KeepsTheOwner()
{
var bc = NewCreature();
var owner = NewMaster();
var other = NewMaster();
bc.SetControlMaster(owner);
bc.SummonMaster = other;
Assert.Equal(owner, bc.ControlMaster);
Assert.Null(bc.SummonMaster);
Assert.Equal(bc.ControlSlots, owner.Followers);
Assert.Equal(0, other.Followers);
Assert.Equal(summoned ? master : null, copy.SummonMaster);
}
[Fact]
@ -446,8 +431,8 @@ public class BaseCreatureSerializationTests : IDisposable
Assert.Equal(0.6, copy.CurrentMoveSpeed); // passive mode, inheriting
}
// A summon master can exist without Summoned (EnragedCreature), and a controlled summon
// reports the same mobile as both.
// A master survives without Summoned (EnragedCreature), and a controlled summon reports the
// same mobile as both.
[Theory]
[InlineData(true, true, false, false)] // controlled pet
[InlineData(true, true, true, true)] // controlled summon, SummonEnd on the wire
@ -473,7 +458,8 @@ public class BaseCreatureSerializationTests : IDisposable
Assert.Equal(controlled, copy.Controlled);
Assert.Equal(summoned, copy.Summoned);
Assert.Equal(hasControlMaster ? master : null, copy.ControlMaster);
Assert.Equal(hasSummonMaster ? master : null, copy.SummonMaster);
Assert.Equal(master, copy.Master);
Assert.Equal(summoned ? master : null, copy.SummonMaster);
if (summoned)
{

150
Projects/UOContent.Tests/Tests/Mobiles/MasterViewsTests.cs Normal file
View file

@ -0,0 +1,150 @@
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);
}
}