ModernUO/Projects/UOContent/Items/Skill Items/Misc/RecipeScroll.cs
Kamron Batman ecbee17690
fix: Optimizes OPL using string interpolation (#1041)
## Breaking Changes (New API)
ObjectPropertyList supports the following API:
```cs
list.Add(500000);
list.Add(500001, stringArgument);
list.Add("Some text");
list.Add($"Some text with {argument}");
list.Add(500002, $"{arg1}\t{arg2}");
```

## Notes
1. All API uses that require a formatter like this:
    ```cs
    list.Add(500002, "{0}\t{1}", arg1, arg2);
    ```
    Should be changed to use string interpolation, for example:
    ```cs
    list.Add(500002, $"{arg1}\t{arg2}");
    ```
2. The following paradigm should no longer be used:
    ```cs
    list.Add(1061170, prop.ToString()); // strength requirement ~1_val~
    ```
    The new string interpolation API will avoid having to convert the argument to a string before writing it to the packet. Instead use the following:
    ```cs
    list.Add(1061170, $"{prop}"); // strength requirement ~1_val~
    ```

### Benchmarks
```cs
|                         Method |     Mean |   Error |  StdDev |  Gen 0 | Allocated |
|------------------------------- |---------:|--------:|--------:|-------:|----------:|
|                BenchmarkOldOPL | 241.0 ns | 0.56 ns | 0.47 ns | 0.0105 |      88 B |
| BenchmarkStringInterpolatedOPL | 199.9 ns | 2.44 ns | 2.39 ns |      - |         - |
```

### Changes
- [X] Removes crash in STArray.Return when array is null.
- [X] Fixes NPE in OPL when entity is null. Serial in packet will be 0 when entity is null.
- [X] Fixes NPE in AosAttributes when Parent is null.
- [X] Changes OPL to use string interpolation.
- [X] Introduces `IPropertyList` to allow extending PropertyList for other uses.
2022-06-02 10:09:53 -07:00

120 lines
3.1 KiB
C#

using Server.Engines.Craft;
using Server.Mobiles;
using Server.Network;
namespace Server.Items
{
public class RecipeScroll : Item
{
private int m_RecipeID;
public RecipeScroll(Recipe r) : this(r.ID)
{
}
[Constructible]
public RecipeScroll(int recipeID) : base(0x2831) => m_RecipeID = recipeID;
public RecipeScroll(Serial serial)
: base(serial)
{
}
public override int LabelNumber => 1074560; // recipe scroll
[CommandProperty(AccessLevel.GameMaster)]
public int RecipeID
{
get => m_RecipeID;
set
{
m_RecipeID = value;
InvalidateProperties();
}
}
public Recipe Recipe
{
get
{
Recipe.Recipes.TryGetValue(m_RecipeID, out var recipe);
return recipe;
}
}
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
var r = Recipe;
if (r != null)
{
list.Add(1049644, $"{r.TextDefinition}"); // [~1_stuff~]
}
}
public override void OnDoubleClick(Mobile from)
{
if (!from.InRange(GetWorldLocation(), 2))
{
from.LocalOverheadMessage(MessageType.Regular, 0x3B2, 1019045); // I can't reach that.
return;
}
var r = Recipe;
if (r != null && from is PlayerMobile pm)
{
if (!pm.HasRecipe(r))
{
var chance = r.CraftItem.GetSuccessChance(pm, null, r.CraftSystem, false, out var allRequiredSkills);
if (allRequiredSkills && chance >= 0.0)
{
pm.SendLocalizedMessage(
1073451,
r.TextDefinition.ToString()
); // You have learned a new recipe: ~1_RECIPE~
pm.AcquireRecipe(r);
Delete();
}
else
{
pm.SendLocalizedMessage(1044153); // You don't have the required skills to attempt this item.
}
}
else
{
pm.SendLocalizedMessage(1073427); // You already know this recipe.
}
}
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.Write(0); // version
writer.Write(m_RecipeID);
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = reader.ReadInt();
switch (version)
{
case 0:
{
m_RecipeID = reader.ReadInt();
break;
}
}
}
}
}