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
|
|
@ -212,6 +212,14 @@ public sealed class GameRuntime
|
|||
faultInjection);
|
||||
|
||||
context.Movement = new RuntimeLocalPlayerMovementState();
|
||||
// Campaign CH slice CH2: local jump refusals (CommenceJump/
|
||||
// DoJump's WeenieError family — research doc §4.2/§6.4) reach
|
||||
// the SpewBox through the SAME AddText router server-sent
|
||||
// WeenieErrors use. Wired here, at construction, because
|
||||
// Communication (built just above) always exists before any
|
||||
// PlayerMovementController is installed.
|
||||
context.Movement.OnInterfaceText =
|
||||
(text, type) => context.Communication.AddText(text, type);
|
||||
construction.Own(context.Movement);
|
||||
Fault(
|
||||
GameRuntimeConstructionPoint.MovementCreated,
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
using System;
|
||||
using System.Numerics;
|
||||
using AcDream.Core.Chat;
|
||||
using AcDream.Core.Physics;
|
||||
|
||||
namespace AcDream.Runtime.Gameplay;
|
||||
|
|
@ -166,6 +167,18 @@ public sealed class PlayerMovementController
|
|||
private uint _localEntityId;
|
||||
private AcDream.Core.Physics.Motion.PositionManager? _positionManager;
|
||||
|
||||
/// <summary>
|
||||
/// Campaign CH slice CH2: reports a client-locally-detected jump refusal
|
||||
/// (retail's <c>CommenceJump @0x0056AF90</c> / <c>DoJump @0x0056B110</c>
|
||||
/// WeenieError family — research doc §4.2/§6.4) to the SpewBox router.
|
||||
/// Wired by <c>RuntimeLocalPlayerMovementState</c>, whose
|
||||
/// <c>OnInterfaceText</c> setter applies to every controller it installs
|
||||
/// (including this one, at commit time). Never invoked directly for the
|
||||
/// jump physics/charge behaviour itself — this is a REPORT of an
|
||||
/// already-decided refusal, not a gate.
|
||||
/// </summary>
|
||||
public Action<string, RetailLogTextType>? OnInterfaceText { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Maximum Z increase per movement step before the move is rejected.
|
||||
///
|
||||
|
|
@ -926,6 +939,41 @@ public sealed class PlayerMovementController
|
|||
"A sealed, retired, or discarded Runtime movement controller cannot be mutated.");
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Campaign CH slice CH2: retail-exact <c>CommenceJump</c>/<c>DoJump</c>
|
||||
/// refusal-text dispatch (research doc §4.2, verified directly against
|
||||
/// the decomp — NOT the <c>HandleFailureEvent</c>/<c>WeenieErrorMessages</c>
|
||||
/// table, which is a DIFFERENT switch that happens to share three of
|
||||
/// these same string globals).
|
||||
/// <c>ClientCombatSystem::CommenceJump @0x0056AF90</c> and
|
||||
/// <c>ClientCombatSystem::DoJump @0x0056B110</c> each explicitly handle
|
||||
/// only <c>0x24</c>/<c>0x48</c>/<c>0x49</c>; every other code —
|
||||
/// including <c>0x47 GeneralMovementFailure</c> (fully constrained or
|
||||
/// can't afford the jump's stamina cost, <see cref="MotionInterpreter.jump_is_allowed"/>)
|
||||
/// and <c>0x08 NoPhysicsObject</c> — falls through their dispatch with
|
||||
/// NO <c>AddTextToScroll</c> call at all. Confirmed via <c>DoJump</c>'s
|
||||
/// compiled <c>switch(eax_7)</c> (raw 376288-376312): exactly 4 real
|
||||
/// case targets (<c>0</c>, <c>0x24</c>, <c>0x48</c>, <c>0x49</c>), every
|
||||
/// other index routed to the function's silent fall-through end. A
|
||||
/// fully-constrained or out-of-stamina jump refusal is therefore
|
||||
/// SILENT in retail — no on-screen text, the player just doesn't jump.
|
||||
/// </summary>
|
||||
private void ReportJumpRefusal(WeenieError result)
|
||||
{
|
||||
if (OnInterfaceText is null)
|
||||
return;
|
||||
|
||||
string? text = result switch
|
||||
{
|
||||
WeenieError.NotGrounded => ClientTextRefusals.CantJumpInAir, // 0x24
|
||||
WeenieError.YouCantJumpFromThisPosition => ClientTextRefusals.CantJumpPosition, // 0x48
|
||||
WeenieError.CantJumpLoadedDown => ClientTextRefusals.CantJumpLoad, // 0x49
|
||||
_ => null,
|
||||
};
|
||||
if (text is not null)
|
||||
OnInterfaceText(text, RetailLogTextType.ClientLocal);
|
||||
}
|
||||
|
||||
private void EnsurePublishedForRuntimeOperation()
|
||||
{
|
||||
if (_publicationLifecycle
|
||||
|
|
@ -2470,7 +2518,13 @@ public sealed class PlayerMovementController
|
|||
// place StandingLongJump arms (grounded + Ready + no
|
||||
// sidestep/turn). Never called by production code before
|
||||
// this line despite the W3 port.
|
||||
_motion.ChargeJump();
|
||||
//
|
||||
// Campaign CH slice CH2: the return value used to be
|
||||
// discarded — a refused charge (CantJumpLoadedDown /
|
||||
// YouCantJumpFromThisPosition) silently drained the power
|
||||
// bar with no explanation. Report it exactly as
|
||||
// ClientCombatSystem::CommenceJump @0x0056AF90 does.
|
||||
ReportJumpRefusal(_motion.ChargeJump());
|
||||
}
|
||||
float chargeRate = _motion.InterpretedState.CurrentStyle
|
||||
== AcDream.Core.Combat.CombatInputPlanner.DualWieldCombatStyle
|
||||
|
|
@ -2509,6 +2563,14 @@ public sealed class PlayerMovementController
|
|||
// sent in JumpAction — local + remote stay in sync.
|
||||
_body.set_local_velocity(outJumpVelocity.Value, autonomous: true);
|
||||
}
|
||||
else
|
||||
{
|
||||
// Campaign CH slice CH2: a refused fire used to reset the
|
||||
// charge state and return silently — the power bar drained
|
||||
// and nothing happened, with no explanation. Report it
|
||||
// exactly as ClientCombatSystem::DoJump @0x0056B110 does.
|
||||
ReportJumpRefusal(jumpResult);
|
||||
}
|
||||
_jumpCharging = false;
|
||||
_jumpExtent = 0f;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -60,6 +60,7 @@ public sealed class RuntimeCommunicationState : IDisposable
|
|||
public RuntimeCommunicationState(int maximumChatEntries = 500)
|
||||
{
|
||||
Chat = new ChatLog(maximumChatEntries);
|
||||
SpewBox = new SpewBoxState();
|
||||
CommandTargets = new ChatCommandTargetState(Chat);
|
||||
_events = new RuntimeCommunicationEventStream(Chat);
|
||||
TurbineChat = new TurbineChatState();
|
||||
|
|
@ -73,6 +74,17 @@ public sealed class RuntimeCommunicationState : IDisposable
|
|||
}
|
||||
|
||||
public ChatLog Chat { get; }
|
||||
|
||||
/// <summary>
|
||||
/// Campaign CH slice CH2: retail's transient on-screen "interface text"
|
||||
/// queue (<c>gmSpewBoxUI</c>) — the SECOND sink <see cref="AddText"/>
|
||||
/// can route to. Never written to directly by producers; always through
|
||||
/// <see cref="AddText"/> so the <c>type == ClientLocal</c> routing rule
|
||||
/// stays centralized at one chokepoint, matching retail's
|
||||
/// <c>ClientSystem::AddTextToScroll</c>.
|
||||
/// </summary>
|
||||
public SpewBoxState SpewBox { get; }
|
||||
|
||||
public ChatCommandTargetState CommandTargets { get; }
|
||||
public TurbineChatState TurbineChat { get; }
|
||||
public FriendsState Friends { get; }
|
||||
|
|
@ -114,6 +126,62 @@ public sealed class RuntimeCommunicationState : IDisposable
|
|||
public void ResetFriends() => Friends.Clear();
|
||||
public void ResetSquelch() => Squelch.Clear();
|
||||
|
||||
/// <summary>
|
||||
/// Campaign CH slice CH2: SpewBox lines are purely transient screen
|
||||
/// flash — unlike the chat transcript (which survives a reconnect via
|
||||
/// <see cref="ResetChatIdentity"/>'s preserve-content reset), a fresh
|
||||
/// generation must not resurrect a stale refusal line.
|
||||
/// </summary>
|
||||
public void ResetSpewBox() => SpewBox.Reset();
|
||||
|
||||
/// <summary>
|
||||
/// The single chokepoint every producer of player-visible interface
|
||||
/// text must go through — the direct analogue of retail's
|
||||
/// <c>ClientSystem::AddTextToScroll(text, type, allowPluginFilter,
|
||||
/// windowId) @0x00563C50</c>.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Retail's routing rule (research doc §2.1) is a receiver-side type
|
||||
/// filter, not a sender-side destination switch:
|
||||
/// <list type="bullet">
|
||||
/// <item><c>type == RetailLogTextType.ClientLocal (0x1A)</c> → the
|
||||
/// SpewBox ONLY. Every <c>ChatInterface</c> window is born with that
|
||||
/// exact bit cleared from its type filter
|
||||
/// (<c>ChatInterface::ChatInterface @0x004F4550</c>,
|
||||
/// <c>m_llTextTypeFilter &= 0xFBFFFFFF</c>) — <c>0x1A</c> is
|
||||
/// precisely what every chat window refuses. Retail also skips the
|
||||
/// timestamp prefix and the chat-log-file write for this type
|
||||
/// (§2.1 step 4); since this branch never touches
|
||||
/// <see cref="Chat"/> at all, that behaviour falls out for free.
|
||||
/// </item>
|
||||
/// <item>Every other type → the existing chat transcript, tagged
|
||||
/// with <paramref name="type"/> exactly as before.</item>
|
||||
/// </list>
|
||||
/// <paramref name="windowId"/> is accepted for future parity with
|
||||
/// retail's per-window echo (a non-zero window ID lands in both the
|
||||
/// SpewBox AND that specific chat window — research doc §2.3) but is
|
||||
/// not yet consumed; every current production caller passes the
|
||||
/// default <c>0</c>.
|
||||
/// </remarks>
|
||||
public void AddText(string text, RetailLogTextType type, uint windowId = 0)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(text);
|
||||
|
||||
// Retail's own first step (0x00563C50): trim trailing whitespace
|
||||
// before anything else, regardless of destination.
|
||||
text = text.TrimEnd();
|
||||
if (text.Length == 0)
|
||||
return;
|
||||
|
||||
if (type == RetailLogTextType.ClientLocal)
|
||||
{
|
||||
SpewBox.Enqueue(text);
|
||||
return;
|
||||
}
|
||||
|
||||
Chat.OnSystemMessage(text, (uint)type);
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
if (_disposed)
|
||||
|
|
@ -126,6 +194,7 @@ public sealed class RuntimeCommunicationState : IDisposable
|
|||
Friends.Clear();
|
||||
Squelch.Clear();
|
||||
Chat.ResetSessionIdentity();
|
||||
SpewBox.Reset();
|
||||
}
|
||||
|
||||
private sealed class CommunicationView(ChatLog chat) : IRuntimeChatView
|
||||
|
|
|
|||
|
|
@ -1,4 +1,5 @@
|
|||
using System.Diagnostics;
|
||||
using AcDream.Core.Chat;
|
||||
using AcDream.Core.Combat;
|
||||
using AcDream.Core.Physics;
|
||||
|
||||
|
|
@ -97,6 +98,26 @@ public sealed class RuntimeLocalPlayerMovementState
|
|||
private MovementInput _commandInput;
|
||||
private bool _disposed;
|
||||
private long _revision;
|
||||
private Action<string, RetailLogTextType>? _onInterfaceText;
|
||||
|
||||
/// <summary>
|
||||
/// Campaign CH slice CH2: the retail-faithful text/type router
|
||||
/// (<c>RuntimeCommunicationState.AddText</c>) — applied to every
|
||||
/// controller this owner installs, past and future, so a client-local
|
||||
/// jump refusal (<c>PlayerMovementController</c>'s local
|
||||
/// <c>ChargeJump</c>/<c>jump</c> calls, research doc §4.2/§6.4) reaches
|
||||
/// the SpewBox through the same chokepoint server-sent WeenieErrors use.
|
||||
/// </summary>
|
||||
public Action<string, RetailLogTextType>? OnInterfaceText
|
||||
{
|
||||
get => _onInterfaceText;
|
||||
set
|
||||
{
|
||||
_onInterfaceText = value;
|
||||
if (_controller is not null)
|
||||
_controller.OnInterfaceText = value;
|
||||
}
|
||||
}
|
||||
|
||||
public PlayerMovementController? Controller
|
||||
{
|
||||
|
|
@ -114,6 +135,8 @@ public sealed class RuntimeLocalPlayerMovementState
|
|||
return;
|
||||
_controller?.RetireRuntimePublication();
|
||||
_controller = value;
|
||||
if (_controller is not null)
|
||||
_controller.OnInterfaceText = _onInterfaceText;
|
||||
ControllerOwnershipEpoch++;
|
||||
Interlocked.Increment(ref _revision);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -63,7 +63,13 @@ public sealed record LiveSocialSessionBindings(
|
|||
ChatLog Chat,
|
||||
TurbineChatState TurbineChat,
|
||||
FriendsState? Friends,
|
||||
SquelchState? Squelch);
|
||||
SquelchState? Squelch,
|
||||
// Campaign CH slice CH2: the retail-faithful text/type router
|
||||
// (RuntimeCommunicationState.AddText). Optional/nullable so every
|
||||
// existing caller (including tests that build a bare ChatLog with no
|
||||
// owning RuntimeCommunicationState) compiles unchanged; GameEventWiring
|
||||
// falls back to its pre-CH2 chat-only behavior when this is null.
|
||||
Action<string, RetailLogTextType>? AddText = null);
|
||||
|
||||
/// <summary>
|
||||
/// Owns every inbound subscription for one exact live session. Domain state
|
||||
|
|
@ -195,6 +201,7 @@ public sealed class LiveSessionEventRouter : ILiveSessionEventRouting
|
|||
clientTime: character.ClientTime,
|
||||
externalContainers: inventory.ExternalContainers,
|
||||
vendor: inventory.Vendor,
|
||||
onInterfaceText: social.AddText,
|
||||
accepting: IsAccepting));
|
||||
ConstructionCheckpoint();
|
||||
|
||||
|
|
@ -267,10 +274,21 @@ public sealed class LiveSessionEventRouter : ILiveSessionEventRouting
|
|||
// raw wire word straight into AddTextToScroll with zero
|
||||
// remapping (research doc §3.3 / HearSpeech.cs doc).
|
||||
speech.ChatType));
|
||||
// 0xF7E0 ServerMessage — Campaign CH slice CH2: routed through
|
||||
// AddText with the wire chatType verbatim, matching retail's
|
||||
// Handle_Communication__TextboxString @0x0057D3A0
|
||||
// (AddTextToScroll(text, wireChatType, 1, 0) — the wire type
|
||||
// decides chat vs SpewBox, exactly like every other producer).
|
||||
Subscribe<ServerMessage.Parsed>(
|
||||
h => session.ServerMessageReceived += h,
|
||||
h => session.ServerMessageReceived -= h,
|
||||
message => social.Chat.OnSystemMessage(message.Message, message.ChatType));
|
||||
message =>
|
||||
{
|
||||
if (social.AddText is { } addText)
|
||||
addText(message.Message, (RetailLogTextType)message.ChatType);
|
||||
else
|
||||
social.Chat.OnSystemMessage(message.Message, message.ChatType);
|
||||
});
|
||||
Subscribe<EmoteText.Parsed>(h => session.EmoteHeard += h, h => session.EmoteHeard -= h, emote =>
|
||||
social.Chat.OnEmote(emote.SenderName, emote.Text, emote.SenderGuid));
|
||||
Subscribe<SoulEmote.Parsed>(h => session.SoulEmoteHeard += h, h => session.SoulEmoteHeard -= h, emote =>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue