mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-24 00:23:49 +01:00
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [workForFaction](./bitburner.singularity.workforfaction.md)
|
|
|
|
## Singularity.workForFaction() method
|
|
|
|
Work for a faction.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
workForFaction(faction: string, workType: FactionWorkType | `${FactionWorkType}`, focus?: boolean): boolean;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| faction | string | Name of faction to work for. |
|
|
| workType | [FactionWorkType](./bitburner.factionworktype.md) \| \`${[FactionWorkType](./bitburner.factionworktype.md)<!-- -->}\` | Type of work to perform for the faction. |
|
|
| focus | boolean | _(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. |
|
|
|
|
**Returns:**
|
|
|
|
boolean
|
|
|
|
True if the player starts working, and false otherwise.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 3 GB \* 16/4/1
|
|
|
|
This function will set you to start working for the specified faction. You must be a member of the faction and that faction must have the specified work type, or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will cancel that action.
|
|
|
|
This function will return true if you successfully start working for the specified faction, and false otherwise.
|
|
|
|
## Example
|
|
|
|
|
|
```js
|
|
const factionName = "CyberSec";
|
|
const workType = "hacking";
|
|
|
|
let success = ns.singularity.workForFaction(factionName, workType);
|
|
if (!success) ns.tprint(`ERROR: Failed to start work for ${factionName} with work type ${workType}.`);
|
|
```
|
|
|