fix: Optimizes FindItemsByType by removing allocations. (#1515)

### Summary
Container enumeration is in dire need of optimization. Thanks to @stefanomerotta for initiating this work with PR #1443. This PR handles a small part of what Stefan started. Also included are some bug fixes.

### Method Signatures

```cs
// Use with foreach without moving/deleting items
FindItemsByTypeEnumerator<T> FindItemsByType<T>(bool recurse = true, Predicate<T> predicate = null)

// Use with foreach when moving/deleting items
QueuedItemsEnumerator<T> EnumerateItemsByType<T>(bool recurse = true, Predicate<T> predicate = null)

// Use when iterating multiple times or queuing
PooledRefQueue<T> QueueItemsByType<T>(bool recurse = true, Predicate<T> predicate = null)

// Use when iterating multiples times or manipulating elements without traversing
PooledRefList<T> ListItemsByType<T>(bool recurse = true, Predicate<T> predicate = null)
```

* `FindItemsByType<T>` has changed from returning `List<T>` to `FindItemsByTypeEnumerator<T>` - This method is not safe to use in situations where an item may get consumed, deleted, or moved.

* `EnumerateItemsByType<T>` was added as a safe way to iterate and manipulate items.
  * **Note**: EnumerateItemsByType will _completely traverse the container_ before iteration starts because it uses `QueueItemsByType` under the hood.

* `QueueItemsByType<T>`  and `ListItemsByType<T>` was added to return a queue or list of items to iterate multiple times and manipulate the items. This isn't the most efficient since it uses a predicate and can result in 2 or 3 total iterations unnecessarily.

### Bug Fixes
- [X] Fishing had an error in the random check that may have caused slight bias.
This commit is contained in:
Kamron Batman 2023-09-28 19:36:45 -07:00 • committed by GitHub
parent 146abad36e
commit a4cabe2fa4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 655 additions and 390 deletions

View file

@ -1,6 +1,7 @@
using System;
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Collections;
using Server.Engines.Plants;
using Server.Engines.Quests;
using Server.Engines.Quests.Hag;
@ -662,15 +663,15 @@ public abstract partial class BaseBeverage : Item, IHasQuantity
public static bool ConsumeTotal(Container pack, Type itemType, BeverageType content, int quantity)
{
var items = pack.FindItemsByType(itemType);
var total = 0;
using var queue = PooledRefQueue<BaseBeverage>.Create();
// First pass, compute total
var total = 0;
for (var i = 0; i < items.Count; ++i)
foreach (var bev in pack.FindItemsByType<BaseBeverage>())
{
if (items[i] is BaseBeverage bev && bev.Content == content && !bev.IsEmpty)
if (itemType.IsInstanceOfType(bev) && bev.Content == content && !bev.IsEmpty)
{
queue.Enqueue(bev);
total += bev.Quantity;
}
}
@ -681,12 +682,9 @@ public abstract partial class BaseBeverage : Item, IHasQuantity
var need = quantity;
for (var i = 0; i < items.Count; ++i)
while (queue.Count > 0)
{
if (items[i] is not BaseBeverage bev || bev.Content != content || bev.IsEmpty)
{
continue;
}
var bev = queue.Dequeue();
var theirQuantity = bev.Quantity;