work on doc

markdown/bitburner.singularity.commitcrime.md

@@ -0,0 +1,36 @@
+<!-- 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; [commitCrime](./bitburner.singularity.commitcrime.md)
+
+## Singularity.commitCrime() 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 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 seconds 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).
+
+Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit.
+
+<b>Signature:</b>
+
+```typescript
+commitCrime(crime: Crime): number;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  crime | [Crime](./bitburner.crime.md) | Name of crime to attempt. |
+
+<b>Returns:</b>
+
+number
+
+True if you successfully start working on the specified program, and false otherwise.
+
+## Remarks
+
+5 GB  Level 3
+