bitburner-src/markdown/bitburner.sleeve.settobladeburneraction.md

39 lines
1.3 KiB
Markdown
Raw Normal View History

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2022-11-24 14:19:51 +01:00
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Sleeve](./bitburner.sleeve.md) &gt; [setToBladeburnerAction](./bitburner.sleeve.settobladeburneraction.md)
2022-11-24 14:19:51 +01:00
## Sleeve.setToBladeburnerAction() method
2023-04-07 13:49:11 +02:00
Set a sleeve to perform Bladeburner actions.
**Signature:**
```typescript
setToBladeburnerAction(
sleeveNumber: number,
action: BladeburnerActionTypeForSleeve | `${BladeburnerActionTypeForSleeve}`,
contract?: BladeburnerContractName,
): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2023-04-07 13:49:11 +02:00
| 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
2023-04-07 13:49:11 +02:00
True if the sleeve started the given Bladeburner action, false otherwise.
## Remarks
RAM cost: 4 GB
2023-04-07 13:49:11 +02:00
Return a boolean indicating whether or not the sleeve started a Bladeburner action.