mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-01 12:03:47 +01:00
39 lines
1.5 KiB
Markdown
39 lines
1.5 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionEstimatedSuccessChance](./bitburner.bladeburner.getactionestimatedsuccesschance.md)
|
|
|
|
## Bladeburner.getActionEstimatedSuccessChance() method
|
|
|
|
Get estimate success chance of an action.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
getActionEstimatedSuccessChance(
|
|
type: BladeburnerActionType | `${BladeburnerActionType}`,
|
|
name: BladeburnerActionName | `${BladeburnerActionName}`,
|
|
sleeveNumber?: number,
|
|
): [number, number];
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) \| \`${[BladeburnerActionType](./bitburner.bladeburneractiontype.md)<!-- -->}\` | Type of action. |
|
|
| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) \| \`${[BladeburnerActionName](./bitburner.bladeburneractionname.md)<!-- -->}\` | Name of action. Must be an exact match. |
|
|
| sleeveNumber | number | _(Optional)_ Optional. Index of the sleeve to retrieve information. |
|
|
|
|
**Returns:**
|
|
|
|
\[number, number\]
|
|
|
|
Estimated success chance for the specified action.
|
|
|
|
## Remarks
|
|
|
|
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
|
|
|