felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-04-16 06:18:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOCUMENTATION: Clarify returned value of ns.bladeburner.getActionCountRemaining (#1873)

Browse Source
This commit is contained in:
catloversg
2025-01-05 07:33:45 +07:00
committed by GitHub
parent 43bca702c0
commit 93c07ac107
2 changed files with 13 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@@ -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.