mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-17 21:23:54 +01:00
31 lines
1.1 KiB
Markdown
31 lines
1.1 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [GoCheat](./bitburner.gocheat.md) > [getCheatSuccessChance](./bitburner.gocheat.getcheatsuccesschance.md)
|
|
|
|
## GoCheat.getCheatSuccessChance() method
|
|
|
|
Returns your chance of successfully playing one of the special moves in the ns.go.cheat API. Scales up with your crime success rate stat. Scales down with the number of times you've attempted to cheat in the current game.
|
|
|
|
Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
getCheatSuccessChance(cheatCount?: number): number;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| cheatCount | number | _(Optional)_ Optional override for the number of cheats already attempted. Defaults to the number of cheats attempted in the current game. |
|
|
|
|
**Returns:**
|
|
|
|
number
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 1 GB Requires BitNode 14.2 to use
|
|
|