mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
108 lines
1.8 KiB
Markdown
108 lines
1.8 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: FactionName, workType: FactionWorkType, focus?: boolean): boolean;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
faction
|
|
|
|
|
|
</td><td>
|
|
|
|
[FactionName](./bitburner.factionname.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Name of faction to work for.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
workType
|
|
|
|
|
|
</td><td>
|
|
|
|
[FactionWorkType](./bitburner.factionworktype.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Type of work to perform for the faction.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
focus
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**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}.`);
|
|
```
|
|
|