From b06b8bbdded7abfb0f8176b47eaeb0aea4f0245a Mon Sep 17 00:00:00 2001 From: Sphyxis <148732459+Sphyxis@users.noreply.github.com> Date: Fri, 3 Nov 2023 19:48:46 -0600 Subject: [PATCH] BLADEBURNER: Updated descriptions (#906) --- ...burner.bladeburner.getactionestimatedsuccesschance.md | 2 +- markdown/bitburner.bladeburner.startaction.md | 9 +++++++++ src/ScriptEditor/NetscriptDefinitions.d.ts | 7 +++++++ 3 files changed, 17 insertions(+), 1 deletion(-) diff --git a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md index 47eabb038..c7ae69af6 100644 --- a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md +++ b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md @@ -29,5 +29,5 @@ Estimated success chance for the specified action. RAM cost: 4 GB -Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). +Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). Returns 2 values, value\[0\] - MIN Chance, value\[1\] - MAX Chance diff --git a/markdown/bitburner.bladeburner.startaction.md b/markdown/bitburner.bladeburner.startaction.md index 988cbe550..072c2b71b 100644 --- a/markdown/bitburner.bladeburner.startaction.md +++ b/markdown/bitburner.bladeburner.startaction.md @@ -31,3 +31,12 @@ RAM cost: 4 GB Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise. +## Example + + +```js +ns.bladeburner.startAction("Contracts", "Tracking") + +// This will start the Bladeburner Contracts action of Tracking +``` + diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index dce05292d..668171ecd 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -2910,6 +2910,12 @@ export interface Bladeburner { * * Attempts to start the specified Bladeburner action. * Returns true if the action was started successfully, and false otherwise. + *@example + * ```js + * ns.bladeburner.startAction("Contracts", "Tracking") + * + * // This will start the Bladeburner Contracts action of Tracking + * ``` * * @param type - Type of action. * @param name - Name of action. Must be an exact match @@ -2971,6 +2977,7 @@ export interface Bladeburner { * Returns the estimated success chance for the specified action. * This chance is returned as a decimal value, NOT a percentage * (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). + * Returns 2 values, value[0] - MIN Chance, value[1] - MAX Chance * * @param type - Type of action. * @param name - Name of action. Must be an exact match.