ModernUO/Projects/UOContent/Engines/ML Quests/Items/QuestGiverItem.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

160 lines
4.3 KiB
C#

using System;
using System.Collections.Generic;
using Server.Items;
using Server.Mobiles;
using Server.Network;
namespace Server.Engines.MLQuests.Items
{
public abstract class QuestGiverItem : Item, IQuestGiver
{
private List<MLQuest> m_MLQuests;
public QuestGiverItem(int itemId)
: base(itemId)
{
}
public QuestGiverItem(Serial serial)
: base(serial)
{
}
public bool CanGiveMLQuest => MLQuests.Count != 0;
public override bool Nontransferable => true;
public List<MLQuest> MLQuests => m_MLQuests ??
(m_MLQuests = MLQuestSystem.FindQuestList(GetType()) ?? MLQuestSystem.EmptyList);
public override void AddNameProperties(IPropertyList list)
{
base.AddNameProperties(list);
AddQuestItemProperty(list);
if (CanGiveMLQuest)
{
list.Add(1072269); // Quest Giver
}
}
public override void OnDoubleClick(Mobile from)
{
if (!from.InRange(GetWorldLocation(), 2))
{
from.LocalOverheadMessage(MessageType.Regular, 0x3B2, 1019045); // I can't reach that.
}
else if (!IsChildOf(from.Backpack))
{
from.SendLocalizedMessage(1042593); // That is not in your backpack.
}
else if (MLQuestSystem.Enabled && CanGiveMLQuest && from is PlayerMobile mobile)
{
MLQuestSystem.OnDoubleClick(this, mobile);
}
}
public override void OnAfterDelete()
{
base.OnAfterDelete();
if (MLQuestSystem.Enabled)
{
MLQuestSystem.HandleDeletion(this);
}
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.Write(0); // version
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = reader.ReadInt();
}
}
public abstract class TransientQuestGiverItem : TransientItem, IQuestGiver
{
private List<MLQuest> m_MLQuests;
public TransientQuestGiverItem(int itemId, TimeSpan lifeSpan)
: base(itemId, lifeSpan)
{
}
public TransientQuestGiverItem(Serial serial)
: base(serial)
{
}
public bool CanGiveMLQuest => MLQuests.Count != 0;
public override bool Nontransferable => true;
public List<MLQuest> MLQuests => m_MLQuests ??
(m_MLQuests = MLQuestSystem.FindQuestList(GetType()) ?? MLQuestSystem.EmptyList);
public override void HandleInvalidTransfer(Mobile from)
{
}
public override void AddNameProperties(IPropertyList list)
{
base.AddNameProperties(list);
AddQuestItemProperty(list);
if (CanGiveMLQuest)
{
list.Add(1072269); // Quest Giver
}
}
public override void OnDoubleClick(Mobile from)
{
if (!from.InRange(GetWorldLocation(), 2))
{
from.LocalOverheadMessage(MessageType.Regular, 0x3B2, 1019045); // I can't reach that.
}
else if (!IsChildOf(from.Backpack))
{
from.SendLocalizedMessage(1042593); // That is not in your backpack.
}
else if (MLQuestSystem.Enabled && CanGiveMLQuest && from is PlayerMobile mobile)
{
MLQuestSystem.OnDoubleClick(this, mobile);
}
}
public override void OnAfterDelete()
{
base.OnAfterDelete();
if (MLQuestSystem.Enabled)
{
MLQuestSystem.HandleDeletion(this);
}
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.Write(0); // version
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = reader.ReadInt();
}
}
}