NETSCRIPT: Add Singularity.getFactionEnemies() (#1192)

markdown/bitburner.singularity.getfactionenemies.md

@@ -0,0 +1,32 @@
+<!-- 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; [getFactionEnemies](./bitburner.singularity.getfactionenemies.md)
+
+## Singularity.getFactionEnemies() method
+
+Get a list of enemies of a faction.
+
+**Signature:**
+
+```typescript
+getFactionEnemies(faction: string): string[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  faction | string | Name of faction. |
+
+**Returns:**
+
+string\[\]
+
+Array containing the names of all enemies of the faction.
+
+## Remarks
+
+RAM cost: 3 GB \* 16/4/1
+
+Returns an array containing the names (as strings) of all factions that are enemies of the specified faction.
+

markdown/bitburner.singularity.md

@@ -48,6 +48,7 @@ This API requires Source-File 4 to use. The RAM cost of all these functions is m
 |  [getCurrentWork()](./bitburner.singularity.getcurrentwork.md) | Get the current work the player is doing. |
 |  [getDarkwebProgramCost(programName)](./bitburner.singularity.getdarkwebprogramcost.md) | Check the price of an exploit on the dark web |
 |  [getDarkwebPrograms()](./bitburner.singularity.getdarkwebprograms.md) | Get a list of programs offered on the dark web. |
+|  [getFactionEnemies(faction)](./bitburner.singularity.getfactionenemies.md) | Get a list of enemies of a faction. |
 |  [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | Get faction favor. |
 |  [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | Get faction favor gain. |
 |  [getFactionInviteRequirements(faction)](./bitburner.singularity.getfactioninviterequirements.md) | List conditions for being invited to a faction. |

src/Netscript/RamCostGenerator.ts

@@ -182,6 +182,7 @@ const singularity = {
   getCompanyFavor: SF4Cost(RamCostConstants.SingularityFn2 / 3),
   getCompanyFavorGain: SF4Cost(RamCostConstants.SingularityFn2 / 4),
   getFactionInviteRequirements: SF4Cost(RamCostConstants.SingularityFn2),
+  getFactionEnemies: SF4Cost(RamCostConstants.SingularityFn2),
   checkFactionInvitations: SF4Cost(RamCostConstants.SingularityFn2),
   joinFaction: SF4Cost(RamCostConstants.SingularityFn2),
   workForFaction: SF4Cost(RamCostConstants.SingularityFn2),

src/NetscriptFunctions/Singularity.ts

@@ -768,6 +768,12 @@ export function NetscriptSingularity(): InternalAPI<ISingularity> {
       const fac = Factions[facName];
       return [...fac.getInfo().inviteReqs].map((condition) => condition.toJSON());
     },
+    getFactionEnemies: (ctx) => (_facName) => {
+      helpers.checkSingularityAccess(ctx);
+      const facName = getEnumHelper("FactionName").nsGetMember(ctx, _facName);
+      const fac = Factions[facName];
+      return fac.getInfo().enemies.slice();
+    },
     checkFactionInvitations: (ctx) => () => {
       helpers.checkSingularityAccess(ctx);
       // Manually trigger a check for faction invites

src/ScriptEditor/NetscriptDefinitions.d.ts

@@ -2077,6 +2077,20 @@ export interface Singularity {
    */
   getFactionInviteRequirements(faction: string): PlayerRequirement[];
 
+  /**
+   * Get a list of enemies of a faction.
+   * @remarks
+   * RAM cost: 3 GB * 16/4/1
+   *
+   *
+   * Returns an array containing the names (as strings) of all factions
+   * that are enemies of the specified faction.
+   *
+   * @param faction - Name of faction.
+   * @returns Array containing the names of all enemies of the faction.
+   */
+  getFactionEnemies(faction: string): string[];
+
   /**
    * List all current faction invitations.
    * @remarks