warrentyexpired/ModernUO
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

perf: Migrate Bulletin/Poll/SOS gumps to DynamicGump (#2418)

Browse source 
## Summary

Migrates three legacy `Gump`-based dialogs to the modern builder API:

- **PlayerBBGump** (`Projects/UOContent/Items/Misc/PlayerBulletinBoards.cs`) — `DynamicGump`. The bulletin board renders a different post per page (variable per-instance state), so the layout cannot be cached. Now `Singleton`, with a private constructor and a static `DisplayTo` entry point. Scroll/banish/delete/post-props buttons mutate `_page` and self-refresh via `SendGump(this)` instead of allocating a fresh gump on every click. Prompt-driven flows (post message / set title / post greeting) re-enter through `DisplayTo` after the prompt completes.
- **MessageGump** + **OldMessageGump** (`Projects/UOContent/Items/Skill Items/Fishing/Misc/SOS.cs`) — `StaticGump<T>`. Both render a fixed structure (background + body + button) where only the formatted sextant coordinate string varies per SOS bottle. The cliloc IDs that *appear in the gump packet* are constant (`MessageGump` uses 1018326; `OldMessageGump` uses no `AddHtmlLocalized` at all — its message is pre-formatted into a string before construction), so the layout cache is safe per the cliloc rule. The varying coordinate text is fed through an HTML placeholder via `BuildStrings`. Both gumps are now `Singleton` with private constructors and static `DisplayTo` entry points.
- **ShardPollGump** (`Projects/UOContent/Misc/ShardPoller.cs`) — `DynamicGump`. The gump's structure changes both with the number of poll options (variable loop) and with the `editing` flag (admin sees radios + add-option row + result percentages; players see only radios). The dual-purpose view is preserved as a single `DynamicGump` with the `editing` flag still controlling layout shape — staff path verified to still render the editor with the totals header, vote percentages, and "Create new option" radio. `Closable = false` becomes `builder.SetNoClose()`. Now `Singleton`, with private constructor and a `DisplayTo` that returns the gump instance so `EventSink_Login_Callback` can still call `QueuePoll` on it. The cancel/edit re-issue paths use `SendGump(this)` for self-refresh; the queued login flow uses `DisplayTo` so each queued poll gets its own gump.

External callers (`OnDoubleClick`, `PostPrompt`, `SetTitlePrompt`, `ShardPollPrompt`, `EventSink_Login_Callback`, the Timer-delayed queued poll send) all updated to use the new `DisplayTo` entry points. Legacy `m_X` field naming was already absent in two of the three files; the bulletin board fields kept their `_camelCase` names. `dotnet build Projects/UOContent/UOContent.csproj` reports 0 warnings, 0 errors.
This commit is contained in:
Kamron Batman 2026-04-25 20:49:12 -07:00 • committed by GitHub
parent 4e565ca6da
commit 802849bebc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 203 additions and 123 deletions
Download patch file Download diff file Expand all files Collapse all files

80
Projects/UOContent/Items/Skill Items/Fishing/Misc/SOS.cs
View file

@ -127,11 +127,11 @@ public partial class SOS : Item
if (UseNewMessages || entry == null)
{
from.SendGump(new MessageGump(TargetMap, TargetLocation));
MessageGump.DisplayTo(from, TargetMap, TargetLocation);
}
else
{
from.SendGump(new OldMessageGump(entry, TargetMap, TargetLocation, from.Language));
OldMessageGump.DisplayTo(from, entry, TargetMap, TargetLocation, from.Language);
}
}
else
@ -226,10 +226,24 @@ public partial class SOS : Item
return water;
}
private class MessageGump : Gump
private class MessageGump : StaticGump<MessageGump>
{
public MessageGump(Map map, Point3D loc) : base(150, 50)
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;
@ -244,31 +258,55 @@ public partial class SOS : Item
fmt = "?????";
}
AddPage(0);
from.SendGump(new MessageGump(fmt));
}
AddBackground(0, 40, 350, 300, 2520);
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.
*/
AddHtmlLocalized(30, 80, 285, 160, 1018326, true, true);
builder.AddHtmlLocalized(30, 80, 285, 160, 1018326, true, true);
AddHtml(35, 240, 230, 20, fmt);
builder.AddHtmlPlaceholder(35, 240, 230, 20, "fmt");
AddButton(35, 265, 4005, 4007, 0);
AddHtmlLocalized(70, 265, 100, 20, 1011036); // OKAY
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 : Gump
private class OldMessageGump : StaticGump<OldMessageGump>
{
private const int Width = 350;
private const int Height = 300;
public OldMessageGump(TextDefinition entry, Map map, Point3D loc, string lang) : base((640 - Width) / 2, (480 - Height) / 2)
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;
@ -283,12 +321,22 @@ public partial class SOS : Item
fmt = "?????";
}
AddPage(0);
AddBackground(0, 0, Width, Height, 2520);
// 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);
AddHtml(38, 38, Width - 83, Height - 86, message);
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);
}
}
}