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

DOCUMENTATION: Clarify getSkillUpgradeCost and fix typo in BaseTask (#1749)

Browse Source
This commit is contained in:
catloversg
2024-11-04 14:27:59 +07:00
committed by GitHub
parent 772762493f
commit e5e4e2693f
2 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1653,7 +1653,7 @@ export interface TIX {
*/
export interface BaseTask {
/**
* The number of game engine cycles that has passed since this task started. 1 engine cycle = 200ms.
* The number of game engine cycles has passed since this task started. 1 engine cycle = 200ms.
*/
cyclesWorked: number;
}
@@ -3584,7 +3584,15 @@ export interface Bladeburner {
*
* This function returns the number of skill points needed to upgrade the specified skill the specified number of times.
*
* The function returns Infinity if the sum of the current level and count exceeds the maximum level.
* The function may return 0 or Infinity in special cases:
*
* - Return 0 if the current skill level is too high and the specified count is too small. In normal situations, you
* don't need to worry about this case. It only happens when involved numbers surpass Number.MAX_SAFE_INTEGER and be
* affected by the floating-point inaccuracy.
*
* - Return Infinity if the sum of the current level and count exceeds the maximum level.
*
* {@link BladeburnerFormulas.skillMaxUpgradeCount | skillMaxUpgradeCount} is the inverse function of this one.
*
* @param skillName - Name of skill. Case-sensitive and must be an exact match.
* @param count - Number of times to upgrade the skill. Defaults to 1 if not specified.