feat(chat): Campaign CH slice CH1 — retail LogTextType color table

Retail colors chat lines by the 34-value wire LogTextType (ACE's
ChatMessageType), NOT by acdream's synthetic 9-value ChatKind. The old
ChatWindowController.RetailChatColor(ChatKind) collapsed distinct retail
colors onto one bucket per ChatKind — e.g. every Channel line rendered
colorLightBlue (Magic's slot) when retail's actual palette spans five
different colors across the Turbine rooms and legacy allegiance family.

Ports ChatInterface::BuildChatColorLookupTable @0x004F31C0 verbatim
(RetailChatColorTable, all 34 RGBA floats read from the PDB-paired
binary's .data section) and threads a new ChatEntry.LogTextType field
through every ingestion site to the correct retail wire value:
HearSpeech/Tell pass the wire chatType through verbatim; Emote/SoulEmote
hard-code 0x0C; the Tell self-echo hard-codes 0x04; legacy ChatChannel
broadcasts derive their type from the channel bit via the new
LegacyChannelChatType helper (ported from the decompiled
Handle_Communication__ChannelBroadcast dispatch, hear vs. own-send);
TurbineChat rooms map through TurbineChatDisplayNames.LogTextType;
CombatChatTranslator's hit/miss/evade lines map to ACE's CombatSelf/
CombatEnemy per Player_Combat.cs; kill/death lines use retail's
decompiled 0x00 Default (not a combat color). ChatWindowController's
transcript now folds LogTextType through RetailChatColorTable with
retail's exact "out-of-range keeps the previous line's color" carry
rule; ChatPanel's combat highlighting sources the same table.

Corrects HearSpeech.cs's doc-comment ChatType legend (4 of 6 entries
were wrong). Adds register row AP-175 for the pre-existing (unchanged)
Popup-renders-in-chat divergence and updates AP-39's stale per-ChatKind
description. Narrows ISSUES #139 — its chat-colors half is done.

Retail renders no chat timestamp prefix path exists in acdream today,
so the "timestamp is always colorGrey 0x0C" rule has nothing to attach
to; noted here per the research doc rather than left silent.

Research: docs/research/2026-08-09-chat-retail-color-table.md
Full Release suite: 11,833 passed / 4 skipped / 0 failed.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
Erik 2026-08-09 15:23:31 +02:00
parent 8df35d1e18
commit 172c6f9aa3
26 changed files with 1360 additions and 85 deletions

View file

@ -93,7 +93,15 @@ public sealed class ChatLog
/// Port from holtburger
/// <c>references/holtburger/.../client/messages.rs</c> lines 476-487.
/// </remarks>
public void OnLocalSpeech(string sender, string text, uint senderGuid, bool isRanged)
/// <param name="logTextType">
/// The wire <c>chatType</c> carried by HearSpeech/HearRangedSpeech
/// (<c>speech.ChatType</c>) — passed through VERBATIM, with zero
/// remapping, matching retail's <c>Handle_Communication__HearSpeech
/// @0x005712A0</c> (the raw <c>arg5</c> feeds <c>AddTextToScroll</c>
/// directly). Defaults to <c>0x02</c> (Speech) for callers that
/// don't have a wire value in hand.
/// </param>
public void OnLocalSpeech(string sender, string text, uint senderGuid, bool isRanged, uint logTextType = 0x02u)
{
// Phase J: ACE's HandleActionTalk broadcasts a HearSpeech echo
// back to the sender too. Detect own echo by guid match and
@ -107,7 +115,10 @@ public sealed class ChatLog
Sender: effectiveSender,
Text: text,
SenderGuid: senderGuid,
ChannelId: 0));
ChannelId: 0)
{
LogTextType = logTextType,
});
}
/// <summary>EmoteText (0x01E0) — server-driven third-person emote.</summary>
@ -118,7 +129,13 @@ public sealed class ChatLog
Sender: senderName,
Text: text,
SenderGuid: senderGuid,
ChannelId: 0));
ChannelId: 0)
{
// Retail hard-codes Emote (0x0C) for every HearEmote line —
// ClientCommunicationSystem::HearEmote @0x0057CBE0, the
// literal constant at 0x0057CF94. Not a wire value.
LogTextType = 0x0Cu,
});
}
/// <summary>SoulEmote (0x01E2) — complex emote (chat + paired animation).</summary>
@ -129,7 +146,12 @@ public sealed class ChatLog
Sender: senderName,
Text: text,
SenderGuid: senderGuid,
ChannelId: 0));
ChannelId: 0)
{
// HearSoulEmote tail-calls HearEmote @0x0057D096 — same
// hard-coded 0x0C.
LogTextType = 0x0Cu,
});
}
/// <summary>PlayerKilled (0x019E) — death announcement.</summary>
@ -147,7 +169,18 @@ public sealed class ChatLog
Sender: "",
Text: deathMessage,
SenderGuid: victimGuid,
ChannelId: killerGuid));
ChannelId: killerGuid)
{
// Inferred by analogy from the sibling GameEvents this opcode
// shares a dispatch pattern with: VictimNotification (0x01AC)
// and KillerNotification (0x01AD) both route through the SAME
// retail handler, ClientCombatSystem::HandleKillerNotification
// Event @0x0056C410 (cases 0xa/0xb of the combat-envelope
// switch, pc:359548-359559), which calls
// AddTextToScroll(..., 0, 1, 0) — type 0x00 Default. No direct
// decomp citation was traced for 0x019E PlayerKilled itself.
LogTextType = 0x00u,
});
}
/// <summary>WeenieError (0x028A) / WeenieErrorWithString (0x028B).</summary>
@ -178,7 +211,15 @@ public sealed class ChatLog
Sender: "",
Text: text,
SenderGuid: 0,
ChannelId: errorId));
ChannelId: errorId)
{
// Retail's HandleFailureEvent @0x00571990 dispatches per ERROR
// CODE across an ~87-case switch, mostly AddTextToScroll(...,
// 0, ...) with a scattered handful at 0x1a (client-local red).
// A full per-code port is future work; 0x00 (Default) matches
// the switch's majority behavior and is the safe baseline.
LogTextType = 0x00u,
});
}
/// <summary>
@ -190,7 +231,21 @@ public sealed class ChatLog
/// <c>ChatVM</c> formatter renders entries as
/// <c>"[ChannelName] Sender says, \"text\""</c> when set.
/// </summary>
public void OnChannelBroadcast(uint channelId, string sender, string text, string channelName = "")
/// <param name="logTextType">
/// The retail <c>LogTextType</c> for this line. When
/// <see langword="null"/> (the legacy 0x0147 default), it is derived
/// from <paramref name="channelId"/> via
/// <see cref="LegacyChannelChatType.Resolve"/> as a HEARD (not
/// own-send) message — correct for this method's only production
/// caller, the inbound <c>ChannelBroadcast</c> GameEvent handler.
/// TurbineChat-sourced calls MUST pass an explicit value computed
/// from the room's <c>TurbineChat.ChatType</c> instead — the wire
/// <paramref name="channelId"/> there is an opaque per-session room
/// GUID, not a legacy channel bitflag, and the two id spaces must
/// never be conflated.
/// </param>
public void OnChannelBroadcast(
uint channelId, string sender, string text, uint? logTextType = null, string channelName = "")
{
Append(new ChatEntry(
Kind: ChatKind.Channel,
@ -200,18 +255,28 @@ public sealed class ChatLog
ChannelId: channelId)
{
ChannelName = channelName,
LogTextType = logTextType ?? LegacyChannelChatType.Resolve(channelId, ownSend: false),
});
}
/// <summary>GameEvent Tell (0x02BD) — whisper received.</summary>
public void OnTellReceived(string sender, string text, uint senderGuid)
/// <param name="logTextType">
/// The wire <c>chatType</c> from the Tell GameEvent payload
/// (<c>GameEvents.Tell.ChatType</c>) — retail's normal value is
/// <c>0x03</c> (Tell), which is also this parameter's default for
/// callers without a wire value in hand.
/// </param>
public void OnTellReceived(string sender, string text, uint senderGuid, uint logTextType = 0x03u)
{
Append(new ChatEntry(
Kind: ChatKind.Tell,
Sender: sender,
Text: text,
SenderGuid: senderGuid,
ChannelId: 0));
ChannelId: 0)
{
LogTextType = logTextType,
});
}
/// <summary>
@ -241,10 +306,28 @@ public sealed class ChatLog
Sender: "",
Text: text,
SenderGuid: 0,
ChannelId: chatType));
ChannelId: chatType)
{
// `chatType` IS the retail LogTextType here — every caller
// (ServerMessage.ChatType, GameEventWiring's transient/
// query-age/use-done sites, App's client-command echoes)
// already passes the wire/retail-correct value.
LogTextType = chatType,
});
}
/// <summary>GameEvent PopupString (0x0004) — modal dialog text.</summary>
/// <summary>
/// GameEvent PopupString (0x0004) — modal dialog text.
/// </summary>
/// <remarks>
/// Retail shows PopUpString as a MODAL DIALOG
/// (<c>Handle_Communication__PopUpString @0x0057FE80</c>), never as a
/// chat-log line — acdream's choice to render it in chat at all is a
/// registered divergence (register row AP-175). Fixed at LogTextType
/// <c>0x00</c> (Default/green) to preserve the color this entry has
/// always rendered with; retail has no chat color for this type since
/// it never reaches the chat log.
/// </remarks>
public void OnPopup(string text)
{
Append(new ChatEntry(
@ -252,7 +335,10 @@ public sealed class ChatLog
Sender: "",
Text: text,
SenderGuid: 0,
ChannelId: 0));
ChannelId: 0)
{
LogTextType = 0x00u,
});
}
/// <summary>
@ -266,7 +352,19 @@ public sealed class ChatLog
/// <c>warning().combat()</c> / <c>error().combat()</c> tag flow at
/// <c>chat.rs:221-308</c>.
/// </summary>
public void OnCombatLine(string text, Combat.CombatLineKind kind = Combat.CombatLineKind.Info)
/// <param name="logTextType">
/// The retail <c>LogTextType</c> for this combat line. Callers should
/// pass one of the ACE-cited combat types (<c>0x16</c> Combat_Self for
/// lines about the local player's OWN offensive action, <c>0x15</c>
/// Combat_Enemy for lines about an enemy's action against the local
/// player — see <see cref="CombatChatTranslator"/>) or <c>0x00</c>
/// Default for retail's decompiled kill/death-notification color
/// (<c>HandleKillerNotificationEvent @0x0056C410</c>). Defaults to
/// <c>0x06</c> (the generic Combat slot) for callers with no more
/// specific classification in hand.
/// </param>
public void OnCombatLine(
string text, Combat.CombatLineKind kind = Combat.CombatLineKind.Info, uint logTextType = 0x06u)
{
Append(new ChatEntry(
Kind: ChatKind.Combat,
@ -276,6 +374,7 @@ public sealed class ChatLog
ChannelId: 0)
{
CombatKind = kind,
LogTextType = logTextType,
});
}
@ -300,7 +399,18 @@ public sealed class ChatLog
/// discriminator the formatter uses to render outgoing-vs-incoming
/// (a real incoming Tell carries the sender's player guid).
/// </remarks>
public void OnSelfSent(ChatKind kind, string text, string targetOrChannel = "")
/// <param name="logTextType">
/// The retail <c>LogTextType</c> for this self-sent line. When
/// <see langword="null"/>, defaults to <c>0x04</c> Speech_Direct_Send
/// for Tell (retail's own-echo "You tell ..." type — cross-check
/// ACE's <c>ChatMessageType.OutgoingTell</c> comment "You tell ...") or
/// <c>0x0B</c> Social_Send for Channel (the simplified own-send default
/// research doc §3.3 records; the LiveSessionCommandRouter production
/// caller overrides this with the precise per-channel-bit value from
/// <see cref="LegacyChannelChatType.Resolve"/> instead of relying on
/// this fallback).
/// </param>
public void OnSelfSent(ChatKind kind, string text, string targetOrChannel = "", uint? logTextType = null)
{
Append(new ChatEntry(
Kind: kind,
@ -315,6 +425,7 @@ public sealed class ChatLog
ChannelId: 0)
{
ChannelName = kind == ChatKind.Channel ? targetOrChannel : "",
LogTextType = logTextType ?? (kind == ChatKind.Tell ? 0x04u : 0x0Bu),
});
}
@ -378,4 +489,17 @@ public readonly record struct ChatEntry(
/// Falls back to <c>"ch {ChannelId}"</c> if not populated.
/// </summary>
public string ChannelName { get; init; } = "";
/// <summary>
/// Campaign CH slice CH1: the retail wire <c>LogTextType</c>
/// (<c>0x00</c>-<c>0x21</c>) that keys
/// <c>RetailChatColorTable</c>/<c>ChatInterface::BuildChatColorLookupTable
/// @0x004F31C0</c>. This is the FULL 34-value retail index space, NOT
/// <see cref="Kind"/> — retail colors by this integer, never by our
/// synthetic 9-value <see cref="ChatKind"/>. Populated by every
/// <c>OnXxx</c> ingestion method above; defaults to <c>0x00</c>
/// (Default/green, retail's own unfilled-slot default) for any entry
/// constructed without setting it explicitly.
/// </summary>
public uint LogTextType { get; init; } = 0x00u;
}

View file

@ -115,7 +115,11 @@ public sealed class CombatChatTranslator : IDisposable
// grows that field, append " Critical hit." here.
"",
FormatAttackConditionsSuffix(0));
_chat.OnCombatLine(line, CombatLineKind.Info);
// Combat_Self (0x16): retail squelch-checks the attacker's OWN
// outgoing-hit notification against ChatMessageType.CombatSelf —
// references/ACE/Source/ACE.Server/WorldObjects/Player_Combat.cs:162-163
// (GameEventAttackerNotification, "You hit X...").
_chat.OnCombatLine(line, CombatLineKind.Info, logTextType: 0x16u);
}
private void HandleDamageTaken(CombatState.DamageIncoming e)
@ -138,21 +142,33 @@ public sealed class CombatChatTranslator : IDisposable
sb.Append('.');
if (e.Critical) sb.Append(" Critical hit.");
sb.Append(FormatAttackConditionsSuffix(0));
_chat.OnCombatLine(sb.ToString(), CombatLineKind.Warning);
// Combat_Enemy (0x15): retail squelch-checks the defender's
// incoming-hit notification against ChatMessageType.CombatEnemy —
// references/ACE/Source/ACE.Server/WorldObjects/Player_Combat.cs:541
// (GameEventDefenderNotification, "X hit you...").
_chat.OnCombatLine(sb.ToString(), CombatLineKind.Warning, logTextType: 0x15u);
}
private void HandleMissedOutgoing(string defenderName)
{
// chat.rs:286-291 — EvasionAttackerNotification:
// "{} evaded your attack."
_chat.OnCombatLine($"{defenderName} evaded your attack.", CombatLineKind.Info);
// Combat_Self (0x16): this is about the LOCAL PLAYER'S OWN attack
// missing — retail squelch-checks GameEventEvasionAttackerNotification
// against CombatSelf, same family as the hit-dealt line above —
// references/ACE/Source/ACE.Server/WorldObjects/Player_Combat.cs:150.
_chat.OnCombatLine($"{defenderName} evaded your attack.", CombatLineKind.Info, logTextType: 0x16u);
}
private void HandleEvadedIncoming(string attackerName)
{
// chat.rs:292-297 — EvasionDefenderNotification:
// "You evaded {}'s attack."
_chat.OnCombatLine($"You evaded {attackerName}'s attack.", CombatLineKind.Info);
// Combat_Enemy (0x15): this is about an ENEMY'S attack (that the
// local player evaded) — retail squelch-checks
// GameEventEvasionDefenderNotification against CombatEnemy —
// references/ACE/Source/ACE.Server/WorldObjects/Player_Combat.cs:345.
_chat.OnCombatLine($"You evaded {attackerName}'s attack.", CombatLineKind.Info, logTextType: 0x15u);
}
private void HandleKillLanded(string victimName, uint victimGuid)
@ -164,7 +180,12 @@ public sealed class CombatChatTranslator : IDisposable
// synthesize a minimal "You killed Foo." line here. The
// detailed sentence (used by retail) arrives separately via
// ChatLog.OnPlayerKilled and is rendered as ChatKind.System.
_chat.OnCombatLine($"You killed {victimName}.", CombatLineKind.Info);
// LogTextType 0x00 Default: retail's own kill/death notification
// handler (VictimNotification 0x01AC + KillerNotification 0x01AD,
// both via ClientCombatSystem::HandleKillerNotificationEvent
// @0x0056C410) calls AddTextToScroll(..., 0, 1, 0) — see
// ChatLog.OnPlayerKilled's identical citation.
_chat.OnCombatLine($"You killed {victimName}.", CombatLineKind.Info, logTextType: 0x00u);
}
// ── Formatters (ported VERBATIM from chat.rs:561-595) ───────────────────

View file

@ -0,0 +1,77 @@
namespace AcDream.Core.Chat;
/// <summary>
/// Maps a legacy <c>ChatChannel (0x0147)</c> bitflag id to retail's wire
/// <c>LogTextType</c> for the chat color table.
///
/// <para>
/// Faithful port of <c>ClientCommunicationSystem::Handle_Communication__
/// ChannelBroadcast @0x00570B90</c> (Sept 2013 EoR build). Retail branches
/// on the channel bit AND on whether the sender-name buffer is the
/// single-char "self" sentinel (<c>m_buffer-&gt;m_len == 1</c>) — i.e.
/// whether this is the local player's OWN outgoing message
/// ("You say to your patron, ...") vs. hearing someone else
/// ("Your patron X tells you, ..."). <see cref="Resolve"/>'s
/// <paramref name="ownSend"/> models that same branch.
/// </para>
///
/// <para>
/// Per-bit findings from the decompiled dispatch (not all bits behave
/// the same for own-send — only Patron/Vassal/Follower get a distinct
/// send-color; Fellowship, Co-Vassals, Allegiance Broadcast, and the
/// generic/admin catch-all use the SAME type for hear and send):
/// </para>
/// </summary>
public static class LegacyChannelChatType
{
/// <summary>
/// Resolve <paramref name="channelBit"/> (the <c>ChannelBroadcast</c>
/// wire channel id, a single flag bit) to a <c>LogTextType</c>.
/// </summary>
/// <param name="channelBit">The wire channel id / bitflag.</param>
/// <param name="ownSend">
/// <see langword="true"/> when this is the local player's own outgoing
/// message (retail's <c>m_buffer-&gt;m_len == 1</c> self-sentinel
/// branch); <see langword="false"/> when hearing another sender.
/// </param>
public static uint Resolve(uint channelBit, bool ownSend) => channelBit switch
{
// Fellowship: same type ("[Fellowship] ...") for hear and send.
// pc:00570e48 (hear, m_buffer_5=0x13) / pc:00570d08 (send, 0x13).
0x0800u => 0x13u,
// Patron / Vassal / Follower(Monarch): hear = Social (0xA,
// "Your patron/vassal/follower X tells you..."); OWN send =
// Social_Send (0xB, "You say to your patron/vassal/follower...").
// pc:00570e50/00570e58 (Patron/Vassal hear, 0xa) + pc:00570e40
// (Follower hear, 0xa); pc:00570c07/00570c21 (all three own-send
// via the shared label_570c21, 0xb).
0x1000u => ownSend ? 0x0Bu : 0x0Au, // Patron
0x2000u => ownSend ? 0x0Bu : 0x0Au, // Vassal
0x4000u => ownSend ? 0x0Bu : 0x0Au, // Follower / Monarch
// Co-Vassals / Allegiance Broadcast: same type for hear and send.
// pc:00571025/00571014 (hear, 0xa) / pc:00570e17/00570df7 (send, 0xa).
0x1000000u => 0x0Au, // Co-Vassals
0x2000000u => 0x0Au, // Allegiance Broadcast
// Unnamed bit — no producer traced, but retail's own dispatch
// assigns it 0x13 (Fellowship's slot) for both hear and send.
// pc:00570d43 (send, 0x13); the hear branch mirrors it via the
// same ebp==0x4000000 special case one level up in the dispatch.
0x4000000u => 0x13u,
// The single named non-family bit inside the generic catch-all:
// 0x400 gets its OWN color (Help, 0xF) where every other
// unmatched bit gets the catch-all (Abuse, 0xE). Both branches
// (hear label_570f0a and send label_570d4f) test `ebp != 0x400`
// with the identical 0xe/0xf split.
0x0400u => 0x0Fu,
// Generic/admin/audit/sentinel catch-all: retail's
// "<Tell> says on the X channel" / "You say on the X channel"
// template, color 0xE (Abuse). pc:00570f1d (hear) / pc:00570d62
// (send) — both compute the same constant 0xe.
_ => 0x0Eu,
};
}