From efd4152eed6a084d0d6e6f1548d1db2436e26892 Mon Sep 17 00:00:00 2001 From: Michael Ficocelli Date: Thu, 23 May 2024 20:07:45 -0400 Subject: [PATCH] IPVGO: Fix outdated docs (#1306) --- markdown/bitburner.go.makemove.md | 2 +- markdown/bitburner.go.passturn.md | 2 +- markdown/bitburner.sleeve.md | 2 +- markdown/bitburner.sleeve.travel.md | 2 +- src/ScriptEditor/NetscriptDefinitions.d.ts | 14 +++++++------- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/markdown/bitburner.go.makemove.md b/markdown/bitburner.go.makemove.md index cd229be4c..db2399054 100644 --- a/markdown/bitburner.go.makemove.md +++ b/markdown/bitburner.go.makemove.md @@ -30,7 +30,7 @@ makeMove( 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 diff --git a/markdown/bitburner.go.passturn.md b/markdown/bitburner.go.passturn.md index 5bedddaf1..3f6a66508 100644 --- a/markdown/bitburner.go.passturn.md +++ b/markdown/bitburner.go.passturn.md @@ -21,7 +21,7 @@ passTurn(): Promise<{ 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 diff --git a/markdown/bitburner.sleeve.md b/markdown/bitburner.sleeve.md index dfe8d29f9..c2d5f2ab3 100644 --- a/markdown/bitburner.sleeve.md +++ b/markdown/bitburner.sleeve.md @@ -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. | | [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. | -| [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. | diff --git a/markdown/bitburner.sleeve.travel.md b/markdown/bitburner.sleeve.travel.md index 3b3c18b82..ba7908bdf 100644 --- a/markdown/bitburner.sleeve.travel.md +++ b/markdown/bitburner.sleeve.travel.md @@ -4,7 +4,7 @@ ## 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:** diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 4eb0542b9..176545ef7 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -3969,7 +3969,7 @@ export interface Go { * @remarks * 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( 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 * 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 * RAM cost: 0 GB @@ -4205,7 +4205,7 @@ export interface Go { cheat: { /** * 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 * small (~10%) chance you will instantly be ejected from the subnet. @@ -4227,7 +4227,7 @@ export interface Go { * RAM cost: 8 GB * 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( x: number, @@ -4250,7 +4250,7 @@ export interface Go { * RAM cost: 8 GB * 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( x1: number, @@ -4275,7 +4275,7 @@ export interface Go { * RAM cost: 8 GB * 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( x: number, @@ -4299,7 +4299,7 @@ export interface Go { * RAM cost: 8 GB * 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( x: number,