Files
bitburner-src/markdown/bitburner.singularity.getfactioninviterequirements.md
T
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* 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>
2025-09-26 14:52:39 -07:00

91 lines
1.7 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [getFactionInviteRequirements](./bitburner.singularity.getfactioninviterequirements.md)
## Singularity.getFactionInviteRequirements() method
List conditions for being invited to a faction.
**Signature:**
```typescript
getFactionInviteRequirements(faction: FactionName): PlayerRequirement[];
```
## 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 the faction
</td></tr>
</tbody></table>
**Returns:**
[PlayerRequirement](./bitburner.playerrequirement.md)<!-- -->\[\]
Array of PlayerRequirement objects which must all be fulfilled to receive an invitation.
## Remarks
RAM cost: 3 GB \* 16/4/1
## Example
```js
ns.singularity.getFactionInviteRequirements("The Syndicate");
[
{ "type": "someCondition", "conditions": [
{ "type": "city", "city": "Aevum" },
{ "type": "city", "city": "Sector-12" }
]
},
{ "type": "not", "condition": {
"type": "employedBy", "company": "Central Intelligence Agency"
}
},
{ "type": "not", "condition": {
"type": "employedBy", "company": "National Security Agency"
}
},
{ "type": "money", "money": 10000000 },
{ "type": "skills", "skills": { "hacking": 200 } },
{ "type": "skills", "skills": { "strength": 200 } },
{ "type": "skills", "skills": { "defense": 200 } },
{ "type": "skills", "skills": { "dexterity": 200 } },
{ "type": "skills", "skills": { "agility": 200 } },
{ "type": "karma", "karma": -90 }
]
```