ModernUO/Projects/UOContent/Items/Containers/Strongbox.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

116 lines
2.9 KiB
C#

using System;
using System.Collections.Generic;
using ModernUO.Serialization;
using Server.Multis;
namespace Server.Items;
[Flippable(0xE80, 0x9A8)]
[SerializationGenerator(0, false)]
public partial class StrongBox : BaseContainer, IChoppable
{
[InvalidateProperties]
[SerializableField(0)]
[SerializableFieldAttr("[CommandProperty(AccessLevel.GameMaster)]")]
private Mobile _owner;
[InvalidateProperties]
[SerializableField(1)]
[SerializableFieldAttr("[CommandProperty(AccessLevel.GameMaster)]")]
private BaseHouse _house;
public StrongBox(Mobile owner, BaseHouse house) : base(0xE80)
{
_owner = owner;
_house = house;
MaxItems = 25;
}
public override double DefaultWeight => 100;
public override int LabelNumber => 1023712;
public override int DefaultMaxWeight => 0;
public override bool Decays => _house == null || _owner?.Deleted != false || !_house.IsCoOwner(_owner);
public override TimeSpan DecayTime => TimeSpan.FromMinutes(30.0);
public void OnChop(Mobile from)
{
if (_house?.Deleted != false || _owner?.Deleted != false || from == _owner || _house.IsOwner(from))
{
Chop(from);
}
}
[AfterDeserialization]
private void AfterDeserialization()
{
Timer.StartTimer(TimeSpan.FromSeconds(1.0), Validate);
}
private void Validate()
{
if (_owner != null && _house?.IsCoOwner(_owner) == false)
{
Console.WriteLine("Warning: Destroying strongbox of {0}", _owner.Name);
Destroy();
}
}
public override void AddNameProperty(IPropertyList list)
{
if (_owner != null)
{
list.Add(1042887, _owner.Name); // a strong box owned by ~1_OWNER_NAME~
}
else
{
base.AddNameProperty(list);
}
}
public override void OnSingleClick(Mobile from)
{
if (_owner == null)
{
base.OnSingleClick(from);
return;
}
LabelTo(from, 1042887, _owner.Name); // a strong box owned by ~1_OWNER_NAME~
if (CheckContentDisplay(from))
{
LabelTo(from, "({0} items, {1} stones)", TotalItems, TotalWeight);
}
}
public override bool IsAccessibleTo(Mobile m) =>
_owner?.Deleted != false || _house?.Deleted != false ||
m.AccessLevel >= AccessLevel.GameMaster ||
m == _owner && _house.IsCoOwner(m) && base.IsAccessibleTo(m);
private void Chop(Mobile from)
{
Effects.PlaySound(Location, Map, 0x3B3);
from.SendLocalizedMessage(500461); // You destroy the item.
Destroy();
}
public Container ConvertToStandardContainer()
{
Container metalBox = new MetalBox();
var subItems = new List<Item>(Items);
foreach (var subItem in subItems)
{
metalBox.AddItem(subItem);
}
Delete();
return metalBox;
}
}