bitburner-src/markdown/bitburner.sleeve.settogymworkout.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.1 KiB

Home > bitburner > Sleeve > setToGymWorkout

Sleeve.setToGymWorkout() method

Set a sleeve to workout at the gym.

Signature:

setToGymWorkout(
    sleeveNumber: number,
    gymName: GymLocationName | `${GymLocationName}`,
    stat: GymType | `${GymType}`,
  ): boolean;

Parameters

Parameter Type Description
sleeveNumber number Index of the sleeve to workout at the gym.
gymName GymLocationName | `${GymLocationName}` Name of the gym.
stat GymType | `${GymType}` Name of the stat to train.

Returns:

boolean

True if the sleeve started working out, false otherwise.

Remarks

RAM cost: 4 GB

Return a boolean indicating whether or not the sleeve started working out.