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

39 lines
1.3 KiB
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; [setToBladeburnerAction](./bitburner.sleeve.settobladeburneraction.md)
## Sleeve.setToBladeburnerAction() method
Set a sleeve to perform Bladeburner actions.
**Signature:**
```typescript
setToBladeburnerAction(
sleeveNumber: number,
action: BladeburnerActionTypeForSleeve | `${BladeburnerActionTypeForSleeve}`,
contract?: BladeburnerContractName,
): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to perform a Bladeburner action. |
| action | [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) \| \`${[BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md)<!-- -->}\` | Name of the action to be performed. |
| contract | [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | _(Optional)_ Name of the contract if applicable. |
**Returns:**
boolean
True if the sleeve started the given Bladeburner action, false otherwise.
## Remarks
RAM cost: 4 GB
Return a boolean indicating whether or not the sleeve started a Bladeburner action.