## 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
113 lines
3.7 KiB
C#
113 lines
3.7 KiB
C#
using System;
|
|
using System.Collections.Generic;
|
|
using Server;
|
|
using Server.Mobiles;
|
|
using Xunit;
|
|
|
|
namespace UOContent.Tests.Mobiles.AI;
|
|
|
|
[Collection("Sequential UOContent Tests")]
|
|
public class SummonAcquireRulesTests : IDisposable
|
|
{
|
|
private readonly List<Mobile> _created = [];
|
|
private readonly Expansion _previous = Core.Expansion;
|
|
|
|
private PlayerMobile Player(Map map, int x, int intel)
|
|
{
|
|
var player = new PlayerMobile { Player = true, RawInt = intel };
|
|
player.MoveToWorld(new Point3D(x, 1600, map.GetAverageZ(x, 1600)), map);
|
|
_created.Add(player);
|
|
return player;
|
|
}
|
|
|
|
private BaseCreature Summon(BaseCreature summon, Mobile caster, int x)
|
|
{
|
|
_created.Add(summon);
|
|
summon.Summoned = true;
|
|
summon.Master = caster;
|
|
summon.MoveToWorld(new Point3D(x, 1600, caster.Map.GetAverageZ(x, 1600)), caster.Map);
|
|
summon.AIObject.AITimer.Stop();
|
|
return summon;
|
|
}
|
|
|
|
private static bool Acquire(BaseCreature creature)
|
|
{
|
|
creature.NextReacquireTime = Core.TickCount - 1;
|
|
return creature.AIObject.AcquireFocusMob(creature.RangePerception, creature.FightMode, false, false, true);
|
|
}
|
|
|
|
[SkippableTheory]
|
|
[InlineData(true)]
|
|
[InlineData(false)]
|
|
public void PreAosFeluccaVortexTurnsOnItsCaster(bool bladeSpirits)
|
|
{
|
|
Skip.If(!Server.Tests.TestServerInitializer.TileDataLoaded, "Requires UO client map data.");
|
|
Core.Expansion = Expansion.UOR;
|
|
|
|
var caster = Player(Map.Felucca, 1500, 100);
|
|
var summon = Summon(bladeSpirits ? new BladeSpirits() : new EnergyVortex(), caster, 1499);
|
|
|
|
Assert.True(Acquire(summon));
|
|
Assert.Same(caster, summon.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void PreAosFeluccaVortexPrefersAnyoneOverItsCaster()
|
|
{
|
|
Skip.If(!Server.Tests.TestServerInitializer.TileDataLoaded, "Requires UO client map data.");
|
|
Core.Expansion = Expansion.UOR;
|
|
|
|
// The caster outranks the bystander on the vortex's int-over-distance ranking.
|
|
var caster = Player(Map.Felucca, 1500, 100);
|
|
var bystander = Player(Map.Felucca, 1496, 10);
|
|
var vortex = Summon(new EnergyVortex(), caster, 1499);
|
|
|
|
Assert.True(Acquire(vortex));
|
|
Assert.Same(bystander, vortex.FocusMob);
|
|
}
|
|
|
|
[SkippableTheory]
|
|
[InlineData(Expansion.UOR, 1)] // Trammel
|
|
[InlineData(Expansion.AOS, 0)] // Felucca
|
|
public void VortexSparesItsCasterOutsidePreAosFelucca(Expansion expansion, int mapIndex)
|
|
{
|
|
Skip.If(!Server.Tests.TestServerInitializer.TileDataLoaded, "Requires UO client map data.");
|
|
Core.Expansion = expansion;
|
|
|
|
var caster = Player(Map.Maps[mapIndex], 1500, 100);
|
|
var vortex = Summon(new EnergyVortex(), caster, 1499);
|
|
|
|
Assert.False(Acquire(vortex));
|
|
Assert.Null(vortex.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void MasterlessSummonDoesNotBreakAcquisition()
|
|
{
|
|
Skip.If(!Server.Tests.TestServerInitializer.TileDataLoaded, "Requires UO client map data.");
|
|
Core.Expansion = Expansion.AOS;
|
|
|
|
var player = Player(Map.Felucca, 1500, 100);
|
|
var hunter = new PetTestStub();
|
|
_created.Add(hunter);
|
|
hunter.MoveToWorld(new Point3D(1499, 1600, player.Z), player.Map);
|
|
hunter.AIObject.AITimer.Stop();
|
|
|
|
var masterless = new PetTestStub { Summoned = true };
|
|
_created.Add(masterless);
|
|
masterless.MoveToWorld(new Point3D(1498, 1600, player.Z), player.Map);
|
|
masterless.AIObject.AITimer.Stop();
|
|
|
|
Assert.True(Acquire(hunter));
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
Core.Expansion = _previous;
|
|
|
|
foreach (var mobile in _created)
|
|
{
|
|
mobile.Delete();
|
|
}
|
|
}
|
|
}
|