bitburner-src/markdown/bitburner.sleeve.settogymworkout.md
Olivier Gagnon 43fc5dfd48 work on doc
2021-10-30 12:34:14 -04:00

35 lines
939 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Sleeve](./bitburner.sleeve.md) &gt; [setToGymWorkout](./bitburner.sleeve.settogymworkout.md)
## Sleeve.setToGymWorkout() method
If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.
Return a boolean indicating whether or not the sleeve started working out.
<b>Signature:</b>
```typescript
setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to workout at the gym. |
| gymName | [Gym](./bitburner.gym.md) | Name of the gym. |
| stat | [GymStat](./bitburner.gymstat.md) | Name of the stat to train. |
<b>Returns:</b>
boolean
True if the sleeve started working out, false otherwise.
## Remarks
4 GB