DOCS: Fix example signature in IPvGO guide (#1396)

This commit is contained in:
Albert Llop 2024-06-14 08:55:46 +02:00 committed by GitHub
parent 417d420793
commit e9347fca76
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -91,14 +91,12 @@ Now that a simple move type is available, it can be used to play on the current
`await ns.go.passTurn()` can be used if no moves are found. This will end the game if the AI also passes (or just passed previously). `await ns.go.passTurn()` can be used if no moves are found. This will end the game if the AI also passes (or just passed previously).
Both `makeMove()` and `passTurn()` , when awaited, return an object that tells you if your move was valid and successfully played, and what the AI's response is. Both `makeMove()` and `passTurn()`, when awaited, return an object that tells you what the AI's response is, and if the game is over.
```js ```js
{ {
// If your move was successfully applied to the subnet // If the opponent moved or passed, or if the game is now over.
success: boolean; type: "move" | "pass" | "gameOver";
// If the opponent moved or passed, or if the game is now over, or if your move was invalid
type: "invalid" | "move" | "pass" | "gameOver";
x: number | null; // Opponent move's x coord (if applicable) x: number | null; // Opponent move's x coord (if applicable)
y: number | null; // Opponent move's y coord (if applicable) y: number | null; // Opponent move's y coord (if applicable)
} }