bitburner-src/markdown/bitburner.sleeve.settofactionwork.md
Olivier Gagnon feb0430aff work on doc
2021-10-30 15:46:34 -04:00

35 lines
1.1 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; [setToFactionWork](./bitburner.sleeve.settofactionwork.md)
## Sleeve.setToFactionWork() 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 or this faction.
<b>Signature:</b>
```typescript
setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType: FactionWork): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve to work for the faction. |
| factionName | [FactionName](./bitburner.factionname.md) | Name of the faction to work for. |
| factionWorkType | [FactionWork](./bitburner.factionwork.md) | Name of the action to perform for this faction. |
<b>Returns:</b>
boolean
True if the sleeve started working on this faction, false otherwise.
## Remarks
RAM cost: 4 GB