bitburner-src/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md
catloversg cacecda72f
API: Add types for parameters of gym-university-bladeburner API (Fix merging error) (#1596)
* API: Add types for parameters of gym-university-bladeburner API
* Fix merging error
2024-08-17 14:08:55 -07:00

1.5 KiB

Home > bitburner > Bladeburner > getActionEstimatedSuccessChance

Bladeburner.getActionEstimatedSuccessChance() method

Get estimate success chance of an action.

Signature:

getActionEstimatedSuccessChance(
    type: BladeburnerActionType | `${BladeburnerActionType}`,
    name: BladeburnerActionName | `${BladeburnerActionName}`,
    sleeveNumber?: number,
  ): [number, number];

Parameters

Parameter Type Description
type BladeburnerActionType | `${BladeburnerActionType}` Type of action.
name BladeburnerActionName | `${BladeburnerActionName}` 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