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

@ -141,11 +141,12 @@ namespace Server.Engines.Craft
if (from.Backpack != null)
{
var items = from.Backpack.FindItemsByType(resourceType);
for (var i = 0; i < items.Count; ++i)
foreach (var item in from.Backpack.FindItemsByType())
{
resourceCount += items[i].Amount;
if (resourceType.IsInstanceOfType(item))
{
resourceCount += item.Amount;
}
}
}
@ -185,11 +186,12 @@ namespace Server.Engines.Craft
if (from.Backpack != null)
{
var items = from.Backpack.FindItemsByType(resourceType);
for (var i = 0; i < items.Count; ++i)
foreach (var item in from.Backpack.FindItemsByType())
{
resourceCount += items[i].Amount;
if (resourceType.IsInstanceOfType(item))
{
resourceCount += item.Amount;
}
}
}
@ -263,11 +265,13 @@ namespace Server.Engines.Craft
if (from.Backpack != null)
{
var items = from.Backpack.FindItemsByType(subResource.ItemType);
for (var j = 0; j < items.Count; ++j)
var type = subResource.ItemType;
foreach (var item in from.Backpack.FindItemsByType())
{
resourceCount += items[j].Amount;
if (type.IsInstanceOfType(item))
{
resourceCount += item.Amount;
}
}
}

View file

@ -685,7 +685,14 @@ namespace Server.Engines.Craft
if (NameNumber == 1041267)
{
// Runebooks are a special case, they need a blank recall rune
consumeExtra = ourPack.FindItemsByType<RecallRune>().Find(rune => !rune.Marked);
foreach (var rune in ourPack.FindItemsByType<RecallRune>())
{
if (!rune.Marked)
{
consumeExtra = rune;
break;
}
}
if (consumeExtra == null)
{