erik/acdream
1
0
Fork 0
Code Issues Pull requests Projects Releases 6 Packages Wiki Activity Actions

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

Browse source 
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>
This commit is contained in:
Erik 2026-08-09 17:04:02 +02:00
parent 0fa4554759
commit 77c8296e3f
28 changed files with 2144 additions and 224 deletions
Download patch file Download diff file Expand all files Collapse all files

150
src/AcDream.Core/Chat/SpewBoxState.cs Normal file
View file

@ -0,0 +1,150 @@
using System;
using System.Collections.Generic;
using System.Threading;
namespace AcDream.Core.Chat;
/// <summary>
/// One visible SpewBox line: display text plus the caller-clock timestamp
/// (seconds) at which it should be pruned.
/// </summary>
public readonly record struct SpewBoxEntry(string Text, double ExpiresAtSeconds);
/// <summary>
/// Retail's transient on-screen "interface text" — a direct port of
/// <c>gmSpewBoxUI</c>'s pending/visible split
/// (<c>docs/research/2026-08-09-chat-retail-interface-text.md</c> §1.1/§3.1).
/// Pure state, no presentation.
///
/// <para>
/// <b>Placement note (deviation from the CH2 brief):</b> the brief names
/// <c>AcDream.Runtime</c> as this type's home. It lives in
/// <c>AcDream.Core.Chat</c> instead, directly beside <see cref="ChatLog"/>,
/// because <c>AcDream.UI.Abstractions</c> (Code Structure Rule 3 — panels/
/// ViewModels target UI.Abstractions only) references <c>AcDream.Core</c>
/// but NOT <c>AcDream.Runtime</c>, and the UI.Abstractions
/// <c>SpewBoxVM</c> needs to wrap this type directly — exactly the same
/// constraint <see cref="ChatVM"/> already satisfies by wrapping
/// <see cref="ChatLog"/> (also Core, not Runtime). <c>RuntimeCommunicationState</c>
/// still owns the canonical instance and is still the sole writer via its
/// <c>AddText</c> router, matching every other J4-era Runtime-owns/App-or-
/// UI.Abstractions-borrows pattern in this codebase.
/// </para>
///
/// <para>
/// Retail decouples enqueue (<c>RecvNotice_DisplayFinalStringInfo
/// @0x004D60A0</c>, type-filtered to <c>0x1A</c> only) from display
/// (<c>Update @0x004D5DF0</c>, driven once per UI tick by global message
/// <c>3</c>) by exactly one frame. <see cref="Tick"/> reproduces that: it
/// drains whatever is pending into the visible list (applying retail's
/// dedupe-against-index-0 and <c>MaxConcurrentItems</c> overflow rules) and
/// prunes expired entries, all in the caller's own per-frame cadence.
/// </para>
/// </summary>
public sealed class SpewBoxState
{
/// <summary>
/// Retail's own code default (<c>gmSpewBoxUI::PostInit @0x004D5AB0</c>)
/// when ListBox property <c>0x10000028</c> is absent or unreadable. The
/// shipped LayoutDesc's authored value was not resolved in this slice —
/// see the divergence register.
/// </summary>
public const int MaxConcurrentItems = 1;
/// <summary>
/// Retail's own client never raises the expiry element message
/// (<c>0x10000003</c>) anywhere in the Sept 2013 EoR build — the real
/// per-line timeout is owned by keystone.dll's authored behaviour for
/// layout <c>0x10000012</c> element <c>0x1000004A</c> and was not
/// measured in this slice (§3.2.1 of the research doc). This is an
/// INVENTED placeholder, not a retail-measured value — see the
/// divergence register.
/// </summary>
public static readonly TimeSpan DefaultLifetime = TimeSpan.FromSeconds(5);
private readonly object _gate = new();
private readonly Queue<string> _pending = new();
private readonly List<SpewBoxEntry> _visible = new();
private long _revision;
/// <summary>Monotonic content revision — advances on any Tick that changes the visible set, and on Reset.</summary>
public long Revision => Interlocked.Read(ref _revision);
/// <summary>Number of currently visible lines (0..<see cref="MaxConcurrentItems"/>).</summary>
public int Count
{
get { lock (_gate) return _visible.Count; }
}
/// <summary>
/// Enqueue text for display — retail's
/// <c>RecvNotice_DisplayFinalStringInfo</c> type-<c>0x1A</c> branch.
/// Does not itself become visible until the next <see cref="Tick"/>.
/// </summary>
public void Enqueue(string text)
{
lock (_gate)
_pending.Enqueue(text);
}
/// <summary>
/// Drain any pending text into the visible list and prune expired
/// entries. Call once per UI frame/tick (retail's global message
/// <c>3</c>, <c>gmSpewBoxUI::Update</c>).
/// </summary>
/// <param name="nowSeconds">
/// Caller's own monotonic clock, in seconds. Only used to stamp new
/// entries' expiry and to prune old ones — never compared across
/// different clock sources.
/// </param>
public void Tick(double nowSeconds)
{
bool changed;
lock (_gate)
{
changed = _pending.Count > 0;
while (_pending.Count > 0)
{
string text = _pending.Dequeue();
// Dedupe against index 0 ONLY (retail: 0x004D5EF6-0x004D5F91)
// — an identical repeat refreshes the newest line in place
// instead of stacking a duplicate.
if (_visible.Count > 0 && _visible[0].Text == text)
_visible.RemoveAt(0);
// Newest at the top — retail's InsertItem(item, 0).
_visible.Insert(0, new SpewBoxEntry(text, nowSeconds + DefaultLifetime.TotalSeconds));
// Overflow drops the OLDEST (highest index) entry — retail's
// DeleteItem(count - 1) when count > m_maxConcurrentItems.
while (_visible.Count > MaxConcurrentItems)
_visible.RemoveAt(_visible.Count - 1);
}
int removed = _visible.RemoveAll(e => e.ExpiresAtSeconds <= nowSeconds);
changed |= removed > 0;
}
if (changed)
Interlocked.Increment(ref _revision);
}
/// <summary>Snapshot of currently visible lines, newest first.</summary>
public SpewBoxEntry[] Snapshot()
{
lock (_gate)
return _visible.ToArray();
}
/// <summary>Clear all pending and visible state — session/generation reset.</summary>
public void Reset()
{
lock (_gate)
{
_pending.Clear();
_visible.Clear();
}
Interlocked.Increment(ref _revision);
}
}