bitburner-src/markdown/bitburner.singularity.gymworkout.md
omuretsu 06a985bdf8 Revert "Remove markdown from git tracking (#139)"
This reverts commit bbb6e3f309935aebac74ddb1fbeec12dfb7540b1.
2022-10-21 11:16:00 -04:00

37 lines
1.2 KiB
Markdown

<!-- 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; [gymWorkout](./bitburner.singularity.gymworkout.md)
## Singularity.gymWorkout() method
Workout at the gym.
<b>Signature:</b>
```typescript
gymWorkout(gymName: string, stat: string, focus?: boolean): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| gymName | string | Name of gym. You must be in the correct city for whatever gym you specify. |
| stat | string | The stat you want to train. |
| focus | boolean | Acquire player focus on this gym workout. Optional. Defaults to true. |
<b>Returns:</b>
boolean
True if actions is successfully started, false otherwise.
## Remarks
RAM cost: 2 GB \* 16/4/1
This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.
The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train