bitburner-src/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md
David Walker 79bb0d289a
Revert "API: Add types for parameters of gym-university-bladeburner API (#1591)" (#1592)
This reverts commit da8870ed796c916c19cac7c2b6328a75180367fc.
2024-08-16 13:45:54 -07:00

1.2 KiB

Home > bitburner > Bladeburner > getActionEstimatedSuccessChance

Bladeburner.getActionEstimatedSuccessChance() method

Get estimate success chance of an action.

Signature:

getActionEstimatedSuccessChance(type: string, name: string, sleeveNumber?: number): [number, number];

Parameters

Parameter Type Description
type string Type of action.
name string 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