ModernUO/Projects/UOContent/Mobiles/Animals/Misc/PackHorse.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

189 lines
5.1 KiB
C#

using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Items;
namespace Server.Mobiles
{
[SerializationGenerator(0, false)]
public partial class PackHorse : BaseCreature
{
[Constructible]
public PackHorse() : base(AIType.AI_Animal, FightMode.Aggressor)
{
Body = 291;
BaseSoundID = 0xA8;
SetStr(44, 120);
SetDex(36, 55);
SetInt(6, 10);
SetHits(61, 80);
SetStam(81, 100);
SetMana(0);
SetDamage(5, 11);
SetDamageType(ResistanceType.Physical, 100);
SetResistance(ResistanceType.Physical, 20, 25);
SetResistance(ResistanceType.Fire, 10, 15);
SetResistance(ResistanceType.Cold, 20, 25);
SetResistance(ResistanceType.Poison, 10, 15);
SetResistance(ResistanceType.Energy, 10, 15);
SetSkill(SkillName.MagicResist, 25.1, 30.0);
SetSkill(SkillName.Tactics, 29.3, 44.0);
SetSkill(SkillName.Wrestling, 29.3, 44.0);
Fame = 0;
Karma = 200;
VirtualArmor = 16;
Tamable = true;
ControlSlots = 1;
MinTameSkill = 11.1;
var pack = Backpack;
pack?.Delete();
pack = new StrongBackpack();
pack.Movable = false;
AddItem(pack);
}
public override string CorpseName => "a horse corpse";
public override string DefaultName => "a pack horse";
public override int Meat => 3;
public override int Hides => 10;
public override FoodType FavoriteFood => FoodType.FruitsAndVeggies | FoodType.GrainsAndHay;
public override bool OnBeforeDeath()
{
if (!base.OnBeforeDeath())
{
return false;
}
PackAnimal.CombineBackpacks(this);
return true;
}
public override DeathMoveResult GetInventoryMoveResultFor(Item item) => DeathMoveResult.MoveToCorpse;
public override bool IsSnoop(Mobile from) => !PackAnimal.CheckAccess(this, from) && base.IsSnoop(from);
public override bool OnDragDrop(Mobile from, Item item)
{
if (CheckFeed(from, item))
{
return true;
}
if (PackAnimal.CheckAccess(this, from))
{
AddToBackpack(item);
return true;
}
return base.OnDragDrop(from, item);
}
public override bool CheckNonlocalDrop(Mobile from, Item item, Item target) => PackAnimal.CheckAccess(this, from);
public override bool CheckNonlocalLift(Mobile from, Item item) => PackAnimal.CheckAccess(this, from);
public override void OnDoubleClick(Mobile from)
{
PackAnimal.TryPackOpen(this, from);
}
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, ref list);
PackAnimal.GetContextMenuEntries(this, from, ref list);
}
}
public class PackAnimalBackpackEntry : ContextMenuEntry
{
public PackAnimalBackpackEntry(bool enabled) : base(6145, 3) => Enabled = enabled;
public override void OnClick(Mobile from, IEntity target)
{
if (target is BaseCreature bc)
{
PackAnimal.TryPackOpen(bc, from);
}
}
}
public static class PackAnimal
{
public static void GetContextMenuEntries(BaseCreature animal, Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
if (CheckAccess(animal, from))
{
list.Add(new PackAnimalBackpackEntry(!animal.IsDeadPet));
}
}
public static bool CheckAccess(BaseCreature animal, Mobile from) =>
from == animal || from.AccessLevel >= AccessLevel.GameMaster || from.Alive && animal.Controlled &&
!animal.IsDeadPet &&
(from == animal.GetMaster() || animal.IsPetFriend(from));
public static void CombineBackpacks(BaseCreature animal)
{
if (Core.AOS)
{
return;
}
if (animal.IsBonded || animal.IsDeadPet)
{
return;
}
var pack = animal.Backpack;
if (pack != null)
{
var newPack = new Backpack();
for (var i = pack.Items.Count - 1; i >= 0; --i)
{
if (i >= pack.Items.Count)
{
continue;
}
newPack.DropItem(pack.Items[i]);
}
pack.DropItem(newPack);
}
}
public static void TryPackOpen(BaseCreature animal, Mobile from)
{
if (animal.IsDeadPet)
{
return;
}
var item = animal.Backpack;
if (item != null)
{
from.Use(item);
}
}
}
}