feat(chat): Campaign CH slice CH2 — retail SpewBox interface text

Retail routes on-screen refusals ("You can't jump while in the air", "You are too encumbered to carry that!") through a SEPARATE transient screen surface (gmSpewBoxUI, ClientSystem::AddTextToScroll @0x00563C50) that never touches the chat scroll — type 0x1A is exactly the bit every ChatInterface window's default filter excludes (ChatInterface::ChatInterface @0x004F4550). acdream had no such split: every WeenieError rendered in chat at a single stand-in LogTextType 0x00 (CH1-era approximation, register AP-176), and locally-detected jump refusals were silently discarded. This slice ports the full mechanism per docs/research/2026-08-09-chat-retail-interface-text.md: CORE (AcDream.Core/Chat): - WeenieErrorMessages.Resolve now returns (text, RetailLogTextType) from a 338-row transcription of ClientCommunicationSystem::HandleFailureEvent @0x00571990 (Appendix A's 339 cases minus one, 0x4F8, deliberately excluded — its case body is a tangled decompiler artifact, not resolvable with confidence). Spot-checked ~20 rows directly against the raw decomp (case 0x2b/0x36/0x3a/0x4e/0x4ec/0x4f3/0x4f4 and the jump family), beyond the ~10 the brief asked for, because the first pass surfaced two transcription classes the research doc's markdown silently ate: (1) 7 ids marked "shared string global" resolved by reading the case bodies directly (0x24/0x48/0x49 reuse the jump- refusal globals; 0x4DE/0x4DF/0x55A/0x55E are pure param passthrough); (2) 19 "arg3 + literal" CONCATENATION ids whose leading space (and therefore their %s marker) the markdown table's cell-trimming ate — fixed by re-reading each case body, several requiring a SECOND non-truncated data_XXXXXXXX dump elsewhere in the same oracle file to recover text the ~33-char inline preview cut off. One retail typo is preserved verbatim: 0x4F4's second placeholder is literal "$s", not "%s" — only the first substitutes. - ClientTextRefusals: the 11 process-lifetime string globals, all byte-recovered from the PDB-paired C:\Users\erikn\Downloads\acclient.exe (MATCH verified via check_exe_pdb.py) via raw UTF-16LE prefix search — 5 were truncated in the research doc's own transcription and all 5 turned out to end "...combat mode"/"...this position", not the shorter "...combat" a truncated read would suggest. - SpewBoxState: the gmSpewBoxUI pending/visible queue port (insert-at-0, dedupe-against-index-0-only, MaxConcurrentItems overflow, per-entry expiry, one-frame enqueue/drain decoupling). Placed in Core (not Runtime as the brief's default) because AcDream.UI.Abstractions references Core but not Runtime, and SpewBoxVM needs to wrap it directly — the same constraint ChatVM already satisfies against ChatLog. - Folded the 4-entry WeenieErrorText.cs into the full table; deleted it. RUNTIME (AcDream.Runtime): - RuntimeCommunicationState.AddText(text, type, windowId): the AddTextToScroll chokepoint. type == ClientLocal -> SpewBox only, never chat; everything else -> the existing transcript, tagged with type. - GameEventWiring gains an `onInterfaceText` delegate hole (Core.Net cannot reference Runtime, so this follows the file's own established pattern for every other Runtime-owned sink). Rewires 0x028A/0x028B/ UseDone through the full table + router; fixes 0x02EB CommunicationTransientString's routing type from a CH1-era 0x00 guess to retail's hardcoded ClientLocal (Handle_Communication__ TransientString @0x0057D460). - LiveSessionEventRouter's 0xF7E0 ServerMessage handler now routes through AddText with the wire chatType verbatim instead of always writing ChatLog directly. - PlayerMovementController gains OnInterfaceText, applied by RuntimeLocalPlayerMovementState to every controller it installs. Reports ChargeJump/jump refusals exactly as ClientCombatSystem:: CommenceJump @0x0056AF90 / DoJump @0x0056B110 do — confirmed via their compiled dispatch that ONLY 0x24/0x48/0x49 produce text; 0x47 (GeneralMovementFailure, fully-constrained/no-stamina) and any other code are retail-SILENT (DoJump's jump table has exactly 4 real targets), which contradicts this task's brief ("0x47 -> the constrained/stamina row per §4.2") — the brief's reading of §4.2 described what jump_is_allowed COMPUTES, not what CommenceJump/DoJump DISPLAY for it. Implemented the decomp-verified silent behavior. APP (AcDream.App / AcDream.UI.Abstractions): - The 5 composition sites that already used RetailLogTextType.ClientLocal now call Communication.AddText instead of Chat.OnSystemMessage directly, so they reach the SpewBox instead of the transcript. - SpewBoxVM (UI.Abstractions) + SpewBoxController (App), modeled directly on PortalWaitNoticeController. Position/font/colour/ MaxConcurrentItems are placeholders: SpewBoxLayoutDumpDiagnostic exhaustively swept the installed client_portal.dat's entire LayoutDesc id range (0x21000000-0x21000075, 101/118 ids populated, sanity-checked against 3 known ids) and found ZERO elements of class 0x10000016 — gmSpewBoxUI is mounted from C++ code, not any authored LayoutDesc, so the dump cannot recover these values. REGISTER: AP-176 retired (its WeenieError half is now the full table port); its OnCombatLine half was never in this slice's scope and is split out to AP-179 so that divergence keeps a row. AP-177 (invented line lifetime) and AP-178 (invented position/font/colour/max-items) filed for the presentation placeholders above. AP-175 (PopUpString -> chat instead of modal) is untouched, not duplicated. Suite: 11,890 passed / 4 skipped / 0 failed (was 11,835/4/0; +55 net new tests, 0 regressions). Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-08-09 17:04:02 +02:00 · 2026-08-09 17:04:02 +02:00 · 77c8296e3f
commit 77c8296e3f
parent 0fa4554759
28 changed files with 2144 additions and 224 deletions
--- a/tests/AcDream.Core.Net.Tests/GameEventWiringTests.cs
+++ b/tests/AcDream.Core.Net.Tests/GameEventWiringTests.cs
@ -758,6 +758,162 @@ public sealed class GameEventWiringTests
        Assert.Contains("Mana Stone", e.Text);
    }

+    // ── Campaign CH slice CH2: onInterfaceText routing ───────────────────
+
+    private static (GameEventDispatcher Dispatcher, ChatLog Chat, List<(string Text, RetailLogTextType Type)> Reported)
+        MakeAllWithInterfaceTextRouter()
+    {
+        var dispatcher = new GameEventDispatcher();
+        var chat = new ChatLog();
+        var reported = new List<(string, RetailLogTextType)>();
+        GameEventWiring.WireAll(
+            dispatcher,
+            new ClientObjectTable(),
+            new CombatState(),
+            new Spellbook(),
+            chat,
+            onInterfaceText: (text, type) => reported.Add((text, type)));
+        return (dispatcher, chat, reported);
+    }
+
+    [Fact]
+    public void WireAll_WithRouter_WeenieError_ClientLocalCode_RoutesThroughRouter_NotChat()
+    {
+        // 0x024 = NotGrounded / YouCantJumpWhileInTheAir -> ClientLocal per
+        // the full HandleFailureEvent table. With a router wired, this must
+        // reach the router (and therefore, in production, the SpewBox) and
+        // NEVER the chat transcript — the exact CH1-era behavior this test
+        // replaces (chat.OnWeenieError used to type every code 0x00).
+        var (d, chat, reported) = MakeAllWithInterfaceTextRouter();
+
+        byte[] payload = new byte[4];
+        BinaryPrimitives.WriteUInt32LittleEndian(payload, 0x024u);
+        var env = GameEventEnvelope.TryParse(WrapEnvelope(GameEventType.WeenieError, payload));
+        d.Dispatch(env!.Value);
+
+        Assert.Equal(0, chat.Count);
+        var (text, type) = Assert.Single(reported);
+        Assert.Equal(ClientTextRefusals.CantJumpInAir, text);
+        Assert.Equal(RetailLogTextType.ClientLocal, type);
+    }
+
+    [Fact]
+    public void WireAll_WithRouter_WeenieError_ChatTypeCode_RoutesThroughRouter_AsChatType()
+    {
+        // 0x402 = Your spell fizzled -> Magic (0x07) per the table. Routed
+        // text still goes through the SAME router (production forwards
+        // non-ClientLocal types to the chat transcript via AddText).
+        var (d, _, reported) = MakeAllWithInterfaceTextRouter();
+
+        byte[] payload = new byte[4];
+        BinaryPrimitives.WriteUInt32LittleEndian(payload, 0x402u);
+        var env = GameEventEnvelope.TryParse(WrapEnvelope(GameEventType.WeenieError, payload));
+        d.Dispatch(env!.Value);
+
+        var (text, type) = Assert.Single(reported);
+        Assert.Equal("Your spell fizzled.", text);
+        Assert.Equal(RetailLogTextType.Magic, type);
+    }
+
+    [Fact]
+    public void WireAll_WithRouter_WeenieErrorWithString_SubstitutesParam_AndRoutesByType()
+    {
+        var (d, chat, reported) = MakeAllWithInterfaceTextRouter();
+
+        // 0x521 = "%s has been added to the list of people you can hear." -> Default (0x00).
+        byte[] interpBytes = MakeString16L("Caith");
+        byte[] payload = new byte[4 + interpBytes.Length];
+        BinaryPrimitives.WriteUInt32LittleEndian(payload, 0x521u);
+        Array.Copy(interpBytes, 0, payload, 4, interpBytes.Length);
+        var env = GameEventEnvelope.TryParse(WrapEnvelope(GameEventType.WeenieErrorWithString, payload));
+        d.Dispatch(env!.Value);
+
+        var (text, type) = Assert.Single(reported);
+        Assert.Equal("Caith has been added to the list of people you can hear.", text);
+        Assert.Equal(RetailLogTextType.Default, type);
+        Assert.Equal(0, chat.Count);
+    }
+
+    [Fact]
+    public void WireAll_WithRouter_SilentClientControlStatus_StillDropped()
+    {
+        var (d, chat, reported) = MakeAllWithInterfaceTextRouter();
+        byte[] payload = new byte[4];
+        BinaryPrimitives.WriteUInt32LittleEndian(payload, 0x003Bu); // ILeftTheWorld
+        var env = GameEventEnvelope.TryParse(WrapEnvelope(GameEventType.WeenieError, payload));
+        d.Dispatch(env!.Value);
+
+        Assert.Empty(reported);
+        Assert.Equal(0, chat.Count);
+    }
+
+    [Fact]
+    public void WireAll_WithRouter_CommunicationTransientString_AlwaysClientLocal()
+    {
+        // Retail hardcodes AddTextToScroll(text, 0x1A, 1, 0) for 0x02EB —
+        // corrects the CH1-era 0x00 routing note in GameEventWiring.cs.
+        var (d, chat, reported) = MakeAllWithInterfaceTextRouter();
+
+        byte[] payload = MakeString16L("You are too encumbered to carry that!");
+        var env = GameEventEnvelope.TryParse(
+            WrapEnvelope(GameEventType.CommunicationTransientString, payload));
+        d.Dispatch(env!.Value);
+
+        var (text, type) = Assert.Single(reported);
+        Assert.Equal("You are too encumbered to carry that!", text);
+        Assert.Equal(RetailLogTextType.ClientLocal, type);
+        Assert.Equal(0, chat.Count);
+    }
+
+    [Fact]
+    public void WireAll_NoRouter_CommunicationTransientString_FallsBackToChatWithClientLocalType()
+    {
+        // No router wired (older/test caller shape) — the fallback still
+        // tags the entry with the retail-correct type even though it can't
+        // perform the SpewBox split.
+        var (d, _, _, _, chat) = MakeAll();
+
+        byte[] payload = MakeString16L("fallback text");
+        var env = GameEventEnvelope.TryParse(
+            WrapEnvelope(GameEventType.CommunicationTransientString, payload));
+        d.Dispatch(env!.Value);
+
+        Assert.Equal(1, chat.Count);
+        var e = chat.Snapshot()[0];
+        Assert.Equal("fallback text", e.Text);
+        Assert.Equal((uint)RetailLogTextType.ClientLocal, e.LogTextType);
+    }
+
+    [Fact]
+    public void WireAll_WithRouter_UseDone_NonZeroError_RoutesResolvedTextAndType()
+    {
+        // 0x1D = YoureTooBusy -> ClientLocal per the table. Folds the former
+        // WeenieErrorText.cs 4-entry map into the full table (register AP-74).
+        var (d, chat, reported) = MakeAllWithInterfaceTextRouter();
+
+        byte[] payload = new byte[4];
+        BinaryPrimitives.WriteUInt32LittleEndian(payload, 0x001Du);
+        var env = GameEventEnvelope.TryParse(WrapEnvelope(GameEventType.UseDone, payload));
+        d.Dispatch(env!.Value);
+
+        var (text, type) = Assert.Single(reported);
+        Assert.Equal("You're too busy!", text);
+        Assert.Equal(RetailLogTextType.ClientLocal, type);
+        Assert.Equal(0, chat.Count);
+    }
+
+    [Fact]
+    public void WireAll_WithRouter_UseDone_ZeroError_ReportsNothing()
+    {
+        var (d, _, reported) = MakeAllWithInterfaceTextRouter();
+
+        byte[] payload = new byte[4]; // err == 0
+        var env = GameEventEnvelope.TryParse(WrapEnvelope(GameEventType.UseDone, payload));
+        d.Dispatch(env!.Value);
+
+        Assert.Empty(reported);
+    }
+
    [Fact]
    public void PlayerDescription_RegistersInventoryEntries_InClientObjectTable()
    {