feat: Adds optimized dynamic/static layout gumps (#1652)

# New Gump API
We are pleased to release a new API that is faster, allocates nearly zero memory, and still feels very similar to the original API. The API is broken into 3 types of gumps, dynamic, static with placeholders, and static without placeholders. 

### Dynamic Gumps
These gumps will inherit `DynamicGump` and are meant for gumps that have a dynamic layout. This includes specifying dynamic arguments to HtmlLocalized entries.

## Static Gumps 
Static gumps are those where the function to the build the layout is called only once and cached forever. They can optionally have placeholders. These placeholders allow the developer to specify the string values later, dynamically in a `BuildStrings` method on the gump. If a gump does not have any placeholders, the string entries will also be cached forever.

## Benchmarks
To make sure we were going in the right direction and not wasting time, we took copious benchmarks. Here are the final benchmarks for a really simple gump. 

Note:
* The majority of creating a gump is compressing the layout and the strings. Compressing each section takes ~6,000ns (12us total).

```cs
| Method                         | Mean         | Error        | StdDev       | Median       | Ratio | RatioSD | Gen0   | Allocated | Alloc Ratio |
|------------------------------- |-------------:|-------------:|-------------:|-------------:|------:|--------:|-------:|----------:|------------:|
| OldGump                        | 13,308.29 ns | 1,059.695 ns | 1,883.608 ns | 14,330.72 ns | 1.000 |    0.00 | 0.1526 |    2400 B |        1.00 |
| DynamicLayoutGump              | 13,357.86 ns |   129.144 ns |   226.185 ns | 13,323.60 ns | 1.029 |    0.17 |      - |      48 B |        0.02 |
| StaticLayoutDynamicStringsGump |  6,653.10 ns |    81.815 ns |   143.292 ns |  6,617.45 ns | 0.514 |    0.09 |      - |      40 B |        0.02 |
| StaticLayoutGump               |     86.33 ns |     0.760 ns |     1.350 ns |     86.07 ns | 0.007 |    0.00 | 0.0020 |      32 B |        0.01 |
```

# Non-Breaking Changes
* All gump components in the core have been moved to `Gumps/Legacy`.
* All legacy gumps will still inherit `Gump`, which now inherits `BaseGump`

# Special Thanks

Thank you to @stefanomerotta for considerable contributions/benchmarking/testing to make this effort a reality! We collectively went through over 10 iterations, but it is finally ready.

Projects/Server/Gumps/Legacy/Gump.cs

@@ -0,0 +1,257 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: Gump.cs                                                         *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Collections.Generic;
+using Server.Network;
+using Server.Utilities;
+
+namespace Server.Gumps;
+
+public class Gump : BaseGump
+{
+    private int _switches;
+    private int _textEntries;
+
+    public Gump(int x, int y)
+    {
+        X = x;
+        Y = y;
+
+        Entries = [];
+        Strings = [];
+    }
+
+    public List<string> Strings { get; }
+
+    public List<GumpEntry> Entries { get; }
+
+    public bool Disposable { get; set; } = true;
+
+    public bool Resizable { get; set; } = true;
+
+    public bool Draggable { get; set; } = true;
+
+    public bool Closable { get; set; } = true;
+
+    public override int Switches => _switches;
+
+    public override int TextEntries => _textEntries;
+
+    public void AddPage(int page)
+    {
+        Add(new GumpPage(page));
+    }
+
+    public void AddAlphaRegion(int x, int y, int width, int height)
+    {
+        Add(new GumpAlphaRegion(x, y, width, height));
+    }
+
+    public void AddBackground(int x, int y, int width, int height, int gumpID)
+    {
+        Add(new GumpBackground(x, y, width, height, gumpID));
+    }
+
+    public void AddButton(
+        int x, int y, int normalID, int pressedID, int buttonID,
+        GumpButtonType type = GumpButtonType.Reply, int param = 0
+    )
+    {
+        Add(new GumpButton(x, y, normalID, pressedID, buttonID, type, param));
+    }
+
+    public void AddCheck(int x, int y, int inactiveID, int activeID, bool initialState, int switchID)
+    {
+        Add(new GumpCheck(x, y, inactiveID, activeID, initialState, switchID));
+    }
+
+    public void AddGroup(int group)
+    {
+        Add(new GumpGroup(group));
+    }
+
+    public void AddTooltip(int number, string args = null)
+    {
+        Add(new GumpTooltip(number, args));
+    }
+
+    public void AddHtml(
+        int x, int y, int width, int height, string text, bool background = false, bool scrollbar = false
+    )
+    {
+        Add(new GumpHtml(x, y, width, height, text, background, scrollbar));
+    }
+
+    public void AddHtmlLocalized(
+        int x, int y, int width, int height, int number, bool background = false,
+        bool scrollbar = false
+    )
+    {
+        Add(new GumpHtmlLocalized(x, y, width, height, number, background, scrollbar));
+    }
+
+    public void AddHtmlLocalized(
+        int x, int y, int width, int height, int number, int color, bool background = false,
+        bool scrollbar = false
+    )
+    {
+        Add(new GumpHtmlLocalized(x, y, width, height, number, color, background, scrollbar));
+    }
+
+    public void AddHtmlLocalized(
+        int x, int y, int width, int height, int number, string args, int color,
+        bool background = false, bool scrollbar = false
+    )
+    {
+        Add(new GumpHtmlLocalized(x, y, width, height, number, args, color, background, scrollbar));
+    }
+
+    public void AddImage(int x, int y, int gumpID, int hue = 0)
+    {
+        Add(new GumpImage(x, y, gumpID, hue));
+    }
+
+    public void AddImageTiled(int x, int y, int width, int height, int gumpID)
+    {
+        Add(new GumpImageTiled(x, y, width, height, gumpID));
+    }
+
+    public void AddImageTiledButton(
+        int x, int y, int normalID, int pressedID, int buttonID, GumpButtonType type,
+        int param, int itemID, int hue, int width, int height
+    )
+    {
+        Add(
+            new GumpImageTileButton(
+                x,
+                y,
+                normalID,
+                pressedID,
+                buttonID,
+                type,
+                param,
+                itemID,
+                hue,
+                width,
+                height
+            )
+        );
+    }
+
+    public void AddItem(int x, int y, int itemID, int hue = 0)
+    {
+        Add(new GumpItem(x, y, itemID, hue));
+    }
+
+    public void AddLabel(int x, int y, int hue, string text)
+    {
+        Add(new GumpLabel(x, y, hue, text));
+    }
+
+    public void AddLabelHtml(int x, int y, int width, int height, string text, string hue, int size = 4, bool center = true)
+    {
+        AddHtml(x, y, width, height, center ? text.Center(hue, size) : text.Color(hue, size));
+    }
+
+    public void AddLabelCropped(int x, int y, int width, int height, int hue, string text)
+    {
+        Add(new GumpLabelCropped(x, y, width, height, hue, text));
+    }
+
+    public void AddRadio(int x, int y, int inactiveID, int activeID, bool initialState, int switchID)
+    {
+        Add(new GumpRadio(x, y, inactiveID, activeID, initialState, switchID));
+    }
+
+    public void AddTextEntry(int x, int y, int width, int height, int hue, int entryID, string initialText)
+    {
+        Add(new GumpTextEntry(x, y, width, height, hue, entryID, initialText));
+    }
+
+    public void AddTextEntry(int x, int y, int width, int height, int hue, int entryID, string initialText, int size)
+    {
+        Add(new GumpTextEntryLimited(x, y, width, height, hue, entryID, initialText, size));
+    }
+
+    public void AddItemProperty(Serial serial)
+    {
+        Add(new GumpItemProperty(serial));
+    }
+
+    public void AddSpriteImage(int x, int y, int gumpID, int width, int height, int sx, int sy)
+    {
+        Add(new GumpSpriteImage(x, y, gumpID, width, height, sx, sy));
+    }
+
+    public void AddECHandleInput()
+    {
+        Add(new GumpECHandleInput());
+    }
+
+    public void AddGumpIDOverride(int gumpID)
+    {
+        Add(new GumpMasterGump(gumpID));
+    }
+
+    public void Add(GumpEntry g)
+    {
+        if (g.Parent != this)
+        {
+            g.Parent = this;
+        }
+        else if (!Entries.Contains(g))
+        {
+            Entries.Add(g);
+        }
+    }
+
+    public void Remove(GumpEntry g)
+    {
+        if (g == null || !Entries.Contains(g))
+        {
+            return;
+        }
+
+        Entries.Remove(g);
+        g.Parent = null;
+    }
+
+    public int Intern(string value)
+    {
+        var indexOf = Strings.IndexOf(value);
+
+        if (indexOf >= 0)
+        {
+            return indexOf;
+        }
+
+        Strings.Add(value);
+        return Strings.Count - 1;
+    }
+
+    public override void SendTo(NetState state)
+    {
+        state.AddGump(this);
+        state.SendDisplayGump(this, out _switches, out _textEntries);
+    }
+
+    protected void Reset()
+    {
+        _switches = 0;
+        _textEntries = 0;
+        Entries.Clear();
+        Strings.Clear();
+    }
+}

Projects/Server/Gumps/Legacy/GumpAlphaRegion.cs

@@ -0,0 +1,43 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpAlphaRegion.cs                                              *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpAlphaRegion : GumpEntry
+{
+    public GumpAlphaRegion(int x, int y, int width, int height)
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii($"{{ checkertrans {X} {Y} {Width} {Height} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpBackground.cs

@@ -0,0 +1,46 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpBackground.cs                                               *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpBackground : GumpEntry
+{
+    public GumpBackground(int x, int y, int width, int height, int gumpID)
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        GumpID = gumpID;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public int GumpID { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii($"{{ resizepic {X} {Y} {GumpID} {Width} {Height} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpButton.cs

@@ -0,0 +1,61 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpButton.cs                                                   *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public enum GumpButtonType
+{
+    Page = 0,
+    Reply = 1
+}
+
+public class GumpButton : GumpEntry
+{
+    public GumpButton(
+        int x, int y, int normalID, int pressedID, int buttonID,
+        GumpButtonType type = GumpButtonType.Reply, int param = 0
+    )
+    {
+        X = x;
+        Y = y;
+        NormalID = normalID;
+        PressedID = pressedID;
+        ButtonID = buttonID;
+        Type = type;
+        Param = param;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int NormalID { get; set; }
+
+    public int PressedID { get; set; }
+
+    public int ButtonID { get; set; }
+
+    public GumpButtonType Type { get; set; }
+
+    public int Param { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii($"{{ button {X} {Y} {NormalID} {PressedID} {(int)Type} {Param} {ButtonID} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpCheck.cs

@@ -0,0 +1,51 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpCheck.cs                                                    *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpCheck : GumpEntry
+{
+    public GumpCheck(int x, int y, int inactiveID, int activeID, bool initialState, int switchID)
+    {
+        X = x;
+        Y = y;
+        InactiveID = inactiveID;
+        ActiveID = activeID;
+        InitialState = initialState;
+        SwitchID = switchID;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int InactiveID { get; set; }
+
+    public int ActiveID { get; set; }
+
+    public bool InitialState { get; set; }
+
+    public int SwitchID { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var initialState = InitialState ? "1" : "0";
+        writer.WriteAscii($"{{ checkbox {X} {Y} {InactiveID} {ActiveID} {initialState} {SwitchID} }}");
+        switches++;
+    }
+}

Projects/Server/Gumps/Legacy/GumpECHandleInput.cs

@@ -0,0 +1,27 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpECHandleInput.cs                                            *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpECHandleInput : GumpEntry
+{
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.Write("{ echandleinput }"u8);
+    }
+}

Projects/Server/Gumps/Legacy/GumpEntry.cs

@@ -0,0 +1,29 @@
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public abstract class GumpEntry
+{
+    private Gump m_Parent;
+
+    public Gump Parent
+    {
+        get => m_Parent;
+        set
+        {
+            if (m_Parent != value)
+            {
+                m_Parent?.Remove(this);
+
+                m_Parent = value;
+
+                m_Parent?.Add(this);
+            }
+        }
+    }
+
+    // TODO: Replace OrderedHashSet with InsertOnlyHashSet, a copy of HashSet that is ReadOnly compatible, but includes
+    // a public AddIfNotPresent function that returns the index of the element
+    public abstract void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches);
+}

Projects/Server/Gumps/Legacy/GumpGroup.cs

@@ -0,0 +1,38 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpGroup.cs                                                    *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpGroup : GumpEntry
+{
+    public GumpGroup(int group) => Group = group;
+
+    public int Group { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        if (Group == 1)
+        {
+            writer.Write("{ group 1 }"u8);
+        }
+        else
+        {
+            writer.WriteAscii($"{{ group {Group} }}");
+        }
+    }
+}

Projects/Server/Gumps/Legacy/GumpHtml.cs

@@ -0,0 +1,55 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpHtml.cs                                                     *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpHtml : GumpEntry
+{
+    public GumpHtml(int x, int y, int width, int height, string text, bool background, bool scrollbar)
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        Text = text;
+        Background = background;
+        Scrollbar = scrollbar;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public string Text { get; set; }
+
+    public bool Background { get; set; }
+
+    public bool Scrollbar { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var textIndex = strings.GetOrAdd(Text ?? "");
+        var background = Background ? "1" : "0";
+        var scrollbar = Scrollbar ? "1" : "0";
+        writer.WriteAscii($"{{ htmlgump {X} {Y} {Width} {Height} {textIndex} {background} {scrollbar} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpHtmlLocalized.cs

@@ -0,0 +1,120 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpHtmlLocalized.cs                                            *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public enum GumpHtmlLocalizedType
+{
+    Plain,
+    Color,
+    Args
+}
+
+public class GumpHtmlLocalized : GumpEntry
+{
+    public GumpHtmlLocalized(
+        int x, int y, int width, int height, int number,
+        bool background = false, bool scrollbar = false
+    )
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        Number = number;
+        Background = background;
+        Scrollbar = scrollbar;
+
+        Type = GumpHtmlLocalizedType.Plain;
+    }
+
+    public GumpHtmlLocalized(
+        int x, int y, int width, int height, int number, int color,
+        bool background = false, bool scrollbar = false
+    )
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        Number = number;
+        Color = color;
+        Background = background;
+        Scrollbar = scrollbar;
+
+        Type = GumpHtmlLocalizedType.Color;
+    }
+
+    public GumpHtmlLocalized(
+        int x, int y, int width, int height, int number, string args, int color,
+        bool background = false, bool scrollbar = false
+    )
+    {
+        // Are multiple arguments unsupported? And what about non ASCII arguments?
+
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        Number = number;
+        Args = args;
+        Color = color;
+        Background = background;
+        Scrollbar = scrollbar;
+
+        Type = GumpHtmlLocalizedType.Args;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public int Number { get; set; }
+
+    public string Args { get; set; }
+
+    public int Color { get; set; }
+
+    public bool Background { get; set; }
+
+    public bool Scrollbar { get; set; }
+
+    public GumpHtmlLocalizedType Type { get; set; }
+
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var background = Background ? "1" : "0";
+        var scrollbar = Scrollbar ? "1" : "0";
+        writer.WriteAscii(
+            Type switch
+            {
+                GumpHtmlLocalizedType.Plain =>
+                    $"{{ xmfhtmlgump {X} {Y} {Width} {Height} {Number} {background} {scrollbar} }}",
+                GumpHtmlLocalizedType.Color =>
+                    $"{{ xmfhtmlgumpcolor {X} {Y} {Width} {Height} {Number} {background} {scrollbar} {Color} }}",
+                _ =>
+                    $"{{ xmfhtmltok {X} {Y} {Width} {Height} {background} {scrollbar} {Color} {Number} @{Args}@ }}"
+            }
+        );
+    }
+}

Projects/Server/Gumps/Legacy/GumpImage.cs

@@ -0,0 +1,56 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpImage.cs                                                    *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpImage : GumpEntry
+{
+    public GumpImage(int x, int y, int gumpID, int hue = 0, string cls = null)
+    {
+        X = x;
+        Y = y;
+        GumpID = gumpID;
+        Hue = hue;
+        Class = cls;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int GumpID { get; set; }
+
+    public int Hue { get; set; }
+
+    public string Class { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var hasHue = Hue != 0;
+        var hasClass = !string.IsNullOrEmpty(Class);
+        writer.WriteAscii(
+            hasHue switch
+            {
+                true when hasClass  => $"{{ gumppic {X} {Y} {GumpID} hue={Hue} class={Class} }}",
+                true                => $"{{ gumppic {X} {Y} {GumpID} hue={Hue} }}",
+                false when hasClass => $"{{ gumppic {X} {Y} {GumpID} class={Class} }}",
+                false               => $"{{ gumppic {X} {Y} {GumpID} }}",
+            }
+        );
+    }
+}

Projects/Server/Gumps/Legacy/GumpImageTileButton.cs

@@ -0,0 +1,70 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpImageTileButton.cs                                          *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpImageTileButton : GumpEntry
+{
+    public GumpImageTileButton(
+        int x, int y, int normalID, int pressedID, int buttonID, GumpButtonType type, int param,
+        int itemID, int hue, int width, int height
+    )
+    {
+        X = x;
+        Y = y;
+        NormalID = normalID;
+        PressedID = pressedID;
+        ButtonID = buttonID;
+        Type = type;
+        Param = param;
+
+        ItemID = itemID;
+        Hue = hue;
+        Width = width;
+        Height = height;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int NormalID { get; set; }
+
+    public int PressedID { get; set; }
+
+    public int ButtonID { get; set; }
+
+    public GumpButtonType Type { get; set; }
+
+    public int Param { get; set; }
+
+    public int ItemID { get; set; }
+
+    public int Hue { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii(
+            $"{{ buttontileart {X} {Y} {NormalID} {PressedID} {(int)Type} {Param} {ButtonID} {ItemID} {Hue} {Width} {Height} }}"
+        );
+    }
+}

Projects/Server/Gumps/Legacy/GumpImageTiled.cs

@@ -0,0 +1,46 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpImageTiled.cs                                               *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpImageTiled : GumpEntry
+{
+    public GumpImageTiled(int x, int y, int width, int height, int gumpID)
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        GumpID = gumpID;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public int GumpID { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii($"{{ gumppictiled {X} {Y} {Width} {Height} {GumpID} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpItem.cs

@@ -0,0 +1,43 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpItem.cs                                                     *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpItem : GumpEntry
+{
+    public GumpItem(int x, int y, int itemID, int hue = 0)
+    {
+        X = x;
+        Y = y;
+        ItemID = itemID;
+        Hue = hue;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int ItemID { get; set; }
+
+    public int Hue { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii(Hue == 0 ? $"{{ tilepic {X} {Y} {ItemID} }}" : $"{{ tilepichue {X} {Y} {ItemID} {Hue} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpItemProperty.cs

@@ -0,0 +1,31 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpItemProperty.cs                                             *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpItemProperty : GumpEntry
+{
+    public GumpItemProperty(Serial serial) => Serial = serial;
+
+    public Serial Serial { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii($"{{ itemproperty {Serial.Value} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpLabel.cs

@@ -0,0 +1,44 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpLabel.cs                                                    *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpLabel : GumpEntry
+{
+    public GumpLabel(int x, int y, int hue, string text)
+    {
+        X = x;
+        Y = y;
+        Hue = hue;
+        Text = text;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Hue { get; set; }
+
+    public string Text { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var textIndex = strings.GetOrAdd(Text ?? "");
+        writer.WriteAscii($"{{ text {X} {Y} {Hue} {textIndex} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpLabelCropped.cs

@@ -0,0 +1,50 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpLabelCropped.cs                                             *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpLabelCropped : GumpEntry
+{
+    public GumpLabelCropped(int x, int y, int width, int height, int hue, string text)
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        Hue = hue;
+        Text = text;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public int Hue { get; set; }
+
+    public string Text { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var textIndex = strings.GetOrAdd(Text ?? "");
+        writer.WriteAscii($"{{ croppedtext {X} {Y} {Width} {Height} {Hue} {textIndex} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpMasterGump.cs

@@ -0,0 +1,31 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpMasterGump.cs                                               *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpMasterGump : GumpEntry
+{
+    public GumpMasterGump(int gumpID) => GumpID = gumpID;
+
+    public int GumpID { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii($"{{ mastergump {GumpID} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpPage.cs

@@ -0,0 +1,38 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpPage.cs                                                     *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpPage : GumpEntry
+{
+    public GumpPage(int page) => Page = page;
+
+    public int Page { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        if (Page == 0)
+        {
+            writer.Write("{ page 0 }"u8);
+        }
+        else
+        {
+            writer.WriteAscii($"{{ page {Page} }}");
+        }
+    }
+}

Projects/Server/Gumps/Legacy/GumpRadio.cs

@@ -0,0 +1,51 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpRadio.cs                                                    *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpRadio : GumpEntry
+{
+    public GumpRadio(int x, int y, int inactiveID, int activeID, bool initialState, int switchID)
+    {
+        X = x;
+        Y = y;
+        InactiveID = inactiveID;
+        ActiveID = activeID;
+        InitialState = initialState;
+        SwitchID = switchID;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int InactiveID { get; set; }
+
+    public int ActiveID { get; set; }
+
+    public bool InitialState { get; set; }
+
+    public int SwitchID { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var initialState = InitialState ? "1" : "0";
+        writer.WriteAscii($"{{ radio {X} {Y} {InactiveID} {ActiveID} {initialState} {SwitchID} }}");
+        switches++;
+    }
+}

Projects/Server/Gumps/Legacy/GumpSpriteImage.cs

@@ -0,0 +1,52 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpSpriteImage.cs                                              *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpSpriteImage : GumpEntry
+{
+    public GumpSpriteImage(int x, int y, int gumpID, int width, int height, int sx, int sy)
+    {
+        X = x;
+        Y = y;
+        GumpID = gumpID;
+        Width = width;
+        Height = height;
+        SX = sx;
+        SY = sy;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public int GumpID { get; set; }
+
+    public int SX { get; set; }
+
+    public int SY { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii($"{{ picinpic {X} {Y} {GumpID} {Width} {Height} {SX} {SY} }}");
+    }
+}

Projects/Server/Gumps/Legacy/GumpTextEntry.cs

@@ -0,0 +1,54 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpTextEntry.cs                                                *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpTextEntry : GumpEntry
+{
+    public GumpTextEntry(int x, int y, int width, int height, int hue, int entryID, string initialText)
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        Hue = hue;
+        EntryID = entryID;
+        InitialText = initialText;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public int Hue { get; set; }
+
+    public int EntryID { get; set; }
+
+    public string InitialText { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var textIndex = strings.GetOrAdd(InitialText ?? "");
+        writer.WriteAscii($"{{ textentry {X} {Y} {Width} {Height} {Hue} {EntryID} {textIndex} }}");
+        entries++;
+    }
+}

Projects/Server/Gumps/Legacy/GumpTextEntryLimited.cs

@@ -0,0 +1,59 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpTextEntryLimited.cs                                         *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+public class GumpTextEntryLimited : GumpEntry
+{
+    public GumpTextEntryLimited(
+        int x, int y, int width, int height, int hue, int entryID, string initialText, int size = 0
+    )
+    {
+        X = x;
+        Y = y;
+        Width = width;
+        Height = height;
+        Hue = hue;
+        EntryID = entryID;
+        InitialText = initialText;
+        Size = size;
+    }
+
+    public int X { get; set; }
+
+    public int Y { get; set; }
+
+    public int Width { get; set; }
+
+    public int Height { get; set; }
+
+    public int Hue { get; set; }
+
+    public int EntryID { get; set; }
+
+    public string InitialText { get; set; }
+
+    public int Size { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        var textIndex = strings.GetOrAdd(InitialText ?? "");
+        writer.WriteAscii($"{{ textentrylimited {X} {Y} {Width} {Height} {Hue} {EntryID} {textIndex} {Size} }}");
+        entries++;
+    }
+}

Projects/Server/Gumps/Legacy/GumpTooltip.cs

@@ -0,0 +1,39 @@
+/*************************************************************************
+ * ModernUO                                                              *
+ * Copyright 2019-2024 - ModernUO Development Team                       *
+ * Email: hi@modernuo.com                                                *
+ * File: GumpTooltip.cs                                                  *
+ *                                                                       *
+ * This program is free software: you can redistribute it and/or modify  *
+ * it under the terms of the GNU General Public License as published by  *
+ * the Free Software Foundation, either version 3 of the License, or     *
+ * (at your option) any later version.                                   *
+ *                                                                       *
+ * You should have received a copy of the GNU General Public License     *
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ *************************************************************************/
+
+using System.Buffers;
+using Server.Collections;
+
+namespace Server.Gumps;
+
+// Note, on OSI, the tooltip supports ONLY clilocs as far as I can figure out,
+// and the tooltip ONLY works after the buttonTileArt (as far as I can tell from testing)
+public class GumpTooltip : GumpEntry
+{
+    public GumpTooltip(int number, string args)
+    {
+        Number = number;
+        Args = args;
+    }
+
+    public int Number { get; set; }
+
+    public string Args { get; set; }
+
+    public override void AppendTo(ref SpanWriter writer, OrderedHashSet<string> strings, ref int entries, ref int switches)
+    {
+        writer.WriteAscii(string.IsNullOrEmpty(Args) ? $"{{ tooltip {Number} }}" : $"{{ tooltip {Number} @{Args}@ }}");
+    }
+}