ModernUO/Projects/UOContent/Items/Deeds/DragonBardingDeed.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

139 lines
3.8 KiB
C#

using System;
using ModernUO.Serialization;
using Server.Engines.Craft;
using Server.Mobiles;
using Server.Targeting;
namespace Server.Items;
[TypeAlias("Server.Items.DragonBarding")]
[SerializationGenerator(2, false)]
public partial class DragonBardingDeed : Item, ICraftable
{
[InvalidateProperties]
[SerializableField(0)]
[SerializableFieldAttr("[CommandProperty(AccessLevel.GameMaster)]")]
private string _craftedBy;
[InvalidateProperties]
[SerializableField(1)]
[SerializableFieldAttr("[CommandProperty(AccessLevel.GameMaster)]")]
private bool _exceptional;
[SerializableField(2, "private", "private")]
private CraftResource _rawResource;
public DragonBardingDeed() : base(0x14F0) => Weight = 1.0;
public override int LabelNumber => _exceptional ? 1053181 : 1053012; // dragon barding deed
[CommandProperty(AccessLevel.GameMaster)]
public CraftResource Resource
{
get => _rawResource;
set
{
_rawResource = value;
Hue = CraftResources.GetHue(value);
InvalidateProperties();
}
}
public int OnCraft(
int quality, bool makersMark, Mobile from, CraftSystem craftSystem, Type typeRes, BaseTool tool,
CraftItem craftItem, int resHue
)
{
Exceptional = quality >= 2;
if (makersMark)
{
CraftedBy = from?.RawName;
}
var resourceType = typeRes ?? craftItem.Resources[0].ItemType;
Resource = CraftResources.GetFromType(resourceType);
var context = craftSystem.GetContext(from);
if (context?.DoNotColor == true)
{
Hue = 0;
}
return quality;
}
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
if (_exceptional && _craftedBy != null)
{
list.Add(1050043, _craftedBy); // crafted by ~1_NAME~
}
}
public override void OnDoubleClick(Mobile from)
{
if (IsChildOf(from.Backpack))
{
from.BeginTarget(6, false, TargetFlags.None, OnTarget);
from.SendLocalizedMessage(1053024); // Select the swamp dragon you wish to place the barding on.
}
else
{
from.SendLocalizedMessage(1042001); // That must be in your pack for you to use it.
}
}
public virtual void OnTarget(Mobile from, object obj)
{
if (Deleted)
{
return;
}
if (obj is not SwampDragon pet || pet.HasBarding)
{
from.SendLocalizedMessage(1053025); // That is not an unarmored swamp dragon.
}
else if (!pet.Controlled || pet.ControlMaster != from)
{
from.SendLocalizedMessage(1053026); // You can only put barding on a tamed swamp dragon that you own.
}
else if (!IsChildOf(from.Backpack))
{
from.SendLocalizedMessage(1060640); // The item must be in your backpack to use it.
}
else
{
pet.BardingExceptional = Exceptional;
pet.BardingCraftedBy = _craftedBy;
pet.BardingHP = pet.BardingMaxHP;
pet.BardingResource = Resource;
pet.HasBarding = true;
pet.Hue = Hue;
Delete();
// You place the barding on your swamp dragon. Use a bladed item on your dragon to remove the armor.
from.SendLocalizedMessage(1053027);
}
}
private void Deserialize(IGenericReader reader, int version)
{
_exceptional = reader.ReadBool();
var crafter = reader.ReadEntity<Mobile>();
Timer.StartTimer(() => _craftedBy = crafter?.RawName);
if (version < 1)
{
reader.ReadInt();
}
_rawResource = (CraftResource)reader.ReadInt();
}
}