ModernUO/Projects/UOContent/Items/Deeds/HolidayTreeDeed.cs
Kamron Batman 598c3c125c
perf: Migrate Item Interaction gumps to DynamicGump/StaticGump (#2421)
## Summary

Migrates 11 player-facing Item Interaction gumps from legacy `Gump` to `StaticGump<T>` or `DynamicGump`.

| File | Gump | Base | Reason |
|---|---|---|---|
| `Items/Deeds/NameChangeDeed.cs` | `NameChangeDeedGump` | `StaticGump<T>` | Fully fixed layout |
| `Items/Deeds/HairRestylingDeed.cs` | `HairRestylingDeedGump` (renamed from `InternalGump`) | `DynamicGump` | Per-race/per-gender cliloc IDs and gump images vary every instance |
| `Items/Deeds/HolidayTreeDeed.cs` | `HolidayTreeChoiceGump` | `StaticGump<T>` | Fully fixed (Classic/Modern radio) |
| `Items/Deeds/NewPlayerTicket.cs` | `NewPlayerTicketGump` (renamed from `InternalGump`) | `StaticGump<T>` | Fully fixed gift menu |
| `Items/Misc/PromotionalToken.cs` | `PromotionalTokenGump` | `DynamicGump` | `TextDefinition` (`ItemGumpName`) varies per token subclass — cliloc/string differs |
| `Items/Misc/SpecialHairDye.cs` | `SpecialHairDyeGump` | `StaticGump<T>` | Static entry array drives a fixed layout |
| `Items/Misc/InteriorDecorator.cs` | `InteriorDecoratorGump` (renamed from `InternalGump`) | `DynamicGump` | Button art flips per `decorator.Command` (Turn/Up/Down) |
| `Items/Special/8th Anniversary Items/Dawn's Music Box/DawnsMusicBoxGump.cs` | `DawnsMusicBoxGump` | `DynamicGump` | Page count derived from variable `Tracks.Count` |
| `Items/Misc/PowerGenerator.cs` | `PowerGeneratorGump` (renamed from `GameGump`) | `DynamicGump` | Variable side length 3-6 and per-step node hues |
| `Gumps/HeritageTokenGump.cs` | `HeritageTokenGump` | `StaticGump<T>` | All 7 pages fully baked — only static cliloc IDs |
| `Gumps/ConfirmHeritageGump.cs` | `ConfirmHeritageGump` | `DynamicGump` | Confirmation cliloc chosen at runtime per item selected |

All gumps use `Singleton => true`, private constructors, and a static `DisplayTo` entry point that validates prerequisites before constructing.

External callers updated (`HeritageToken`, `DawnsMusicBox`) to the new `DisplayTo` entry points. `Console.WriteLine` in `ConfirmHeritageGump` exception handler replaced with `LogFactory`-backed logger.
2026-04-26 11:31:49 -07:00

166 lines
4.2 KiB
C#

using ModernUO.Serialization;
using Server.Gumps;
using Server.Multis;
using Server.Network;
using Server.Targeting;
namespace Server.Items;
[SerializationGenerator(0, false)]
public partial class HolidayTreeDeed : Item
{
[Constructible]
public HolidayTreeDeed() : base(0x14F0)
{
Hue = 0x488;
LootType = LootType.Blessed;
}
public override double DefaultWeight => 1.0;
public override int LabelNumber => 1041116; // a deed for a holiday tree
public bool ValidatePlacement(Mobile from, Point3D loc)
{
if (from.AccessLevel >= AccessLevel.GameMaster)
{
return true;
}
if (!from.InRange(GetWorldLocation(), 1))
{
from.SendLocalizedMessage(500446); // That is too far away.
return false;
}
if (Core.Now.Month != 12)
{
from.SendLocalizedMessage(
1005700
); // You will have to wait till next December to put your tree back up for display.
return false;
}
var map = from.Map;
if (map == null)
{
return false;
}
var house = BaseHouse.FindHouseAt(loc, map, 20);
if (house?.IsFriend(from) != true)
{
from.SendLocalizedMessage(1005701); // The holiday tree can only be placed in your house.
return false;
}
if (!map.CanFit(loc, 20))
{
from.SendLocalizedMessage(500269); // You cannot build that there.
return false;
}
return true;
}
public void BeginPlace(Mobile from, HolidayTreeType type)
{
from.BeginTarget(-1, true, TargetFlags.None, Placement_OnTarget, type);
}
public void Placement_OnTarget(Mobile from, object targeted, HolidayTreeType type)
{
if (targeted is not IPoint3D p)
{
return;
}
var loc = new Point3D(p);
if (p is StaticTarget target)
/* NOTE: OSI does not properly normalize Z positioning here.
* A side affect is that you can only place on floors (due to the CanFit call).
* That functionality may be desired. And so, it's included in this script.
*/
{
loc.Z -= TileData.ItemTable[target.ItemID]
.CalcHeight;
}
if (ValidatePlacement(from, loc))
{
EndPlace(from, type, loc);
}
}
public void EndPlace(Mobile from, HolidayTreeType type, Point3D loc)
{
Delete();
var tree = new HolidayTree(from, type, loc);
BaseHouse.FindHouseAt(tree)?.Addons.Add(tree);
}
public override void OnDoubleClick(Mobile from)
{
HolidayTreeChoiceGump.DisplayTo(from, this);
}
}
public class HolidayTreeChoiceGump : StaticGump<HolidayTreeChoiceGump>
{
private readonly HolidayTreeDeed _deed;
public override bool Singleton => true;
private HolidayTreeChoiceGump(HolidayTreeDeed deed) : base(200, 200) => _deed = deed;
public static void DisplayTo(Mobile from, HolidayTreeDeed deed)
{
if (from?.NetState == null || deed?.Deleted != false)
{
return;
}
from.SendGump(new HolidayTreeChoiceGump(deed));
}
protected override void BuildLayout(ref StaticGumpBuilder builder)
{
builder.AddPage();
builder.AddBackground(0, 0, 220, 120, 5054);
builder.AddBackground(10, 10, 200, 100, 3000);
builder.AddButton(20, 35, 4005, 4007, 1);
builder.AddHtmlLocalized(55, 35, 145, 25, 1018322); // Classic
builder.AddButton(20, 65, 4005, 4007, 2);
builder.AddHtmlLocalized(55, 65, 145, 25, 1018321); // Modern
}
public override void OnResponse(NetState sender, in RelayInfo info)
{
if (_deed.Deleted)
{
return;
}
var from = sender.Mobile;
switch (info.ButtonID)
{
case 1:
{
_deed.BeginPlace(from, HolidayTreeType.Classic);
break;
}
case 2:
{
_deed.BeginPlace(from, HolidayTreeType.Modern);
break;
}
}
}
}