mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-12-31 02:17:39 +01:00
DOCUMENTATION: Fix mangled NS API TSDoc (#1643)
This commit is contained in:
catloversg
GitHub
parent
17e906cd76
commit
0ce5cd35dc
@ -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:**
|
||||
|
||||
|
||||
13
markdown/bitburner.bitnodemultipliers.companyworkrepgain.md
Normal file
13
markdown/bitburner.bitnodemultipliers.companyworkrepgain.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[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;
|
||||
```
|
||||
@ -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:**
|
||||
|
||||
|
||||
@ -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:**
|
||||
|
||||
|
||||
13
markdown/bitburner.bitnodemultipliers.crimesuccessrate.md
Normal file
13
markdown/bitburner.bitnodemultipliers.crimesuccessrate.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[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;
|
||||
```
|
||||
13
markdown/bitburner.bitnodemultipliers.ganguniqueaugs.md
Normal file
13
markdown/bitburner.bitnodemultipliers.ganguniqueaugs.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[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;
|
||||
```
|
||||
13
markdown/bitburner.bitnodemultipliers.gopower.md
Normal file
13
markdown/bitburner.bitnodemultipliers.gopower.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[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;
|
||||
```
|
||||
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[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;
|
||||
```
|
||||
@ -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:**
|
||||
|
||||
|
||||
@ -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. |
|
||||
|
||||
|
||||
@ -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:**
|
||||
|
||||
|
||||
@ -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:**
|
||||
|
||||
|
||||
@ -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:**
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
## BitNodeMultipliers.StaneksGiftExtraSize property
|
||||
|
||||
Influences the size of the gift
|
||||
Influences the size of the gift.
|
||||
|
||||
**Signature:**
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@
|
||||
|
||||
## BitNodeMultipliers.StaneksGiftPowerMultiplier property
|
||||
|
||||
Influences the power of the gift
|
||||
Influences the power of the gift.
|
||||
|
||||
**Signature:**
|
||||
|
||||
|
||||
@ -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.#",
|
||||
]
|
||||
```
|
||||
\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]
|
||||
|
||||
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\].
|
||||
|
||||
@ -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.#",
|
||||
]
|
||||
```
|
||||
\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]
|
||||
|
||||
**Signature:**
|
||||
|
||||
|
||||
@ -23,30 +23,10 @@ export interface Go
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [getBoardState()](./bitburner.go.getboardstate.md) | <p>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.)</p><p>For example, a 5x5 board might look like this:</p>
|
||||
```js
|
||||
[
|
||||
"XX.O.",
|
||||
"X..OO",
|
||||
".XO..",
|
||||
"XXO.#",
|
||||
".XO.#",
|
||||
]
|
||||
```
|
||||
<p>Each string represents a vertical column on the board, and each character in the string represents a point.</p><p>Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].</p><p>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.</p> |
|
||||
| [getBoardState()](./bitburner.go.getboardstate.md) | <p>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.)</p><p>For example, a 5x5 board might look like this:</p><p>\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]</p><p>Each string represents a vertical column on the board, and each character in the string represents a point.</p><p>Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].</p><p>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.</p> |
|
||||
| [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) | <p>Returns all the prior moves in the current game, as an array of simple board states.</p><p>For example, a single 5x5 prior move board might look like this:</p>
|
||||
```js
|
||||
[
|
||||
"XX.O.",
|
||||
"X..OO",
|
||||
".XO..",
|
||||
"XXO.#",
|
||||
".XO.#",
|
||||
]
|
||||
```
|
||||
|
|
||||
| [getMoveHistory()](./bitburner.go.getmovehistory.md) | <p>Returns all the prior moves in the current game, as an array of simple board states.</p><p>For example, a single 5x5 prior move board might look like this:</p><p>\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]</p> |
|
||||
| [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. |
|
||||
|
||||
@ -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. <pre lang="javascript"> \[ \[ 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\], \] </pre>
|
||||
|
||||
**Signature:**
|
||||
|
||||
|
||||
@ -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: <pre lang="javascript"> \[ "OO..?", "OO.?.", "O.?.X", ".?.XX", "?..X\#", \] </pre>
|
||||
|
||||
**Signature:**
|
||||
|
||||
|
||||
@ -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! <pre lang="javascript"> \[ \[-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\], \] </pre>
|
||||
|
||||
**Signature:**
|
||||
|
||||
|
||||
@ -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
|
||||
{
|
||||
<OpponentName>: {
|
||||
wins: number,
|
||||
losses: number,
|
||||
winStreak: number,
|
||||
highestWinStreak: number,
|
||||
favor: number,
|
||||
bonusPercent: number,
|
||||
bonusDescription: string,
|
||||
}
|
||||
}
|
||||
```
|
||||
<pre lang="javascript"> { <OpponentName>: { wins: number, losses: number, winStreak: number, highestWinStreak: number, favor: number, bonusPercent: number, bonusDescription: string, } } </pre>
|
||||
|
||||
**Signature:**
|
||||
|
||||
|
||||
@ -16,53 +16,9 @@ export interface GoAnalysis
|
||||
|
||||
| Method | Description |
|
||||
| --- | --- |
|
||||
| [getChains()](./bitburner.goanalysis.getchains.md) | <p>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 <code>null.</code></p><p>The data from getChains() can be used with the data from getBoardState() to see which player (or empty) each chain is</p><p>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.</p>
|
||||
```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) | <p>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.</p><p>Filled points of any color are indicated with '.'</p><p>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:</p>
|
||||
```js
|
||||
[
|
||||
"OO..?",
|
||||
"OO.?.",
|
||||
"O.?.X",
|
||||
".?.XX",
|
||||
"?..X#",
|
||||
]
|
||||
```
|
||||
|
|
||||
| [getLiberties()](./bitburner.goanalysis.getliberties.md) | <p>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.</p><p>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!</p>
|
||||
```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) | <p>Displays the game history, captured nodes, and gained bonuses for each opponent you have played against.</p><p>The details are keyed by opponent name, in this structure:</p>
|
||||
```js
|
||||
{
|
||||
<OpponentName>: {
|
||||
wins: number,
|
||||
losses: number,
|
||||
winStreak: number,
|
||||
highestWinStreak: number,
|
||||
favor: number,
|
||||
bonusPercent: number,
|
||||
bonusDescription: string,
|
||||
}
|
||||
}
|
||||
```
|
||||
|
|
||||
| [getChains()](./bitburner.goanalysis.getchains.md) | <p>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 <code>null.</code></p><p>The data from getChains() can be used with the data from getBoardState() to see which player (or empty) each chain is</p><p>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. <pre lang="javascript"> \[ \[ 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\], \] </pre></p> |
|
||||
| [getControlledEmptyNodes()](./bitburner.goanalysis.getcontrolledemptynodes.md) | <p>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.</p><p>Filled points of any color are indicated with '.'</p><p>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: <pre lang="javascript"> \[ "OO..?", "OO.?.", "O.?.X", ".?.XX", "?..X\#", \] </pre></p> |
|
||||
| [getLiberties()](./bitburner.goanalysis.getliberties.md) | <p>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.</p><p>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! <pre lang="javascript"> \[ \[-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\], \] </pre></p> |
|
||||
| [getStats()](./bitburner.goanalysis.getstats.md) | <p>Displays the game history, captured nodes, and gained bonuses for each opponent you have played against.</p><p>The details are keyed by opponent name, in this structure:</p><p><pre lang="javascript"> { <OpponentName>: { wins: number, losses: number, winStreak: number, highestWinStreak: number, favor: number, bonusPercent: number, bonusDescription: string, } } </pre></p> |
|
||||
| [getValidMoves()](./bitburner.goanalysis.getvalidmoves.md) | <p>Shows if each point on the board is a valid move for the player.</p><p>The true/false validity of each move can be retrieved via the X and Y coordinates of the move. <code>const validMoves = ns.go.analysis.getValidMoves();</code></p><p><code>const moveIsValid = validMoves[x][y];</code></p><p>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.</p> |
|
||||
|
||||
|
||||
@ -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<keyof BitNodeMultipliers, number> = {}) {
|
||||
for (const [key, value] of getRecordEntries(a)) this[key] = clampNumber(value);
|
||||
}
|
||||
|
||||
109
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
109
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@ -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],
|
||||
* ]
|
||||
* ```
|
||||
* <pre lang="javascript">
|
||||
* [
|
||||
* [ 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],
|
||||
* ]
|
||||
* </pre>
|
||||
*
|
||||
* @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],
|
||||
* ]
|
||||
* ```
|
||||
* <pre lang="javascript">
|
||||
* [
|
||||
* [-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],
|
||||
* ]
|
||||
* </pre>
|
||||
*
|
||||
* @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#",
|
||||
* ]
|
||||
* ```
|
||||
* <pre lang="javascript">
|
||||
* [
|
||||
* "OO..?",
|
||||
* "OO.?.",
|
||||
* "O.?.X",
|
||||
* ".?.XX",
|
||||
* "?..X#",
|
||||
* ]
|
||||
* </pre>
|
||||
*
|
||||
* @remarks
|
||||
* RAM cost: 16 GB
|
||||
@ -4331,7 +4328,7 @@ export interface GoAnalysis {
|
||||
*
|
||||
* The details are keyed by opponent name, in this structure:
|
||||
*
|
||||
* ```js
|
||||
* <pre lang="javascript">
|
||||
* {
|
||||
* <OpponentName>: {
|
||||
* wins: number,
|
||||
@ -4343,7 +4340,7 @@ export interface GoAnalysis {
|
||||
* bonusDescription: string,
|
||||
* }
|
||||
* }
|
||||
* ```
|
||||
* </pre>
|
||||
*/
|
||||
getStats(): Partial<Record<GoOpponent, SimpleOpponentStats>>;
|
||||
}
|
||||
@ -4527,15 +4524,13 @@ export interface Go {
|
||||
*
|
||||
* For example, a 5x5 board might look like this:
|
||||
*
|
||||
* ```js
|
||||
* [
|
||||
* "XX.O.",
|
||||
* "X..OO",
|
||||
* ".XO..",
|
||||
* "XXO.#",
|
||||
* ".XO.#",
|
||||
* ]
|
||||
* ```
|
||||
[<br/>
|
||||
"XX.O.",<br/>
|
||||
"X..OO",<br/>
|
||||
".XO..",<br/>
|
||||
"XXO.#",<br/>
|
||||
".XO.#",<br/>
|
||||
]
|
||||
*
|
||||
* 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.#",
|
||||
* ]
|
||||
* ```
|
||||
[<br/>
|
||||
"XX.O.",<br/>
|
||||
"X..OO",<br/>
|
||||
".XO..",<br/>
|
||||
"XXO.#",<br/>
|
||||
".XO.#",<br/>
|
||||
]
|
||||
*/
|
||||
getMoveHistory(): string[][];
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user