ModernUO/Projects/UOContent/Engines/Craft/T2A/TinkeringMenu.cs
Kamron Batman 16bf3016fb
feat: Pre-Publish 14 Crafting (supersedes #2181, #2381) (#2476)
## Summary

Adds authentic **T2A-era (pre-UO:Third-Dawn) packet-based crafting menus**, enabled via the **`t2aCraftMenus` server setting** (read once at startup; default **`!Core.UOTD`**, so a pre-UO:TD shard gets them automatically). When enabled, double-clicking a crafting tool opens the classic `0x7C`/`0x7D` item-list menu — skill- and material-filtered — instead of the modern gump, covering all 8 tool/skill crafts (blacksmithy, tailoring, tinkering, carpentry, alchemy, bowcraft/fletching, inscription, cartography). It is **not** a runtime/admin-flippable feature flag.

This is the **definitive, reconciled** branch and **supersedes**:
- **#2181** (Delphi — `T2A_CraftingMenus`): the original effort.
- **#2381** (Jack/UOLL — `t2a_crafting_menus`): the research-grounded superset (Delphi's base + 12 corrections), rebased onto current `main`.

Original authorship is preserved across the cherry-picked history: foundation commit **@Delphi79**, mechanic fixes **@jackuoll (Jack Ward)**, reconciliation/fixes/docs mine.

## How it was built

1. Cherry-picked Jack's 13 commits onto current `main` (superset of Delphi's; only 2 trivial FeatureFlags conflicts).
2. Applied targeted fixes (below) with tests.
3. Full convention audit, build, and test pass.

Grounded in independent historical research plus Jack's deep dive. Maintainer reference: `dev-docs/t2a-crafting.md`.

## Mechanics (highlights)

- Double-click tool → target resource → skill/material-filtered menu → craft. Resource pre-selection per skill; make-last by targeting the tool.
- **Stacked-gem jewelry:** target a gem stack → the **full stack** is consumed and the piece is named by count ("a 1000 diamond ring"); count persists (`BaseJewel` serialization **v4 → v5**, new `_gemCount`).
- **Tool-less inscription & cartography** (skill-list invoked; no pen/sextant); inscription consumes reagents+scroll on success and failure, mana only on success.
- **Tailoring matching-hue consumption:** targeting hued cloth/leather consumes only that hue. Crafted items take color from their **`CraftResource`** (not the dyed hue), so dyed leather/cloth don't tint the product; in T2A only colored ingots/ore color items (metal armor/shields).
- **Half-resources on failed non-scroll crafts** (pre-UO:TD).
- **Maker's mark** always prompted for exceptional items, via the shared `QueryMakersMarkGump`.
- Server-side menu infra changes are additive (`ItemListEntry.CraftIndex`, `Entries` setter, `HasSent`).

## Notable changes on top of the cherry-pick

- **Toggle is a startup server setting, not a feature flag.** Removed `ContentFeatureFlags.T2ACraftMenus` (and its admin-flippable plumbing); the value is read once via `ServerConfiguration.GetSetting("t2aCraftMenus", !Core.UOTD)` into `T2ACraftSystem.Enabled`. Since the default tracks the era and it can't be flipped at runtime, there's no incoherent "menus-on / UO:TD-era" state.
- **Stacked-gem consumption (B3a/B3):** consume the full `PendingGemCount` (was deliberately consuming 1 while naming by the stack), null-safe gem type, plain-piece fallback + message. New `T2AJewelGemCraftTests`.
- **Convention audit:** `new List<Item>()` → `PooledRefList<Item>` on the hue-aware consume path; removed dead code.

## Decisions & deviations

- `make-last` kept as **QoL** (post-T2A gump-era feature).
- `half-on-failure` (non-scroll) kept as a **reconstruction** (not OSI-confirmed).
- **Stacked-gem** behavior set per shard authority (overrides the "single gem" reconstruction).
- **Cooking** out of scope (no T2A crafting menu existed for it).
- **No colored items from dyed materials:** crafted color comes from the `CraftResource` type. Pre-AOS leather has no colored variant, so leather is always uncolored; weapons retain resource color only in AOS+ (unchanged, intended).

## Test plan

- Automated: `dotnet build ModernUO.slnx -c Debug` clean; `dotnet test Projects/UOContent.Tests` → **421 passed** (incl. 3 new jewelry tests).
- Manual (needs a running T2A shard + client):
  - [ ] Each of the 8 skills opens the correct menu; empty-menu guard fires.
  - [ ] Make-last repeats the last craft (jewelry re-prompts gem).
  - [ ] Jewelry consumes the full targeted gem stack and names by count.
  - [ ] Cartography consumes blank maps only with T2A enabled / maps+scrolls when disabled.
  - [ ] Tailoring consumes only the targeted-hue material; crafted items are not tinted by dyed cloth/leather.
  - [ ] Maker's-mark prompt on exceptional.
  - [ ] Failed non-scroll craft consumes half resources.
  - [ ] Inscription: reagents+scroll on success/failure, mana only on success.
  - [ ] T2A disabled: gump crafting unchanged.

## Credits

Co-authored-by: @Delphi79
Co-authored-by: @jackuoll
2026-06-07 20:27:22 -07:00

529 lines
18 KiB
C#

using System;
using Server.Items;
using Server.Menus.ItemLists;
using Server.Network;
using Server.Targeting;
namespace Server.Engines.Craft.T2A;
public class TinkeringMenu : ItemListMenu
{
private enum Category
{
Main,
Wood,
Tools,
Parts,
Utensils,
Traps,
Misc,
Jewelry,
Necklaces,
Earrings,
Rings,
Keg
}
private static readonly Type[] WoodItemTypes =
[
typeof(JointingPlane), typeof(MouldingPlane), typeof(SmoothingPlane),
typeof(ClockFrame), typeof(Axle), typeof(RollingPin)
];
private static readonly Type[] ToolTypes =
[
typeof(SewingKit), typeof(TinkerTools),
typeof(DrawKnife), typeof(Froe), typeof(Inshave), typeof(Scorp),
typeof(Scissors), typeof(Tongs),
typeof(DovetailSaw), typeof(Saw), typeof(Hammer),
typeof(SmithHammer), typeof(SledgeHammer), typeof(Shovel),
typeof(MortarPestle), typeof(Hatchet), typeof(Pickaxe), typeof(Lockpick)
];
private static readonly Type[] PartTypes =
[
typeof(Gears), typeof(Springs), typeof(Hinge),
typeof(ClockParts), typeof(SextantParts),
typeof(BarrelTap), typeof(BarrelHoops), typeof(AxleGears)
];
private static readonly Type[] UtensilTypes =
[
typeof(ButcherKnife), typeof(Plate), typeof(Cleaver),
typeof(KnifeLeft), typeof(KnifeRight), typeof(SkinningKnife),
typeof(ForkLeft), typeof(ForkRight),
typeof(SpoonLeft), typeof(SpoonRight),
typeof(Goblet), typeof(PewterMug)
];
private static readonly Type[] TrapTypes =
[
typeof(DartTrapCraft), typeof(ExplosionTrapCraft), typeof(PoisonTrapCraft)
];
private static readonly Type[] MiscTypes =
[
typeof(KeyRing), typeof(Key),
typeof(Scales), typeof(Spyglass), typeof(Lantern), typeof(HeatingStand),
typeof(Globe), typeof(Candelabra), typeof(Sextant),
typeof(ClockRight), typeof(ClockLeft)
];
private static readonly Type[] NecklaceTypes = [typeof(GoldNecklace), typeof(SilverNecklace)];
private static readonly Type[] EarringTypes = [typeof(GoldEarrings), typeof(SilverEarrings)];
private static readonly Type[] RingTypes = [typeof(GoldRing), typeof(SilverRing), typeof(WeddingRing)];
// Combined for AnyCraftableInCategory check on the Jewelry parent entry
private static readonly Type[] AllJewelryTypes =
[
typeof(GoldNecklace), typeof(SilverNecklace),
typeof(GoldEarrings), typeof(SilverEarrings),
typeof(GoldRing), typeof(SilverRing), typeof(WeddingRing)
];
private static readonly Type[] KegItemTypes = [typeof(PotionKeg)];
private static ItemListEntry[] _mainEntries;
private static ItemListEntry[] _woodEntries;
private static ItemListEntry[] _toolEntries;
private static ItemListEntry[] _partEntries;
private static ItemListEntry[] _utensilEntries;
private static ItemListEntry[] _trapEntries;
private static ItemListEntry[] _miscEntries;
private static ItemListEntry[] _necklaceEntries;
private static ItemListEntry[] _earringEntries;
private static ItemListEntry[] _ringEntries;
private static ItemListEntry[] _kegEntries;
private readonly Category _category;
private readonly BaseTool _tool;
private readonly Type _selectedResourceType;
private static string GetQuestion(Category category) => category switch
{
Category.Main => "What would you like to make?",
Category.Wood => "What kind of wooden item?",
Category.Tools => "What kind of tool?",
Category.Parts => "What kind of part?",
Category.Utensils => "What kind of utensil?",
Category.Traps => "What kind of trap?",
Category.Misc => "What would you like to make?",
Category.Jewelry => "What kind of jewelry?",
Category.Necklaces => "What kind of necklace?",
Category.Earrings => "What kind of earrings?",
Category.Rings => "What kind of ring?",
Category.Keg => "What would you like to make?",
_ => "What would you like to make?"
};
private TinkeringMenu(Mobile from, BaseTool tool, Category category, Type selectedResourceType)
: base(GetQuestion(category), BuildFilteredEntries(from, category))
{
_tool = tool;
_category = category;
_selectedResourceType = selectedResourceType;
}
private static string FormatItemName(Type type)
{
var name = type.Name;
Span<char> buffer = stackalloc char[name.Length * 2];
var pos = 0;
for (var i = 0; i < name.Length; i++)
{
if (i > 0 && char.IsUpper(name[i]))
{
buffer[pos++] = ' ';
}
buffer[pos++] = char.ToLower(name[i]);
}
return new string(buffer[..pos]);
}
private static ItemListEntry[] BuildStaticEntries(Type[] types, string resourceName)
{
var entries = new ItemListEntry[types.Length];
var count = 0;
var craftItems = DefTinkering.CraftSystem.CraftItems;
for (var i = 0; i < types.Length; i++)
{
var itemDef = craftItems.SearchFor(types[i]);
if (itemDef == null)
{
continue;
}
var name = FormatItemName(types[i]);
var res = itemDef.Resources[0];
entries[count++] = new ItemListEntry($"{name} ({res.Amount} {resourceName})", itemDef.ItemId, 0, i);
}
if (count < entries.Length)
{
Array.Resize(ref entries, count);
}
return entries;
}
private static ItemListEntry[] GetStaticEntries(Category category) => category switch
{
Category.Main => Main(),
Category.Wood => Wood(),
Category.Tools => Tools(),
Category.Parts => Parts(),
Category.Utensils => Utensils(),
Category.Traps => Traps(),
Category.Misc => Misc(),
Category.Necklaces => Necklaces(),
Category.Earrings => Earrings(),
Category.Rings => Rings(),
Category.Keg => KegItems(),
_ => null
};
private static Type[] GetTypes(Category category) => category switch
{
Category.Wood => WoodItemTypes,
Category.Tools => ToolTypes,
Category.Parts => PartTypes,
Category.Utensils => UtensilTypes,
Category.Traps => TrapTypes,
Category.Misc => MiscTypes,
Category.Jewelry => AllJewelryTypes,
Category.Necklaces => NecklaceTypes,
Category.Earrings => EarringTypes,
Category.Rings => RingTypes,
Category.Keg => KegItemTypes,
_ => null
};
public static ItemListEntry[] Main() => _mainEntries ??=
[
new ItemListEntry("Wooden Items", 0x1BDD, 0, (int)Category.Wood),
new ItemListEntry("Tools", 0x1EB8, 0, (int)Category.Tools),
new ItemListEntry("Parts", 0x1053, 0, (int)Category.Parts),
new ItemListEntry("Utensils", 0x9D7, 0, (int)Category.Utensils),
new ItemListEntry("Traps", 0x1BFC, 0, (int)Category.Traps),
new ItemListEntry("Miscellaneous", 0xA25, 0, (int)Category.Misc),
new ItemListEntry("Jewelry", 0x1088, 0, (int)Category.Jewelry)
];
public static ItemListEntry[] Wood() => _woodEntries ??= BuildStaticEntries(WoodItemTypes, "logs");
public static ItemListEntry[] Tools() => _toolEntries ??= BuildStaticEntries(ToolTypes, "ingots");
public static ItemListEntry[] Parts() => _partEntries ??= BuildStaticEntries(PartTypes, "ingots");
public static ItemListEntry[] Utensils() => _utensilEntries ??= BuildStaticEntries(UtensilTypes, "ingots");
public static ItemListEntry[] Traps() => _trapEntries ??= BuildStaticEntries(TrapTypes, "ingots");
public static ItemListEntry[] Misc() => _miscEntries ??= BuildStaticEntries(MiscTypes, "ingots");
public static ItemListEntry[] Necklaces() => _necklaceEntries ??= BuildStaticEntries(NecklaceTypes, "ingots");
public static ItemListEntry[] Earrings() => _earringEntries ??= BuildStaticEntries(EarringTypes, "ingots");
public static ItemListEntry[] Rings() => _ringEntries ??= BuildStaticEntries(RingTypes, "ingots");
public static ItemListEntry[] KegItems() => _kegEntries ??= BuildStaticEntries(KegItemTypes, "kegs");
private static ItemListEntry[] BuildFilteredEntries(Mobile from, Category category)
{
if (category == Category.Main)
{
return BuildFilteredMainEntries(from);
}
if (category == Category.Jewelry)
{
return BuildFilteredJewelryEntries(from);
}
var types = GetTypes(category);
var staticEntries = GetStaticEntries(category);
if (types == null || staticEntries == null)
{
return [];
}
return T2ACraftSystem.FilterEntries(from, staticEntries, types, DefTinkering.CraftSystem);
}
private static readonly ItemListEntry[] JewelrySubcategoryEntries =
[
new("Necklaces", 0x1088, 0, (int)Category.Necklaces),
new("Earrings", 0x1087, 0, (int)Category.Earrings),
new("Rings", 0x108a, 0, (int)Category.Rings)
];
private static ItemListEntry[] BuildFilteredJewelryEntries(Mobile from)
{
var system = DefTinkering.CraftSystem;
var filtered = new ItemListEntry[JewelrySubcategoryEntries.Length];
var count = 0;
for (var i = 0; i < JewelrySubcategoryEntries.Length; i++)
{
var entry = JewelrySubcategoryEntries[i];
var types = GetTypes((Category)entry.CraftIndex);
if (types != null && T2ACraftSystem.AnyCraftableInCategory(from, types, system))
{
filtered[count++] = entry;
}
}
if (count == 0)
{
return [];
}
if (count < filtered.Length)
{
Array.Resize(ref filtered, count);
}
return filtered;
}
private static ItemListEntry[] BuildFilteredMainEntries(Mobile from)
{
var system = DefTinkering.CraftSystem;
var mainStatic = Main();
var filtered = new ItemListEntry[mainStatic.Length];
var count = 0;
for (var i = 0; i < mainStatic.Length; i++)
{
var entry = mainStatic[i];
var types = GetTypes((Category)entry.CraftIndex);
if (types != null && T2ACraftSystem.AnyCraftableInCategory(from, types, system))
{
filtered[count++] = entry;
}
}
if (count == 0)
{
return [];
}
if (count < filtered.Length)
{
Array.Resize(ref filtered, count);
}
return filtered;
}
public override void OnResponse(NetState state, int index)
{
var from = state.Mobile;
var craftIndex = Entries[index].CraftIndex;
// Navigation categories: Main → subcategory, Jewelry → subcategory
if (_category is Category.Main or Category.Jewelry)
{
var childCategory = (Category)craftIndex;
var menu = new TinkeringMenu(from, _tool, childCategory, _selectedResourceType);
if (menu.Entries.Length == 0)
{
from.SendAsciiMessage("You lack the skill and materials to craft anything in that category.");
return;
}
from.SendMenu(menu);
return;
}
// Jewelry leaf categories: prompt for gem targeting
if (_category is Category.Necklaces or Category.Earrings or Category.Rings)
{
var types = GetTypes(_category);
if (types == null || craftIndex < 0 || craftIndex >= types.Length)
{
return;
}
var itemType = types[craftIndex];
if (DefTinkering.CraftSystem.CraftItems.SearchFor(itemType) == null)
{
return;
}
// Clear stale gem state from any previous craft attempt (e.g. failed skill check)
var ctx = DefTinkering.CraftSystem.GetContext(from);
if (ctx != null)
{
ctx.PendingGemType = GemType.None;
ctx.PendingGemCount = 0;
}
from.SendAsciiMessage("Target the gemstone you wish to use.");
from.Target = new GemSelectTarget(from, _tool, itemType, _selectedResourceType);
return;
}
// Leaf categories: craft directly
var leafTypes = GetTypes(_category);
if (leafTypes == null || craftIndex < 0 || craftIndex >= leafTypes.Length)
{
return;
}
var leafItemType = leafTypes[craftIndex];
var system = DefTinkering.CraftSystem;
var itemDef = system.CraftItems.SearchFor(leafItemType);
if (itemDef == null || _selectedResourceType == null)
{
return;
}
// Persist selected resource index so make-last remembers it
T2ACraftSystem.SetLastResourceIndex(from, system, _selectedResourceType);
itemDef.Craft(from, system, _selectedResourceType, _tool);
}
public static void ResourceSelection(Mobile from, BaseTool tool, Item preTarget = null)
{
if (preTarget != null && TrySelectResource(from, tool, preTarget))
{
return;
}
from.SendAsciiMessage("Select the resource you wish to use (wood or ingots).");
from.Target = new ResourceSelectTarget(from, tool);
}
private static bool TrySelectResource(Mobile from, BaseTool tool, Item targeted)
{
if (targeted is Log or Board)
{
var menu = new TinkeringMenu(from, tool, Category.Wood, typeof(Log));
if (menu.Entries.Length == 0)
{
from.SendAsciiMessage("You lack the skill and materials to craft anything.");
return true;
}
from.SendMenu(menu);
return true;
}
if (targeted is BaseIngot)
{
var menu = new TinkeringMenu(from, tool, Category.Main, targeted.GetType());
if (menu.Entries.Length == 0)
{
from.SendAsciiMessage("You lack the skill and materials to craft anything.");
return true;
}
from.SendMenu(menu);
return true;
}
if (targeted is Keg)
{
var menu = new TinkeringMenu(from, tool, Category.Keg, typeof(Keg));
if (menu.Entries.Length == 0)
{
from.SendAsciiMessage("You lack the skill and materials to craft anything.");
return true;
}
from.SendMenu(menu);
return true;
}
return false;
}
private class ResourceSelectTarget : Target
{
private readonly Mobile _from;
private readonly BaseTool _tool;
public ResourceSelectTarget(Mobile from, BaseTool tool) : base(12, false, TargetFlags.None)
{
_from = from;
_tool = tool;
}
protected override void OnTarget(Mobile from, object targeted)
{
if (targeted is Item item && TrySelectResource(from, _tool, item))
{
return;
}
from.SendAsciiMessage("That is not a valid resource. Please select wood or ingots.");
from.Target = new ResourceSelectTarget(_from, _tool);
}
}
internal class GemSelectTarget : Target
{
private readonly Mobile _from;
private readonly BaseTool _tool;
private readonly Type _itemType;
private readonly Type _selectedResourceType;
public GemSelectTarget(Mobile from, BaseTool tool, Type itemType, Type selectedResourceType)
: base(12, false, TargetFlags.None)
{
_from = from;
_tool = tool;
_itemType = itemType;
_selectedResourceType = selectedResourceType;
}
protected override void OnTarget(Mobile from, object targeted)
{
if (targeted is not Item gemItem)
{
from.SendAsciiMessage("That is not a gemstone.");
return;
}
var gemType = BaseJewel.GetGemType(gemItem);
if (gemType == GemType.None)
{
from.SendAsciiMessage("That is not a gemstone.");
return;
}
var amount = gemItem.Amount;
if (amount < 1)
{
from.SendAsciiMessage("That gemstone stack is empty.");
return;
}
var system = DefTinkering.CraftSystem;
var itemDef = system.CraftItems.SearchFor(_itemType);
if (itemDef == null)
{
return;
}
// Store pending gem info in craft context
var ctx = system.GetContext(from);
if (ctx == null)
{
return;
}
ctx.PendingGemType = gemType;
ctx.PendingGemCount = amount;
T2ACraftSystem.SetLastResourceIndex(from, system, _selectedResourceType);
itemDef.Craft(from, system, _selectedResourceType, _tool);
}
protected override void OnTargetCancel(Mobile from, TargetCancelType cancelType)
{
if (cancelType == TargetCancelType.Canceled)
{
CraftItem.ShowCraftMenu(from, DefTinkering.CraftSystem, _tool);
}
}
}
}