ModernUO/Projects/UOContent/Items/Special/Special Scrolls/StatScroll.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

206 lines
6.1 KiB
C#

using Server.Mobiles;
namespace Server.Items
{
public class StatCapScroll : SpecialScroll
{
[Constructible]
public StatCapScroll(int value = 105) : base(SkillName.Alchemy, value) => Hue = 0x481;
public StatCapScroll(Serial serial) : base(serial)
{
}
/* Using a scroll increases the maximum amount of a specific skill or your maximum statistics.
* When used, the effect is not immediately seen without a gain of points with that skill or statistics.
* You can view your maximum skill values in your skills window.
* You can view your maximum statistic value in your statistics window.
*/
public override int Message =>
1049469;
public override int Title
{
get
{
var level = ((int)Value - 230) / 5;
/* Wonderous Scroll (+5 Maximum Stats): OR
* Exalted Scroll (+10 Maximum Stats): OR
* Mythical Scroll (+15 Maximum Stats): OR
* Legendary Scroll (+20 Maximum Stats): OR
* Ultimate Scroll (+25 Maximum Stats):
*/
if (level >= 0 && level <= 4 && Value % 5 == 0)
{
return 1049458 + level;
}
return 0;
}
}
public override string DefaultTitle =>
$"<basefont color=#FFFFFF>Power Scroll ({((int)Value - 225 >= 0 ? "+" : "")}{(int)Value - 225} Maximum Stats):</basefont>";
public override void AddNameProperty(IPropertyList list)
{
var level = ((int)Value - 230) / 5;
if (level >= 0 && level <= 4 && (int)Value % 5 == 0)
/* a wonderous scroll of ~1_type~ (+5 Maximum Stats) OR
* an exalted scroll of ~1_type~ (+10 Maximum Stats) OR
* a mythical scroll of ~1_type~ (+15 Maximum Stats) OR
* a legendary scroll of ~1_type~ (+20 Maximum Stats) OR
* an ultimate scroll of ~1_type~ (+25 Maximum Stats)
*/
{
list.Add(1049463 + level, "#1049476");
}
else
{
var diff = Value - 225;
list.Add($"a scroll of power ({(diff >= 0 ? "+" : "")}{diff} Maximum Stats)");
}
}
public override void OnSingleClick(Mobile from)
{
var level = ((int)Value - 230) / 5;
if (level >= 0 && level <= 4 && (int)Value % 5 == 0)
{
LabelTo(from, 1049463 + level, "#1049476");
}
else
{
var diff = Value - 225;
LabelTo(from, $"a scroll of power ({(diff >= 0 ? "+" : "")}{diff} Maximum Stats)");
}
}
public override bool CanUse(Mobile from)
{
if (!base.CanUse(from))
{
return false;
}
var newValue = (int)Value;
if (from is PlayerMobile mobile && mobile.HasStatReward)
{
newValue += 5;
}
if (from.StatCap >= newValue)
{
from.SendLocalizedMessage(1049510); // Your stats are too high for this power scroll.
return false;
}
return true;
}
public override void Use(Mobile from)
{
if (!CanUse(from))
{
return;
}
from.SendLocalizedMessage(1049512); // You feel a surge of magic as the scroll enhances your powers!
if (from is PlayerMobile mobile && mobile.HasStatReward)
{
mobile.StatCap = (int)Value + 5;
}
else
{
from.StatCap = (int)Value;
}
Effects.SendLocationParticles(
EffectItem.Create(from.Location, from.Map, EffectItem.DefaultDuration),
0,
0,
0,
0,
0,
5060,
0
);
Effects.PlaySound(from.Location, from.Map, 0x243);
Effects.SendMovingParticles(
new Entity(Serial.Zero, new Point3D(from.X - 6, from.Y - 6, from.Z + 15), from.Map),
from,
0x36D4,
7,
0,
false,
true,
0x497,
0,
9502,
1,
0,
(EffectLayer)255,
0x100
);
Effects.SendMovingParticles(
new Entity(Serial.Zero, new Point3D(from.X - 4, from.Y - 6, from.Z + 15), from.Map),
from,
0x36D4,
7,
0,
false,
true,
0x497,
0,
9502,
1,
0,
(EffectLayer)255,
0x100
);
Effects.SendMovingParticles(
new Entity(Serial.Zero, new Point3D(from.X - 6, from.Y - 4, from.Z + 15), from.Map),
from,
0x36D4,
7,
0,
false,
true,
0x497,
0,
9502,
1,
0,
(EffectLayer)255,
0x100
);
Effects.SendTargetParticles(from, 0x375A, 35, 90, 0x00, 0x00, 9502, (EffectLayer)255, 0x100);
Delete();
}
public override void Serialize(IGenericWriter writer)
{
base.Serialize(writer);
writer.Write(0); // version
}
public override void Deserialize(IGenericReader reader)
{
base.Deserialize(reader);
var version = InheritsItem ? 0 : reader.ReadInt(); // Required for SpecialScroll insertion
LootType = LootType.Cursed;
Insured = false;
}
}
}