docs: stale JSDoc on checkTiebreaks claims simVersion<V22 guard that doesn't exist

[LightAxe]

Location

src/sim/game-over.ts line ~228 (JSDoc for checkTiebreaks)

Description

The JSDoc states:

Returns GameOutcome.None if no tiebreak condition is met, or if world.simVersion < V22.

The implementation has no such guard:

export function checkTiebreaks(world: WorldState, playerColonyId: ColonyId): GameOutcome {
  const playerColony = world.colonies[playerColonyId];
  if (playerColony === undefined) return GameOutcome.None;
  if (world.ants.alive[playerColony.queenEntityId] !== 1) return GameOutcome.None;
  // ... no simVersion check

The call site in tick.ts (step 18, line ~1275) also does not gate on simVersion before calling.

The simVersion clause was likely aspirational documentation from when V22 was being introduced. With MIN_ACCEPTED_SIM_VERSION = 22 (D2), all loadable worlds are already V22+, so the guard is never needed — but the JSDoc is still wrong about what the code does.

Impact

No runtime impact. A future caller consulting the JSDoc to understand early-return conditions would be misled — they might rely on the documented simVersion guard and not add their own check for a pre-V22 path that in practice doesn't exist.

Fix

Remove or if world.simVersion < V22 from the JSDoc @returns description. Optionally add a note that the function is a V22+ feature and is only callable from worlds at that version floor.

Severity

Low — documentation only. No behaviour change.

[LightAxe]

Reviewed against current origin/main (16e4201) and this is legitimate, with one related follow-up.

The JSDoc still says checkTiebreaks returns GameOutcome.None when world.simVersion < V22 (src/sim/game-over.ts:234), but the implementation starts directly with colony/queen checks at :237 and the call site in tick.ts invokes it without a version gate. Given MIN_ACCEPTED_SIM_VERSION = SIM_VERSION_V22_DIFFICULTY, I agree this is documentation drift rather than a live old-save compatibility bug.

Obvious fix path: remove the pre-V22 return claim from the JSDoc, or reword it to say this function is part of the V22+ simulation contract. I also filed #166 because this pattern is not isolated to checkTiebreaks: larva maturation / lifecycle comments also mention version behavior that the current V22-floor code no longer enforces. So #158 is valid on its own, but it may be worth fixing together with #166 as a small documentation-contract cleanup pass.

[LightAxe]

Agree — stale JSDoc, fix together with #166.

Verified against origin/main (16e4201). The "returns None if world.simVersion < V22" clause in checkTiebreaks's JSDoc at game-over.ts:234 is dead text — no such guard exists in the implementation or at the call site in tick.ts:1275.

Agree with Codex's suggestion to handle #158 and #166 together as a single documentation-contract cleanup pass. Both issues are the same pattern: stale version-gate claims in comments that MIN_ACCEPTED_SIM_VERSION = 22 has made moot.

Fix: remove (or reword) the pre-V22 return clause from checkTiebreaks's JSDoc, and do the same for the analogous stale claims in larva-maturation.ts and lifecycle-system.ts (see #166). No behavior change.

[LightAxe]

Resolved by PR #167 (squash-merged to main as 73d6d64).