BLADEBURNER: Updated descriptions (#906)

This commit is contained in:
Sphyxis 2023-11-03 19:48:46 -06:00 committed by GitHub
parent 4e8c43fdbe
commit b06b8bbdde
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 17 additions and 1 deletions

@ -29,5 +29,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 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

@ -31,3 +31,12 @@ RAM cost: 4 GB
Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise.
## Example
```js
ns.bladeburner.startAction("Contracts", "Tracking")
// This will start the Bladeburner Contracts action of Tracking
```

@ -2910,6 +2910,12 @@ export interface Bladeburner {
*
* Attempts to start the specified Bladeburner action.
* Returns true if the action was started successfully, and false otherwise.
*@example
* ```js
* ns.bladeburner.startAction("Contracts", "Tracking")
*
* // This will start the Bladeburner Contracts action of Tracking
* ```
*
* @param type - Type of action.
* @param name - Name of action. Must be an exact match
@ -2971,6 +2977,7 @@ export interface Bladeburner {
* 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
*
* @param type - Type of action.
* @param name - Name of action. Must be an exact match.