IPvGO: Fix API documentation (#1171)

Proper fix for table pre layout
This commit is contained in:
catloversg 2024-03-22 04:39:37 +07:00 committed by GitHub
parent 35a34470a2
commit 99f7a4cc7b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 11 deletions

@ -8,7 +8,7 @@ Retrieves a simplified version of the board state. "X" represents black pieces,
For example, a 5x5 board might look like this:
<pre lang="javascript"> \[ "XX.O.", "X..OO", ".XO..", "XXO.\#", ".XO.\#", \] </pre>
\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]
Each string represents a vertical column on the board, and each character in the string represents a point.

@ -23,7 +23,7 @@ export interface Go
| Method | Description |
| --- | --- |
| [getBoardState()](./bitburner.go.getboardstate.md) | <p>Retrieves a simplified version of the board state. "X" represents black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. (They are not territory nor open nodes.)</p><p>For example, a 5x5 board might look like this:</p><p><pre lang="javascript"> \[ "XX.O.", "X..OO", ".XO..", "XXO.\#", ".XO.\#", \] </pre></p><p>Each string represents a vertical column on the board, and each character in the string represents a point.</p><p>Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].</p><p>Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.</p> |
| [getBoardState()](./bitburner.go.getboardstate.md) | <p>Retrieves a simplified version of the board state. "X" represents black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. (They are not territory nor open nodes.)</p><p>For example, a 5x5 board might look like this:</p><p>\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]</p><p>Each string represents a vertical column on the board, and each character in the string represents a point.</p><p>Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].</p><p>Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.</p> |
| [getCurrentPlayer()](./bitburner.go.getcurrentplayer.md) | Returns the color of the current player, or 'None' if the game is over. |
| [getGameState()](./bitburner.go.getgamestate.md) | Gets the status of the current game. Shows the current player, current score, and the previous move coordinates. Previous move coordinates will be \[-1, -1\] for a pass, or if there are no prior moves. |
| [getOpponent()](./bitburner.go.getopponent.md) | Returns the name of the opponent faction in the current subnet. |

@ -3993,15 +3993,13 @@ export interface Go {
*
* For example, a 5x5 board might look like this:
*
* <pre lang="javascript">
* [
* "XX.O.",
* "X..OO",
* ".XO..",
* "XXO.#",
* ".XO.#",
* ]
* </pre>
[<br/>
"XX.O.",<br/>
"X..OO",<br/>
".XO..",<br/>
"XXO.#",<br/>
".XO.#",<br/>
]
*
* Each string represents a vertical column on the board, and each character in the string represents a point.
*