From 0ce5cd35dc03da86c576e6e7729d297bbc3aa84a Mon Sep 17 00:00:00 2001
From: catloversg <152669316+catloversg@users.noreply.github.com>
Date: Sun, 8 Sep 2024 07:29:23 +0700
Subject: [PATCH] DOCUMENTATION: Fix mangled NS API TSDoc (#1643)
---
....bitnodemultipliers.codingcontractmoney.md | 2 +-
...r.bitnodemultipliers.companyworkrepgain.md | 13 +++
...bitnodemultipliers.corporationdivisions.md | 2 +-
...r.bitnodemultipliers.corporationsoftcap.md | 2 +-
...ner.bitnodemultipliers.crimesuccessrate.md | 13 +++
...urner.bitnodemultipliers.ganguniqueaugs.md | 13 +++
.../bitburner.bitnodemultipliers.gopower.md | 13 +++
...tnodemultipliers.hackingspeedmultiplier.md | 13 +++
...ner.bitnodemultipliers.hacknetnodemoney.md | 2 +-
markdown/bitburner.bitnodemultipliers.md | 23 ++--
...tnodemultipliers.purchasedserversoftcap.md | 2 +-
...rner.bitnodemultipliers.scripthackmoney.md | 2 +-
....bitnodemultipliers.scripthackmoneygain.md | 2 +-
...bitnodemultipliers.staneksgiftextrasize.md | 2 +-
...emultipliers.staneksgiftpowermultiplier.md | 2 +-
markdown/bitburner.go.getboardstate.md | 11 +-
markdown/bitburner.go.getmovehistory.md | 10 +-
markdown/bitburner.go.md | 24 +---
markdown/bitburner.goanalysis.getchains.md | 12 +-
...rner.goanalysis.getcontrolledemptynodes.md | 12 +-
markdown/bitburner.goanalysis.getliberties.md | 12 +-
markdown/bitburner.goanalysis.getstats.md | 14 +--
markdown/bitburner.goanalysis.md | 52 +--------
src/BitNode/BitNodeMultipliers.ts | 20 ++--
src/ScriptEditor/NetscriptDefinitions.d.ts | 109 ++++++++----------
25 files changed, 162 insertions(+), 220 deletions(-)
create mode 100644 markdown/bitburner.bitnodemultipliers.companyworkrepgain.md
create mode 100644 markdown/bitburner.bitnodemultipliers.crimesuccessrate.md
create mode 100644 markdown/bitburner.bitnodemultipliers.ganguniqueaugs.md
create mode 100644 markdown/bitburner.bitnodemultipliers.gopower.md
create mode 100644 markdown/bitburner.bitnodemultipliers.hackingspeedmultiplier.md
diff --git a/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md b/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md
index a0eea9f25..69bc05e31 100644
--- a/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md
+++ b/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.CodingContractMoney property
-Influences the amount of money gained from completing Coding Contracts
+Influences the amount of money gained from completing Coding Contracts.
**Signature:**
diff --git a/markdown/bitburner.bitnodemultipliers.companyworkrepgain.md b/markdown/bitburner.bitnodemultipliers.companyworkrepgain.md
new file mode 100644
index 000000000..a1094ae55
--- /dev/null
+++ b/markdown/bitburner.bitnodemultipliers.companyworkrepgain.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CompanyWorkRepGain](./bitburner.bitnodemultipliers.companyworkrepgain.md)
+
+## BitNodeMultipliers.CompanyWorkRepGain property
+
+Influences how much rep the player gains when performing work for a company.
+
+**Signature:**
+
+```typescript
+CompanyWorkRepGain: number;
+```
diff --git a/markdown/bitburner.bitnodemultipliers.corporationdivisions.md b/markdown/bitburner.bitnodemultipliers.corporationdivisions.md
index 7375d1f75..283e65855 100644
--- a/markdown/bitburner.bitnodemultipliers.corporationdivisions.md
+++ b/markdown/bitburner.bitnodemultipliers.corporationdivisions.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.CorporationDivisions property
-Influences the amount of divisions a corporation can have at the same time
+Influences the amount of divisions a corporation can have at the same time.
**Signature:**
diff --git a/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md b/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md
index 0ff2d2284..ec026f0a1 100644
--- a/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md
+++ b/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.CorporationSoftcap property
-Influences the money gain from dividends of corporations created by the player.
+Influences profits from corporation dividends and selling shares.
**Signature:**
diff --git a/markdown/bitburner.bitnodemultipliers.crimesuccessrate.md b/markdown/bitburner.bitnodemultipliers.crimesuccessrate.md
new file mode 100644
index 000000000..754bd0959
--- /dev/null
+++ b/markdown/bitburner.bitnodemultipliers.crimesuccessrate.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CrimeSuccessRate](./bitburner.bitnodemultipliers.crimesuccessrate.md)
+
+## BitNodeMultipliers.CrimeSuccessRate property
+
+Influences the success chance of committing crimes
+
+**Signature:**
+
+```typescript
+CrimeSuccessRate: number;
+```
diff --git a/markdown/bitburner.bitnodemultipliers.ganguniqueaugs.md b/markdown/bitburner.bitnodemultipliers.ganguniqueaugs.md
new file mode 100644
index 000000000..0b7ba201c
--- /dev/null
+++ b/markdown/bitburner.bitnodemultipliers.ganguniqueaugs.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [GangUniqueAugs](./bitburner.bitnodemultipliers.ganguniqueaugs.md)
+
+## BitNodeMultipliers.GangUniqueAugs property
+
+Percentage of unique augs that the gang has.
+
+**Signature:**
+
+```typescript
+GangUniqueAugs: number;
+```
diff --git a/markdown/bitburner.bitnodemultipliers.gopower.md b/markdown/bitburner.bitnodemultipliers.gopower.md
new file mode 100644
index 000000000..29171f101
--- /dev/null
+++ b/markdown/bitburner.bitnodemultipliers.gopower.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [GoPower](./bitburner.bitnodemultipliers.gopower.md)
+
+## BitNodeMultipliers.GoPower property
+
+Percentage multiplier on the effect of the IPvGO rewards \*
+
+**Signature:**
+
+```typescript
+GoPower: number;
+```
diff --git a/markdown/bitburner.bitnodemultipliers.hackingspeedmultiplier.md b/markdown/bitburner.bitnodemultipliers.hackingspeedmultiplier.md
new file mode 100644
index 000000000..b5b0eb710
--- /dev/null
+++ b/markdown/bitburner.bitnodemultipliers.hackingspeedmultiplier.md
@@ -0,0 +1,13 @@
+
+
+[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HackingSpeedMultiplier](./bitburner.bitnodemultipliers.hackingspeedmultiplier.md)
+
+## BitNodeMultipliers.HackingSpeedMultiplier property
+
+Influences how quickly the player's hack(), grow() and weaken() calls run
+
+**Signature:**
+
+```typescript
+HackingSpeedMultiplier: number;
+```
diff --git a/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md b/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md
index cb2899c16..1b45a2ecf 100644
--- a/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md
+++ b/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.HacknetNodeMoney property
-Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9)
+Influences how much money is produced by Hacknet Nodes. Influences the hash rate of Hacknet Servers (unlocked in BitNode-9)
**Signature:**
diff --git a/markdown/bitburner.bitnodemultipliers.md b/markdown/bitburner.bitnodemultipliers.md
index df34706e5..2fd6e2971 100644
--- a/markdown/bitburner.bitnodemultipliers.md
+++ b/markdown/bitburner.bitnodemultipliers.md
@@ -23,14 +23,16 @@ interface BitNodeMultipliers
| [BladeburnerSkillCost](./bitburner.bitnodemultipliers.bladeburnerskillcost.md) | | number | Influences the cost of skill levels from Bladeburner. |
| [CharismaLevelMultiplier](./bitburner.bitnodemultipliers.charismalevelmultiplier.md) | | number | Influences how quickly the player's charisma level (not exp) scales |
| [ClassGymExpGain](./bitburner.bitnodemultipliers.classgymexpgain.md) | | number | Influences the experience gained for each ability when a player completes a class. |
-| [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) | | number | Influences the amount of money gained from completing Coding Contracts |
+| [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) | | number | Influences the amount of money gained from completing Coding Contracts. |
| [CompanyWorkExpGain](./bitburner.bitnodemultipliers.companyworkexpgain.md) | | number | Influences the experience gained for each ability when the player completes working their job. |
| [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md) | | number | Influences how much money the player earns when completing working their job. |
-| [CorporationDivisions](./bitburner.bitnodemultipliers.corporationdivisions.md) | | number | Influences the amount of divisions a corporation can have at the same time |
-| [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | | number | Influences the money gain from dividends of corporations created by the player. |
+| [CompanyWorkRepGain](./bitburner.bitnodemultipliers.companyworkrepgain.md) | | number | Influences how much rep the player gains when performing work for a company. |
+| [CorporationDivisions](./bitburner.bitnodemultipliers.corporationdivisions.md) | | number | Influences the amount of divisions a corporation can have at the same time. |
+| [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | | number | Influences profits from corporation dividends and selling shares. |
| [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) | | number | Influences the valuation of corporations created by the player. |
| [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md) | | number | Influences the base experience gained for each ability when the player commits a crime. |
| [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) | | number | Influences the base money gained when the player commits a crime. |
+| [CrimeSuccessRate](./bitburner.bitnodemultipliers.crimesuccessrate.md) | | number | Influences the success chance of committing crimes |
| [DaedalusAugsRequirement](./bitburner.bitnodemultipliers.daedalusaugsrequirement.md) | | number | Influences how many Augmentations you need in order to get invited to the Daedalus faction |
| [DefenseLevelMultiplier](./bitburner.bitnodemultipliers.defenselevelmultiplier.md) | | number | Influences how quickly the player's defense level (not exp) scales |
| [DexterityLevelMultiplier](./bitburner.bitnodemultipliers.dexteritylevelmultiplier.md) | | number | Influences how quickly the player's dexterity level (not exp) scales |
@@ -40,9 +42,12 @@ interface BitNodeMultipliers
| [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md) | | number | Influences how much it costs to unlock the stock market's 4S Market Data API |
| [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md) | | number | Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) |
| [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md) | | number | Influences the respect gain and money gain of your gang. |
+| [GangUniqueAugs](./bitburner.bitnodemultipliers.ganguniqueaugs.md) | | number | Percentage of unique augs that the gang has. |
+| [GoPower](./bitburner.bitnodemultipliers.gopower.md) | | number | Percentage multiplier on the effect of the IPvGO rewards \* |
| [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) | | number | Influences the experienced gained when hacking a server. |
| [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) | | number | Influences how quickly the player's hacking level (not experience) scales |
-| [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | | number | Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) |
+| [HackingSpeedMultiplier](./bitburner.bitnodemultipliers.hackingspeedmultiplier.md) | | number | Influences how quickly the player's hack(), grow() and weaken() calls run |
+| [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | | number | Influences how much money is produced by Hacknet Nodes. Influences the hash rate of Hacknet Servers (unlocked in BitNode-9) |
| [HomeComputerRamCost](./bitburner.bitnodemultipliers.homecomputerramcost.md) | | number | Influences how much money it costs to upgrade your home computer's RAM |
| [InfiltrationMoney](./bitburner.bitnodemultipliers.infiltrationmoney.md) | | number | Influences how much money is gained when the player infiltrates a company. |
| [InfiltrationRep](./bitburner.bitnodemultipliers.infiltrationrep.md) | | number | Influences how much rep the player can gain from factions when selling stolen documents and secrets |
@@ -50,17 +55,17 @@ interface BitNodeMultipliers
| [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) | | number | Influence how much it costs to purchase a server |
| [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) | | number | Influences the maximum number of purchased servers you can have |
| [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) | | number | Influences the maximum allowed RAM for a purchased server |
-| [PurchasedServerSoftcap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | | number | Influences cost of any purchased server at or above 128GB |
+| [PurchasedServerSoftcap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | | number | Influence how much it costs to purchase a server |
| [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) | | number | Influences the minimum favor the player must have with a faction before they can donate to gain rep. |
-| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | | number | Influences how much the money on a server can be reduced when a script performs a hack against it. |
-| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | | number | Influences how much of the money stolen by a scripted hack will be added to the player's money. |
+| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | | number | Influences how much money can be stolen from a server when a script performs a hack against it. |
+| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | | number | The amount of money actually gained when a script hacks a server. This is different than the above because you can reduce the amount of money but not gain that same amount. |
| [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | | number | Influences the growth percentage per cycle against a server. |
| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | | number | Influences the maximum money that a server can grow to. |
| [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | | number | Influences the initial money that a server starts with. |
| [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | | number | Influences the initial security level (hackDifficulty) of a server. |
| [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | | number | Influences the weaken amount per invocation against a server. |
-| [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) | | number | Influences the size of the gift |
-| [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) | | number | Influences the power of the gift |
+| [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) | | number | Influences the size of the gift. |
+| [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) | | number | Influences the power of the gift. |
| [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) | | number | Influences how quickly the player's strength level (not exp) scales |
| [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) | | number | Influences the hacking skill required to backdoor the world daemon. |
diff --git a/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md b/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md
index 23786f7cf..d01d5d41c 100644
--- a/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md
+++ b/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.PurchasedServerSoftcap property
-Influences cost of any purchased server at or above 128GB
+Influence how much it costs to purchase a server
**Signature:**
diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoney.md b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md
index 0b94ca152..900905b2a 100644
--- a/markdown/bitburner.bitnodemultipliers.scripthackmoney.md
+++ b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.ScriptHackMoney property
-Influences how much the money on a server can be reduced when a script performs a hack against it.
+Influences how much money can be stolen from a server when a script performs a hack against it.
**Signature:**
diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md b/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md
index a2d67aa72..b07df74cd 100644
--- a/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md
+++ b/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.ScriptHackMoneyGain property
-Influences how much of the money stolen by a scripted hack will be added to the player's money.
+The amount of money actually gained when a script hacks a server. This is different than the above because you can reduce the amount of money but not gain that same amount.
**Signature:**
diff --git a/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md b/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md
index 0facd2693..d7bc481ac 100644
--- a/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md
+++ b/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.StaneksGiftExtraSize property
-Influences the size of the gift
+Influences the size of the gift.
**Signature:**
diff --git a/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md b/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md
index 1bc5a6069..829569c54 100644
--- a/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md
+++ b/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md
@@ -4,7 +4,7 @@
## BitNodeMultipliers.StaneksGiftPowerMultiplier property
-Influences the power of the gift
+Influences the power of the gift.
**Signature:**
diff --git a/markdown/bitburner.go.getboardstate.md b/markdown/bitburner.go.getboardstate.md
index 75e5e9e20..dbeeadb2b 100644
--- a/markdown/bitburner.go.getboardstate.md
+++ b/markdown/bitburner.go.getboardstate.md
@@ -8,15 +8,8 @@ Retrieves a simplified version of the board state. "X" represents black pieces,
For example, a 5x5 board might look like this:
-```js
-[
- "XX.O.",
- "X..OO",
- ".XO..",
- "XXO.#",
- ".XO.#",
-]
-```
+\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
+
Each string represents a vertical column on the board, and each character in the string represents a point.
Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].
diff --git a/markdown/bitburner.go.getmovehistory.md b/markdown/bitburner.go.getmovehistory.md
index f3e693647..93b4c45cb 100644
--- a/markdown/bitburner.go.getmovehistory.md
+++ b/markdown/bitburner.go.getmovehistory.md
@@ -8,15 +8,7 @@ Returns all the prior moves in the current game, as an array of simple board sta
For example, a single 5x5 prior move board might look like this:
-```js
-[
- "XX.O.",
- "X..OO",
- ".XO..",
- "XXO.#",
- ".XO.#",
-]
-```
+\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
**Signature:**
diff --git a/markdown/bitburner.go.md b/markdown/bitburner.go.md
index 12f87a36b..f017983bd 100644
--- a/markdown/bitburner.go.md
+++ b/markdown/bitburner.go.md
@@ -23,30 +23,10 @@ export interface Go
| Method | Description |
| --- | --- |
-| [getBoardState()](./bitburner.go.getboardstate.md) | Retrieves a simplified version of the board state. "X" represents black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. (They are not territory nor open nodes.)
For example, a 5x5 board might look like this:
-```js
-[
- "XX.O.",
- "X..OO",
- ".XO..",
- "XXO.#",
- ".XO.#",
-]
-```
-Each string represents a vertical column on the board, and each character in the string represents a point.
Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].
Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.
|
+| [getBoardState()](./bitburner.go.getboardstate.md) | Retrieves a simplified version of the board state. "X" represents black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. (They are not territory nor open nodes.)
For example, a 5x5 board might look like this:
\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
Each string represents a vertical column on the board, and each character in the string represents a point.
Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].
Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.
|
| [getCurrentPlayer()](./bitburner.go.getcurrentplayer.md) | Returns the color of the current player, or 'None' if the game is over. |
| [getGameState()](./bitburner.go.getgamestate.md) | Gets the status of the current game. Shows the current player, current score, and the previous move coordinates. Previous move coordinates will be \[-1, -1\] for a pass, or if there are no prior moves. |
-| [getMoveHistory()](./bitburner.go.getmovehistory.md) | Returns all the prior moves in the current game, as an array of simple board states.
For example, a single 5x5 prior move board might look like this:
-```js
-[
- "XX.O.",
- "X..OO",
- ".XO..",
- "XXO.#",
- ".XO.#",
-]
-```
- |
+| [getMoveHistory()](./bitburner.go.getmovehistory.md) | Returns all the prior moves in the current game, as an array of simple board states.
For example, a single 5x5 prior move board might look like this:
\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]
|
| [getOpponent()](./bitburner.go.getopponent.md) | Returns the name of the opponent faction in the current subnet. |
| [makeMove(x, y)](./bitburner.go.makemove.md) | Make a move on the IPvGO subnet game board, and await the opponent's response. x:0 y:0 represents the bottom-left corner of the board in the UI. |
| [opponentNextTurn(logOpponentMove)](./bitburner.go.opponentnextturn.md) | Returns a promise that resolves with the success or failure state of your last move, and the AI's response, if applicable. x:0 y:0 represents the bottom-left corner of the board in the UI. |
diff --git a/markdown/bitburner.goanalysis.getchains.md b/markdown/bitburner.goanalysis.getchains.md
index 09023a8ba..ba1f61d4b 100644
--- a/markdown/bitburner.goanalysis.getchains.md
+++ b/markdown/bitburner.goanalysis.getchains.md
@@ -8,17 +8,7 @@ Returns an ID for each point. All points that share an ID are part of the same n
The data from getChains() can be used with the data from getBoardState() to see which player (or empty) each chain is
-For example, a 5x5 board might look like this. There is a large chain \#1 on the left side, smaller chains 2 and 3 on the right, and a large chain 0 taking up the center of the board.
-
-```js
-[
- [ 0,0,0,3,4],
- [ 1,0,0,3,3],
- [ 1,1,0,0,0],
- [null,1,0,2,2],
- [null,1,0,2,5],
-]
-```
+For example, a 5x5 board might look like this. There is a large chain \#1 on the left side, smaller chains 2 and 3 on the right, and a large chain 0 taking up the center of the board. \[ \[ 0,0,0,3,4\], \[ 1,0,0,3,3\], \[ 1,1,0,0,0\], \[null,1,0,2,2\], \[null,1,0,2,5\], \]
**Signature:**
diff --git a/markdown/bitburner.goanalysis.getcontrolledemptynodes.md b/markdown/bitburner.goanalysis.getcontrolledemptynodes.md
index 65d7b337c..82a9444db 100644
--- a/markdown/bitburner.goanalysis.getcontrolledemptynodes.md
+++ b/markdown/bitburner.goanalysis.getcontrolledemptynodes.md
@@ -8,17 +8,7 @@ Returns 'X', 'O', or '?' for each empty point to indicate which player controls
Filled points of any color are indicated with '.'
-In this example, white encircles some space in the top-left, black encircles some in the top-right, and between their routers is contested space in the center:
-
-```js
-[
- "OO..?",
- "OO.?.",
- "O.?.X",
- ".?.XX",
- "?..X#",
-]
-```
+In this example, white encircles some space in the top-left, black encircles some in the top-right, and between their routers is contested space in the center: \[ "OO..?", "OO.?.", "O.?.X", ".?.XX", "?..X\#", \]
**Signature:**
diff --git a/markdown/bitburner.goanalysis.getliberties.md b/markdown/bitburner.goanalysis.getliberties.md
index 74caf34a2..d99b08461 100644
--- a/markdown/bitburner.goanalysis.getliberties.md
+++ b/markdown/bitburner.goanalysis.getliberties.md
@@ -6,17 +6,7 @@
Returns a number for each point, representing how many open nodes its network/chain is connected to. Empty nodes and dead nodes are shown as -1 liberties.
-For example, a 5x5 board might look like this. The chain in the top-left touches 5 total empty nodes, and the one in the center touches four. The group in the bottom-right only has one liberty; it is in danger of being captured!
-
-```js
-[
- [-1, 5,-1,-1, 2],
- [ 5, 5,-1,-1,-1],
- [-1,-1, 4,-1,-1],
- [ 3,-1,-1, 3, 1],
- [ 3,-1,-1, 3, 1],
-]
-```
+For example, a 5x5 board might look like this. The chain in the top-left touches 5 total empty nodes, and the one in the center touches four. The group in the bottom-right only has one liberty; it is in danger of being captured! \[ \[-1, 5,-1,-1, 2\], \[ 5, 5,-1,-1,-1\], \[-1,-1, 4,-1,-1\], \[ 3,-1,-1, 3, 1\], \[ 3,-1,-1, 3, 1\], \]
**Signature:**
diff --git a/markdown/bitburner.goanalysis.getstats.md b/markdown/bitburner.goanalysis.getstats.md
index f081ba8aa..05f37cefd 100644
--- a/markdown/bitburner.goanalysis.getstats.md
+++ b/markdown/bitburner.goanalysis.getstats.md
@@ -8,19 +8,7 @@ Displays the game history, captured nodes, and gained bonuses for each opponent
The details are keyed by opponent name, in this structure:
-```js
-{
- : {
- wins: number,
- losses: number,
- winStreak: number,
- highestWinStreak: number,
- favor: number,
- bonusPercent: number,
- bonusDescription: string,
- }
-}
-```
+ { : { wins: number, losses: number, winStreak: number, highestWinStreak: number, favor: number, bonusPercent: number, bonusDescription: string, } }
**Signature:**
diff --git a/markdown/bitburner.goanalysis.md b/markdown/bitburner.goanalysis.md
index eb185e8ca..901d95911 100644
--- a/markdown/bitburner.goanalysis.md
+++ b/markdown/bitburner.goanalysis.md
@@ -16,53 +16,9 @@ export interface GoAnalysis
| Method | Description |
| --- | --- |
-| [getChains()](./bitburner.goanalysis.getchains.md) | Returns an ID for each point. All points that share an ID are part of the same network (or "chain"). Empty points are also given chain IDs to represent continuous empty space. Dead nodes are given the value null.
The data from getChains() can be used with the data from getBoardState() to see which player (or empty) each chain is
For example, a 5x5 board might look like this. There is a large chain \#1 on the left side, smaller chains 2 and 3 on the right, and a large chain 0 taking up the center of the board.
-```js
-[
- [ 0,0,0,3,4],
- [ 1,0,0,3,3],
- [ 1,1,0,0,0],
- [null,1,0,2,2],
- [null,1,0,2,5],
-]
-```
- |
-| [getControlledEmptyNodes()](./bitburner.goanalysis.getcontrolledemptynodes.md) | Returns 'X', 'O', or '?' for each empty point to indicate which player controls that empty point. If no single player fully encircles the empty space, it is shown as contested with '?'. "\#" are dead nodes that are not part of the subnet.
Filled points of any color are indicated with '.'
In this example, white encircles some space in the top-left, black encircles some in the top-right, and between their routers is contested space in the center:
-```js
-[
- "OO..?",
- "OO.?.",
- "O.?.X",
- ".?.XX",
- "?..X#",
-]
-```
- |
-| [getLiberties()](./bitburner.goanalysis.getliberties.md) | Returns a number for each point, representing how many open nodes its network/chain is connected to. Empty nodes and dead nodes are shown as -1 liberties.
For example, a 5x5 board might look like this. The chain in the top-left touches 5 total empty nodes, and the one in the center touches four. The group in the bottom-right only has one liberty; it is in danger of being captured!
-```js
-[
- [-1, 5,-1,-1, 2],
- [ 5, 5,-1,-1,-1],
- [-1,-1, 4,-1,-1],
- [ 3,-1,-1, 3, 1],
- [ 3,-1,-1, 3, 1],
-]
-```
- |
-| [getStats()](./bitburner.goanalysis.getstats.md) | Displays the game history, captured nodes, and gained bonuses for each opponent you have played against.
The details are keyed by opponent name, in this structure:
-```js
-{
- : {
- wins: number,
- losses: number,
- winStreak: number,
- highestWinStreak: number,
- favor: number,
- bonusPercent: number,
- bonusDescription: string,
- }
-}
-```
- |
+| [getChains()](./bitburner.goanalysis.getchains.md) | Returns an ID for each point. All points that share an ID are part of the same network (or "chain"). Empty points are also given chain IDs to represent continuous empty space. Dead nodes are given the value null.
The data from getChains() can be used with the data from getBoardState() to see which player (or empty) each chain is
For example, a 5x5 board might look like this. There is a large chain \#1 on the left side, smaller chains 2 and 3 on the right, and a large chain 0 taking up the center of the board.
\[ \[ 0,0,0,3,4\], \[ 1,0,0,3,3\], \[ 1,1,0,0,0\], \[null,1,0,2,2\], \[null,1,0,2,5\], \]
|
+| [getControlledEmptyNodes()](./bitburner.goanalysis.getcontrolledemptynodes.md) | Returns 'X', 'O', or '?' for each empty point to indicate which player controls that empty point. If no single player fully encircles the empty space, it is shown as contested with '?'. "\#" are dead nodes that are not part of the subnet.
Filled points of any color are indicated with '.'
In this example, white encircles some space in the top-left, black encircles some in the top-right, and between their routers is contested space in the center:
\[ "OO..?", "OO.?.", "O.?.X", ".?.XX", "?..X\#", \]
|
+| [getLiberties()](./bitburner.goanalysis.getliberties.md) | Returns a number for each point, representing how many open nodes its network/chain is connected to. Empty nodes and dead nodes are shown as -1 liberties.
For example, a 5x5 board might look like this. The chain in the top-left touches 5 total empty nodes, and the one in the center touches four. The group in the bottom-right only has one liberty; it is in danger of being captured!
\[ \[-1, 5,-1,-1, 2\], \[ 5, 5,-1,-1,-1\], \[-1,-1, 4,-1,-1\], \[ 3,-1,-1, 3, 1\], \[ 3,-1,-1, 3, 1\], \]
|
+| [getStats()](./bitburner.goanalysis.getstats.md) | Displays the game history, captured nodes, and gained bonuses for each opponent you have played against.
The details are keyed by opponent name, in this structure:
{ : { wins: number, losses: number, winStreak: number, highestWinStreak: number, favor: number, bonusPercent: number, bonusDescription: string, } } |
| [getValidMoves()](./bitburner.goanalysis.getvalidmoves.md) | Shows if each point on the board is a valid move for the player.
The true/false validity of each move can be retrieved via the X and Y coordinates of the move. const validMoves = ns.go.analysis.getValidMoves();
const moveIsValid = validMoves[x][y];
Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.
|
diff --git a/src/BitNode/BitNodeMultipliers.ts b/src/BitNode/BitNodeMultipliers.ts
index 277b8dbe6..0d65bc3d1 100644
--- a/src/BitNode/BitNodeMultipliers.ts
+++ b/src/BitNode/BitNodeMultipliers.ts
@@ -27,7 +27,7 @@ export class BitNodeMultipliers {
/** Influences the experience gained for each ability when a player completes a class. */
ClassGymExpGain = 1;
- /**Influences the amount of money gained from completing Coding Contracts. */
+ /** Influences the amount of money gained from completing Coding Contracts. */
CodingContractMoney = 1;
/** Influences the experience gained for each ability when the player completes working their job. */
@@ -39,6 +39,12 @@ export class BitNodeMultipliers {
/** Influences how much rep the player gains when performing work for a company. */
CompanyWorkRepGain = 1;
+ /** Influences the amount of divisions a corporation can have at the same time. */
+ CorporationDivisions = 1;
+
+ /** Influences profits from corporation dividends and selling shares. */
+ CorporationSoftcap = 1;
+
/** Influences the valuation of corporations created by the player. */
CorporationValuation = 1;
@@ -48,7 +54,7 @@ export class BitNodeMultipliers {
/** Influences the base money gained when the player commits a crime. */
CrimeMoney = 1;
- /** influences the success chance of committing crimes */
+ /** Influences the success chance of committing crimes */
CrimeSuccessRate = 1;
/** Influences how many Augmentations you need in order to get invited to the Daedalus faction */
@@ -75,7 +81,7 @@ export class BitNodeMultipliers {
/** Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) */
FourSigmaMarketDataCost = 1;
- /** Reduces gangs earning. */
+ /** Influences the respect gain and money gain of your gang. */
GangSoftcap = 1;
/** Percentage of unique augs that the gang has. */
@@ -133,7 +139,7 @@ export class BitNodeMultipliers {
ScriptHackMoney = 1;
/**
- * The amount of money actually gained when script hack a server. This is
+ * The amount of money actually gained when a script hacks a server. This is
* different than the above because you can reduce the amount of money but
* not gain that same amount.
*/
@@ -166,12 +172,6 @@ export class BitNodeMultipliers {
/** Influences the hacking skill required to backdoor the world daemon. */
WorldDaemonDifficulty = 1;
- /** Influences profits from corporation dividends and selling shares. */
- CorporationSoftcap = 1;
-
- /** Influences the amount of divisions a corporation can have have at the same time*/
- CorporationDivisions = 1;
-
constructor(a: PartialRecord = {}) {
for (const [key, value] of getRecordEntries(a)) this[key] = clampNumber(value);
}
diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts
index 54b615512..1c4f63502 100644
--- a/src/ScriptEditor/NetscriptDefinitions.d.ts
+++ b/src/ScriptEditor/NetscriptDefinitions.d.ts
@@ -653,7 +653,7 @@ interface BitNodeMultipliers {
CharismaLevelMultiplier: number;
/** Influences the experience gained for each ability when a player completes a class. */
ClassGymExpGain: number;
- /**Influences the amount of money gained from completing Coding Contracts. */
+ /** Influences the amount of money gained from completing Coding Contracts. */
CodingContractMoney: number;
/** Influences the experience gained for each ability when the player completes working their job. */
CompanyWorkExpGain: number;
@@ -661,13 +661,17 @@ interface BitNodeMultipliers {
CompanyWorkMoney: number;
/** Influences how much rep the player gains when performing work for a company. */
CompanyWorkRepGain: number;
+ /** Influences the amount of divisions a corporation can have at the same time. */
+ CorporationDivisions: number;
+ /** Influences profits from corporation dividends and selling shares. */
+ CorporationSoftcap: number;
/** Influences the valuation of corporations created by the player. */
CorporationValuation: number;
/** Influences the base experience gained for each ability when the player commits a crime. */
CrimeExpGain: number;
/** Influences the base money gained when the player commits a crime. */
CrimeMoney: number;
- /** influences the success chance of committing crimes */
+ /** Influences the success chance of committing crimes */
CrimeSuccessRate: number;
/** Influences how many Augmentations you need in order to get invited to the Daedalus faction */
DaedalusAugsRequirement: number;
@@ -685,7 +689,7 @@ interface BitNodeMultipliers {
FourSigmaMarketDataApiCost: number;
/** Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) */
FourSigmaMarketDataCost: number;
- /** Reduces gangs earning. */
+ /** Influences the respect gain and money gain of your gang. */
GangSoftcap: number;
/** Percentage of unique augs that the gang has. */
GangUniqueAugs: number;
@@ -726,7 +730,7 @@ interface BitNodeMultipliers {
/** Influences how much money can be stolen from a server when a script performs a hack against it. */
ScriptHackMoney: number;
/**
- * The amount of money actually gained when script hack a server. This is
+ * The amount of money actually gained when a script hacks a server. This is
* different than the above because you can reduce the amount of money but
* not gain that same amount.
*/
@@ -749,10 +753,6 @@ interface BitNodeMultipliers {
StaneksGiftExtraSize: number;
/** Influences the hacking skill required to backdoor the world daemon. */
WorldDaemonDifficulty: number;
- /** Influences profits from corporation dividends and selling shares. */
- CorporationSoftcap: number;
- /** Influences the amount of divisions a corporation can have have at the same time*/
- CorporationDivisions: number;
}
/**
@@ -4260,16 +4260,15 @@ export interface GoAnalysis {
*
* For example, a 5x5 board might look like this. There is a large chain #1 on the left side, smaller chains
* 2 and 3 on the right, and a large chain 0 taking up the center of the board.
- *
- * ```js
- * [
- * [ 0,0,0,3,4],
- * [ 1,0,0,3,3],
- * [ 1,1,0,0,0],
- * [null,1,0,2,2],
- * [null,1,0,2,5],
- * ]
- * ```
+ *
+ * [
+ * [ 0,0,0,3,4],
+ * [ 1,0,0,3,3],
+ * [ 1,1,0,0,0],
+ * [null,1,0,2,2],
+ * [null,1,0,2,5],
+ * ]
+ *
*
* @remarks
* RAM cost: 16 GB
@@ -4284,16 +4283,15 @@ export interface GoAnalysis {
*
* For example, a 5x5 board might look like this. The chain in the top-left touches 5 total empty nodes, and the one
* in the center touches four. The group in the bottom-right only has one liberty; it is in danger of being captured!
- *
- * ```js
- * [
- * [-1, 5,-1,-1, 2],
- * [ 5, 5,-1,-1,-1],
- * [-1,-1, 4,-1,-1],
- * [ 3,-1,-1, 3, 1],
- * [ 3,-1,-1, 3, 1],
- * ]
- * ```
+ *
+ * [
+ * [-1, 5,-1,-1, 2],
+ * [ 5, 5,-1,-1,-1],
+ * [-1,-1, 4,-1,-1],
+ * [ 3,-1,-1, 3, 1],
+ * [ 3,-1,-1, 3, 1],
+ * ]
+ *
*
* @remarks
* RAM cost: 16 GB
@@ -4309,16 +4307,15 @@ export interface GoAnalysis {
* Filled points of any color are indicated with '.'
*
* In this example, white encircles some space in the top-left, black encircles some in the top-right, and between their routers is contested space in the center:
- *
- * ```js
- * [
- * "OO..?",
- * "OO.?.",
- * "O.?.X",
- * ".?.XX",
- * "?..X#",
- * ]
- * ```
+ *
+ * [
+ * "OO..?",
+ * "OO.?.",
+ * "O.?.X",
+ * ".?.XX",
+ * "?..X#",
+ * ]
+ *
*
* @remarks
* RAM cost: 16 GB
@@ -4331,7 +4328,7 @@ export interface GoAnalysis {
*
* The details are keyed by opponent name, in this structure:
*
- * ```js
+ *
* {
* : {
* wins: number,
@@ -4343,7 +4340,7 @@ export interface GoAnalysis {
* bonusDescription: string,
* }
* }
- * ```
+ *
*/
getStats(): Partial>;
}
@@ -4527,15 +4524,13 @@ export interface Go {
*
* For example, a 5x5 board might look like this:
*
- * ```js
- * [
- * "XX.O.",
- * "X..OO",
- * ".XO..",
- * "XXO.#",
- * ".XO.#",
- * ]
- * ```
+ [
+ "XX.O.",
+ "X..OO",
+ ".XO..",
+ "XXO.#",
+ ".XO.#",
+ ]
*
* Each string represents a vertical column on the board, and each character in the string represents a point.
*
@@ -4555,15 +4550,13 @@ export interface Go {
*
* For example, a single 5x5 prior move board might look like this:
*
- * ```js
- * [
- * "XX.O.",
- * "X..OO",
- * ".XO..",
- * "XXO.#",
- * ".XO.#",
- * ]
- * ```
+ [
+ "XX.O.",
+ "X..OO",
+ ".XO..",
+ "XXO.#",
+ ".XO.#",
+ ]
*/
getMoveHistory(): string[][];