bitburner-src/markdown/bitburner.singularity.gymworkout.md
catloversg cacecda72f
API: Add types for parameters of gym-university-bladeburner API (Fix merging error) (#1596)
* API: Add types for parameters of gym-university-bladeburner API
* Fix merging error
2024-08-17 14:08:55 -07:00

1.5 KiB

Home > bitburner > Singularity > gymWorkout

Singularity.gymWorkout() method

Workout at the gym.

Signature:

gymWorkout(gymName: GymLocationName | `${GymLocationName}`, stat: GymType | `${GymType}`, focus?: boolean): boolean;

Parameters

Parameter Type Description
gymName GymLocationName | `${GymLocationName}` Name of gym. You must be in the correct city for whatever gym you specify.
stat GymType | `${GymType}` 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