IPVGO: Add new analysis method to set a custom testing board state (#2029)

src/Go/Types.ts

@@ -54,6 +54,7 @@ export type BoardState = {
   passCount: number;
   cheatCount: number;
   cheatCountForWhite: number;
+  komiOverride: number | null;
 };
 
 export type PointState = {

src/Go/boardAnalysis/goAI.ts

@@ -860,8 +860,11 @@ function getMoveOptions(boardState: BoardState, player: GoColor, rng: number, sm
 /**
  * Gets the starting score for white.
  */
-export function getKomi(opponent: GoOpponent) {
-  return opponentDetails[opponent].komi;
+export function getKomi(state: BoardState): number {
+  if (state.komiOverride !== null) {
+    return state.komiOverride;
+  }
+  return opponentDetails[state.ai].komi;
 }
 
 /**

src/Go/boardAnalysis/scoring.ts

@@ -17,7 +17,7 @@ import { Go, GoEvents } from "../Go";
  *  fully surrounded by their pieces
  */
 export function getScore(boardState: BoardState) {
-  const komi = getKomi(boardState.ai) ?? 6.5;
+  const komi = getKomi(boardState) ?? 6.5;
   const whitePieces = getColoredPieceCount(boardState, GoColor.white);
   const blackPieces = getColoredPieceCount(boardState, GoColor.black);
   const territoryScores = getTerritoryScores(boardState.board);

src/Go/boardState/boardState.ts

@@ -35,6 +35,7 @@ export function getNewBoardState(
     passCount: 0,
     cheatCount: 0,
     cheatCountForWhite: 0,
+    komiOverride: null,
     board: Array.from({ length: boardSize }, (_, x) =>
       Array.from({ length: boardSize }, (_, y) =>
         !boardToCopy || boardToCopy?.[x]?.[y]

src/Go/effects/netscriptGoImplementation.ts

@@ -2,7 +2,7 @@ import { Board, BoardState, OpponentStats, Play, SimpleBoard, SimpleOpponentStat
 
 import { Player } from "@player";
 import { AugmentationName, GoColor, GoOpponent, GoPlayType, GoValidity } from "@enums";
-import { Go } from "../Go";
+import { Go, GoEvents } from "../Go";
 import {
   getNewBoardState,
   getNewBoardStateFromSimpleBoard,
@@ -263,6 +263,20 @@ export function getControlledEmptyNodes(_board?: Board) {
   );
 }
 
+export function setTestingBoardState(board: Board, komi?: number) {
+  resetBoardState(
+    () => {},
+    () => {},
+    GoOpponent.none,
+    board.length,
+  );
+  Go.currentGame.board = board;
+  if (komi != undefined) {
+    Go.currentGame.komiOverride = komi;
+  }
+  GoEvents.emit();
+}
+
 /**
  * Returns all previous board states as SimpleBoards
  */

src/Netscript/RamCostGenerator.ts

@@ -271,6 +271,7 @@ const go = {
     getControlledEmptyNodes: 16,
     getStats: 0,
     resetStats: 0,
+    setTestingBoardState: 4,
   },
   cheat: {
     getCheatSuccessChance: 1,

src/NetscriptFunctions/Go.ts

@@ -25,6 +25,7 @@ import {
   makePlayerMove,
   resetBoardState,
   resetStats,
+  setTestingBoardState,
   validateBoardState,
   validateMove,
 } from "../Go/effects/netscriptGoImplementation";
@@ -104,6 +105,15 @@ export function NetscriptGo(): InternalAPI<NSGo> {
         (resetAll = false) => {
           resetStats(!!resetAll);
         },
+      setTestingBoardState: (ctx) => (_boardState, _komi) => {
+        const State = validateBoardState(error(ctx), _boardState);
+        if (!State) {
+          error(ctx)("Invalid board state passed to setTestingBoardState()");
+          return;
+        }
+        const komi: number | undefined = _komi !== undefined ? helpers.number(ctx, "komi", _komi) : undefined;
+        return setTestingBoardState(State.board, komi);
+      },
     },
     cheat: {
       getCheatSuccessChance: (ctx: NetscriptContext) => (_cheatCount, playAsWhite) => {

src/ScriptEditor/NetscriptDefinitions.d.ts

@@ -4495,6 +4495,18 @@ export interface GoAnalysis {
    * @param resetAll if true, reset win/loss records for all opponents. Leaves node power and bonuses unchanged.
    */
   resetStats(resetAll = false): void;
+
+  /**
+   * Starts a new game against the "No AI" opponent, and sets the initial board size, pieces, and offline nodes to the given board state.
+   * "X" represent black pieces, "O" white, and "." empty points. "#" are dead nodes that are not part of the subnet.
+   *
+   * @remarks
+   * RAM cost: 4 GB
+   *
+   * @param boardState - The initial board state to use for the new game, in the format used by getBoardState().
+   * @param komi - Optional komi value to set for the game. Defaults to 5.5.
+   */
+  setTestingBoardState(boardState: string[], komi?: number): void;
 }
 
 /**