MISC: Fix typos in NetscriptDefinitions.d.ts (#1546)

This commit is contained in:
catloversg 2024-08-05 03:09:50 +07:00 committed by GitHub
parent 986ac0b627
commit e5a63b4116
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
24 changed files with 65 additions and 61 deletions

@ -17,7 +17,7 @@ createCorporation(corporationName: string, selfFund: boolean): boolean;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| corporationName | string | Name of the corporation | | corporationName | string | Name of the corporation |
| selfFund | boolean | If you should self fund, defaults to true, false will only work on Bitnode 3 | | selfFund | boolean | If you should self fund, defaults to true, false will only work on BitNode 3 |
**Returns:** **Returns:**

@ -14,7 +14,7 @@ export interface CrimeTask
## Remarks ## Remarks
An object representing the crime being commited An object representing the crime being committed
## Properties ## Properties

@ -4,7 +4,7 @@
## Go.cheat property ## Go.cheat property
Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Bitnode 14.2 to use. Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.
**Signature:** **Signature:**

@ -4,7 +4,7 @@
## Go.makeMove() method ## Go.makeMove() method
Make a move on the IPvGO subnet gameboard, and await the opponent's response. x:0 y:0 represents the bottom-left corner of the board in the UI. 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.
**Signature:** **Signature:**

@ -17,7 +17,7 @@ export interface Go
| Property | Modifiers | Type | Description | | Property | Modifiers | Type | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| [analysis](./bitburner.go.analysis.md) | | { getValidMoves(): boolean\[\]\[\]; getChains(): (number \| null)\[\]\[\]; getLiberties(): number\[\]\[\]; getControlledEmptyNodes(): string\[\]; getStats(): Partial&lt;Record&lt;[GoOpponent](./bitburner.goopponent.md)<!-- -->, [SimpleOpponentStats](./bitburner.simpleopponentstats.md)<!-- -->&gt;&gt;; } | Tools to analyze the IPvGO subnet. | | [analysis](./bitburner.go.analysis.md) | | { getValidMoves(): boolean\[\]\[\]; getChains(): (number \| null)\[\]\[\]; getLiberties(): number\[\]\[\]; getControlledEmptyNodes(): string\[\]; getStats(): Partial&lt;Record&lt;[GoOpponent](./bitburner.goopponent.md)<!-- -->, [SimpleOpponentStats](./bitburner.simpleopponentstats.md)<!-- -->&gt;&gt;; } | Tools to analyze the IPvGO subnet. |
| [cheat](./bitburner.go.cheat.md) | | { getCheatSuccessChance(): number; removeRouter( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; playTwoMoves( x1: number, y1: number, x2: number, y2: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; repairOfflineNode( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; destroyNode( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; } | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Bitnode 14.2 to use. | | [cheat](./bitburner.go.cheat.md) | | { getCheatSuccessChance(): number; removeRouter( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; playTwoMoves( x1: number, y1: number, x2: number, y2: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; repairOfflineNode( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; destroyNode( x: number, y: number, ): Promise&lt;{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }&gt;; } | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. |
## Methods ## Methods
@ -28,7 +28,7 @@ export interface Go
| [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. | | [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><p>\[<br/> "XX.O.",<br/> "X..OO",<br/> ".XO..",<br/> "XXO.\#",<br/> ".XO.\#",<br/> \]</p> | | [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. | | [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 gameboard, and await the opponent's response. x:0 y:0 represents the bottom-left corner of the board in the UI. | | [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. | | [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. |
| [passTurn()](./bitburner.go.passturn.md) | <p>Pass the player's turn rather than making a move, and await the opponent's response. This ends the game if the opponent passed on the previous turn, or if the opponent passes on their following turn.</p><p>This can also be used if you pick up the game in a state where the opponent needs to play next. For example: if BitBurner was closed while waiting for the opponent to make a move, you may need to call passTurn() to get them to play their move on game start.</p> | | [passTurn()](./bitburner.go.passturn.md) | <p>Pass the player's turn rather than making a move, and await the opponent's response. This ends the game if the opponent passed on the previous turn, or if the opponent passes on their following turn.</p><p>This can also be used if you pick up the game in a state where the opponent needs to play next. For example: if BitBurner was closed while waiting for the opponent to make a move, you may need to call passTurn() to get them to play their move on game start.</p> |
| [resetBoardState(opponent, boardSize)](./bitburner.go.resetboardstate.md) | <p>Gets new IPvGO subnet with the specified size owned by the listed faction, ready for the player to make a move. This will reset your win streak if the current game is not complete and you have already made moves.</p><p>Note that some factions will have a few routers on the subnet at this state.</p><p>opponent is "Netburners" or "Slum Snakes" or "The Black Hand" or "Tetrads" or "Daedalus" or "Illuminati" or "????????????" or "No AI",</p> | | [resetBoardState(opponent, boardSize)](./bitburner.go.resetboardstate.md) | <p>Gets new IPvGO subnet with the specified size owned by the listed faction, ready for the player to make a move. This will reset your win streak if the current game is not complete and you have already made moves.</p><p>Note that some factions will have a few routers on the subnet at this state.</p><p>opponent is "Netburners" or "Slum Snakes" or "The Black Hand" or "Tetrads" or "Daedalus" or "Illuminati" or "????????????" or "No AI",</p> |

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [KarmaRequiremennt](./bitburner.karmarequiremennt.md) &gt; [karma](./bitburner.karmarequiremennt.karma.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [KarmaRequirement](./bitburner.karmarequirement.md) &gt; [karma](./bitburner.karmarequirement.karma.md)
## KarmaRequiremennt.karma property ## KarmaRequirement.karma property
**Signature:** **Signature:**

@ -1,21 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [KarmaRequiremennt](./bitburner.karmarequiremennt.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [KarmaRequirement](./bitburner.karmarequirement.md)
## KarmaRequiremennt interface ## KarmaRequirement interface
Player must have less than this much karma. Player must have less than this much karma.
**Signature:** **Signature:**
```typescript ```typescript
interface KarmaRequiremennt interface KarmaRequirement
``` ```
## Properties ## Properties
| Property | Modifiers | Type | Description | | Property | Modifiers | Type | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| [karma](./bitburner.karmarequiremennt.karma.md) | | number | | | [karma](./bitburner.karmarequirement.karma.md) | | number | |
| [type](./bitburner.karmarequiremennt.type.md) | | "karma" | | | [type](./bitburner.karmarequirement.type.md) | | "karma" | |

@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [KarmaRequiremennt](./bitburner.karmarequiremennt.md) &gt; [type](./bitburner.karmarequiremennt.type.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [KarmaRequirement](./bitburner.karmarequirement.md) &gt; [type](./bitburner.karmarequirement.type.md)
## KarmaRequiremennt.type property ## KarmaRequirement.type property
**Signature:** **Signature:**

@ -94,7 +94,7 @@
| [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer | | [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer |
| [IStyleSettings](./bitburner.istylesettings.md) | Interface Styles | | [IStyleSettings](./bitburner.istylesettings.md) | Interface Styles |
| [JobTitleRequirement](./bitburner.jobtitlerequirement.md) | Player must have this job title at some company. | | [JobTitleRequirement](./bitburner.jobtitlerequirement.md) | Player must have this job title at some company. |
| [KarmaRequiremennt](./bitburner.karmarequiremennt.md) | Player must have less than this much karma. | | [KarmaRequirement](./bitburner.karmarequirement.md) | Player must have less than this much karma. |
| [LocationRequirement](./bitburner.locationrequirement.md) | Player must be at this location within a city. | | [LocationRequirement](./bitburner.locationrequirement.md) | Player must be at this location within a city. |
| [Material](./bitburner.material.md) | Material in a warehouse | | [Material](./bitburner.material.md) | Material in a warehouse |
| [MoneyRequirement](./bitburner.moneyrequirement.md) | Player must have at least this much money. | | [MoneyRequirement](./bitburner.moneyrequirement.md) | Player must have at least this much money. |
@ -132,7 +132,7 @@
| [SourceFileRequirement](./bitburner.sourcefilerequirement.md) | Player must have this Source File. | | [SourceFileRequirement](./bitburner.sourcefilerequirement.md) | Player must have this Source File. |
| [SpawnOptions](./bitburner.spawnoptions.md) | | | [SpawnOptions](./bitburner.spawnoptions.md) | |
| [Stanek](./bitburner.stanek.md) | Stanek's Gift API. | | [Stanek](./bitburner.stanek.md) | Stanek's Gift API. |
| [StockMarketConstants](./bitburner.stockmarketconstants.md) | Constants used for the stockmarket game mechanic. | | [StockMarketConstants](./bitburner.stockmarketconstants.md) | Constants used for the stock market game mechanic. |
| [StockOrder](./bitburner.stockorder.md) | <p>Return value of [getOrders](./bitburner.tix.getorders.md)</p><p>Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md)</p> | | [StockOrder](./bitburner.stockorder.md) | <p>Return value of [getOrders](./bitburner.tix.getorders.md)</p><p>Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md)</p> |
| [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) | | [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) |
| [StudyTask](./bitburner.studytask.md) | Study | | [StudyTask](./bitburner.studytask.md) | Study |

@ -4,7 +4,7 @@
## NS.getBitNodeMultipliers() method ## NS.getBitNodeMultipliers() method
Get the current Bitnode multipliers. Get the current BitNode multipliers.
**Signature:** **Signature:**
@ -29,7 +29,7 @@ Object containing the current BitNode multipliers.
RAM cost: 4 GB RAM cost: 4 GB
Returns an object containing the current (or supplied) BitNode multipliers. This function requires you to be in Bitnode 5 or have Source-File 5 in order to run. The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). The multipliers represent the difference between the current BitNode and the original BitNode (BitNode-1). Returns an object containing the current (or supplied) BitNode multipliers. This function requires you to be in BitNode 5 or have Source-File 5 in order to run. The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). The multipliers represent the difference between the current BitNode and the original BitNode (BitNode-1).
For example, if the CrimeMoney multiplier has a value of 0.1, then that means that committing crimes in the current BitNode will only give 10% of the money you would have received in BitNode-1. For example, if the CrimeMoney multiplier has a value of 0.1, then that means that committing crimes in the current BitNode will only give 10% of the money you would have received in BitNode-1.

@ -35,7 +35,7 @@ This function returns the decimal number of script threads you need when running
```js ```js
// Calculate threadcount of a single hack that would take $100k from n00dles // Calculate the thread count of a single hack that would take $100k from n00dles
const hackThreads = ns.hackAnalyzeThreads("n00dles", 1e5); const hackThreads = ns.hackAnalyzeThreads("n00dles", 1e5);
// Launching a script requires an integer thread count. The below would take less than the targeted $100k. // Launching a script requires an integer thread count. The below would take less than the targeted $100k.

@ -9,7 +9,7 @@ Terminate all scripts on a server.
**Signature:** **Signature:**
```typescript ```typescript
killall(host?: string, safetyguard?: boolean): boolean; killall(host?: string, safetyGuard?: boolean): boolean;
``` ```
## Parameters ## Parameters
@ -17,7 +17,7 @@ killall(host?: string, safetyguard?: boolean): boolean;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| host | string | _(Optional)_ IP or hostname of the server on which to kill all scripts. | | host | string | _(Optional)_ IP or hostname of the server on which to kill all scripts. |
| safetyguard | boolean | _(Optional)_ Skips the script that calls this function | | safetyGuard | boolean | _(Optional)_ Skips the script that calls this function |
**Returns:** **Returns:**

@ -73,7 +73,7 @@ export async function main(ns) {
| [formatPercent(n, fractionalDigits, suffixStart)](./bitburner.ns.formatpercent.md) | Format a number as a percentage. | | [formatPercent(n, fractionalDigits, suffixStart)](./bitburner.ns.formatpercent.md) | Format a number as a percentage. |
| [formatRam(n, fractionalDigits)](./bitburner.ns.formatram.md) | Format a number as an amount of ram. | | [formatRam(n, fractionalDigits)](./bitburner.ns.formatram.md) | Format a number as an amount of ram. |
| [ftpcrack(host)](./bitburner.ns.ftpcrack.md) | Runs FTPCrack.exe on a server. | | [ftpcrack(host)](./bitburner.ns.ftpcrack.md) | Runs FTPCrack.exe on a server. |
| [getBitNodeMultipliers(n, lvl)](./bitburner.ns.getbitnodemultipliers.md) | Get the current Bitnode multipliers. | | [getBitNodeMultipliers(n, lvl)](./bitburner.ns.getbitnodemultipliers.md) | Get the current BitNode multipliers. |
| [getFavorToDonate()](./bitburner.ns.getfavortodonate.md) | Returns the amount of Faction favor required to be able to donate to a faction. | | [getFavorToDonate()](./bitburner.ns.getfavortodonate.md) | Returns the amount of Faction favor required to be able to donate to a faction. |
| [getFunctionRamCost(name)](./bitburner.ns.getfunctionramcost.md) | Get the ram cost of a netscript function. | | [getFunctionRamCost(name)](./bitburner.ns.getfunctionramcost.md) | Get the ram cost of a netscript function. |
| [getGrowTime(host)](./bitburner.ns.getgrowtime.md) | Get the execution time of a grow() call. | | [getGrowTime(host)](./bitburner.ns.getgrowtime.md) | Get the execution time of a grow() call. |
@ -129,7 +129,7 @@ export async function main(ns) {
| [isRunning(script, host, args)](./bitburner.ns.isrunning.md) | Check if a script is running. | | [isRunning(script, host, args)](./bitburner.ns.isrunning.md) | Check if a script is running. |
| [kill(pid)](./bitburner.ns.kill.md) | Terminate the script with the provided PID. | | [kill(pid)](./bitburner.ns.kill.md) | Terminate the script with the provided PID. |
| [kill(filename, hostname, args)](./bitburner.ns.kill_1.md) | Terminate the script(s) with the provided filename, hostname, and script arguments. | | [kill(filename, hostname, args)](./bitburner.ns.kill_1.md) | Terminate the script(s) with the provided filename, hostname, and script arguments. |
| [killall(host, safetyguard)](./bitburner.ns.killall.md) | Terminate all scripts on a server. | | [killall(host, safetyGuard)](./bitburner.ns.killall.md) | Terminate all scripts on a server. |
| [ls(host, substring)](./bitburner.ns.ls.md) | List files on a server. | | [ls(host, substring)](./bitburner.ns.ls.md) | List files on a server. |
| [moveTail(x, y, pid)](./bitburner.ns.movetail.md) | Move a tail window. | | [moveTail(x, y, pid)](./bitburner.ns.movetail.md) | Move a tail window. |
| [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. | | [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. |

@ -28,5 +28,5 @@ void
RAM cost: 0 GB RAM cost: 0 GB
Moves a tail window. Coordinates are in screenspace pixels (top left is 0,0). Moves a tail window. Coordinates are in screen space pixels (top left is 0,0).

@ -28,7 +28,7 @@ The new static RAM limit, which will be the old one if it wasn't changed. This m
RAM cost: 0 GB RAM cost: 0 GB
This acts analagously to the ramOverride parameter in runOptions, but for changing RAM in the current running script. The static RAM allocation (the amount of RAM used by ONE thread) will be adjusted to the given value, if possible. This can fail if the number is less than the current dynamic RAM limit, or if adjusting upward would require more RAM than is available on the server. This acts analogously to the ramOverride parameter in runOptions, but for changing RAM in the current running script. The static RAM allocation (the amount of RAM used by ONE thread) will be adjusted to the given value, if possible. This can fail if the number is less than the current dynamic RAM limit, or if adjusting upward would require more RAM than is available on the server.
RAM usage will be rounded to the nearest hundredth of a GB, which is the granularity of all RAM calculations. RAM usage will be rounded to the nearest hundredth of a GB, which is the granularity of all RAM calculations.

@ -12,7 +12,7 @@ Structured interface to requirements for joining a faction or company. For field
export type PlayerRequirement = export type PlayerRequirement =
| MoneyRequirement | MoneyRequirement
| SkillRequirement | SkillRequirement
| KarmaRequiremennt | KarmaRequirement
| PeopleKilledRequirement | PeopleKilledRequirement
| FileRequirement | FileRequirement
| NumAugmentationsRequirement | NumAugmentationsRequirement
@ -33,5 +33,5 @@ export type PlayerRequirement =
| SomeRequirement | SomeRequirement
| EveryRequirement; | EveryRequirement;
``` ```
**References:** [MoneyRequirement](./bitburner.moneyrequirement.md)<!-- -->, [SkillRequirement](./bitburner.skillrequirement.md)<!-- -->, [KarmaRequiremennt](./bitburner.karmarequiremennt.md)<!-- -->, [PeopleKilledRequirement](./bitburner.peoplekilledrequirement.md)<!-- -->, [FileRequirement](./bitburner.filerequirement.md)<!-- -->, [NumAugmentationsRequirement](./bitburner.numaugmentationsrequirement.md)<!-- -->, [EmployedByRequirement](./bitburner.employedbyrequirement.md)<!-- -->, [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md)<!-- -->, [JobTitleRequirement](./bitburner.jobtitlerequirement.md)<!-- -->, [CityRequirement](./bitburner.cityrequirement.md)<!-- -->, [LocationRequirement](./bitburner.locationrequirement.md)<!-- -->, [BackdoorRequirement](./bitburner.backdoorrequirement.md)<!-- -->, [HacknetRAMRequirement](./bitburner.hacknetramrequirement.md)<!-- -->, [HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md)<!-- -->, [HacknetLevelsRequirement](./bitburner.hacknetlevelsrequirement.md)<!-- -->, [BitNodeRequirement](./bitburner.bitnoderequirement.md)<!-- -->, [SourceFileRequirement](./bitburner.sourcefilerequirement.md)<!-- -->, [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md)<!-- -->, [NumInfiltrationsRequirement](./bitburner.numinfiltrationsrequirement.md)<!-- -->, [NotRequirement](./bitburner.notrequirement.md)<!-- -->, [SomeRequirement](./bitburner.somerequirement.md)<!-- -->, [EveryRequirement](./bitburner.everyrequirement.md) **References:** [MoneyRequirement](./bitburner.moneyrequirement.md)<!-- -->, [SkillRequirement](./bitburner.skillrequirement.md)<!-- -->, [KarmaRequirement](./bitburner.karmarequirement.md)<!-- -->, [PeopleKilledRequirement](./bitburner.peoplekilledrequirement.md)<!-- -->, [FileRequirement](./bitburner.filerequirement.md)<!-- -->, [NumAugmentationsRequirement](./bitburner.numaugmentationsrequirement.md)<!-- -->, [EmployedByRequirement](./bitburner.employedbyrequirement.md)<!-- -->, [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md)<!-- -->, [JobTitleRequirement](./bitburner.jobtitlerequirement.md)<!-- -->, [CityRequirement](./bitburner.cityrequirement.md)<!-- -->, [LocationRequirement](./bitburner.locationrequirement.md)<!-- -->, [BackdoorRequirement](./bitburner.backdoorrequirement.md)<!-- -->, [HacknetRAMRequirement](./bitburner.hacknetramrequirement.md)<!-- -->, [HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md)<!-- -->, [HacknetLevelsRequirement](./bitburner.hacknetlevelsrequirement.md)<!-- -->, [BitNodeRequirement](./bitburner.bitnoderequirement.md)<!-- -->, [SourceFileRequirement](./bitburner.sourcefilerequirement.md)<!-- -->, [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md)<!-- -->, [NumInfiltrationsRequirement](./bitburner.numinfiltrationsrequirement.md)<!-- -->, [NotRequirement](./bitburner.notrequirement.md)<!-- -->, [SomeRequirement](./bitburner.somerequirement.md)<!-- -->, [EveryRequirement](./bitburner.everyrequirement.md)

@ -4,7 +4,7 @@
## ResetInfo.currentNode property ## ResetInfo.currentNode property
The current bitnode The current BitNode
**Signature:** **Signature:**

@ -4,7 +4,7 @@
## ResetInfo.lastNodeReset property ## ResetInfo.lastNodeReset property
Numeric timestamp (from Date.now()) of last bitnode reset Numeric timestamp (from Date.now()) of last BitNode reset
**Signature:** **Signature:**

@ -17,9 +17,9 @@ interface ResetInfo
| Property | Modifiers | Type | Description | | Property | Modifiers | Type | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| [bitNodeOptions](./bitburner.resetinfo.bitnodeoptions.md) | | [BitNodeOptions](./bitburner.bitnodeoptions.md) | Current BitNode options | | [bitNodeOptions](./bitburner.resetinfo.bitnodeoptions.md) | | [BitNodeOptions](./bitburner.bitnodeoptions.md) | Current BitNode options |
| [currentNode](./bitburner.resetinfo.currentnode.md) | | number | The current bitnode | | [currentNode](./bitburner.resetinfo.currentnode.md) | | number | The current BitNode |
| [lastAugReset](./bitburner.resetinfo.lastaugreset.md) | | number | Numeric timestamp (from Date.now()) of last augmentation reset | | [lastAugReset](./bitburner.resetinfo.lastaugreset.md) | | number | Numeric timestamp (from Date.now()) of last augmentation reset |
| [lastNodeReset](./bitburner.resetinfo.lastnodereset.md) | | number | Numeric timestamp (from Date.now()) of last bitnode reset | | [lastNodeReset](./bitburner.resetinfo.lastnodereset.md) | | number | Numeric timestamp (from Date.now()) of last BitNode reset |
| [ownedAugs](./bitburner.resetinfo.ownedaugs.md) | | Map&lt;string, number&gt; | A map of owned augmentations to their levels. Keyed by the augmentation name. Map values are the augmentation level (e.g. for NeuroFlux governor). | | [ownedAugs](./bitburner.resetinfo.ownedaugs.md) | | Map&lt;string, number&gt; | A map of owned augmentations to their levels. Keyed by the augmentation name. Map values are the augmentation level (e.g. for NeuroFlux governor). |
| [ownedSF](./bitburner.resetinfo.ownedsf.md) | | Map&lt;number, number&gt; | A map of owned SF to their levels. Keyed by the SF number. Map values are the SF level. | | [ownedSF](./bitburner.resetinfo.ownedsf.md) | | Map&lt;number, number&gt; | A map of owned SF to their levels. Keyed by the SF number. Map values are the SF level. |

@ -4,7 +4,7 @@
## StockMarketConstants interface ## StockMarketConstants interface
Constants used for the stockmarket game mechanic. Constants used for the stock market game mechanic.
**Signature:** **Signature:**

@ -22,7 +22,7 @@ getOrganization(sym: string): string;
string string
The organization assicated with the stock symbol. The organization associated with the stock symbol.
## Remarks ## Remarks

@ -14,7 +14,7 @@ import type {
CompanyReputationRequirement, CompanyReputationRequirement,
EmployedByRequirement, EmployedByRequirement,
JobTitleRequirement, JobTitleRequirement,
KarmaRequiremennt, KarmaRequirement,
MoneyRequirement, MoneyRequirement,
NumAugmentationsRequirement, NumAugmentationsRequirement,
PeopleKilledRequirement, PeopleKilledRequirement,
@ -173,7 +173,7 @@ export const haveKarma = (n: number): PlayerCondition => ({
else if (n < -10) return "A history of violence"; else if (n < -10) return "A history of violence";
else return "Street cred"; else return "Street cred";
}, },
toJSON(): KarmaRequiremennt { toJSON(): KarmaRequirement {
return { type: "karma", karma: n }; return { type: "karma", karma: n };
}, },
isSatisfied(p: PlayerObject): boolean { isSatisfied(p: PlayerObject): boolean {

@ -819,16 +819,16 @@ export const ns: InternalAPI<NSFull> = {
}, },
killall: killall:
(ctx) => (ctx) =>
(_hostname = ctx.workerScript.hostname, _safetyguard = true) => { (_hostname = ctx.workerScript.hostname, _safetyGuard = true) => {
const hostname = helpers.string(ctx, "hostname", _hostname); const hostname = helpers.string(ctx, "hostname", _hostname);
const safetyguard = !!_safetyguard; const safetyGuard = !!_safetyGuard;
const server = helpers.getServer(ctx, hostname); const server = helpers.getServer(ctx, hostname);
let scriptsKilled = 0; let scriptsKilled = 0;
for (const byPid of server.runningScriptMap.values()) { for (const byPid of server.runningScriptMap.values()) {
for (const pid of byPid.keys()) { for (const pid of byPid.keys()) {
if (safetyguard && pid == ctx.workerScript.pid) continue; if (safetyGuard && pid == ctx.workerScript.pid) continue;
killWorkerScriptByPid(pid); killWorkerScriptByPid(pid);
++scriptsKilled; ++scriptsKilled;
} }

@ -68,9 +68,9 @@ interface SleevePerson extends Person {
interface ResetInfo { interface ResetInfo {
/** Numeric timestamp (from Date.now()) of last augmentation reset */ /** Numeric timestamp (from Date.now()) of last augmentation reset */
lastAugReset: number; lastAugReset: number;
/** Numeric timestamp (from Date.now()) of last bitnode reset */ /** Numeric timestamp (from Date.now()) of last BitNode reset */
lastNodeReset: number; lastNodeReset: number;
/** The current bitnode */ /** The current BitNode */
currentNode: number; currentNode: number;
/** A map of owned augmentations to their levels. Keyed by the augmentation name. Map values are the augmentation level (e.g. for NeuroFlux governor). */ /** A map of owned augmentations to their levels. Keyed by the augmentation name. Map values are the augmentation level (e.g. for NeuroFlux governor). */
ownedAugs: Map<string, number>; ownedAugs: Map<string, number>;
@ -424,7 +424,7 @@ interface StockOrder {
[key: string]: StockOrderObject[]; [key: string]: StockOrderObject[];
} }
/** Constants used for the stockmarket game mechanic. /** Constants used for the stock market game mechanic.
* @public */ * @public */
interface StockMarketConstants { interface StockMarketConstants {
/** Normal time in ms between stock market updates */ /** Normal time in ms between stock market updates */
@ -1249,7 +1249,7 @@ export interface TIX {
* ns.tprint("Stock organization: " + ns.stock.getOrganization(sym)); * ns.tprint("Stock organization: " + ns.stock.getOrganization(sym));
* ``` * ```
* @param sym - Stock symbol. * @param sym - Stock symbol.
* @returns The organization assicated with the stock symbol. * @returns The organization associated with the stock symbol.
*/ */
getOrganization(sym: string): string; getOrganization(sym: string): string;
@ -1660,7 +1660,7 @@ export interface CreateProgramWorkTask {
/** /**
* Crime * Crime
* @remarks * @remarks
* An object representing the crime being commited * An object representing the crime being committed
* @public * @public
*/ */
export interface CrimeTask { export interface CrimeTask {
@ -1710,6 +1710,8 @@ export type Task = StudyTask | CompanyWorkTask | CreateProgramWorkTask | CrimeTa
* - All boolean options: false * - All boolean options: false
* *
* If you specify intelligenceOverride, it must be a non-negative integer. * If you specify intelligenceOverride, it must be a non-negative integer.
*
* @public
*/ */
export interface BitNodeOptions extends BitNodeBooleanOptions { export interface BitNodeOptions extends BitNodeBooleanOptions {
sourceFileOverrides: Map<number, number>; sourceFileOverrides: Map<number, number>;
@ -1722,6 +1724,8 @@ export interface BitNodeOptions extends BitNodeBooleanOptions {
* *
* disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy * disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy
* augmentations for them. * augmentations for them.
*
* @public
*/ */
export interface BitNodeBooleanOptions { export interface BitNodeBooleanOptions {
restrictHomePCUpgrade: boolean; restrictHomePCUpgrade: boolean;
@ -4037,7 +4041,7 @@ type SimpleOpponentStats = {
*/ */
export interface Go { export interface Go {
/** /**
* Make a move on the IPvGO subnet gameboard, and await the opponent's response. * 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. * x:0 y:0 represents the bottom-left corner of the board in the UI.
* *
* @remarks * @remarks
@ -4291,7 +4295,7 @@ export interface Go {
}; };
/** /**
* Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires Bitnode 14.2 to use. * Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use.
*/ */
cheat: { cheat: {
/** /**
@ -4303,7 +4307,7 @@ export interface Go {
* *
* @remarks * @remarks
* RAM cost: 1 GB * RAM cost: 1 GB
* Requires Bitnode 14.2 to use * Requires BitNode 14.2 to use
*/ */
getCheatSuccessChance(): number; getCheatSuccessChance(): number;
/** /**
@ -4316,7 +4320,7 @@ export interface Go {
* *
* @remarks * @remarks
* RAM cost: 8 GB * RAM cost: 8 GB
* Requires Bitnode 14.2 to use * Requires BitNode 14.2 to use
* *
* @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
@ -4339,7 +4343,7 @@ export interface Go {
* *
* @remarks * @remarks
* RAM cost: 8 GB * RAM cost: 8 GB
* Requires Bitnode 14.2 to use * Requires BitNode 14.2 to use
* *
* @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
@ -4364,7 +4368,7 @@ export interface Go {
* *
* @remarks * @remarks
* RAM cost: 8 GB * RAM cost: 8 GB
* Requires Bitnode 14.2 to use * Requires BitNode 14.2 to use
* *
* @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
@ -4388,7 +4392,7 @@ export interface Go {
* *
* @remarks * @remarks
* RAM cost: 8 GB * RAM cost: 8 GB
* Requires Bitnode 14.2 to use * Requires BitNode 14.2 to use
* *
* @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended * @returns a promise that contains the opponent move's x and y coordinates (or pass) in response, or an indication if the game has ended
*/ */
@ -5632,7 +5636,7 @@ export interface NS {
* *
* @example * @example
* ```js * ```js
* // Calculate threadcount of a single hack that would take $100k from n00dles * // Calculate the thread count of a single hack that would take $100k from n00dles
* const hackThreads = ns.hackAnalyzeThreads("n00dles", 1e5); * const hackThreads = ns.hackAnalyzeThreads("n00dles", 1e5);
* *
* // Launching a script requires an integer thread count. The below would take less than the targeted $100k. * // Launching a script requires an integer thread count. The below would take less than the targeted $100k.
@ -6052,7 +6056,7 @@ export interface NS {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* Moves a tail window. Coordinates are in screenspace pixels (top left is 0,0). * Moves a tail window. Coordinates are in screen space pixels (top left is 0,0).
* *
* @param x - x coordinate. * @param x - x coordinate.
* @param y - y coordinate. * @param y - y coordinate.
@ -6404,10 +6408,10 @@ export interface NS {
* If no host is defined, it will kill all scripts, where the script is running. * If no host is defined, it will kill all scripts, where the script is running.
* *
* @param host - IP or hostname of the server on which to kill all scripts. * @param host - IP or hostname of the server on which to kill all scripts.
* @param safetyguard - Skips the script that calls this function * @param safetyGuard - Skips the script that calls this function
* @returns True if any scripts were killed, and false otherwise. * @returns True if any scripts were killed, and false otherwise.
*/ */
killall(host?: string, safetyguard?: boolean): boolean; killall(host?: string, safetyGuard?: boolean): boolean;
/** /**
* Terminates the current script immediately. * Terminates the current script immediately.
@ -6770,7 +6774,7 @@ export interface NS {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* This acts analagously to the ramOverride parameter in runOptions, but for changing RAM in * This acts analogously to the ramOverride parameter in runOptions, but for changing RAM in
* the current running script. The static RAM allocation (the amount of RAM used by ONE thread) * the current running script. The static RAM allocation (the amount of RAM used by ONE thread)
* will be adjusted to the given value, if possible. This can fail if the number is less than the * will be adjusted to the given value, if possible. This can fail if the number is less than the
* current dynamic RAM limit, or if adjusting upward would require more RAM than is available on * current dynamic RAM limit, or if adjusting upward would require more RAM than is available on
@ -7466,12 +7470,12 @@ export interface NS {
getFavorToDonate(): number; getFavorToDonate(): number;
/** /**
* Get the current Bitnode multipliers. * Get the current BitNode multipliers.
* @remarks * @remarks
* RAM cost: 4 GB * RAM cost: 4 GB
* *
* Returns an object containing the current (or supplied) BitNode multipliers. * Returns an object containing the current (or supplied) BitNode multipliers.
* This function requires you to be in Bitnode 5 or have Source-File 5 in order to run. * This function requires you to be in BitNode 5 or have Source-File 5 in order to run.
* The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). * The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%).
* The multipliers represent the difference between the current BitNode and * The multipliers represent the difference between the current BitNode and
* the original BitNode (BitNode-1). * the original BitNode (BitNode-1).
@ -8243,7 +8247,7 @@ export interface Corporation extends WarehouseAPI, OfficeAPI {
/** Create a Corporation /** Create a Corporation
* @param corporationName - Name of the corporation * @param corporationName - Name of the corporation
* @param selfFund - If you should self fund, defaults to true, false will only work on Bitnode 3 * @param selfFund - If you should self fund, defaults to true, false will only work on BitNode 3
* @returns true if created and false if not */ * @returns true if created and false if not */
createCorporation(corporationName: string, selfFund: boolean): boolean; createCorporation(corporationName: string, selfFund: boolean): boolean;
@ -8920,7 +8924,7 @@ interface SkillRequirement {
* Player must have less than this much karma. * Player must have less than this much karma.
* @public * @public
*/ */
interface KarmaRequiremennt { interface KarmaRequirement {
type: "karma"; type: "karma";
karma: number; karma: number;
} }
@ -9091,7 +9095,7 @@ interface EveryRequirement {
export type PlayerRequirement = export type PlayerRequirement =
| MoneyRequirement | MoneyRequirement
| SkillRequirement | SkillRequirement
| KarmaRequiremennt | KarmaRequirement
| PeopleKilledRequirement | PeopleKilledRequirement
| FileRequirement | FileRequirement
| NumAugmentationsRequirement | NumAugmentationsRequirement