ModernUO/Projects/UOContent/Items/Special/Veteran Rewards/MinotaurStatue.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

191 lines
5.3 KiB
C#

using Server.Engines.VeteranRewards;
using Server.Gumps;
namespace Server.Items
{
public enum MinotaurStatueType
{
AttackSouth = 100,
AttackEast = 101,
DefendSouth = 102,
DefendEast = 103
}
public class MinotaurStatue : BaseAddon, IRewardItem
{
private bool m_IsRewardItem;
[Constructible]
public MinotaurStatue(MinotaurStatueType type)
{
switch (type)
{
case MinotaurStatueType.AttackSouth:
AddComponent(new AddonComponent(0x306C), 0, 0, 0);
AddComponent(new AddonComponent(0x306D), -1, 0, 0);
AddComponent(new AddonComponent(0x306E), 0, -1, 0);
break;
case MinotaurStatueType.AttackEast:
AddComponent(new AddonComponent(0x3074), 0, 0, 0);
AddComponent(new AddonComponent(0x3075), -1, 0, 0);
AddComponent(new AddonComponent(0x3076), 0, -1, 0);
break;
case MinotaurStatueType.DefendSouth:
AddComponent(new AddonComponent(0x3072), 0, 0, 0);
AddComponent(new AddonComponent(0x3073), 0, -1, 0);
break;
case MinotaurStatueType.DefendEast:
AddComponent(new AddonComponent(0x306F), 0, 0, 0);
AddComponent(new AddonComponent(0x3070), -1, 0, 0);
AddComponent(new AddonComponent(0x3071), 0, -1, 0);
break;
}
}
public MinotaurStatue(Serial serial) : base(serial)
{
}
public override BaseAddonDeed Deed
{
get
{
var deed = new MinotaurStatueDeed();
deed.IsRewardItem = m_IsRewardItem;
return deed;
}
}
[CommandProperty(AccessLevel.GameMaster)]
public bool IsRewardItem
{
get => m_IsRewardItem;
set
{
m_IsRewardItem = value;
InvalidateProperties();
}
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.WriteEncodedInt(0); // version
writer.Write(m_IsRewardItem);
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = reader.ReadEncodedInt();
m_IsRewardItem = reader.ReadBool();
}
}
public class MinotaurStatueDeed : BaseAddonDeed, IRewardItem, IRewardOption
{
private bool m_IsRewardItem;
private MinotaurStatueType m_StatueType;
[Constructible]
public MinotaurStatueDeed() => LootType = LootType.Blessed;
public MinotaurStatueDeed(Serial serial) : base(serial)
{
}
public override int LabelNumber => 1080409; // Minotaur Statue Deed
public override BaseAddon Addon
{
get
{
var addon = new MinotaurStatue(m_StatueType);
addon.IsRewardItem = m_IsRewardItem;
return addon;
}
}
[CommandProperty(AccessLevel.GameMaster)]
public bool IsRewardItem
{
get => m_IsRewardItem;
set
{
m_IsRewardItem = value;
InvalidateProperties();
}
}
public void GetOptions(RewardOptionList list)
{
list.Add((int)MinotaurStatueType.AttackSouth, 1080410); // Minotaur Attack South
list.Add((int)MinotaurStatueType.AttackEast, 1080411); // Minotaur Attack East
list.Add((int)MinotaurStatueType.DefendSouth, 1080412); // Minotaur Defend South
list.Add((int)MinotaurStatueType.DefendEast, 1080413); // Minotaur Defend East
}
public void OnOptionSelected(Mobile from, int option)
{
m_StatueType = (MinotaurStatueType)option;
if (!Deleted)
{
base.OnDoubleClick(from);
}
}
public override void OnDoubleClick(Mobile from)
{
if (m_IsRewardItem && !RewardSystem.CheckIsUsableBy(from, this))
{
return;
}
if (IsChildOf(from.Backpack))
{
from.CloseGump<RewardOptionGump>();
from.SendGump(new RewardOptionGump(this));
}
else
{
from.SendLocalizedMessage(1062334); // This item must be in your backpack to be used.
}
}
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
if (m_IsRewardItem)
{
list.Add(1076218); // 2nd Year Veteran Reward
}
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.WriteEncodedInt(0); // version
writer.Write(m_IsRewardItem);
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = reader.ReadEncodedInt();
m_IsRewardItem = reader.ReadBool();
}
}
}