ModernUO/Projects/UOContent/Items/Containers/Container.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

566 lines
12 KiB
C#

using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Mobiles;
using Server.Multis;
using Server.Systems.FeatureFlags;
namespace Server.Items;
[ManualDirtyChecking]
public abstract class BaseContainer : Container
{
public BaseContainer(int itemID) : base(itemID)
{
}
public BaseContainer(Serial serial) : base(serial)
{
}
public override int DefaultMaxWeight => IsSecure ? 0 : base.DefaultMaxWeight;
public override void DisplayTo(Mobile to)
{
if (to.AccessLevel < FeatureFlagSettings.RequiredAccessLevel
&& FeatureFlagManager.IsItemUseBlocked(GetType(), out var reason))
{
to.SendMessage(0x22, reason);
return;
}
base.DisplayTo(to);
}
public override bool IsAccessibleTo(Mobile m) => BaseHouse.CheckAccessible(m, this) && base.IsAccessibleTo(m);
public override bool CheckHold(Mobile m, Item item, bool message, bool checkItems, int plusItems, int plusWeight)
{
if (IsSecure && !BaseHouse.CheckHold(m, this, item, message, checkItems, plusItems, plusWeight))
{
return false;
}
return base.CheckHold(m, item, message, checkItems, plusItems, plusWeight);
}
public override bool CheckItemUse(Mobile from, Item item)
{
if (IsDecoContainer && item is BaseBook)
{
return true;
}
return base.CheckItemUse(from, item);
}
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, ref list);
SetSecureLevelEntry.AddTo(from, this, ref list);
}
public override bool TryDropItem(Mobile from, Item dropped, bool sendFullMessage)
{
if (!CheckHold(from, dropped, sendFullMessage, true))
{
return false;
}
var house = BaseHouse.FindHouseAt(this);
if (house?.HasLockedDownItem(this) == true)
{
if (dropped is VendorRentalContract || dropped is Container container &&
container.FindItemByType<VendorRentalContract>() != null)
{
from.SendLocalizedMessage(1062492); // You cannot place a rental contract in a locked down container.
return false;
}
if (!house.LockDown(from, dropped, false))
{
return false;
}
}
var list = Items;
for (var i = 0; i < list.Count; ++i)
{
var item = list[i];
if (item is not Container && item.StackWith(from, dropped, false))
{
return true;
}
}
DropItem(dropped);
return true;
}
public override bool OnDragDropInto(Mobile from, Item item, Point3D p)
{
if (!CheckHold(from, item, true, true))
{
return false;
}
var house = BaseHouse.FindHouseAt(this);
if (house?.HasLockedDownItem(this) == true)
{
if (item is VendorRentalContract || item is Container container &&
container.FindItemByType<VendorRentalContract>() != null)
{
from.SendLocalizedMessage(1062492); // You cannot place a rental contract in a locked down container.
return false;
}
if (!house.LockDown(from, item, false))
{
return false;
}
}
item.Location = new Point3D(p.X, p.Y, 0);
AddItem(item);
from.SendSound(GetDroppedSound(item), GetWorldLocation());
return true;
}
public override void UpdateTotal(Item sender, TotalType type, int delta)
{
base.UpdateTotal(sender, type, delta);
if (type == TotalType.Weight)
{
(RootParent as Mobile)?.InvalidateProperties();
}
}
public override void OnDoubleClick(Mobile from)
{
if (from.AccessLevel > AccessLevel.Player || from.InRange(GetWorldLocation(), 2) || RootParent is PlayerVendor)
{
Open(from);
}
else
{
from.LocalOverheadMessage(MessageType.Regular, 0x3B2, 1019045); // I can't reach that.
}
}
public virtual void Open(Mobile from)
{
DisplayTo(from);
}
/* Note: base class insertion; we cannot serialize anything here */
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
}
}
[SerializationGenerator(0, false)]
public partial class CreatureBackpack : Backpack // Used on BaseCreature
{
[Constructible]
public CreatureBackpack(string name)
{
Name = name;
Layer = Layer.Backpack;
Hue = 5;
}
public override double DefaultWeight => 3.0;
public override void AddNameProperty(IPropertyList list)
{
if (Name != null)
{
list.Add(1075257, Name); // Contents of ~1_PETNAME~'s pack.
}
else
{
base.AddNameProperty(list);
}
}
public override void OnItemRemoved(Item item)
{
if (Items.Count == 0)
{
Delete();
}
base.OnItemRemoved(item);
}
public override bool OnDragLift(Mobile from)
{
if (from.AccessLevel > AccessLevel.Player)
{
return true;
}
from.SendLocalizedMessage(500169); // You cannot pick that up.
return false;
}
public override bool OnDragDropInto(Mobile from, Item item, Point3D p) => false;
public override bool TryDropItem(Mobile from, Item dropped, bool sendFullMessage) => false;
}
[SerializationGenerator(0, false)]
public partial class StrongBackpack : Backpack // Used on Pack animals
{
[Constructible]
public StrongBackpack() => Layer = Layer.Backpack;
public override double DefaultWeight => 13.0;
public override int DefaultMaxWeight => 1600;
public override bool CheckHold(Mobile m, Item item, bool message, bool checkItems, int plusItems, int plusWeight) =>
base.CheckHold(m, item, false, checkItems, plusItems, plusWeight);
public override bool CheckContentDisplay(Mobile from) =>
RootParent is BaseCreature creature && creature.ControlMaster == from ||
base.CheckContentDisplay(from);
}
[SerializationGenerator(0, false)]
public partial class Backpack : BaseContainer, IDyable
{
[Constructible]
public Backpack() : base(0xE75) => Layer = Layer.Backpack;
public override double DefaultWeight => 3.0;
public override int DefaultMaxWeight
{
get
{
if (Core.ML && Parent is Mobile m && m.Player && m.Backpack == this)
{
return 550;
}
return base.DefaultMaxWeight;
}
}
public bool Dye(Mobile from, DyeTub sender)
{
if (Deleted)
{
return false;
}
Hue = sender.DyedHue;
return true;
}
}
[SerializationGenerator(0, false)]
public partial class Pouch : TrappableContainer
{
[Constructible]
public Pouch() : base(0xE79)
{
}
public override double DefaultWeight => 1.0;
}
[SerializationGenerator(0, false)]
public abstract partial class BaseBagBall : BaseContainer, IDyable
{
public BaseBagBall(int itemID) : base(itemID)
{
}
public override double DefaultWeight => 1.0;
public bool Dye(Mobile from, DyeTub sender)
{
if (Deleted)
{
return false;
}
Hue = sender.DyedHue;
return true;
}
}
[SerializationGenerator(0, false)]
public partial class SmallBagBall : BaseBagBall
{
[Constructible]
public SmallBagBall() : base(0x2256)
{
}
}
[SerializationGenerator(0, false)]
public partial class LargeBagBall : BaseBagBall
{
[Constructible]
public LargeBagBall() : base(0x2257)
{
}
}
[SerializationGenerator(0, false)]
public partial class Bag : BaseContainer, IDyable
{
[Constructible]
public Bag() : base(0xE76)
{
}
public override double DefaultWeight => 2.0;
public bool Dye(Mobile from, DyeTub sender)
{
if (Deleted)
{
return false;
}
Hue = sender.DyedHue;
return true;
}
}
[SerializationGenerator(0, false)]
public partial class Barrel : BaseContainer
{
[Constructible]
public Barrel() : base(0xE77)
{
}
public override double DefaultWeight => 25.0;
}
[SerializationGenerator(0, false)]
public partial class Keg : BaseContainer
{
[Constructible]
public Keg() : base(0xE7F)
{
}
public override double DefaultWeight => 15.0;
}
[SerializationGenerator(0, false)]
public partial class PicnicBasket : BaseContainer
{
[Constructible]
public PicnicBasket() : base(0xE7A)
{
}
public override double DefaultWeight => 2.0;
}
[SerializationGenerator(0, false)]
public partial class Basket : BaseContainer
{
[Constructible]
public Basket() : base(0x990)
{
}
public override double DefaultWeight => 1.0;
}
[Furniture]
[Flippable(0x9AA, 0xE7D)]
[SerializationGenerator(0, false)]
public partial class WoodenBox : LockableContainer
{
[Constructible]
public WoodenBox() : base(0x9AA)
{
}
public override double DefaultWeight => 4.0;
}
[Furniture]
[Flippable(0x9A9, 0xE7E)]
[SerializationGenerator(0, false)]
public partial class SmallCrate : LockableContainer
{
[Constructible]
public SmallCrate() : base(0x9A9)
{
}
public override double DefaultWeight => 2.0;
}
[Furniture]
[Flippable(0xE3F, 0xE3E)]
[SerializationGenerator(0, false)]
public partial class MediumCrate : LockableContainer
{
[Constructible]
public MediumCrate() : base(0xE3F)
{
}
public override double DefaultWeight => 2.0;
}
[Furniture]
[Flippable(0xE3D, 0xE3C)]
[SerializationGenerator(0, false)]
public partial class LargeCrate : LockableContainer
{
[Constructible]
public LargeCrate() : base(0xE3D)
{
}
public override double DefaultWeight => 1.0;
}
[DynamicFlipping]
[Flippable(0x9A8, 0xE80)]
[SerializationGenerator(0, false)]
public partial class MetalBox : LockableContainer
{
[Constructible]
public MetalBox() : base(0x9A8)
{
}
}
[DynamicFlipping]
[Flippable(0x9AB, 0xE7C)]
[SerializationGenerator(0, false)]
public partial class MetalChest : LockableContainer
{
[Constructible]
public MetalChest() : base(0x9AB)
{
}
}
[DynamicFlipping, Flippable(0xE41, 0xE40)]
[SerializationGenerator(0, false)]
public partial class MetalGoldenChest : LockableContainer
{
[Constructible]
public MetalGoldenChest() : base(0xE41)
{
}
}
[Furniture]
[Flippable(0xe43, 0xe42)]
[SerializationGenerator(0, false)]
public partial class WoodenChest : LockableContainer
{
[Constructible]
public WoodenChest() : base(0xe43)
{
}
public override double DefaultWeight => 2.0;
}
[Furniture]
[Flippable(0x280B, 0x280C)]
[SerializationGenerator(0, false)]
public partial class PlainWoodenChest : LockableContainer
{
[Constructible]
public PlainWoodenChest() : base(0x280B)
{
}
}
[Furniture]
[Flippable(0x280D, 0x280E)]
[SerializationGenerator(0, false)]
public partial class OrnateWoodenChest : LockableContainer
{
[Constructible]
public OrnateWoodenChest() : base(0x280D)
{
}
}
[Furniture]
[Flippable(0x280F, 0x2810)]
[SerializationGenerator(0, false)]
public partial class GildedWoodenChest : LockableContainer
{
[Constructible]
public GildedWoodenChest() : base(0x280F)
{
}
}
[Furniture]
[Flippable(0x2811, 0x2812)]
[SerializationGenerator(0, false)]
public partial class WoodenFootLocker : LockableContainer
{
[Constructible]
public WoodenFootLocker() : base(0x2811) => GumpID = 0x10B;
}
[Furniture]
[Flippable(0x2813, 0x2814)]
[SerializationGenerator(0, false)]
public partial class FinishedWoodenChest : LockableContainer
{
[Constructible]
public FinishedWoodenChest() : base(0x2813)
{
}
}
[Furniture]
[SerializationGenerator(0)]
[Flippable(0x2DF1, 0x2DF2)]
public partial class RarewoodChest : LockableContainer
{
[Constructible]
public RarewoodChest() : base(0x2DF1)
{
}
}
[Furniture]
[SerializationGenerator(0)]
[Flippable(0x2DF3, 0x2DF4)]
public partial class DecorativeBox : LockableContainer
{
[Constructible]
public DecorativeBox() : base(0x2DF4)
{
}
}