work on doc

This commit is contained in:
Olivier Gagnon
2021-10-30 12:34:14 -04:00
parent f99c3fd0cd
commit 43fc5dfd48
589 changed files with 63720 additions and 1168 deletions
@@ -0,0 +1,31 @@
<!-- 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; [stopAction](./bitburner.singularity.stopaction.md)
## Singularity.stopAction() method
If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.
This function is used to end whatever action the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.
The actions that can be stopped with this function are:
\* Studying at a university \* Working for a company/faction \* Creating a program \* Committing a Crime
This function will return true if the players action was ended. It will return false if the player was not performing an action when this function was called.
<b>Signature:</b>
```typescript
stopAction(): boolean;
```
<b>Returns:</b>
boolean
True if the players action was ended, false if the player was not performing an action.
## Remarks
1 GB Level 1