## 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.
84 lines
2.1 KiB
C#
84 lines
2.1 KiB
C#
using System;
|
|
using ModernUO.Serialization;
|
|
|
|
namespace Server.Items
|
|
{
|
|
[SerializationGenerator(0, false)]
|
|
public abstract partial class BaseFish : Item
|
|
{
|
|
private static readonly TimeSpan DeathDelay = TimeSpan.FromMinutes(5);
|
|
|
|
private TimerExecutionToken _timerToken;
|
|
|
|
[Constructible]
|
|
public BaseFish(int itemID) : base(itemID)
|
|
{
|
|
StartTimer();
|
|
}
|
|
|
|
[CommandProperty(AccessLevel.GameMaster)]
|
|
public bool Dead => ItemID == 0x3B0C;
|
|
|
|
public virtual void StartTimer()
|
|
{
|
|
_timerToken.Cancel();
|
|
Timer.StartTimer(DeathDelay, Kill, out _timerToken);
|
|
|
|
InvalidateProperties();
|
|
}
|
|
|
|
public virtual void StopTimer()
|
|
{
|
|
_timerToken.Cancel();
|
|
InvalidateProperties();
|
|
}
|
|
|
|
public override void OnDelete()
|
|
{
|
|
StopTimer();
|
|
}
|
|
|
|
public virtual void Kill()
|
|
{
|
|
ItemID = 0x3B0C;
|
|
StopTimer();
|
|
}
|
|
|
|
public int GetDescription()
|
|
{
|
|
// TODO: This will never return "very unusual dead aquarium creature" due to the way it is killed
|
|
if (ItemID > 0x3B0F)
|
|
{
|
|
return Dead ? 1074424 : 1074422; // A very unusual [dead/live] aquarium creature
|
|
}
|
|
|
|
if (Hue != 0)
|
|
{
|
|
return Dead ? 1074425 : 1074423; // A [dead/live] aquarium creature of unusual color
|
|
}
|
|
|
|
return Dead ? 1073623 : 1073622; // A [dead/live] aquarium creature
|
|
}
|
|
|
|
public override void GetProperties(IPropertyList list)
|
|
{
|
|
base.GetProperties(list);
|
|
|
|
list.Add(GetDescription());
|
|
|
|
if (!Dead && _timerToken.Running)
|
|
{
|
|
list.Add(1074507); // Gasping for air
|
|
}
|
|
}
|
|
|
|
[AfterDeserialization]
|
|
private void AfterDeserialization()
|
|
{
|
|
if (Parent is not Aquarium && Parent is not FishBowl)
|
|
{
|
|
StartTimer();
|
|
}
|
|
}
|
|
}
|
|
}
|