From 93c07ac107668ce089e99b78351d655d687a8457 Mon Sep 17 00:00:00 2001 From: catloversg <152669316+catloversg@users.noreply.github.com> Date: Sun, 5 Jan 2025 07:33:45 +0700 Subject: [PATCH] DOCUMENTATION: Clarify returned value of ns.bladeburner.getActionCountRemaining (#1873) --- .../bitburner.bladeburner.getactioncountremaining.md | 6 +++++- src/ScriptEditor/NetscriptDefinitions.d.ts | 12 ++++++++---- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/markdown/bitburner.bladeburner.getactioncountremaining.md b/markdown/bitburner.bladeburner.getactioncountremaining.md index cc23e84de..1395e8b3d 100644 --- a/markdown/bitburner.bladeburner.getactioncountremaining.md +++ b/markdown/bitburner.bladeburner.getactioncountremaining.md @@ -34,5 +34,9 @@ RAM cost: 4 GB Returns the remaining count of the specified action. -Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of whether the player has the required rank to attempt the mission or not. +Note: + +- This function is meant to be used for Contracts and Operations. It returns Infinity for General actions (Training, Field Analysis, etc.). It returns 1 for BlackOps not yet completed, regardless of whether the player has the required rank to attempt the mission. + +- With Contracts and Operations, the returned value is a floating-point number. The UI shows the rounded-down value. diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index fabeaf863..71d91af79 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -3441,10 +3441,14 @@ export interface Bladeburner { * * Returns the remaining count of the specified action. * - * Note that this is meant to be used for Contracts and Operations. - * This function will return ‘Infinity’ for actions such as Training and Field Analysis. - * This function will return 1 for BlackOps not yet completed regardless of whether - * the player has the required rank to attempt the mission or not. + * Note: + * + * - This function is meant to be used for Contracts and Operations. It returns Infinity for General actions + * (Training, Field Analysis, etc.). It returns 1 for BlackOps not yet completed, regardless of whether the player has + * the required rank to attempt the mission. + * + * - With Contracts and Operations, the returned value is a floating-point number. The UI shows the rounded-down + * value. * * @param type - Type of action. * @param name - Name of action. Must be an exact match.