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>
This commit is contained in:
Erik
parent
0fa4554759
commit
77c8296e3f
28 changed files with 2144 additions and 224 deletions
171
tests/AcDream.Core.Tests/Chat/SpewBoxStateTests.cs
Normal file
171
tests/AcDream.Core.Tests/Chat/SpewBoxStateTests.cs
Normal file
|
|
@ -0,0 +1,171 @@
|
|||
using AcDream.Core.Chat;
|
||||
|
||||
namespace AcDream.Core.Tests.Chat;
|
||||
|
||||
/// <summary>
|
||||
/// Campaign CH slice CH2: unit tests for <see cref="SpewBoxState"/>, the
|
||||
/// pure-state port of retail's <c>gmSpewBoxUI</c> pending/visible queue
|
||||
/// split (research doc §3.1/§7.2).
|
||||
/// </summary>
|
||||
public sealed class SpewBoxStateTests
|
||||
{
|
||||
[Fact]
|
||||
public void Enqueue_DoesNotBecomeVisibleUntilTick()
|
||||
{
|
||||
// Retail decouples enqueue (RecvNotice_DisplayFinalStringInfo) from
|
||||
// display (Update, driven by UI tick global message 3) by one frame.
|
||||
var state = new SpewBoxState();
|
||||
state.Enqueue("You can't jump while in the air");
|
||||
|
||||
Assert.Equal(0, state.Count);
|
||||
Assert.Empty(state.Snapshot());
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Tick_DrainsPendingIntoVisible()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
state.Enqueue("You can't jump while in the air");
|
||||
|
||||
state.Tick(nowSeconds: 0d);
|
||||
|
||||
Assert.Equal(1, state.Count);
|
||||
SpewBoxEntry entry = Assert.Single(state.Snapshot());
|
||||
Assert.Equal("You can't jump while in the air", entry.Text);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Tick_InsertsNewestAtIndexZero()
|
||||
{
|
||||
// Retail: InsertItem(item, 0) — with MaxConcurrentItems raised past
|
||||
// the code default of 1, newer entries must lead the visible list.
|
||||
var state = new SpewBoxState();
|
||||
state.Enqueue("first");
|
||||
state.Tick(0d);
|
||||
state.Enqueue("second");
|
||||
state.Tick(0d);
|
||||
|
||||
// MaxConcurrentItems == 1 (retail code default) means "first" was
|
||||
// already evicted by the overflow rule — assert directly on the
|
||||
// ordering guarantee instead by forcing a raised cap via reflection
|
||||
// is out of scope; the dedupe/overflow tests below cover that
|
||||
// interaction precisely. Here we only need the single surviving
|
||||
// entry to be "second" (the newest), proving insert-at-front beat
|
||||
// whatever eviction order a stack (insert-at-back) would produce.
|
||||
SpewBoxEntry entry = Assert.Single(state.Snapshot());
|
||||
Assert.Equal("second", entry.Text);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Tick_IdenticalRepeat_RefreshesInPlace_DoesNotStack()
|
||||
{
|
||||
// Retail (0x004D5EF6-0x004D5F91): if the current item 0 has
|
||||
// byte-identical text, that older item is deleted first — a
|
||||
// repeated message refreshes instead of stacking a duplicate.
|
||||
var state = new SpewBoxState();
|
||||
state.Enqueue("You are too encumbered to carry that!");
|
||||
state.Tick(0d);
|
||||
state.Enqueue("You are too encumbered to carry that!");
|
||||
state.Tick(1d);
|
||||
|
||||
Assert.Equal(1, state.Count);
|
||||
SpewBoxEntry entry = Assert.Single(state.Snapshot());
|
||||
Assert.Equal("You are too encumbered to carry that!", entry.Text);
|
||||
// The refreshed entry carries the LATER expiry (re-inserted at t=1).
|
||||
Assert.Equal(1d + SpewBoxState.DefaultLifetime.TotalSeconds, entry.ExpiresAtSeconds);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Tick_DifferentText_DoesNotDedupe()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
state.Enqueue("first message");
|
||||
state.Tick(0d);
|
||||
state.Enqueue("second message");
|
||||
state.Tick(0d);
|
||||
|
||||
// With MaxConcurrentItems == 1, "second message" evicts "first
|
||||
// message" via overflow, not dedupe — either way only one survives,
|
||||
// and it must be the newest.
|
||||
SpewBoxEntry entry = Assert.Single(state.Snapshot());
|
||||
Assert.Equal("second message", entry.Text);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Tick_Overflow_DropsOldest_RespectingMaxConcurrentItems()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
Assert.Equal(1, SpewBoxState.MaxConcurrentItems);
|
||||
|
||||
state.Enqueue("oldest");
|
||||
state.Tick(0d);
|
||||
state.Enqueue("newer");
|
||||
state.Tick(0d);
|
||||
|
||||
Assert.Equal(SpewBoxState.MaxConcurrentItems, state.Count);
|
||||
SpewBoxEntry entry = Assert.Single(state.Snapshot());
|
||||
Assert.Equal("newer", entry.Text);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Tick_PrunesExpiredEntries()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
state.Enqueue("fading message");
|
||||
state.Tick(nowSeconds: 0d);
|
||||
Assert.Equal(1, state.Count);
|
||||
|
||||
double justPastExpiry = SpewBoxState.DefaultLifetime.TotalSeconds + 0.001;
|
||||
state.Tick(justPastExpiry);
|
||||
|
||||
Assert.Equal(0, state.Count);
|
||||
Assert.Empty(state.Snapshot());
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Tick_NoPendingNoExpired_RevisionUnchanged()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
state.Enqueue("stays visible a while");
|
||||
state.Tick(0d);
|
||||
long revisionAfterFirstTick = state.Revision;
|
||||
|
||||
// Well within the lifetime window, nothing pending — a second Tick
|
||||
// should be a pure no-op.
|
||||
state.Tick(0.5d);
|
||||
|
||||
Assert.Equal(revisionAfterFirstTick, state.Revision);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Reset_ClearsPendingAndVisible()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
state.Enqueue("pending, never ticked");
|
||||
state.Enqueue("about to be visible");
|
||||
state.Tick(0d);
|
||||
Assert.True(state.Count > 0);
|
||||
|
||||
state.Reset();
|
||||
|
||||
Assert.Equal(0, state.Count);
|
||||
Assert.Empty(state.Snapshot());
|
||||
|
||||
// A Reset while text was still pending (never ticked) must also
|
||||
// discard the pending queue — ticking afterward shows nothing.
|
||||
state.Tick(1d);
|
||||
Assert.Equal(0, state.Count);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Revision_AdvancesOnTickThatChangesVisibleSet()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
long initial = state.Revision;
|
||||
|
||||
state.Enqueue("a line");
|
||||
state.Tick(0d);
|
||||
|
||||
Assert.True(state.Revision > initial);
|
||||
}
|
||||
}
|
||||
|
|
@ -42,11 +42,17 @@ public sealed class WeenieErrorMessagesTests
|
|||
// ── known codes — informational, no parameter ────────────────────
|
||||
|
||||
[Fact]
|
||||
public void Format_TurbineChatIsEnabled_NoParamForm()
|
||||
public void Format_0x051D_FallsBackToHex_NoRetailCaseExists()
|
||||
{
|
||||
// 0x051D came in WeenieError (no param) form at login.
|
||||
// Campaign CH slice CH2: the pre-CH2 "Turbine Chat is enabled."
|
||||
// text for 0x051D was an ACE-derived guess, never decomp-confirmed.
|
||||
// The full HandleFailureEvent port found NO case for 0x51D anywhere
|
||||
// in the switch (only 0x51C has one — case 0x51c: at raw line
|
||||
// 383115-383118 of acclient_2013_pseudo_c.txt) — retail's own
|
||||
// client simply has no display text for this id. Falling back to
|
||||
// the generic form is now the retail-faithful answer, not a gap.
|
||||
Assert.Equal(
|
||||
"Turbine Chat is enabled.",
|
||||
"WeenieError 0x051D",
|
||||
WeenieErrorMessages.Format(0x051D, param: null));
|
||||
}
|
||||
|
||||
|
|
@ -149,14 +155,16 @@ public sealed class WeenieErrorMessagesTests
|
|||
}
|
||||
|
||||
[Fact]
|
||||
public void Format_AdjacentUnmappedPKCode_StillFallsBackToHex()
|
||||
public void Format_LevelTooLowToChangePKStatus_NowResolvedByCH2()
|
||||
{
|
||||
// 0x04EE (LevelTooLowToChangePKStatusWithObject) sits right next
|
||||
// to the codes above but its retail literal
|
||||
// ("Your level is too low to change…") was NOT independently
|
||||
// byte-recovered in this pass — confirms the fallback still
|
||||
// covers the untouched neighbours rather than silently guessing.
|
||||
Assert.Equal("WeenieError 0x04EE", WeenieErrorMessages.Format(0x04EE, null));
|
||||
// 0x04EE (LevelTooLowToChangePKStatusWithObject) sits right next to
|
||||
// the PK-status codes above; the pre-CH2 test asserted the
|
||||
// fallback because only a curated ~60-entry subset was ported then.
|
||||
// Campaign CH slice CH2's full 338-row HandleFailureEvent port
|
||||
// (Appendix A row 0x4EE, Type 0x00) resolves it for real.
|
||||
Assert.Equal(
|
||||
"Your level is too low to change your player killer status with this object.",
|
||||
WeenieErrorMessages.Format(0x04EE, null));
|
||||
}
|
||||
|
||||
// ── unknown codes — graceful fallback preserves debug info ───────
|
||||
|
|
@ -193,10 +201,17 @@ public sealed class WeenieErrorMessagesTests
|
|||
}
|
||||
|
||||
[Fact]
|
||||
public void Format_FailToAffectCannotBeHarmed_SubstitutesParam()
|
||||
public void Format_0x004F_FallsBackToHex_NoRetailCaseExists()
|
||||
{
|
||||
// Campaign CH slice CH2: the pre-CH2 "You fail to affect _ because
|
||||
// they cannot be harmed!" text for 0x004F was an ACE-derived guess.
|
||||
// Direct decomp verification (grepping every "case 0x4f:" in
|
||||
// ClientCommunicationSystem::HandleFailureEvent's whole body) found
|
||||
// NONE — only 0x4E, 0x50, 0x51, 0x52, 0x53, 0x54 have cases; 0x4F is
|
||||
// skipped entirely, same as the many other gaps in that switch's
|
||||
// sparse jump table. Retail has no display text for this id.
|
||||
Assert.Equal(
|
||||
"You fail to affect Drudge because they cannot be harmed!",
|
||||
"WeenieError 0x004F: Drudge",
|
||||
WeenieErrorMessages.Format(0x004F, "Drudge"));
|
||||
}
|
||||
|
||||
|
|
@ -207,4 +222,85 @@ public sealed class WeenieErrorMessagesTests
|
|||
"+Acdream is already at full health!",
|
||||
WeenieErrorMessages.Format(0x04FF, "+Acdream"));
|
||||
}
|
||||
|
||||
// ── Campaign CH slice CH2: the full HandleFailureEvent table port ────
|
||||
|
||||
/// <summary>
|
||||
/// Pins the table's size: 338 rows (Appendix A's 339 minus the one
|
||||
/// deliberately-excluded 0x4F8, see the class doc comment on
|
||||
/// <see cref="WeenieErrorMessages"/>). A change to this number without
|
||||
/// a matching research/commit citation is a red flag, not a routine
|
||||
/// edit.
|
||||
/// </summary>
|
||||
[Fact]
|
||||
public void Resolve_FullTable_HasExactly338Rows()
|
||||
{
|
||||
int count = 0;
|
||||
for (uint id = 0; id <= 0x600u; id++)
|
||||
{
|
||||
var (text, _) = WeenieErrorMessages.Resolve(id, null);
|
||||
if (!text.StartsWith("WeenieError 0x", StringComparison.Ordinal))
|
||||
count++;
|
||||
}
|
||||
Assert.Equal(338, count);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Resolve_0x4F8_IsDeliberatelyExcluded_FallsBackToHex()
|
||||
{
|
||||
// See the class doc comment: 0x4F8's case body is a tangled
|
||||
// multi-operator+ decompiler artifact that could not be resolved
|
||||
// with confidence — excluded rather than guessed.
|
||||
var (text, type) = WeenieErrorMessages.Resolve(0x4F8, "Someone");
|
||||
Assert.Equal("WeenieError 0x04F8: Someone", text);
|
||||
Assert.Equal(RetailLogTextType.Default, type);
|
||||
}
|
||||
|
||||
// ── spot pins across all three retail routing destinations ──────────
|
||||
|
||||
[Theory]
|
||||
// ClientLocal (0x1A) — the SpewBox destination.
|
||||
[InlineData(0x017u, "You failed to go to non-combat mode.", RetailLogTextType.ClientLocal)]
|
||||
[InlineData(0x02Au, "You are too encumbered to carry that!", RetailLogTextType.ClientLocal)]
|
||||
[InlineData(0x04EBu, "You can't do that while in the air!", RetailLogTextType.ClientLocal)]
|
||||
[InlineData(0x550u, "Out of Range!", RetailLogTextType.ClientLocal)]
|
||||
// Magic (0x07) — the light-blue spell/portal-failure channel.
|
||||
[InlineData(0x402u, "Your spell fizzled.", RetailLogTextType.Magic)]
|
||||
[InlineData(0x49Bu, "You fail to link with the lifestone!", RetailLogTextType.Magic)]
|
||||
[InlineData(0x593u, "Olthoi characters can only use Lifestone and PK Arena recalls!", RetailLogTextType.Magic)]
|
||||
// Default (0x00) — the ordinary broadcast/green channel.
|
||||
[InlineData(0x4A, "Ack! You killed yourself!", RetailLogTextType.Default)]
|
||||
[InlineData(0x50Cu, "%s is now a closed fellowship.", RetailLogTextType.Default)]
|
||||
[InlineData(0x55Fu, "Only Player Killer characters may use this command!", RetailLogTextType.Default)]
|
||||
public void Resolve_SpotPins_TextAndTypeMatchAppendixA(uint id, string expectedTemplate, RetailLogTextType expectedType)
|
||||
{
|
||||
var (text, type) = WeenieErrorMessages.Resolve(id, param: null);
|
||||
Assert.Equal(expectedTemplate, text);
|
||||
Assert.Equal(expectedType, type);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Resolve_JumpFamily_SharesClientTextRefusalsConstantsVerbatim()
|
||||
{
|
||||
// HandleFailureEvent's 0x24/0x48/0x49 cases reuse the SAME string
|
||||
// globals as the local jump-refusal sites — assert byte-identity,
|
||||
// not just similar wording.
|
||||
Assert.Equal(ClientTextRefusals.CantJumpInAir, WeenieErrorMessages.Resolve(0x024u, null).Text);
|
||||
Assert.Equal(ClientTextRefusals.CantJumpPosition, WeenieErrorMessages.Resolve(0x048u, null).Text);
|
||||
Assert.Equal(ClientTextRefusals.CantJumpLoad, WeenieErrorMessages.Resolve(0x049u, null).Text);
|
||||
Assert.Equal(RetailLogTextType.ClientLocal, WeenieErrorMessages.Resolve(0x024u, null).Type);
|
||||
Assert.Equal(RetailLogTextType.ClientLocal, WeenieErrorMessages.Resolve(0x048u, null).Type);
|
||||
Assert.Equal(RetailLogTextType.ClientLocal, WeenieErrorMessages.Resolve(0x049u, null).Type);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Resolve_0x4F4_PreservesRetailDollarSTypo()
|
||||
{
|
||||
// Retail's own literal is "...because $s cannot affect anyone!" —
|
||||
// a genuine retail typo (should have been %s). Only the FIRST %s
|
||||
// substitutes; the literal "$s" must NOT be replaced.
|
||||
var (text, type) = WeenieErrorMessages.Resolve(0x4F4u, "A drudge");
|
||||
Assert.Equal("A drudge fails to affect you because $s cannot affect anyone!", text);
|
||||
Assert.Equal(RetailLogTextType.Magic, type);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue