mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-18 12:15:44 +01:00
39 lines
1.1 KiB
Markdown
39 lines
1.1 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToGymWorkout](./bitburner.sleeve.settogymworkout.md)
|
|
|
|
## Sleeve.setToGymWorkout() method
|
|
|
|
Set a sleeve to workout at the gym.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
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](./bitburner.gymlocationname.md) \| \`${[GymLocationName](./bitburner.gymlocationname.md)<!-- -->}\` | Name of the gym. |
|
|
| stat | [GymType](./bitburner.gymtype.md) \| \`${[GymType](./bitburner.gymtype.md)<!-- -->}\` | 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.
|
|
|