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
|
|
@ -87,6 +87,15 @@ public static class GameEventWiring
|
|||
// itemMana/friends/squelch/externalContainers pattern — optional so
|
||||
// every existing caller compiles unchanged.
|
||||
VendorState? vendor = null,
|
||||
// Campaign CH slice CH2: the retail-faithful text/type router
|
||||
// (RuntimeCommunicationState.AddText — Core.Net cannot reference
|
||||
// AcDream.Runtime directly, so this is a delegate hole exactly like
|
||||
// every other Runtime-owned sink above). When null, WeenieError/
|
||||
// WeenieErrorWithString/CommunicationTransientString/UseDone fall
|
||||
// back to their pre-CH2 behavior (still text-correct via the full
|
||||
// WeenieErrorMessages table, just without the SpewBox split) so
|
||||
// every existing caller compiles and behaves unchanged.
|
||||
Action<string, RetailLogTextType>? onInterfaceText = null,
|
||||
Func<bool>? accepting = null)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(dispatcher);
|
||||
|
|
@ -117,15 +126,22 @@ public static class GameEventWiring
|
|||
});
|
||||
registrar.Register(GameEventType.CommunicationTransientString, e =>
|
||||
{
|
||||
// 0x02EB carries no chat type on the wire (see ParseTransient).
|
||||
// 0 is ACE's ChatMessageType.Broadcast, which its own
|
||||
// LogTextTypeEnumMapper comment names "Default" — the right
|
||||
// stand-in for a message the server sends untyped. Left at 0x00
|
||||
// by Campaign CH slice CH1 (retail color table): this is
|
||||
// server-driven text, not client-local, so it keeps the
|
||||
// Default/green color rather than moving to 0x1A.
|
||||
// 0x02EB carries no chat type on the wire (see ParseTransient) —
|
||||
// retail doesn't need one, because
|
||||
// Handle_Communication__TransientString @0x0057D460
|
||||
// HARDCODES the destination:
|
||||
// AddTextToScroll(text, 0x1A, 1, 0). Every 0x02EB message is
|
||||
// SpewBox, unconditionally, regardless of who's the recipient
|
||||
// (research doc §1.3/§2.4) — this corrects Campaign CH slice
|
||||
// CH1's routing note, which assumed "server-driven" implied
|
||||
// "not client-local" (it doesn't; retail's routing key is the
|
||||
// TYPE ARGUMENT the handler passes, not who initiated the text).
|
||||
var s = GameEvents.ParseTransient(e.Payload.Span);
|
||||
if (s is not null) chat.OnSystemMessage(s, chatType: 0u);
|
||||
if (s is null) return;
|
||||
if (onInterfaceText is not null)
|
||||
onInterfaceText(s, RetailLogTextType.ClientLocal);
|
||||
else
|
||||
chat.OnSystemMessage(s, chatType: (uint)RetailLogTextType.ClientLocal);
|
||||
});
|
||||
registrar.Register(GameEventType.PopupString, e =>
|
||||
{
|
||||
|
|
@ -227,16 +243,44 @@ public static class GameEventWiring
|
|||
// Phase I.5: WeenieError + WeenieErrorWithString parsers existed
|
||||
// (GameEvents.ParseWeenieError(WithString)) but were never registered.
|
||||
// The server fires these for game-logic failures: "not enough mana",
|
||||
// "can't pick that up", "your spell fizzled". Routed to chat.
|
||||
// "can't pick that up", "your spell fizzled".
|
||||
//
|
||||
// Campaign CH slice CH2: retail resolves BOTH the display text and
|
||||
// the AddTextToScroll destination type from the SAME per-id switch
|
||||
// (ClientCommunicationSystem::HandleFailureEvent @0x00571990 — see
|
||||
// WeenieErrorMessages' full 338-row port). When a router is wired
|
||||
// (the production path), the resolved type decides chat vs SpewBox;
|
||||
// otherwise this falls back to the legacy chat-only path so callers
|
||||
// that don't wire the router (older tests) keep their prior shape.
|
||||
registrar.Register(GameEventType.WeenieError, e =>
|
||||
{
|
||||
var code = GameEvents.ParseWeenieError(e.Payload.Span);
|
||||
if (code is not null) chat.OnWeenieError(code.Value, param: null);
|
||||
if (code is null) return;
|
||||
if (onInterfaceText is not null)
|
||||
{
|
||||
if (WeenieErrorMessages.IsSilentClientControlStatus(code.Value)) return;
|
||||
var (text, type) = WeenieErrorMessages.Resolve(code.Value, null);
|
||||
onInterfaceText(text, type);
|
||||
}
|
||||
else
|
||||
{
|
||||
chat.OnWeenieError(code.Value, param: null);
|
||||
}
|
||||
});
|
||||
registrar.Register(GameEventType.WeenieErrorWithString, e =>
|
||||
{
|
||||
var p = GameEvents.ParseWeenieErrorWithString(e.Payload.Span);
|
||||
if (p is not null) chat.OnWeenieError(p.Value.ErrorCode, p.Value.Interpolation);
|
||||
if (p is null) return;
|
||||
if (onInterfaceText is not null)
|
||||
{
|
||||
if (WeenieErrorMessages.IsSilentClientControlStatus(p.Value.ErrorCode)) return;
|
||||
var (text, type) = WeenieErrorMessages.Resolve(p.Value.ErrorCode, p.Value.Interpolation);
|
||||
onInterfaceText(text, type);
|
||||
}
|
||||
else
|
||||
{
|
||||
chat.OnWeenieError(p.Value.ErrorCode, p.Value.Interpolation);
|
||||
}
|
||||
});
|
||||
|
||||
// ── Combat ────────────────────────────────────────────────
|
||||
|
|
@ -527,10 +571,15 @@ public static class GameEventWiring
|
|||
});
|
||||
|
||||
// UseDone (0x01C7) — the Use/UseWithTarget completion signal. A non-zero
|
||||
// code is a WeenieError refusal ("You are not trained in healing!" etc.);
|
||||
// retail surfaces the string-table text as a chat line. Interim text map:
|
||||
// WeenieErrorText (#202 / register AP-74). Without this line a refused
|
||||
// kit-heal looks like "nothing happened" — the 2026-07-03 session bug.
|
||||
// code is a WeenieError refusal ("You are not trained in healing!" etc.).
|
||||
//
|
||||
// Campaign CH slice CH2: folds the former 4-entry
|
||||
// WeenieErrorText.cs (#202 / register AP-74) into the full
|
||||
// WeenieErrorMessages table, which resolves both the text AND the
|
||||
// real per-code retail destination type (most UseDone refusal codes
|
||||
// — 0x1D/0x4EB/0x4FC/0x4FE among them — route to the SpewBox, not
|
||||
// chat, per HandleFailureEvent) instead of the previous hardcoded
|
||||
// chatType 0.
|
||||
registrar.Register(GameEventType.UseDone, e =>
|
||||
{
|
||||
uint? err = GameEvents.ParseUseDone(e.Payload.Span);
|
||||
|
|
@ -543,12 +592,13 @@ public static class GameEventWiring
|
|||
if (err is null) return;
|
||||
Console.WriteLine($"[use-done] err=0x{err.Value:X4}");
|
||||
onUseDone?.Invoke(err.Value);
|
||||
// chatType 0x00 (Default): this text is client-formatted from a
|
||||
// WeenieError CODE, the same shape as HandleFailureEvent's
|
||||
// per-code switch (@0x00571990), whose majority case is 0x00 —
|
||||
// see the identical reasoning on ChatLog.OnWeenieError.
|
||||
if (err.Value != 0)
|
||||
chat.OnSystemMessage(WeenieErrorText.For(err.Value), chatType: 0);
|
||||
if (err.Value == 0) return;
|
||||
|
||||
var (text, type) = WeenieErrorMessages.Resolve(err.Value, null);
|
||||
if (onInterfaceText is not null)
|
||||
onInterfaceText(text, type);
|
||||
else
|
||||
chat.OnSystemMessage(text, chatType: (uint)type);
|
||||
});
|
||||
|
||||
// CloseGroundContainer (0x0052): clear ClientUISystem::groundObject and
|
||||
|
|
|
|||
|
|
@ -1,23 +0,0 @@
|
|||
namespace AcDream.Core.Net.Messages;
|
||||
|
||||
/// <summary>
|
||||
/// Interim WeenieError → display text. Retail resolves error codes through
|
||||
/// the portal String tables into lines like "You are not trained in
|
||||
/// healing!"; porting that lookup is #202 — until then this map (codes from
|
||||
/// ACE's <c>WeenieError</c> enum, texts phrased after the retail messages the
|
||||
/// enum names encode) covers the errors our current use/heal flows can
|
||||
/// produce. Register row AP-74. Unknown codes fall back to a generic line
|
||||
/// carrying the code so nothing is ever silently dropped again (the
|
||||
/// 2026-07-03 "kit did nothing" session was an unsurfaced 0x04FC).
|
||||
/// </summary>
|
||||
public static class WeenieErrorText
|
||||
{
|
||||
public static string For(uint error) => error switch
|
||||
{
|
||||
0x001Du => "You're too busy!", // YoureTooBusy
|
||||
0x04EBu => "You can't do that while in the air!", // YouCantDoThatWhileInTheAir
|
||||
0x04FCu => "You are not trained in healing!", // YouArentTrainedInHealing
|
||||
0x04FEu => "You can't heal that!", // YouCantHealThat
|
||||
_ => $"You can't do that. (error 0x{error:X4})",
|
||||
};
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue