mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-13 11:13:50 +01:00
65cd14e33b
* 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.
36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [commitCrime](./bitburner.singularity.commitcrime.md)
|
||
|
||
## Singularity.commitCrime() method
|
||
|
||
Commit a crime.
|
||
|
||
<b>Signature:</b>
|
||
|
||
```typescript
|
||
commitCrime(crime: CrimeType | `${CrimeType}`, focus?: boolean): number;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
| Parameter | Type | Description |
|
||
| --- | --- | --- |
|
||
| crime | [CrimeType](./bitburner.crimetype.md) \| \`${[CrimeType](./bitburner.crimetype.md)<!-- -->}\` | Name of crime to attempt. |
|
||
| focus | boolean | Acquire player focus on this crime. Optional. Defaults to true. |
|
||
|
||
<b>Returns:</b>
|
||
|
||
number
|
||
|
||
The number of milliseconds it takes to attempt the specified crime.
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 5 GB \* 16/4/1
|
||
|
||
This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.
|
||
|
||
This function returns the number of milliseconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('ROBSTORE')` will return 60,000).
|
||
|