API: Programming-friendly interface to getFactionInviteRequirements (#…

…953)

markdown/bitburner.backdoorrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BackdoorRequirement](./bitburner.backdoorrequirement.md)
+
+## BackdoorRequirement interface
+
+Player must have installed a backdoor on this server.
+
+**Signature:**
+
+```typescript
+interface BackdoorRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [server](./bitburner.backdoorrequirement.server.md) |  | string |  |
+|  [type](./bitburner.backdoorrequirement.type.md) |  | "backdoorInstalled" |  |
+

markdown/bitburner.backdoorrequirement.server.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BackdoorRequirement](./bitburner.backdoorrequirement.md) &gt; [server](./bitburner.backdoorrequirement.server.md)
+
+## BackdoorRequirement.server property
+
+**Signature:**
+
+```typescript
+server: string;
+```

markdown/bitburner.backdoorrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BackdoorRequirement](./bitburner.backdoorrequirement.md) &gt; [type](./bitburner.backdoorrequirement.type.md)
+
+## BackdoorRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "backdoorInstalled";
+```

markdown/bitburner.bitnoderequirement.bitnoden.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeRequirement](./bitburner.bitnoderequirement.md) &gt; [bitNodeN](./bitburner.bitnoderequirement.bitnoden.md)
+
+## BitNodeRequirement.bitNodeN property
+
+**Signature:**
+
+```typescript
+bitNodeN: number;
+```

markdown/bitburner.bitnoderequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeRequirement](./bitburner.bitnoderequirement.md)
+
+## BitNodeRequirement interface
+
+Player must be located in this BitNode.
+
+**Signature:**
+
+```typescript
+interface BitNodeRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [bitNodeN](./bitburner.bitnoderequirement.bitnoden.md) |  | number |  |
+|  [type](./bitburner.bitnoderequirement.type.md) |  | "bitNodeN" |  |
+

markdown/bitburner.bitnoderequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeRequirement](./bitburner.bitnoderequirement.md) &gt; [type](./bitburner.bitnoderequirement.type.md)
+
+## BitNodeRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "bitNodeN";
+```

markdown/bitburner.bladeburnerrankrequirement.bladeburnerrank.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md) &gt; [bladeburnerRank](./bitburner.bladeburnerrankrequirement.bladeburnerrank.md)
+
+## BladeburnerRankRequirement.bladeburnerRank property
+
+**Signature:**
+
+```typescript
+bladeburnerRank: number;
+```

markdown/bitburner.bladeburnerrankrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md)
+
+## BladeburnerRankRequirement interface
+
+Player must have at least this rank in the Bladeburner Division.
+
+**Signature:**
+
+```typescript
+interface BladeburnerRankRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [bladeburnerRank](./bitburner.bladeburnerrankrequirement.bladeburnerrank.md) |  | number |  |
+|  [type](./bitburner.bladeburnerrankrequirement.type.md) |  | "bladeburnerRank" |  |
+

markdown/bitburner.bladeburnerrankrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md) &gt; [type](./bitburner.bladeburnerrankrequirement.type.md)
+
+## BladeburnerRankRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "bladeburnerRank";
+```

markdown/bitburner.cityrequirement.city.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityRequirement](./bitburner.cityrequirement.md) &gt; [city](./bitburner.cityrequirement.city.md)
+
+## CityRequirement.city property
+
+**Signature:**
+
+```typescript
+city: CityName;
+```

markdown/bitburner.cityrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityRequirement](./bitburner.cityrequirement.md)
+
+## CityRequirement interface
+
+Player must be located in this city.
+
+**Signature:**
+
+```typescript
+interface CityRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [city](./bitburner.cityrequirement.city.md) |  | [CityName](./bitburner.cityname.md) |  |
+|  [type](./bitburner.cityrequirement.type.md) |  | "city" |  |
+

markdown/bitburner.cityrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityRequirement](./bitburner.cityrequirement.md) &gt; [type](./bitburner.cityrequirement.type.md)
+
+## CityRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "city";
+```

markdown/bitburner.companyreputationrequirement.company.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) &gt; [company](./bitburner.companyreputationrequirement.company.md)
+
+## CompanyReputationRequirement.company property
+
+**Signature:**
+
+```typescript
+company: CompanyName;
+```

markdown/bitburner.companyreputationrequirement.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md)
+
+## CompanyReputationRequirement interface
+
+Player must have at least this much reputation with this company.
+
+**Signature:**
+
+```typescript
+interface CompanyReputationRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [company](./bitburner.companyreputationrequirement.company.md) |  | [CompanyName](./bitburner.companyname.md) |  |
+|  [reputation](./bitburner.companyreputationrequirement.reputation.md) |  | number |  |
+|  [type](./bitburner.companyreputationrequirement.type.md) |  | "companyReputation" |  |
+

markdown/bitburner.companyreputationrequirement.reputation.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) &gt; [reputation](./bitburner.companyreputationrequirement.reputation.md)
+
+## CompanyReputationRequirement.reputation property
+
+**Signature:**
+
+```typescript
+reputation: number;
+```

markdown/bitburner.companyreputationrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) &gt; [type](./bitburner.companyreputationrequirement.type.md)
+
+## CompanyReputationRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "companyReputation";
+```

markdown/bitburner.employedbyrequirement.company.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployedByRequirement](./bitburner.employedbyrequirement.md) &gt; [company](./bitburner.employedbyrequirement.company.md)
+
+## EmployedByRequirement.company property
+
+**Signature:**
+
+```typescript
+company: CompanyName;
+```

markdown/bitburner.employedbyrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployedByRequirement](./bitburner.employedbyrequirement.md)
+
+## EmployedByRequirement interface
+
+Player must be working for this company.
+
+**Signature:**
+
+```typescript
+interface EmployedByRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [company](./bitburner.employedbyrequirement.company.md) |  | [CompanyName](./bitburner.companyname.md) |  |
+|  [type](./bitburner.employedbyrequirement.type.md) |  | "employedBy" |  |
+

markdown/bitburner.employedbyrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployedByRequirement](./bitburner.employedbyrequirement.md) &gt; [type](./bitburner.employedbyrequirement.type.md)
+
+## EmployedByRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "employedBy";
+```

markdown/bitburner.everyrequirement.conditions.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EveryRequirement](./bitburner.everyrequirement.md) &gt; [conditions](./bitburner.everyrequirement.conditions.md)
+
+## EveryRequirement.conditions property
+
+**Signature:**
+
+```typescript
+conditions: PlayerRequirement[];
+```

markdown/bitburner.everyrequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EveryRequirement](./bitburner.everyrequirement.md)
+
+## EveryRequirement interface
+
+All sub-conditions must be satisfied.
+
+**Signature:**
+
+```typescript
+interface EveryRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [conditions](./bitburner.everyrequirement.conditions.md) |  | [PlayerRequirement](./bitburner.playerrequirement.md)<!-- -->\[\] |  |
+|  [type](./bitburner.everyrequirement.type.md) |  | "everyCondition" |  |
+

markdown/bitburner.everyrequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EveryRequirement](./bitburner.everyrequirement.md) &gt; [type](./bitburner.everyrequirement.type.md)
+
+## EveryRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "everyCondition";
+```

markdown/bitburner.filerequirement.file.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FileRequirement](./bitburner.filerequirement.md) &gt; [file](./bitburner.filerequirement.file.md)
+
+## FileRequirement.file property
+
+**Signature:**
+
+```typescript
+file: string;
+```

markdown/bitburner.filerequirement.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FileRequirement](./bitburner.filerequirement.md)
+
+## FileRequirement interface
+
+Player must have a specific Literature or Message file on their home computer.
+
+**Signature:**
+
+```typescript
+interface FileRequirement 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [file](./bitburner.filerequirement.file.md) |  | string |  |
+|  [type](./bitburner.filerequirement.type.md) |  | "file" |  |
+

markdown/bitburner.filerequirement.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [FileRequirement](./bitburner.filerequirement.md) &gt; [type](./bitburner.filerequirement.type.md)
+
+## FileRequirement.type property
+
+**Signature:**
+
+```typescript
+type: "file";
+```

markdown/bitburner.hacknetcoresrequirement.hacknetcores.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md) &gt; [hacknetCores](./bitburner.hacknetcoresrequirement.hacknetcores.md)
+
+## HacknetCoresRequirement.hacknetCores property
+
+**Signature:**
+
+```typescript
+hacknetCores: number;
+```