IPVGO: Fix outdated docs (#1306)

This commit is contained in:
Michael Ficocelli 2024-05-23 20:07:45 -04:00 committed by GitHub
parent 23445a917d
commit efd4152eed
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 11 additions and 11 deletions

@ -30,7 +30,7 @@ makeMove(
Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }> Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>
a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
## Remarks ## Remarks

@ -21,7 +21,7 @@ passTurn(): Promise<{
Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt; Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;
a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
## Remarks ## Remarks

@ -37,5 +37,5 @@ If you are not in BitNode-10, then you must have Source-File 10 in order to use
| [setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md) | Set a sleeve to shock recovery. | | [setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md) | Set a sleeve to shock recovery. |
| [setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md) | Set a sleeve to synchronize. | | [setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md) | Set a sleeve to synchronize. |
| [setToUniversityCourse(sleeveNumber, university, className)](./bitburner.sleeve.settouniversitycourse.md) | Set a sleeve to take a class at a university. | | [setToUniversityCourse(sleeveNumber, university, className)](./bitburner.sleeve.settouniversitycourse.md) | Set a sleeve to take a class at a university. |
| [travel(sleeveNumber, city)](./bitburner.sleeve.travel.md) | Make a sleeve travel to another city. | | [travel(sleeveNumber, city)](./bitburner.sleeve.travel.md) | Make a sleeve travel to another city. The cost for using this function is the same as for a player. |

@ -4,7 +4,7 @@
## Sleeve.travel() method ## Sleeve.travel() method
Make a sleeve travel to another city. Make a sleeve travel to another city. The cost for using this function is the same as for a player.
**Signature:** **Signature:**

@ -3969,7 +3969,7 @@ export interface Go {
* @remarks * @remarks
* RAM cost: 4 GB * RAM cost: 4 GB
* *
* @returns a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
makeMove( makeMove(
x: number, x: number,
@ -3987,7 +3987,7 @@ export interface Go {
* This can also be used if you pick up the game in a state where the opponent needs to play next. For example: if BitBurner was * This can also be used if you pick up the game in a state where the opponent needs to play next. For example: if BitBurner was
* closed while waiting for the opponent to make a move, you may need to call passTurn() to get them to play their move on game start. * closed while waiting for the opponent to make a move, you may need to call passTurn() to get them to play their move on game start.
* *
* @returns a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
* *
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
@ -4205,7 +4205,7 @@ export interface Go {
cheat: { cheat: {
/** /**
* Returns your chance of successfully playing one of the special moves in the ns.go.cheat API. * Returns your chance of successfully playing one of the special moves in the ns.go.cheat API.
* Scales with your crime success rate stat. Caps at 80%. * Scales with your crime success rate stat.
* *
* Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a * Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a
* small (~10%) chance you will instantly be ejected from the subnet. * small (~10%) chance you will instantly be ejected from the subnet.
@ -4227,7 +4227,7 @@ export interface Go {
* RAM cost: 8 GB * RAM cost: 8 GB
* Requires Bitnode 14.2 to use * Requires Bitnode 14.2 to use
* *
* @returns a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
removeRouter( removeRouter(
x: number, x: number,
@ -4250,7 +4250,7 @@ export interface Go {
* RAM cost: 8 GB * RAM cost: 8 GB
* Requires Bitnode 14.2 to use * Requires Bitnode 14.2 to use
* *
* @returns a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
playTwoMoves( playTwoMoves(
x1: number, x1: number,
@ -4275,7 +4275,7 @@ export interface Go {
* RAM cost: 8 GB * RAM cost: 8 GB
* Requires Bitnode 14.2 to use * Requires Bitnode 14.2 to use
* *
* @returns a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
repairOfflineNode( repairOfflineNode(
x: number, x: number,
@ -4299,7 +4299,7 @@ export interface Go {
* RAM cost: 8 GB * RAM cost: 8 GB
* Requires Bitnode 14.2 to use * Requires Bitnode 14.2 to use
* *
* @returns a promise that contains if your move was valid and successful, the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
destroyNode( destroyNode(
x: number, x: number,