From e5a63b4116304a898d4c0002b2552e3e1716bd4a Mon Sep 17 00:00:00 2001 From: catloversg <152669316+catloversg@users.noreply.github.com> Date: Mon, 5 Aug 2024 03:09:50 +0700 Subject: [PATCH] MISC: Fix typos in NetscriptDefinitions.d.ts (#1546) --- ...bitburner.corporation.createcorporation.md | 2 +- markdown/bitburner.crimetask.md | 2 +- markdown/bitburner.go.cheat.md | 2 +- markdown/bitburner.go.makemove.md | 2 +- markdown/bitburner.go.md | 4 +- ...md => bitburner.karmarequirement.karma.md} | 4 +- ...mennt.md => bitburner.karmarequirement.md} | 10 ++-- ....md => bitburner.karmarequirement.type.md} | 4 +- markdown/bitburner.md | 4 +- .../bitburner.ns.getbitnodemultipliers.md | 4 +- markdown/bitburner.ns.hackanalyzethreads.md | 2 +- markdown/bitburner.ns.killall.md | 4 +- markdown/bitburner.ns.md | 4 +- markdown/bitburner.ns.movetail.md | 2 +- markdown/bitburner.ns.ramoverride.md | 2 +- markdown/bitburner.playerrequirement.md | 4 +- markdown/bitburner.resetinfo.currentnode.md | 2 +- markdown/bitburner.resetinfo.lastnodereset.md | 2 +- markdown/bitburner.resetinfo.md | 4 +- markdown/bitburner.stockmarketconstants.md | 2 +- markdown/bitburner.tix.getorganization.md | 2 +- src/Faction/FactionJoinCondition.ts | 4 +- src/NetscriptFunctions.ts | 6 +-- src/ScriptEditor/NetscriptDefinitions.d.ts | 48 ++++++++++--------- 24 files changed, 65 insertions(+), 61 deletions(-) rename markdown/{bitburner.karmarequiremennt.karma.md => bitburner.karmarequirement.karma.md} (59%) rename markdown/{bitburner.karmarequiremennt.md => bitburner.karmarequirement.md} (57%) rename markdown/{bitburner.karmarequiremennt.type.md => bitburner.karmarequirement.type.md} (59%) diff --git a/markdown/bitburner.corporation.createcorporation.md b/markdown/bitburner.corporation.createcorporation.md index ed4ecb174..da6be8f27 100644 --- a/markdown/bitburner.corporation.createcorporation.md +++ b/markdown/bitburner.corporation.createcorporation.md @@ -17,7 +17,7 @@ createCorporation(corporationName: string, selfFund: boolean): boolean; | Parameter | Type | Description | | --- | --- | --- | | 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:** diff --git a/markdown/bitburner.crimetask.md b/markdown/bitburner.crimetask.md index 3a1e09daa..afc5987f7 100644 --- a/markdown/bitburner.crimetask.md +++ b/markdown/bitburner.crimetask.md @@ -14,7 +14,7 @@ export interface CrimeTask ## Remarks -An object representing the crime being commited +An object representing the crime being committed ## Properties diff --git a/markdown/bitburner.go.cheat.md b/markdown/bitburner.go.cheat.md index 973a2ff3d..51352bb3a 100644 --- a/markdown/bitburner.go.cheat.md +++ b/markdown/bitburner.go.cheat.md @@ -4,7 +4,7 @@ ## 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:** diff --git a/markdown/bitburner.go.makemove.md b/markdown/bitburner.go.makemove.md index db2399054..c5f8316a3 100644 --- a/markdown/bitburner.go.makemove.md +++ b/markdown/bitburner.go.makemove.md @@ -4,7 +4,7 @@ ## 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:** diff --git a/markdown/bitburner.go.md b/markdown/bitburner.go.md index 0a4b2c493..6d231643f 100644 --- a/markdown/bitburner.go.md +++ b/markdown/bitburner.go.md @@ -17,7 +17,7 @@ export interface Go | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [analysis](./bitburner.go.analysis.md) | | { getValidMoves(): boolean\[\]\[\]; getChains(): (number \| null)\[\]\[\]; getLiberties(): number\[\]\[\]; getControlledEmptyNodes(): string\[\]; getStats(): Partial<Record<[GoOpponent](./bitburner.goopponent.md), [SimpleOpponentStats](./bitburner.simpleopponentstats.md)>>; } | Tools to analyze the IPvGO subnet. | -| [cheat](./bitburner.go.cheat.md) | | { getCheatSuccessChance(): number; removeRouter( x: number, y: number, ): Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>; playTwoMoves( x1: number, y1: number, x2: number, y2: number, ): Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>; repairOfflineNode( x: number, y: number, ): Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>; destroyNode( x: number, y: number, ): Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>; } | 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<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>; playTwoMoves( x1: number, y1: number, x2: number, y2: number, ): Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>; repairOfflineNode( x: number, y: number, ): Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>; destroyNode( x: number, y: number, ): Promise<{ type: "move" \| "pass" \| "gameOver"; x: number \| null; y: number \| null; }>; } | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. | ## 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. | | [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 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. | | [passTurn()](./bitburner.go.passturn.md) |

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.

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.

| | [resetBoardState(opponent, boardSize)](./bitburner.go.resetboardstate.md) |

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.

Note that some factions will have a few routers on the subnet at this state.

opponent is "Netburners" or "Slum Snakes" or "The Black Hand" or "Tetrads" or "Daedalus" or "Illuminati" or "????????????" or "No AI",

| diff --git a/markdown/bitburner.karmarequiremennt.karma.md b/markdown/bitburner.karmarequirement.karma.md similarity index 59% rename from markdown/bitburner.karmarequiremennt.karma.md rename to markdown/bitburner.karmarequirement.karma.md index 762e2659c..d78498925 100644 --- a/markdown/bitburner.karmarequiremennt.karma.md +++ b/markdown/bitburner.karmarequirement.karma.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [bitburner](./bitburner.md) > [KarmaRequiremennt](./bitburner.karmarequiremennt.md) > [karma](./bitburner.karmarequiremennt.karma.md) +[Home](./index.md) > [bitburner](./bitburner.md) > [KarmaRequirement](./bitburner.karmarequirement.md) > [karma](./bitburner.karmarequirement.karma.md) -## KarmaRequiremennt.karma property +## KarmaRequirement.karma property **Signature:** diff --git a/markdown/bitburner.karmarequiremennt.md b/markdown/bitburner.karmarequirement.md similarity index 57% rename from markdown/bitburner.karmarequiremennt.md rename to markdown/bitburner.karmarequirement.md index a965e67ad..3ba5bf6ad 100644 --- a/markdown/bitburner.karmarequiremennt.md +++ b/markdown/bitburner.karmarequirement.md @@ -1,21 +1,21 @@ -[Home](./index.md) > [bitburner](./bitburner.md) > [KarmaRequiremennt](./bitburner.karmarequiremennt.md) +[Home](./index.md) > [bitburner](./bitburner.md) > [KarmaRequirement](./bitburner.karmarequirement.md) -## KarmaRequiremennt interface +## KarmaRequirement interface Player must have less than this much karma. **Signature:** ```typescript -interface KarmaRequiremennt +interface KarmaRequirement ``` ## Properties | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [karma](./bitburner.karmarequiremennt.karma.md) | | number | | -| [type](./bitburner.karmarequiremennt.type.md) | | "karma" | | +| [karma](./bitburner.karmarequirement.karma.md) | | number | | +| [type](./bitburner.karmarequirement.type.md) | | "karma" | | diff --git a/markdown/bitburner.karmarequiremennt.type.md b/markdown/bitburner.karmarequirement.type.md similarity index 59% rename from markdown/bitburner.karmarequiremennt.type.md rename to markdown/bitburner.karmarequirement.type.md index cffc7f71a..12ff9a94a 100644 --- a/markdown/bitburner.karmarequiremennt.type.md +++ b/markdown/bitburner.karmarequirement.type.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [bitburner](./bitburner.md) > [KarmaRequiremennt](./bitburner.karmarequiremennt.md) > [type](./bitburner.karmarequiremennt.type.md) +[Home](./index.md) > [bitburner](./bitburner.md) > [KarmaRequirement](./bitburner.karmarequirement.md) > [type](./bitburner.karmarequirement.type.md) -## KarmaRequiremennt.type property +## KarmaRequirement.type property **Signature:** diff --git a/markdown/bitburner.md b/markdown/bitburner.md index b6919a62b..db3e9aee1 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -94,7 +94,7 @@ | [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer | | [IStyleSettings](./bitburner.istylesettings.md) | Interface Styles | | [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. | | [Material](./bitburner.material.md) | Material in a warehouse | | [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. | | [SpawnOptions](./bitburner.spawnoptions.md) | | | [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) |

Return value of [getOrders](./bitburner.tix.getorders.md)

Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md)

| | [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) | | [StudyTask](./bitburner.studytask.md) | Study | diff --git a/markdown/bitburner.ns.getbitnodemultipliers.md b/markdown/bitburner.ns.getbitnodemultipliers.md index 75af8f361..212add578 100644 --- a/markdown/bitburner.ns.getbitnodemultipliers.md +++ b/markdown/bitburner.ns.getbitnodemultipliers.md @@ -4,7 +4,7 @@ ## NS.getBitNodeMultipliers() method -Get the current Bitnode multipliers. +Get the current BitNode multipliers. **Signature:** @@ -29,7 +29,7 @@ Object containing the current BitNode multipliers. 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. diff --git a/markdown/bitburner.ns.hackanalyzethreads.md b/markdown/bitburner.ns.hackanalyzethreads.md index 06c696ef1..21aee624f 100644 --- a/markdown/bitburner.ns.hackanalyzethreads.md +++ b/markdown/bitburner.ns.hackanalyzethreads.md @@ -35,7 +35,7 @@ This function returns the decimal number of script threads you need when running ```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); // Launching a script requires an integer thread count. The below would take less than the targeted $100k. diff --git a/markdown/bitburner.ns.killall.md b/markdown/bitburner.ns.killall.md index 9d86eb527..2a0683c30 100644 --- a/markdown/bitburner.ns.killall.md +++ b/markdown/bitburner.ns.killall.md @@ -9,7 +9,7 @@ Terminate all scripts on a server. **Signature:** ```typescript -killall(host?: string, safetyguard?: boolean): boolean; +killall(host?: string, safetyGuard?: boolean): boolean; ``` ## Parameters @@ -17,7 +17,7 @@ killall(host?: string, safetyguard?: boolean): boolean; | Parameter | Type | Description | | --- | --- | --- | | 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:** diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index 751a2fdfd..c08ac5b99 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -73,7 +73,7 @@ export async function main(ns) { | [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. | | [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. | | [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. | @@ -129,7 +129,7 @@ export async function main(ns) { | [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(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. | | [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. | diff --git a/markdown/bitburner.ns.movetail.md b/markdown/bitburner.ns.movetail.md index 5c59cecf1..3bf8aa478 100644 --- a/markdown/bitburner.ns.movetail.md +++ b/markdown/bitburner.ns.movetail.md @@ -28,5 +28,5 @@ void 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). diff --git a/markdown/bitburner.ns.ramoverride.md b/markdown/bitburner.ns.ramoverride.md index 59087e71c..e4c8e8328 100644 --- a/markdown/bitburner.ns.ramoverride.md +++ b/markdown/bitburner.ns.ramoverride.md @@ -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 -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. diff --git a/markdown/bitburner.playerrequirement.md b/markdown/bitburner.playerrequirement.md index f5f7ff8c2..b736d9b4e 100644 --- a/markdown/bitburner.playerrequirement.md +++ b/markdown/bitburner.playerrequirement.md @@ -12,7 +12,7 @@ Structured interface to requirements for joining a faction or company. For field export type PlayerRequirement = | MoneyRequirement | SkillRequirement - | KarmaRequiremennt + | KarmaRequirement | PeopleKilledRequirement | FileRequirement | NumAugmentationsRequirement @@ -33,5 +33,5 @@ export type PlayerRequirement = | SomeRequirement | 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) diff --git a/markdown/bitburner.resetinfo.currentnode.md b/markdown/bitburner.resetinfo.currentnode.md index 67cd90017..f4ab3ee8e 100644 --- a/markdown/bitburner.resetinfo.currentnode.md +++ b/markdown/bitburner.resetinfo.currentnode.md @@ -4,7 +4,7 @@ ## ResetInfo.currentNode property -The current bitnode +The current BitNode **Signature:** diff --git a/markdown/bitburner.resetinfo.lastnodereset.md b/markdown/bitburner.resetinfo.lastnodereset.md index b76049752..b7da48f7e 100644 --- a/markdown/bitburner.resetinfo.lastnodereset.md +++ b/markdown/bitburner.resetinfo.lastnodereset.md @@ -4,7 +4,7 @@ ## ResetInfo.lastNodeReset property -Numeric timestamp (from Date.now()) of last bitnode reset +Numeric timestamp (from Date.now()) of last BitNode reset **Signature:** diff --git a/markdown/bitburner.resetinfo.md b/markdown/bitburner.resetinfo.md index 6f834bf2f..6fc4b31f3 100644 --- a/markdown/bitburner.resetinfo.md +++ b/markdown/bitburner.resetinfo.md @@ -17,9 +17,9 @@ interface ResetInfo | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [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 | -| [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<string, 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). | | [ownedSF](./bitburner.resetinfo.ownedsf.md) | | Map<number, number> | A map of owned SF to their levels. Keyed by the SF number. Map values are the SF level. | diff --git a/markdown/bitburner.stockmarketconstants.md b/markdown/bitburner.stockmarketconstants.md index 19a1c03c4..d1429873b 100644 --- a/markdown/bitburner.stockmarketconstants.md +++ b/markdown/bitburner.stockmarketconstants.md @@ -4,7 +4,7 @@ ## StockMarketConstants interface -Constants used for the stockmarket game mechanic. +Constants used for the stock market game mechanic. **Signature:** diff --git a/markdown/bitburner.tix.getorganization.md b/markdown/bitburner.tix.getorganization.md index 39b397796..0132ffed1 100644 --- a/markdown/bitburner.tix.getorganization.md +++ b/markdown/bitburner.tix.getorganization.md @@ -22,7 +22,7 @@ getOrganization(sym: string): string; string -The organization assicated with the stock symbol. +The organization associated with the stock symbol. ## Remarks diff --git a/src/Faction/FactionJoinCondition.ts b/src/Faction/FactionJoinCondition.ts index 66d2cd206..8f5a41fb6 100644 --- a/src/Faction/FactionJoinCondition.ts +++ b/src/Faction/FactionJoinCondition.ts @@ -14,7 +14,7 @@ import type { CompanyReputationRequirement, EmployedByRequirement, JobTitleRequirement, - KarmaRequiremennt, + KarmaRequirement, MoneyRequirement, NumAugmentationsRequirement, PeopleKilledRequirement, @@ -173,7 +173,7 @@ export const haveKarma = (n: number): PlayerCondition => ({ else if (n < -10) return "A history of violence"; else return "Street cred"; }, - toJSON(): KarmaRequiremennt { + toJSON(): KarmaRequirement { return { type: "karma", karma: n }; }, isSatisfied(p: PlayerObject): boolean { diff --git a/src/NetscriptFunctions.ts b/src/NetscriptFunctions.ts index 7f3c09297..d44b68520 100644 --- a/src/NetscriptFunctions.ts +++ b/src/NetscriptFunctions.ts @@ -819,16 +819,16 @@ export const ns: InternalAPI = { }, killall: (ctx) => - (_hostname = ctx.workerScript.hostname, _safetyguard = true) => { + (_hostname = ctx.workerScript.hostname, _safetyGuard = true) => { const hostname = helpers.string(ctx, "hostname", _hostname); - const safetyguard = !!_safetyguard; + const safetyGuard = !!_safetyGuard; const server = helpers.getServer(ctx, hostname); let scriptsKilled = 0; for (const byPid of server.runningScriptMap.values()) { for (const pid of byPid.keys()) { - if (safetyguard && pid == ctx.workerScript.pid) continue; + if (safetyGuard && pid == ctx.workerScript.pid) continue; killWorkerScriptByPid(pid); ++scriptsKilled; } diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index 86f0f9d91..119d4775c 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -68,9 +68,9 @@ interface SleevePerson extends Person { interface ResetInfo { /** Numeric timestamp (from Date.now()) of last augmentation reset */ lastAugReset: number; - /** Numeric timestamp (from Date.now()) of last bitnode reset */ + /** Numeric timestamp (from Date.now()) of last BitNode reset */ lastNodeReset: number; - /** The current bitnode */ + /** The current BitNode */ 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). */ ownedAugs: Map; @@ -424,7 +424,7 @@ interface StockOrder { [key: string]: StockOrderObject[]; } -/** Constants used for the stockmarket game mechanic. +/** Constants used for the stock market game mechanic. * @public */ interface StockMarketConstants { /** Normal time in ms between stock market updates */ @@ -1249,7 +1249,7 @@ export interface TIX { * ns.tprint("Stock organization: " + ns.stock.getOrganization(sym)); * ``` * @param sym - Stock symbol. - * @returns The organization assicated with the stock symbol. + * @returns The organization associated with the stock symbol. */ getOrganization(sym: string): string; @@ -1660,7 +1660,7 @@ export interface CreateProgramWorkTask { /** * Crime * @remarks - * An object representing the crime being commited + * An object representing the crime being committed * @public */ export interface CrimeTask { @@ -1710,6 +1710,8 @@ export type Task = StudyTask | CompanyWorkTask | CreateProgramWorkTask | CrimeTa * - All boolean options: false * * If you specify intelligenceOverride, it must be a non-negative integer. + * + * @public */ export interface BitNodeOptions extends BitNodeBooleanOptions { sourceFileOverrides: Map; @@ -1722,6 +1724,8 @@ export interface BitNodeOptions extends BitNodeBooleanOptions { * * disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy * augmentations for them. + * + * @public */ export interface BitNodeBooleanOptions { restrictHomePCUpgrade: boolean; @@ -4037,7 +4041,7 @@ type SimpleOpponentStats = { */ 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. * * @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: { /** @@ -4303,7 +4307,7 @@ export interface Go { * * @remarks * RAM cost: 1 GB - * Requires Bitnode 14.2 to use + * Requires BitNode 14.2 to use */ getCheatSuccessChance(): number; /** @@ -4316,7 +4320,7 @@ export interface Go { * * @remarks * 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 */ @@ -4339,7 +4343,7 @@ export interface Go { * * @remarks * 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 */ @@ -4364,7 +4368,7 @@ export interface Go { * * @remarks * 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 */ @@ -4388,7 +4392,7 @@ export interface Go { * * @remarks * 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 */ @@ -5632,7 +5636,7 @@ export interface NS { * * @example * ```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); * * // 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 * 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 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. * * @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. */ - killall(host?: string, safetyguard?: boolean): boolean; + killall(host?: string, safetyGuard?: boolean): boolean; /** * Terminates the current script immediately. @@ -6770,7 +6774,7 @@ export interface NS { * @remarks * 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) * 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 @@ -7466,12 +7470,12 @@ export interface NS { getFavorToDonate(): number; /** - * Get the current Bitnode multipliers. + * Get the current BitNode multipliers. * @remarks * 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. + * 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). @@ -8243,7 +8247,7 @@ export interface Corporation extends WarehouseAPI, OfficeAPI { /** Create a 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 */ createCorporation(corporationName: string, selfFund: boolean): boolean; @@ -8920,7 +8924,7 @@ interface SkillRequirement { * Player must have less than this much karma. * @public */ -interface KarmaRequiremennt { +interface KarmaRequirement { type: "karma"; karma: number; } @@ -9091,7 +9095,7 @@ interface EveryRequirement { export type PlayerRequirement = | MoneyRequirement | SkillRequirement - | KarmaRequiremennt + | KarmaRequirement | PeopleKilledRequirement | FileRequirement | NumAugmentationsRequirement