ModernUO/Projects/UOContent/Items/Aquarium/FishBowl.cs
Kamron Batman a2c232f4a8
fix: Removes side effects from locked down items, decaying houses, bracelet of binding, and builds (#2608)
## Why

Delta world saves (only changed entities re-serialized during the freeze) need two things from content: `Serialize` must be pure, and an unchanged entity must produce identical bytes on every save. An audit of the tree found the places that break this today. This PR fixes them and adds a diagnostic that measures byte stability in a running world over real time. No wire format changes, no version bumps.

## What

- **Guild**: `Serialize` ran the daily guildmaster recalculation (dictionary-order tie breaks, random picks, mutates another entity), war expiry, and the alliance leadership check on every save. That work now runs from `GuildMaintenanceTimer` (the former `WarTimer`, now started for both guild systems; the war and alliance checks are no-ops without the new guild system).
- **BaseHouse**: the `DecayLevel` getter wrote `LastRefreshed` and advanced the dynamic decay stage on every read, so any undecayable house changed its persisted bytes whenever a sign, gump, or `[Props` looked at it. It is now a pure read; `UpdateDecay()` on the decay tick advances the stage and refreshes a house that leaves the undecayable state.
- **Locked-down container contents decay through `DecayScheduler`** instead of a sweep inside `BaseHouse.Serialize`. `Item.CanDecay` now accepts a parent container whose new `Container.ContentsDecay` is true (locked down and not secure) when the content item is not itself locked down or secured; the `IsLockedDown`/`IsSecure` setters re-evaluate a container and its direct contents; `OnDecay` resolves the region from the world location. `BaseBoard`, `Aquarium` and `FishBowl` override `ContentsDecay` to false, matching the exclusions of the old sweep. Items already inside such containers are picked up at load, where every item re-evaluates its registration. The per-save O(all locked-down items) walk is gone; the work is now event driven.
- **BraceletOfBinding**: the `Bound` getter nulled its backing field for a deleted target; it now returns null for a missing or deleted target without writing.
- **`[SaveStability [delaySeconds=60] [sampleStride=1]`** (Administrator): hashes the serialized bytes of every entity in every registered entity persistence (`Persistence.EntityPersistences`, new), waits the delay in real time, hashes again, and reports per type how many records changed. Both passes are chunked under a 20 ms per-tick budget. Serializing twice inside one tick cannot see drift derived from `Core.Now`, which is frozen within a tick; the real-time wait is the point. On an idle shard the only legitimate churn is NPC movement and regeneration, so a static type with a high changed fraction is a serialization bug. `[SaveStability cancel` stops a run.

Engine additions: `Container.ContentsDecay` / `UpdateContentsDecayRegistration()`, the `CanDecay`/`OnDecay` change above, and diagnostic-facing `IGenericEntityPersistence.Name`, `EntityCount`, `EnumerateEntities()`, and `Persistence.EntityPersistences`.

## Behaviour notes

- Fealty recalculation now happens on the minute timer for both guild systems instead of at save time.
- A house that becomes decayable is refreshed on its next decay tick rather than at the exact moment of transition (at most one minute later).
- Contents of locked-down containers now decay on their own schedule (same `LastMoved + DecayTime` rule) instead of at the next world save after becoming due.

## Testing

- New tests: `GuildSerializePurityTests`, `HouseDecayPurityTests`, `SaveStabilityTests` (stable entities hash identically after the clock advances; a clock-stamped record is reported by type only after the clock advances; the snapshot covers Items, Mobiles and Guilds).
- `LockedDownContainerDecayTests` (Server.Tests): registration on drop, lock/secure/release transitions, excluded containers, nested containers, and decay on schedule through the scheduler.
- Full suites: Server.Tests 855 passed, UOContent.Tests 765 passed.
2026-09-06 09:39:00 -07:00

145 lines
4.1 KiB
C#

using ModernUO.Serialization;
using Server.Collections;
using Server.ContextMenus;
using Server.Network;
namespace Server.Items
{
[SerializationGenerator(0, false)]
public partial class FishBowl : BaseContainer
{
public override bool ContentsDecay => false; // the fish is part of the bowl
[Constructible]
public FishBowl() : base(0x241C)
{
Hue = 0x47E;
MaxItems = 1;
}
public override int LabelNumber => 1074499; // A fish bowl
[CommandProperty(AccessLevel.GameMaster)]
public bool Empty => Items.Count == 0;
[CommandProperty(AccessLevel.GameMaster)]
public BaseFish Fish => Empty ? null : Items[0] as BaseFish;
public override double DefaultWeight => 2.0;
public override void OnDoubleClick(Mobile from)
{
}
public override bool TryDropItem(Mobile from, Item dropped, bool sendFullMessage)
{
if (!CheckHold(from, dropped, sendFullMessage, true))
{
return false;
}
DropItem(dropped);
return true;
}
public override bool OnDragDrop(Mobile from, Item dropped)
{
if (!IsAccessibleTo(from))
{
from.SendLocalizedMessage(502436); // That is not accessible.
return false;
}
if (!(dropped is BaseFish))
{
from.SendLocalizedMessage(1074836); // The container can not hold that type of object.
return false;
}
if (base.OnDragDrop(from, dropped))
{
((BaseFish)dropped).StopTimer();
InvalidateProperties();
return true;
}
return false;
}
public override bool CheckItemUse(Mobile from, Item item) => item == this && base.CheckItemUse(from, item);
public override bool CheckLift(Mobile from, Item item, ref LRReason reject)
{
if (item != this)
{
reject = LRReason.CannotLift;
return false;
}
return base.CheckLift(from, item, ref reject);
}
public override void AddNameProperties(IPropertyList list)
{
base.AddNameProperties(list);
if (!Empty)
{
var fish = Fish;
if (fish != null)
{
list.AddLocalized(1074494, fish.LabelNumber); // Contains: ~1_CREATURE~
}
}
}
public override void GetContextMenuEntries(Mobile from, ref PooledRefList<ContextMenuEntry> list)
{
base.GetContextMenuEntries(from, ref list);
if (!Empty && IsAccessibleTo(from))
{
list.Add(new RemoveCreature());
}
}
private class RemoveCreature : ContextMenuEntry
{
public RemoveCreature() : base(6242, 3)
{
}
public override void OnClick(Mobile from, IEntity target)
{
if (target is not FishBowl { Deleted: false } bowl || !bowl.IsAccessibleTo(from))
{
return;
}
var fish = bowl.Fish;
if (fish == null)
{
return;
}
if (fish.IsLockedDown) // for legacy fish bowls
{
from.SendLocalizedMessage(1010449); // You may not use this object while it is locked down.
}
else if (!from.PlaceInBackpack(fish))
{
from.SendLocalizedMessage(1074496); // There is no room in your pack for the creature.
}
else
{
from.SendLocalizedMessage(1074495); // The creature has been removed from the fish bowl.
fish.StartTimer();
bowl.InvalidateProperties();
}
}
}
}
}