bitburner-src/markdown/bitburner.singularity.getcrimechance.md
Olivier Gagnon feb0430aff work on doc
2021-10-30 15:46:34 -04:00

33 lines
908 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [getCrimeChance](./bitburner.singularity.getcrimechance.md)
## Singularity.getCrimeChance() method
If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.
This function returns your chance of success at commiting the specified crime. The chance is returned as a decimal (i.e. 60% would be returned as 0.6).
<b>Signature:</b>
```typescript
getCrimeChance(crime: Crime): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| crime | [Crime](./bitburner.crime.md) | Name of crime. |
<b>Returns:</b>
number
Chance of success at commiting the specified crime as a decimal.
## Remarks
Singularity - Level 3