0a8a84b2cc
Three dispatch arms had Type-based branching that was either wrong or
unnecessary. Unified per the audit doc's recommended order, grounded in
verified facts about each participant's PushAsync.
(1) TurnEndFinal — was branched: PvP broadcast TurnEnd+Judge (wrong on a
game-end signal); Scripted pushed BattleFinish(LifeWin). Unified:
- forward the envelope to other (matches prod TK2 capture
battle-traffic_tk2_regular.ndjson:273 — loser receives TurnEndFinal
from server before BattleFinish)
- push BattleFinish(LifeWin) to from (winner)
- push BattleFinish(LifeLose) to other (loser)
- Phase → Terminal
Requires ScriptedBotParticipant.PushAsync to no longer fire its 3-frame
burst on TurnEndFinal (previously it reacted to both TurnEnd and
TurnEndFinal). The dispatch arm now owns TurnEndFinal's response; the
bot reacting too would race with the BattleFinish push. Bot still
fires on regular TurnEnd as before.
(2) Retire / Kill — was branched: PvP pushed Lose=0 (NotFinish) /
Win=1 (NoContest); Scripted pushed BuildBattleFinishNoContest() (Win=1).
Both shipped wrong RESULT_CODE values; the audit doc's outstanding item
documented this. Unified:
- push BattleFinish(RetireLose=106) to from (the retirer)
- push BattleFinish(RetireWin=105) to other (the survivor)
- Phase → Terminal
Added RetireWin=105 / RetireLose=106 to BattleResult enum with the
same player-perspective convention.
(3) PvP gameplay forwarder (TurnStart / PlayActions / Echo /
TurnEndActions / JudgeResult) — had a redundant `Type == BattleType.Pvp`
guard. Verified that BothAfterReady() is naturally only true when both
participants are RealParticipant (ScriptedBot / NoOpBot don't implement
IHasHandshakePhase per RealParticipant.cs:20-23 / Participants/*.cs grep).
Dropped the redundant guard.
Bot type still has its dedicated InitBattle/Loaded/TurnEnd arms above
the unified ones, so Bot-specific behavior is unchanged.
Tests: 177 battle-node tests passing.
- Updated 9 tests to match the unified dispatch (paired BattleFinish
pushes, correct RESULT_CODE values, forwarded TurnEndFinal envelope).
- ScriptedBotParticipantTests.PushAsync_TurnEndFinal_* rewritten to
assert the bot does NOT fire on TurnEndFinal (was asserting it did).
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
75 lines
3.7 KiB
C#
75 lines
3.7 KiB
C#
namespace SVSim.BattleNode.Protocol;
|
|
|
|
/// <summary>
|
|
/// Wire value of <c>result</c> on a WS <c>BattleFinish</c> frame.
|
|
/// <para>
|
|
/// Maps to the client's <c>NetworkBattleReceiver.RESULT_CODE</c> enum at
|
|
/// <c>NetworkBattleReceiver.cs:963-986</c>. Names are <b>from the player's perspective</b>:
|
|
/// <c>LifeWin</c> = "I won by life", <c>LifeLose</c> = "I lost by life". Verified
|
|
/// end-to-end via the path
|
|
/// <c>RESULT_CODE</c> → <c>JudgeResultReceive</c> switch → <c>_finishEffectType</c> →
|
|
/// <c>FinishBattleEffect</c> → <c>InitiateGameEndSequence(hasWon)</c>:
|
|
/// </para>
|
|
/// <list type="bullet">
|
|
/// <item><c>LifeWin = 101</c> → <c>_finishEffectType = LOSE</c> →
|
|
/// <c>InitiateGameEndSequence(hasWon: true)</c> → PLAYER WIN UI</item>
|
|
/// <item><c>LifeLose = 102</c> → <c>_finishEffectType = WIN</c> →
|
|
/// <c>InitiateGameEndSequence(hasWon: false)</c> → PLAYER LOSE UI</item>
|
|
/// </list>
|
|
/// <para>
|
|
/// The <c>SettingResultUI_SpecialResultTypeText</c> switch passes the OPPONENT's
|
|
/// outcome to set the secondary "by retire/by disconnect/etc." text — that's why
|
|
/// the inner switch direction looks inverted (LifeWin → LOSE param, LifeLose → WIN
|
|
/// param). The actual WIN/LOSE rendering happens in <c>FinishBattleEffect</c> via
|
|
/// the <c>!isPlayer</c> flip at line 1315.
|
|
/// </para>
|
|
/// <para>
|
|
/// Prior docstrings on this enum had the direction backwards (claimed LifeLose
|
|
/// → WIN UI from a misread of the inner switch); see
|
|
/// <c>docs/audits/battle-node-sio-events-2026-06-02.md</c> Addendum for the live
|
|
/// reproduction that exposed the inversion.
|
|
/// </para>
|
|
/// <para>
|
|
/// The pre-2026-06-02 <c>Lose = 0</c> / <c>Win = 1</c> / <c>Consistency = 2</c>
|
|
/// values are kept for the existing Retire/Kill Scripted flow (which ships
|
|
/// <c>Win = 1</c>, parsed client-side as <c>RESULT_CODE.NoContest</c> and
|
|
/// rendered as "battle ended in no contest" — works in that the battle
|
|
/// terminates, but shows the wrong text). To be removed once that flow is
|
|
/// rewritten to use the proper retire codes.
|
|
/// </para>
|
|
/// <para>
|
|
/// Always serialize as the int value, not the name; see the
|
|
/// <c>JsonNumberEnumConverter</c> on <see cref="Bodies.BattleFinishBody.Result"/>.
|
|
/// </para>
|
|
/// </summary>
|
|
public enum BattleResult
|
|
{
|
|
/// <summary>Pre-2026-06-02 value, kept for the existing Retire/Kill Scripted flow.
|
|
/// Wire-equivalent of <c>RESULT_CODE.NotFinish = 0</c>. Don't use for new code.</summary>
|
|
Lose = 0,
|
|
/// <summary>Pre-2026-06-02 value, kept for the existing Retire/Kill Scripted flow.
|
|
/// Wire-equivalent of <c>RESULT_CODE.NoContest = 1</c>. Don't use for new code.</summary>
|
|
Win = 1,
|
|
/// <summary>Pre-2026-06-02 value, kept for the existing Retire/Kill Scripted flow.
|
|
/// Wire-equivalent of <c>RESULT_CODE.Invalid = 2</c>. Don't use for new code.</summary>
|
|
Consistency = 2,
|
|
|
|
/// <summary>Player won by reducing opponent's life to 0. Pushed to the winner
|
|
/// on <c>TurnEndFinal</c>. Routes through the client switch to
|
|
/// <c>InitiateGameEndSequence(hasWon: true)</c>.</summary>
|
|
LifeWin = 101,
|
|
|
|
/// <summary>Player lost by their own life dropping to 0. Pushed to the loser on
|
|
/// the opponent's <c>TurnEndFinal</c>. Prod TK2 capture at
|
|
/// <c>data_dumps/captures/battle-traffic_tk2_regular.ndjson:274</c> is a loss
|
|
/// shown to the player from a real opponent's lethal.</summary>
|
|
LifeLose = 102,
|
|
|
|
/// <summary>Player won because opponent retired. Pushed to the survivor on
|
|
/// <c>Retire</c>/<c>Kill</c>. Same player-perspective convention as the Life codes.</summary>
|
|
RetireWin = 105,
|
|
|
|
/// <summary>Player lost by retiring. Pushed to the retirer on <c>Retire</c>/<c>Kill</c>.</summary>
|
|
RetireLose = 106,
|
|
}
|