mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 14:28:36 +02:00
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
81 lines
1.4 KiB
Markdown
81 lines
1.4 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.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
commitCrime(crime: CrimeType, focus?: boolean): number;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
<table><thead><tr><th>
|
||
|
||
Parameter
|
||
|
||
|
||
</th><th>
|
||
|
||
Type
|
||
|
||
|
||
</th><th>
|
||
|
||
Description
|
||
|
||
|
||
</th></tr></thead>
|
||
<tbody><tr><td>
|
||
|
||
crime
|
||
|
||
|
||
</td><td>
|
||
|
||
[CrimeType](./bitburner.crimetype.md)
|
||
|
||
|
||
</td><td>
|
||
|
||
Name of crime to attempt.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
focus
|
||
|
||
|
||
</td><td>
|
||
|
||
boolean
|
||
|
||
|
||
</td><td>
|
||
|
||
_(Optional)_ Acquire player focus on this crime. Optional. Defaults to true.
|
||
|
||
|
||
</td></tr>
|
||
</tbody></table>
|
||
|
||
**Returns:**
|
||
|
||
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('Rob Store')` will return 60,000).
|
||
|