bitburner-src/markdown/bitburner.workformulas.crimegains.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

26 lines
762 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [WorkFormulas](./bitburner.workformulas.md) &gt; [crimeGains](./bitburner.workformulas.crimegains.md)
## WorkFormulas.crimeGains() method
<b>Signature:</b>
```typescript
crimeGains(person: Person, crimeType: CrimeType | `${CrimeType}`): WorkStats;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| person | [Person](./bitburner.person.md) | |
| crimeType | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)<!-- -->}\` | |
<b>Returns:</b>
[WorkStats](./bitburner.workstats.md)
The WorkStats gained when completing one instance of the specified crime.