mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-23 08:03:48 +01:00
37 lines
1.5 KiB
Markdown
37 lines
1.5 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [gymWorkout](./bitburner.singularity.gymworkout.md)
|
|
|
|
## Singularity.gymWorkout() method
|
|
|
|
Workout at the gym.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
gymWorkout(gymName: GymLocationName | `${GymLocationName}`, stat: GymType | `${GymType}`, focus?: boolean): boolean;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| gymName | [GymLocationName](./bitburner.gymlocationname.md) \| \`${[GymLocationName](./bitburner.gymlocationname.md)<!-- -->}\` | Name of gym. You must be in the correct city for whatever gym you specify. |
|
|
| stat | [GymType](./bitburner.gymtype.md) \| \`${[GymType](./bitburner.gymtype.md)<!-- -->}\` | The stat you want to train. |
|
|
| focus | boolean | _(Optional)_ Acquire player focus on this gym workout. Optional. Defaults to true. |
|
|
|
|
**Returns:**
|
|
|
|
boolean
|
|
|
|
True if action 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
|
|
|