mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-09-19 20:38:42 +02: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) > [setToFactionWork](./bitburner.sleeve.settofactionwork.md)
|
|
|
|
## Sleeve.setToFactionWork() method
|
|
|
|
Set a sleeve to work for a faction.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
setToFactionWork(
|
|
sleeveNumber: number,
|
|
factionName: string,
|
|
factionWorkType: FactionWorkType | `${FactionWorkType}`,
|
|
): boolean | undefined;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| sleeveNumber | number | Index of the sleeve to work for the faction. |
|
|
| factionName | string | Name of the faction to work for. |
|
|
| factionWorkType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)<!-- -->}\` | Name of the action to perform for this faction. |
|
|
|
|
<b>Returns:</b>
|
|
|
|
boolean \| undefined
|
|
|
|
True if the sleeve started working on this faction, false otherwise, can also throw on errors
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 4 GB
|
|
|
|
Return a boolean indicating whether or not the sleeve started working or this faction.
|
|
|