acdream/tools/SpellDump/EmitEnum.cs
Erik 17ebfc434d feat(mosstank): buff trained skills and attributes, pick tiers by skill, manage mana
Reworks MossTank against user feedback and the Virindi Tank feature docs
(virindi.net is reachable again over https with a self-signed cert; the
research doc's "unreachable" note is stale).

VTank's stated default is the spec: "automatically buffs every Attribute and
Skill you have trained", and "all buff spells are recast when they go below 5
minutes". The previous pass buffed the whole spellbook and refreshed at 60s;
both are corrected.

The hard problem was working out WHICH stat each buff raises. The client's
spell table has no such link -- it arrives from the server with the
enchantment -- and the naming is too irregular to infer: Invulnerability
raises Melee Defense, Impregnability raises Missile Defense, Fealty raises
Loyalty, Sprint raises Run, Arcane Enlightenment raises Arcane Lore, and the
line called Willpower raises the attribute named Self. Any name-matching
scheme dies on that last one.

Retail states it outright in each spell's own description ("Increases the
caster's Life Magic skill by 10 points"), so BuffProfile derives the whole
mapping from shipped data at runtime. It also carries the one alias the data
needs: the spell text says "Assess Monster" where the skill table says "Assess
Creature", and without that the skill silently never matches.

Two data facts that would each have caused a real bug, found by dumping the
spell table rather than assuming:

* Family is NOT a spell-line identity in general. Retail groups the
  instantaneous vital transfers by SOURCE vital, so family 89 holds both
  "Stamina to Health" and "Stamina to Mana". Picking the strongest tier in a
  family would convert into the wrong vital about half the time. Buff lines
  group by family (correct for duration buffs, which is retail's own stacking
  bucket); the conversions are found by name stem instead.
* Instantaneous spells have no duration and must be excluded from buff lines
  entirely, or they are treated as buffs that never appear to land.

Tier selection now follows the character's skill in the casting school against
the spell's difficulty (VTank's SpellDiffExcessThreshold-Buff), which is why
PluginSpellInfo gained School as a SKILL id -- MagicSchool is retail's 1-5
school enum, not something a character trains.

Mana upkeep is the loop asked for: convert stamina to mana when mana is low,
Revitalize when that leaves stamina too low to convert, and refuse to drain
stamina past a floor. Unknown vitals read as zero and are treated as "no
information" rather than "empty", so it will not cast on a healthy character.

Panel no longer shows at character select. IsAvailable is now the runtime's
own lifecycle state rather than a proxy, and markup gained visible="{Binding}"
plus UiElement.VisibleSource -- evaluated before the visible gate, because
TickSelfAndChildren returns early when hidden and an element could otherwise
never un-hide itself.

Also: a generated SpellId enum of all 6,266 spells (tools/SpellDump --enum),
generated from portal.dat rather than copied, so it cannot drift and carries
no third-party licence; skill and spell names now come from the retail tables
for display; and the Buff click logs unconditionally, so "nothing happened"
can be told apart from "the click never arrived".

Solution builds clean; 14,433 tests pass on the standard hermetic lane filter,
0 failures, including 21 covering the buff profile, tier selection and mana
loop.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-20 18:09:02 +02:00

77 lines
2.8 KiB
C#

// Emit a C# enum of every spell in portal.dat's SpellTable.
//
// Generated rather than hand-written or copied from another project: the ids
// and names come from the user's own game data, so the enum cannot drift from
// what the client actually loads, and regenerating is a one-liner.
using System.Text;
using AcDream.Core.Spells;
namespace SpellDump;
internal static class EmitEnum
{
public static void Run(SpellTable table, string outPath, string ns, string typeName)
{
var byName = new Dictionary<string, uint>(StringComparer.Ordinal);
var ordered = new List<(uint Id, string Ident, string Name)>();
foreach (uint id in table.SpellIds.OrderBy(i => i))
{
if (!table.TryGet(id, out SpellMetadata meta))
continue;
string ident = Identifier(meta.Name);
if (ident.Length == 0)
ident = "Spell";
// Retail reuses display names across ids; suffix collisions with the
// id so every member stays addressable and stable.
if (byName.ContainsKey(ident))
ident = $"{ident}_{id:X4}";
byName[ident] = id;
ordered.Add((id, ident, meta.Name));
}
var sb = new StringBuilder();
sb.AppendLine("// <auto-generated>");
sb.AppendLine("// Generated by tools/SpellDump from portal.dat's SpellTable (0x0E00000E).");
sb.AppendLine("// Do not edit by hand. Regenerate with:");
sb.AppendLine("// dotnet run --project tools/SpellDump -- --enum");
sb.AppendLine("// </auto-generated>");
sb.AppendLine();
sb.AppendLine($"namespace {ns};");
sb.AppendLine();
sb.AppendLine("/// <summary>Every spell id in the retail spell table, by name.</summary>");
sb.AppendLine($"public enum {typeName} : uint");
sb.AppendLine("{");
foreach (var (id, ident, name) in ordered)
{
sb.AppendLine($" /// <summary>{System.Security.SecurityElement.Escape(name)}</summary>");
sb.AppendLine($" {ident} = 0x{id:X4},");
}
sb.AppendLine("}");
File.WriteAllText(outPath, sb.ToString());
Console.WriteLine($"wrote {outPath}: {ordered.Count} spells");
}
private static string Identifier(string name)
{
var sb = new StringBuilder(name.Length);
bool upper = true;
foreach (char c in name)
{
if (char.IsLetterOrDigit(c))
{
sb.Append(upper ? char.ToUpperInvariant(c) : c);
upper = false;
}
else
{
upper = true; // word break -> PascalCase
}
}
string ident = sb.ToString();
if (ident.Length > 0 && char.IsDigit(ident[0]))
ident = "S" + ident;
return ident;
}
}