## 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
226 lines
7.9 KiB
C#
226 lines
7.9 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 GuardFriendlyFireTests : IDisposable
|
|
{
|
|
private readonly List<Mobile> _created = [];
|
|
|
|
private (PlayerMobile owner, PetTestStub pet) Spawn()
|
|
{
|
|
Skip.If(!Server.Tests.TestServerInitializer.TileDataLoaded, "Requires UO client map data.");
|
|
var z = Map.Felucca.GetAverageZ(1500, 1600);
|
|
var owner = new PlayerMobile();
|
|
owner.MoveToWorld(new Point3D(1500, 1600, z), Map.Felucca);
|
|
_created.Add(owner);
|
|
var pet = OtherPet(owner, new Point3D(1499, 1600, z));
|
|
pet.IssueOrder(OrderType.Guard, owner);
|
|
pet.AIObject.AITimer.Stop();
|
|
return (owner, pet);
|
|
}
|
|
|
|
private PetTestStub OtherPet(PlayerMobile owner, Point3D location)
|
|
{
|
|
var pet = new PetTestStub();
|
|
pet.MoveToWorld(location, owner.Map);
|
|
pet.SetControlMaster(owner);
|
|
pet.AIObject.AITimer.Stop();
|
|
_created.Add(pet);
|
|
return pet;
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardFallbackDoesNotAcquireItsOwner()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
Assert.Null(pet.ControlTarget); // speech dispatch clears this; guard must not fall through to wild acquisition.
|
|
Assert.True(pet.CanSee(owner));
|
|
Assert.True(pet.InLOS(owner));
|
|
pet.NextReacquireTime = Core.TickCount - 1;
|
|
Assert.False(pet.AIObject.AcquireFocusMob(pet.RangePerception, pet.FightMode, false, false, true));
|
|
Assert.Null(pet.FocusMob);
|
|
Assert.Null(pet.Combatant);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardDropsStaleCombatAgainstAnotherPetOfItsOwner()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
var sibling = OtherPet(owner, new Point3D(1498, 1600, owner.Z));
|
|
pet.IssueOrder(OrderType.Attack, owner, sibling);
|
|
Assert.Same(sibling, pet.Combatant);
|
|
pet.IssueOrder(OrderType.Guard, owner);
|
|
pet.AIObject.DoOrderGuard();
|
|
Assert.Null(pet.Combatant);
|
|
Assert.Null(pet.FocusMob);
|
|
Assert.Equal(OrderType.Guard, pet.ControlOrder);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardDoesNotRetaliateAgainstOwnerFriendlyDamage()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
pet.AggressiveAction(owner, false);
|
|
Assert.Null(pet.Combatant);
|
|
Assert.Equal(OrderType.Guard, pet.ControlOrder);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardDoesNotRetaliateAgainstSiblingFriendlyDamage()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
var sibling = OtherPet(owner, new Point3D(1498, 1600, owner.Z));
|
|
pet.AggressiveAction(sibling, false);
|
|
Assert.Null(pet.Combatant);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardReacquiresAnEnemyAttackingItsOwner()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
var enemy = new PetTestStub();
|
|
_created.Add(enemy);
|
|
enemy.MoveToWorld(new Point3D(1498, 1600, owner.Z), owner.Map);
|
|
enemy.AIObject.AITimer.Stop();
|
|
enemy.Combatant = owner;
|
|
Assert.Same(owner, enemy.Combatant);
|
|
Assert.True(pet.AIObject.AcquireFocusMob(10, pet.FightMode, false, false, true));
|
|
Assert.Same(enemy, pet.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardStillDefendsAgainstAnotherPlayersPet()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
var enemyOwner = new PlayerMobile();
|
|
_created.Add(enemyOwner);
|
|
enemyOwner.MoveToWorld(new Point3D(1497, 1600, owner.Z), owner.Map);
|
|
var enemy = OtherPet(enemyOwner, new Point3D(1498, 1600, owner.Z));
|
|
enemy.IssueOrder(OrderType.Attack, enemyOwner, owner);
|
|
Assert.True(pet.AIObject.AcquireFocusMob(10, pet.FightMode, false, false, true));
|
|
Assert.Same(enemy, pet.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardIgnoresSiblingInOwnersAggressorHistory()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
var sibling = OtherPet(owner, new Point3D(1498, 1600, owner.Z));
|
|
owner.AggressiveAction(sibling, false);
|
|
Assert.Contains(owner.Aggressors, entry => entry.Attacker == sibling);
|
|
Assert.False(pet.AIObject.AcquireFocusMob(10, pet.FightMode, false, false, true));
|
|
Assert.Null(pet.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardIgnoresOwnControlledSummonAttackingOwner()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
var summon = OtherPet(owner, new Point3D(1498, 1600, owner.Z));
|
|
summon.Summoned = true;
|
|
summon.Master = owner;
|
|
summon.Combatant = owner;
|
|
Assert.Same(owner, summon.Combatant);
|
|
pet.AggressiveAction(summon, false);
|
|
Assert.Null(pet.Combatant);
|
|
Assert.False(pet.AIObject.AcquireFocusMob(10, pet.FightMode, false, false, true));
|
|
Assert.Null(pet.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void GuardDefendsAgainstOwnUncontrolledSummonAttackingOwner()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
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();
|
|
vortex.Combatant = owner;
|
|
Assert.Same(owner, vortex.Combatant);
|
|
Assert.True(pet.AIObject.AcquireFocusMob(10, pet.FightMode, false, false, true));
|
|
Assert.Same(vortex, pet.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void FriendlyDamageDoesNotInterruptGuardCombat()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
var enemy = new PetTestStub();
|
|
_created.Add(enemy);
|
|
enemy.MoveToWorld(new Point3D(1496, 1600, owner.Z), owner.Map);
|
|
enemy.AIObject.AITimer.Stop();
|
|
pet.Combatant = enemy;
|
|
pet.AggressiveAction(owner, false);
|
|
Assert.Same(enemy, pet.Combatant);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void ExplicitAttackStillAcquiresTheCommandedTarget()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
var sibling = OtherPet(owner, new Point3D(1498, 1600, owner.Z));
|
|
pet.IssueOrder(OrderType.Attack, owner, sibling);
|
|
Assert.True(pet.AIObject.AcquireFocusMob(10, pet.FightMode, false, false, true));
|
|
Assert.Same(sibling, pet.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void BardProvocationStillOverridesGuard()
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
pet.BardProvoked = true;
|
|
pet.BardTarget = owner;
|
|
Assert.True(pet.AIObject.AcquireFocusMob(10, pet.FightMode, false, false, true));
|
|
Assert.Same(owner, pet.FocusMob);
|
|
}
|
|
|
|
[SkippableTheory]
|
|
[InlineData(OrderType.Follow)]
|
|
[InlineData(OrderType.Come)]
|
|
[InlineData(OrderType.Stay)]
|
|
public void NonCombatOrdersDoNotAcquireTheirFriendlyTarget(OrderType order)
|
|
{
|
|
var (owner, pet) = Spawn();
|
|
pet.IssueOrder(order, owner, owner);
|
|
Assert.False(pet.AIObject.AcquireFocusMob(10, pet.FightMode, false, false, true));
|
|
Assert.Null(pet.FocusMob);
|
|
}
|
|
|
|
[SkippableFact]
|
|
public void ActualWhiteWyrmDoesNotTurnOnOwnerWhenEnemyDisappears()
|
|
{
|
|
var (owner, _) = Spawn();
|
|
var wyrm = new WhiteWyrm();
|
|
_created.Add(wyrm);
|
|
wyrm.MoveToWorld(new Point3D(1498, 1600, owner.Z), owner.Map);
|
|
wyrm.SetControlMaster(owner);
|
|
wyrm.IssueOrder(OrderType.Guard, owner);
|
|
wyrm.AIObject.AITimer.Stop();
|
|
var enemy = new PetTestStub();
|
|
_created.Add(enemy);
|
|
enemy.MoveToWorld(new Point3D(1497, 1600, owner.Z), owner.Map);
|
|
enemy.AIObject.AITimer.Stop();
|
|
wyrm.Combatant = enemy;
|
|
enemy.Hidden = true;
|
|
wyrm.NextReacquireTime = Core.TickCount - 1;
|
|
Assert.IsType<MageAI>(wyrm.AIObject);
|
|
wyrm.AIObject.DoActionCombat();
|
|
Assert.NotSame(owner, wyrm.Combatant);
|
|
Assert.Null(wyrm.FocusMob);
|
|
wyrm.AIObject.DoOrderGuard();
|
|
Assert.Null(wyrm.Combatant);
|
|
}
|
|
|
|
public void Dispose()
|
|
{
|
|
foreach (var mobile in _created)
|
|
{
|
|
mobile.Delete();
|
|
}
|
|
}
|
|
}
|