## Summary
Folds **113** hand-written `[SerializableProperty]` members into plain `[SerializableField]` declarations using the v4 setter hooks — value coercion/vetoes via `allowFieldChange`, post-change side effects via `fieldChanged` (whose `oldValue` parameter covers the old-house/old-sender unsubscribe patterns). Net **-450 lines** of setter boilerplate.
```cs
// before
[SerializableProperty(1)]
[CommandProperty(AccessLevel.GameMaster)]
public int Charges
{
get => _charges;
set
{
_charges = Math.Clamp(value, 0, MaxCharges);
InvalidateProperties();
this.MarkDirty();
}
}
// after
[SerializableField(1, allowFieldChange: nameof(AllowChargesChange))]
[SerializedCommandProperty(AccessLevel.GameMaster)]
[InvalidateProperties]
private int _charges;
private bool AllowChargesChange(ref int value)
{
value = Math.Clamp(value, 0, MaxCharges);
return true;
}
```
## How sites were selected
A classifier parsed all 204 `[SerializableProperty]` sites and converted only those matching strict shapes: getter is exactly `get => _field;`, the assignment comes first (after at most an equality guard), and relocated side effects contain no `return`, no `value` mutation, and no field re-assignment. Everything else was left alone deliberately:
- **~34 custom getters** (fallback defaults like `_x == -1 ? Default : _x`, self-healing refs) — no setter hook can express these.
- **~35 pre-assignment logic** (durability Unscale/Scale sandwiches, old-state captures like PotionKeg's pile weight).
- **virtual/override members, name-mismatched backing fields (`m_`), exotic semantics** (guards' `Focus` does work on *equal* assignment; `ChampionSpawn.Active` never assigns its field).
Five sites the classifier refused were converted by hand where the hooks fit cleanly: `ReceiverCrystal.Sender`, `PlayerVendor.House`, `PlayerBarkeeper.House` (old-value unsubscribe via `oldValue`), `BaseSuit.AccessLevel` (its existing virtual `OnAccessLevelChanged` already had the exact callback shape), and `DyeTub.DyedHue` (a true veto: `AllowDyedHueChange(ref int value) => _redyable`).
## Verification
- Build: **0 errors, 0 warnings**.
- **Schema regeneration produces zero Migrations changes** — the conversion is wire- and schema-neutral by construction (same orders, types, and property names), and CI's schema diff check enforces it.
- **835 + 708 tests green.**
## Behavioral notes (all strict improvements, called out for review)
- Generated setters skip everything when the incoming value equals the current one; a few converted setters previously re-ran side effects on equal assignment (redundant `Update()`-style refreshes).
- Generated setters always `MarkDirty()` on change; several converted setters never did (e.g. `DyeTub.DyedHue`, `MorphItem` ranges) — their changes only persisted if something else dirtied the entity. Those latent persistence bugs are fixed by construction.
344 lines
12 KiB
C#
344 lines
12 KiB
C#
using System;
|
|
using ModernUO.Serialization;
|
|
using Server.Gumps;
|
|
|
|
namespace Server.Items;
|
|
|
|
[Flippable(0x14ED, 0x14EE)]
|
|
[SerializationGenerator(0, false)]
|
|
public partial class SOS : Item
|
|
{
|
|
// We can only speculate, but I lack of support for non-ascii arguments in localized html gumps is why this wasn't used.
|
|
// By default let's use the old gump, because we can.
|
|
private static bool UseNewMessages = false;
|
|
|
|
private static int[] WaterTiles =
|
|
{
|
|
0x00A8, 0x00AB,
|
|
0x0136, 0x0137
|
|
};
|
|
|
|
private static Rectangle2D[] BritRegions = { new(0, 0, 5120, 4096) };
|
|
|
|
private static Rectangle2D[] IlshRegions =
|
|
{ new(1472, 272, 304, 240), new(1240, 1000, 312, 160) };
|
|
|
|
private static Rectangle2D[] MalasRegions = { new(1376, 1520, 464, 280) };
|
|
|
|
private static TextDefinition[] MessageEntries =
|
|
{
|
|
// Help! Ship going do...n heavy storms...precious cargo...st reach dest...current coordinates ~1_SEXTANT~...ve any survivors...ease!
|
|
1153537,
|
|
// ...was a cad and a boor, no matter what momma s...rew him overboard! Oh, Anna, 'twas so exciting! Unfort...y he grabbe...est, and all his riches went with him! ...sked the captain, and he says we're at ~1_SEXTANT~ ... so maybe ...
|
|
1153538,
|
|
// ...know that the wreck is near ~1_SEXTANT~ but have not found it. Could the message passed down in my family for generations be wrong? No... I swear on the soul of my grandfather, I will find...
|
|
1153539,
|
|
// ...Ar! ~1_SEXTANT~ and, a fair wind! No chance...storms, though--ar! Is that a sea serp...<br><br>uh oh.
|
|
1153540,
|
|
// WANTED: divers exp...d in shipwre...overy. Must have own vess...pply at ~1_SEXTANT~...good benefits, flexible hours...
|
|
1153541,
|
|
// ...isaster indeed. Capt. McQ...overboard, fear the worst. These are t...ast days of the good ship Norr...ast known position was ~1_SEXTANT~ but ...'re beyond salvag...
|
|
1153542,
|
|
// ...never expected an iceberg...silly woman on bow crushed instantly...send help to ~1_SEXTANT~...ey'll never forget the tragedy of the sinking of the...
|
|
1153543,
|
|
// ...so I threw the treasure overboard, before the curse could get me too. But I was too late. Now I am doomed to wander these seas, a ghost forever. Join me: seek ye at ~1_SEXTANT~ if thou wishest my company...
|
|
1153544,
|
|
// ...then the ship exploded. A dragon swooped over. The slime swallowed Bertie whole--he screamed, it was amazing. The sky glowed orange...A sextant reading put us at ~1_SEXTANT~. Norma was chattering about sailing over the edge of the world. I looked at my hands and saw through them..."
|
|
1153545,
|
|
// ...been inside this whale for three days now. I've run out of food I can pick out of his teeth. I took a sextant reading through the blowhole: ~1_SEXTANT~. I'll never see my treasure again...
|
|
1153546,
|
|
// ...grand adventure! Captain Quacklebush had me swab down the decks daily... ...pirates came, I was in the rigging practicing with my sextant. ~1_SEXTANT~ if I am not mistaken... ...scuttled the ship, and our precious cargo went with her and the screaming pirates, down to the bottom of the sea...
|
|
1153547,
|
|
// ...nobody knew I was a girl. They just assumed I was another sailor...then we met the undine. ~1_SEXTANT~. It demanded sacrifice...I was youngest, they figured...grabbed the captain's treasure, screamed "It'll go down with me!" ...they took me up on it.
|
|
1153548,
|
|
// ...trapped on a deserted island with a magic fountain supplying food, fresh water springs, gorgeous scenery, and my lovely young wife. I know the ship with all our life's earnings sank at ~1_SEXTANT ~ but I don't know what our coordinates are...someone has GOT to rescue me before Sunday's finals game or I'll go mad...
|
|
1153549,
|
|
// ...round Jhelom towne we did roam, drinking all night. Got into a fight...hoisted sail on the morn, all crew aboard but the cook...ull breach, last known coordinates ~1_SEXTANT~...be better off in Stone's jail cell!
|
|
1153550
|
|
};
|
|
|
|
[SerializableField(1)]
|
|
[SerializedCommandProperty(AccessLevel.GameMaster)]
|
|
private Map _targetMap;
|
|
|
|
[SerializableField(2)]
|
|
[SerializedCommandProperty(AccessLevel.GameMaster)]
|
|
private Point3D _targetLocation;
|
|
|
|
[SerializableField(3)]
|
|
[SerializedCommandProperty(AccessLevel.GameMaster)]
|
|
private int _messageIndex;
|
|
|
|
[Constructible]
|
|
public SOS(Map map = null) : this(map, MessageInABottle.GetRandomLevel())
|
|
{
|
|
}
|
|
|
|
[Constructible]
|
|
public SOS(Map map, int level) : base(0x14EE)
|
|
{
|
|
_level = level;
|
|
MessageIndex = Utility.Random(MessageEntries.Length);
|
|
TargetMap = map ?? Map.Trammel;
|
|
TargetLocation = FindLocation(TargetMap);
|
|
|
|
UpdateHue();
|
|
}
|
|
|
|
public override double DefaultWeight => 1.0;
|
|
|
|
public override int LabelNumber
|
|
{
|
|
get
|
|
{
|
|
if (IsAncient)
|
|
{
|
|
return 1063450; // an ancient SOS
|
|
}
|
|
|
|
return 1041081; // a waterstained SOS
|
|
}
|
|
}
|
|
|
|
[CommandProperty(AccessLevel.GameMaster)]
|
|
public bool IsAncient => _level >= 4;
|
|
|
|
[SerializableField(0, fieldChanged: nameof(OnLevelChanged), allowFieldChange: nameof(AllowLevelChange))]
|
|
[SerializedCommandProperty(AccessLevel.GameMaster)]
|
|
[InvalidateProperties]
|
|
private int _level;
|
|
|
|
private bool AllowLevelChange(ref int value)
|
|
{
|
|
value = Math.Max(1, Math.Min(value, 4));
|
|
return true;
|
|
}
|
|
|
|
private void OnLevelChanged(int oldValue, int newValue)
|
|
{
|
|
UpdateHue();
|
|
}
|
|
|
|
public void UpdateHue() => Hue = IsAncient ? 0x481 : 0;
|
|
|
|
public override void OnDoubleClick(Mobile from)
|
|
{
|
|
if (IsChildOf(from.Backpack))
|
|
{
|
|
var entry = MessageIndex >= 0 && MessageIndex < MessageEntries.Length ? MessageEntries[MessageIndex] : null;
|
|
|
|
if (UseNewMessages || entry == null)
|
|
{
|
|
MessageGump.DisplayTo(from, TargetMap, TargetLocation);
|
|
}
|
|
else
|
|
{
|
|
OldMessageGump.DisplayTo(from, entry, TargetMap, TargetLocation, from.Language);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
from.SendLocalizedMessage(1042001); // That must be in your pack for you to use it.
|
|
}
|
|
}
|
|
|
|
public static Point3D FindLocation(Map map)
|
|
{
|
|
if (map == null || map == Map.Internal)
|
|
{
|
|
return Point3D.Zero;
|
|
}
|
|
|
|
Rectangle2D[] regions;
|
|
|
|
if (map == Map.Felucca || map == Map.Trammel)
|
|
{
|
|
regions = BritRegions;
|
|
}
|
|
else if (map == Map.Ilshenar)
|
|
{
|
|
regions = IlshRegions;
|
|
}
|
|
else if (map == Map.Malas)
|
|
{
|
|
regions = MalasRegions;
|
|
}
|
|
else
|
|
{
|
|
regions = new[] { new Rectangle2D(0, 0, map.Width, map.Height) };
|
|
}
|
|
|
|
if (regions.Length == 0)
|
|
{
|
|
return Point3D.Zero;
|
|
}
|
|
|
|
for (var i = 0; i < 50; ++i)
|
|
{
|
|
var reg = regions.RandomElement();
|
|
var x = Utility.Random(reg.X, reg.Width);
|
|
var y = Utility.Random(reg.Y, reg.Height);
|
|
|
|
if (!ValidateDeepWater(map, x, y))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
var valid = true;
|
|
|
|
for (int j = 1, offset = 5; valid && j <= 5; ++j, offset += 5)
|
|
{
|
|
if (!ValidateDeepWater(map, x + offset, y + offset))
|
|
{
|
|
valid = false;
|
|
}
|
|
else if (!ValidateDeepWater(map, x + offset, y - offset))
|
|
{
|
|
valid = false;
|
|
}
|
|
else if (!ValidateDeepWater(map, x - offset, y + offset))
|
|
{
|
|
valid = false;
|
|
}
|
|
else if (!ValidateDeepWater(map, x - offset, y - offset))
|
|
{
|
|
valid = false;
|
|
}
|
|
}
|
|
|
|
if (valid)
|
|
{
|
|
return new Point3D(x, y, 0);
|
|
}
|
|
}
|
|
|
|
return Point3D.Zero;
|
|
}
|
|
|
|
private static bool ValidateDeepWater(Map map, int x, int y)
|
|
{
|
|
var tileID = map.Tiles.GetLandTile(x, y).ID;
|
|
var water = false;
|
|
|
|
for (var i = 0; !water && i < WaterTiles.Length; i += 2)
|
|
{
|
|
water = tileID >= WaterTiles[i] && tileID <= WaterTiles[i + 1];
|
|
}
|
|
|
|
return water;
|
|
}
|
|
|
|
private class MessageGump : StaticGump<MessageGump>
|
|
{
|
|
private readonly string _fmt;
|
|
|
|
public override bool Singleton => true;
|
|
|
|
private MessageGump(string fmt) : base(150, 50)
|
|
{
|
|
_fmt = fmt;
|
|
}
|
|
|
|
public static void DisplayTo(Mobile from, Map map, Point3D loc)
|
|
{
|
|
if (from?.NetState == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
int xLong = 0, yLat = 0;
|
|
int xMins = 0, yMins = 0;
|
|
bool xEast = false, ySouth = false;
|
|
string fmt;
|
|
|
|
if (Sextant.Format(loc, map, ref xLong, ref yLat, ref xMins, ref yMins, ref xEast, ref ySouth))
|
|
{
|
|
fmt = $"{yLat}° {yMins}'{(ySouth ? "S" : "N")}, {xLong}°{xMins}'{(xEast ? "E" : "W")}";
|
|
}
|
|
else
|
|
{
|
|
fmt = "?????";
|
|
}
|
|
|
|
from.SendGump(new MessageGump(fmt));
|
|
}
|
|
|
|
protected override void BuildLayout(ref StaticGumpBuilder builder)
|
|
{
|
|
builder.AddPage();
|
|
|
|
builder.AddBackground(0, 40, 350, 300, 2520);
|
|
|
|
/* This is a message hastily scribbled by a passenger aboard a sinking ship.
|
|
* While it is probably too late to save the passengers and crew,
|
|
* perhaps some treasure went down with the ship!
|
|
* The message gives the ship's last known sextant co-ordinates.
|
|
*/
|
|
builder.AddHtmlLocalized(30, 80, 285, 160, 1018326, true, true);
|
|
|
|
builder.AddHtmlPlaceholder(35, 240, 230, 20, "fmt");
|
|
|
|
builder.AddButton(35, 265, 4005, 4007, 0);
|
|
builder.AddHtmlLocalized(70, 265, 100, 20, 1011036); // OKAY
|
|
}
|
|
|
|
protected override void BuildStrings(ref GumpStringsBuilder builder)
|
|
{
|
|
builder.SetStringSlot("fmt", _fmt);
|
|
}
|
|
}
|
|
|
|
private class OldMessageGump : StaticGump<OldMessageGump>
|
|
{
|
|
private const int Width = 350;
|
|
private const int Height = 300;
|
|
|
|
private readonly string _message;
|
|
|
|
public override bool Singleton => true;
|
|
|
|
private OldMessageGump(string message) : base((640 - Width) / 2, (480 - Height) / 2)
|
|
{
|
|
_message = message;
|
|
}
|
|
|
|
public static void DisplayTo(Mobile from, TextDefinition entry, Map map, Point3D loc, string lang)
|
|
{
|
|
if (from?.NetState == null || entry == null)
|
|
{
|
|
return;
|
|
}
|
|
|
|
int xLong = 0, yLat = 0;
|
|
int xMins = 0, yMins = 0;
|
|
bool xEast = false, ySouth = false;
|
|
string fmt;
|
|
|
|
if (Sextant.Format(loc, map, ref xLong, ref yLat, ref xMins, ref yMins, ref xEast, ref ySouth))
|
|
{
|
|
fmt = $"{yLat}°{yMins}'{(ySouth ? "S" : "N")},{xLong}°{xMins}'{(xEast ? "E" : "W")}";
|
|
}
|
|
else
|
|
{
|
|
fmt = "?????";
|
|
}
|
|
|
|
// Gumps do not support non-ascii string arguments. Probably why this was not used on OSI
|
|
var message = entry.Number > 0 ? Localization.Format(entry.Number, lang, $"{fmt}") : string.Format(entry.String, fmt);
|
|
|
|
from.SendGump(new OldMessageGump(message));
|
|
}
|
|
|
|
protected override void BuildLayout(ref StaticGumpBuilder builder)
|
|
{
|
|
builder.AddPage();
|
|
builder.AddBackground(0, 0, Width, Height, 2520);
|
|
builder.AddHtmlPlaceholder(38, 38, Width - 83, Height - 86, "message");
|
|
}
|
|
|
|
protected override void BuildStrings(ref GumpStringsBuilder builder)
|
|
{
|
|
builder.SetStringSlot("message", _message);
|
|
}
|
|
}
|
|
}
|