work on making sure all the functions are accounted for

InfraK · Nov 3, 2021 · c5fb515 · c5fb515
1 parent 2578ea5
commit c5fb515
Show file tree

Hide file tree

Showing 124 changed files with 2,775 additions and 2,204 deletions.
diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts
diff --git a/electron/icon.icns b/electron/icon.icns
diff --git a/electron/icon.ico b/electron/icon.ico
diff --git a/electron/main.js b/electron/main.js
@@ -5,15 +5,15 @@ function createWindow() {
   const win = new BrowserWindow({
     show: false,
     webPreferences: {
-      devTools: true,
+      // devTools: true,
     },
   });
 
   win.removeMenu();
   win.maximize();
   win.loadFile("index.html");
   win.show();
-  win.webContents.openDevTools();
+  // win.webContents.openDevTools();
   globalShortcut.register("f5", function () {
     win.loadFile("index.html");
   });

diff --git a/electron/package.json b/electron/package.json
@@ -3,5 +3,22 @@
   "version": "1.0.0",
   "description": "A cyberpunk-themed programming incremental game",
   "main": "main.js",
-  "author": "Daniel Xie"
+  "author": "Daniel Xie & Olivier Gagnon",
+  "mac": {
+    "icon": "./public/icons/mac/icon.icns",    
+    "category": "public.app-category.games"
+  },
+  "win": {
+    "icon": "./public/icons/png/256x256.png" 
+  },
+  "files": [
+    "./build/**/*",
+    "./dist/**/*",
+    "./node_modules/**/*",
+    "./public/**/*",      
+    "*.js"
+  ],
+  "directories": {
+    "buildResources": "public"
+  }
 }
diff --git a/input/bitburner.api.json b/input/bitburner.api.json
diff --git a/markdown/bitburner.augmentationstats.md b/markdown/bitburner.augmentationstats.md
@@ -9,7 +9,7 @@ Data representing the internal values of an Augmentation.
 <b>Signature:</b>
 
 ```typescript
-interface AugmentationStats 
+export interface AugmentationStats 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.augmentpair.md b/markdown/bitburner.augmentpair.md
@@ -9,7 +9,7 @@ Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasab
 <b>Signature:</b>
 
 ```typescript
-interface AugmentPair 
+export interface AugmentPair 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.basichgwoptions.md b/markdown/bitburner.basichgwoptions.md
@@ -9,7 +9,7 @@ Options to affect the behavior of [hack](./bitburner.ns.hack.md)<!-- -->, [grow]
 <b>Signature:</b>
 
 ```typescript
-interface BasicHGWOptions 
+export interface BasicHGWOptions 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.bitnodemultipliers.md b/markdown/bitburner.bitnodemultipliers.md
@@ -9,7 +9,7 @@ All multipliers affecting the difficulty of the current challenge.
 <b>Signature:</b>
 
 ```typescript
-interface BitNodeMultipliers 
+export interface BitNodeMultipliers 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.bladeburnercuraction.md b/markdown/bitburner.bladeburnercuraction.md
@@ -9,7 +9,7 @@ Bladeburner current action.
 <b>Signature:</b>
 
 ```typescript
-interface BladeburnerCurAction 
+export interface BladeburnerCurAction 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.characterinfo.md b/markdown/bitburner.characterinfo.md
@@ -8,7 +8,7 @@
 <b>Signature:</b>
 
 ```typescript
-interface CharacterInfo 
+export interface CharacterInfo 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.charactermult.md b/markdown/bitburner.charactermult.md
@@ -8,7 +8,7 @@
 <b>Signature:</b>
 
 ```typescript
-interface CharacterMult 
+export interface CharacterMult 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.codingattemptoptions.md b/markdown/bitburner.codingattemptoptions.md
@@ -9,7 +9,7 @@ Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md
 <b>Signature:</b>
 
 ```typescript
-interface CodingAttemptOptions 
+export interface CodingAttemptOptions 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.codingcontract.md b/markdown/bitburner.codingcontract.md
@@ -9,7 +9,7 @@ Coding Contact API
 <b>Signature:</b>
 
 ```typescript
-interface CodingContract 
+export interface CodingContract 
 ```
 
 ## Methods

diff --git a/markdown/bitburner.crimestats.md b/markdown/bitburner.crimestats.md
@@ -9,7 +9,7 @@ Data representing the internal values of a crime.
 <b>Signature:</b>
 
 ```typescript
-interface CrimeStats 
+export interface CrimeStats 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.equipmentstats.md b/markdown/bitburner.equipmentstats.md
@@ -9,7 +9,7 @@ Object representing data representing a gang member equipment.
 <b>Signature:</b>
 
 ```typescript
-interface EquipmentStats 
+export interface EquipmentStats 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.gang.creategang.md b/markdown/bitburner.gang.creategang.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; [Gang](./bitburner.gang.md) &gt; [createGang](./bitburner.gang.creategang.md)
+
+## Gang.createGang() method
+
+Create a gang.
+
+<b>Signature:</b>
+
+```typescript
+createGang(faction: string): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  faction | string |  |
+
+<b>Returns:</b>
+
+boolean
+
+True if the gang was created, false otherwise.
+
+## Remarks
+
+RAM cost: 1GB
+
+Create a gang with the specified faction.
+
diff --git a/markdown/bitburner.gang.ingang.md b/markdown/bitburner.gang.ingang.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Gang](./bitburner.gang.md) &gt; [inGang](./bitburner.gang.ingang.md)
+
+## Gang.inGang() method
+
+Check if you're in a gang.
+
+<b>Signature:</b>
+
+```typescript
+inGang(): boolean;
+```
+<b>Returns:</b>
+
+boolean
+
+True if you're in a gang, false otherwise.
+
+## Remarks
+
+RAM cost: 1GB
+
diff --git a/markdown/bitburner.gang.md b/markdown/bitburner.gang.md
@@ -9,7 +9,7 @@ Gang API
 <b>Signature:</b>
 
 ```typescript
-interface Gang 
+export interface Gang 
 ```
 
 ## Remarks
@@ -22,6 +22,7 @@ If you are not in BitNode-2, then you must have Source-File 2 in order to use th
 |  --- | --- |
 |  [ascendMember(memberName)](./bitburner.gang.ascendmember.md) | Ascend a gang member. |
 |  [canRecruitMember()](./bitburner.gang.canrecruitmember.md) | Check if you can recruit a new gang member. |
+|  [createGang(faction)](./bitburner.gang.creategang.md) | Create a gang. |
 |  [getBonusTime()](./bitburner.gang.getbonustime.md) | Get bonus time. |
 |  [getChanceToWinClash(gangName)](./bitburner.gang.getchancetowinclash.md) | Get chance to win clash with other gang. |
 |  [getEquipmentCost(equipName)](./bitburner.gang.getequipmentcost.md) | Get cost of equipment. |
@@ -34,6 +35,7 @@ If you are not in BitNode-2, then you must have Source-File 2 in order to use th
 |  [getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) | Get information about the other gangs. |
 |  [getTaskNames()](./bitburner.gang.gettasknames.md) | List member task names. |
 |  [getTaskStats(name)](./bitburner.gang.gettaskstats.md) | Get stats of a task. |
+|  [inGang()](./bitburner.gang.ingang.md) | Check if you're in a gang. |
 |  [purchaseEquipment(memberName, equipName)](./bitburner.gang.purchaseequipment.md) | Purchase an equipment for a gang member. |
 |  [recruitMember(name)](./bitburner.gang.recruitmember.md) | Recruit a new gang member. |
 |  [setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) | Set gang member to task. |

diff --git a/markdown/bitburner.ganggeninfo.md b/markdown/bitburner.ganggeninfo.md
@@ -9,7 +9,7 @@ Gang general info.
 <b>Signature:</b>
 
 ```typescript
-interface GangGenInfo 
+export interface GangGenInfo 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.gangmemberascension.md b/markdown/bitburner.gangmemberascension.md
@@ -8,7 +8,7 @@
 <b>Signature:</b>
 
 ```typescript
-interface GangMemberAscension 
+export interface GangMemberAscension 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.gangmemberinfo.md b/markdown/bitburner.gangmemberinfo.md
@@ -8,7 +8,7 @@
 <b>Signature:</b>
 
 ```typescript
-interface GangMemberInfo 
+export interface GangMemberInfo 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.gangotherinfo.md b/markdown/bitburner.gangotherinfo.md
@@ -8,5 +8,5 @@
 <b>Signature:</b>
 
 ```typescript
-interface GangOtherInfo 
+export interface GangOtherInfo 
 ```
diff --git a/markdown/bitburner.gangotherinfoobject.md b/markdown/bitburner.gangotherinfoobject.md
@@ -8,7 +8,7 @@
 <b>Signature:</b>
 
 ```typescript
-interface GangOtherInfoObject 
+export interface GangOtherInfoObject 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.gangtaskstats.md b/markdown/bitburner.gangtaskstats.md
@@ -9,7 +9,7 @@ Object representing data representing a gang member task.
 <b>Signature:</b>
 
 ```typescript
-interface GangTaskStats 
+export interface GangTaskStats 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.gangterritory.md b/markdown/bitburner.gangterritory.md
@@ -8,7 +8,7 @@
 <b>Signature:</b>
 
 ```typescript
-interface GangTerritory 
+export interface GangTerritory 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.hackingmultipliers.md b/markdown/bitburner.hackingmultipliers.md
@@ -9,7 +9,7 @@ Hack related multipliers.
 <b>Signature:</b>
 
 ```typescript
-interface HackingMultipliers 
+export interface HackingMultipliers 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.hacknet.md b/markdown/bitburner.hacknet.md
@@ -9,7 +9,7 @@ Hacknet API
 <b>Signature:</b>
 
 ```typescript
-interface Hacknet 
+export interface Hacknet 
 ```
 
 ## Remarks

diff --git a/markdown/bitburner.hacknetmultipliers.md b/markdown/bitburner.hacknetmultipliers.md
@@ -9,7 +9,7 @@ Hacknet related multipliers.
 <b>Signature:</b>
 
 ```typescript
-interface HacknetMultipliers 
+export interface HacknetMultipliers 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.nodestats.md b/markdown/bitburner.nodestats.md
@@ -9,7 +9,7 @@ Object representing all the values related to a hacknet node.
 <b>Signature:</b>
 
 ```typescript
-interface NodeStats 
+export interface NodeStats 
 ```
 
 ## Properties

diff --git a/markdown/bitburner.ns.args.md b/markdown/bitburner.ns.args.md
@@ -14,7 +14,9 @@ readonly args: (string | number)[];
 
 ## Remarks
 
-RAM cost: 0 GB Arguments passed into a script can be accessed using a normal array using the \[\] operator (args\[0\], args\[1\], etc…).
+RAM cost: 0 GB
+
+Arguments passed into a script can be accessed using a normal array using the \[\] operator (args\[0\], args\[1\], etc…).
 
 It is also possible to get the number of arguments that was passed into a script using: 'args.length' WARNING: Do not try to modify the args array. This will break the game.
 
diff --git a/markdown/bitburner.ns.brutessh.md b/markdown/bitburner.ns.brutessh.md
@@ -4,7 +4,7 @@
 
 ## NS.brutessh() method
 
-Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer.
+Runs BruteSSH.exe on a server.
 
 <b>Signature:</b>
 
@@ -26,6 +26,8 @@ void
 
 RAM cost: 0.05 GB
 
+Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer.
+
 ## Example
 
 

diff --git a/markdown/bitburner.ns.clear.md b/markdown/bitburner.ns.clear.md
@@ -4,11 +4,7 @@
 
 ## NS.clear() method
 
-This function is used to clear data in a Netscript Ports or a text file.
-
-If the port/fn argument is a number between 1 and 20, then it specifies a port and will clear it (deleting all data from the underlying queue).
-
-If the port/fn argument is a string, then it specifies the name of a text file (.txt) and will delete all data from that text file.
+Clear data from a port.
 
 <b>Signature:</b>
 
@@ -28,5 +24,11 @@ void
 
 ## Remarks
 
-RAM cost: 1 GB
+RAM cost: 0 GB
+
+This function is used to clear data in a Netscript Ports or a text file.
+
+If the port/fn argument is a number between 1 and 20, then it specifies a port and will clear it (deleting all data from the underlying queue).
+
+If the port/fn argument is a string, then it specifies the name of a text file (.txt) and will delete all data from that text file.
 
diff --git a/markdown/bitburner.ns.deleteserver.md b/markdown/bitburner.ns.deleteserver.md
@@ -4,9 +4,7 @@
 
 ## NS.deleteServer() method
 
-Deletes one of your purchased servers, which is specified by its hostname.
-
-The hostname argument can be any data type, but it will be converted to a string. Whitespace is automatically removed from the string. This function will not delete a server that still has scripts running on it.
+Delete a purchased server.
 
 <b>Signature:</b>
 
@@ -30,3 +28,7 @@ True if successful, and false otherwise.
 
 2.25 GB
 
+Deletes one of your purchased servers, which is specified by its hostname.
+
+The hostname argument can be any data type, but it will be converted to a string. Whitespace is automatically removed from the string. This function will not delete a server that still has scripts running on it.
+