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 values returned in range 0-1 (#1986)

Browse Source
This commit is contained in:
catloversg
2025-03-02 00:08:42 +07:00
committed by GitHub
parent 4ef597bd37
commit ff724f3f06
6 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md
View File

@@ -34,5 +34,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 2 values, value\[0\] - MIN Chance, value\[1\] - MAX Chance
Returns the estimated success chance for the specified action. This chance is returned in the range 0-1. (e.g. if you have an estimated success chance of 80%, then this function will return 0.8, NOT 80). Returns 2 values, value\[0\] - MIN Chance, value\[1\] - MAX Chance

2
markdown/bitburner.gang.getchancetowinclash.md
View File

@@ -28,5 +28,5 @@ Chance you have to win a clash with the specified gang.
RAM cost: 4 GB
Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage
Returns the chance you have to win a clash with the specified gang. The chance is returned in the range 0-1.

2
markdown/bitburner.ns.hackanalyzechance.md
View File

@@ -30,7 +30,7 @@ RAM cost: 1 GB
Returns the chance you have of successfully hacking the specified server.
This returned value is in decimal form, not percentage.
This returned value is in the range 0-1.
Like other basic hacking analysis functions, this calculation uses the current status of the player and server. To calculate using hypothetical server or player status, obtain access to the Formulas API and use [formulas.hacking.hackChance](./bitburner.hackingformulas.hackchance.md)<!-- -->.

2
markdown/bitburner.tix.getforecast.md
View File

@@ -26,7 +26,7 @@ Probability that the specified stock’s price will increase (as opposed to decr
## Remarks
RAM cost: 2.5 GB The probability is returned as a decimal value, NOT a percentage (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).
RAM cost: 2.5 GB The probability is returned in the range 0-1. (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).
In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a 30% chance of increasing and a 70% chance of decreasing during the next tick.

2
markdown/bitburner.tix.getvolatility.md
View File

@@ -26,7 +26,7 @@ Volatility of the specified stock.
## Remarks
RAM cost: 2.5 GB Volatility represents the maximum percentage by which a stock’s price can change every tick. The volatility is returned as a decimal value, NOT a percentage (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).
RAM cost: 2.5 GB Volatility represents the maximum percentage by which a stock’s price can change every tick. The volatility is returned in the range 0-1. (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).
In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.

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

@@ -1573,7 +1573,7 @@ export interface TIX {
* @remarks
* RAM cost: 2.5 GB
* Volatility represents the maximum percentage by which a stock’s price can change every tick.
* The volatility is returned as a decimal value, NOT a percentage
* The volatility is returned in the range 0-1.
* (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).
*
* In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.
@@ -1588,7 +1588,7 @@ export interface TIX {
* tick.
* @remarks
* RAM cost: 2.5 GB
* The probability is returned as a decimal value, NOT a percentage
* The probability is returned in the range 0-1.
* (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).
*
* In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a
@@ -3423,8 +3423,8 @@ export interface Bladeburner {
* 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).
* This chance is returned in the range 0-1.
* (e.g. if you have an estimated success chance of 80%, then this function will return 0.8, NOT 80).
* Returns 2 values, value[0] - MIN Chance, value[1] - MAX Chance
*
* @param type - Type of action.
@@ -4291,7 +4291,7 @@ export interface Gang {
* @remarks
* RAM cost: 4 GB
*
* Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage
* Returns the chance you have to win a clash with the specified gang. The chance is returned in the range 0-1.
*
* @param gangName - Target gang
* @returns Chance you have to win a clash with the specified gang.
@@ -6272,7 +6272,7 @@ export interface NS {
*
* Returns the chance you have of successfully hacking the specified server.
*
* This returned value is in decimal form, not percentage.
* This returned value is in the range 0-1.
*
* Like other basic hacking analysis functions, this calculation uses the current status of the player and server.
* To calculate using hypothetical server or player status, obtain access to the Formulas API and use {@link HackingFormulas.hackChance | formulas.hacking.hackChance}.