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
46
tests/AcDream.App.Tests/UI/SpewBoxControllerTests.cs
Normal file
46
tests/AcDream.App.Tests/UI/SpewBoxControllerTests.cs
Normal file
|
|
@ -0,0 +1,46 @@
|
|||
using AcDream.App.UI;
|
||||
using AcDream.Core.Chat;
|
||||
using AcDream.UI.Abstractions.Panels.SpewBox;
|
||||
|
||||
namespace AcDream.App.Tests.UI;
|
||||
|
||||
public sealed class SpewBoxControllerTests
|
||||
{
|
||||
[Fact]
|
||||
public void Controller_IsClickThroughOverlayAndDisposesFromRetainedRoot()
|
||||
{
|
||||
var root = new UiRoot
|
||||
{
|
||||
Width = 1280f,
|
||||
Height = 720f,
|
||||
};
|
||||
var state = new SpewBoxState();
|
||||
|
||||
using (var controller = new SpewBoxController(root, new SpewBoxVM(state)))
|
||||
{
|
||||
UiText text = Assert.IsType<UiText>(Assert.Single(root.Children));
|
||||
Assert.False(text.Visible);
|
||||
Assert.True(text.ClickThrough);
|
||||
Assert.Equal(int.MaxValue, text.ZOrder);
|
||||
|
||||
state.Enqueue("You can't jump while in the air");
|
||||
|
||||
UiText.Line line = Assert.Single(text.LinesProvider!());
|
||||
Assert.Equal("You can't jump while in the air", line.Text);
|
||||
Assert.True(text.Visible);
|
||||
}
|
||||
|
||||
Assert.Empty(root.Children);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Controller_NoContent_LeavesTextHiddenWithEmptyLines()
|
||||
{
|
||||
var root = new UiRoot { Width = 1280f, Height = 720f };
|
||||
using var controller = new SpewBoxController(root, new SpewBoxVM(new SpewBoxState()));
|
||||
|
||||
UiText text = Assert.IsType<UiText>(Assert.Single(root.Children));
|
||||
Assert.Empty(text.LinesProvider!());
|
||||
Assert.False(text.Visible);
|
||||
}
|
||||
}
|
||||
195
tests/AcDream.App.Tests/UI/SpewBoxLayoutDumpDiagnostic.cs
Normal file
195
tests/AcDream.App.Tests/UI/SpewBoxLayoutDumpDiagnostic.cs
Normal file
|
|
@ -0,0 +1,195 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;
|
||||
using DatReaderWriter;
|
||||
using DatReaderWriter.DBObjs;
|
||||
using DatReaderWriter.Options;
|
||||
using DatReaderWriter.Types;
|
||||
using Xunit;
|
||||
using Xunit.Abstractions;
|
||||
|
||||
namespace AcDream.App.Tests.UI;
|
||||
|
||||
/// <summary>
|
||||
/// Campaign CH slice CH2, task C.7: a one-shot diagnostic sweep of every
|
||||
/// installed <see cref="LayoutDesc"/> for an element of retail's SpewBox
|
||||
/// class (<c>0x10000016</c> — <c>gmSpewBoxUI::GetUIElementType @0x004D5AA0</c>).
|
||||
/// Not a gate/conformance test — just a discovery tool, per the research
|
||||
/// doc's §8.1/§8.2 open question. Skips (does not fail) when the installed
|
||||
/// DAT directory is unavailable, matching every other
|
||||
/// <c>ContentConformanceDats.ResolveDatDir()</c>-gated diagnostic in this
|
||||
/// tree.
|
||||
///
|
||||
/// <para>
|
||||
/// <b>RESULT (2026-08-09, run against the installed <c>client_portal.dat</c>):</b>
|
||||
/// the installed DAT's entire LayoutDesc id space is the CLOSED range
|
||||
/// <c>0x21000000</c>-<c>0x21000075</c> (118 possible ids, 101 populated —
|
||||
/// sanity-checked by confirming 3 independently-known ids, 0x2100002E
|
||||
/// character window / 0x21000023 inventory / 0x21000016 toolbar prototype,
|
||||
/// are all present). The sweep is therefore EXHAUSTIVE, and it finds
|
||||
/// <b>ZERO</b> elements of class <c>0x10000016</c> anywhere in any of the
|
||||
/// 101 layouts, and LayoutDesc <c>0x10000012</c> — the id the decompiled
|
||||
/// <c>CreateChildElementByEnum(null, 0x10000012, 0x1000004A)</c> call
|
||||
/// appears to reference — exists but has zero top-level elements (it is
|
||||
/// not the per-line template catalog; that id must resolve through a
|
||||
/// different mechanism than a direct <c>dats.Get<LayoutDesc></c> hit,
|
||||
/// which this slice did not crack). Conclusion: <c>gmSpewBoxUI</c> is
|
||||
/// mounted directly from C++ code in <c>gmClient</c>'s HUD registration
|
||||
/// block (research doc §1.1) rather than resolved from any authored
|
||||
/// LayoutDesc tree — its position/extent/font/color/max-items are NOT
|
||||
/// recoverable via this dump technique. Every value the SpewBox
|
||||
/// presentation uses below is therefore an invented placeholder with its
|
||||
/// own divergence-register row, exactly as the research doc's §3.2
|
||||
/// PRESENTATION-UNKNOWN section predicted.
|
||||
/// </para>
|
||||
/// </summary>
|
||||
public sealed class SpewBoxLayoutDumpDiagnostic
|
||||
{
|
||||
private readonly ITestOutputHelper _out;
|
||||
public SpewBoxLayoutDumpDiagnostic(ITestOutputHelper output) => _out = output;
|
||||
|
||||
private const uint SpewBoxElementClass = 0x10000016u;
|
||||
private const uint ListBoxElementClass = 0x10000049u;
|
||||
private const uint LineTemplateLayoutEnum = 0x10000012u;
|
||||
private const uint LineTemplateElementId = 0x1000004Au;
|
||||
private const uint ListBoxMaxItemsProperty = 0x10000028u;
|
||||
|
||||
private static string? ResolveDatDir()
|
||||
{
|
||||
var fromEnv = System.Environment.GetEnvironmentVariable("ACDREAM_DAT_DIR");
|
||||
if (!string.IsNullOrWhiteSpace(fromEnv) && System.IO.Directory.Exists(fromEnv))
|
||||
return fromEnv;
|
||||
var def = System.IO.Path.Combine(
|
||||
System.Environment.GetFolderPath(System.Environment.SpecialFolder.UserProfile),
|
||||
"Documents", "Asheron's Call");
|
||||
return System.IO.Directory.Exists(def) ? def : null;
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void SweepInstalledLayoutDescs_ForSpewBoxElementClass()
|
||||
{
|
||||
string? datDir = ResolveDatDir();
|
||||
if (datDir is null)
|
||||
{
|
||||
_out.WriteLine("SKIP: installed retail DAT directory is unavailable.");
|
||||
return;
|
||||
}
|
||||
|
||||
using var dats = new DatCollection(datDir, DatAccessType.Read);
|
||||
|
||||
int scanned = 0;
|
||||
var hits = new List<(uint LayoutId, ElementDesc Element)>();
|
||||
var allIds = dats.GetAllIdsOfType<LayoutDesc>().ToList();
|
||||
_out.WriteLine($"Portal.GetAllIdsOfType<LayoutDesc> count: {dats.Portal.GetAllIdsOfType<LayoutDesc>().Count()}");
|
||||
_out.WriteLine($"HighRes.GetAllIdsOfType<LayoutDesc> count: {dats.HighRes.GetAllIdsOfType<LayoutDesc>().Count()}");
|
||||
_out.WriteLine($"Contains known char-window 0x2100002E: {allIds.Contains(0x2100002Eu)}");
|
||||
_out.WriteLine($"Contains known inventory 0x21000023: {allIds.Contains(0x21000023u)}");
|
||||
_out.WriteLine($"Contains known toolbar 0x21000016: {allIds.Contains(0x21000016u)}");
|
||||
_out.WriteLine($"Min id: 0x{allIds.Min():X8} Max id: 0x{allIds.Max():X8}");
|
||||
|
||||
foreach (uint layoutId in allIds)
|
||||
{
|
||||
scanned++;
|
||||
if (!dats.Portal.TryGet<LayoutDesc>(layoutId, out LayoutDesc? ld) || ld is null)
|
||||
continue;
|
||||
|
||||
foreach (var kv in ld.Elements)
|
||||
{
|
||||
var found = FindByType(kv.Value, SpewBoxElementClass);
|
||||
if (found is not null)
|
||||
hits.Add((layoutId, found));
|
||||
}
|
||||
}
|
||||
|
||||
_out.WriteLine($"Scanned {scanned} installed LayoutDescs.");
|
||||
_out.WriteLine($"Elements of class 0x{SpewBoxElementClass:X8} (gmSpewBoxUI): {hits.Count}");
|
||||
|
||||
foreach (var (layoutId, element) in hits)
|
||||
{
|
||||
_out.WriteLine(
|
||||
$" LayoutDesc 0x{layoutId:X8} -> element 0x{element.ElementId:X8} "
|
||||
+ $"pos=({element.X},{element.Y}) size=({element.Width}x{element.Height}) "
|
||||
+ $"zLevel={element.ZLevel} readOrder={element.ReadOrder} "
|
||||
+ $"children={element.Children.Count}");
|
||||
|
||||
var listBox = FindByType(element, ListBoxElementClass);
|
||||
if (listBox is not null)
|
||||
{
|
||||
_out.WriteLine(
|
||||
$" ListBox child 0x{listBox.ElementId:X8} "
|
||||
+ $"pos=({listBox.X},{listBox.Y}) size=({listBox.Width}x{listBox.Height})");
|
||||
DumpProperties(listBox, " ");
|
||||
}
|
||||
else
|
||||
{
|
||||
_out.WriteLine(" (no ListBox child of class 0x10000049 found)");
|
||||
}
|
||||
}
|
||||
|
||||
// Also probe the presumed shared line-template catalog directly —
|
||||
// gmSpewBoxUI::Update's CreateChildElementByEnum(null, 0x10000012,
|
||||
// 0x1000004A) call implies LayoutDesc 0x10000012 hosts a template
|
||||
// catalog with a top-level entry 0x1000004A.
|
||||
if (dats.Portal.TryGet<LayoutDesc>(LineTemplateLayoutEnum, out LayoutDesc? templateLd)
|
||||
&& templateLd is not null)
|
||||
{
|
||||
_out.WriteLine($"LayoutDesc 0x{LineTemplateLayoutEnum:X8} exists ({templateLd.Elements.Count} top-level elements).");
|
||||
if (templateLd.Elements.TryGetValue(LineTemplateElementId, out ElementDesc? lineTemplate))
|
||||
{
|
||||
_out.WriteLine(
|
||||
$" Line template 0x{LineTemplateElementId:X8}: type=0x{lineTemplate.Type:X8} "
|
||||
+ $"pos=({lineTemplate.X},{lineTemplate.Y}) size=({lineTemplate.Width}x{lineTemplate.Height})");
|
||||
DumpProperties(lineTemplate, " ");
|
||||
}
|
||||
else
|
||||
{
|
||||
_out.WriteLine($" No top-level element 0x{LineTemplateElementId:X8} in that LayoutDesc.");
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
_out.WriteLine($"LayoutDesc 0x{LineTemplateLayoutEnum:X8} does not exist in the installed DAT.");
|
||||
}
|
||||
|
||||
// Informational only — this is a discovery sweep, not a pass/fail gate.
|
||||
// The findings are transcribed into WeenieErrorMessages/SpewBoxController
|
||||
// doc comments and the divergence register by hand after reading this
|
||||
// output; there is nothing here worth asserting on.
|
||||
}
|
||||
|
||||
private static ElementDesc? FindByType(ElementDesc d, uint type)
|
||||
{
|
||||
if (d.Type == type)
|
||||
return d;
|
||||
foreach (var kv in d.Children)
|
||||
{
|
||||
var found = FindByType(kv.Value, type);
|
||||
if (found is not null)
|
||||
return found;
|
||||
}
|
||||
return null;
|
||||
}
|
||||
|
||||
private static void DumpProperties(ElementDesc d, string indent)
|
||||
{
|
||||
if (d.StateDesc?.Properties is null)
|
||||
{
|
||||
System.Console.WriteLine($"{indent}(no direct-state properties)");
|
||||
return;
|
||||
}
|
||||
|
||||
foreach (var (propertyId, property) in d.StateDesc.Properties)
|
||||
{
|
||||
System.Console.WriteLine($"{indent}property 0x{propertyId:X8} = {Describe(property)}"
|
||||
+ (propertyId == ListBoxMaxItemsProperty ? " <-- MaxConcurrentItems" : ""));
|
||||
}
|
||||
}
|
||||
|
||||
private static string Describe(object property) => property switch
|
||||
{
|
||||
DatReaderWriter.Types.EnumBaseProperty e => $"Enum({e.Value})",
|
||||
DatReaderWriter.Types.DataIdBaseProperty did => $"DataId(0x{did.Value:X8})",
|
||||
DatReaderWriter.Types.ArrayBaseProperty arr => $"Array[{arr.Value.Count}]({string.Join(", ", arr.Value.Select(Describe))})",
|
||||
_ => property.ToString() ?? "?",
|
||||
};
|
||||
}
|
||||
|
|
@ -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()
|
||||
{
|
||||
|
|
|
|||
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);
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Numerics;
|
||||
using AcDream.Core.Chat;
|
||||
using AcDream.Core.Physics;
|
||||
using AcDream.Core.Physics.Motion;
|
||||
using AcDream.Runtime.Gameplay;
|
||||
|
|
@ -880,6 +881,65 @@ public class PlayerMovementControllerTests
|
|||
Assert.Equal(baseline, restored, precision: 4);
|
||||
}
|
||||
|
||||
// ── Campaign CH slice CH2: local jump refusals reach the SpewBox ───────
|
||||
|
||||
[Fact]
|
||||
public void ChargeJump_RefusedByOverBurden_ReportsCantJumpLoadedDown()
|
||||
{
|
||||
// CACQualities::CanJump refuses past 200% load (PlayerWeenie.CanJump,
|
||||
// CanJumpLoadThreshold = 2.0f) — a real, production-reachable refusal,
|
||||
// not a fake. Retail: ClientCombatSystem::CommenceJump @0x0056AF90's
|
||||
// eax_3 == 0x49 branch -> cant_jump_load.
|
||||
var engine = MakeFlatEngine();
|
||||
var controller = new PlayerMovementController(engine);
|
||||
controller.SeedPlacementForTest(new Vector3(96f, 96f, 50f), 0x0001, new Vector3(96f, 96f, 50f));
|
||||
controller.SetCharacterBurden(2.5f);
|
||||
|
||||
var reported = new List<(string Text, AcDream.Core.Chat.RetailLogTextType Type)>();
|
||||
controller.OnInterfaceText = (text, type) => reported.Add((text, type));
|
||||
|
||||
controller.Update(0.016f, new MovementInput(Jump: true));
|
||||
|
||||
var report = Assert.Single(reported);
|
||||
Assert.Equal(ClientTextRefusals.CantJumpLoad, report.Text);
|
||||
Assert.Equal(AcDream.Core.Chat.RetailLogTextType.ClientLocal, report.Type);
|
||||
Assert.False(controller.IsAirborne, "a refused charge must not launch the player");
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ChargeJump_Succeeds_ReportsNothing()
|
||||
{
|
||||
var engine = MakeFlatEngine();
|
||||
var controller = new PlayerMovementController(engine);
|
||||
controller.SeedPlacementForTest(new Vector3(96f, 96f, 50f), 0x0001, new Vector3(96f, 96f, 50f));
|
||||
|
||||
var reported = new List<string>();
|
||||
controller.OnInterfaceText = (text, _) => reported.Add(text);
|
||||
|
||||
controller.Update(1.0f, new MovementInput(Jump: true)); // full charge
|
||||
controller.Update(0.016f, new MovementInput(Jump: false)); // release -> jump fires
|
||||
|
||||
Assert.Empty(reported);
|
||||
Assert.True(controller.IsAirborne);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ChargeJump_RefusalWithNoObserverWired_DoesNotThrow()
|
||||
{
|
||||
// OnInterfaceText defaults to null (no production wiring in a bare
|
||||
// test controller) — the refusal path must be a safe no-op, not a
|
||||
// NullReferenceException.
|
||||
var engine = MakeFlatEngine();
|
||||
var controller = new PlayerMovementController(engine);
|
||||
controller.SeedPlacementForTest(new Vector3(96f, 96f, 50f), 0x0001, new Vector3(96f, 96f, 50f));
|
||||
controller.SetCharacterBurden(2.5f);
|
||||
|
||||
var exception = Record.Exception(() =>
|
||||
controller.Update(0.016f, new MovementInput(Jump: true)));
|
||||
|
||||
Assert.Null(exception);
|
||||
}
|
||||
|
||||
// ── Campaign P Slice P5 (2026-07-30): ConstraintManager leash arming (#167) ──
|
||||
//
|
||||
// docs/research/2026-07-30-constraint-leash-constants.md. The player's
|
||||
|
|
|
|||
|
|
@ -167,6 +167,82 @@ public sealed class RuntimeCommunicationStateTests
|
|||
Assert.Null(second.CommandTargets.LastIncomingTellSender);
|
||||
}
|
||||
|
||||
// ── Campaign CH slice CH2: AddText routing chokepoint ────────────────
|
||||
|
||||
[Fact]
|
||||
public void AddText_ClientLocal_RoutesToSpewBoxOnly_NeverChatTranscript()
|
||||
{
|
||||
// Retail: type == 0x1A (ClientLocal) is exactly the bit every
|
||||
// ChatInterface window's default filter excludes
|
||||
// (ChatInterface::ChatInterface @0x004F4550,
|
||||
// m_llTextTypeFilter &= 0xFBFFFFFF). The CH1-era ChatLog.OnWeenieError
|
||||
// path put EVERY WeenieError line in chat, including 0x1A ones —
|
||||
// this is the fix: a ClientLocal line must reach SpewBox and never
|
||||
// touch the chat transcript at all.
|
||||
using var state = new RuntimeCommunicationState();
|
||||
|
||||
state.AddText("You can't jump while in the air", RetailLogTextType.ClientLocal);
|
||||
|
||||
Assert.Equal(0, state.Chat.Count);
|
||||
state.SpewBox.Tick(0d);
|
||||
Assert.Equal(1, state.SpewBox.Count);
|
||||
Assert.Equal("You can't jump while in the air", state.SpewBox.Snapshot()[0].Text);
|
||||
}
|
||||
|
||||
[Theory]
|
||||
[InlineData(RetailLogTextType.Default)]
|
||||
[InlineData(RetailLogTextType.Magic)]
|
||||
[InlineData(RetailLogTextType.System)]
|
||||
public void AddText_NonClientLocalTypes_RouteToChatOnly_NeverSpewBox(RetailLogTextType type)
|
||||
{
|
||||
using var state = new RuntimeCommunicationState();
|
||||
|
||||
state.AddText("Your spell fizzled.", type);
|
||||
|
||||
Assert.Equal(1, state.Chat.Count);
|
||||
Assert.Equal("Your spell fizzled.", state.Chat.Snapshot()[0].Text);
|
||||
Assert.Equal((uint)type, state.Chat.Snapshot()[0].LogTextType);
|
||||
state.SpewBox.Tick(0d);
|
||||
Assert.Equal(0, state.SpewBox.Count);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddText_TrimsTrailingWhitespace_LikeRetailAddTextToScroll()
|
||||
{
|
||||
using var state = new RuntimeCommunicationState();
|
||||
|
||||
state.AddText("Out of Range! ", RetailLogTextType.ClientLocal);
|
||||
|
||||
state.SpewBox.Tick(0d);
|
||||
Assert.Equal("Out of Range!", state.SpewBox.Snapshot()[0].Text);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void AddText_EmptyAfterTrim_IsDropped()
|
||||
{
|
||||
using var state = new RuntimeCommunicationState();
|
||||
|
||||
state.AddText(" ", RetailLogTextType.ClientLocal);
|
||||
state.AddText(" ", RetailLogTextType.Default);
|
||||
|
||||
state.SpewBox.Tick(0d);
|
||||
Assert.Equal(0, state.SpewBox.Count);
|
||||
Assert.Equal(0, state.Chat.Count);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Dispose_ResetsSpewBox()
|
||||
{
|
||||
var state = new RuntimeCommunicationState();
|
||||
state.AddText("about to be torn down", RetailLogTextType.ClientLocal);
|
||||
state.SpewBox.Tick(0d);
|
||||
Assert.Equal(1, state.SpewBox.Count);
|
||||
|
||||
state.Dispose();
|
||||
|
||||
Assert.Equal(0, state.SpewBox.Count);
|
||||
}
|
||||
|
||||
private sealed class RecordingObserver : IRuntimeCommunicationObserver
|
||||
{
|
||||
public List<RuntimeCommunicationEvent> Events { get; } = [];
|
||||
|
|
|
|||
|
|
@ -153,6 +153,57 @@ public sealed class RuntimeLocalPlayerMovementStateTests
|
|||
Assert.NotEqual(first.Snapshot.Position, second.Snapshot.Position);
|
||||
}
|
||||
|
||||
// ── Campaign CH slice CH2: OnInterfaceText propagation ──────────────
|
||||
|
||||
[Fact]
|
||||
public void OnInterfaceText_SetBeforeControllerInstall_AppliesToTheInstalledController()
|
||||
{
|
||||
using var movement = new RuntimeLocalPlayerMovementState();
|
||||
var received = new List<(string Text, AcDream.Core.Chat.RetailLogTextType Type)>();
|
||||
movement.OnInterfaceText = (text, type) => received.Add((text, type));
|
||||
|
||||
var controller = new PlayerMovementController(new PhysicsEngine());
|
||||
movement.Controller = controller;
|
||||
|
||||
controller.OnInterfaceText!("test line", AcDream.Core.Chat.RetailLogTextType.ClientLocal);
|
||||
|
||||
Assert.Single(received);
|
||||
Assert.Equal("test line", received[0].Text);
|
||||
Assert.Equal(AcDream.Core.Chat.RetailLogTextType.ClientLocal, received[0].Type);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void OnInterfaceText_SetAfterControllerInstall_StillAppliesToTheCurrentController()
|
||||
{
|
||||
using var movement = new RuntimeLocalPlayerMovementState();
|
||||
var controller = new PlayerMovementController(new PhysicsEngine());
|
||||
movement.Controller = controller;
|
||||
|
||||
var received = new List<string>();
|
||||
movement.OnInterfaceText = (text, _) => received.Add(text);
|
||||
|
||||
controller.OnInterfaceText!("late-bound line", AcDream.Core.Chat.RetailLogTextType.ClientLocal);
|
||||
|
||||
Assert.Equal(["late-bound line"], received);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void OnInterfaceText_SwappingController_AppliesToTheReplacement()
|
||||
{
|
||||
using var movement = new RuntimeLocalPlayerMovementState();
|
||||
var received = new List<string>();
|
||||
movement.OnInterfaceText = (text, _) => received.Add(text);
|
||||
|
||||
var first = new PlayerMovementController(new PhysicsEngine());
|
||||
movement.Controller = first;
|
||||
var second = new PlayerMovementController(new PhysicsEngine());
|
||||
movement.Controller = second;
|
||||
|
||||
second.OnInterfaceText!("from replacement", AcDream.Core.Chat.RetailLogTextType.ClientLocal);
|
||||
|
||||
Assert.Equal(["from replacement"], received);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void MotionPreparationPublishesOnlyTheConstructionSeam()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -97,6 +97,63 @@ public sealed class LiveSessionEventRouterTests
|
|||
Assert.Equal(1, chat.Count);
|
||||
}
|
||||
|
||||
// ── Campaign CH slice CH2: 0xF7E0 ServerMessage routes through AddText ──
|
||||
|
||||
[Fact]
|
||||
public void ServerMessage_RoutesThroughAddText_WithWireChatTypeVerbatim_WhenWired()
|
||||
{
|
||||
using var session = NewSession();
|
||||
var chat = new ChatLog();
|
||||
var reported = new List<(string Text, RetailLogTextType Type)>();
|
||||
var social = new LiveSocialSessionBindings(
|
||||
chat,
|
||||
new TurbineChatState(),
|
||||
new FriendsState(),
|
||||
new SquelchState(),
|
||||
(text, type) => reported.Add((text, type)));
|
||||
var router = new LiveSessionEventRouter(
|
||||
session,
|
||||
new LiveEntitySessionSink(
|
||||
_ => { }, _ => { }, _ => { }, _ => { }, _ => { }, _ => { },
|
||||
_ => { }, _ => { }, _ => { }, _ => { }, _ => { }, _ => { },
|
||||
_ => { }),
|
||||
new LiveEnvironmentSessionSink(_ => { }, _ => { }),
|
||||
NewInventoryBindings(),
|
||||
NewCharacterBindings(),
|
||||
social);
|
||||
router.Attach();
|
||||
|
||||
// 0x1A carried verbatim -- retail's Handle_Communication__TextboxString
|
||||
// @0x0057D3A0 feeds the RAW wire chatType into AddTextToScroll.
|
||||
EventDelegate<Action<AcDream.Core.Net.Messages.ServerMessage.Parsed>>(
|
||||
session, nameof(session.ServerMessageReceived))(
|
||||
new AcDream.Core.Net.Messages.ServerMessage.Parsed("You are too encumbered to carry that!", 0x1Au));
|
||||
|
||||
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);
|
||||
|
||||
router.Dispose();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ServerMessage_FallsBackToChatDirectly_WhenNoRouterWired()
|
||||
{
|
||||
using var session = NewSession();
|
||||
var chat = new ChatLog();
|
||||
var router = NewRouter(session, new Counters(), chat: chat);
|
||||
|
||||
EventDelegate<Action<AcDream.Core.Net.Messages.ServerMessage.Parsed>>(
|
||||
session, nameof(session.ServerMessageReceived))(
|
||||
new AcDream.Core.Net.Messages.ServerMessage.Parsed("fallback path", 0x00u));
|
||||
|
||||
Assert.Equal(1, chat.Count);
|
||||
Assert.Equal("fallback path", chat.Snapshot()[0].Text);
|
||||
|
||||
router.Dispose();
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void NestedRouters_DisposeOlderFirstLeavesOnlyNewerRouter()
|
||||
{
|
||||
|
|
|
|||
|
|
@ -0,0 +1,79 @@
|
|||
using AcDream.Core.Chat;
|
||||
using AcDream.UI.Abstractions.Panels.SpewBox;
|
||||
|
||||
namespace AcDream.UI.Abstractions.Tests.Panels.SpewBox;
|
||||
|
||||
public sealed class SpewBoxVMTests
|
||||
{
|
||||
[Fact]
|
||||
public void Lines_NoContent_ReturnsEmpty()
|
||||
{
|
||||
var vm = new SpewBoxVM(new SpewBoxState());
|
||||
|
||||
Assert.Empty(vm.Lines(0d));
|
||||
Assert.False(vm.HasVisibleLines);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Lines_DrainsPendingAndReturnsRemainingLifetime()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
var vm = new SpewBoxVM(state);
|
||||
state.Enqueue("You can't jump while in the air");
|
||||
|
||||
IReadOnlyList<SpewBoxLine> lines = vm.Lines(nowSeconds: 10d);
|
||||
|
||||
SpewBoxLine line = Assert.Single(lines);
|
||||
Assert.Equal("You can't jump while in the air", line.Text);
|
||||
Assert.Equal(SpewBoxState.DefaultLifetime.TotalSeconds, line.RemainingLifetimeSeconds, precision: 3);
|
||||
Assert.True(vm.HasVisibleLines);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Lines_RemainingLifetime_CountsDownAndFloorsAtZero()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
var vm = new SpewBoxVM(state);
|
||||
state.Enqueue("fading");
|
||||
|
||||
vm.Lines(nowSeconds: 0d);
|
||||
double halfway = SpewBoxState.DefaultLifetime.TotalSeconds / 2;
|
||||
SpewBoxLine midLine = Assert.Single(vm.Lines(nowSeconds: halfway));
|
||||
Assert.Equal(halfway, midLine.RemainingLifetimeSeconds, precision: 3);
|
||||
|
||||
// Past expiry: the line is pruned by the same Lines() call that ticks it.
|
||||
Assert.Empty(vm.Lines(nowSeconds: SpewBoxState.DefaultLifetime.TotalSeconds + 1d));
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Lines_NewestFirst_MatchesRetailInsertAtZero()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
var vm = new SpewBoxVM(state);
|
||||
state.Enqueue("older");
|
||||
vm.Lines(0d);
|
||||
state.Enqueue("newer");
|
||||
|
||||
IReadOnlyList<SpewBoxLine> lines = vm.Lines(0d);
|
||||
|
||||
// MaxConcurrentItems == 1 means only the newest survives, which is
|
||||
// itself proof insertion happens at the front (retail's overflow
|
||||
// rule drops the OLDEST / highest index, not the newest).
|
||||
SpewBoxLine line = Assert.Single(lines);
|
||||
Assert.Equal("newer", line.Text);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void Revision_TracksUnderlyingState()
|
||||
{
|
||||
var state = new SpewBoxState();
|
||||
var vm = new SpewBoxVM(state);
|
||||
long initial = vm.Revision;
|
||||
|
||||
state.Enqueue("a line");
|
||||
vm.Lines(0d);
|
||||
|
||||
Assert.True(vm.Revision > initial);
|
||||
Assert.Equal(state.Revision, vm.Revision);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue