mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-05-02 05:47:14 +02:00
catloversg
65 lines
950 B
Markdown
65 lines
950 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [joinFaction](./bitburner.singularity.joinfaction.md)
|
|
|
|
## Singularity.joinFaction() method
|
|
|
|
Join a faction.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
joinFaction(faction: FactionName): 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 join.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
boolean
|
|
|
|
True if the player successfully accepts an invitation, and false otherwise.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 3 GB \* 16/4/1
|
|
|
|
This function will automatically accept an invitation from a faction and join it.
|
|
|
|
Note that this function returns false if you are already a member of the specified faction.
|
|
|