ModernUO/Projects/UOContent/Multis/Boats/TillerMan.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

131 lines
3.1 KiB
C#

using Server.Multis;
using Server.Network;
namespace Server.Items
{
public class TillerMan : Item
{
private BaseBoat m_Boat;
public TillerMan(BaseBoat boat) : base(0x3E4E)
{
m_Boat = boat;
Movable = false;
}
public TillerMan(Serial serial) : base(serial)
{
}
public void SetFacing(Direction dir)
{
ItemID = dir switch
{
Direction.South => 0x3E4B,
Direction.North => 0x3E4E,
Direction.West => 0x3E50,
Direction.East => 0x3E55,
_ => ItemID
};
}
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
list.Add(m_Boat.Status);
}
public void Say(int number)
{
PublicOverheadMessage(MessageType.Regular, 0x3B2, number);
}
public void Say(int number, string args)
{
PublicOverheadMessage(MessageType.Regular, 0x3B2, number, args);
}
public override void AddNameProperty(IPropertyList list)
{
if (m_Boat?.ShipName != null)
{
list.Add(1042884, m_Boat.ShipName); // the tiller man of the ~1_SHIP_NAME~
}
else
{
base.AddNameProperty(list);
}
}
public override void OnSingleClick(Mobile from)
{
if (m_Boat?.ShipName != null)
{
LabelTo(from, 1042884, m_Boat.ShipName); // the tiller man of the ~1_SHIP_NAME~
}
else
{
base.OnSingleClick(from);
}
}
public override void OnDoubleClick(Mobile from)
{
if (m_Boat?.Contains(from) == true)
{
m_Boat.BeginRename(from);
}
else
{
m_Boat?.BeginDryDock(from);
}
}
public override bool OnDragDrop(Mobile from, Item dropped)
{
if (dropped is MapItem item && m_Boat?.CanCommand(from) == true && m_Boat.Contains(from))
{
m_Boat.AssociateMap(item);
}
return false;
}
public override void OnAfterDelete()
{
m_Boat?.Delete();
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.Write(0); // version
writer.Write(m_Boat);
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = reader.ReadInt();
switch (version)
{
case 0:
{
m_Boat = reader.ReadEntity<BaseBoat>();
if (m_Boat == null)
{
Delete();
}
break;
}
}
}
}
}