ModernUO/Projects/UOContent/Spells/Spellweaving/Items/TransientItem.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

108 lines
2.9 KiB
C#

using System;
namespace Server.Items
{
public class TransientItem : Item
{
private TimerExecutionToken _timerToken;
[Constructible]
public TransientItem(int itemID, TimeSpan lifeSpan)
: base(itemID)
{
CreationTime = Core.Now;
LifeSpan = lifeSpan;
Timer.StartTimer(TimeSpan.FromSeconds(5), TimeSpan.FromSeconds(5), CheckExpiry, out _timerToken);
}
public TransientItem(Serial serial)
: base(serial)
{
}
[CommandProperty(AccessLevel.GameMaster)]
public TimeSpan LifeSpan { get; set; }
[CommandProperty(AccessLevel.GameMaster)]
public DateTime CreationTime { get; set; }
public override bool Nontransferable => true;
public virtual TextDefinition InvalidTransferMessage => null;
public override void HandleInvalidTransfer(Mobile from)
{
if (InvalidTransferMessage != null)
{
TextDefinition.SendMessageTo(from, InvalidTransferMessage);
}
Delete();
}
public virtual void Expire(Mobile parent)
{
parent?.SendLocalizedMessage(1072515, Name ?? $"#{LabelNumber}"); // The ~1_name~ expired...
Effects.PlaySound(GetWorldLocation(), Map, 0x201);
Delete();
}
public virtual void SendTimeRemainingMessage(Mobile to)
{
to.SendLocalizedMessage(
1072516,
$"{Name ?? $"#{LabelNumber}"}\t{(int)LifeSpan.TotalSeconds}"
); // ~1_name~ will expire in ~2_val~ seconds!
}
public override void OnDelete()
{
_timerToken.Cancel();
base.OnDelete();
}
public virtual void CheckExpiry()
{
if (CreationTime + LifeSpan < Core.Now)
{
Expire(RootParent as Mobile);
}
else
{
InvalidateProperties();
}
}
public override void GetProperties(IPropertyList list)
{
base.GetProperties(list);
var remaining = CreationTime + LifeSpan - Core.Now;
list.Add(1072517, $"{(int)remaining.TotalSeconds}"); // Lifespan: ~1_val~ seconds
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.Write(0);
writer.Write(LifeSpan);
writer.Write(CreationTime);
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = reader.ReadInt();
LifeSpan = reader.ReadTimeSpan();
CreationTime = reader.ReadDateTime();
Timer.StartTimer(TimeSpan.FromSeconds(5), TimeSpan.FromSeconds(5), CheckExpiry, out _timerToken);
}
}
}