ModernUO/Projects/UOContent/Items/Addons/AddonContainerComponent.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

121 lines
3.6 KiB
C#

using System;
using System.Buffers.Binary;
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.ContextMenus;
using Server.Network;
namespace Server.Items
{
[SerializationGenerator(0, false)]
public partial class AddonContainerComponent : Item, IChoppable
{
[Constructible]
public AddonContainerComponent(int itemID) : base(itemID)
{
Movable = false;
AddonComponent.ApplyLightTo(this);
}
public virtual bool NeedsWall => false;
public virtual Point3D WallPosition => Point3D.Zero;
[SerializableField(0)]
[SerializableFieldAttr("[CommandProperty(AccessLevel.GameMaster)]")]
private BaseAddonContainer _addon;
[SerializableField(1)]
[SerializableFieldAttr("[CommandProperty(AccessLevel.GameMaster)]")]
private Point3D _offset;
[Hue]
[CommandProperty(AccessLevel.GameMaster)]
public override int Hue
{
get => base.Hue;
set
{
base.Hue = value;
if (_addon?.ShareHue == true)
{
_addon.Hue = value;
}
}
}
public virtual void OnChop(Mobile from)
{
if (_addon != null && from.InRange(GetWorldLocation(), 3))
{
_addon.OnChop(from);
}
else
{
from.SendLocalizedMessage(500446); // That is too far away.
}
}
public override bool OnDragDrop(Mobile from, Item dropped) => _addon?.OnDragDrop(from, dropped) == true;
public override void OnDoubleClick(Mobile from) => _addon?.OnComponentUsed(this, from);
public override void OnLocationChange(Point3D old)
{
if (_addon != null)
{
_addon.Location = new Point3D(X - _offset.X, Y - _offset.Y, Z - _offset.Z);
}
}
public override void OnMapChange()
{
if (_addon != null)
{
_addon.Map = Map;
}
}
public override void GetProperties(IPropertyList list) => _addon?.GetProperties(list);
public override void GetContextMenuEntries(Mobile from, List<ContextMenuEntry> list) =>
_addon?.GetContextMenuEntries(from, list);
public override void OnAfterDelete()
{
base.OnAfterDelete();
_addon?.Delete();
}
public override void SendWorldPacketTo(NetState ns, ReadOnlySpan<byte> world = default)
{
Span<byte> buffer = stackalloc byte[OutgoingEntityPackets.MaxWorldEntityPacketLength].InitializePacket();
var length = OutgoingItemPackets.CreateWorldItem(buffer, this);
// Use an itemid of a real container
BinaryPrimitives.WriteUInt16BigEndian(buffer[7..9], (ushort)(_addon?.ItemID ?? 0x9AB));
ns.Send(buffer[..length]);
base.SendWorldPacketTo(ns, world);
}
[AfterDeserialization]
private void AfterDeserialization()
{
_addon?.OnComponentLoaded(this);
AddonComponent.ApplyLightTo(this);
}
}
[SerializationGenerator(0, false)]
public partial class LocalizedContainerComponent : AddonContainerComponent
{
[SerializableField(0, setter: "private")]
private int _number;
public LocalizedContainerComponent(int itemID, int labelNumber) : base(itemID) => _number = labelNumber;
public override int LabelNumber => _number > 0 ? _number : base.LabelNumber;
}
}