Skip to content

Commit

Permalink
DOCUMENTATION: Clarify returned value of ns.bladeburner.getActionCoun…
Browse files Browse the repository at this point in the history
…tRemaining (#1873)
  • Loading branch information
catloversg authored Jan 5, 2025
1 parent 43bca70 commit 93c07ac
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
6 changes: 5 additions & 1 deletion markdown/bitburner.bladeburner.getactioncountremaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

12 changes: 8 additions & 4 deletions src/ScriptEditor/NetscriptDefinitions.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit 93c07ac

Please sign in to comment.