diff --git a/markdown/bitburner.activefragment.md b/markdown/bitburner.activefragment.md index 44c8fd1f1..aba270949 100644 --- a/markdown/bitburner.activefragment.md +++ b/markdown/bitburner.activefragment.md @@ -13,12 +13,128 @@ interface ActiveFragment ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [highestCharge](./bitburner.activefragment.highestcharge.md) | | number | | -| [id](./bitburner.activefragment.id.md) | | number | | -| [numCharge](./bitburner.activefragment.numcharge.md) | | number | | -| [rotation](./bitburner.activefragment.rotation.md) | | number | | -| [x](./bitburner.activefragment.x.md) | | number | | -| [y](./bitburner.activefragment.y.md) | | number | | + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[highestCharge](./bitburner.activefragment.highestcharge.md) + + + + + + + +number + + + + + +
+ +[id](./bitburner.activefragment.id.md) + + + + + + + +number + + + + + +
+ +[numCharge](./bitburner.activefragment.numcharge.md) + + + + + + + +number + + + + + +
+ +[rotation](./bitburner.activefragment.rotation.md) + + + + + + + +number + + + + + +
+ +[x](./bitburner.activefragment.x.md) + + + + + + + +number + + + + + +
+ +[y](./bitburner.activefragment.y.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.augmentpair.md b/markdown/bitburner.augmentpair.md index d044376b8..013b1cb63 100644 --- a/markdown/bitburner.augmentpair.md +++ b/markdown/bitburner.augmentpair.md @@ -14,8 +14,64 @@ interface AugmentPair ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [cost](./bitburner.augmentpair.cost.md) | | number | augmentation cost | -| [name](./bitburner.augmentpair.name.md) | | string | augmentation name | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[cost](./bitburner.augmentpair.cost.md) + + + + + + + +number + + + + +augmentation cost + + +
+ +[name](./bitburner.augmentpair.name.md) + + + + + + + +string + + + + +augmentation name + + +
diff --git a/markdown/bitburner.autocompletedata.flags.md b/markdown/bitburner.autocompletedata.flags.md index 086fe3b1e..dd5a9de27 100644 --- a/markdown/bitburner.autocompletedata.flags.md +++ b/markdown/bitburner.autocompletedata.flags.md @@ -14,9 +14,37 @@ flags(schema: [string, string | number | boolean | string[]][]): { [key: string] ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +schema + + + + +\[string, string \| number \| boolean \| string\[\]\]\[\] + + + + + +
**Returns:** diff --git a/markdown/bitburner.autocompletedata.md b/markdown/bitburner.autocompletedata.md index 42e79061d..3395c8c27 100644 --- a/markdown/bitburner.autocompletedata.md +++ b/markdown/bitburner.autocompletedata.md @@ -14,20 +14,208 @@ interface AutocompleteData ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [command](./bitburner.autocompletedata.command.md) | | string |

The raw command string that you have typed until you press \[Tab\] to use the autocomplete feature.

For example, if you type [Space]run test.js[Space][Space][Space][Press tab to use autocomplete], "command" will contain all space characters (1 space character before "run" and 3 space characters after ".js").

| -| [enums](./bitburner.autocompletedata.enums.md) | | [NSEnums](./bitburner.nsenums.md) | Netscript Enums | -| [filename](./bitburner.autocompletedata.filename.md) | | string | The filename of the script about to be run | -| [hostname](./bitburner.autocompletedata.hostname.md) | | string | The hostname of the server the script would be running on | -| [processes](./bitburner.autocompletedata.processes.md) | | [ProcessInfo](./bitburner.processinfo.md)\[\] | The processes running on the host | -| [scripts](./bitburner.autocompletedata.scripts.md) | | string\[\] | All scripts on the current server | -| [servers](./bitburner.autocompletedata.servers.md) | | string\[\] |

All server hostnames.

Some servers are hidden until you satisfy their requirements. This array does not contain those servers if you do not satisfy their requirements.

| -| [txts](./bitburner.autocompletedata.txts.md) | | string\[\] | All text files on the current server | + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[command](./bitburner.autocompletedata.command.md) + + + + + + + +string + + + + +The raw command string that you have typed until you press \[Tab\] to use the autocomplete feature. + +For example, if you type `[Space]run test.js[Space][Space][Space][Press tab to use autocomplete]`, "command" will contain all space characters (1 space character before "run" and 3 space characters after ".js"). + + +
+ +[enums](./bitburner.autocompletedata.enums.md) + + + + + + + +[NSEnums](./bitburner.nsenums.md) + + + + +Netscript Enums + + +
+ +[filename](./bitburner.autocompletedata.filename.md) + + + + + + + +string + + + + +The filename of the script about to be run + + +
+ +[hostname](./bitburner.autocompletedata.hostname.md) + + + + + + + +string + + + + +The hostname of the server the script would be running on + + +
+ +[processes](./bitburner.autocompletedata.processes.md) + + + + + + + +[ProcessInfo](./bitburner.processinfo.md)\[\] + + + + +The processes running on the host + + +
+ +[scripts](./bitburner.autocompletedata.scripts.md) + + + + + + + +string\[\] + + + + +All scripts on the current server + + +
+ +[servers](./bitburner.autocompletedata.servers.md) + + + + + + + +string\[\] + + + + +All server hostnames. + +Some servers are hidden until you satisfy their requirements. This array does not contain those servers if you do not satisfy their requirements. + + +
+ +[txts](./bitburner.autocompletedata.txts.md) + + + + + + + +string\[\] + + + + +All text files on the current server + + +
## Methods -| Method | Description | -| --- | --- | -| [flags(schema)](./bitburner.autocompletedata.flags.md) | Parses the flags schema on the already inputted flags | + + +
+ +Method + + + + +Description + + +
+ +[flags(schema)](./bitburner.autocompletedata.flags.md) + + + + +Parses the flags schema on the already inputted flags + + +
diff --git a/markdown/bitburner.backdoorrequirement.md b/markdown/bitburner.backdoorrequirement.md index 787b1e2cc..e8530f10f 100644 --- a/markdown/bitburner.backdoorrequirement.md +++ b/markdown/bitburner.backdoorrequirement.md @@ -14,8 +14,60 @@ interface BackdoorRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [server](./bitburner.backdoorrequirement.server.md) | | string | | -| [type](./bitburner.backdoorrequirement.type.md) | | "backdoorInstalled" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[server](./bitburner.backdoorrequirement.server.md) + + + + + + + +string + + + + + +
+ +[type](./bitburner.backdoorrequirement.type.md) + + + + + + + +"backdoorInstalled" + + + + + +
diff --git a/markdown/bitburner.basetask.md b/markdown/bitburner.basetask.md index 858840b3f..7c717f6a9 100644 --- a/markdown/bitburner.basetask.md +++ b/markdown/bitburner.basetask.md @@ -14,7 +14,45 @@ export interface BaseTask ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [cyclesWorked](./bitburner.basetask.cyclesworked.md) | | number | The number of game engine cycles has passed since this task started. 1 engine cycle = 200ms. | + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[cyclesWorked](./bitburner.basetask.cyclesworked.md) + + + + + + + +number + + + + +The number of game engine cycles has passed since this task started. 1 engine cycle = 200ms. + + +
diff --git a/markdown/bitburner.basichgwoptions.md b/markdown/bitburner.basichgwoptions.md index b7f2f0e2c..d3c49147f 100644 --- a/markdown/bitburner.basichgwoptions.md +++ b/markdown/bitburner.basichgwoptions.md @@ -14,9 +14,83 @@ interface BasicHGWOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [additionalMsec?](./bitburner.basichgwoptions.additionalmsec.md) | | number | _(Optional)_ Number of additional milliseconds that will be spent waiting between the start of the function and when it completes. | -| [stock?](./bitburner.basichgwoptions.stock.md) | | boolean | _(Optional)_ Set to true this action will affect the stock market. | -| [threads?](./bitburner.basichgwoptions.threads.md) | | number | _(Optional)_ Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. Accepts positive non integer values. | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[additionalMsec?](./bitburner.basichgwoptions.additionalmsec.md) + + + + + + + +number + + + + +_(Optional)_ Number of additional milliseconds that will be spent waiting between the start of the function and when it completes. + + +
+ +[stock?](./bitburner.basichgwoptions.stock.md) + + + + + + + +boolean + + + + +_(Optional)_ Set to true this action will affect the stock market. + + +
+ +[threads?](./bitburner.basichgwoptions.threads.md) + + + + + + + +number + + + + +_(Optional)_ Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. Accepts positive non integer values. + + +
diff --git a/markdown/bitburner.bitnodebooleanoptions.md b/markdown/bitburner.bitnodebooleanoptions.md index e88e7ea52..db8e8373c 100644 --- a/markdown/bitburner.bitnodebooleanoptions.md +++ b/markdown/bitburner.bitnodebooleanoptions.md @@ -18,13 +18,145 @@ export interface BitNodeBooleanOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [disable4SData](./bitburner.bitnodebooleanoptions.disable4sdata.md) | | boolean | | -| [disableBladeburner](./bitburner.bitnodebooleanoptions.disablebladeburner.md) | | boolean | | -| [disableCorporation](./bitburner.bitnodebooleanoptions.disablecorporation.md) | | boolean | | -| [disableGang](./bitburner.bitnodebooleanoptions.disablegang.md) | | boolean | | -| [disableHacknetServer](./bitburner.bitnodebooleanoptions.disablehacknetserver.md) | | boolean | | -| [disableSleeveExpAndAugmentation](./bitburner.bitnodebooleanoptions.disablesleeveexpandaugmentation.md) | | boolean | | -| [restrictHomePCUpgrade](./bitburner.bitnodebooleanoptions.restricthomepcupgrade.md) | | boolean | | + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[disable4SData](./bitburner.bitnodebooleanoptions.disable4sdata.md) + + + + + + + +boolean + + + + + +
+ +[disableBladeburner](./bitburner.bitnodebooleanoptions.disablebladeburner.md) + + + + + + + +boolean + + + + + +
+ +[disableCorporation](./bitburner.bitnodebooleanoptions.disablecorporation.md) + + + + + + + +boolean + + + + + +
+ +[disableGang](./bitburner.bitnodebooleanoptions.disablegang.md) + + + + + + + +boolean + + + + + +
+ +[disableHacknetServer](./bitburner.bitnodebooleanoptions.disablehacknetserver.md) + + + + + + + +boolean + + + + + +
+ +[disableSleeveExpAndAugmentation](./bitburner.bitnodebooleanoptions.disablesleeveexpandaugmentation.md) + + + + + + + +boolean + + + + + +
+ +[restrictHomePCUpgrade](./bitburner.bitnodebooleanoptions.restricthomepcupgrade.md) + + + + + + + +boolean + + + + + +
diff --git a/markdown/bitburner.bitnodemultipliers.md b/markdown/bitburner.bitnodemultipliers.md index 78b494c2c..5467fb016 100644 --- a/markdown/bitburner.bitnodemultipliers.md +++ b/markdown/bitburner.bitnodemultipliers.md @@ -14,58 +14,1014 @@ interface BitNodeMultipliers ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [AgilityLevelMultiplier](./bitburner.bitnodemultipliers.agilitylevelmultiplier.md) | | number | Influences how quickly the player's agility level (not exp) scales | -| [AugmentationMoneyCost](./bitburner.bitnodemultipliers.augmentationmoneycost.md) | | number | Influences the base cost to purchase an augmentation. | -| [AugmentationRepCost](./bitburner.bitnodemultipliers.augmentationrepcost.md) | | number | Influences the base rep the player must have with a faction to purchase an augmentation. | -| [BladeburnerRank](./bitburner.bitnodemultipliers.bladeburnerrank.md) | | number | Influences how quickly the player can gain rank within Bladeburner. | -| [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. | -| [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. | -| [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 | -| [FactionPassiveRepGain](./bitburner.bitnodemultipliers.factionpassiverepgain.md) | | number | Influences how much rep the player gains in each faction simply by being a member. | -| [FactionWorkExpGain](./bitburner.bitnodemultipliers.factionworkexpgain.md) | | number | Influences the experience gained for each ability when the player completes work for a Faction. | -| [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) | | number | Influences how much rep the player gains when performing work for a faction or donating to it. | -| [FavorToDonateToFaction](./bitburner.bitnodemultipliers.favortodonatetofaction.md) | | number | Influences the minimum favor the player must have with a faction before they can donate to gain rep. | -| [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 | -| [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 | -| [ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md) | | number | Influences how much money the player actually gains when they hack a server via the terminal. This is different from ScriptHackMoney. When the player hacks a server via the terminal, the amount of money in that server is reduced, but they do not gain that same amount. | -| [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 | Influence how much it costs to purchase a server | -| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | | number | Influences how much money is stolen from a server when the player performs a hack against it. | -| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | | number | Influences how much money the player actually gains when a script hacks a server. This is different from ScriptHackMoney. When a script hacks a server, the amount of money in that server is reduced, but the player does 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. | -| [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. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[AgilityLevelMultiplier](./bitburner.bitnodemultipliers.agilitylevelmultiplier.md) + + + + + + + +number + + + + +Influences how quickly the player's agility level (not exp) scales + + +
+ +[AugmentationMoneyCost](./bitburner.bitnodemultipliers.augmentationmoneycost.md) + + + + + + + +number + + + + +Influences the base cost to purchase an augmentation. + + +
+ +[AugmentationRepCost](./bitburner.bitnodemultipliers.augmentationrepcost.md) + + + + + + + +number + + + + +Influences the base rep the player must have with a faction to purchase an augmentation. + + +
+ +[BladeburnerRank](./bitburner.bitnodemultipliers.bladeburnerrank.md) + + + + + + + +number + + + + +Influences how quickly the player can gain rank within Bladeburner. + + +
+ +[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. + + +
+ +[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. + + +
+ +[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 + + +
+ +[FactionPassiveRepGain](./bitburner.bitnodemultipliers.factionpassiverepgain.md) + + + + + + + +number + + + + +Influences how much rep the player gains in each faction simply by being a member. + + +
+ +[FactionWorkExpGain](./bitburner.bitnodemultipliers.factionworkexpgain.md) + + + + + + + +number + + + + +Influences the experience gained for each ability when the player completes work for a Faction. + + +
+ +[FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) + + + + + + + +number + + + + +Influences how much rep the player gains when performing work for a faction or donating to it. + + +
+ +[FavorToDonateToFaction](./bitburner.bitnodemultipliers.favortodonatetofaction.md) + + + + + + + +number + + + + +Influences the minimum favor the player must have with a faction before they can donate to gain rep. + + +
+ +[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 + + +
+ +[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 + + +
+ +[ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md) + + + + + + + +number + + + + +Influences how much money the player actually gains when they hack a server via the terminal. This is different from ScriptHackMoney. When the player hacks a server via the terminal, the amount of money in that server is reduced, but they do not gain that same amount. + + +
+ +[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 + + + + +Influence how much it costs to purchase a server + + +
+ +[ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) + + + + + + + +number + + + + +Influences how much money is stolen from a server when the player performs a hack against it. + + +
+ +[ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) + + + + + + + +number + + + + +Influences how much money the player actually gains when a script hacks a server. This is different from ScriptHackMoney. When a script hacks a server, the amount of money in that server is reduced, but the player does 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. + + +
+ +[StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) + + + + + + + +number + + + + +Influences how quickly the player's strength level (not exp) scales + + +
+ +[WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) + + + + + + + +number + + + + +Influences the hacking skill required to backdoor the world daemon. + + +
diff --git a/markdown/bitburner.bitnodeoptions.md b/markdown/bitburner.bitnodeoptions.md index 82b523f12..4b69ddbe3 100644 --- a/markdown/bitburner.bitnodeoptions.md +++ b/markdown/bitburner.bitnodeoptions.md @@ -23,8 +23,60 @@ export interface BitNodeOptions extends BitNodeBooleanOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [intelligenceOverride](./bitburner.bitnodeoptions.intelligenceoverride.md) | | number \| undefined | | -| [sourceFileOverrides](./bitburner.bitnodeoptions.sourcefileoverrides.md) | | Map<number, number> | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[intelligenceOverride](./bitburner.bitnodeoptions.intelligenceoverride.md) + + + + + + + +number \| undefined + + + + + +
+ +[sourceFileOverrides](./bitburner.bitnodeoptions.sourcefileoverrides.md) + + + + + + + +Map<number, number> + + + + + +
diff --git a/markdown/bitburner.bitnoderequirement.md b/markdown/bitburner.bitnoderequirement.md index 23042806d..7573f06ff 100644 --- a/markdown/bitburner.bitnoderequirement.md +++ b/markdown/bitburner.bitnoderequirement.md @@ -14,8 +14,60 @@ interface BitNodeRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [bitNodeN](./bitburner.bitnoderequirement.bitnoden.md) | | number | | -| [type](./bitburner.bitnoderequirement.type.md) | | "bitNodeN" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[bitNodeN](./bitburner.bitnoderequirement.bitnoden.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.bitnoderequirement.type.md) + + + + + + + +"bitNodeN" + + + + + +
diff --git a/markdown/bitburner.bladeburner.getactionautolevel.md b/markdown/bitburner.bladeburner.getactionautolevel.md index 2e96de5eb..bb2dce173 100644 --- a/markdown/bitburner.bladeburner.getactionautolevel.md +++ b/markdown/bitburner.bladeburner.getactionautolevel.md @@ -14,10 +14,55 @@ getActionAutolevel(type: BladeburnerActionType, name: BladeburnerActionName): bo ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getactioncountremaining.md b/markdown/bitburner.bladeburner.getactioncountremaining.md index 668c966cc..f68bff956 100644 --- a/markdown/bitburner.bladeburner.getactioncountremaining.md +++ b/markdown/bitburner.bladeburner.getactioncountremaining.md @@ -14,10 +14,55 @@ getActionCountRemaining(type: BladeburnerActionType, name: BladeburnerActionName ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getactioncurrentlevel.md b/markdown/bitburner.bladeburner.getactioncurrentlevel.md index 47333fd1b..cbd106ac8 100644 --- a/markdown/bitburner.bladeburner.getactioncurrentlevel.md +++ b/markdown/bitburner.bladeburner.getactioncurrentlevel.md @@ -14,10 +14,55 @@ getActionCurrentLevel(type: BladeburnerActionType, name: BladeburnerActionName): ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md index afeb3b74c..5ed913864 100644 --- a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md +++ b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md @@ -18,11 +18,71 @@ getActionEstimatedSuccessChance( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | -| sleeveNumber | number | _(Optional)_ Optional. Index of the sleeve to retrieve information. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
+ +sleeveNumber + + + + +number + + + + +_(Optional)_ Optional. Index of the sleeve to retrieve information. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getactionmaxlevel.md b/markdown/bitburner.bladeburner.getactionmaxlevel.md index fa4f0bd9c..228ec8b7b 100644 --- a/markdown/bitburner.bladeburner.getactionmaxlevel.md +++ b/markdown/bitburner.bladeburner.getactionmaxlevel.md @@ -14,10 +14,55 @@ getActionMaxLevel(type: BladeburnerActionType, name: BladeburnerActionName): num ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getactionrepgain.md b/markdown/bitburner.bladeburner.getactionrepgain.md index a00ab51a9..7ee1bb694 100644 --- a/markdown/bitburner.bladeburner.getactionrepgain.md +++ b/markdown/bitburner.bladeburner.getactionrepgain.md @@ -14,11 +14,71 @@ getActionRepGain(type: BladeburnerActionType, name: BladeburnerActionName, level ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | -| level | number | _(Optional)_ Optional number. Action level at which to calculate the gain. Will be the action's current level if not given. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
+ +level + + + + +number + + + + +_(Optional)_ Optional number. Action level at which to calculate the gain. Will be the action's current level if not given. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getactionsuccesses.md b/markdown/bitburner.bladeburner.getactionsuccesses.md index 917525012..938e3165b 100644 --- a/markdown/bitburner.bladeburner.getactionsuccesses.md +++ b/markdown/bitburner.bladeburner.getactionsuccesses.md @@ -14,10 +14,55 @@ getActionSuccesses(type: BladeburnerActionType, name: BladeburnerActionName): nu ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getactiontime.md b/markdown/bitburner.bladeburner.getactiontime.md index af31601b5..464058460 100644 --- a/markdown/bitburner.bladeburner.getactiontime.md +++ b/markdown/bitburner.bladeburner.getactiontime.md @@ -14,10 +14,55 @@ getActionTime(type: BladeburnerActionType, name: BladeburnerActionName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getblackoprank.md b/markdown/bitburner.bladeburner.getblackoprank.md index 109c14527..4ee365d9d 100644 --- a/markdown/bitburner.bladeburner.getblackoprank.md +++ b/markdown/bitburner.bladeburner.getblackoprank.md @@ -14,9 +14,39 @@ getBlackOpRank(name: BladeburnerBlackOpName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| name | [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | Name of BlackOp. Must be an exact match. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +name + + + + +[BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) + + + + +Name of BlackOp. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getcitychaos.md b/markdown/bitburner.bladeburner.getcitychaos.md index c4d77b1ab..5f6d40713 100644 --- a/markdown/bitburner.bladeburner.getcitychaos.md +++ b/markdown/bitburner.bladeburner.getcitychaos.md @@ -14,9 +14,39 @@ getCityChaos(city: CityName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of city. Case-sensitive + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getcitycommunities.md b/markdown/bitburner.bladeburner.getcitycommunities.md index 63e67f656..d1b5a6e54 100644 --- a/markdown/bitburner.bladeburner.getcitycommunities.md +++ b/markdown/bitburner.bladeburner.getcitycommunities.md @@ -14,9 +14,39 @@ getCityCommunities(city: CityName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of city. Case-sensitive + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md index d7cce4421..9afbcd305 100644 --- a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md +++ b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md @@ -14,9 +14,39 @@ getCityEstimatedPopulation(city: CityName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of city. Case-sensitive + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getskilllevel.md b/markdown/bitburner.bladeburner.getskilllevel.md index d11da0cb1..2365a1e9e 100644 --- a/markdown/bitburner.bladeburner.getskilllevel.md +++ b/markdown/bitburner.bladeburner.getskilllevel.md @@ -14,9 +14,39 @@ getSkillLevel(skillName: BladeburnerSkillName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill. Case-sensitive and must be an exact match. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +skillName + + + + +[BladeburnerSkillName](./bitburner.bladeburnerskillname.md) + + + + +Name of skill. Case-sensitive and must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getskillupgradecost.md b/markdown/bitburner.bladeburner.getskillupgradecost.md index c363e2bd6..fcbbaeef4 100644 --- a/markdown/bitburner.bladeburner.getskillupgradecost.md +++ b/markdown/bitburner.bladeburner.getskillupgradecost.md @@ -14,10 +14,55 @@ getSkillUpgradeCost(skillName: BladeburnerSkillName, count?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill. Case-sensitive and must be an exact match. | -| count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +skillName + + + + +[BladeburnerSkillName](./bitburner.bladeburnerskillname.md) + + + + +Name of skill. Case-sensitive and must be an exact match. + + +
+ +count + + + + +number + + + + +_(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.getteamsize.md b/markdown/bitburner.bladeburner.getteamsize.md index bde617b9f..301755086 100644 --- a/markdown/bitburner.bladeburner.getteamsize.md +++ b/markdown/bitburner.bladeburner.getteamsize.md @@ -14,10 +14,55 @@ getTeamSize(type?: BladeburnerActionType, name?: BladeburnerActionName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | _(Optional)_ Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | _(Optional)_ Name of action. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +_(Optional)_ Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +_(Optional)_ Name of action. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.md b/markdown/bitburner.bladeburner.md index 2aedf1a1a..a72ca4f7a 100644 --- a/markdown/bitburner.bladeburner.md +++ b/markdown/bitburner.bladeburner.md @@ -18,45 +18,445 @@ You have to be employed in the Bladeburner division and be in BitNode 6/7 or hav ## Methods -| Method | Description | -| --- | --- | -| [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | Get whether an action is set to autolevel. | -| [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | Get action count remaining. | -| [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | Get the current level of an action. | -| [getActionCurrentTime()](./bitburner.bladeburner.getactioncurrenttime.md) | Get the time elapsed on current action. | -| [getActionEstimatedSuccessChance(type, name, sleeveNumber)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. | -| [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | Get the maximum level of an action. | -| [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | Get the reputation gain of an action. | -| [getActionSuccesses(type, name)](./bitburner.bladeburner.getactionsuccesses.md) | Get action successes. | -| [getActionTime(type, name)](./bitburner.bladeburner.getactiontime.md) | Get the time to complete an action. | -| [getBlackOpNames()](./bitburner.bladeburner.getblackopnames.md) | List all black ops. | -| [getBlackOpRank(name)](./bitburner.bladeburner.getblackoprank.md) | Get black op required rank. | -| [getBonusTime()](./bitburner.bladeburner.getbonustime.md) | Get Bladeburner bonus time. | -| [getCity()](./bitburner.bladeburner.getcity.md) | Get current city. | -| [getCityChaos(city)](./bitburner.bladeburner.getcitychaos.md) | Get chaos of a city. | -| [getCityCommunities(city)](./bitburner.bladeburner.getcitycommunities.md) | Get number of communities in a city. | -| [getCityEstimatedPopulation(city)](./bitburner.bladeburner.getcityestimatedpopulation.md) | Get estimated population in city. | -| [getContractNames()](./bitburner.bladeburner.getcontractnames.md) | List all contracts. | -| [getCurrentAction()](./bitburner.bladeburner.getcurrentaction.md) | Get current action. | -| [getGeneralActionNames()](./bitburner.bladeburner.getgeneralactionnames.md) | List all general actions. | -| [getNextBlackOp()](./bitburner.bladeburner.getnextblackop.md) | Get an object with the name and rank requirement of the next BlackOp that can be completed. | -| [getOperationNames()](./bitburner.bladeburner.getoperationnames.md) | List all operations. | -| [getRank()](./bitburner.bladeburner.getrank.md) | Get player bladeburner rank. | -| [getSkillLevel(skillName)](./bitburner.bladeburner.getskilllevel.md) | Get skill level. | -| [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | List all skills. | -| [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | Get bladeburner skill points. | -| [getSkillUpgradeCost(skillName, count)](./bitburner.bladeburner.getskillupgradecost.md) | Get cost to upgrade skill. | -| [getStamina()](./bitburner.bladeburner.getstamina.md) | Get Bladeburner stamina. | -| [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | Get team size. | -| [inBladeburner()](./bitburner.bladeburner.inbladeburner.md) | Returns whether player is a member of Bladeburner division. Does not require API access. | -| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the Bladeburner division. | -| [joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) | Join the Bladeburner faction. | -| [nextUpdate()](./bitburner.bladeburner.nextupdate.md) | Sleep until the next Bladeburner update has happened. | -| [setActionAutolevel(type, name, autoLevel)](./bitburner.bladeburner.setactionautolevel.md) | Set an action autolevel. | -| [setActionLevel(type, name, level)](./bitburner.bladeburner.setactionlevel.md) | Set the level of an action. | -| [setTeamSize(type, name, size)](./bitburner.bladeburner.setteamsize.md) | Set team size. | -| [startAction(type, name)](./bitburner.bladeburner.startaction.md) | Start an action. | -| [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | Stop current action. | -| [switchCity(city)](./bitburner.bladeburner.switchcity.md) | Travel to another city in Bladeburner. | -| [upgradeSkill(skillName, count)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) + + + + +Get whether an action is set to autolevel. + + +
+ +[getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) + + + + +Get action count remaining. + + +
+ +[getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) + + + + +Get the current level of an action. + + +
+ +[getActionCurrentTime()](./bitburner.bladeburner.getactioncurrenttime.md) + + + + +Get the time elapsed on current action. + + +
+ +[getActionEstimatedSuccessChance(type, name, sleeveNumber)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) + + + + +Get estimate success chance of an action. + + +
+ +[getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) + + + + +Get the maximum level of an action. + + +
+ +[getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) + + + + +Get the reputation gain of an action. + + +
+ +[getActionSuccesses(type, name)](./bitburner.bladeburner.getactionsuccesses.md) + + + + +Get action successes. + + +
+ +[getActionTime(type, name)](./bitburner.bladeburner.getactiontime.md) + + + + +Get the time to complete an action. + + +
+ +[getBlackOpNames()](./bitburner.bladeburner.getblackopnames.md) + + + + +List all black ops. + + +
+ +[getBlackOpRank(name)](./bitburner.bladeburner.getblackoprank.md) + + + + +Get black op required rank. + + +
+ +[getBonusTime()](./bitburner.bladeburner.getbonustime.md) + + + + +Get Bladeburner bonus time. + + +
+ +[getCity()](./bitburner.bladeburner.getcity.md) + + + + +Get current city. + + +
+ +[getCityChaos(city)](./bitburner.bladeburner.getcitychaos.md) + + + + +Get chaos of a city. + + +
+ +[getCityCommunities(city)](./bitburner.bladeburner.getcitycommunities.md) + + + + +Get number of communities in a city. + + +
+ +[getCityEstimatedPopulation(city)](./bitburner.bladeburner.getcityestimatedpopulation.md) + + + + +Get estimated population in city. + + +
+ +[getContractNames()](./bitburner.bladeburner.getcontractnames.md) + + + + +List all contracts. + + +
+ +[getCurrentAction()](./bitburner.bladeburner.getcurrentaction.md) + + + + +Get current action. + + +
+ +[getGeneralActionNames()](./bitburner.bladeburner.getgeneralactionnames.md) + + + + +List all general actions. + + +
+ +[getNextBlackOp()](./bitburner.bladeburner.getnextblackop.md) + + + + +Get an object with the name and rank requirement of the next BlackOp that can be completed. + + +
+ +[getOperationNames()](./bitburner.bladeburner.getoperationnames.md) + + + + +List all operations. + + +
+ +[getRank()](./bitburner.bladeburner.getrank.md) + + + + +Get player bladeburner rank. + + +
+ +[getSkillLevel(skillName)](./bitburner.bladeburner.getskilllevel.md) + + + + +Get skill level. + + +
+ +[getSkillNames()](./bitburner.bladeburner.getskillnames.md) + + + + +List all skills. + + +
+ +[getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) + + + + +Get bladeburner skill points. + + +
+ +[getSkillUpgradeCost(skillName, count)](./bitburner.bladeburner.getskillupgradecost.md) + + + + +Get cost to upgrade skill. + + +
+ +[getStamina()](./bitburner.bladeburner.getstamina.md) + + + + +Get Bladeburner stamina. + + +
+ +[getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) + + + + +Get team size. + + +
+ +[inBladeburner()](./bitburner.bladeburner.inbladeburner.md) + + + + +Returns whether player is a member of Bladeburner division. Does not require API access. + + +
+ +[joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) + + + + +Join the Bladeburner division. + + +
+ +[joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) + + + + +Join the Bladeburner faction. + + +
+ +[nextUpdate()](./bitburner.bladeburner.nextupdate.md) + + + + +Sleep until the next Bladeburner update has happened. + + +
+ +[setActionAutolevel(type, name, autoLevel)](./bitburner.bladeburner.setactionautolevel.md) + + + + +Set an action autolevel. + + +
+ +[setActionLevel(type, name, level)](./bitburner.bladeburner.setactionlevel.md) + + + + +Set the level of an action. + + +
+ +[setTeamSize(type, name, size)](./bitburner.bladeburner.setteamsize.md) + + + + +Set team size. + + +
+ +[startAction(type, name)](./bitburner.bladeburner.startaction.md) + + + + +Start an action. + + +
+ +[stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) + + + + +Stop current action. + + +
+ +[switchCity(city)](./bitburner.bladeburner.switchcity.md) + + + + +Travel to another city in Bladeburner. + + +
+ +[upgradeSkill(skillName, count)](./bitburner.bladeburner.upgradeskill.md) + + + + +Upgrade skill. + + +
diff --git a/markdown/bitburner.bladeburner.setactionautolevel.md b/markdown/bitburner.bladeburner.setactionautolevel.md index 0a371f0bd..4fa8e8f8f 100644 --- a/markdown/bitburner.bladeburner.setactionautolevel.md +++ b/markdown/bitburner.bladeburner.setactionautolevel.md @@ -14,11 +14,71 @@ setActionAutolevel(type: BladeburnerActionType, name: BladeburnerActionName, aut ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | -| autoLevel | boolean | Whether or not to autolevel this action | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
+ +autoLevel + + + + +boolean + + + + +Whether or not to autolevel this action + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.setactionlevel.md b/markdown/bitburner.bladeburner.setactionlevel.md index 79b42e0f7..ff398c732 100644 --- a/markdown/bitburner.bladeburner.setactionlevel.md +++ b/markdown/bitburner.bladeburner.setactionlevel.md @@ -14,11 +14,71 @@ setActionLevel(type: BladeburnerActionType, name: BladeburnerActionName, level: ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | -| level | number | Level to set this action to. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
+ +level + + + + +number + + + + +Level to set this action to. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.setteamsize.md b/markdown/bitburner.bladeburner.setteamsize.md index 9585a79d9..4fcf4a32a 100644 --- a/markdown/bitburner.bladeburner.setteamsize.md +++ b/markdown/bitburner.bladeburner.setteamsize.md @@ -14,11 +14,71 @@ setTeamSize(type: BladeburnerActionType, name: BladeburnerActionName, size: numb ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match. | -| size | number | Number of team members to set. Must be a non-negative integer. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match. + + +
+ +size + + + + +number + + + + +Number of team members to set. Must be a non-negative integer. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.startaction.md b/markdown/bitburner.bladeburner.startaction.md index 775b4632f..5e380f803 100644 --- a/markdown/bitburner.bladeburner.startaction.md +++ b/markdown/bitburner.bladeburner.startaction.md @@ -14,10 +14,55 @@ startAction(type: BladeburnerActionType, name: BladeburnerActionName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | Type of action. | -| name | [BladeburnerActionName](./bitburner.bladeburneractionname.md) | Name of action. Must be an exact match | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + +Type of action. + + +
+ +name + + + + +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + +Name of action. Must be an exact match + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.switchcity.md b/markdown/bitburner.bladeburner.switchcity.md index f0df65280..4077fffce 100644 --- a/markdown/bitburner.bladeburner.switchcity.md +++ b/markdown/bitburner.bladeburner.switchcity.md @@ -14,9 +14,39 @@ switchCity(city: CityName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) | Name of city. Case-sensitive | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of city. Case-sensitive + + +
**Returns:** diff --git a/markdown/bitburner.bladeburner.upgradeskill.md b/markdown/bitburner.bladeburner.upgradeskill.md index eb5ad9216..42821cece 100644 --- a/markdown/bitburner.bladeburner.upgradeskill.md +++ b/markdown/bitburner.bladeburner.upgradeskill.md @@ -14,10 +14,55 @@ upgradeSkill(skillName: BladeburnerSkillName, count?: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| skillName | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Name of skill to be upgraded. Case-sensitive and must be an exact match. | -| count | number | _(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +skillName + + + + +[BladeburnerSkillName](./bitburner.bladeburnerskillname.md) + + + + +Name of skill to be upgraded. Case-sensitive and must be an exact match. + + +
+ +count + + + + +number + + + + +_(Optional)_ Number of times to upgrade the skill. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburnercuraction.md b/markdown/bitburner.bladeburnercuraction.md index 880d4675a..a383554d0 100644 --- a/markdown/bitburner.bladeburnercuraction.md +++ b/markdown/bitburner.bladeburnercuraction.md @@ -14,8 +14,64 @@ interface BladeburnerCurAction ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [name](./bitburner.bladeburnercuraction.name.md) | | string | Name of Action | -| [type](./bitburner.bladeburnercuraction.type.md) | | string | Type of Action | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[name](./bitburner.bladeburnercuraction.name.md) + + + + + + + +string + + + + +Name of Action + + +
+ +[type](./bitburner.bladeburnercuraction.type.md) + + + + + + + +string + + + + +Type of Action + + +
diff --git a/markdown/bitburner.bladeburnerformulas.md b/markdown/bitburner.bladeburnerformulas.md index cd9c53985..e7f636a29 100644 --- a/markdown/bitburner.bladeburnerformulas.md +++ b/markdown/bitburner.bladeburnerformulas.md @@ -14,7 +14,27 @@ interface BladeburnerFormulas ## Methods -| Method | Description | -| --- | --- | -| [skillMaxUpgradeCount(name, level, skillPoints)](./bitburner.bladeburnerformulas.skillmaxupgradecount.md) | Calculate the number of times that you can upgrade a skill. | + + +
+ +Method + + + + +Description + + +
+ +[skillMaxUpgradeCount(name, level, skillPoints)](./bitburner.bladeburnerformulas.skillmaxupgradecount.md) + + + + +Calculate the number of times that you can upgrade a skill. + + +
diff --git a/markdown/bitburner.bladeburnerformulas.skillmaxupgradecount.md b/markdown/bitburner.bladeburnerformulas.skillmaxupgradecount.md index dfaa32c82..07679be94 100644 --- a/markdown/bitburner.bladeburnerformulas.skillmaxupgradecount.md +++ b/markdown/bitburner.bladeburnerformulas.skillmaxupgradecount.md @@ -14,11 +14,71 @@ skillMaxUpgradeCount(name: BladeburnerSkillName, level: number, skillPoints: num ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| name | [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | Skill name. It's case-sensitive and must be an exact match. | -| level | number | Skill level. It must be a non-negative number. | -| skillPoints | number | Number of skill points to upgrade the skill. It must be a non-negative number. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +name + + + + +[BladeburnerSkillName](./bitburner.bladeburnerskillname.md) + + + + +Skill name. It's case-sensitive and must be an exact match. + + +
+ +level + + + + +number + + + + +Skill level. It must be a non-negative number. + + +
+ +skillPoints + + + + +number + + + + +Number of skill points to upgrade the skill. It must be a non-negative number. + + +
**Returns:** diff --git a/markdown/bitburner.bladeburnerrankrequirement.md b/markdown/bitburner.bladeburnerrankrequirement.md index 3bf96e7dc..02709cdf1 100644 --- a/markdown/bitburner.bladeburnerrankrequirement.md +++ b/markdown/bitburner.bladeburnerrankrequirement.md @@ -14,8 +14,60 @@ interface BladeburnerRankRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [bladeburnerRank](./bitburner.bladeburnerrankrequirement.bladeburnerrank.md) | | number | | -| [type](./bitburner.bladeburnerrankrequirement.type.md) | | "bladeburnerRank" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[bladeburnerRank](./bitburner.bladeburnerrankrequirement.bladeburnerrank.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.bladeburnerrankrequirement.type.md) + + + + + + + +"bladeburnerRank" + + + + + +
diff --git a/markdown/bitburner.cityrequirement.md b/markdown/bitburner.cityrequirement.md index d74db0fd4..173cfc647 100644 --- a/markdown/bitburner.cityrequirement.md +++ b/markdown/bitburner.cityrequirement.md @@ -14,8 +14,60 @@ interface CityRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [city](./bitburner.cityrequirement.city.md) | | [CityName](./bitburner.cityname.md) | | -| [type](./bitburner.cityrequirement.type.md) | | "city" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[city](./bitburner.cityrequirement.city.md) + + + + + + + +[CityName](./bitburner.cityname.md) + + + + + +
+ +[type](./bitburner.cityrequirement.type.md) + + + + + + + +"city" + + + + + +
diff --git a/markdown/bitburner.codingcontract.attempt.md b/markdown/bitburner.codingcontract.attempt.md index d903bc41f..1f00f9d9f 100644 --- a/markdown/bitburner.codingcontract.attempt.md +++ b/markdown/bitburner.codingcontract.attempt.md @@ -14,11 +14,71 @@ attempt(answer: any, filename: string, host?: string): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| answer | any | Attempted solution for the contract. This can be a string formatted like submitting manually, or the answer in the format of the specific contract type. | -| filename | string | Filename of the contract. | -| host | string | _(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +answer + + + + +any + + + + +Attempted solution for the contract. This can be a string formatted like submitting manually, or the answer in the format of the specific contract type. + + +
+ +filename + + + + +string + + + + +Filename of the contract. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. + + +
**Returns:** diff --git a/markdown/bitburner.codingcontract.createdummycontract.md b/markdown/bitburner.codingcontract.createdummycontract.md index 589b33c0a..53d2b9bf9 100644 --- a/markdown/bitburner.codingcontract.createdummycontract.md +++ b/markdown/bitburner.codingcontract.createdummycontract.md @@ -14,9 +14,39 @@ createDummyContract(type: CodingContractName): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| type | [CodingContractName](./bitburner.codingcontractname.md) | Type of contract to generate | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +type + + + + +[CodingContractName](./bitburner.codingcontractname.md) + + + + +Type of contract to generate + + +
**Returns:** diff --git a/markdown/bitburner.codingcontract.getcontract.md b/markdown/bitburner.codingcontract.getcontract.md index f64cb9842..55915c79a 100644 --- a/markdown/bitburner.codingcontract.getcontract.md +++ b/markdown/bitburner.codingcontract.getcontract.md @@ -14,10 +14,55 @@ getContract(filename: string, host?: string): CodingContractObject; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Filename of the contract. | -| host | string | _(Optional)_ Hostname/IP of the server containing the contract. Optional. Default to the current server if not provided. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Filename of the contract. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the server containing the contract. Optional. Default to the current server if not provided. + + +
**Returns:** diff --git a/markdown/bitburner.codingcontract.getcontracttype.md b/markdown/bitburner.codingcontract.getcontracttype.md index 038e45d99..55410cc0d 100644 --- a/markdown/bitburner.codingcontract.getcontracttype.md +++ b/markdown/bitburner.codingcontract.getcontracttype.md @@ -14,10 +14,55 @@ getContractType(filename: string, host?: string): CodingContractName; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Filename of the contract. | -| host | string | _(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Filename of the contract. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. + + +
**Returns:** diff --git a/markdown/bitburner.codingcontract.getdata.md b/markdown/bitburner.codingcontract.getdata.md index f69df8d52..0b5dc39fb 100644 --- a/markdown/bitburner.codingcontract.getdata.md +++ b/markdown/bitburner.codingcontract.getdata.md @@ -14,10 +14,55 @@ getData(filename: string, host?: string): any; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Filename of the contract. | -| host | string | _(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Filename of the contract. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. + + +
**Returns:** diff --git a/markdown/bitburner.codingcontract.getdescription.md b/markdown/bitburner.codingcontract.getdescription.md index 7919e82cc..05abf2a15 100644 --- a/markdown/bitburner.codingcontract.getdescription.md +++ b/markdown/bitburner.codingcontract.getdescription.md @@ -14,10 +14,55 @@ getDescription(filename: string, host?: string): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Filename of the contract. | -| host | string | _(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Filename of the contract. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. + + +
**Returns:** diff --git a/markdown/bitburner.codingcontract.getnumtriesremaining.md b/markdown/bitburner.codingcontract.getnumtriesremaining.md index 73176a942..22e9e5df8 100644 --- a/markdown/bitburner.codingcontract.getnumtriesremaining.md +++ b/markdown/bitburner.codingcontract.getnumtriesremaining.md @@ -14,10 +14,55 @@ getNumTriesRemaining(filename: string, host?: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Filename of the contract. | -| host | string | _(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Filename of the contract. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided. + + +
**Returns:** diff --git a/markdown/bitburner.codingcontract.md b/markdown/bitburner.codingcontract.md index 9b4890910..356a4efa5 100644 --- a/markdown/bitburner.codingcontract.md +++ b/markdown/bitburner.codingcontract.md @@ -14,14 +14,104 @@ export interface CodingContract ## Methods -| Method | Description | -| --- | --- | -| [attempt(answer, filename, host)](./bitburner.codingcontract.attempt.md) | Attempts a coding contract, returning a reward string on success or empty string on failure. | -| [createDummyContract(type)](./bitburner.codingcontract.createdummycontract.md) | Generate a dummy contract. | -| [getContract(filename, host)](./bitburner.codingcontract.getcontract.md) | Get various data about a specific contract. | -| [getContractType(filename, host)](./bitburner.codingcontract.getcontracttype.md) | Get the type of a coding contract. | -| [getContractTypes()](./bitburner.codingcontract.getcontracttypes.md) | List all contract types. | -| [getData(filename, host)](./bitburner.codingcontract.getdata.md) | Get the input data. | -| [getDescription(filename, host)](./bitburner.codingcontract.getdescription.md) | Get the description. | -| [getNumTriesRemaining(filename, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of attempts remaining. | + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[attempt(answer, filename, host)](./bitburner.codingcontract.attempt.md) + + + + +Attempts a coding contract, returning a reward string on success or empty string on failure. + + +
+ +[createDummyContract(type)](./bitburner.codingcontract.createdummycontract.md) + + + + +Generate a dummy contract. + + +
+ +[getContract(filename, host)](./bitburner.codingcontract.getcontract.md) + + + + +Get various data about a specific contract. + + +
+ +[getContractType(filename, host)](./bitburner.codingcontract.getcontracttype.md) + + + + +Get the type of a coding contract. + + +
+ +[getContractTypes()](./bitburner.codingcontract.getcontracttypes.md) + + + + +List all contract types. + + +
+ +[getData(filename, host)](./bitburner.codingcontract.getdata.md) + + + + +Get the input data. + + +
+ +[getDescription(filename, host)](./bitburner.codingcontract.getdescription.md) + + + + +Get the description. + + +
+ +[getNumTriesRemaining(filename, host)](./bitburner.codingcontract.getnumtriesremaining.md) + + + + +Get the number of attempts remaining. + + +
diff --git a/markdown/bitburner.companypositioninfo.md b/markdown/bitburner.companypositioninfo.md index 538e84634..57c117def 100644 --- a/markdown/bitburner.companypositioninfo.md +++ b/markdown/bitburner.companypositioninfo.md @@ -14,12 +14,128 @@ export interface CompanyPositionInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [field](./bitburner.companypositioninfo.field.md) | | [JobField](./bitburner.jobfield.md) | | -| [name](./bitburner.companypositioninfo.name.md) | | [JobName](./bitburner.jobname.md) | | -| [nextPosition](./bitburner.companypositioninfo.nextposition.md) | | [JobName](./bitburner.jobname.md) \| null | | -| [requiredReputation](./bitburner.companypositioninfo.requiredreputation.md) | | number | | -| [requiredSkills](./bitburner.companypositioninfo.requiredskills.md) | | [Skills](./bitburner.skills.md) | | -| [salary](./bitburner.companypositioninfo.salary.md) | | number | | + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[field](./bitburner.companypositioninfo.field.md) + + + + + + + +[JobField](./bitburner.jobfield.md) + + + + + +
+ +[name](./bitburner.companypositioninfo.name.md) + + + + + + + +[JobName](./bitburner.jobname.md) + + + + + +
+ +[nextPosition](./bitburner.companypositioninfo.nextposition.md) + + + + + + + +[JobName](./bitburner.jobname.md) \| null + + + + + +
+ +[requiredReputation](./bitburner.companypositioninfo.requiredreputation.md) + + + + + + + +number + + + + + +
+ +[requiredSkills](./bitburner.companypositioninfo.requiredskills.md) + + + + + + + +[Skills](./bitburner.skills.md) + + + + + +
+ +[salary](./bitburner.companypositioninfo.salary.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.companyreputationrequirement.md b/markdown/bitburner.companyreputationrequirement.md index 3b820897d..f8ddf36fa 100644 --- a/markdown/bitburner.companyreputationrequirement.md +++ b/markdown/bitburner.companyreputationrequirement.md @@ -14,9 +14,77 @@ interface CompanyReputationRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [company](./bitburner.companyreputationrequirement.company.md) | | [CompanyName](./bitburner.companyname.md) | | -| [reputation](./bitburner.companyreputationrequirement.reputation.md) | | number | | -| [type](./bitburner.companyreputationrequirement.type.md) | | "companyReputation" | | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[company](./bitburner.companyreputationrequirement.company.md) + + + + + + + +[CompanyName](./bitburner.companyname.md) + + + + + +
+ +[reputation](./bitburner.companyreputationrequirement.reputation.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.companyreputationrequirement.type.md) + + + + + + + +"companyReputation" + + + + + +
diff --git a/markdown/bitburner.companyworktask.md b/markdown/bitburner.companyworktask.md index d1af0f3c2..7cb0a9942 100644 --- a/markdown/bitburner.companyworktask.md +++ b/markdown/bitburner.companyworktask.md @@ -19,8 +19,60 @@ An object representing the current work for a company ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [companyName](./bitburner.companyworktask.companyname.md) | | [CompanyName](./bitburner.companyname.md) | | -| [type](./bitburner.companyworktask.type.md) | | "COMPANY" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[companyName](./bitburner.companyworktask.companyname.md) + + + + + + + +[CompanyName](./bitburner.companyname.md) + + + + + +
+ +[type](./bitburner.companyworktask.type.md) + + + + + + + +"COMPANY" + + + + + +
diff --git a/markdown/bitburner.corpconstants.md b/markdown/bitburner.corpconstants.md index 52da97100..ad0a8f8e6 100644 --- a/markdown/bitburner.corpconstants.md +++ b/markdown/bitburner.corpconstants.md @@ -14,39 +14,617 @@ interface CorpConstants ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [baseProductProfitMult](./bitburner.corpconstants.baseproductprofitmult.md) | | number | | -| [bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md) | | number | | -| [bribeThreshold](./bitburner.corpconstants.bribethreshold.md) | | number | | -| [dividendMaxRate](./bitburner.corpconstants.dividendmaxrate.md) | | number | | -| [employeePositions](./bitburner.corpconstants.employeepositions.md) | | [CorpEmployeePosition](./bitburner.corpemployeeposition.md)\[\] | Names of all employee positions | -| [employeeRaiseAmount](./bitburner.corpconstants.employeeraiseamount.md) | | number | | -| [employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md) | | number | Conversion factor for employee stats to initial salary | -| [gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md) | | number | | -| [gameCyclesPerMarketCycle](./bitburner.corpconstants.gamecyclespermarketcycle.md) | | number | | -| [industryNames](./bitburner.corpconstants.industrynames.md) | | [CorpIndustryName](./bitburner.corpindustryname.md)\[\] | Names of all industries | -| [initialShares](./bitburner.corpconstants.initialshares.md) | | number | | -| [issueNewSharesCooldown](./bitburner.corpconstants.issuenewsharescooldown.md) | | number | Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms) | -| [marketCyclesPerEmployeeRaise](./bitburner.corpconstants.marketcyclesperemployeeraise.md) | | number | | -| [materialNames](./bitburner.corpconstants.materialnames.md) | | [CorpMaterialName](./bitburner.corpmaterialname.md)\[\] | Names of all materials | -| [maxProductsBase](./bitburner.corpconstants.maxproductsbase.md) | | number | Max products for a division without upgrades | -| [minEmployeeDecay](./bitburner.corpconstants.minemployeedecay.md) | | number | The minimum decay value for morale/energy | -| [officeInitialCost](./bitburner.corpconstants.officeinitialcost.md) | | number | | -| [officeInitialSize](./bitburner.corpconstants.officeinitialsize.md) | | number | | -| [officeSizeUpgradeCostBase](./bitburner.corpconstants.officesizeupgradecostbase.md) | | number | | -| [researchNames](./bitburner.corpconstants.researchnames.md) | | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches | -| [researchNamesBase](./bitburner.corpconstants.researchnamesbase.md) | | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches common to all industries | -| [researchNamesProductOnly](./bitburner.corpconstants.researchnamesproductonly.md) | | [CorpResearchName](./bitburner.corpresearchname.md)\[\] | Names of all researches only available to product industries | -| [secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md) | | number | | -| [sellSharesCooldown](./bitburner.corpconstants.sellsharescooldown.md) | | number | Cooldown for selling shares in game cycles (1 game cycle = 200ms) | -| [sharesPerPriceUpdate](./bitburner.corpconstants.sharesperpriceupdate.md) | | number | When selling large number of shares, price is dynamically updated for every batch of this amount | -| [smartSupplyOptions](./bitburner.corpconstants.smartsupplyoptions.md) | | [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md)\[\] | | -| [stateNames](./bitburner.corpconstants.statenames.md) | | [CorpStateName](./bitburner.corpstatename.md)\[\] | Names of all corporation game states | -| [teaCostPerEmployee](./bitburner.corpconstants.teacostperemployee.md) | | number | | -| [unlockNames](./bitburner.corpconstants.unlocknames.md) | | [CorpUnlockName](./bitburner.corpunlockname.md)\[\] | Names of all one-time corporation-wide unlocks | -| [upgradeNames](./bitburner.corpconstants.upgradenames.md) | | [CorpUpgradeName](./bitburner.corpupgradename.md)\[\] | Names of all corporation-wide upgrades | -| [warehouseInitialCost](./bitburner.corpconstants.warehouseinitialcost.md) | | number | | -| [warehouseInitialSize](./bitburner.corpconstants.warehouseinitialsize.md) | | number | | -| [warehouseSizeUpgradeCostBase](./bitburner.corpconstants.warehousesizeupgradecostbase.md) | | number | | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[baseProductProfitMult](./bitburner.corpconstants.baseproductprofitmult.md) + + + + + + + +number + + + + + +
+ +[bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md) + + + + + + + +number + + + + + +
+ +[bribeThreshold](./bitburner.corpconstants.bribethreshold.md) + + + + + + + +number + + + + + +
+ +[dividendMaxRate](./bitburner.corpconstants.dividendmaxrate.md) + + + + + + + +number + + + + + +
+ +[employeePositions](./bitburner.corpconstants.employeepositions.md) + + + + + + + +[CorpEmployeePosition](./bitburner.corpemployeeposition.md)\[\] + + + + +Names of all employee positions + + +
+ +[employeeRaiseAmount](./bitburner.corpconstants.employeeraiseamount.md) + + + + + + + +number + + + + + +
+ +[employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md) + + + + + + + +number + + + + +Conversion factor for employee stats to initial salary + + +
+ +[gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md) + + + + + + + +number + + + + + +
+ +[gameCyclesPerMarketCycle](./bitburner.corpconstants.gamecyclespermarketcycle.md) + + + + + + + +number + + + + + +
+ +[industryNames](./bitburner.corpconstants.industrynames.md) + + + + + + + +[CorpIndustryName](./bitburner.corpindustryname.md)\[\] + + + + +Names of all industries + + +
+ +[initialShares](./bitburner.corpconstants.initialshares.md) + + + + + + + +number + + + + + +
+ +[issueNewSharesCooldown](./bitburner.corpconstants.issuenewsharescooldown.md) + + + + + + + +number + + + + +Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms) + + +
+ +[marketCyclesPerEmployeeRaise](./bitburner.corpconstants.marketcyclesperemployeeraise.md) + + + + + + + +number + + + + + +
+ +[materialNames](./bitburner.corpconstants.materialnames.md) + + + + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md)\[\] + + + + +Names of all materials + + +
+ +[maxProductsBase](./bitburner.corpconstants.maxproductsbase.md) + + + + + + + +number + + + + +Max products for a division without upgrades + + +
+ +[minEmployeeDecay](./bitburner.corpconstants.minemployeedecay.md) + + + + + + + +number + + + + +The minimum decay value for morale/energy + + +
+ +[officeInitialCost](./bitburner.corpconstants.officeinitialcost.md) + + + + + + + +number + + + + + +
+ +[officeInitialSize](./bitburner.corpconstants.officeinitialsize.md) + + + + + + + +number + + + + + +
+ +[officeSizeUpgradeCostBase](./bitburner.corpconstants.officesizeupgradecostbase.md) + + + + + + + +number + + + + + +
+ +[researchNames](./bitburner.corpconstants.researchnames.md) + + + + + + + +[CorpResearchName](./bitburner.corpresearchname.md)\[\] + + + + +Names of all researches + + +
+ +[researchNamesBase](./bitburner.corpconstants.researchnamesbase.md) + + + + + + + +[CorpResearchName](./bitburner.corpresearchname.md)\[\] + + + + +Names of all researches common to all industries + + +
+ +[researchNamesProductOnly](./bitburner.corpconstants.researchnamesproductonly.md) + + + + + + + +[CorpResearchName](./bitburner.corpresearchname.md)\[\] + + + + +Names of all researches only available to product industries + + +
+ +[secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md) + + + + + + + +number + + + + + +
+ +[sellSharesCooldown](./bitburner.corpconstants.sellsharescooldown.md) + + + + + + + +number + + + + +Cooldown for selling shares in game cycles (1 game cycle = 200ms) + + +
+ +[sharesPerPriceUpdate](./bitburner.corpconstants.sharesperpriceupdate.md) + + + + + + + +number + + + + +When selling large number of shares, price is dynamically updated for every batch of this amount + + +
+ +[smartSupplyOptions](./bitburner.corpconstants.smartsupplyoptions.md) + + + + + + + +[CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md)\[\] + + + + + +
+ +[stateNames](./bitburner.corpconstants.statenames.md) + + + + + + + +[CorpStateName](./bitburner.corpstatename.md)\[\] + + + + +Names of all corporation game states + + +
+ +[teaCostPerEmployee](./bitburner.corpconstants.teacostperemployee.md) + + + + + + + +number + + + + + +
+ +[unlockNames](./bitburner.corpconstants.unlocknames.md) + + + + + + + +[CorpUnlockName](./bitburner.corpunlockname.md)\[\] + + + + +Names of all one-time corporation-wide unlocks + + +
+ +[upgradeNames](./bitburner.corpconstants.upgradenames.md) + + + + + + + +[CorpUpgradeName](./bitburner.corpupgradename.md)\[\] + + + + +Names of all corporation-wide upgrades + + +
+ +[warehouseInitialCost](./bitburner.corpconstants.warehouseinitialcost.md) + + + + + + + +number + + + + + +
+ +[warehouseInitialSize](./bitburner.corpconstants.warehouseinitialsize.md) + + + + + + + +number + + + + + +
+ +[warehouseSizeUpgradeCostBase](./bitburner.corpconstants.warehousesizeupgradecostbase.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.corpindustrydata.md b/markdown/bitburner.corpindustrydata.md index e8fbe2beb..ef3dcd809 100644 --- a/markdown/bitburner.corpindustrydata.md +++ b/markdown/bitburner.corpindustrydata.md @@ -14,20 +14,284 @@ interface CorpIndustryData ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [advertisingFactor?](./bitburner.corpindustrydata.advertisingfactor.md) | | number | _(Optional)_ Advertising factor (affects sales) | -| [aiCoreFactor?](./bitburner.corpindustrydata.aicorefactor.md) | | number | _(Optional)_ AI Cores factor | -| [description](./bitburner.corpindustrydata.description.md) | | string | | -| [hardwareFactor?](./bitburner.corpindustrydata.hardwarefactor.md) | | number | _(Optional)_ Hardware factor | -| [makesMaterials](./bitburner.corpindustrydata.makesmaterials.md) | | boolean | Whether the industry of this division is capable of producing materials | -| [makesProducts](./bitburner.corpindustrydata.makesproducts.md) | | boolean | Whether the industry of this division is capable of developing and producing products | -| [producedMaterials?](./bitburner.corpindustrydata.producedmaterials.md) | | [CorpMaterialName](./bitburner.corpmaterialname.md)\[\] | _(Optional)_ Array of Materials produced | -| [product?](./bitburner.corpindustrydata.product.md) | | [CorpProductData](./bitburner.corpproductdata.md) | _(Optional)_ | -| [realEstateFactor?](./bitburner.corpindustrydata.realestatefactor.md) | | number | _(Optional)_ Real estate factor | -| [recommendStarting](./bitburner.corpindustrydata.recommendstarting.md) | | boolean | | -| [requiredMaterials](./bitburner.corpindustrydata.requiredmaterials.md) | | Partial<Record<[CorpMaterialName](./bitburner.corpmaterialname.md), number>> | | -| [robotFactor?](./bitburner.corpindustrydata.robotfactor.md) | | number | _(Optional)_ Robots factor | -| [scienceFactor?](./bitburner.corpindustrydata.sciencefactor.md) | | number | _(Optional)_ Scientific research factor (affects quality) | -| [startingCost](./bitburner.corpindustrydata.startingcost.md) | | number | | + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[advertisingFactor?](./bitburner.corpindustrydata.advertisingfactor.md) + + + + + + + +number + + + + +_(Optional)_ Advertising factor (affects sales) + + +
+ +[aiCoreFactor?](./bitburner.corpindustrydata.aicorefactor.md) + + + + + + + +number + + + + +_(Optional)_ AI Cores factor + + +
+ +[description](./bitburner.corpindustrydata.description.md) + + + + + + + +string + + + + + +
+ +[hardwareFactor?](./bitburner.corpindustrydata.hardwarefactor.md) + + + + + + + +number + + + + +_(Optional)_ Hardware factor + + +
+ +[makesMaterials](./bitburner.corpindustrydata.makesmaterials.md) + + + + + + + +boolean + + + + +Whether the industry of this division is capable of producing materials + + +
+ +[makesProducts](./bitburner.corpindustrydata.makesproducts.md) + + + + + + + +boolean + + + + +Whether the industry of this division is capable of developing and producing products + + +
+ +[producedMaterials?](./bitburner.corpindustrydata.producedmaterials.md) + + + + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md)\[\] + + + + +_(Optional)_ Array of Materials produced + + +
+ +[product?](./bitburner.corpindustrydata.product.md) + + + + + + + +[CorpProductData](./bitburner.corpproductdata.md) + + + + +_(Optional)_ + + +
+ +[realEstateFactor?](./bitburner.corpindustrydata.realestatefactor.md) + + + + + + + +number + + + + +_(Optional)_ Real estate factor + + +
+ +[recommendStarting](./bitburner.corpindustrydata.recommendstarting.md) + + + + + + + +boolean + + + + + +
+ +[requiredMaterials](./bitburner.corpindustrydata.requiredmaterials.md) + + + + + + + +Partial<Record<[CorpMaterialName](./bitburner.corpmaterialname.md), number>> + + + + + +
+ +[robotFactor?](./bitburner.corpindustrydata.robotfactor.md) + + + + + + + +number + + + + +_(Optional)_ Robots factor + + +
+ +[scienceFactor?](./bitburner.corpindustrydata.sciencefactor.md) + + + + + + + +number + + + + +_(Optional)_ Scientific research factor (affects quality) + + +
+ +[startingCost](./bitburner.corpindustrydata.startingcost.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.corpmaterialconstantdata.md b/markdown/bitburner.corpmaterialconstantdata.md index a7e722621..7c2ae4ab9 100644 --- a/markdown/bitburner.corpmaterialconstantdata.md +++ b/markdown/bitburner.corpmaterialconstantdata.md @@ -14,15 +14,185 @@ interface CorpMaterialConstantData ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [baseCost](./bitburner.corpmaterialconstantdata.basecost.md) | | number | | -| [baseMarkup](./bitburner.corpmaterialconstantdata.basemarkup.md) | | number | | -| [competitionBase](./bitburner.corpmaterialconstantdata.competitionbase.md) | | number | | -| [competitionRange](./bitburner.corpmaterialconstantdata.competitionrange.md) | | \[min: number, max: number\] | | -| [demandBase](./bitburner.corpmaterialconstantdata.demandbase.md) | | number | | -| [demandRange](./bitburner.corpmaterialconstantdata.demandrange.md) | | \[min: number, max: number\] | Min and max demand | -| [maxVolatility](./bitburner.corpmaterialconstantdata.maxvolatility.md) | | number | | -| [name](./bitburner.corpmaterialconstantdata.name.md) | | string | Name of the material | -| [size](./bitburner.corpmaterialconstantdata.size.md) | | number | Size of the material | + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[baseCost](./bitburner.corpmaterialconstantdata.basecost.md) + + + + + + + +number + + + + + +
+ +[baseMarkup](./bitburner.corpmaterialconstantdata.basemarkup.md) + + + + + + + +number + + + + + +
+ +[competitionBase](./bitburner.corpmaterialconstantdata.competitionbase.md) + + + + + + + +number + + + + + +
+ +[competitionRange](./bitburner.corpmaterialconstantdata.competitionrange.md) + + + + + + + +\[min: number, max: number\] + + + + + +
+ +[demandBase](./bitburner.corpmaterialconstantdata.demandbase.md) + + + + + + + +number + + + + + +
+ +[demandRange](./bitburner.corpmaterialconstantdata.demandrange.md) + + + + + + + +\[min: number, max: number\] + + + + +Min and max demand + + +
+ +[maxVolatility](./bitburner.corpmaterialconstantdata.maxvolatility.md) + + + + + + + +number + + + + + +
+ +[name](./bitburner.corpmaterialconstantdata.name.md) + + + + + + + +string + + + + +Name of the material + + +
+ +[size](./bitburner.corpmaterialconstantdata.size.md) + + + + + + + +number + + + + +Size of the material + + +
diff --git a/markdown/bitburner.corporation.bribe.md b/markdown/bitburner.corporation.bribe.md index b3529f74e..6278f37c8 100644 --- a/markdown/bitburner.corporation.bribe.md +++ b/markdown/bitburner.corporation.bribe.md @@ -20,10 +20,55 @@ bribe(factionName: FactionName, amountCash: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| factionName | [FactionName](./bitburner.factionname.md) | Faction name | -| amountCash | number | Amount of money to bribe | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +factionName + + + + +[FactionName](./bitburner.factionname.md) + + + + +Faction name + + +
+ +amountCash + + + + +number + + + + +Amount of money to bribe + + +
**Returns:** diff --git a/markdown/bitburner.corporation.buybackshares.md b/markdown/bitburner.corporation.buybackshares.md index d84f31f6b..d425eb9f4 100644 --- a/markdown/bitburner.corporation.buybackshares.md +++ b/markdown/bitburner.corporation.buybackshares.md @@ -14,9 +14,39 @@ buyBackShares(amount: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| amount | number | Amount of shares to buy back, must be integer and larger than 0 | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +amount + + + + +number + + + + +Amount of shares to buy back, must be integer and larger than 0 + + +
**Returns:** diff --git a/markdown/bitburner.corporation.cancreatecorporation.md b/markdown/bitburner.corporation.cancreatecorporation.md index 0b769e4c1..b50f2f1b9 100644 --- a/markdown/bitburner.corporation.cancreatecorporation.md +++ b/markdown/bitburner.corporation.cancreatecorporation.md @@ -14,9 +14,39 @@ canCreateCorporation(selfFund: boolean): CreatingCorporationCheckResult; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| selfFund | boolean | true if you want to self-fund, false otherwise | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +selfFund + + + + +boolean + + + + +true if you want to self-fund, false otherwise + + +
**Returns:** diff --git a/markdown/bitburner.corporation.createcorporation.md b/markdown/bitburner.corporation.createcorporation.md index c61b14e2d..77daca10a 100644 --- a/markdown/bitburner.corporation.createcorporation.md +++ b/markdown/bitburner.corporation.createcorporation.md @@ -18,10 +18,55 @@ createCorporation(corporationName: string, selfFund?: boolean): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| corporationName | string | Name of the corporation. It must be a non-empty string. | -| selfFund | boolean | _(Optional)_ If you want to self-fund. Defaults to true, false will only work in BitNode 3. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +corporationName + + + + +string + + + + +Name of the corporation. It must be a non-empty string. + + +
+ +selfFund + + + + +boolean + + + + +_(Optional)_ If you want to self-fund. Defaults to true, false will only work in BitNode 3. + + +
**Returns:** diff --git a/markdown/bitburner.corporation.expandcity.md b/markdown/bitburner.corporation.expandcity.md index 163177de0..40da3b415 100644 --- a/markdown/bitburner.corporation.expandcity.md +++ b/markdown/bitburner.corporation.expandcity.md @@ -14,10 +14,55 @@ expandCity(divisionName: string, city: CityName): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
**Returns:** diff --git a/markdown/bitburner.corporation.expandindustry.md b/markdown/bitburner.corporation.expandindustry.md index 6b25c7f96..8b29b7abb 100644 --- a/markdown/bitburner.corporation.expandindustry.md +++ b/markdown/bitburner.corporation.expandindustry.md @@ -14,10 +14,55 @@ expandIndustry(industryType: CorpIndustryName, divisionName: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| industryType | [CorpIndustryName](./bitburner.corpindustryname.md) | Name of the industry | -| divisionName | string | Name of the division | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +industryType + + + + +[CorpIndustryName](./bitburner.corpindustryname.md) + + + + +Name of the industry + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
**Returns:** diff --git a/markdown/bitburner.corporation.getdivision.md b/markdown/bitburner.corporation.getdivision.md index dd47cd1a3..4e7e00b66 100644 --- a/markdown/bitburner.corporation.getdivision.md +++ b/markdown/bitburner.corporation.getdivision.md @@ -14,9 +14,39 @@ getDivision(divisionName: string): Division; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
**Returns:** diff --git a/markdown/bitburner.corporation.getindustrydata.md b/markdown/bitburner.corporation.getindustrydata.md index f743ddd9e..70fd3ef16 100644 --- a/markdown/bitburner.corporation.getindustrydata.md +++ b/markdown/bitburner.corporation.getindustrydata.md @@ -14,9 +14,39 @@ getIndustryData(industryName: CorpIndustryName): CorpIndustryData; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| industryName | [CorpIndustryName](./bitburner.corpindustryname.md) | Name of the industry | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +industryName + + + + +[CorpIndustryName](./bitburner.corpindustryname.md) + + + + +Name of the industry + + +
**Returns:** diff --git a/markdown/bitburner.corporation.getmaterialdata.md b/markdown/bitburner.corporation.getmaterialdata.md index d6a6008ad..6d98ad254 100644 --- a/markdown/bitburner.corporation.getmaterialdata.md +++ b/markdown/bitburner.corporation.getmaterialdata.md @@ -14,9 +14,39 @@ getMaterialData(materialName: CorpMaterialName): CorpMaterialConstantData; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
**Returns:** diff --git a/markdown/bitburner.corporation.getunlockcost.md b/markdown/bitburner.corporation.getunlockcost.md index bfc93e5ba..e69bbc23a 100644 --- a/markdown/bitburner.corporation.getunlockcost.md +++ b/markdown/bitburner.corporation.getunlockcost.md @@ -14,9 +14,39 @@ getUnlockCost(upgradeName: CorpUnlockName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgradeName | [CorpUnlockName](./bitburner.corpunlockname.md) | Name of the upgrade | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgradeName + + + + +[CorpUnlockName](./bitburner.corpunlockname.md) + + + + +Name of the upgrade + + +
**Returns:** diff --git a/markdown/bitburner.corporation.getupgradelevel.md b/markdown/bitburner.corporation.getupgradelevel.md index a5ac22c51..ec31beda2 100644 --- a/markdown/bitburner.corporation.getupgradelevel.md +++ b/markdown/bitburner.corporation.getupgradelevel.md @@ -14,9 +14,39 @@ getUpgradeLevel(upgradeName: CorpUpgradeName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgradeName | [CorpUpgradeName](./bitburner.corpupgradename.md) | Name of the upgrade | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgradeName + + + + +[CorpUpgradeName](./bitburner.corpupgradename.md) + + + + +Name of the upgrade + + +
**Returns:** diff --git a/markdown/bitburner.corporation.getupgradelevelcost.md b/markdown/bitburner.corporation.getupgradelevelcost.md index 2fc760e14..c070a4ca2 100644 --- a/markdown/bitburner.corporation.getupgradelevelcost.md +++ b/markdown/bitburner.corporation.getupgradelevelcost.md @@ -14,9 +14,39 @@ getUpgradeLevelCost(upgradeName: CorpUpgradeName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgradeName | [CorpUpgradeName](./bitburner.corpupgradename.md) | Name of the upgrade | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgradeName + + + + +[CorpUpgradeName](./bitburner.corpupgradename.md) + + + + +Name of the upgrade + + +
**Returns:** diff --git a/markdown/bitburner.corporation.gopublic.md b/markdown/bitburner.corporation.gopublic.md index 2906e2c97..197ea0fe4 100644 --- a/markdown/bitburner.corporation.gopublic.md +++ b/markdown/bitburner.corporation.gopublic.md @@ -14,9 +14,39 @@ goPublic(numShares: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| numShares | number | Number of shares you would like to issue for your IPO | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +numShares + + + + +number + + + + +Number of shares you would like to issue for your IPO + + +
**Returns:** diff --git a/markdown/bitburner.corporation.hasunlock.md b/markdown/bitburner.corporation.hasunlock.md index 553a3c69b..f29dcca18 100644 --- a/markdown/bitburner.corporation.hasunlock.md +++ b/markdown/bitburner.corporation.hasunlock.md @@ -14,9 +14,39 @@ hasUnlock(upgradeName: CorpUnlockName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgradeName | [CorpUnlockName](./bitburner.corpunlockname.md) | Name of the upgrade | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgradeName + + + + +[CorpUnlockName](./bitburner.corpunlockname.md) + + + + +Name of the upgrade + + +
**Returns:** diff --git a/markdown/bitburner.corporation.issuedividends.md b/markdown/bitburner.corporation.issuedividends.md index 01d1daa8d..c7729da16 100644 --- a/markdown/bitburner.corporation.issuedividends.md +++ b/markdown/bitburner.corporation.issuedividends.md @@ -14,9 +14,39 @@ issueDividends(rate: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| rate | number | Fraction of profit to issue as dividends. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +rate + + + + +number + + + + +Fraction of profit to issue as dividends. + + +
**Returns:** diff --git a/markdown/bitburner.corporation.issuenewshares.md b/markdown/bitburner.corporation.issuenewshares.md index 34b1efccb..f9c6510cd 100644 --- a/markdown/bitburner.corporation.issuenewshares.md +++ b/markdown/bitburner.corporation.issuenewshares.md @@ -14,9 +14,39 @@ issueNewShares(amount?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| amount | number | _(Optional)_ Number of new shares to issue. It will be rounded to nearest 10 million. Defaults to max amount. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +amount + + + + +number + + + + +_(Optional)_ Number of new shares to issue. It will be rounded to nearest 10 million. Defaults to max amount. + + +
**Returns:** diff --git a/markdown/bitburner.corporation.levelupgrade.md b/markdown/bitburner.corporation.levelupgrade.md index 8def072d7..ddbe339cd 100644 --- a/markdown/bitburner.corporation.levelupgrade.md +++ b/markdown/bitburner.corporation.levelupgrade.md @@ -14,9 +14,39 @@ levelUpgrade(upgradeName: CorpUpgradeName): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgradeName | [CorpUpgradeName](./bitburner.corpupgradename.md) | Name of the upgrade | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgradeName + + + + +[CorpUpgradeName](./bitburner.corpupgradename.md) + + + + +Name of the upgrade + + +
**Returns:** diff --git a/markdown/bitburner.corporation.md b/markdown/bitburner.corporation.md index 5d9fd08d3..c9516108d 100644 --- a/markdown/bitburner.corporation.md +++ b/markdown/bitburner.corporation.md @@ -15,33 +15,323 @@ export interface Corporation extends WarehouseAPI, OfficeAPI ## Methods -| Method | Description | -| --- | --- | -| [acceptInvestmentOffer()](./bitburner.corporation.acceptinvestmentoffer.md) | Accept the investment offer. The value of offer is based on current corporation valuation. | -| [bribe(factionName, amountCash)](./bitburner.corporation.bribe.md) |

Bribe a faction. You must satisfy these conditions:

- The corporation valuation must be greater than or equal to a threshold. You can use [getCorporation](./bitburner.corporation.getcorporation.md) and [getConstants](./bitburner.corporation.getconstants.md) to get this information.

- You must be a member of the specified faction.

- The specified faction must offer at least 1 type of work. You can use [getFactionWorkTypes](./bitburner.singularity.getfactionworktypes.md) to get the list of work types of a faction.

| -| [buyBackShares(amount)](./bitburner.corporation.buybackshares.md) | Buyback shares. Spend money from the player's wallet to transfer shares from public traders to the CEO. | -| [canCreateCorporation(selfFund)](./bitburner.corporation.cancreatecorporation.md) | Return whether the player can create a corporation. Does not require API access. | -| [createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md) |

Create a Corporation. You should use [canCreateCorporation](./bitburner.corporation.cancreatecorporation.md) to check if you are unsure you can do it, because it throws an error in these cases:

- Use seed money outside BitNode 3.

- Be in a BitNode that has CorporationSoftcap (a BitNode modifier) less than 0.15.

| -| [expandCity(divisionName, city)](./bitburner.corporation.expandcity.md) | Expand to a new city. | -| [expandIndustry(industryType, divisionName)](./bitburner.corporation.expandindustry.md) | Expand to a new industry. | -| [getBonusTime()](./bitburner.corporation.getbonustime.md) | Get bonus time. Bonus time is accumulated when the game is offline or if the game is inactive in the browser. Bonus time makes the corporation progress faster. | -| [getConstants()](./bitburner.corporation.getconstants.md) | Get corporation-related constants. | -| [getCorporation()](./bitburner.corporation.getcorporation.md) | Get corporation data. | -| [getDivision(divisionName)](./bitburner.corporation.getdivision.md) | Get division data. | -| [getIndustryData(industryName)](./bitburner.corporation.getindustrydata.md) | Get constant data of an industry. | -| [getInvestmentOffer()](./bitburner.corporation.getinvestmentoffer.md) | Get an offer for investment based on current corporation valuation. | -| [getMaterialData(materialName)](./bitburner.corporation.getmaterialdata.md) | Get constant data of a material. | -| [getUnlockCost(upgradeName)](./bitburner.corporation.getunlockcost.md) | Get the cost to unlock a one-time unlockable upgrade. | -| [getUpgradeLevel(upgradeName)](./bitburner.corporation.getupgradelevel.md) | Get the level of a levelable upgrade. | -| [getUpgradeLevelCost(upgradeName)](./bitburner.corporation.getupgradelevelcost.md) | Get the cost to unlock the next level of a levelable upgrade. | -| [goPublic(numShares)](./bitburner.corporation.gopublic.md) | Go public. | -| [hasCorporation()](./bitburner.corporation.hascorporation.md) | Return whether the player has a corporation. Does not require API access. | -| [hasUnlock(upgradeName)](./bitburner.corporation.hasunlock.md) | Check if you have a one-time unlockable upgrade. | -| [issueDividends(rate)](./bitburner.corporation.issuedividends.md) | Issue dividends. | -| [issueNewShares(amount)](./bitburner.corporation.issuenewshares.md) | Issue new shares. | -| [levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) | Level up an upgrade. | -| [nextUpdate()](./bitburner.corporation.nextupdate.md) | Sleep until the next Corporation update happens. | -| [purchaseUnlock(upgradeName)](./bitburner.corporation.purchaseunlock.md) | Unlock an upgrade. | -| [sellDivision(divisionName)](./bitburner.corporation.selldivision.md) | Sell a division. | -| [sellShares(amount)](./bitburner.corporation.sellshares.md) | Sell shares. Transfer shares from the CEO to public traders to receive money in the player's wallet. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[acceptInvestmentOffer()](./bitburner.corporation.acceptinvestmentoffer.md) + + + + +Accept the investment offer. The value of offer is based on current corporation valuation. + + +
+ +[bribe(factionName, amountCash)](./bitburner.corporation.bribe.md) + + + + +Bribe a faction. You must satisfy these conditions: + +- The corporation valuation must be greater than or equal to a threshold. You can use [getCorporation](./bitburner.corporation.getcorporation.md) and [getConstants](./bitburner.corporation.getconstants.md) to get this information. + +- You must be a member of the specified faction. + +- The specified faction must offer at least 1 type of work. You can use [getFactionWorkTypes](./bitburner.singularity.getfactionworktypes.md) to get the list of work types of a faction. + + +
+ +[buyBackShares(amount)](./bitburner.corporation.buybackshares.md) + + + + +Buyback shares. Spend money from the player's wallet to transfer shares from public traders to the CEO. + + +
+ +[canCreateCorporation(selfFund)](./bitburner.corporation.cancreatecorporation.md) + + + + +Return whether the player can create a corporation. Does not require API access. + + +
+ +[createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md) + + + + +Create a Corporation. You should use [canCreateCorporation](./bitburner.corporation.cancreatecorporation.md) to check if you are unsure you can do it, because it throws an error in these cases: + +- Use seed money outside BitNode 3. + +- Be in a BitNode that has CorporationSoftcap (a BitNode modifier) less than 0.15. + + +
+ +[expandCity(divisionName, city)](./bitburner.corporation.expandcity.md) + + + + +Expand to a new city. + + +
+ +[expandIndustry(industryType, divisionName)](./bitburner.corporation.expandindustry.md) + + + + +Expand to a new industry. + + +
+ +[getBonusTime()](./bitburner.corporation.getbonustime.md) + + + + +Get bonus time. Bonus time is accumulated when the game is offline or if the game is inactive in the browser. Bonus time makes the corporation progress faster. + + +
+ +[getConstants()](./bitburner.corporation.getconstants.md) + + + + +Get corporation-related constants. + + +
+ +[getCorporation()](./bitburner.corporation.getcorporation.md) + + + + +Get corporation data. + + +
+ +[getDivision(divisionName)](./bitburner.corporation.getdivision.md) + + + + +Get division data. + + +
+ +[getIndustryData(industryName)](./bitburner.corporation.getindustrydata.md) + + + + +Get constant data of an industry. + + +
+ +[getInvestmentOffer()](./bitburner.corporation.getinvestmentoffer.md) + + + + +Get an offer for investment based on current corporation valuation. + + +
+ +[getMaterialData(materialName)](./bitburner.corporation.getmaterialdata.md) + + + + +Get constant data of a material. + + +
+ +[getUnlockCost(upgradeName)](./bitburner.corporation.getunlockcost.md) + + + + +Get the cost to unlock a one-time unlockable upgrade. + + +
+ +[getUpgradeLevel(upgradeName)](./bitburner.corporation.getupgradelevel.md) + + + + +Get the level of a levelable upgrade. + + +
+ +[getUpgradeLevelCost(upgradeName)](./bitburner.corporation.getupgradelevelcost.md) + + + + +Get the cost to unlock the next level of a levelable upgrade. + + +
+ +[goPublic(numShares)](./bitburner.corporation.gopublic.md) + + + + +Go public. + + +
+ +[hasCorporation()](./bitburner.corporation.hascorporation.md) + + + + +Return whether the player has a corporation. Does not require API access. + + +
+ +[hasUnlock(upgradeName)](./bitburner.corporation.hasunlock.md) + + + + +Check if you have a one-time unlockable upgrade. + + +
+ +[issueDividends(rate)](./bitburner.corporation.issuedividends.md) + + + + +Issue dividends. + + +
+ +[issueNewShares(amount)](./bitburner.corporation.issuenewshares.md) + + + + +Issue new shares. + + +
+ +[levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) + + + + +Level up an upgrade. + + +
+ +[nextUpdate()](./bitburner.corporation.nextupdate.md) + + + + +Sleep until the next Corporation update happens. + + +
+ +[purchaseUnlock(upgradeName)](./bitburner.corporation.purchaseunlock.md) + + + + +Unlock an upgrade. + + +
+ +[sellDivision(divisionName)](./bitburner.corporation.selldivision.md) + + + + +Sell a division. + + +
+ +[sellShares(amount)](./bitburner.corporation.sellshares.md) + + + + +Sell shares. Transfer shares from the CEO to public traders to receive money in the player's wallet. + + +
diff --git a/markdown/bitburner.corporation.purchaseunlock.md b/markdown/bitburner.corporation.purchaseunlock.md index 670530973..53ebabb2b 100644 --- a/markdown/bitburner.corporation.purchaseunlock.md +++ b/markdown/bitburner.corporation.purchaseunlock.md @@ -14,9 +14,39 @@ purchaseUnlock(upgradeName: CorpUnlockName): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgradeName | [CorpUnlockName](./bitburner.corpunlockname.md) | Name of the upgrade | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgradeName + + + + +[CorpUnlockName](./bitburner.corpunlockname.md) + + + + +Name of the upgrade + + +
**Returns:** diff --git a/markdown/bitburner.corporation.selldivision.md b/markdown/bitburner.corporation.selldivision.md index 0ef19e5b4..989445704 100644 --- a/markdown/bitburner.corporation.selldivision.md +++ b/markdown/bitburner.corporation.selldivision.md @@ -14,9 +14,39 @@ sellDivision(divisionName: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
**Returns:** diff --git a/markdown/bitburner.corporation.sellshares.md b/markdown/bitburner.corporation.sellshares.md index 05309f8dd..cec067a95 100644 --- a/markdown/bitburner.corporation.sellshares.md +++ b/markdown/bitburner.corporation.sellshares.md @@ -14,9 +14,39 @@ sellShares(amount: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| amount | number | Amount of shares to sell, must be integer between 1 and 100t | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +amount + + + + +number + + + + +Amount of shares to sell, must be integer between 1 and 100t + + +
**Returns:** diff --git a/markdown/bitburner.corporationinfo.md b/markdown/bitburner.corporationinfo.md index d3a33c7e5..4f5192fe7 100644 --- a/markdown/bitburner.corporationinfo.md +++ b/markdown/bitburner.corporationinfo.md @@ -14,25 +14,395 @@ interface CorporationInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [dividendEarnings](./bitburner.corporationinfo.dividendearnings.md) | | number | Your earnings as a shareholder per second this cycle | -| [dividendRate](./bitburner.corporationinfo.dividendrate.md) | | number | Fraction of profits issued as dividends | -| [divisions](./bitburner.corporationinfo.divisions.md) | | string\[\] | Array of all division names | -| [expenses](./bitburner.corporationinfo.expenses.md) | | number | Expenses per second this cycle | -| [funds](./bitburner.corporationinfo.funds.md) | | number | Funds available | -| [investorShares](./bitburner.corporationinfo.investorshares.md) | | number | Amount of shares owned by private investors. Not available for public sale or CEO buyback. | -| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | | number | Amount of shares owned by public traders. Available for CEO buyback. | -| [issueNewSharesCooldown](./bitburner.corporationinfo.issuenewsharescooldown.md) | | number | Cooldown until new shares can be issued | -| [name](./bitburner.corporationinfo.name.md) | | string | Name of the corporation | -| [nextState](./bitburner.corporationinfo.nextstate.md) | | [CorpStateName](./bitburner.corpstatename.md) |

The next state to be processed.

I.e. when the state is PURCHASE, it means purchasing will occur during the next state transition.

Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE.

| -| [numShares](./bitburner.corporationinfo.numshares.md) | | number | Amount of shares owned by the CEO. | -| [prevState](./bitburner.corporationinfo.prevstate.md) | | [CorpStateName](./bitburner.corpstatename.md) |

The last state that got processed.

I.e. when that state is PURCHASE, it means purchasing just happened.

Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE.

| -| [public](./bitburner.corporationinfo.public.md) | | boolean | Indicating if the company is public | -| [revenue](./bitburner.corporationinfo.revenue.md) | | number | Revenue per second this cycle | -| [sharePrice](./bitburner.corporationinfo.shareprice.md) | | number | Price of the shares | -| [shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md) | | number | Cooldown until shares can be sold again | -| [totalShares](./bitburner.corporationinfo.totalshares.md) | | number | Total number of shares issued by this corporation. | -| [tributeModifier](./bitburner.corporationinfo.tributemodifier.md) | | number | Your income from dividend is negatively affected by this penalty modifier | -| [valuation](./bitburner.corporationinfo.valuation.md) | | number | Corporation valuation | + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[dividendEarnings](./bitburner.corporationinfo.dividendearnings.md) + + + + + + + +number + + + + +Your earnings as a shareholder per second this cycle + + +
+ +[dividendRate](./bitburner.corporationinfo.dividendrate.md) + + + + + + + +number + + + + +Fraction of profits issued as dividends + + +
+ +[divisions](./bitburner.corporationinfo.divisions.md) + + + + + + + +string\[\] + + + + +Array of all division names + + +
+ +[expenses](./bitburner.corporationinfo.expenses.md) + + + + + + + +number + + + + +Expenses per second this cycle + + +
+ +[funds](./bitburner.corporationinfo.funds.md) + + + + + + + +number + + + + +Funds available + + +
+ +[investorShares](./bitburner.corporationinfo.investorshares.md) + + + + + + + +number + + + + +Amount of shares owned by private investors. Not available for public sale or CEO buyback. + + +
+ +[issuedShares](./bitburner.corporationinfo.issuedshares.md) + + + + + + + +number + + + + +Amount of shares owned by public traders. Available for CEO buyback. + + +
+ +[issueNewSharesCooldown](./bitburner.corporationinfo.issuenewsharescooldown.md) + + + + + + + +number + + + + +Cooldown until new shares can be issued + + +
+ +[name](./bitburner.corporationinfo.name.md) + + + + + + + +string + + + + +Name of the corporation + + +
+ +[nextState](./bitburner.corporationinfo.nextstate.md) + + + + + + + +[CorpStateName](./bitburner.corpstatename.md) + + + + +The next state to be processed. + +I.e. when the state is PURCHASE, it means purchasing will occur during the next state transition. + +Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE. + + +
+ +[numShares](./bitburner.corporationinfo.numshares.md) + + + + + + + +number + + + + +Amount of shares owned by the CEO. + + +
+ +[prevState](./bitburner.corporationinfo.prevstate.md) + + + + + + + +[CorpStateName](./bitburner.corpstatename.md) + + + + +The last state that got processed. + +I.e. when that state is PURCHASE, it means purchasing just happened. + +Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE. + + +
+ +[public](./bitburner.corporationinfo.public.md) + + + + + + + +boolean + + + + +Indicating if the company is public + + +
+ +[revenue](./bitburner.corporationinfo.revenue.md) + + + + + + + +number + + + + +Revenue per second this cycle + + +
+ +[sharePrice](./bitburner.corporationinfo.shareprice.md) + + + + + + + +number + + + + +Price of the shares + + +
+ +[shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md) + + + + + + + +number + + + + +Cooldown until shares can be sold again + + +
+ +[totalShares](./bitburner.corporationinfo.totalshares.md) + + + + + + + +number + + + + +Total number of shares issued by this corporation. + + +
+ +[tributeModifier](./bitburner.corporationinfo.tributemodifier.md) + + + + + + + +number + + + + +Your income from dividend is negatively affected by this penalty modifier + + +
+ +[valuation](./bitburner.corporationinfo.valuation.md) + + + + + + + +number + + + + +Corporation valuation + + +
diff --git a/markdown/bitburner.corpproductdata.md b/markdown/bitburner.corpproductdata.md index b0969450d..b755cf497 100644 --- a/markdown/bitburner.corpproductdata.md +++ b/markdown/bitburner.corpproductdata.md @@ -14,10 +14,102 @@ interface CorpProductData ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [desc](./bitburner.corpproductdata.desc.md) | | string | Description of product creation | -| [name](./bitburner.corpproductdata.name.md) | | string | Name of the product | -| [ratingWeights](./bitburner.corpproductdata.ratingweights.md) | | { aesthetics?: number; durability?: number; features?: number; quality?: number; performance?: number; reliability?: number; } | Weighting factors for product | -| [verb](./bitburner.corpproductdata.verb.md) | | string | Verb used to describe creation of the product | + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[desc](./bitburner.corpproductdata.desc.md) + + + + + + + +string + + + + +Description of product creation + + +
+ +[name](./bitburner.corpproductdata.name.md) + + + + + + + +string + + + + +Name of the product + + +
+ +[ratingWeights](./bitburner.corpproductdata.ratingweights.md) + + + + + + + +{ aesthetics?: number; durability?: number; features?: number; quality?: number; performance?: number; reliability?: number; } + + + + +Weighting factors for product + + +
+ +[verb](./bitburner.corpproductdata.verb.md) + + + + + + + +string + + + + +Verb used to describe creation of the product + + +
diff --git a/markdown/bitburner.createprogramworktask.md b/markdown/bitburner.createprogramworktask.md index 990874b79..66e0872e5 100644 --- a/markdown/bitburner.createprogramworktask.md +++ b/markdown/bitburner.createprogramworktask.md @@ -19,8 +19,60 @@ An object representing the status of the program being created ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [programName](./bitburner.createprogramworktask.programname.md) | | string | | -| [type](./bitburner.createprogramworktask.type.md) | | "CREATE\_PROGRAM" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[programName](./bitburner.createprogramworktask.programname.md) + + + + + + + +string + + + + + +
+ +[type](./bitburner.createprogramworktask.type.md) + + + + + + + +"CREATE\_PROGRAM" + + + + + +
diff --git a/markdown/bitburner.crimestats.md b/markdown/bitburner.crimestats.md index c7f8d642b..1875ead38 100644 --- a/markdown/bitburner.crimestats.md +++ b/markdown/bitburner.crimestats.md @@ -14,25 +14,387 @@ interface CrimeStats ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agility\_exp](./bitburner.crimestats.agility_exp.md) | | number | agility exp gained from crime | -| [agility\_success\_weight](./bitburner.crimestats.agility_success_weight.md) | | number | Impact of agility level on success chance of the crime | -| [charisma\_exp](./bitburner.crimestats.charisma_exp.md) | | number | charisma exp gained from crime | -| [charisma\_success\_weight](./bitburner.crimestats.charisma_success_weight.md) | | number | Impact of charisma level on success chance of the crime | -| [defense\_exp](./bitburner.crimestats.defense_exp.md) | | number | defense exp gained from crime | -| [defense\_success\_weight](./bitburner.crimestats.defense_success_weight.md) | | number | Impact of defense level on success chance of the crime | -| [dexterity\_exp](./bitburner.crimestats.dexterity_exp.md) | | number | dexterity exp gained from crime | -| [dexterity\_success\_weight](./bitburner.crimestats.dexterity_success_weight.md) | | number | Impact of dexterity level on success chance of the crime | -| [difficulty](./bitburner.crimestats.difficulty.md) | | number | Number representing the difficulty of the crime. Used for success chance calculations | -| [hacking\_exp](./bitburner.crimestats.hacking_exp.md) | | number | hacking exp gained from crime | -| [hacking\_success\_weight](./bitburner.crimestats.hacking_success_weight.md) | | number | Impact of hacking level on success chance of the crime | -| [intelligence\_exp](./bitburner.crimestats.intelligence_exp.md) | | number | intelligence exp gained from crime | -| [karma](./bitburner.crimestats.karma.md) | | number | Amount of karma lost for successfully committing this crime | -| [kills](./bitburner.crimestats.kills.md) | | number | How many people die as a result of this crime | -| [money](./bitburner.crimestats.money.md) | | number | How much money is given | -| [strength\_exp](./bitburner.crimestats.strength_exp.md) | | number | strength exp gained from crime | -| [strength\_success\_weight](./bitburner.crimestats.strength_success_weight.md) | | number | Impact of strength level on success chance of the crime | -| [time](./bitburner.crimestats.time.md) | | number | Milliseconds it takes to attempt the crime | -| [type](./bitburner.crimestats.type.md) | | string | Description of the crime activity | + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agility\_exp](./bitburner.crimestats.agility_exp.md) + + + + + + + +number + + + + +agility exp gained from crime + + +
+ +[agility\_success\_weight](./bitburner.crimestats.agility_success_weight.md) + + + + + + + +number + + + + +Impact of agility level on success chance of the crime + + +
+ +[charisma\_exp](./bitburner.crimestats.charisma_exp.md) + + + + + + + +number + + + + +charisma exp gained from crime + + +
+ +[charisma\_success\_weight](./bitburner.crimestats.charisma_success_weight.md) + + + + + + + +number + + + + +Impact of charisma level on success chance of the crime + + +
+ +[defense\_exp](./bitburner.crimestats.defense_exp.md) + + + + + + + +number + + + + +defense exp gained from crime + + +
+ +[defense\_success\_weight](./bitburner.crimestats.defense_success_weight.md) + + + + + + + +number + + + + +Impact of defense level on success chance of the crime + + +
+ +[dexterity\_exp](./bitburner.crimestats.dexterity_exp.md) + + + + + + + +number + + + + +dexterity exp gained from crime + + +
+ +[dexterity\_success\_weight](./bitburner.crimestats.dexterity_success_weight.md) + + + + + + + +number + + + + +Impact of dexterity level on success chance of the crime + + +
+ +[difficulty](./bitburner.crimestats.difficulty.md) + + + + + + + +number + + + + +Number representing the difficulty of the crime. Used for success chance calculations + + +
+ +[hacking\_exp](./bitburner.crimestats.hacking_exp.md) + + + + + + + +number + + + + +hacking exp gained from crime + + +
+ +[hacking\_success\_weight](./bitburner.crimestats.hacking_success_weight.md) + + + + + + + +number + + + + +Impact of hacking level on success chance of the crime + + +
+ +[intelligence\_exp](./bitburner.crimestats.intelligence_exp.md) + + + + + + + +number + + + + +intelligence exp gained from crime + + +
+ +[karma](./bitburner.crimestats.karma.md) + + + + + + + +number + + + + +Amount of karma lost for successfully committing this crime + + +
+ +[kills](./bitburner.crimestats.kills.md) + + + + + + + +number + + + + +How many people die as a result of this crime + + +
+ +[money](./bitburner.crimestats.money.md) + + + + + + + +number + + + + +How much money is given + + +
+ +[strength\_exp](./bitburner.crimestats.strength_exp.md) + + + + + + + +number + + + + +strength exp gained from crime + + +
+ +[strength\_success\_weight](./bitburner.crimestats.strength_success_weight.md) + + + + + + + +number + + + + +Impact of strength level on success chance of the crime + + +
+ +[time](./bitburner.crimestats.time.md) + + + + + + + +number + + + + +Milliseconds it takes to attempt the crime + + +
+ +[type](./bitburner.crimestats.type.md) + + + + + + + +string + + + + +Description of the crime activity + + +
diff --git a/markdown/bitburner.crimetask.md b/markdown/bitburner.crimetask.md index bfff0f84d..2347fa973 100644 --- a/markdown/bitburner.crimetask.md +++ b/markdown/bitburner.crimetask.md @@ -19,8 +19,60 @@ An object representing the crime being committed ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [crimeType](./bitburner.crimetask.crimetype.md) | | [CrimeType](./bitburner.crimetype.md) | | -| [type](./bitburner.crimetask.type.md) | | "CRIME" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[crimeType](./bitburner.crimetask.crimetype.md) + + + + + + + +[CrimeType](./bitburner.crimetype.md) + + + + + +
+ +[type](./bitburner.crimetask.type.md) + + + + + + + +"CRIME" + + + + + +
diff --git a/markdown/bitburner.division.md b/markdown/bitburner.division.md index 0b7a43e71..7489d4061 100644 --- a/markdown/bitburner.division.md +++ b/markdown/bitburner.division.md @@ -14,21 +14,311 @@ interface Division ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [awareness](./bitburner.division.awareness.md) | | number | Awareness of the division | -| [cities](./bitburner.division.cities.md) | | [CityName](./bitburner.cityname.md)\[\] | Cities in which this division has expanded | -| [industry](./bitburner.division.industry.md) | | [CorpIndustryName](./bitburner.corpindustryname.md) | Industry of division, like Agriculture | -| [lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) | | number | Expenses last cycle | -| [lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) | | number | Revenue last cycle | -| [makesProducts](./bitburner.division.makesproducts.md) | | boolean | Whether the industry of this division is capable of developing and producing products | -| [maxProducts](./bitburner.division.maxproducts.md) | | number | How many products this division can support | -| [name](./bitburner.division.name.md) | | string | Name of the division | -| [numAdVerts](./bitburner.division.numadverts.md) | | number | Number of times AdVert has been bought | -| [popularity](./bitburner.division.popularity.md) | | number | Popularity of the division | -| [productionMult](./bitburner.division.productionmult.md) | | number | Production multiplier | -| [products](./bitburner.division.products.md) | | string\[\] | Names of Products developed by this division | -| [researchPoints](./bitburner.division.researchpoints.md) | | number | Amount of research in that division | -| [thisCycleExpenses](./bitburner.division.thiscycleexpenses.md) | | number | Expenses this cycle | -| [thisCycleRevenue](./bitburner.division.thiscyclerevenue.md) | | number | Revenue this cycle | + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[awareness](./bitburner.division.awareness.md) + + + + + + + +number + + + + +Awareness of the division + + +
+ +[cities](./bitburner.division.cities.md) + + + + + + + +[CityName](./bitburner.cityname.md)\[\] + + + + +Cities in which this division has expanded + + +
+ +[industry](./bitburner.division.industry.md) + + + + + + + +[CorpIndustryName](./bitburner.corpindustryname.md) + + + + +Industry of division, like Agriculture + + +
+ +[lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) + + + + + + + +number + + + + +Expenses last cycle + + +
+ +[lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) + + + + + + + +number + + + + +Revenue last cycle + + +
+ +[makesProducts](./bitburner.division.makesproducts.md) + + + + + + + +boolean + + + + +Whether the industry of this division is capable of developing and producing products + + +
+ +[maxProducts](./bitburner.division.maxproducts.md) + + + + + + + +number + + + + +How many products this division can support + + +
+ +[name](./bitburner.division.name.md) + + + + + + + +string + + + + +Name of the division + + +
+ +[numAdVerts](./bitburner.division.numadverts.md) + + + + + + + +number + + + + +Number of times AdVert has been bought + + +
+ +[popularity](./bitburner.division.popularity.md) + + + + + + + +number + + + + +Popularity of the division + + +
+ +[productionMult](./bitburner.division.productionmult.md) + + + + + + + +number + + + + +Production multiplier + + +
+ +[products](./bitburner.division.products.md) + + + + + + + +string\[\] + + + + +Names of Products developed by this division + + +
+ +[researchPoints](./bitburner.division.researchpoints.md) + + + + + + + +number + + + + +Amount of research in that division + + +
+ +[thisCycleExpenses](./bitburner.division.thiscycleexpenses.md) + + + + + + + +number + + + + +Expenses this cycle + + +
+ +[thisCycleRevenue](./bitburner.division.thiscyclerevenue.md) + + + + + + + +number + + + + +Revenue this cycle + + +
diff --git a/markdown/bitburner.employedbyrequirement.md b/markdown/bitburner.employedbyrequirement.md index eec703bee..cd3c4416c 100644 --- a/markdown/bitburner.employedbyrequirement.md +++ b/markdown/bitburner.employedbyrequirement.md @@ -14,8 +14,60 @@ interface EmployedByRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [company](./bitburner.employedbyrequirement.company.md) | | [CompanyName](./bitburner.companyname.md) | | -| [type](./bitburner.employedbyrequirement.type.md) | | "employedBy" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[company](./bitburner.employedbyrequirement.company.md) + + + + + + + +[CompanyName](./bitburner.companyname.md) + + + + + +
+ +[type](./bitburner.employedbyrequirement.type.md) + + + + + + + +"employedBy" + + + + + +
diff --git a/markdown/bitburner.equipmentstats.md b/markdown/bitburner.equipmentstats.md index 8fda26d3f..6ee751bd0 100644 --- a/markdown/bitburner.equipmentstats.md +++ b/markdown/bitburner.equipmentstats.md @@ -14,12 +14,140 @@ interface EquipmentStats ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agi?](./bitburner.equipmentstats.agi.md) | | number | _(Optional)_ Agility multiplier | -| [cha?](./bitburner.equipmentstats.cha.md) | | number | _(Optional)_ Charisma multiplier | -| [def?](./bitburner.equipmentstats.def.md) | | number | _(Optional)_ Defense multiplier | -| [dex?](./bitburner.equipmentstats.dex.md) | | number | _(Optional)_ Dexterity multiplier | -| [hack?](./bitburner.equipmentstats.hack.md) | | number | _(Optional)_ Hacking multiplier | -| [str?](./bitburner.equipmentstats.str.md) | | number | _(Optional)_ Strength multiplier | + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agi?](./bitburner.equipmentstats.agi.md) + + + + + + + +number + + + + +_(Optional)_ Agility multiplier + + +
+ +[cha?](./bitburner.equipmentstats.cha.md) + + + + + + + +number + + + + +_(Optional)_ Charisma multiplier + + +
+ +[def?](./bitburner.equipmentstats.def.md) + + + + + + + +number + + + + +_(Optional)_ Defense multiplier + + +
+ +[dex?](./bitburner.equipmentstats.dex.md) + + + + + + + +number + + + + +_(Optional)_ Dexterity multiplier + + +
+ +[hack?](./bitburner.equipmentstats.hack.md) + + + + + + + +number + + + + +_(Optional)_ Hacking multiplier + + +
+ +[str?](./bitburner.equipmentstats.str.md) + + + + + + + +number + + + + +_(Optional)_ Strength multiplier + + +
diff --git a/markdown/bitburner.everyrequirement.md b/markdown/bitburner.everyrequirement.md index 691e075d2..e545e8425 100644 --- a/markdown/bitburner.everyrequirement.md +++ b/markdown/bitburner.everyrequirement.md @@ -14,8 +14,60 @@ interface EveryRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [conditions](./bitburner.everyrequirement.conditions.md) | | [PlayerRequirement](./bitburner.playerrequirement.md)\[\] | | -| [type](./bitburner.everyrequirement.type.md) | | "everyCondition" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[conditions](./bitburner.everyrequirement.conditions.md) + + + + + + + +[PlayerRequirement](./bitburner.playerrequirement.md)\[\] + + + + + +
+ +[type](./bitburner.everyrequirement.type.md) + + + + + + + +"everyCondition" + + + + + +
diff --git a/markdown/bitburner.export.md b/markdown/bitburner.export.md index 533ba40fc..20da59d0f 100644 --- a/markdown/bitburner.export.md +++ b/markdown/bitburner.export.md @@ -14,9 +14,83 @@ interface Export ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [amount](./bitburner.export.amount.md) | | string | Amount of material exported | -| [city](./bitburner.export.city.md) | | [CityName](./bitburner.cityname.md) | City the material is being exported to | -| [division](./bitburner.export.division.md) | | string | Division the material is being exported to | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[amount](./bitburner.export.amount.md) + + + + + + + +string + + + + +Amount of material exported + + +
+ +[city](./bitburner.export.city.md) + + + + + + + +[CityName](./bitburner.cityname.md) + + + + +City the material is being exported to + + +
+ +[division](./bitburner.export.division.md) + + + + + + + +string + + + + +Division the material is being exported to + + +
diff --git a/markdown/bitburner.factionworktask.md b/markdown/bitburner.factionworktask.md index 06c741c70..987b4b905 100644 --- a/markdown/bitburner.factionworktask.md +++ b/markdown/bitburner.factionworktask.md @@ -19,9 +19,77 @@ An object representing the current work for a faction ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [factionName](./bitburner.factionworktask.factionname.md) | | [FactionName](./bitburner.factionname.md) | | -| [factionWorkType](./bitburner.factionworktask.factionworktype.md) | | [FactionWorkType](./bitburner.factionworktype.md) | | -| [type](./bitburner.factionworktask.type.md) | | "FACTION" | | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[factionName](./bitburner.factionworktask.factionname.md) + + + + + + + +[FactionName](./bitburner.factionname.md) + + + + + +
+ +[factionWorkType](./bitburner.factionworktask.factionworktype.md) + + + + + + + +[FactionWorkType](./bitburner.factionworktype.md) + + + + + +
+ +[type](./bitburner.factionworktask.type.md) + + + + + + + +"FACTION" + + + + + +
diff --git a/markdown/bitburner.filemetadata.md b/markdown/bitburner.filemetadata.md index ab39a6824..fa7364cff 100644 --- a/markdown/bitburner.filemetadata.md +++ b/markdown/bitburner.filemetadata.md @@ -14,9 +14,83 @@ interface FileMetadata ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [atime](./bitburner.filemetadata.atime.md) | | number | Time of Access | -| [btime](./bitburner.filemetadata.btime.md) | | number | Time of Birth (creation) | -| [mtime](./bitburner.filemetadata.mtime.md) | | number | Time of Modification | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[atime](./bitburner.filemetadata.atime.md) + + + + + + + +number + + + + +Time of Access + + +
+ +[btime](./bitburner.filemetadata.btime.md) + + + + + + + +number + + + + +Time of Birth (creation) + + +
+ +[mtime](./bitburner.filemetadata.mtime.md) + + + + + + + +number + + + + +Time of Modification + + +
diff --git a/markdown/bitburner.filerequirement.md b/markdown/bitburner.filerequirement.md index 12173edd4..ddec9a121 100644 --- a/markdown/bitburner.filerequirement.md +++ b/markdown/bitburner.filerequirement.md @@ -14,8 +14,60 @@ interface FileRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [file](./bitburner.filerequirement.file.md) | | string | | -| [type](./bitburner.filerequirement.type.md) | | "file" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[file](./bitburner.filerequirement.file.md) + + + + + + + +string + + + + + +
+ +[type](./bitburner.filerequirement.type.md) + + + + + + + +"file" + + + + + +
diff --git a/markdown/bitburner.format.md b/markdown/bitburner.format.md index 10feca43d..d22fa3e02 100644 --- a/markdown/bitburner.format.md +++ b/markdown/bitburner.format.md @@ -14,10 +14,60 @@ export interface Format ## Methods -| Method | Description | -| --- | --- | -| [number(n, fractionalDigits, suffixStart, isInteger)](./bitburner.format.number.md) | Format a number. | -| [percent(n, fractionalDigits, suffixStart)](./bitburner.format.percent.md) | Format a number as a percentage. | -| [ram(n, fractionalDigits)](./bitburner.format.ram.md) | Format a number as an amount of ram. | -| [time(milliseconds, milliPrecision)](./bitburner.format.time.md) | Format time to a readable string. | + + + + + +
+ +Method + + + + +Description + + +
+ +[number(n, fractionalDigits, suffixStart, isInteger)](./bitburner.format.number.md) + + + + +Format a number. + + +
+ +[percent(n, fractionalDigits, suffixStart)](./bitburner.format.percent.md) + + + + +Format a number as a percentage. + + +
+ +[ram(n, fractionalDigits)](./bitburner.format.ram.md) + + + + +Format a number as an amount of ram. + + +
+ +[time(milliseconds, milliPrecision)](./bitburner.format.time.md) + + + + +Format time to a readable string. + + +
diff --git a/markdown/bitburner.format.number.md b/markdown/bitburner.format.number.md index 7c1c42524..9607952c2 100644 --- a/markdown/bitburner.format.number.md +++ b/markdown/bitburner.format.number.md @@ -14,12 +14,87 @@ number(n: number, fractionalDigits?: number, suffixStart?: number, isInteger?: b ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| n | number | Number to format. | -| fractionalDigits | number | _(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 3. | -| suffixStart | number | _(Optional)_ How high a number must be before a suffix will be added. Optional, defaults to 1000. | -| isInteger | boolean | _(Optional)_ Whether the number represents an integer. Integers do not display fractional digits until a suffix is present. Optional, defaults to false. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +n + + + + +number + + + + +Number to format. + + +
+ +fractionalDigits + + + + +number + + + + +_(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 3. + + +
+ +suffixStart + + + + +number + + + + +_(Optional)_ How high a number must be before a suffix will be added. Optional, defaults to 1000. + + +
+ +isInteger + + + + +boolean + + + + +_(Optional)_ Whether the number represents an integer. Integers do not display fractional digits until a suffix is present. Optional, defaults to false. + + +
**Returns:** diff --git a/markdown/bitburner.format.percent.md b/markdown/bitburner.format.percent.md index aa641c5fe..9c5e79b35 100644 --- a/markdown/bitburner.format.percent.md +++ b/markdown/bitburner.format.percent.md @@ -14,11 +14,71 @@ percent(n: number, fractionalDigits?: number, suffixStart?: number): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| n | number | Number to format as a percentage. | -| fractionalDigits | number | _(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. | -| suffixStart | number | _(Optional)_ When to switch the percentage to a multiplier. Default is 1e6 or x1.00m. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +n + + + + +number + + + + +Number to format as a percentage. + + +
+ +fractionalDigits + + + + +number + + + + +_(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. + + +
+ +suffixStart + + + + +number + + + + +_(Optional)_ When to switch the percentage to a multiplier. Default is 1e6 or x1.00m. + + +
**Returns:** diff --git a/markdown/bitburner.format.ram.md b/markdown/bitburner.format.ram.md index e65cbfed5..76c217122 100644 --- a/markdown/bitburner.format.ram.md +++ b/markdown/bitburner.format.ram.md @@ -14,10 +14,55 @@ ram(n: number, fractionalDigits?: number): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| n | number | Number to format as an amount of ram, in base units of GB (or GiB if that Numeric Display option is set). | -| fractionalDigits | number | _(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +n + + + + +number + + + + +Number to format as an amount of ram, in base units of GB (or GiB if that Numeric Display option is set). + + +
+ +fractionalDigits + + + + +number + + + + +_(Optional)_ Number of digits to show in the fractional part of the decimal number. Optional, defaults to 2. + + +
**Returns:** diff --git a/markdown/bitburner.format.time.md b/markdown/bitburner.format.time.md index 1ceb7923e..cbee02664 100644 --- a/markdown/bitburner.format.time.md +++ b/markdown/bitburner.format.time.md @@ -14,10 +14,55 @@ time(milliseconds: number, milliPrecision?: boolean): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| milliseconds | number | Number of millisecond to format. | -| milliPrecision | boolean | _(Optional)_ Format time with subsecond precision. Defaults to false. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +milliseconds + + + + +number + + + + +Number of millisecond to format. + + +
+ +milliPrecision + + + + +boolean + + + + +_(Optional)_ Format time with subsecond precision. Defaults to false. + + +
**Returns:** diff --git a/markdown/bitburner.formulas.md b/markdown/bitburner.formulas.md index 435639c57..26248a902 100644 --- a/markdown/bitburner.formulas.md +++ b/markdown/bitburner.formulas.md @@ -18,22 +18,220 @@ You need Formulas.exe on your home computer to use this API. ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [bladeburner](./bitburner.formulas.bladeburner.md) | | [BladeburnerFormulas](./bitburner.bladeburnerformulas.md) | Bladeburner formulas | -| [gang](./bitburner.formulas.gang.md) | | [GangFormulas](./bitburner.gangformulas.md) | Gang formulas | -| [hacking](./bitburner.formulas.hacking.md) | | [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas | -| [hacknetNodes](./bitburner.formulas.hacknetnodes.md) | | [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Nodes formulas | -| [hacknetServers](./bitburner.formulas.hacknetservers.md) | | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Servers formulas | -| [reputation](./bitburner.formulas.reputation.md) | | [ReputationFormulas](./bitburner.reputationformulas.md) | Reputation formulas | -| [skills](./bitburner.formulas.skills.md) | | [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas | -| [work](./bitburner.formulas.work.md) | | [WorkFormulas](./bitburner.workformulas.md) | Work formulas | + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[bladeburner](./bitburner.formulas.bladeburner.md) + + + + + + + +[BladeburnerFormulas](./bitburner.bladeburnerformulas.md) + + + + +Bladeburner formulas + + +
+ +[gang](./bitburner.formulas.gang.md) + + + + + + + +[GangFormulas](./bitburner.gangformulas.md) + + + + +Gang formulas + + +
+ +[hacking](./bitburner.formulas.hacking.md) + + + + + + + +[HackingFormulas](./bitburner.hackingformulas.md) + + + + +Hacking formulas + + +
+ +[hacknetNodes](./bitburner.formulas.hacknetnodes.md) + + + + + + + +[HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) + + + + +Hacknet Nodes formulas + + +
+ +[hacknetServers](./bitburner.formulas.hacknetservers.md) + + + + + + + +[HacknetServersFormulas](./bitburner.hacknetserversformulas.md) + + + + +Hacknet Servers formulas + + +
+ +[reputation](./bitburner.formulas.reputation.md) + + + + + + + +[ReputationFormulas](./bitburner.reputationformulas.md) + + + + +Reputation formulas + + +
+ +[skills](./bitburner.formulas.skills.md) + + + + + + + +[SkillsFormulas](./bitburner.skillsformulas.md) + + + + +Skills formulas + + +
+ +[work](./bitburner.formulas.work.md) + + + + + + + +[WorkFormulas](./bitburner.workformulas.md) + + + + +Work formulas + + +
## Methods -| Method | Description | -| --- | --- | -| [mockPerson()](./bitburner.formulas.mockperson.md) | | -| [mockPlayer()](./bitburner.formulas.mockplayer.md) | | -| [mockServer()](./bitburner.formulas.mockserver.md) | | + + + + +
+ +Method + + + + +Description + + +
+ +[mockPerson()](./bitburner.formulas.mockperson.md) + + + + + +
+ +[mockPlayer()](./bitburner.formulas.mockplayer.md) + + + + + +
+ +[mockServer()](./bitburner.formulas.mockserver.md) + + + + + +
diff --git a/markdown/bitburner.fragment.md b/markdown/bitburner.fragment.md index 9b4d20c20..127780896 100644 --- a/markdown/bitburner.fragment.md +++ b/markdown/bitburner.fragment.md @@ -13,12 +13,128 @@ interface Fragment ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [effect](./bitburner.fragment.effect.md) | | string | | -| [id](./bitburner.fragment.id.md) | | number | | -| [limit](./bitburner.fragment.limit.md) | | number | | -| [power](./bitburner.fragment.power.md) | | number | | -| [shape](./bitburner.fragment.shape.md) | | boolean\[\]\[\] | | -| [type](./bitburner.fragment.type.md) | | number | | + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[effect](./bitburner.fragment.effect.md) + + + + + + + +string + + + + + +
+ +[id](./bitburner.fragment.id.md) + + + + + + + +number + + + + + +
+ +[limit](./bitburner.fragment.limit.md) + + + + + + + +number + + + + + +
+ +[power](./bitburner.fragment.power.md) + + + + + + + +number + + + + + +
+ +[shape](./bitburner.fragment.shape.md) + + + + + + + +boolean\[\]\[\] + + + + + +
+ +[type](./bitburner.fragment.type.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.gameinfo.md b/markdown/bitburner.gameinfo.md index 144f5822b..0643619f2 100644 --- a/markdown/bitburner.gameinfo.md +++ b/markdown/bitburner.gameinfo.md @@ -14,10 +14,104 @@ interface GameInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [commit](./bitburner.gameinfo.commit.md) | | string | Git commit hash that the release was built from. E.g.: "d0d776700" | -| [platform](./bitburner.gameinfo.platform.md) | | "Browser" \| "Steam" | Platform that the game is running on | -| [version](./bitburner.gameinfo.version.md) | | string |

Version as shown in release notes and in the UI. E.g.: "2.8.1"

Note that this property does not have the prefix "v". For example, with v2.8.1, this property is "2.8.1".

| -| [versionNumber](./bitburner.gameinfo.versionnumber.md) | | number | Internal version number that increments during releases. E.g.: 43 | + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[commit](./bitburner.gameinfo.commit.md) + + + + + + + +string + + + + +Git commit hash that the release was built from. E.g.: "d0d776700" + + +
+ +[platform](./bitburner.gameinfo.platform.md) + + + + + + + +"Browser" \| "Steam" + + + + +Platform that the game is running on + + +
+ +[version](./bitburner.gameinfo.version.md) + + + + + + + +string + + + + +Version as shown in release notes and in the UI. E.g.: "2.8.1" + +Note that this property does not have the prefix "v". For example, with v2.8.1, this property is "2.8.1". + + +
+ +[versionNumber](./bitburner.gameinfo.versionnumber.md) + + + + + + + +number + + + + +Internal version number that increments during releases. E.g.: 43 + + +
diff --git a/markdown/bitburner.gang.ascendmember.md b/markdown/bitburner.gang.ascendmember.md index 028a3e6ed..4c4638122 100644 --- a/markdown/bitburner.gang.ascendmember.md +++ b/markdown/bitburner.gang.ascendmember.md @@ -14,9 +14,39 @@ ascendMember(memberName: string): GangMemberAscension | undefined; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| memberName | string | Name of member to ascend. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +memberName + + + + +string + + + + +Name of member to ascend. + + +
**Returns:** diff --git a/markdown/bitburner.gang.creategang.md b/markdown/bitburner.gang.creategang.md index 89453e517..07aa4a960 100644 --- a/markdown/bitburner.gang.creategang.md +++ b/markdown/bitburner.gang.creategang.md @@ -14,9 +14,39 @@ createGang(faction: FactionName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of the faction that you want to create a gang with. This faction must allow this action, and you must be its member. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of the faction that you want to create a gang with. This faction must allow this action, and you must be its member. + + +
**Returns:** diff --git a/markdown/bitburner.gang.getascensionresult.md b/markdown/bitburner.gang.getascensionresult.md index e860893e8..fcfd79b3d 100644 --- a/markdown/bitburner.gang.getascensionresult.md +++ b/markdown/bitburner.gang.getascensionresult.md @@ -14,9 +14,39 @@ getAscensionResult(memberName: string): GangMemberAscension | undefined; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| memberName | string | Name of member. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +memberName + + + + +string + + + + +Name of member. + + +
**Returns:** diff --git a/markdown/bitburner.gang.getchancetowinclash.md b/markdown/bitburner.gang.getchancetowinclash.md index 62994f3db..4ad494e8d 100644 --- a/markdown/bitburner.gang.getchancetowinclash.md +++ b/markdown/bitburner.gang.getchancetowinclash.md @@ -14,9 +14,39 @@ getChanceToWinClash(gangName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| gangName | string | Target gang | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +gangName + + + + +string + + + + +Target gang + + +
**Returns:** diff --git a/markdown/bitburner.gang.getequipmentcost.md b/markdown/bitburner.gang.getequipmentcost.md index 434f63de3..35e6725f7 100644 --- a/markdown/bitburner.gang.getequipmentcost.md +++ b/markdown/bitburner.gang.getequipmentcost.md @@ -14,9 +14,39 @@ getEquipmentCost(equipName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| equipName | string | Name of equipment. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +equipName + + + + +string + + + + +Name of equipment. + + +
**Returns:** diff --git a/markdown/bitburner.gang.getequipmentstats.md b/markdown/bitburner.gang.getequipmentstats.md index 2649721cb..f2c537a0f 100644 --- a/markdown/bitburner.gang.getequipmentstats.md +++ b/markdown/bitburner.gang.getequipmentstats.md @@ -14,9 +14,39 @@ getEquipmentStats(equipName: string): EquipmentStats; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| equipName | string | Name of equipment. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +equipName + + + + +string + + + + +Name of equipment. + + +
**Returns:** diff --git a/markdown/bitburner.gang.getequipmenttype.md b/markdown/bitburner.gang.getequipmenttype.md index aa3bfdc14..01ef78836 100644 --- a/markdown/bitburner.gang.getequipmenttype.md +++ b/markdown/bitburner.gang.getequipmenttype.md @@ -14,9 +14,39 @@ getEquipmentType(equipName: string): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| equipName | string | Name of equipment. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +equipName + + + + +string + + + + +Name of equipment. + + +
**Returns:** diff --git a/markdown/bitburner.gang.getinstallresult.md b/markdown/bitburner.gang.getinstallresult.md index 0bf8046df..c9431b9f5 100644 --- a/markdown/bitburner.gang.getinstallresult.md +++ b/markdown/bitburner.gang.getinstallresult.md @@ -14,9 +14,39 @@ getInstallResult(memberName: string): GangMemberInstall | undefined; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| memberName | string | Name of member. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +memberName + + + + +string + + + + +Name of member. + + +
**Returns:** diff --git a/markdown/bitburner.gang.getmemberinformation.md b/markdown/bitburner.gang.getmemberinformation.md index 76ce8db05..d47b6e715 100644 --- a/markdown/bitburner.gang.getmemberinformation.md +++ b/markdown/bitburner.gang.getmemberinformation.md @@ -14,9 +14,39 @@ getMemberInformation(name: string): GangMemberInfo; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | Name of member. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +name + + + + +string + + + + +Name of member. + + +
**Returns:** diff --git a/markdown/bitburner.gang.gettaskstats.md b/markdown/bitburner.gang.gettaskstats.md index c80e52687..15aa14522 100644 --- a/markdown/bitburner.gang.gettaskstats.md +++ b/markdown/bitburner.gang.gettaskstats.md @@ -14,9 +14,39 @@ getTaskStats(name: string): GangTaskStats; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | Name of the task. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +name + + + + +string + + + + +Name of the task. + + +
**Returns:** diff --git a/markdown/bitburner.gang.md b/markdown/bitburner.gang.md index 6996d7989..5a2528b91 100644 --- a/markdown/bitburner.gang.md +++ b/markdown/bitburner.gang.md @@ -18,32 +18,302 @@ If you are not in BitNode-2, then you must have Source-File 2 in order to use th ## Methods -| Method | Description | -| --- | --- | -| [ascendMember(memberName)](./bitburner.gang.ascendmember.md) | Ascend a gang member. | -| [canRecruitMember()](./bitburner.gang.canrecruitmember.md) | Check if you can recruit a new gang member. | -| [createGang(faction)](./bitburner.gang.creategang.md) | Create a gang. | -| [getAscensionResult(memberName)](./bitburner.gang.getascensionresult.md) | Get the result of an ascension without ascending. | -| [getBonusTime()](./bitburner.gang.getbonustime.md) | Get bonus time. | -| [getChanceToWinClash(gangName)](./bitburner.gang.getchancetowinclash.md) | Get chance to win clash with other gang. | -| [getEquipmentCost(equipName)](./bitburner.gang.getequipmentcost.md) | Get cost of equipment. | -| [getEquipmentNames()](./bitburner.gang.getequipmentnames.md) | List equipment names. | -| [getEquipmentStats(equipName)](./bitburner.gang.getequipmentstats.md) | Get stats of an equipment. | -| [getEquipmentType(equipName)](./bitburner.gang.getequipmenttype.md) | Get type of an equipment. | -| [getGangInformation()](./bitburner.gang.getganginformation.md) | Get information about your gang. | -| [getInstallResult(memberName)](./bitburner.gang.getinstallresult.md) | Get the effect of an install on ascension multipliers without installing. | -| [getMemberInformation(name)](./bitburner.gang.getmemberinformation.md) | Get information about a specific gang member. | -| [getMemberNames()](./bitburner.gang.getmembernames.md) | List all gang members. | -| [getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) | Get information about all gangs. | -| [getRecruitsAvailable()](./bitburner.gang.getrecruitsavailable.md) | Check how many gang members you can currently recruit. | -| [getTaskNames()](./bitburner.gang.gettasknames.md) | List member task names. | -| [getTaskStats(name)](./bitburner.gang.gettaskstats.md) | Get stats of a task. | -| [inGang()](./bitburner.gang.ingang.md) | Check if you're in a gang. | -| [nextUpdate()](./bitburner.gang.nextupdate.md) | Sleeps until the next Gang update has happened. | -| [purchaseEquipment(memberName, equipName)](./bitburner.gang.purchaseequipment.md) | Purchase an equipment for a gang member. | -| [recruitMember(name)](./bitburner.gang.recruitmember.md) | Recruit a new gang member. | -| [renameMember(memberName, newName)](./bitburner.gang.renamemember.md) | Rename a Gang member to a new unique name. | -| [respectForNextRecruit()](./bitburner.gang.respectfornextrecruit.md) | Check the amount of Respect needed for your next gang recruit. | -| [setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) | Set gang member to task. | -| [setTerritoryWarfare(engage)](./bitburner.gang.setterritorywarfare.md) | Enable/Disable territory clashes. | + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[ascendMember(memberName)](./bitburner.gang.ascendmember.md) + + + + +Ascend a gang member. + + +
+ +[canRecruitMember()](./bitburner.gang.canrecruitmember.md) + + + + +Check if you can recruit a new gang member. + + +
+ +[createGang(faction)](./bitburner.gang.creategang.md) + + + + +Create a gang. + + +
+ +[getAscensionResult(memberName)](./bitburner.gang.getascensionresult.md) + + + + +Get the result of an ascension without ascending. + + +
+ +[getBonusTime()](./bitburner.gang.getbonustime.md) + + + + +Get bonus time. + + +
+ +[getChanceToWinClash(gangName)](./bitburner.gang.getchancetowinclash.md) + + + + +Get chance to win clash with other gang. + + +
+ +[getEquipmentCost(equipName)](./bitburner.gang.getequipmentcost.md) + + + + +Get cost of equipment. + + +
+ +[getEquipmentNames()](./bitburner.gang.getequipmentnames.md) + + + + +List equipment names. + + +
+ +[getEquipmentStats(equipName)](./bitburner.gang.getequipmentstats.md) + + + + +Get stats of an equipment. + + +
+ +[getEquipmentType(equipName)](./bitburner.gang.getequipmenttype.md) + + + + +Get type of an equipment. + + +
+ +[getGangInformation()](./bitburner.gang.getganginformation.md) + + + + +Get information about your gang. + + +
+ +[getInstallResult(memberName)](./bitburner.gang.getinstallresult.md) + + + + +Get the effect of an install on ascension multipliers without installing. + + +
+ +[getMemberInformation(name)](./bitburner.gang.getmemberinformation.md) + + + + +Get information about a specific gang member. + + +
+ +[getMemberNames()](./bitburner.gang.getmembernames.md) + + + + +List all gang members. + + +
+ +[getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) + + + + +Get information about all gangs. + + +
+ +[getRecruitsAvailable()](./bitburner.gang.getrecruitsavailable.md) + + + + +Check how many gang members you can currently recruit. + + +
+ +[getTaskNames()](./bitburner.gang.gettasknames.md) + + + + +List member task names. + + +
+ +[getTaskStats(name)](./bitburner.gang.gettaskstats.md) + + + + +Get stats of a task. + + +
+ +[inGang()](./bitburner.gang.ingang.md) + + + + +Check if you're in a gang. + + +
+ +[nextUpdate()](./bitburner.gang.nextupdate.md) + + + + +Sleeps until the next Gang update has happened. + + +
+ +[purchaseEquipment(memberName, equipName)](./bitburner.gang.purchaseequipment.md) + + + + +Purchase an equipment for a gang member. + + +
+ +[recruitMember(name)](./bitburner.gang.recruitmember.md) + + + + +Recruit a new gang member. + + +
+ +[renameMember(memberName, newName)](./bitburner.gang.renamemember.md) + + + + +Rename a Gang member to a new unique name. + + +
+ +[respectForNextRecruit()](./bitburner.gang.respectfornextrecruit.md) + + + + +Check the amount of Respect needed for your next gang recruit. + + +
+ +[setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) + + + + +Set gang member to task. + + +
+ +[setTerritoryWarfare(engage)](./bitburner.gang.setterritorywarfare.md) + + + + +Enable/Disable territory clashes. + + +
diff --git a/markdown/bitburner.gang.purchaseequipment.md b/markdown/bitburner.gang.purchaseequipment.md index 0d8206691..127d1f2fd 100644 --- a/markdown/bitburner.gang.purchaseequipment.md +++ b/markdown/bitburner.gang.purchaseequipment.md @@ -14,10 +14,55 @@ purchaseEquipment(memberName: string, equipName: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| memberName | string | Name of Gang member to purchase the equipment for. | -| equipName | string | Name of Equipment/Augmentation to purchase. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +memberName + + + + +string + + + + +Name of Gang member to purchase the equipment for. + + +
+ +equipName + + + + +string + + + + +Name of Equipment/Augmentation to purchase. + + +
**Returns:** diff --git a/markdown/bitburner.gang.recruitmember.md b/markdown/bitburner.gang.recruitmember.md index 3468d4f35..29590e826 100644 --- a/markdown/bitburner.gang.recruitmember.md +++ b/markdown/bitburner.gang.recruitmember.md @@ -14,9 +14,39 @@ recruitMember(name: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | Name of member to recruit. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +name + + + + +string + + + + +Name of member to recruit. + + +
**Returns:** diff --git a/markdown/bitburner.gang.renamemember.md b/markdown/bitburner.gang.renamemember.md index a43597a5f..0d7b4079f 100644 --- a/markdown/bitburner.gang.renamemember.md +++ b/markdown/bitburner.gang.renamemember.md @@ -14,10 +14,55 @@ renameMember(memberName: string, newName: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| memberName | string | Name of the member to change. | -| newName | string | New name for that gang member. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +memberName + + + + +string + + + + +Name of the member to change. + + +
+ +newName + + + + +string + + + + +New name for that gang member. + + +
**Returns:** diff --git a/markdown/bitburner.gang.setmembertask.md b/markdown/bitburner.gang.setmembertask.md index d6981dd2a..61f9d5661 100644 --- a/markdown/bitburner.gang.setmembertask.md +++ b/markdown/bitburner.gang.setmembertask.md @@ -14,10 +14,55 @@ setMemberTask(memberName: string, taskName: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| memberName | string | Name of Gang member to assign. | -| taskName | string | Task to assign. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +memberName + + + + +string + + + + +Name of Gang member to assign. + + +
+ +taskName + + + + +string + + + + +Task to assign. + + +
**Returns:** diff --git a/markdown/bitburner.gang.setterritorywarfare.md b/markdown/bitburner.gang.setterritorywarfare.md index 7ef407b19..e95553f2f 100644 --- a/markdown/bitburner.gang.setterritorywarfare.md +++ b/markdown/bitburner.gang.setterritorywarfare.md @@ -14,9 +14,39 @@ setTerritoryWarfare(engage: boolean): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| engage | boolean | Whether or not to engage in territory clashes. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +engage + + + + +boolean + + + + +Whether or not to engage in territory clashes. + + +
**Returns:** diff --git a/markdown/bitburner.gangformulas.ascensionmultiplier.md b/markdown/bitburner.gangformulas.ascensionmultiplier.md index 8b2148a7c..88c840d2e 100644 --- a/markdown/bitburner.gangformulas.ascensionmultiplier.md +++ b/markdown/bitburner.gangformulas.ascensionmultiplier.md @@ -14,9 +14,39 @@ ascensionMultiplier(points: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| points | number | Amount of ascension points. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +points + + + + +number + + + + +Amount of ascension points. + + +
**Returns:** diff --git a/markdown/bitburner.gangformulas.ascensionpointsgain.md b/markdown/bitburner.gangformulas.ascensionpointsgain.md index 6f06887a6..bc0797a52 100644 --- a/markdown/bitburner.gangformulas.ascensionpointsgain.md +++ b/markdown/bitburner.gangformulas.ascensionpointsgain.md @@ -14,9 +14,39 @@ ascensionPointsGain(exp: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| exp | number | Experience point before ascension. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +exp + + + + +number + + + + +Experience point before ascension. + + +
**Returns:** diff --git a/markdown/bitburner.gangformulas.md b/markdown/bitburner.gangformulas.md index 3d58751fa..1da848a81 100644 --- a/markdown/bitburner.gangformulas.md +++ b/markdown/bitburner.gangformulas.md @@ -14,12 +14,82 @@ interface GangFormulas ## Methods -| Method | Description | -| --- | --- | -| [ascensionMultiplier(points)](./bitburner.gangformulas.ascensionmultiplier.md) | Calculate ascension mult. | -| [ascensionPointsGain(exp)](./bitburner.gangformulas.ascensionpointsgain.md) | Calculate ascension point gain. | -| [moneyGain(gang, member, task)](./bitburner.gangformulas.moneygain.md) | Calculate money gain per tick. | -| [respectGain(gang, member, task)](./bitburner.gangformulas.respectgain.md) | Calculate respect gain per tick. | -| [wantedLevelGain(gang, member, task)](./bitburner.gangformulas.wantedlevelgain.md) | Calculate wanted gain per tick. | -| [wantedPenalty(gang)](./bitburner.gangformulas.wantedpenalty.md) | Calculate the wanted penalty. | + + + + + + + +
+ +Method + + + + +Description + + +
+ +[ascensionMultiplier(points)](./bitburner.gangformulas.ascensionmultiplier.md) + + + + +Calculate ascension mult. + + +
+ +[ascensionPointsGain(exp)](./bitburner.gangformulas.ascensionpointsgain.md) + + + + +Calculate ascension point gain. + + +
+ +[moneyGain(gang, member, task)](./bitburner.gangformulas.moneygain.md) + + + + +Calculate money gain per tick. + + +
+ +[respectGain(gang, member, task)](./bitburner.gangformulas.respectgain.md) + + + + +Calculate respect gain per tick. + + +
+ +[wantedLevelGain(gang, member, task)](./bitburner.gangformulas.wantedlevelgain.md) + + + + +Calculate wanted gain per tick. + + +
+ +[wantedPenalty(gang)](./bitburner.gangformulas.wantedpenalty.md) + + + + +Calculate the wanted penalty. + + +
diff --git a/markdown/bitburner.gangformulas.moneygain.md b/markdown/bitburner.gangformulas.moneygain.md index 58717f7df..449d5de7c 100644 --- a/markdown/bitburner.gangformulas.moneygain.md +++ b/markdown/bitburner.gangformulas.moneygain.md @@ -14,11 +14,71 @@ moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): numbe ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) | -| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Member info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) | -| task | [GangTaskStats](./bitburner.gangtaskstats.md) | Task info from [getTaskStats](./bitburner.gang.gettaskstats.md) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +gang + + + + +[GangGenInfo](./bitburner.ganggeninfo.md) + + + + +Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) + + +
+ +member + + + + +[GangMemberInfo](./bitburner.gangmemberinfo.md) + + + + +Member info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) + + +
+ +task + + + + +[GangTaskStats](./bitburner.gangtaskstats.md) + + + + +Task info from [getTaskStats](./bitburner.gang.gettaskstats.md) + + +
**Returns:** diff --git a/markdown/bitburner.gangformulas.respectgain.md b/markdown/bitburner.gangformulas.respectgain.md index e6fadaa9a..d3c24ee57 100644 --- a/markdown/bitburner.gangformulas.respectgain.md +++ b/markdown/bitburner.gangformulas.respectgain.md @@ -14,11 +14,71 @@ respectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): num ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) | -| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Gang info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) | -| task | [GangTaskStats](./bitburner.gangtaskstats.md) | Gang info from [getTaskStats](./bitburner.gang.gettaskstats.md) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +gang + + + + +[GangGenInfo](./bitburner.ganggeninfo.md) + + + + +Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) + + +
+ +member + + + + +[GangMemberInfo](./bitburner.gangmemberinfo.md) + + + + +Gang info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) + + +
+ +task + + + + +[GangTaskStats](./bitburner.gangtaskstats.md) + + + + +Gang info from [getTaskStats](./bitburner.gang.gettaskstats.md) + + +
**Returns:** diff --git a/markdown/bitburner.gangformulas.wantedlevelgain.md b/markdown/bitburner.gangformulas.wantedlevelgain.md index f3400e600..ad51135c9 100644 --- a/markdown/bitburner.gangformulas.wantedlevelgain.md +++ b/markdown/bitburner.gangformulas.wantedlevelgain.md @@ -14,11 +14,71 @@ wantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) | -| member | [GangMemberInfo](./bitburner.gangmemberinfo.md) | Member info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) | -| task | [GangTaskStats](./bitburner.gangtaskstats.md) | Task info from [getTaskStats](./bitburner.gang.gettaskstats.md) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +gang + + + + +[GangGenInfo](./bitburner.ganggeninfo.md) + + + + +Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) + + +
+ +member + + + + +[GangMemberInfo](./bitburner.gangmemberinfo.md) + + + + +Member info from [getMemberInformation](./bitburner.gang.getmemberinformation.md) + + +
+ +task + + + + +[GangTaskStats](./bitburner.gangtaskstats.md) + + + + +Task info from [getTaskStats](./bitburner.gang.gettaskstats.md) + + +
**Returns:** diff --git a/markdown/bitburner.gangformulas.wantedpenalty.md b/markdown/bitburner.gangformulas.wantedpenalty.md index 295af76f8..8ff4cc08d 100644 --- a/markdown/bitburner.gangformulas.wantedpenalty.md +++ b/markdown/bitburner.gangformulas.wantedpenalty.md @@ -14,9 +14,39 @@ wantedPenalty(gang: GangGenInfo): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +gang + + + + +[GangGenInfo](./bitburner.ganggeninfo.md) + + + + +Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) + + +
**Returns:** diff --git a/markdown/bitburner.ganggeninfo.md b/markdown/bitburner.ganggeninfo.md index 7a2e8876f..f82d218ce 100644 --- a/markdown/bitburner.ganggeninfo.md +++ b/markdown/bitburner.ganggeninfo.md @@ -14,20 +14,292 @@ interface GangGenInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [equipmentCostMult](./bitburner.ganggeninfo.equipmentcostmult.md) | | number | Gang gives a discount on all equipment. This multiplier is applied to the equipment cost. | -| [faction](./bitburner.ganggeninfo.faction.md) | | string | Name of faction that the gang belongs to ("Slum Snakes", etc.) | -| [isHacking](./bitburner.ganggeninfo.ishacking.md) | | boolean | Indicating whether or not it's a hacking gang | -| [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) | | number | Money earned per game cycle | -| [power](./bitburner.ganggeninfo.power.md) | | number | Gang's power for territory warfare | -| [respect](./bitburner.ganggeninfo.respect.md) | | number | Gang's respect | -| [respectForNextRecruit](./bitburner.ganggeninfo.respectfornextrecruit.md) | | number | Amount of Respect needed for next gang recruit, if possible | -| [respectGainRate](./bitburner.ganggeninfo.respectgainrate.md) | | number | Respect earned per game cycle | -| [territory](./bitburner.ganggeninfo.territory.md) | | number | Amount of territory held, in the range 0-1 | -| [territoryClashChance](./bitburner.ganggeninfo.territoryclashchance.md) | | number | Clash chance | -| [territoryWarfareEngaged](./bitburner.ganggeninfo.territorywarfareengaged.md) | | boolean | Indicating if territory clashes are enabled | -| [wantedLevel](./bitburner.ganggeninfo.wantedlevel.md) | | number | Gang's wanted level | -| [wantedLevelGainRate](./bitburner.ganggeninfo.wantedlevelgainrate.md) | | number | Wanted level gained/lost per game cycle (negative for losses) | -| [wantedPenalty](./bitburner.ganggeninfo.wantedpenalty.md) | | number | Number indicating the current wanted penalty | + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[equipmentCostMult](./bitburner.ganggeninfo.equipmentcostmult.md) + + + + + + + +number + + + + +Gang gives a discount on all equipment. This multiplier is applied to the equipment cost. + + +
+ +[faction](./bitburner.ganggeninfo.faction.md) + + + + + + + +string + + + + +Name of faction that the gang belongs to ("Slum Snakes", etc.) + + +
+ +[isHacking](./bitburner.ganggeninfo.ishacking.md) + + + + + + + +boolean + + + + +Indicating whether or not it's a hacking gang + + +
+ +[moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) + + + + + + + +number + + + + +Money earned per game cycle + + +
+ +[power](./bitburner.ganggeninfo.power.md) + + + + + + + +number + + + + +Gang's power for territory warfare + + +
+ +[respect](./bitburner.ganggeninfo.respect.md) + + + + + + + +number + + + + +Gang's respect + + +
+ +[respectForNextRecruit](./bitburner.ganggeninfo.respectfornextrecruit.md) + + + + + + + +number + + + + +Amount of Respect needed for next gang recruit, if possible + + +
+ +[respectGainRate](./bitburner.ganggeninfo.respectgainrate.md) + + + + + + + +number + + + + +Respect earned per game cycle + + +
+ +[territory](./bitburner.ganggeninfo.territory.md) + + + + + + + +number + + + + +Amount of territory held, in the range 0-1 + + +
+ +[territoryClashChance](./bitburner.ganggeninfo.territoryclashchance.md) + + + + + + + +number + + + + +Clash chance + + +
+ +[territoryWarfareEngaged](./bitburner.ganggeninfo.territorywarfareengaged.md) + + + + + + + +boolean + + + + +Indicating if territory clashes are enabled + + +
+ +[wantedLevel](./bitburner.ganggeninfo.wantedlevel.md) + + + + + + + +number + + + + +Gang's wanted level + + +
+ +[wantedLevelGainRate](./bitburner.ganggeninfo.wantedlevelgainrate.md) + + + + + + + +number + + + + +Wanted level gained/lost per game cycle (negative for losses) + + +
+ +[wantedPenalty](./bitburner.ganggeninfo.wantedpenalty.md) + + + + + + + +number + + + + +Number indicating the current wanted penalty + + +
diff --git a/markdown/bitburner.gangmemberascension.md b/markdown/bitburner.gangmemberascension.md index adc8a45af..a20fa5768 100644 --- a/markdown/bitburner.gangmemberascension.md +++ b/markdown/bitburner.gangmemberascension.md @@ -13,13 +13,159 @@ interface GangMemberAscension ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agi](./bitburner.gangmemberascension.agi.md) | | number | Factor by which the agility ascension multiplier was increased (newMult / oldMult) | -| [cha](./bitburner.gangmemberascension.cha.md) | | number | Factor by which the charisma ascension multiplier was increased (newMult / oldMult) | -| [def](./bitburner.gangmemberascension.def.md) | | number | Factor by which the defense ascension multiplier was increased (newMult / oldMult) | -| [dex](./bitburner.gangmemberascension.dex.md) | | number | Factor by which the dexterity ascension multiplier was increased (newMult / oldMult) | -| [hack](./bitburner.gangmemberascension.hack.md) | | number | Factor by which the hacking ascension multiplier was increased (newMult / oldMult) | -| [respect](./bitburner.gangmemberascension.respect.md) | | number | Amount of respect lost from ascending | -| [str](./bitburner.gangmemberascension.str.md) | | number | Factor by which the strength ascension multiplier was increased (newMult / oldMult) | + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agi](./bitburner.gangmemberascension.agi.md) + + + + + + + +number + + + + +Factor by which the agility ascension multiplier was increased (newMult / oldMult) + + +
+ +[cha](./bitburner.gangmemberascension.cha.md) + + + + + + + +number + + + + +Factor by which the charisma ascension multiplier was increased (newMult / oldMult) + + +
+ +[def](./bitburner.gangmemberascension.def.md) + + + + + + + +number + + + + +Factor by which the defense ascension multiplier was increased (newMult / oldMult) + + +
+ +[dex](./bitburner.gangmemberascension.dex.md) + + + + + + + +number + + + + +Factor by which the dexterity ascension multiplier was increased (newMult / oldMult) + + +
+ +[hack](./bitburner.gangmemberascension.hack.md) + + + + + + + +number + + + + +Factor by which the hacking ascension multiplier was increased (newMult / oldMult) + + +
+ +[respect](./bitburner.gangmemberascension.respect.md) + + + + + + + +number + + + + +Amount of respect lost from ascending + + +
+ +[str](./bitburner.gangmemberascension.str.md) + + + + + + + +number + + + + +Factor by which the strength ascension multiplier was increased (newMult / oldMult) + + +
diff --git a/markdown/bitburner.gangmemberexpgain.md b/markdown/bitburner.gangmemberexpgain.md index 66ab26f1c..ae97e3cf9 100644 --- a/markdown/bitburner.gangmemberexpgain.md +++ b/markdown/bitburner.gangmemberexpgain.md @@ -13,12 +13,140 @@ interface GangMemberExpGain ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agi\_exp](./bitburner.gangmemberexpgain.agi_exp.md) | | number | Agi EXP gain for a member after a given task | -| [cha\_exp](./bitburner.gangmemberexpgain.cha_exp.md) | | number | Cha EXP gain for a member after a given task | -| [def\_exp](./bitburner.gangmemberexpgain.def_exp.md) | | number | Def EXP gain for a member after a given task | -| [dex\_exp](./bitburner.gangmemberexpgain.dex_exp.md) | | number | Dex EXP gain for a member after a given task | -| [hack\_exp](./bitburner.gangmemberexpgain.hack_exp.md) | | number | Hack EXP gain for a member after a given task | -| [str\_exp](./bitburner.gangmemberexpgain.str_exp.md) | | number | Str EXP gain for a member after a given task | + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agi\_exp](./bitburner.gangmemberexpgain.agi_exp.md) + + + + + + + +number + + + + +Agi EXP gain for a member after a given task + + +
+ +[cha\_exp](./bitburner.gangmemberexpgain.cha_exp.md) + + + + + + + +number + + + + +Cha EXP gain for a member after a given task + + +
+ +[def\_exp](./bitburner.gangmemberexpgain.def_exp.md) + + + + + + + +number + + + + +Def EXP gain for a member after a given task + + +
+ +[dex\_exp](./bitburner.gangmemberexpgain.dex_exp.md) + + + + + + + +number + + + + +Dex EXP gain for a member after a given task + + +
+ +[hack\_exp](./bitburner.gangmemberexpgain.hack_exp.md) + + + + + + + +number + + + + +Hack EXP gain for a member after a given task + + +
+ +[str\_exp](./bitburner.gangmemberexpgain.str_exp.md) + + + + + + + +number + + + + +Str EXP gain for a member after a given task + + +
diff --git a/markdown/bitburner.gangmemberinfo.md b/markdown/bitburner.gangmemberinfo.md index f4f692a18..573a644f2 100644 --- a/markdown/bitburner.gangmemberinfo.md +++ b/markdown/bitburner.gangmemberinfo.md @@ -13,45 +13,769 @@ interface GangMemberInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agi\_asc\_mult](./bitburner.gangmemberinfo.agi_asc_mult.md) | | number | Agility multiplier from ascensions | -| [agi\_asc\_points](./bitburner.gangmemberinfo.agi_asc_points.md) | | number | Total Agility Ascension points accumulated | -| [agi\_exp](./bitburner.gangmemberinfo.agi_exp.md) | | number | Current agility experience | -| [agi\_mult](./bitburner.gangmemberinfo.agi_mult.md) | | number | Agility multiplier from equipment | -| [agi](./bitburner.gangmemberinfo.agi.md) | | number | Agility skill level | -| [augmentations](./bitburner.gangmemberinfo.augmentations.md) | | string\[\] | List of all Augmentations currently installed on gang member | -| [cha\_asc\_mult](./bitburner.gangmemberinfo.cha_asc_mult.md) | | number | Charisma multiplier from ascensions | -| [cha\_asc\_points](./bitburner.gangmemberinfo.cha_asc_points.md) | | number | Total Charisma Ascension points accumulated | -| [cha\_exp](./bitburner.gangmemberinfo.cha_exp.md) | | number | Current charisma experience | -| [cha\_mult](./bitburner.gangmemberinfo.cha_mult.md) | | number | Charisma multiplier from equipment | -| [cha](./bitburner.gangmemberinfo.cha.md) | | number | Charisma skill level | -| [def\_asc\_mult](./bitburner.gangmemberinfo.def_asc_mult.md) | | number | Defense multiplier from ascensions | -| [def\_asc\_points](./bitburner.gangmemberinfo.def_asc_points.md) | | number | Total Defense Ascension points accumulated | -| [def\_exp](./bitburner.gangmemberinfo.def_exp.md) | | number | Current defense experience | -| [def\_mult](./bitburner.gangmemberinfo.def_mult.md) | | number | Defense multiplier from equipment | -| [def](./bitburner.gangmemberinfo.def.md) | | number | Defense skill level | -| [dex\_asc\_mult](./bitburner.gangmemberinfo.dex_asc_mult.md) | | number | Dexterity multiplier from ascensions | -| [dex\_asc\_points](./bitburner.gangmemberinfo.dex_asc_points.md) | | number | Total Dexterity Ascension points accumulated | -| [dex\_exp](./bitburner.gangmemberinfo.dex_exp.md) | | number | Current dexterity experience | -| [dex\_mult](./bitburner.gangmemberinfo.dex_mult.md) | | number | Dexterity multiplier from equipment | -| [dex](./bitburner.gangmemberinfo.dex.md) | | number | Dexterity skill level | -| [earnedRespect](./bitburner.gangmemberinfo.earnedrespect.md) | | number | Amount of Respect earned by member since they last Ascended | -| [expGain](./bitburner.gangmemberinfo.expgain.md) | | [GangMemberExpGain](./bitburner.gangmemberexpgain.md) \| null |

Per Cycle Exp object for each stat for this gang member.

null in the event that the member does not have a given task.

| -| [hack\_asc\_mult](./bitburner.gangmemberinfo.hack_asc_mult.md) | | number | Hack multiplier from ascensions | -| [hack\_asc\_points](./bitburner.gangmemberinfo.hack_asc_points.md) | | number | Total Hack Ascension points accumulated | -| [hack\_exp](./bitburner.gangmemberinfo.hack_exp.md) | | number | Current hack experience | -| [hack\_mult](./bitburner.gangmemberinfo.hack_mult.md) | | number | Hack multiplier from equipment | -| [hack](./bitburner.gangmemberinfo.hack.md) | | number | Hack skill level | -| [moneyGain](./bitburner.gangmemberinfo.moneygain.md) | | number | Per Cycle Income for this gang member | -| [name](./bitburner.gangmemberinfo.name.md) | | string | Name of the gang member | -| [respectGain](./bitburner.gangmemberinfo.respectgain.md) | | number | Per Cycle Rate this member is currently gaining Respect | -| [str\_asc\_mult](./bitburner.gangmemberinfo.str_asc_mult.md) | | number | Strength multiplier from ascensions | -| [str\_asc\_points](./bitburner.gangmemberinfo.str_asc_points.md) | | number | Total Strength Ascension points accumulated | -| [str\_exp](./bitburner.gangmemberinfo.str_exp.md) | | number | Current strength experience | -| [str\_mult](./bitburner.gangmemberinfo.str_mult.md) | | number | Strength multiplier from equipment | -| [str](./bitburner.gangmemberinfo.str.md) | | number | Strength skill level | -| [task](./bitburner.gangmemberinfo.task.md) | | string | Currently assigned task | -| [upgrades](./bitburner.gangmemberinfo.upgrades.md) | | string\[\] | List of all non-Augmentation Equipment owned by gang member | -| [wantedLevelGain](./bitburner.gangmemberinfo.wantedlevelgain.md) | | number | Per Cycle Rate by which this member is affecting your gang's Wanted Level | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agi\_asc\_mult](./bitburner.gangmemberinfo.agi_asc_mult.md) + + + + + + + +number + + + + +Agility multiplier from ascensions + + +
+ +[agi\_asc\_points](./bitburner.gangmemberinfo.agi_asc_points.md) + + + + + + + +number + + + + +Total Agility Ascension points accumulated + + +
+ +[agi\_exp](./bitburner.gangmemberinfo.agi_exp.md) + + + + + + + +number + + + + +Current agility experience + + +
+ +[agi\_mult](./bitburner.gangmemberinfo.agi_mult.md) + + + + + + + +number + + + + +Agility multiplier from equipment + + +
+ +[agi](./bitburner.gangmemberinfo.agi.md) + + + + + + + +number + + + + +Agility skill level + + +
+ +[augmentations](./bitburner.gangmemberinfo.augmentations.md) + + + + + + + +string\[\] + + + + +List of all Augmentations currently installed on gang member + + +
+ +[cha\_asc\_mult](./bitburner.gangmemberinfo.cha_asc_mult.md) + + + + + + + +number + + + + +Charisma multiplier from ascensions + + +
+ +[cha\_asc\_points](./bitburner.gangmemberinfo.cha_asc_points.md) + + + + + + + +number + + + + +Total Charisma Ascension points accumulated + + +
+ +[cha\_exp](./bitburner.gangmemberinfo.cha_exp.md) + + + + + + + +number + + + + +Current charisma experience + + +
+ +[cha\_mult](./bitburner.gangmemberinfo.cha_mult.md) + + + + + + + +number + + + + +Charisma multiplier from equipment + + +
+ +[cha](./bitburner.gangmemberinfo.cha.md) + + + + + + + +number + + + + +Charisma skill level + + +
+ +[def\_asc\_mult](./bitburner.gangmemberinfo.def_asc_mult.md) + + + + + + + +number + + + + +Defense multiplier from ascensions + + +
+ +[def\_asc\_points](./bitburner.gangmemberinfo.def_asc_points.md) + + + + + + + +number + + + + +Total Defense Ascension points accumulated + + +
+ +[def\_exp](./bitburner.gangmemberinfo.def_exp.md) + + + + + + + +number + + + + +Current defense experience + + +
+ +[def\_mult](./bitburner.gangmemberinfo.def_mult.md) + + + + + + + +number + + + + +Defense multiplier from equipment + + +
+ +[def](./bitburner.gangmemberinfo.def.md) + + + + + + + +number + + + + +Defense skill level + + +
+ +[dex\_asc\_mult](./bitburner.gangmemberinfo.dex_asc_mult.md) + + + + + + + +number + + + + +Dexterity multiplier from ascensions + + +
+ +[dex\_asc\_points](./bitburner.gangmemberinfo.dex_asc_points.md) + + + + + + + +number + + + + +Total Dexterity Ascension points accumulated + + +
+ +[dex\_exp](./bitburner.gangmemberinfo.dex_exp.md) + + + + + + + +number + + + + +Current dexterity experience + + +
+ +[dex\_mult](./bitburner.gangmemberinfo.dex_mult.md) + + + + + + + +number + + + + +Dexterity multiplier from equipment + + +
+ +[dex](./bitburner.gangmemberinfo.dex.md) + + + + + + + +number + + + + +Dexterity skill level + + +
+ +[earnedRespect](./bitburner.gangmemberinfo.earnedrespect.md) + + + + + + + +number + + + + +Amount of Respect earned by member since they last Ascended + + +
+ +[expGain](./bitburner.gangmemberinfo.expgain.md) + + + + + + + +[GangMemberExpGain](./bitburner.gangmemberexpgain.md) \| null + + + + +Per Cycle Exp object for each stat for this gang member. + +null in the event that the member does not have a given task. + + +
+ +[hack\_asc\_mult](./bitburner.gangmemberinfo.hack_asc_mult.md) + + + + + + + +number + + + + +Hack multiplier from ascensions + + +
+ +[hack\_asc\_points](./bitburner.gangmemberinfo.hack_asc_points.md) + + + + + + + +number + + + + +Total Hack Ascension points accumulated + + +
+ +[hack\_exp](./bitburner.gangmemberinfo.hack_exp.md) + + + + + + + +number + + + + +Current hack experience + + +
+ +[hack\_mult](./bitburner.gangmemberinfo.hack_mult.md) + + + + + + + +number + + + + +Hack multiplier from equipment + + +
+ +[hack](./bitburner.gangmemberinfo.hack.md) + + + + + + + +number + + + + +Hack skill level + + +
+ +[moneyGain](./bitburner.gangmemberinfo.moneygain.md) + + + + + + + +number + + + + +Per Cycle Income for this gang member + + +
+ +[name](./bitburner.gangmemberinfo.name.md) + + + + + + + +string + + + + +Name of the gang member + + +
+ +[respectGain](./bitburner.gangmemberinfo.respectgain.md) + + + + + + + +number + + + + +Per Cycle Rate this member is currently gaining Respect + + +
+ +[str\_asc\_mult](./bitburner.gangmemberinfo.str_asc_mult.md) + + + + + + + +number + + + + +Strength multiplier from ascensions + + +
+ +[str\_asc\_points](./bitburner.gangmemberinfo.str_asc_points.md) + + + + + + + +number + + + + +Total Strength Ascension points accumulated + + +
+ +[str\_exp](./bitburner.gangmemberinfo.str_exp.md) + + + + + + + +number + + + + +Current strength experience + + +
+ +[str\_mult](./bitburner.gangmemberinfo.str_mult.md) + + + + + + + +number + + + + +Strength multiplier from equipment + + +
+ +[str](./bitburner.gangmemberinfo.str.md) + + + + + + + +number + + + + +Strength skill level + + +
+ +[task](./bitburner.gangmemberinfo.task.md) + + + + + + + +string + + + + +Currently assigned task + + +
+ +[upgrades](./bitburner.gangmemberinfo.upgrades.md) + + + + + + + +string\[\] + + + + +List of all non-Augmentation Equipment owned by gang member + + +
+ +[wantedLevelGain](./bitburner.gangmemberinfo.wantedlevelgain.md) + + + + + + + +number + + + + +Per Cycle Rate by which this member is affecting your gang's Wanted Level + + +
diff --git a/markdown/bitburner.gangmemberinstall.md b/markdown/bitburner.gangmemberinstall.md index 503b28a63..32ca2d77c 100644 --- a/markdown/bitburner.gangmemberinstall.md +++ b/markdown/bitburner.gangmemberinstall.md @@ -13,12 +13,140 @@ interface GangMemberInstall ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agi](./bitburner.gangmemberinstall.agi.md) | | number | Factor by which the agility ascension multiplier was decreased (newMult / oldMult) | -| [cha](./bitburner.gangmemberinstall.cha.md) | | number | Factor by which the charisma ascension multiplier was decreased (newMult / oldMult) | -| [def](./bitburner.gangmemberinstall.def.md) | | number | Factor by which the defense ascension multiplier was decreased (newMult / oldMult) | -| [dex](./bitburner.gangmemberinstall.dex.md) | | number | Factor by which the dexterity ascension multiplier was decreased (newMult / oldMult) | -| [hack](./bitburner.gangmemberinstall.hack.md) | | number | Factor by which the hacking ascension multiplier was decreased (newMult / oldMult) | -| [str](./bitburner.gangmemberinstall.str.md) | | number | Factor by which the strength ascension multiplier was decreased (newMult / oldMult) | + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agi](./bitburner.gangmemberinstall.agi.md) + + + + + + + +number + + + + +Factor by which the agility ascension multiplier was decreased (newMult / oldMult) + + +
+ +[cha](./bitburner.gangmemberinstall.cha.md) + + + + + + + +number + + + + +Factor by which the charisma ascension multiplier was decreased (newMult / oldMult) + + +
+ +[def](./bitburner.gangmemberinstall.def.md) + + + + + + + +number + + + + +Factor by which the defense ascension multiplier was decreased (newMult / oldMult) + + +
+ +[dex](./bitburner.gangmemberinstall.dex.md) + + + + + + + +number + + + + +Factor by which the dexterity ascension multiplier was decreased (newMult / oldMult) + + +
+ +[hack](./bitburner.gangmemberinstall.hack.md) + + + + + + + +number + + + + +Factor by which the hacking ascension multiplier was decreased (newMult / oldMult) + + +
+ +[str](./bitburner.gangmemberinstall.str.md) + + + + + + + +number + + + + +Factor by which the strength ascension multiplier was decreased (newMult / oldMult) + + +
diff --git a/markdown/bitburner.gangotherinfoobject.md b/markdown/bitburner.gangotherinfoobject.md index b6d9b37c2..615d293c1 100644 --- a/markdown/bitburner.gangotherinfoobject.md +++ b/markdown/bitburner.gangotherinfoobject.md @@ -13,8 +13,64 @@ interface GangOtherInfoObject ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [power](./bitburner.gangotherinfoobject.power.md) | | number | Gang power | -| [territory](./bitburner.gangotherinfoobject.territory.md) | | number | Gang territory, in the range 0-1 | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[power](./bitburner.gangotherinfoobject.power.md) + + + + + + + +number + + + + +Gang power + + +
+ +[territory](./bitburner.gangotherinfoobject.territory.md) + + + + + + + +number + + + + +Gang territory, in the range 0-1 + + +
diff --git a/markdown/bitburner.gangtaskstats.md b/markdown/bitburner.gangtaskstats.md index 505443931..076104226 100644 --- a/markdown/bitburner.gangtaskstats.md +++ b/markdown/bitburner.gangtaskstats.md @@ -14,21 +14,311 @@ interface GangTaskStats ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agiWeight](./bitburner.gangtaskstats.agiweight.md) | | number | Agility skill impact on task scaling | -| [baseMoney](./bitburner.gangtaskstats.basemoney.md) | | number | Base money earned | -| [baseRespect](./bitburner.gangtaskstats.baserespect.md) | | number | Base respect earned | -| [baseWanted](./bitburner.gangtaskstats.basewanted.md) | | number | Base wanted earned | -| [chaWeight](./bitburner.gangtaskstats.chaweight.md) | | number | Charisma skill impact on task scaling | -| [defWeight](./bitburner.gangtaskstats.defweight.md) | | number | Defense skill impact on task scaling | -| [desc](./bitburner.gangtaskstats.desc.md) | | string | Task Description | -| [dexWeight](./bitburner.gangtaskstats.dexweight.md) | | number | Dexterity skill impact on task scaling | -| [difficulty](./bitburner.gangtaskstats.difficulty.md) | | number | Number representing the difficulty of the task | -| [hackWeight](./bitburner.gangtaskstats.hackweight.md) | | number | Hacking skill impact on task scaling | -| [isCombat](./bitburner.gangtaskstats.iscombat.md) | | boolean | Is a task of a combat gang | -| [isHacking](./bitburner.gangtaskstats.ishacking.md) | | boolean | Is a task of a hacking gang | -| [name](./bitburner.gangtaskstats.name.md) | | string | Task name | -| [strWeight](./bitburner.gangtaskstats.strweight.md) | | number | Strength skill impact on task scaling | -| [territory](./bitburner.gangtaskstats.territory.md) | | [GangTerritory](./bitburner.gangterritory.md) | Territory impact on task scaling | + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agiWeight](./bitburner.gangtaskstats.agiweight.md) + + + + + + + +number + + + + +Agility skill impact on task scaling + + +
+ +[baseMoney](./bitburner.gangtaskstats.basemoney.md) + + + + + + + +number + + + + +Base money earned + + +
+ +[baseRespect](./bitburner.gangtaskstats.baserespect.md) + + + + + + + +number + + + + +Base respect earned + + +
+ +[baseWanted](./bitburner.gangtaskstats.basewanted.md) + + + + + + + +number + + + + +Base wanted earned + + +
+ +[chaWeight](./bitburner.gangtaskstats.chaweight.md) + + + + + + + +number + + + + +Charisma skill impact on task scaling + + +
+ +[defWeight](./bitburner.gangtaskstats.defweight.md) + + + + + + + +number + + + + +Defense skill impact on task scaling + + +
+ +[desc](./bitburner.gangtaskstats.desc.md) + + + + + + + +string + + + + +Task Description + + +
+ +[dexWeight](./bitburner.gangtaskstats.dexweight.md) + + + + + + + +number + + + + +Dexterity skill impact on task scaling + + +
+ +[difficulty](./bitburner.gangtaskstats.difficulty.md) + + + + + + + +number + + + + +Number representing the difficulty of the task + + +
+ +[hackWeight](./bitburner.gangtaskstats.hackweight.md) + + + + + + + +number + + + + +Hacking skill impact on task scaling + + +
+ +[isCombat](./bitburner.gangtaskstats.iscombat.md) + + + + + + + +boolean + + + + +Is a task of a combat gang + + +
+ +[isHacking](./bitburner.gangtaskstats.ishacking.md) + + + + + + + +boolean + + + + +Is a task of a hacking gang + + +
+ +[name](./bitburner.gangtaskstats.name.md) + + + + + + + +string + + + + +Task name + + +
+ +[strWeight](./bitburner.gangtaskstats.strweight.md) + + + + + + + +number + + + + +Strength skill impact on task scaling + + +
+ +[territory](./bitburner.gangtaskstats.territory.md) + + + + + + + +[GangTerritory](./bitburner.gangterritory.md) + + + + +Territory impact on task scaling + + +
diff --git a/markdown/bitburner.gangterritory.md b/markdown/bitburner.gangterritory.md index 1ef82b948..315ae344f 100644 --- a/markdown/bitburner.gangterritory.md +++ b/markdown/bitburner.gangterritory.md @@ -13,9 +13,83 @@ interface GangTerritory ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [money](./bitburner.gangterritory.money.md) | | number | Money gain impact on task scaling | -| [respect](./bitburner.gangterritory.respect.md) | | number | Respect gain impact on task scaling | -| [wanted](./bitburner.gangterritory.wanted.md) | | number | Wanted gain impact on task scaling | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[money](./bitburner.gangterritory.money.md) + + + + + + + +number + + + + +Money gain impact on task scaling + + +
+ +[respect](./bitburner.gangterritory.respect.md) + + + + + + + +number + + + + +Respect gain impact on task scaling + + +
+ +[wanted](./bitburner.gangterritory.wanted.md) + + + + + + + +number + + + + +Wanted gain impact on task scaling + + +
diff --git a/markdown/bitburner.go.makemove.md b/markdown/bitburner.go.makemove.md index 7b24a7883..cfa6a1d19 100644 --- a/markdown/bitburner.go.makemove.md +++ b/markdown/bitburner.go.makemove.md @@ -22,11 +22,71 @@ makeMove( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| x | number | x coordinate of move to make | -| y | number | y coordinate of move to make | -| playAsWhite | boolean | _(Optional)_ optional. If true, attempts to play as white and then wait for black's move. Can only be used when playing as white when the opponent is set to "No AI" | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +x + + + + +number + + + + +x coordinate of move to make + + +
+ +y + + + + +number + + + + +y coordinate of move to make + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ optional. If true, attempts to play as white and then wait for black's move. Can only be used when playing as white when the opponent is set to "No AI" + + +
**Returns:** diff --git a/markdown/bitburner.go.md b/markdown/bitburner.go.md index e68a69e62..2c6b7dc7c 100644 --- a/markdown/bitburner.go.md +++ b/markdown/bitburner.go.md @@ -14,22 +14,196 @@ export interface Go ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [analysis](./bitburner.go.analysis.md) | | [GoAnalysis](./bitburner.goanalysis.md) | Tools to analyze the IPvGO subnet. | -| [cheat](./bitburner.go.cheat.md) | | [GoCheat](./bitburner.gocheat.md) | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[analysis](./bitburner.go.analysis.md) + + + + + + + +[GoAnalysis](./bitburner.goanalysis.md) + + + + +Tools to analyze the IPvGO subnet. + + +
+ +[cheat](./bitburner.go.cheat.md) + + + + + + + +[GoCheat](./bitburner.gocheat.md) + + + + +Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. + + +
## Methods -| Method | Description | -| --- | --- | -| [getBoardState()](./bitburner.go.getboardstate.md) |

Retrieves a simplified version of the board state. "X" represents black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. (They are not territory nor open nodes.)

For example, a 5x5 board might look like this:

\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\]

Each string represents a vertical column on the board, and each character in the string represents a point.

Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\].

Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.

| -| [getCurrentPlayer()](./bitburner.go.getcurrentplayer.md) | Returns the color of the current player, or 'None' if the game is over. | -| [getGameState()](./bitburner.go.getgamestate.md) | Gets the status of the current game. Shows the current player, current score, and the previous move coordinates. Previous move will be null 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, playAsWhite)](./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, playAsWhite)](./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(passAsWhite)](./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 already on the subnet after a reset.

| + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[getBoardState()](./bitburner.go.getboardstate.md) + + + + +Retrieves a simplified version of the board state. "X" represents black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. (They are not territory nor open nodes.) + +For example, a 5x5 board might look like this: + +\[
"XX.O.",
"X..OO",
".XO..",
"XXO.\#",
".XO.\#",
\] + +Each string represents a vertical column on the board, and each character in the string represents a point. + +Traditional notation for Go is e.g. "B,1" referring to second ("B") column, first rank. This is the equivalent of index \[1\]\[0\]. + +Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab. + + +
+ +[getCurrentPlayer()](./bitburner.go.getcurrentplayer.md) + + + + +Returns the color of the current player, or 'None' if the game is over. + + +
+ +[getGameState()](./bitburner.go.getgamestate.md) + + + + +Gets the status of the current game. Shows the current player, current score, and the previous move coordinates. Previous move will be null 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, playAsWhite)](./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, playAsWhite)](./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(passAsWhite)](./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 already on the subnet after a reset. + + +
diff --git a/markdown/bitburner.go.opponentnextturn.md b/markdown/bitburner.go.opponentnextturn.md index 54153b543..19211d472 100644 --- a/markdown/bitburner.go.opponentnextturn.md +++ b/markdown/bitburner.go.opponentnextturn.md @@ -21,10 +21,55 @@ opponentNextTurn( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| logOpponentMove | boolean | _(Optional)_ optional, defaults to true. if false prevents logging opponent move | -| playAsWhite | boolean | _(Optional)_ optional. If true, waits to get the next move the black player makes. Intended to be used when playing as white when the opponent is set to "No AI" | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +logOpponentMove + + + + +boolean + + + + +_(Optional)_ optional, defaults to true. if false prevents logging opponent move + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ optional. If true, waits to get the next move the black player makes. Intended to be used when playing as white when the opponent is set to "No AI" + + +
**Returns:** diff --git a/markdown/bitburner.go.passturn.md b/markdown/bitburner.go.passturn.md index 48f83bc5e..9c3bf1b5f 100644 --- a/markdown/bitburner.go.passturn.md +++ b/markdown/bitburner.go.passturn.md @@ -20,9 +20,39 @@ passTurn(passAsWhite?: boolean): Promise<{ ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| passAsWhite | boolean | _(Optional)_ optional. If true, attempts to pass as white and then wait for black's move. Only can be used when playing against "No AI". | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +passAsWhite + + + + +boolean + + + + +_(Optional)_ optional. If true, attempts to pass as white and then wait for black's move. Only can be used when playing against "No AI". + + +
**Returns:** diff --git a/markdown/bitburner.go.resetboardstate.md b/markdown/bitburner.go.resetboardstate.md index aa2422e64..880823731 100644 --- a/markdown/bitburner.go.resetboardstate.md +++ b/markdown/bitburner.go.resetboardstate.md @@ -16,10 +16,55 @@ resetBoardState(opponent: GoOpponent, boardSize: 5 | 7 | 9 | 13): string[] | und ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| opponent | [GoOpponent](./bitburner.goopponent.md) | The opponent faction to play against. "Netburners" \| "Slum Snakes" \| "The Black Hand" \| "Tetrads" \| "Daedalus" \| "Illuminati" \| "????????????" \| "No AI" | -| boardSize | 5 \| 7 \| 9 \| 13 | The size of the board to play on. Must be 5, 7, 9, or 13. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +opponent + + + + +[GoOpponent](./bitburner.goopponent.md) + + + + +The opponent faction to play against. "Netburners" \| "Slum Snakes" \| "The Black Hand" \| "Tetrads" \| "Daedalus" \| "Illuminati" \| "????????????" \| "No AI" + + +
+ +boardSize + + + + +5 \| 7 \| 9 \| 13 + + + + +The size of the board to play on. Must be 5, 7, 9, or 13. + + +
**Returns:** diff --git a/markdown/bitburner.goanalysis.clearpointhighlight.md b/markdown/bitburner.goanalysis.clearpointhighlight.md index d3ede938c..d4cb765ce 100644 --- a/markdown/bitburner.goanalysis.clearpointhighlight.md +++ b/markdown/bitburner.goanalysis.clearpointhighlight.md @@ -14,10 +14,55 @@ clearPointHighlight(x: number, y: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| x | number | the x coordinate to remove highlight from | -| y | number | the y coordinate to remove highlight from | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +x + + + + +number + + + + +the x coordinate to remove highlight from + + +
+ +y + + + + +number + + + + +the y coordinate to remove highlight from + + +
**Returns:** diff --git a/markdown/bitburner.goanalysis.getchains.md b/markdown/bitburner.goanalysis.getchains.md index aa25f4649..9e640bccd 100644 --- a/markdown/bitburner.goanalysis.getchains.md +++ b/markdown/bitburner.goanalysis.getchains.md @@ -20,9 +20,39 @@ getChains(boardState?: string[]): (number | null)[][]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| boardState | string\[\] | _(Optional)_ Optional. The current board state, as an array of strings. Defaults to the current board state. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +boardState + + + + +string\[\] + + + + +_(Optional)_ Optional. The current board state, as an array of strings. Defaults to the current board state. + + +
**Returns:** diff --git a/markdown/bitburner.goanalysis.getcontrolledemptynodes.md b/markdown/bitburner.goanalysis.getcontrolledemptynodes.md index a8ca593fa..21929cd76 100644 --- a/markdown/bitburner.goanalysis.getcontrolledemptynodes.md +++ b/markdown/bitburner.goanalysis.getcontrolledemptynodes.md @@ -20,9 +20,39 @@ getControlledEmptyNodes(boardState?: string[]): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| boardState | string\[\] | _(Optional)_ Optional. The current board state, as an array of strings. Defaults to the current board state. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +boardState + + + + +string\[\] + + + + +_(Optional)_ Optional. The current board state, as an array of strings. Defaults to the current board state. + + +
**Returns:** diff --git a/markdown/bitburner.goanalysis.getliberties.md b/markdown/bitburner.goanalysis.getliberties.md index 7f5c32424..da69073ad 100644 --- a/markdown/bitburner.goanalysis.getliberties.md +++ b/markdown/bitburner.goanalysis.getliberties.md @@ -18,9 +18,39 @@ getLiberties(boardState?: string[]): number[][]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| boardState | string\[\] | _(Optional)_ Optional. The current board state, as an array of strings. Defaults to the current board state. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +boardState + + + + +string\[\] + + + + +_(Optional)_ Optional. The current board state, as an array of strings. Defaults to the current board state. + + +
**Returns:** diff --git a/markdown/bitburner.goanalysis.getvalidmoves.md b/markdown/bitburner.goanalysis.getvalidmoves.md index e820ae1b5..c061f0e93 100644 --- a/markdown/bitburner.goanalysis.getvalidmoves.md +++ b/markdown/bitburner.goanalysis.getvalidmoves.md @@ -24,11 +24,71 @@ getValidMoves(boardState?: string[] | boolean, priorBoardState?: string[], playA ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| boardState | string\[\] \| boolean | _(Optional)_ Optional. The board state to analyze, in the string\[\] format used by getBoardState(). Defaults to the current board state. Alternatively can be simply "true" to get current valid moves for white. | -| priorBoardState | string\[\] | _(Optional)_ Optional. The move before the board state to analyze, in the format used by getBoardState(). Defaults to the current board's prior move state. | -| playAsWhite | boolean | _(Optional)_ Optional. Whether to analyze the board state as if the white player is the current player. Defaults to false. Intended to be used when playing as white when the opponent is set to "No AI". | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +boardState + + + + +string\[\] \| boolean + + + + +_(Optional)_ Optional. The board state to analyze, in the string\[\] format used by getBoardState(). Defaults to the current board state. Alternatively can be simply "true" to get current valid moves for white. + + +
+ +priorBoardState + + + + +string\[\] + + + + +_(Optional)_ Optional. The move before the board state to analyze, in the format used by getBoardState(). Defaults to the current board's prior move state. + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ Optional. Whether to analyze the board state as if the white player is the current player. Defaults to false. Intended to be used when playing as white when the opponent is set to "No AI". + + +
**Returns:** diff --git a/markdown/bitburner.goanalysis.highlightpoint.md b/markdown/bitburner.goanalysis.highlightpoint.md index 663e7995b..ed390c509 100644 --- a/markdown/bitburner.goanalysis.highlightpoint.md +++ b/markdown/bitburner.goanalysis.highlightpoint.md @@ -14,12 +14,87 @@ highlightPoint(x: number, y: number, color?: string, text?: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| x | number | The x coordinate to highlight | -| y | number | The y coordinate to highlight | -| color | string | _(Optional)_ The color to use for the circle. It can be any value accepted by [outline-color CSS property](https://developer.mozilla.org/en-US/docs/Web/CSS/outline-color) (e.g., an RGB string like "\#FFF000"). You can also use "none" to clear it or one of 5 special values: "hack", "hp", "money", "int", "cha". The corresponding colors of 5 special values depend on your theme. | -| text | string | _(Optional)_ Text to add to the node (replaces the default A.1 or B5 seen on hover). Should be kept short to fit well. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +x + + + + +number + + + + +The x coordinate to highlight + + +
+ +y + + + + +number + + + + +The y coordinate to highlight + + +
+ +color + + + + +string + + + + +_(Optional)_ The color to use for the circle. It can be any value accepted by [outline-color CSS property](https://developer.mozilla.org/en-US/docs/Web/CSS/outline-color) (e.g., an RGB string like "\#FFF000"). You can also use "none" to clear it or one of 5 special values: "hack", "hp", "money", "int", "cha". The corresponding colors of 5 special values depend on your theme. + + +
+ +text + + + + +string + + + + +_(Optional)_ Text to add to the node (replaces the default A.1 or B5 seen on hover). Should be kept short to fit well. + + +
**Returns:** diff --git a/markdown/bitburner.goanalysis.md b/markdown/bitburner.goanalysis.md index b034827fa..1808cfa77 100644 --- a/markdown/bitburner.goanalysis.md +++ b/markdown/bitburner.goanalysis.md @@ -14,16 +14,156 @@ export interface GoAnalysis ## Methods -| Method | Description | -| --- | --- | -| [clearAllPointHighlights()](./bitburner.goanalysis.clearallpointhighlights.md) | Removes all highlights from the board. | -| [clearPointHighlight(x, y)](./bitburner.goanalysis.clearpointhighlight.md) | Removes the highlight color and text from the specified node. | -| [getChains(boardState)](./bitburner.goanalysis.getchains.md) |

Returns an ID for each point. All points that share an ID are part of the same network (or "chain"). Empty points are also given chain IDs to represent continuous empty space. Dead nodes are given the value null.

Takes an optional boardState argument; by default uses the current board state.

The data from getChains() can be used with the data from getBoardState() to see which player (or empty) each chain is

For example, a 5x5 board might look like this. There is a large chain \#1 on the left side, smaller chains 2 and 3 on the right, and a large chain 0 taking up the center of the board. 

 \[ \[ 0,0,0,3,4\], \[ 1,0,0,3,3\], \[ 1,1,0,0,0\], \[null,1,0,2,2\], \[null,1,0,2,5\], \]

| -| [getControlledEmptyNodes(boardState)](./bitburner.goanalysis.getcontrolledemptynodes.md) |

Returns 'X' for black, 'O' for white, 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.

Takes an optional boardState argument; by default uses the current board state.

Filled points of any color are indicated with '.'

In this example, white encircles some space in the top-left, black encircles some in the top-right, and between their routers is contested space in the center: 

 \[ "OO..?", "OO.?.", "O.?.X", ".?.XX", "?..X\#", \]

| -| [getLiberties(boardState)](./bitburner.goanalysis.getliberties.md) |

Returns a number for each point, representing how many open nodes its network/chain is connected to. Empty nodes and dead nodes are shown as -1 liberties.

Takes an optional boardState argument; by default uses the current board state.

For example, a 5x5 board might look like this. The chain in the top-left touches 5 total empty nodes, and the one in the center touches four. The group in the bottom-right only has one liberty; it is in danger of being captured! 

 \[ \[-1, 5,-1,-1, 2\], \[ 5, 5,-1,-1,-1\], \[-1,-1, 4,-1,-1\], \[ 3,-1,-1, 3, 1\], \[ 3,-1,-1, 3, 1\], \]

| -| [getStats()](./bitburner.goanalysis.getstats.md) |

Displays the game history, captured nodes, and gained bonuses for each opponent you have played against.

The details are keyed by opponent name, in this structure:

 { : { wins: number, losses: number, winStreak: number, highestWinStreak: number, favor: number, bonusPercent: number, bonusDescription: string, } }

| -| [getValidMoves(boardState, priorBoardState, playAsWhite)](./bitburner.goanalysis.getvalidmoves.md) |

Shows if each point on the board is a valid move for the player. By default, analyzes the current board state. Takes an optional boardState (and an optional prior-move boardState, if desired) to analyze a custom board.

The true/false validity of each move can be retrieved via the X and Y coordinates of the move. const validMoves = ns.go.analysis.getValidMoves();

const moveIsValid = validMoves[x][y];

Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab.

Also note that, when given a custom board state, only one prior move can be analyzed. This means that the superko rules (no duplicate board states in the full game history) is not supported; you will have to implement your own analysis for that.

The current valid moves for white can also be seen by simply calling ns.go.analysis.getValidMoves(true) .

| -| [highlightPoint(x, y, color, text)](./bitburner.goanalysis.highlightpoint.md) | Adds a colored circle indicator to the specified point. These indicators are removed once a move is played. | -| [resetStats(resetAll)](./bitburner.goanalysis.resetstats.md) | Reset all win/loss and winstreak records for the No AI opponent. | -| [setTestingBoardState(boardState, komi)](./bitburner.goanalysis.settestingboardstate.md) | Starts a new game against the "No AI" opponent, and sets the initial board size, pieces, and offline nodes to the given board state. "X" represent black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. | + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[clearAllPointHighlights()](./bitburner.goanalysis.clearallpointhighlights.md) + + + + +Removes all highlights from the board. + + +
+ +[clearPointHighlight(x, y)](./bitburner.goanalysis.clearpointhighlight.md) + + + + +Removes the highlight color and text from the specified node. + + +
+ +[getChains(boardState)](./bitburner.goanalysis.getchains.md) + + + + +Returns an ID for each point. All points that share an ID are part of the same network (or "chain"). Empty points are also given chain IDs to represent continuous empty space. Dead nodes are given the value `null.` + +Takes an optional boardState argument; by default uses the current board state. + +The data from getChains() can be used with the data from getBoardState() to see which player (or empty) each chain is + +For example, a 5x5 board might look like this. There is a large chain \#1 on the left side, smaller chains 2 and 3 on the right, and a large chain 0 taking up the center of the board. 
 \[ \[ 0,0,0,3,4\], \[ 1,0,0,3,3\], \[ 1,1,0,0,0\], \[null,1,0,2,2\], \[null,1,0,2,5\], \]
+ + +
+ +[getControlledEmptyNodes(boardState)](./bitburner.goanalysis.getcontrolledemptynodes.md) + + + + +Returns 'X' for black, 'O' for white, 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. + +Takes an optional boardState argument; by default uses the current board state. + +Filled points of any color are indicated with '.' + +In this example, white encircles some space in the top-left, black encircles some in the top-right, and between their routers is contested space in the center: 
 \[ "OO..?", "OO.?.", "O.?.X", ".?.XX", "?..X\#", \]
+ + +
+ +[getLiberties(boardState)](./bitburner.goanalysis.getliberties.md) + + + + +Returns a number for each point, representing how many open nodes its network/chain is connected to. Empty nodes and dead nodes are shown as -1 liberties. + +Takes an optional boardState argument; by default uses the current board state. + +For example, a 5x5 board might look like this. The chain in the top-left touches 5 total empty nodes, and the one in the center touches four. The group in the bottom-right only has one liberty; it is in danger of being captured! 
 \[ \[-1, 5,-1,-1, 2\], \[ 5, 5,-1,-1,-1\], \[-1,-1, 4,-1,-1\], \[ 3,-1,-1, 3, 1\], \[ 3,-1,-1, 3, 1\], \]
+ + +
+ +[getStats()](./bitburner.goanalysis.getstats.md) + + + + +Displays the game history, captured nodes, and gained bonuses for each opponent you have played against. + +The details are keyed by opponent name, in this structure: + +
 { : { wins: number, losses: number, winStreak: number, highestWinStreak: number, favor: number, bonusPercent: number, bonusDescription: string, } }
+ + +
+ +[getValidMoves(boardState, priorBoardState, playAsWhite)](./bitburner.goanalysis.getvalidmoves.md) + + + + +Shows if each point on the board is a valid move for the player. By default, analyzes the current board state. Takes an optional boardState (and an optional prior-move boardState, if desired) to analyze a custom board. + +The true/false validity of each move can be retrieved via the X and Y coordinates of the move. `const validMoves = ns.go.analysis.getValidMoves();` + +`const moveIsValid = validMoves[x][y];` + +Note that the \[0\]\[0\] point is shown on the bottom-left on the visual board (as is traditional), and each string represents a vertical column on the board. In other words, the printed example above can be understood to be rotated 90 degrees clockwise compared to the board UI as shown in the IPvGO subnet tab. + +Also note that, when given a custom board state, only one prior move can be analyzed. This means that the superko rules (no duplicate board states in the full game history) is not supported; you will have to implement your own analysis for that. + +The current valid moves for white can also be seen by simply calling `ns.go.analysis.getValidMoves(true)` . + + +
+ +[highlightPoint(x, y, color, text)](./bitburner.goanalysis.highlightpoint.md) + + + + +Adds a colored circle indicator to the specified point. These indicators are removed once a move is played. + + +
+ +[resetStats(resetAll)](./bitburner.goanalysis.resetstats.md) + + + + +Reset all win/loss and winstreak records for the No AI opponent. + + +
+ +[setTestingBoardState(boardState, komi)](./bitburner.goanalysis.settestingboardstate.md) + + + + +Starts a new game against the "No AI" opponent, and sets the initial board size, pieces, and offline nodes to the given board state. "X" represent black pieces, "O" white, and "." empty points. "\#" are dead nodes that are not part of the subnet. + + +
diff --git a/markdown/bitburner.goanalysis.resetstats.md b/markdown/bitburner.goanalysis.resetstats.md index 3740b52b1..8bfd2410e 100644 --- a/markdown/bitburner.goanalysis.resetstats.md +++ b/markdown/bitburner.goanalysis.resetstats.md @@ -14,9 +14,39 @@ resetStats(resetAll?: boolean): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| resetAll | boolean | _(Optional)_ Optional. if true, reset win/loss records for all opponents. Leaves node power and bonuses unchanged. Defaults to false. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +resetAll + + + + +boolean + + + + +_(Optional)_ Optional. if true, reset win/loss records for all opponents. Leaves node power and bonuses unchanged. Defaults to false. + + +
**Returns:** diff --git a/markdown/bitburner.goanalysis.settestingboardstate.md b/markdown/bitburner.goanalysis.settestingboardstate.md index 5a0e0f6fb..a44d8fd3f 100644 --- a/markdown/bitburner.goanalysis.settestingboardstate.md +++ b/markdown/bitburner.goanalysis.settestingboardstate.md @@ -14,10 +14,55 @@ setTestingBoardState(boardState: string[], komi?: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| boardState | string\[\] | The initial board state to use for the new game, in the format used by getBoardState(). | -| komi | number | _(Optional)_ Optional komi value to set for the game. Defaults to 5.5. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +boardState + + + + +string\[\] + + + + +The initial board state to use for the new game, in the format used by getBoardState(). + + +
+ +komi + + + + +number + + + + +_(Optional)_ Optional komi value to set for the game. Defaults to 5.5. + + +
**Returns:** diff --git a/markdown/bitburner.gocheat.destroynode.md b/markdown/bitburner.gocheat.destroynode.md index d1268f663..8df6f5c78 100644 --- a/markdown/bitburner.gocheat.destroynode.md +++ b/markdown/bitburner.gocheat.destroynode.md @@ -26,11 +26,71 @@ destroyNode( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| x | number | x coordinate of empty node to destroy | -| y | number | y coordinate of empty node to destroy | -| playAsWhite | boolean | _(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +x + + + + +number + + + + +x coordinate of empty node to destroy + + +
+ +y + + + + +number + + + + +y coordinate of empty node to destroy + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. + + +
**Returns:** diff --git a/markdown/bitburner.gocheat.getcheatcount.md b/markdown/bitburner.gocheat.getcheatcount.md index 04ee578c0..c6b5374d7 100644 --- a/markdown/bitburner.gocheat.getcheatcount.md +++ b/markdown/bitburner.gocheat.getcheatcount.md @@ -14,9 +14,39 @@ getCheatCount(playAsWhite?: boolean): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| playAsWhite | boolean | _(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. + + +
**Returns:** diff --git a/markdown/bitburner.gocheat.getcheatsuccesschance.md b/markdown/bitburner.gocheat.getcheatsuccesschance.md index a82324b5a..3d3423535 100644 --- a/markdown/bitburner.gocheat.getcheatsuccesschance.md +++ b/markdown/bitburner.gocheat.getcheatsuccesschance.md @@ -16,10 +16,55 @@ getCheatSuccessChance(cheatCount?: number, playAsWhite?: boolean): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| cheatCount | number | _(Optional)_ Optional override for the number of cheats already attempted. Defaults to the number of cheats attempted in the current game. | -| playAsWhite | boolean | _(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +cheatCount + + + + +number + + + + +_(Optional)_ Optional override for the number of cheats already attempted. Defaults to the number of cheats attempted in the current game. + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. + + +
**Returns:** diff --git a/markdown/bitburner.gocheat.md b/markdown/bitburner.gocheat.md index 60b53ee35..bd65c7bce 100644 --- a/markdown/bitburner.gocheat.md +++ b/markdown/bitburner.gocheat.md @@ -14,12 +14,100 @@ export interface GoCheat ## Methods -| Method | Description | -| --- | --- | -| [destroyNode(x, y, playAsWhite)](./bitburner.gocheat.destroynode.md) |

Attempts to destroy an empty node, leaving an offline dead space that does not count as territory or provide open node access to adjacent routers.

Success chance can be seen via ns.go.getCheatSuccessChance()

Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet.

| -| [getCheatCount(playAsWhite)](./bitburner.gocheat.getcheatcount.md) | Returns the number of times you've attempted to cheat in the current game. | -| [getCheatSuccessChance(cheatCount, playAsWhite)](./bitburner.gocheat.getcheatsuccesschance.md) |

Returns your chance of successfully playing one of the special moves in the ns.go.cheat API. Scales up with your crime success rate stat. Scales down with the number of times you've attempted to cheat in the current game.

Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet.

| -| [playTwoMoves(x1, y1, x2, y2, playAsWhite)](./bitburner.gocheat.playtwomoves.md) |

Attempts to place two routers at once on empty nodes. Note that this ignores other move restrictions, so you can suicide your own routers if they have no access to empty ports and do not capture any enemy routers.

Success chance can be seen via ns.go.getCheatSuccessChance()

Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet.

| -| [removeRouter(x, y, playAsWhite)](./bitburner.gocheat.removerouter.md) |

Attempts to remove an existing router, leaving an empty node behind.

Success chance can be seen via ns.go.getCheatSuccessChance()

Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet.

| -| [repairOfflineNode(x, y, playAsWhite)](./bitburner.gocheat.repairofflinenode.md) |

Attempts to repair an offline node, leaving an empty playable node behind.

Success chance can be seen via ns.go.getCheatSuccessChance()

Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet.

| + + + + + + + +
+ +Method + + + + +Description + + +
+ +[destroyNode(x, y, playAsWhite)](./bitburner.gocheat.destroynode.md) + + + + +Attempts to destroy an empty node, leaving an offline dead space that does not count as territory or provide open node access to adjacent routers. + +Success chance can be seen via ns.go.getCheatSuccessChance() + +Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet. + + +
+ +[getCheatCount(playAsWhite)](./bitburner.gocheat.getcheatcount.md) + + + + +Returns the number of times you've attempted to cheat in the current game. + + +
+ +[getCheatSuccessChance(cheatCount, playAsWhite)](./bitburner.gocheat.getcheatsuccesschance.md) + + + + +Returns your chance of successfully playing one of the special moves in the ns.go.cheat API. Scales up with your crime success rate stat. Scales down with the number of times you've attempted to cheat in the current game. + +Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet. + + +
+ +[playTwoMoves(x1, y1, x2, y2, playAsWhite)](./bitburner.gocheat.playtwomoves.md) + + + + +Attempts to place two routers at once on empty nodes. Note that this ignores other move restrictions, so you can suicide your own routers if they have no access to empty ports and do not capture any enemy routers. + +Success chance can be seen via ns.go.getCheatSuccessChance() + +Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet. + + +
+ +[removeRouter(x, y, playAsWhite)](./bitburner.gocheat.removerouter.md) + + + + +Attempts to remove an existing router, leaving an empty node behind. + +Success chance can be seen via ns.go.getCheatSuccessChance() + +Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet. + + +
+ +[repairOfflineNode(x, y, playAsWhite)](./bitburner.gocheat.repairofflinenode.md) + + + + +Attempts to repair an offline node, leaving an empty playable node behind. + +Success chance can be seen via ns.go.getCheatSuccessChance() + +Warning: if you fail to play a cheat move, your turn will be skipped. After your first cheat attempt, if you fail, there is a small (\~10%) chance you will instantly be ejected from the subnet. + + +
diff --git a/markdown/bitburner.gocheat.playtwomoves.md b/markdown/bitburner.gocheat.playtwomoves.md index 4c1383308..c4e23f251 100644 --- a/markdown/bitburner.gocheat.playtwomoves.md +++ b/markdown/bitburner.gocheat.playtwomoves.md @@ -28,13 +28,103 @@ playTwoMoves( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| x1 | number | x coordinate of first move to make | -| y1 | number | y coordinate of first move to make | -| x2 | number | x coordinate of second move to make | -| y2 | number | y coordinate of second move to make | -| playAsWhite | boolean | _(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. | + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +x1 + + + + +number + + + + +x coordinate of first move to make + + +
+ +y1 + + + + +number + + + + +y coordinate of first move to make + + +
+ +x2 + + + + +number + + + + +x coordinate of second move to make + + +
+ +y2 + + + + +number + + + + +y coordinate of second move to make + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. + + +
**Returns:** diff --git a/markdown/bitburner.gocheat.removerouter.md b/markdown/bitburner.gocheat.removerouter.md index c4ec0ce28..275c74be5 100644 --- a/markdown/bitburner.gocheat.removerouter.md +++ b/markdown/bitburner.gocheat.removerouter.md @@ -26,11 +26,71 @@ removeRouter( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| x | number | x coordinate of router to remove | -| y | number | y coordinate of router to remove | -| playAsWhite | boolean | _(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +x + + + + +number + + + + +x coordinate of router to remove + + +
+ +y + + + + +number + + + + +y coordinate of router to remove + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. + + +
**Returns:** diff --git a/markdown/bitburner.gocheat.repairofflinenode.md b/markdown/bitburner.gocheat.repairofflinenode.md index 48060e409..cf5639bb7 100644 --- a/markdown/bitburner.gocheat.repairofflinenode.md +++ b/markdown/bitburner.gocheat.repairofflinenode.md @@ -26,11 +26,71 @@ repairOfflineNode( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| x | number | x coordinate of offline node to repair | -| y | number | y coordinate of offline node to repair | -| playAsWhite | boolean | _(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +x + + + + +number + + + + +x coordinate of offline node to repair + + +
+ +y + + + + +number + + + + +y coordinate of offline node to repair + + +
+ +playAsWhite + + + + +boolean + + + + +_(Optional)_ Optional override for playing as white. Can only be used when playing on a 'No AI' board. + + +
**Returns:** diff --git a/markdown/bitburner.grafting.getaugmentationgraftprice.md b/markdown/bitburner.grafting.getaugmentationgraftprice.md index 237a29a2b..37c39ded3 100644 --- a/markdown/bitburner.grafting.getaugmentationgraftprice.md +++ b/markdown/bitburner.grafting.getaugmentationgraftprice.md @@ -14,9 +14,39 @@ getAugmentationGraftPrice(augName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of the aug to check the price of. Must be an exact match. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of the aug to check the price of. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.grafting.getaugmentationgrafttime.md b/markdown/bitburner.grafting.getaugmentationgrafttime.md index 915d6b78a..cc26d9d5f 100644 --- a/markdown/bitburner.grafting.getaugmentationgrafttime.md +++ b/markdown/bitburner.grafting.getaugmentationgrafttime.md @@ -14,9 +14,39 @@ getAugmentationGraftTime(augName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of the aug to check the grafting time of. Must be an exact match. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of the aug to check the grafting time of. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.grafting.graftaugmentation.md b/markdown/bitburner.grafting.graftaugmentation.md index 344107893..be0db3dab 100644 --- a/markdown/bitburner.grafting.graftaugmentation.md +++ b/markdown/bitburner.grafting.graftaugmentation.md @@ -14,10 +14,55 @@ graftAugmentation(augName: string, focus?: boolean): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | The name of the aug to begin grafting. Must be an exact match. | -| focus | boolean | _(Optional)_ Acquire player focus on this Augmentation grafting. Optional. Defaults to true. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +The name of the aug to begin grafting. Must be an exact match. + + +
+ +focus + + + + +boolean + + + + +_(Optional)_ Acquire player focus on this Augmentation grafting. Optional. Defaults to true. + + +
**Returns:** diff --git a/markdown/bitburner.grafting.md b/markdown/bitburner.grafting.md index 7f0470363..61c4f30a6 100644 --- a/markdown/bitburner.grafting.md +++ b/markdown/bitburner.grafting.md @@ -18,11 +18,71 @@ This API requires Source-File 10 to use. ## Methods -| Method | Description | -| --- | --- | -| [getAugmentationGraftPrice(augName)](./bitburner.grafting.getaugmentationgraftprice.md) | Retrieve the grafting cost of an aug. | -| [getAugmentationGraftTime(augName)](./bitburner.grafting.getaugmentationgrafttime.md) | Retrieves the time required to graft an aug. Do not use this value to determine when the ongoing grafting finishes. The ongoing grafting is affected by current intelligence level and focus bonus. You should use [waitForOngoingGrafting](./bitburner.grafting.waitforongoinggrafting.md) for that purpose. | -| [getGraftableAugmentations()](./bitburner.grafting.getgraftableaugmentations.md) | Retrieves a list of augmentations that can be grafted. | -| [graftAugmentation(augName, focus)](./bitburner.grafting.graftaugmentation.md) | Begins grafting the named aug. You must be in New Tokyo to use this. When you call this API, the current work (grafting or other actions) will be canceled. | -| [waitForOngoingGrafting()](./bitburner.grafting.waitforongoinggrafting.md) | Wait until the ongoing grafting finishes or is canceled. | + + + + + + +
+ +Method + + + + +Description + + +
+ +[getAugmentationGraftPrice(augName)](./bitburner.grafting.getaugmentationgraftprice.md) + + + + +Retrieve the grafting cost of an aug. + + +
+ +[getAugmentationGraftTime(augName)](./bitburner.grafting.getaugmentationgrafttime.md) + + + + +Retrieves the time required to graft an aug. Do not use this value to determine when the ongoing grafting finishes. The ongoing grafting is affected by current intelligence level and focus bonus. You should use [waitForOngoingGrafting](./bitburner.grafting.waitforongoinggrafting.md) for that purpose. + + +
+ +[getGraftableAugmentations()](./bitburner.grafting.getgraftableaugmentations.md) + + + + +Retrieves a list of augmentations that can be grafted. + + +
+ +[graftAugmentation(augName, focus)](./bitburner.grafting.graftaugmentation.md) + + + + +Begins grafting the named aug. You must be in New Tokyo to use this. When you call this API, the current work (grafting or other actions) will be canceled. + + +
+ +[waitForOngoingGrafting()](./bitburner.grafting.waitforongoinggrafting.md) + + + + +Wait until the ongoing grafting finishes or is canceled. + + +
diff --git a/markdown/bitburner.graftingtask.md b/markdown/bitburner.graftingtask.md index 01c47c8be..216ba1998 100644 --- a/markdown/bitburner.graftingtask.md +++ b/markdown/bitburner.graftingtask.md @@ -19,9 +19,79 @@ An object representing the current grafting task ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [augmentation](./bitburner.graftingtask.augmentation.md) | | string | | -| [completion](./bitburner.graftingtask.completion.md) | | Promise<void> | This promise resolves when the task is complete. | -| [type](./bitburner.graftingtask.type.md) | | "GRAFTING" | | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[augmentation](./bitburner.graftingtask.augmentation.md) + + + + + + + +string + + + + + +
+ +[completion](./bitburner.graftingtask.completion.md) + + + + + + + +Promise<void> + + + + +This promise resolves when the task is complete. + + +
+ +[type](./bitburner.graftingtask.type.md) + + + + + + + +"GRAFTING" + + + + + +
diff --git a/markdown/bitburner.hackingformulas.growamount.md b/markdown/bitburner.hackingformulas.growamount.md index 71b1f165f..f7ef35d3f 100644 --- a/markdown/bitburner.hackingformulas.growamount.md +++ b/markdown/bitburner.hackingformulas.growamount.md @@ -18,12 +18,87 @@ growAmount(server: Server, player: Person, threads: number, cores?: number): num ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | -| threads | number | Number of threads to grow with. Can be fractional. | -| cores | number | _(Optional)_ Number of cores on the computer that will execute grow. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
+ +threads + + + + +number + + + + +Number of threads to grow with. Can be fractional. + + +
+ +cores + + + + +number + + + + +_(Optional)_ Number of cores on the computer that will execute grow. + + +
**Returns:** diff --git a/markdown/bitburner.hackingformulas.growpercent.md b/markdown/bitburner.hackingformulas.growpercent.md index c56ade88b..718aadf2d 100644 --- a/markdown/bitburner.hackingformulas.growpercent.md +++ b/markdown/bitburner.hackingformulas.growpercent.md @@ -20,12 +20,87 @@ growPercent(server: Server, threads: number, player: Person, cores?: number): nu ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| threads | number | Amount of threads. Can be fractional. | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | -| cores | number | _(Optional)_ Number of cores on the computer that will execute grow. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +threads + + + + +number + + + + +Amount of threads. Can be fractional. + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
+ +cores + + + + +number + + + + +_(Optional)_ Number of cores on the computer that will execute grow. + + +
**Returns:** diff --git a/markdown/bitburner.hackingformulas.growthreads.md b/markdown/bitburner.hackingformulas.growthreads.md index 6e21fba40..4c73996b4 100644 --- a/markdown/bitburner.hackingformulas.growthreads.md +++ b/markdown/bitburner.hackingformulas.growthreads.md @@ -18,12 +18,87 @@ growThreads(server: Server, player: Person, targetMoney: number, cores?: number) ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | -| targetMoney | number | Desired final money, capped to server's moneyMax | -| cores | number | _(Optional)_ Number of cores on the computer that will execute grow. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
+ +targetMoney + + + + +number + + + + +Desired final money, capped to server's moneyMax + + +
+ +cores + + + + +number + + + + +_(Optional)_ Number of cores on the computer that will execute grow. + + +
**Returns:** diff --git a/markdown/bitburner.hackingformulas.growtime.md b/markdown/bitburner.hackingformulas.growtime.md index f91b0cb3f..e1ea0df02 100644 --- a/markdown/bitburner.hackingformulas.growtime.md +++ b/markdown/bitburner.hackingformulas.growtime.md @@ -14,10 +14,55 @@ growTime(server: Server, player: Person): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
**Returns:** diff --git a/markdown/bitburner.hackingformulas.hackchance.md b/markdown/bitburner.hackingformulas.hackchance.md index 1233c7951..3ef44ddb4 100644 --- a/markdown/bitburner.hackingformulas.hackchance.md +++ b/markdown/bitburner.hackingformulas.hackchance.md @@ -14,10 +14,55 @@ hackChance(server: Server, player: Person): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
**Returns:** diff --git a/markdown/bitburner.hackingformulas.hackexp.md b/markdown/bitburner.hackingformulas.hackexp.md index 4250eeb34..870581684 100644 --- a/markdown/bitburner.hackingformulas.hackexp.md +++ b/markdown/bitburner.hackingformulas.hackexp.md @@ -14,10 +14,55 @@ hackExp(server: Server, player: Person): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
**Returns:** diff --git a/markdown/bitburner.hackingformulas.hackpercent.md b/markdown/bitburner.hackingformulas.hackpercent.md index 76dbf7c1b..849f14b55 100644 --- a/markdown/bitburner.hackingformulas.hackpercent.md +++ b/markdown/bitburner.hackingformulas.hackpercent.md @@ -14,10 +14,55 @@ hackPercent(server: Server, player: Person): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
**Returns:** diff --git a/markdown/bitburner.hackingformulas.hacktime.md b/markdown/bitburner.hackingformulas.hacktime.md index 8054d2f3f..dae7b9436 100644 --- a/markdown/bitburner.hackingformulas.hacktime.md +++ b/markdown/bitburner.hackingformulas.hacktime.md @@ -14,10 +14,55 @@ hackTime(server: Server, player: Person): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
**Returns:** diff --git a/markdown/bitburner.hackingformulas.md b/markdown/bitburner.hackingformulas.md index d1caf2f8f..b084112e0 100644 --- a/markdown/bitburner.hackingformulas.md +++ b/markdown/bitburner.hackingformulas.md @@ -14,15 +14,129 @@ interface HackingFormulas ## Methods -| Method | Description | -| --- | --- | -| [growAmount(server, player, threads, cores)](./bitburner.hackingformulas.growamount.md) |

Calculate the amount of money a grow action will leave a server with. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md), what matters is the state of the server and player when the grow \*finishes\*, not when it is started.

The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details.

The inverse of this function is [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md), although it rounds up to integer threads.

| -| [growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) |

Calculate the growth multiplier constant for a given server and threads.

The actual amount of money grown depends both linearly \*and\* exponentially on threads; this is only giving the exponential part that is used for the multiplier. See [grow](./bitburner.ns.grow.md) for more details.

As a result of the above, this multiplier does \*not\* depend on the amount of money on the server. Changing server.moneyAvailable and server.moneyMax will have no effect.

For the most common use-cases, you probably want either [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md) or [formulas.hacking.growAmount](./bitburner.hackingformulas.growamount.md) instead.

| -| [growThreads(server, player, targetMoney, cores)](./bitburner.hackingformulas.growthreads.md) |

Calculate how many threads it will take to grow server to targetMoney. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md), what matters is the state of the server and player when the grow \*finishes\*, not when it is started.

The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details.

The inverse of this function is [formulas.hacking.growAmount](./bitburner.hackingformulas.growamount.md), although it can work with fractional threads.

| -| [growTime(server, player)](./bitburner.hackingformulas.growtime.md) | Calculate grow time. | -| [hackChance(server, player)](./bitburner.hackingformulas.hackchance.md) | Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.) | -| [hackExp(server, player)](./bitburner.hackingformulas.hackexp.md) | Calculate hack exp for one thread. | -| [hackPercent(server, player)](./bitburner.hackingformulas.hackpercent.md) | Calculate hack percent for one thread. (Ex: 0.25 would steal 25% of the server's current value.) | -| [hackTime(server, player)](./bitburner.hackingformulas.hacktime.md) | Calculate hack time. | -| [weakenTime(server, player)](./bitburner.hackingformulas.weakentime.md) | Calculate weaken time. | + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[growAmount(server, player, threads, cores)](./bitburner.hackingformulas.growamount.md) + + + + +Calculate the amount of money a grow action will leave a server with. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md), what matters is the state of the server and player when the grow \*finishes\*, not when it is started. + +The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details. + +The inverse of this function is [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md), although it rounds up to integer threads. + + +
+ +[growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) + + + + +Calculate the growth multiplier constant for a given server and threads. + +The actual amount of money grown depends both linearly \*and\* exponentially on threads; this is only giving the exponential part that is used for the multiplier. See [grow](./bitburner.ns.grow.md) for more details. + +As a result of the above, this multiplier does \*not\* depend on the amount of money on the server. Changing server.moneyAvailable and server.moneyMax will have no effect. + +For the most common use-cases, you probably want either [formulas.hacking.growThreads](./bitburner.hackingformulas.growthreads.md) or [formulas.hacking.growAmount](./bitburner.hackingformulas.growamount.md) instead. + + +
+ +[growThreads(server, player, targetMoney, cores)](./bitburner.hackingformulas.growthreads.md) + + + + +Calculate how many threads it will take to grow server to targetMoney. Starting money is server.moneyAvailable. Note that when simulating the effect of [grow](./bitburner.ns.grow.md), what matters is the state of the server and player when the grow \*finishes\*, not when it is started. + +The growth amount depends both linearly \*and\* exponentially on threads; see [grow](./bitburner.ns.grow.md) for more details. + +The inverse of this function is [formulas.hacking.growAmount](./bitburner.hackingformulas.growamount.md), although it can work with fractional threads. + + +
+ +[growTime(server, player)](./bitburner.hackingformulas.growtime.md) + + + + +Calculate grow time. + + +
+ +[hackChance(server, player)](./bitburner.hackingformulas.hackchance.md) + + + + +Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.) + + +
+ +[hackExp(server, player)](./bitburner.hackingformulas.hackexp.md) + + + + +Calculate hack exp for one thread. + + +
+ +[hackPercent(server, player)](./bitburner.hackingformulas.hackpercent.md) + + + + +Calculate hack percent for one thread. (Ex: 0.25 would steal 25% of the server's current value.) + + +
+ +[hackTime(server, player)](./bitburner.hackingformulas.hacktime.md) + + + + +Calculate hack time. + + +
+ +[weakenTime(server, player)](./bitburner.hackingformulas.weakentime.md) + + + + +Calculate weaken time. + + +
diff --git a/markdown/bitburner.hackingformulas.weakentime.md b/markdown/bitburner.hackingformulas.weakentime.md index dc203334a..43eb4f777 100644 --- a/markdown/bitburner.hackingformulas.weakentime.md +++ b/markdown/bitburner.hackingformulas.weakentime.md @@ -14,10 +14,55 @@ weakenTime(server: Server, player: Person): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| server | [Server](./bitburner.server.md) | Server info, typically from [getServer](./bitburner.ns.getserver.md) | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +server + + + + +[Server](./bitburner.server.md) + + + + +Server info, typically from [getServer](./bitburner.ns.getserver.md) + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
**Returns:** diff --git a/markdown/bitburner.hackingmultipliers.md b/markdown/bitburner.hackingmultipliers.md index 52041b712..a60eb5e13 100644 --- a/markdown/bitburner.hackingmultipliers.md +++ b/markdown/bitburner.hackingmultipliers.md @@ -14,10 +14,102 @@ interface HackingMultipliers ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [chance](./bitburner.hackingmultipliers.chance.md) | | number | Player's hacking chance multiplier. | -| [growth](./bitburner.hackingmultipliers.growth.md) | | number | Player's hacking growth multiplier | -| [money](./bitburner.hackingmultipliers.money.md) | | number | Player's hacking money stolen multiplier. | -| [speed](./bitburner.hackingmultipliers.speed.md) | | number | Player's hacking speed multiplier. | + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[chance](./bitburner.hackingmultipliers.chance.md) + + + + + + + +number + + + + +Player's hacking chance multiplier. + + +
+ +[growth](./bitburner.hackingmultipliers.growth.md) + + + + + + + +number + + + + +Player's hacking growth multiplier + + +
+ +[money](./bitburner.hackingmultipliers.money.md) + + + + + + + +number + + + + +Player's hacking money stolen multiplier. + + +
+ +[speed](./bitburner.hackingmultipliers.speed.md) + + + + + + + +number + + + + +Player's hacking speed multiplier. + + +
diff --git a/markdown/bitburner.hacknet.getcacheupgradecost.md b/markdown/bitburner.hacknet.getcacheupgradecost.md index caf02f22c..87d1302d1 100644 --- a/markdown/bitburner.hacknet.getcacheupgradecost.md +++ b/markdown/bitburner.hacknet.getcacheupgradecost.md @@ -14,10 +14,55 @@ getCacheUpgradeCost(index: number, n?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node. | -| n | number | _(Optional)_ Number of times to upgrade cache. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node. + + +
+ +n + + + + +number + + + + +_(Optional)_ Number of times to upgrade cache. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.getcoreupgradecost.md b/markdown/bitburner.hacknet.getcoreupgradecost.md index a75decc97..d3c030ed4 100644 --- a/markdown/bitburner.hacknet.getcoreupgradecost.md +++ b/markdown/bitburner.hacknet.getcoreupgradecost.md @@ -14,10 +14,55 @@ getCoreUpgradeCost(index: number, n?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node. | -| n | number | _(Optional)_ Number of times to upgrade cores. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node. + + +
+ +n + + + + +number + + + + +_(Optional)_ Number of times to upgrade cores. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.gethashupgradelevel.md b/markdown/bitburner.hacknet.gethashupgradelevel.md index 9ce756f93..2f6cfacec 100644 --- a/markdown/bitburner.hacknet.gethashupgradelevel.md +++ b/markdown/bitburner.hacknet.gethashupgradelevel.md @@ -14,9 +14,37 @@ getHashUpgradeLevel(upgName: HacknetServerHashUpgrade): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgName | [HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgName + + + + +[HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.getlevelupgradecost.md b/markdown/bitburner.hacknet.getlevelupgradecost.md index 78277cf5c..b9cd188d1 100644 --- a/markdown/bitburner.hacknet.getlevelupgradecost.md +++ b/markdown/bitburner.hacknet.getlevelupgradecost.md @@ -14,10 +14,55 @@ getLevelUpgradeCost(index: number, n?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node. | -| n | number | _(Optional)_ Number of levels to upgrade. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node. + + +
+ +n + + + + +number + + + + +_(Optional)_ Number of levels to upgrade. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.getnodestats.md b/markdown/bitburner.hacknet.getnodestats.md index d804503b2..a6688c8a7 100644 --- a/markdown/bitburner.hacknet.getnodestats.md +++ b/markdown/bitburner.hacknet.getnodestats.md @@ -14,9 +14,39 @@ getNodeStats(index: number): NodeStats; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.getramupgradecost.md b/markdown/bitburner.hacknet.getramupgradecost.md index 5b2523b0d..4e1a45b5b 100644 --- a/markdown/bitburner.hacknet.getramupgradecost.md +++ b/markdown/bitburner.hacknet.getramupgradecost.md @@ -14,10 +14,55 @@ getRamUpgradeCost(index: number, n?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node. | -| n | number | _(Optional)_ Number of times to upgrade RAM. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node. + + +
+ +n + + + + +number + + + + +_(Optional)_ Number of times to upgrade RAM. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.hashcost.md b/markdown/bitburner.hacknet.hashcost.md index 118c28221..7965739a0 100644 --- a/markdown/bitburner.hacknet.hashcost.md +++ b/markdown/bitburner.hacknet.hashcost.md @@ -14,10 +14,55 @@ hashCost(upgName: HacknetServerHashUpgrade, count?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgName | [HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) | Name of the upgrade using hash of Hacknet Server. | -| count | number | _(Optional)_ Number of upgrades to buy at once. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgName + + + + +[HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) + + + + +Name of the upgrade using hash of Hacknet Server. + + +
+ +count + + + + +number + + + + +_(Optional)_ Number of upgrades to buy at once. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.md b/markdown/bitburner.hacknet.md index f51f7c904..11b0b42cb 100644 --- a/markdown/bitburner.hacknet.md +++ b/markdown/bitburner.hacknet.md @@ -18,27 +18,247 @@ Not all these functions are immediately available. ## Methods -| Method | Description | -| --- | --- | -| [getCacheUpgradeCost(index, n)](./bitburner.hacknet.getcacheupgradecost.md) | Calculate the cost of upgrading hacknet node cache. | -| [getCoreUpgradeCost(index, n)](./bitburner.hacknet.getcoreupgradecost.md) | Calculate the cost of upgrading hacknet node cores. | -| [getHashUpgradeLevel(upgName)](./bitburner.hacknet.gethashupgradelevel.md) | Get the level of a hash upgrade. | -| [getHashUpgrades()](./bitburner.hacknet.gethashupgrades.md) | Get the list of hash upgrades | -| [getLevelUpgradeCost(index, n)](./bitburner.hacknet.getlevelupgradecost.md) | Calculate the cost of upgrading hacknet node levels. | -| [getNodeStats(index)](./bitburner.hacknet.getnodestats.md) | Get the stats of a hacknet node. | -| [getPurchaseNodeCost()](./bitburner.hacknet.getpurchasenodecost.md) | Get the price of the next hacknet node. | -| [getRamUpgradeCost(index, n)](./bitburner.hacknet.getramupgradecost.md) | Calculate the cost of upgrading hacknet node RAM. | -| [getStudyMult()](./bitburner.hacknet.getstudymult.md) | Get the multiplier to study. | -| [getTrainingMult()](./bitburner.hacknet.gettrainingmult.md) | Get the multiplier to training. | -| [hashCapacity()](./bitburner.hacknet.hashcapacity.md) | Get the maximum number of hashes you can store. | -| [hashCost(upgName, count)](./bitburner.hacknet.hashcost.md) | Get the cost of a hash upgrade. | -| [maxNumNodes()](./bitburner.hacknet.maxnumnodes.md) | Get the maximum number of hacknet nodes. | -| [numHashes()](./bitburner.hacknet.numhashes.md) | Get the total number of hashes stored. | -| [numNodes()](./bitburner.hacknet.numnodes.md) | Get the number of hacknet nodes you own. | -| [purchaseNode()](./bitburner.hacknet.purchasenode.md) | Purchase a new hacknet node. | -| [spendHashes(upgName, upgTarget, count)](./bitburner.hacknet.spendhashes.md) | Purchase a hash upgrade. | -| [upgradeCache(index, n)](./bitburner.hacknet.upgradecache.md) | Upgrade the cache of a hacknet node. | -| [upgradeCore(index, n)](./bitburner.hacknet.upgradecore.md) | Upgrade the core of a hacknet node. | -| [upgradeLevel(index, n)](./bitburner.hacknet.upgradelevel.md) | Upgrade the level of a hacknet node. | -| [upgradeRam(index, n)](./bitburner.hacknet.upgraderam.md) | Upgrade the RAM of a hacknet node. | + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[getCacheUpgradeCost(index, n)](./bitburner.hacknet.getcacheupgradecost.md) + + + + +Calculate the cost of upgrading hacknet node cache. + + +
+ +[getCoreUpgradeCost(index, n)](./bitburner.hacknet.getcoreupgradecost.md) + + + + +Calculate the cost of upgrading hacknet node cores. + + +
+ +[getHashUpgradeLevel(upgName)](./bitburner.hacknet.gethashupgradelevel.md) + + + + +Get the level of a hash upgrade. + + +
+ +[getHashUpgrades()](./bitburner.hacknet.gethashupgrades.md) + + + + +Get the list of hash upgrades + + +
+ +[getLevelUpgradeCost(index, n)](./bitburner.hacknet.getlevelupgradecost.md) + + + + +Calculate the cost of upgrading hacknet node levels. + + +
+ +[getNodeStats(index)](./bitburner.hacknet.getnodestats.md) + + + + +Get the stats of a hacknet node. + + +
+ +[getPurchaseNodeCost()](./bitburner.hacknet.getpurchasenodecost.md) + + + + +Get the price of the next hacknet node. + + +
+ +[getRamUpgradeCost(index, n)](./bitburner.hacknet.getramupgradecost.md) + + + + +Calculate the cost of upgrading hacknet node RAM. + + +
+ +[getStudyMult()](./bitburner.hacknet.getstudymult.md) + + + + +Get the multiplier to study. + + +
+ +[getTrainingMult()](./bitburner.hacknet.gettrainingmult.md) + + + + +Get the multiplier to training. + + +
+ +[hashCapacity()](./bitburner.hacknet.hashcapacity.md) + + + + +Get the maximum number of hashes you can store. + + +
+ +[hashCost(upgName, count)](./bitburner.hacknet.hashcost.md) + + + + +Get the cost of a hash upgrade. + + +
+ +[maxNumNodes()](./bitburner.hacknet.maxnumnodes.md) + + + + +Get the maximum number of hacknet nodes. + + +
+ +[numHashes()](./bitburner.hacknet.numhashes.md) + + + + +Get the total number of hashes stored. + + +
+ +[numNodes()](./bitburner.hacknet.numnodes.md) + + + + +Get the number of hacknet nodes you own. + + +
+ +[purchaseNode()](./bitburner.hacknet.purchasenode.md) + + + + +Purchase a new hacknet node. + + +
+ +[spendHashes(upgName, upgTarget, count)](./bitburner.hacknet.spendhashes.md) + + + + +Purchase a hash upgrade. + + +
+ +[upgradeCache(index, n)](./bitburner.hacknet.upgradecache.md) + + + + +Upgrade the cache of a hacknet node. + + +
+ +[upgradeCore(index, n)](./bitburner.hacknet.upgradecore.md) + + + + +Upgrade the core of a hacknet node. + + +
+ +[upgradeLevel(index, n)](./bitburner.hacknet.upgradelevel.md) + + + + +Upgrade the level of a hacknet node. + + +
+ +[upgradeRam(index, n)](./bitburner.hacknet.upgraderam.md) + + + + +Upgrade the RAM of a hacknet node. + + +
diff --git a/markdown/bitburner.hacknet.spendhashes.md b/markdown/bitburner.hacknet.spendhashes.md index 029b9aff6..748d727b0 100644 --- a/markdown/bitburner.hacknet.spendhashes.md +++ b/markdown/bitburner.hacknet.spendhashes.md @@ -14,11 +14,71 @@ spendHashes(upgName: HacknetServerHashUpgrade, upgTarget?: string, count?: numbe ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgName | [HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) | Name of the upgrade using hash of Hacknet Server. | -| upgTarget | string | _(Optional)_ Object to which upgrade applies. Required for certain upgrades. | -| count | number | _(Optional)_ Number of upgrades to buy at once. Must be a non-negative integer. Defaults to 1 if not specified. For compatibility reasons, upgTarget must be specified, even if it is not used, in order to specify count. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgName + + + + +[HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) + + + + +Name of the upgrade using hash of Hacknet Server. + + +
+ +upgTarget + + + + +string + + + + +_(Optional)_ Object to which upgrade applies. Required for certain upgrades. + + +
+ +count + + + + +number + + + + +_(Optional)_ Number of upgrades to buy at once. Must be a non-negative integer. Defaults to 1 if not specified. For compatibility reasons, upgTarget must be specified, even if it is not used, in order to specify count. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.upgradecache.md b/markdown/bitburner.hacknet.upgradecache.md index d5eab5ef6..8753b50e0 100644 --- a/markdown/bitburner.hacknet.upgradecache.md +++ b/markdown/bitburner.hacknet.upgradecache.md @@ -14,10 +14,55 @@ upgradeCache(index: number, n?: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node. | -| n | number | _(Optional)_ Number of cache levels to purchase. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node. + + +
+ +n + + + + +number + + + + +_(Optional)_ Number of cache levels to purchase. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.upgradecore.md b/markdown/bitburner.hacknet.upgradecore.md index a98650dff..2681e5b2e 100644 --- a/markdown/bitburner.hacknet.upgradecore.md +++ b/markdown/bitburner.hacknet.upgradecore.md @@ -14,10 +14,55 @@ upgradeCore(index: number, n?: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node. | -| n | number | _(Optional)_ Number of cores to purchase. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node. + + +
+ +n + + + + +number + + + + +_(Optional)_ Number of cores to purchase. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.upgradelevel.md b/markdown/bitburner.hacknet.upgradelevel.md index ff39226e3..1a31e85f2 100644 --- a/markdown/bitburner.hacknet.upgradelevel.md +++ b/markdown/bitburner.hacknet.upgradelevel.md @@ -14,10 +14,55 @@ upgradeLevel(index: number, n?: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node. | -| n | number | _(Optional)_ Number of levels to purchase. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node. + + +
+ +n + + + + +number + + + + +_(Optional)_ Number of levels to purchase. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknet.upgraderam.md b/markdown/bitburner.hacknet.upgraderam.md index a2fd4cd0d..1f8c0b0b1 100644 --- a/markdown/bitburner.hacknet.upgraderam.md +++ b/markdown/bitburner.hacknet.upgraderam.md @@ -14,10 +14,55 @@ upgradeRam(index: number, n?: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| index | number | Index/Identifier of Hacknet Node. | -| n | number | _(Optional)_ Number of times to upgrade RAM. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +index + + + + +number + + + + +Index/Identifier of Hacknet Node. + + +
+ +n + + + + +number + + + + +_(Optional)_ Number of times to upgrade RAM. Must be positive. Will be rounded to the nearest integer. Defaults to 1 if not specified. + + +
**Returns:** diff --git a/markdown/bitburner.hacknetcoresrequirement.md b/markdown/bitburner.hacknetcoresrequirement.md index 5a77c4b2e..1cc9fae77 100644 --- a/markdown/bitburner.hacknetcoresrequirement.md +++ b/markdown/bitburner.hacknetcoresrequirement.md @@ -14,8 +14,60 @@ interface HacknetCoresRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [hacknetCores](./bitburner.hacknetcoresrequirement.hacknetcores.md) | | number | | -| [type](./bitburner.hacknetcoresrequirement.type.md) | | "hacknetCores" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[hacknetCores](./bitburner.hacknetcoresrequirement.hacknetcores.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.hacknetcoresrequirement.type.md) + + + + + + + +"hacknetCores" + + + + + +
diff --git a/markdown/bitburner.hacknetlevelsrequirement.md b/markdown/bitburner.hacknetlevelsrequirement.md index 181897204..d846ba2c6 100644 --- a/markdown/bitburner.hacknetlevelsrequirement.md +++ b/markdown/bitburner.hacknetlevelsrequirement.md @@ -14,8 +14,60 @@ interface HacknetLevelsRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [hacknetLevels](./bitburner.hacknetlevelsrequirement.hacknetlevels.md) | | number | | -| [type](./bitburner.hacknetlevelsrequirement.type.md) | | "hacknetLevels" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[hacknetLevels](./bitburner.hacknetlevelsrequirement.hacknetlevels.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.hacknetlevelsrequirement.type.md) + + + + + + + +"hacknetLevels" + + + + + +
diff --git a/markdown/bitburner.hacknetmultipliers.md b/markdown/bitburner.hacknetmultipliers.md index e957cb8b9..15e89acdd 100644 --- a/markdown/bitburner.hacknetmultipliers.md +++ b/markdown/bitburner.hacknetmultipliers.md @@ -14,11 +14,121 @@ interface HacknetMultipliers ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [coreCost](./bitburner.hacknetmultipliers.corecost.md) | | number | Player's hacknet core cost multiplier | -| [levelCost](./bitburner.hacknetmultipliers.levelcost.md) | | number | Player's hacknet level cost multiplier | -| [production](./bitburner.hacknetmultipliers.production.md) | | number | Player's hacknet production multiplier | -| [purchaseCost](./bitburner.hacknetmultipliers.purchasecost.md) | | number | Player's hacknet purchase cost multiplier | -| [ramCost](./bitburner.hacknetmultipliers.ramcost.md) | | number | Player's hacknet ram cost multiplier | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[coreCost](./bitburner.hacknetmultipliers.corecost.md) + + + + + + + +number + + + + +Player's hacknet core cost multiplier + + +
+ +[levelCost](./bitburner.hacknetmultipliers.levelcost.md) + + + + + + + +number + + + + +Player's hacknet level cost multiplier + + +
+ +[production](./bitburner.hacknetmultipliers.production.md) + + + + + + + +number + + + + +Player's hacknet production multiplier + + +
+ +[purchaseCost](./bitburner.hacknetmultipliers.purchasecost.md) + + + + + + + +number + + + + +Player's hacknet purchase cost multiplier + + +
+ +[ramCost](./bitburner.hacknetmultipliers.ramcost.md) + + + + + + + +number + + + + +Player's hacknet ram cost multiplier + + +
diff --git a/markdown/bitburner.hacknetnodeconstants.md b/markdown/bitburner.hacknetnodeconstants.md index 99ea44864..6624dcc53 100644 --- a/markdown/bitburner.hacknetnodeconstants.md +++ b/markdown/bitburner.hacknetnodeconstants.md @@ -14,18 +14,254 @@ interface HacknetNodeConstants ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [BaseCost](./bitburner.hacknetnodeconstants.basecost.md) | | number | Base cost for a new node | -| [CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md) | | number | Base cost to increase cores | -| [LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md) | | number | Base cost per level | -| [MaxCores](./bitburner.hacknetnodeconstants.maxcores.md) | | number | Max number of cores | -| [MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md) | | number | Max node level | -| [MaxRam](./bitburner.hacknetnodeconstants.maxram.md) | | number | Max amount of RAM in GB | -| [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) | | number | Amount of money gained per level | -| [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) | | number | Multiplier to purchase new node | -| [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) | | number | Base cost to increase RAM | -| [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) | | number | Multiplier to increase cores | -| [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) | | number | Multiplier to increase node level | -| [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) | | number | Multiplier to increase RAM | + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[BaseCost](./bitburner.hacknetnodeconstants.basecost.md) + + + + + + + +number + + + + +Base cost for a new node + + +
+ +[CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md) + + + + + + + +number + + + + +Base cost to increase cores + + +
+ +[LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md) + + + + + + + +number + + + + +Base cost per level + + +
+ +[MaxCores](./bitburner.hacknetnodeconstants.maxcores.md) + + + + + + + +number + + + + +Max number of cores + + +
+ +[MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md) + + + + + + + +number + + + + +Max node level + + +
+ +[MaxRam](./bitburner.hacknetnodeconstants.maxram.md) + + + + + + + +number + + + + +Max amount of RAM in GB + + +
+ +[MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) + + + + + + + +number + + + + +Amount of money gained per level + + +
+ +[PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) + + + + + + + +number + + + + +Multiplier to purchase new node + + +
+ +[RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) + + + + + + + +number + + + + +Base cost to increase RAM + + +
+ +[UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) + + + + + + + +number + + + + +Multiplier to increase cores + + +
+ +[UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) + + + + + + + +number + + + + +Multiplier to increase node level + + +
+ +[UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) + + + + + + + +number + + + + +Multiplier to increase RAM + + +
diff --git a/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md b/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md index bcc3ae9cd..6ef9328db 100644 --- a/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md +++ b/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md @@ -14,11 +14,71 @@ coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): n ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| startingCore | number | starting cores | -| extraCores | number | _(Optional)_ amount of cores to purchase (defaults to 1) | -| costMult | number | _(Optional)_ player cost reduction (default to 1) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +startingCore + + + + +number + + + + +starting cores + + +
+ +extraCores + + + + +number + + + + +_(Optional)_ amount of cores to purchase (defaults to 1) + + +
+ +costMult + + + + +number + + + + +_(Optional)_ player cost reduction (default to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md b/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md index afc300d85..60d88ad22 100644 --- a/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md +++ b/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md @@ -14,10 +14,55 @@ hacknetNodeCost(n: number, mult: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| n | number | number of the hacknet node | -| mult | number | player cost reduction (defaults to 1) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +n + + + + +number + + + + +number of the hacknet node + + +
+ +mult + + + + +number + + + + +player cost reduction (defaults to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md b/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md index 0852a0c40..5d4756fe0 100644 --- a/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md +++ b/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md @@ -14,11 +14,71 @@ levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number) ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| startingLevel | number | starting level | -| extraLevels | number | _(Optional)_ amount of level to purchase (defaults to 1) | -| costMult | number | _(Optional)_ player cost reduction (default to 1) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +startingLevel + + + + +number + + + + +starting level + + +
+ +extraLevels + + + + +number + + + + +_(Optional)_ amount of level to purchase (defaults to 1) + + +
+ +costMult + + + + +number + + + + +_(Optional)_ player cost reduction (default to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetnodesformulas.md b/markdown/bitburner.hacknetnodesformulas.md index 5c78af790..55c7329d7 100644 --- a/markdown/bitburner.hacknetnodesformulas.md +++ b/markdown/bitburner.hacknetnodesformulas.md @@ -14,12 +14,82 @@ interface HacknetNodesFormulas ## Methods -| Method | Description | -| --- | --- | -| [constants()](./bitburner.hacknetnodesformulas.constants.md) | All constants used by the game. | -| [coreUpgradeCost(startingCore, extraCores, costMult)](./bitburner.hacknetnodesformulas.coreupgradecost.md) | Calculate cost of upgrading hacknet node cores. | -| [hacknetNodeCost(n, mult)](./bitburner.hacknetnodesformulas.hacknetnodecost.md) | Calculate the cost of a hacknet node. | -| [levelUpgradeCost(startingLevel, extraLevels, costMult)](./bitburner.hacknetnodesformulas.levelupgradecost.md) | Calculate cost of upgrading hacknet node level. | -| [moneyGainRate(level, ram, cores, mult)](./bitburner.hacknetnodesformulas.moneygainrate.md) | Calculate money gain rate. | -| [ramUpgradeCost(startingRam, extraLevels, costMult)](./bitburner.hacknetnodesformulas.ramupgradecost.md) | Calculate cost of upgrading hacknet node ram. | + + + + + + + +
+ +Method + + + + +Description + + +
+ +[constants()](./bitburner.hacknetnodesformulas.constants.md) + + + + +All constants used by the game. + + +
+ +[coreUpgradeCost(startingCore, extraCores, costMult)](./bitburner.hacknetnodesformulas.coreupgradecost.md) + + + + +Calculate cost of upgrading hacknet node cores. + + +
+ +[hacknetNodeCost(n, mult)](./bitburner.hacknetnodesformulas.hacknetnodecost.md) + + + + +Calculate the cost of a hacknet node. + + +
+ +[levelUpgradeCost(startingLevel, extraLevels, costMult)](./bitburner.hacknetnodesformulas.levelupgradecost.md) + + + + +Calculate cost of upgrading hacknet node level. + + +
+ +[moneyGainRate(level, ram, cores, mult)](./bitburner.hacknetnodesformulas.moneygainrate.md) + + + + +Calculate money gain rate. + + +
+ +[ramUpgradeCost(startingRam, extraLevels, costMult)](./bitburner.hacknetnodesformulas.ramupgradecost.md) + + + + +Calculate cost of upgrading hacknet node ram. + + +
diff --git a/markdown/bitburner.hacknetnodesformulas.moneygainrate.md b/markdown/bitburner.hacknetnodesformulas.moneygainrate.md index 60cc16ccc..f28bd3350 100644 --- a/markdown/bitburner.hacknetnodesformulas.moneygainrate.md +++ b/markdown/bitburner.hacknetnodesformulas.moneygainrate.md @@ -14,12 +14,87 @@ moneyGainRate(level: number, ram: number, cores: number, mult?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| level | number | level of the node. | -| ram | number | ram of the node. | -| cores | number | cores of the node. | -| mult | number | _(Optional)_ player production mult (default to 1) | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +level + + + + +number + + + + +level of the node. + + +
+ +ram + + + + +number + + + + +ram of the node. + + +
+ +cores + + + + +number + + + + +cores of the node. + + +
+ +mult + + + + +number + + + + +_(Optional)_ player production mult (default to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md b/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md index e343061aa..869cf7c5c 100644 --- a/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md +++ b/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md @@ -14,11 +14,71 @@ ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): nu ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| startingRam | number | starting ram | -| extraLevels | number | _(Optional)_ amount of level of ram to purchase (defaults to 1) | -| costMult | number | _(Optional)_ player cost reduction (default to 1) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +startingRam + + + + +number + + + + +starting ram + + +
+ +extraLevels + + + + +number + + + + +_(Optional)_ amount of level of ram to purchase (defaults to 1) + + +
+ +costMult + + + + +number + + + + +_(Optional)_ player cost reduction (default to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetramrequirement.md b/markdown/bitburner.hacknetramrequirement.md index c03e53acb..5409a2ab2 100644 --- a/markdown/bitburner.hacknetramrequirement.md +++ b/markdown/bitburner.hacknetramrequirement.md @@ -14,8 +14,60 @@ interface HacknetRAMRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [hacknetRAM](./bitburner.hacknetramrequirement.hacknetram.md) | | number | | -| [type](./bitburner.hacknetramrequirement.type.md) | | "hacknetRAM" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[hacknetRAM](./bitburner.hacknetramrequirement.hacknetram.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.hacknetramrequirement.type.md) + + + + + + + +"hacknetRAM" + + + + + +
diff --git a/markdown/bitburner.hacknetserverconstants.md b/markdown/bitburner.hacknetserverconstants.md index 4c1e87013..45e40e4e7 100644 --- a/markdown/bitburner.hacknetserverconstants.md +++ b/markdown/bitburner.hacknetserverconstants.md @@ -14,21 +14,311 @@ interface HacknetServerConstants ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [BaseCost](./bitburner.hacknetserverconstants.basecost.md) | | number | Base cost for a new server | -| [CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md) | | number | Base cost to upgrade cache | -| [CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md) | | number | Base cost to increase cores | -| [HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md) | | number | Number of hashes calculated per level | -| [MaxCache](./bitburner.hacknetserverconstants.maxcache.md) | | number | Max cache size | -| [MaxCores](./bitburner.hacknetserverconstants.maxcores.md) | | number | Max number of cores | -| [MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md) | | number | Max level for a server | -| [MaxRam](./bitburner.hacknetserverconstants.maxram.md) | | number | Max amount of RAM in GB | -| [MaxServers](./bitburner.hacknetserverconstants.maxservers.md) | | number | Max number of servers | -| [PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md) | | number | Multiplier to purchase a new server | -| [RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md) | | number | Base cost to increase RAM | -| [UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md) | | number | Multiplier to upgrade cache | -| [UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md) | | number | Multiplier to increase cores | -| [UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md) | | number | Multiplier to increase server level | -| [UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md) | | number | Multiplier to increase RAM | + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[BaseCost](./bitburner.hacknetserverconstants.basecost.md) + + + + + + + +number + + + + +Base cost for a new server + + +
+ +[CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md) + + + + + + + +number + + + + +Base cost to upgrade cache + + +
+ +[CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md) + + + + + + + +number + + + + +Base cost to increase cores + + +
+ +[HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md) + + + + + + + +number + + + + +Number of hashes calculated per level + + +
+ +[MaxCache](./bitburner.hacknetserverconstants.maxcache.md) + + + + + + + +number + + + + +Max cache size + + +
+ +[MaxCores](./bitburner.hacknetserverconstants.maxcores.md) + + + + + + + +number + + + + +Max number of cores + + +
+ +[MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md) + + + + + + + +number + + + + +Max level for a server + + +
+ +[MaxRam](./bitburner.hacknetserverconstants.maxram.md) + + + + + + + +number + + + + +Max amount of RAM in GB + + +
+ +[MaxServers](./bitburner.hacknetserverconstants.maxservers.md) + + + + + + + +number + + + + +Max number of servers + + +
+ +[PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md) + + + + + + + +number + + + + +Multiplier to purchase a new server + + +
+ +[RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md) + + + + + + + +number + + + + +Base cost to increase RAM + + +
+ +[UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md) + + + + + + + +number + + + + +Multiplier to upgrade cache + + +
+ +[UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md) + + + + + + + +number + + + + +Multiplier to increase cores + + +
+ +[UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md) + + + + + + + +number + + + + +Multiplier to increase server level + + +
+ +[UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md) + + + + + + + +number + + + + +Multiplier to increase RAM + + +
diff --git a/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md b/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md index 096d32142..53726519b 100644 --- a/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md @@ -14,10 +14,55 @@ cacheUpgradeCost(startingCache: number, extraCache?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| startingCache | number | starting cache level | -| extraCache | number | _(Optional)_ amount of levels of cache to purchase (defaults to 1) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +startingCache + + + + +number + + + + +starting cache level + + +
+ +extraCache + + + + +number + + + + +_(Optional)_ amount of levels of cache to purchase (defaults to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetserversformulas.coreupgradecost.md b/markdown/bitburner.hacknetserversformulas.coreupgradecost.md index 66b32bb52..69d9619ae 100644 --- a/markdown/bitburner.hacknetserversformulas.coreupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.coreupgradecost.md @@ -14,11 +14,71 @@ coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): n ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| startingCore | number | starting cores | -| extraCores | number | _(Optional)_ amount of cores to purchase (defaults to 1) | -| costMult | number | _(Optional)_ player cost reduction (default to 1) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +startingCore + + + + +number + + + + +starting cores + + +
+ +extraCores + + + + +number + + + + +_(Optional)_ amount of cores to purchase (defaults to 1) + + +
+ +costMult + + + + +number + + + + +_(Optional)_ player cost reduction (default to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetserversformulas.hacknetservercost.md b/markdown/bitburner.hacknetserversformulas.hacknetservercost.md index cd4d436f4..1927c1028 100644 --- a/markdown/bitburner.hacknetserversformulas.hacknetservercost.md +++ b/markdown/bitburner.hacknetserversformulas.hacknetservercost.md @@ -14,10 +14,55 @@ hacknetServerCost(n: number, mult?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| n | number | number of the hacknet server | -| mult | number | _(Optional)_ player cost reduction (defaults to 1) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +n + + + + +number + + + + +number of the hacknet server + + +
+ +mult + + + + +number + + + + +_(Optional)_ player cost reduction (defaults to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetserversformulas.hashgainrate.md b/markdown/bitburner.hacknetserversformulas.hashgainrate.md index 5ea1e8c7c..cd9681031 100644 --- a/markdown/bitburner.hacknetserversformulas.hashgainrate.md +++ b/markdown/bitburner.hacknetserversformulas.hashgainrate.md @@ -14,13 +14,103 @@ hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| level | number | level of the server. | -| ramUsed | number | ramUsed of the server. | -| maxRam | number | maxRam of the server. | -| cores | number | cores of the server. | -| mult | number | _(Optional)_ player production mult (default to 1) | + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +level + + + + +number + + + + +level of the server. + + +
+ +ramUsed + + + + +number + + + + +ramUsed of the server. + + +
+ +maxRam + + + + +number + + + + +maxRam of the server. + + +
+ +cores + + + + +number + + + + +cores of the server. + + +
+ +mult + + + + +number + + + + +_(Optional)_ player production mult (default to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetserversformulas.hashupgradecost.md b/markdown/bitburner.hacknetserversformulas.hashupgradecost.md index cf8d1b098..b774f116b 100644 --- a/markdown/bitburner.hacknetserversformulas.hashupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.hashupgradecost.md @@ -14,10 +14,55 @@ hashUpgradeCost(upgName: HacknetServerHashUpgrade, level: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| upgName | [HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) | name of the upgrade | -| level | number | level of the upgrade | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +upgName + + + + +[HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) + + + + +name of the upgrade + + +
+ +level + + + + +number + + + + +level of the upgrade + + +
**Returns:** diff --git a/markdown/bitburner.hacknetserversformulas.levelupgradecost.md b/markdown/bitburner.hacknetserversformulas.levelupgradecost.md index d679643c4..f6eb6cd96 100644 --- a/markdown/bitburner.hacknetserversformulas.levelupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.levelupgradecost.md @@ -14,11 +14,71 @@ levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number) ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| startingLevel | number | starting level | -| extraLevels | number | _(Optional)_ amount of level to purchase (defaults to 1) | -| costMult | number | _(Optional)_ player cost reduction (default to 1) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +startingLevel + + + + +number + + + + +starting level + + +
+ +extraLevels + + + + +number + + + + +_(Optional)_ amount of level to purchase (defaults to 1) + + +
+ +costMult + + + + +number + + + + +_(Optional)_ player cost reduction (default to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hacknetserversformulas.md b/markdown/bitburner.hacknetserversformulas.md index 3ccee0895..0122ec70c 100644 --- a/markdown/bitburner.hacknetserversformulas.md +++ b/markdown/bitburner.hacknetserversformulas.md @@ -14,14 +14,104 @@ interface HacknetServersFormulas ## Methods -| Method | Description | -| --- | --- | -| [cacheUpgradeCost(startingCache, extraCache)](./bitburner.hacknetserversformulas.cacheupgradecost.md) | Calculate cost of upgrading hacknet server cache. | -| [constants()](./bitburner.hacknetserversformulas.constants.md) | All constants used by the game. | -| [coreUpgradeCost(startingCore, extraCores, costMult)](./bitburner.hacknetserversformulas.coreupgradecost.md) | Calculate cost of upgrading hacknet server cores. | -| [hacknetServerCost(n, mult)](./bitburner.hacknetserversformulas.hacknetservercost.md) | Calculate the cost of a hacknet server. | -| [hashGainRate(level, ramUsed, maxRam, cores, mult)](./bitburner.hacknetserversformulas.hashgainrate.md) | Calculate hash gain rate. | -| [hashUpgradeCost(upgName, level)](./bitburner.hacknetserversformulas.hashupgradecost.md) | Calculate hash cost of an upgrade. | -| [levelUpgradeCost(startingLevel, extraLevels, costMult)](./bitburner.hacknetserversformulas.levelupgradecost.md) | Calculate cost of upgrading hacknet server level. | -| [ramUpgradeCost(startingRam, extraLevels, costMult)](./bitburner.hacknetserversformulas.ramupgradecost.md) | Calculate cost of upgrading hacknet server ram. | + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[cacheUpgradeCost(startingCache, extraCache)](./bitburner.hacknetserversformulas.cacheupgradecost.md) + + + + +Calculate cost of upgrading hacknet server cache. + + +
+ +[constants()](./bitburner.hacknetserversformulas.constants.md) + + + + +All constants used by the game. + + +
+ +[coreUpgradeCost(startingCore, extraCores, costMult)](./bitburner.hacknetserversformulas.coreupgradecost.md) + + + + +Calculate cost of upgrading hacknet server cores. + + +
+ +[hacknetServerCost(n, mult)](./bitburner.hacknetserversformulas.hacknetservercost.md) + + + + +Calculate the cost of a hacknet server. + + +
+ +[hashGainRate(level, ramUsed, maxRam, cores, mult)](./bitburner.hacknetserversformulas.hashgainrate.md) + + + + +Calculate hash gain rate. + + +
+ +[hashUpgradeCost(upgName, level)](./bitburner.hacknetserversformulas.hashupgradecost.md) + + + + +Calculate hash cost of an upgrade. + + +
+ +[levelUpgradeCost(startingLevel, extraLevels, costMult)](./bitburner.hacknetserversformulas.levelupgradecost.md) + + + + +Calculate cost of upgrading hacknet server level. + + +
+ +[ramUpgradeCost(startingRam, extraLevels, costMult)](./bitburner.hacknetserversformulas.ramupgradecost.md) + + + + +Calculate cost of upgrading hacknet server ram. + + +
diff --git a/markdown/bitburner.hacknetserversformulas.ramupgradecost.md b/markdown/bitburner.hacknetserversformulas.ramupgradecost.md index 70f688b8a..61e036fd4 100644 --- a/markdown/bitburner.hacknetserversformulas.ramupgradecost.md +++ b/markdown/bitburner.hacknetserversformulas.ramupgradecost.md @@ -14,11 +14,71 @@ ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): nu ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| startingRam | number | starting ram | -| extraLevels | number | _(Optional)_ amount of level of ram to purchase (defaults to 1) | -| costMult | number | _(Optional)_ player cost reduction (default to 1) | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +startingRam + + + + +number + + + + +starting ram + + +
+ +extraLevels + + + + +number + + + + +_(Optional)_ amount of level of ram to purchase (defaults to 1) + + +
+ +costMult + + + + +number + + + + +_(Optional)_ player cost reduction (default to 1) + + +
**Returns:** diff --git a/markdown/bitburner.hostreturnoptions.md b/markdown/bitburner.hostreturnoptions.md index 6e2ad08d2..757b73f5f 100644 --- a/markdown/bitburner.hostreturnoptions.md +++ b/markdown/bitburner.hostreturnoptions.md @@ -14,7 +14,45 @@ interface HostReturnOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [returnByIP?](./bitburner.hostreturnoptions.returnbyip.md) | | boolean | _(Optional)_ If set to true, returns IP addresses instead of hostnames. Defaults to false. | + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[returnByIP?](./bitburner.hostreturnoptions.returnbyip.md) + + + + + + + +boolean + + + + +_(Optional)_ If set to `true`, returns IP addresses instead of hostnames. Defaults to `false`. + + +
diff --git a/markdown/bitburner.hp.md b/markdown/bitburner.hp.md index 7fe3d2ce5..ddebf3b05 100644 --- a/markdown/bitburner.hp.md +++ b/markdown/bitburner.hp.md @@ -13,8 +13,60 @@ interface HP ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [current](./bitburner.hp.current.md) | | number | | -| [max](./bitburner.hp.max.md) | | number | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[current](./bitburner.hp.current.md) + + + + + + + +number + + + + + +
+ +[max](./bitburner.hp.max.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.ilocation.md b/markdown/bitburner.ilocation.md index adb667c36..3356b6511 100644 --- a/markdown/bitburner.ilocation.md +++ b/markdown/bitburner.ilocation.md @@ -13,8 +13,60 @@ interface ILocation ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [city](./bitburner.ilocation.city.md) | | [CityName](./bitburner.cityname.md) | | -| [name](./bitburner.ilocation.name.md) | | [LocationName](./bitburner.locationname.md) | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[city](./bitburner.ilocation.city.md) + + + + + + + +[CityName](./bitburner.cityname.md) + + + + + +
+ +[name](./bitburner.ilocation.name.md) + + + + + + + +[LocationName](./bitburner.locationname.md) + + + + + +
diff --git a/markdown/bitburner.industrydata.md b/markdown/bitburner.industrydata.md index caa0ced08..7103000c7 100644 --- a/markdown/bitburner.industrydata.md +++ b/markdown/bitburner.industrydata.md @@ -14,13 +14,159 @@ interface IndustryData ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [cost](./bitburner.industrydata.cost.md) | | number | Cost to make a new division of this industry type | -| [makesMaterials](./bitburner.industrydata.makesmaterials.md) | | boolean | Whether the division makes materials | -| [makesProducts](./bitburner.industrydata.makesproducts.md) | | boolean | Whether the division makes products | -| [producedMaterials?](./bitburner.industrydata.producedmaterials.md) | | string\[\] | _(Optional)_ Materials produced | -| [productType?](./bitburner.industrydata.producttype.md) | | string | _(Optional)_ Product type | -| [requiredMaterials](./bitburner.industrydata.requiredmaterials.md) | | Record<string, number> | Materials required for production and their amounts | -| [type](./bitburner.industrydata.type.md) | | [CorpIndustryName](./bitburner.corpindustryname.md) | Industry type | + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[cost](./bitburner.industrydata.cost.md) + + + + + + + +number + + + + +Cost to make a new division of this industry type + + +
+ +[makesMaterials](./bitburner.industrydata.makesmaterials.md) + + + + + + + +boolean + + + + +Whether the division makes materials + + +
+ +[makesProducts](./bitburner.industrydata.makesproducts.md) + + + + + + + +boolean + + + + +Whether the division makes products + + +
+ +[producedMaterials?](./bitburner.industrydata.producedmaterials.md) + + + + + + + +string\[\] + + + + +_(Optional)_ Materials produced + + +
+ +[productType?](./bitburner.industrydata.producttype.md) + + + + + + + +string + + + + +_(Optional)_ Product type + + +
+ +[requiredMaterials](./bitburner.industrydata.requiredmaterials.md) + + + + + + + +Record<string, number> + + + + +Materials required for production and their amounts + + +
+ +[type](./bitburner.industrydata.type.md) + + + + + + + +[CorpIndustryName](./bitburner.corpindustryname.md) + + + + +Industry type + + +
diff --git a/markdown/bitburner.infiltration.getinfiltration.md b/markdown/bitburner.infiltration.getinfiltration.md index 04b00b03e..e3b5ba064 100644 --- a/markdown/bitburner.infiltration.getinfiltration.md +++ b/markdown/bitburner.infiltration.getinfiltration.md @@ -14,9 +14,37 @@ getInfiltration(location: LocationName): InfiltrationLocation; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| location | [LocationName](./bitburner.locationname.md) | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +location + + + + +[LocationName](./bitburner.locationname.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.infiltration.md b/markdown/bitburner.infiltration.md index 673bb335b..ebae6d06d 100644 --- a/markdown/bitburner.infiltration.md +++ b/markdown/bitburner.infiltration.md @@ -14,8 +14,38 @@ interface Infiltration ## Methods -| Method | Description | -| --- | --- | -| [getInfiltration(location)](./bitburner.infiltration.getinfiltration.md) | Get all infiltrations with difficulty, location and rewards. | -| [getPossibleLocations()](./bitburner.infiltration.getpossiblelocations.md) | Get all locations that can be infiltrated. | + + + +
+ +Method + + + + +Description + + +
+ +[getInfiltration(location)](./bitburner.infiltration.getinfiltration.md) + + + + +Get all infiltrations with difficulty, location and rewards. + + +
+ +[getPossibleLocations()](./bitburner.infiltration.getpossiblelocations.md) + + + + +Get all locations that can be infiltrated. + + +
diff --git a/markdown/bitburner.infiltrationlocation.md b/markdown/bitburner.infiltrationlocation.md index 750dd0907..eac33f8fe 100644 --- a/markdown/bitburner.infiltrationlocation.md +++ b/markdown/bitburner.infiltrationlocation.md @@ -13,11 +13,111 @@ interface InfiltrationLocation ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [difficulty](./bitburner.infiltrationlocation.difficulty.md) | | number | | -| [location](./bitburner.infiltrationlocation.location.md) | | [ILocation](./bitburner.ilocation.md) | | -| [maxClearanceLevel](./bitburner.infiltrationlocation.maxclearancelevel.md) | | number | | -| [reward](./bitburner.infiltrationlocation.reward.md) | | [InfiltrationReward](./bitburner.infiltrationreward.md) | | -| [startingSecurityLevel](./bitburner.infiltrationlocation.startingsecuritylevel.md) | | number | | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[difficulty](./bitburner.infiltrationlocation.difficulty.md) + + + + + + + +number + + + + + +
+ +[location](./bitburner.infiltrationlocation.location.md) + + + + + + + +[ILocation](./bitburner.ilocation.md) + + + + + +
+ +[maxClearanceLevel](./bitburner.infiltrationlocation.maxclearancelevel.md) + + + + + + + +number + + + + + +
+ +[reward](./bitburner.infiltrationlocation.reward.md) + + + + + + + +[InfiltrationReward](./bitburner.infiltrationreward.md) + + + + + +
+ +[startingSecurityLevel](./bitburner.infiltrationlocation.startingsecuritylevel.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.infiltrationreward.md b/markdown/bitburner.infiltrationreward.md index 0becc6d0d..51ebbda78 100644 --- a/markdown/bitburner.infiltrationreward.md +++ b/markdown/bitburner.infiltrationreward.md @@ -13,9 +13,77 @@ interface InfiltrationReward ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [sellCash](./bitburner.infiltrationreward.sellcash.md) | | number | | -| [SoARep](./bitburner.infiltrationreward.soarep.md) | | number | | -| [tradeRep](./bitburner.infiltrationreward.traderep.md) | | number | | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[sellCash](./bitburner.infiltrationreward.sellcash.md) + + + + + + + +number + + + + + +
+ +[SoARep](./bitburner.infiltrationreward.soarep.md) + + + + + + + +number + + + + + +
+ +[tradeRep](./bitburner.infiltrationreward.traderep.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.investmentoffer.md b/markdown/bitburner.investmentoffer.md index 3af82ad66..5ae1f65ce 100644 --- a/markdown/bitburner.investmentoffer.md +++ b/markdown/bitburner.investmentoffer.md @@ -14,9 +14,83 @@ interface InvestmentOffer ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [funds](./bitburner.investmentoffer.funds.md) | | number | Amount of funds you will get from this investment | -| [round](./bitburner.investmentoffer.round.md) | | number | Current round of funding (max 4) | -| [shares](./bitburner.investmentoffer.shares.md) | | number | Amount of share you will give in exchange for this investment | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[funds](./bitburner.investmentoffer.funds.md) + + + + + + + +number + + + + +Amount of funds you will get from this investment + + +
+ +[round](./bitburner.investmentoffer.round.md) + + + + + + + +number + + + + +Current round of funding (max 4) + + +
+ +[shares](./bitburner.investmentoffer.shares.md) + + + + + + + +number + + + + +Amount of share you will give in exchange for this investment + + +
diff --git a/markdown/bitburner.istylesettings.md b/markdown/bitburner.istylesettings.md index 2df3eff1a..dcc068506 100644 --- a/markdown/bitburner.istylesettings.md +++ b/markdown/bitburner.istylesettings.md @@ -14,10 +14,94 @@ interface IStyleSettings ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [fontFamily](./bitburner.istylesettings.fontfamily.md) | | string | | -| [fontSize](./bitburner.istylesettings.fontsize.md) | | number | | -| [lineHeight](./bitburner.istylesettings.lineheight.md) | | number | | -| [tailFontSize](./bitburner.istylesettings.tailfontsize.md) | | number | | + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[fontFamily](./bitburner.istylesettings.fontfamily.md) + + + + + + + +string + + + + + +
+ +[fontSize](./bitburner.istylesettings.fontsize.md) + + + + + + + +number + + + + + +
+ +[lineHeight](./bitburner.istylesettings.lineheight.md) + + + + + + + +number + + + + + +
+ +[tailFontSize](./bitburner.istylesettings.tailfontsize.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.jobtitlerequirement.md b/markdown/bitburner.jobtitlerequirement.md index 35fd0cfab..93dddcfba 100644 --- a/markdown/bitburner.jobtitlerequirement.md +++ b/markdown/bitburner.jobtitlerequirement.md @@ -14,8 +14,60 @@ interface JobTitleRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [jobTitle](./bitburner.jobtitlerequirement.jobtitle.md) | | [JobName](./bitburner.jobname.md) | | -| [type](./bitburner.jobtitlerequirement.type.md) | | "jobTitle" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[jobTitle](./bitburner.jobtitlerequirement.jobtitle.md) + + + + + + + +[JobName](./bitburner.jobname.md) + + + + + +
+ +[type](./bitburner.jobtitlerequirement.type.md) + + + + + + + +"jobTitle" + + + + + +
diff --git a/markdown/bitburner.karmarequirement.md b/markdown/bitburner.karmarequirement.md index 3ba5bf6ad..2a0d23ae4 100644 --- a/markdown/bitburner.karmarequirement.md +++ b/markdown/bitburner.karmarequirement.md @@ -14,8 +14,60 @@ interface KarmaRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [karma](./bitburner.karmarequirement.karma.md) | | number | | -| [type](./bitburner.karmarequirement.type.md) | | "karma" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[karma](./bitburner.karmarequirement.karma.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.karmarequirement.type.md) + + + + + + + +"karma" + + + + + +
diff --git a/markdown/bitburner.locationrequirement.md b/markdown/bitburner.locationrequirement.md index 8d33ec88b..bcfa24314 100644 --- a/markdown/bitburner.locationrequirement.md +++ b/markdown/bitburner.locationrequirement.md @@ -14,8 +14,60 @@ interface LocationRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [location](./bitburner.locationrequirement.location.md) | | [LocationName](./bitburner.locationname.md) | | -| [type](./bitburner.locationrequirement.type.md) | | "location" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[location](./bitburner.locationrequirement.location.md) + + + + + + + +[LocationName](./bitburner.locationname.md) + + + + + +
+ +[type](./bitburner.locationrequirement.type.md) + + + + + + + +"location" + + + + + +
diff --git a/markdown/bitburner.material.md b/markdown/bitburner.material.md index 14f517bca..6c1fd5277 100644 --- a/markdown/bitburner.material.md +++ b/markdown/bitburner.material.md @@ -14,19 +14,273 @@ interface Material ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [actualSellAmount](./bitburner.material.actualsellamount.md) | | number | Amount of material sold last cycle | -| [buyAmount](./bitburner.material.buyamount.md) | | number | Amount of material purchased from the market last cycle | -| [competition](./bitburner.material.competition.md) | | number \| undefined | Competition for the material, only present if "Market Research - Competition" unlocked | -| [demand](./bitburner.material.demand.md) | | number \| undefined | Demand for the material, only present if "Market Research - Demand" unlocked | -| [desiredSellAmount](./bitburner.material.desiredsellamount.md) | | string \| number | Sell amount, can be "PROD/2" | -| [desiredSellPrice](./bitburner.material.desiredsellprice.md) | | string \| number | Sell cost, can be "MP+5" | -| [exports](./bitburner.material.exports.md) | | [Export](./bitburner.export.md)\[\] | Export orders | -| [importAmount](./bitburner.material.importamount.md) | | number | Amount of material imported from other divisions last cycle | -| [marketPrice](./bitburner.material.marketprice.md) | | number | Cost to buy material | -| [name](./bitburner.material.name.md) | | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| [productionAmount](./bitburner.material.productionamount.md) | | number | Amount of material produced last cycle | -| [quality](./bitburner.material.quality.md) | | number | Quality of the material | -| [stored](./bitburner.material.stored.md) | | number | Amount of material | + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[actualSellAmount](./bitburner.material.actualsellamount.md) + + + + + + + +number + + + + +Amount of material sold last cycle + + +
+ +[buyAmount](./bitburner.material.buyamount.md) + + + + + + + +number + + + + +Amount of material purchased from the market last cycle + + +
+ +[competition](./bitburner.material.competition.md) + + + + + + + +number \| undefined + + + + +Competition for the material, only present if "Market Research - Competition" unlocked + + +
+ +[demand](./bitburner.material.demand.md) + + + + + + + +number \| undefined + + + + +Demand for the material, only present if "Market Research - Demand" unlocked + + +
+ +[desiredSellAmount](./bitburner.material.desiredsellamount.md) + + + + + + + +string \| number + + + + +Sell amount, can be "PROD/2" + + +
+ +[desiredSellPrice](./bitburner.material.desiredsellprice.md) + + + + + + + +string \| number + + + + +Sell cost, can be "MP+5" + + +
+ +[exports](./bitburner.material.exports.md) + + + + + + + +[Export](./bitburner.export.md)\[\] + + + + +Export orders + + +
+ +[importAmount](./bitburner.material.importamount.md) + + + + + + + +number + + + + +Amount of material imported from other divisions last cycle + + +
+ +[marketPrice](./bitburner.material.marketprice.md) + + + + + + + +number + + + + +Cost to buy material + + +
+ +[name](./bitburner.material.name.md) + + + + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
+ +[productionAmount](./bitburner.material.productionamount.md) + + + + + + + +number + + + + +Amount of material produced last cycle + + +
+ +[quality](./bitburner.material.quality.md) + + + + + + + +number + + + + +Quality of the material + + +
+ +[stored](./bitburner.material.stored.md) + + + + + + + +number + + + + +Amount of material + + +
diff --git a/markdown/bitburner.md b/markdown/bitburner.md index 1eb8ca6f2..0ac2f6177 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -6,216 +6,2212 @@ ## Interfaces -| Interface | Description | -| --- | --- | -| [ActiveFragment](./bitburner.activefragment.md) | | -| [AugmentPair](./bitburner.augmentpair.md) | Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) | -| [AutocompleteData](./bitburner.autocompletedata.md) | Used for autocompletion | -| [BackdoorRequirement](./bitburner.backdoorrequirement.md) | Player must have installed a backdoor on this server. | -| [BaseTask](./bitburner.basetask.md) | Base interface of all tasks. | -| [BasicHGWOptions](./bitburner.basichgwoptions.md) | Options to affect the behavior of [hack](./bitburner.ns.hack.md), [grow](./bitburner.ns.grow.md), and [weaken](./bitburner.ns.weaken.md). | -| [BitNodeBooleanOptions](./bitburner.bitnodebooleanoptions.md) |

Note:

- restrictHomePCUpgrade: The home computer's maximum RAM and number of cores are lower than normal. Max RAM: 128GB. Max core: 1.

- disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy augmentations for them.

| -| [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. | -| [BitNodeOptions](./bitburner.bitnodeoptions.md) |

Default value:

- sourceFileOverrides: an empty Map

- intelligenceOverride: undefined

- All boolean options: false

If you specify intelligenceOverride, it must be a non-negative integer.

| -| [BitNodeRequirement](./bitburner.bitnoderequirement.md) | Player must be located in this BitNode. | -| [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API | -| [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | Bladeburner current action. | -| [BladeburnerFormulas](./bitburner.bladeburnerformulas.md) | Bladeburner formulas | -| [BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md) | Player must have at least this rank in the Bladeburner Division. | -| [CityRequirement](./bitburner.cityrequirement.md) | Player must be located in this city. | -| [CodingContract](./bitburner.codingcontract.md) | Coding Contract API | -| [CompanyPositionInfo](./bitburner.companypositioninfo.md) | Company position requirements and salary. | -| [CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) | Player must have at least this much reputation with this company. | -| [CompanyWorkTask](./bitburner.companyworktask.md) | Company Work | -| [CorpConstants](./bitburner.corpconstants.md) | Corporation related constants | -| [CorpIndustryData](./bitburner.corpindustrydata.md) | Data for an individual industry | -| [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) | Corporation material information | -| [Corporation](./bitburner.corporation.md) | Corporation API | -| [CorporationInfo](./bitburner.corporationinfo.md) | General info about a corporation | -| [CorpProductData](./bitburner.corpproductdata.md) | Product rating information | -| [CreateProgramWorkTask](./bitburner.createprogramworktask.md) | Create Program | -| [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. | -| [CrimeTask](./bitburner.crimetask.md) | Crime | -| [Division](./bitburner.division.md) | Corporation division | -| [EmployedByRequirement](./bitburner.employedbyrequirement.md) | Player must be working for this company. | -| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. | -| [EveryRequirement](./bitburner.everyrequirement.md) | All sub-conditions must be satisfied. | -| [Export](./bitburner.export.md) | Export order for a material | -| [FactionWorkTask](./bitburner.factionworktask.md) | Faction Work | -| [FileMetadata](./bitburner.filemetadata.md) | Metadata of a file | -| [FileRequirement](./bitburner.filerequirement.md) | Player must have a specific Literature or Message file on their home computer. | -| [Format](./bitburner.format.md) | Format API | -| [Formulas](./bitburner.formulas.md) | Formulas API | -| [Fragment](./bitburner.fragment.md) | | -| [GameInfo](./bitburner.gameinfo.md) | Game Information | -| [Gang](./bitburner.gang.md) | Gang API | -| [GangFormulas](./bitburner.gangformulas.md) | Gang formulas | -| [GangGenInfo](./bitburner.ganggeninfo.md) | Gang general info. | -| [GangMemberAscension](./bitburner.gangmemberascension.md) | | -| [GangMemberExpGain](./bitburner.gangmemberexpgain.md) | | -| [GangMemberInfo](./bitburner.gangmemberinfo.md) | | -| [GangMemberInstall](./bitburner.gangmemberinstall.md) | | -| [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | | -| [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. | -| [GangTerritory](./bitburner.gangterritory.md) | | -| [Go](./bitburner.go.md) | IPvGO api | -| [GoAnalysis](./bitburner.goanalysis.md) | Tools to analyze the IPvGO subnet. | -| [GoCheat](./bitburner.gocheat.md) | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. | -| [Grafting](./bitburner.grafting.md) | Grafting API | -| [GraftingTask](./bitburner.graftingtask.md) | Grafting Work | -| [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas | -| [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. | -| [Hacknet](./bitburner.hacknet.md) | Hacknet API | -| [HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md) | Player's Hacknet devices must have at least this many total cores. | -| [HacknetLevelsRequirement](./bitburner.hacknetlevelsrequirement.md) | Player's Hacknet devices must have at least this many total levels. | -| [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. | -| [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) | Hacknet node related constants | -| [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas | -| [HacknetRAMRequirement](./bitburner.hacknetramrequirement.md) | Player's Hacknet devices must have at least this much total RAM. | -| [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants | -| [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas | -| [HostReturnOptions](./bitburner.hostreturnoptions.md) | Options to control how a server identifier (hostname or IP address) is returned. Affects the behavior of [scan](./bitburner.ns.scan.md), [getPurchasedServers](./bitburner.ns.getpurchasedservers.md), and [getCurrentServer](./bitburner.singularity.getcurrentserver.md) | -| [HP](./bitburner.hp.md) | | -| [ILocation](./bitburner.ilocation.md) | | -| [IndustryData](./bitburner.industrydata.md) | Corporation industry information | -| [Infiltration](./bitburner.infiltration.md) | Infiltration API. | -| [InfiltrationLocation](./bitburner.infiltrationlocation.md) | | -| [InfiltrationReward](./bitburner.infiltrationreward.md) | | -| [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. | -| [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. | -| [MoneySource](./bitburner.moneysource.md) | | -| [MoneySources](./bitburner.moneysources.md) | | -| [Multipliers](./bitburner.multipliers.md) | | -| [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. | -| [NodeStats](./bitburner.nodestats.md) | Object representing all the values related to a hacknet node. | -| [NotRequirement](./bitburner.notrequirement.md) | The sub-condition must not be satisfied. | -| [NS](./bitburner.ns.md) | Collection of all functions passed to scripts | -| [NumAugmentationsRequirement](./bitburner.numaugmentationsrequirement.md) | Player must have at least this many augmentations installed (if positive). Player must have no augmentations installed (if zero). | -| [NumInfiltrationsRequirement](./bitburner.numinfiltrationsrequirement.md) | Player must have completed this many infiltrations. | -| [Office](./bitburner.office.md) | Office for a division in a city. | -| [OfficeAPI](./bitburner.officeapi.md) | Corporation Office API | -| [PeopleKilledRequirement](./bitburner.peoplekilledrequirement.md) | Player must have killed at least this many people. | -| [Person](./bitburner.person.md) | | -| [Player](./bitburner.player.md) | | -| [ProcessInfo](./bitburner.processinfo.md) | A single process on a server. | -| [Product](./bitburner.product.md) | Product in a warehouse | -| [ReactElement](./bitburner.reactelement.md) | A stand-in for the real React.ReactElement. Use React.createElement to make these. See [creating an element without jsx](https://react.dev/reference/react/createElement#creating-an-element-without-jsx) from the official React documentation. | -| [RecentScript](./bitburner.recentscript.md) | | -| [ReputationFormulas](./bitburner.reputationformulas.md) | Reputation formulas | -| [ResetInfo](./bitburner.resetinfo.md) | Various info about resets | -| [RunningScript](./bitburner.runningscript.md) | | -| [RunOptions](./bitburner.runoptions.md) | | -| [Server](./bitburner.server.md) | A server. Not all servers have all of these properties - optional properties are missing on certain servers. | -| [Singularity](./bitburner.singularity.md) | Singularity API | -| [SkillRequirement](./bitburner.skillrequirement.md) | Player must have each listed skill at least this level. | -| [Skills](./bitburner.skills.md) | | -| [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas | -| [Sleeve](./bitburner.sleeve.md) | Sleeve API | -| [SleevePerson](./bitburner.sleeveperson.md) | | -| [SomeRequirement](./bitburner.somerequirement.md) | At least one sub-condition must be satisfied. | -| [SourceFileLvl](./bitburner.sourcefilelvl.md) | | -| [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 stock market game mechanic. | -| [StockOrder](./bitburner.stockorder.md) | | -| [StudyTask](./bitburner.studytask.md) | Study | -| [TailProperties](./bitburner.tailproperties.md) | | -| [TIX](./bitburner.tix.md) | Stock market API | -| [UserInterface](./bitburner.userinterface.md) | User Interface API. | -| [UserInterfaceTheme](./bitburner.userinterfacetheme.md) | Interface Theme | -| [Warehouse](./bitburner.warehouse.md) | Warehouse for a division in a city | -| [WarehouseAPI](./bitburner.warehouseapi.md) | Corporation Warehouse API | -| [WorkFormulas](./bitburner.workformulas.md) | Work formulas | -| [WorkStats](./bitburner.workstats.md) | | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Interface + + + + +Description + + +
+ +[ActiveFragment](./bitburner.activefragment.md) + + + + + + +
+ +[AugmentPair](./bitburner.augmentpair.md) + + + + +Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) + + +
+ +[AutocompleteData](./bitburner.autocompletedata.md) + + + + +Used for autocompletion + + +
+ +[BackdoorRequirement](./bitburner.backdoorrequirement.md) + + + + +Player must have installed a backdoor on this server. + + +
+ +[BaseTask](./bitburner.basetask.md) + + + + +Base interface of all tasks. + + +
+ +[BasicHGWOptions](./bitburner.basichgwoptions.md) + + + + +Options to affect the behavior of [hack](./bitburner.ns.hack.md), [grow](./bitburner.ns.grow.md), and [weaken](./bitburner.ns.weaken.md). + + +
+ +[BitNodeBooleanOptions](./bitburner.bitnodebooleanoptions.md) + + + + +Note: + +- restrictHomePCUpgrade: The home computer's maximum RAM and number of cores are lower than normal. Max RAM: 128GB. Max core: 1. + +- disableSleeveExpAndAugmentation: Your Sleeves do not gain experience when they perform action. You also cannot buy augmentations for them. + + +
+ +[BitNodeMultipliers](./bitburner.bitnodemultipliers.md) + + + + +All multipliers affecting the difficulty of the current challenge. + + +
+ +[BitNodeOptions](./bitburner.bitnodeoptions.md) + + + + +Default value: + +- sourceFileOverrides: an empty Map + +- intelligenceOverride: undefined + +- All boolean options: false + +If you specify intelligenceOverride, it must be a non-negative integer. + + +
+ +[BitNodeRequirement](./bitburner.bitnoderequirement.md) + + + + +Player must be located in this BitNode. + + +
+ +[Bladeburner](./bitburner.bladeburner.md) + + + + +Bladeburner API + + +
+ +[BladeburnerCurAction](./bitburner.bladeburnercuraction.md) + + + + +Bladeburner current action. + + +
+ +[BladeburnerFormulas](./bitburner.bladeburnerformulas.md) + + + + +Bladeburner formulas + + +
+ +[BladeburnerRankRequirement](./bitburner.bladeburnerrankrequirement.md) + + + + +Player must have at least this rank in the Bladeburner Division. + + +
+ +[CityRequirement](./bitburner.cityrequirement.md) + + + + +Player must be located in this city. + + +
+ +[CodingContract](./bitburner.codingcontract.md) + + + + +Coding Contract API + + +
+ +[CompanyPositionInfo](./bitburner.companypositioninfo.md) + + + + +Company position requirements and salary. + + +
+ +[CompanyReputationRequirement](./bitburner.companyreputationrequirement.md) + + + + +Player must have at least this much reputation with this company. + + +
+ +[CompanyWorkTask](./bitburner.companyworktask.md) + + + + +Company Work + + +
+ +[CorpConstants](./bitburner.corpconstants.md) + + + + +Corporation related constants + + +
+ +[CorpIndustryData](./bitburner.corpindustrydata.md) + + + + +Data for an individual industry + + +
+ +[CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) + + + + +Corporation material information + + +
+ +[Corporation](./bitburner.corporation.md) + + + + +Corporation API + + +
+ +[CorporationInfo](./bitburner.corporationinfo.md) + + + + +General info about a corporation + + +
+ +[CorpProductData](./bitburner.corpproductdata.md) + + + + +Product rating information + + +
+ +[CreateProgramWorkTask](./bitburner.createprogramworktask.md) + + + + +Create Program + + +
+ +[CrimeStats](./bitburner.crimestats.md) + + + + +Data representing the internal values of a crime. + + +
+ +[CrimeTask](./bitburner.crimetask.md) + + + + +Crime + + +
+ +[Division](./bitburner.division.md) + + + + +Corporation division + + +
+ +[EmployedByRequirement](./bitburner.employedbyrequirement.md) + + + + +Player must be working for this company. + + +
+ +[EquipmentStats](./bitburner.equipmentstats.md) + + + + +Object representing data representing a gang member equipment. + + +
+ +[EveryRequirement](./bitburner.everyrequirement.md) + + + + +All sub-conditions must be satisfied. + + +
+ +[Export](./bitburner.export.md) + + + + +Export order for a material + + +
+ +[FactionWorkTask](./bitburner.factionworktask.md) + + + + +Faction Work + + +
+ +[FileMetadata](./bitburner.filemetadata.md) + + + + +Metadata of a file + + +
+ +[FileRequirement](./bitburner.filerequirement.md) + + + + +Player must have a specific Literature or Message file on their home computer. + + +
+ +[Format](./bitburner.format.md) + + + + +Format API + + +
+ +[Formulas](./bitburner.formulas.md) + + + + +Formulas API + + +
+ +[Fragment](./bitburner.fragment.md) + + + + + + +
+ +[GameInfo](./bitburner.gameinfo.md) + + + + +Game Information + + +
+ +[Gang](./bitburner.gang.md) + + + + +Gang API + + +
+ +[GangFormulas](./bitburner.gangformulas.md) + + + + +Gang formulas + + +
+ +[GangGenInfo](./bitburner.ganggeninfo.md) + + + + +Gang general info. + + +
+ +[GangMemberAscension](./bitburner.gangmemberascension.md) + + + + + + +
+ +[GangMemberExpGain](./bitburner.gangmemberexpgain.md) + + + + + + +
+ +[GangMemberInfo](./bitburner.gangmemberinfo.md) + + + + + + +
+ +[GangMemberInstall](./bitburner.gangmemberinstall.md) + + + + + + +
+ +[GangOtherInfoObject](./bitburner.gangotherinfoobject.md) + + + + + + +
+ +[GangTaskStats](./bitburner.gangtaskstats.md) + + + + +Object representing data representing a gang member task. + + +
+ +[GangTerritory](./bitburner.gangterritory.md) + + + + + + +
+ +[Go](./bitburner.go.md) + + + + +IPvGO api + + +
+ +[GoAnalysis](./bitburner.goanalysis.md) + + + + +Tools to analyze the IPvGO subnet. + + +
+ +[GoCheat](./bitburner.gocheat.md) + + + + +Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. + + +
+ +[Grafting](./bitburner.grafting.md) + + + + +Grafting API + + +
+ +[GraftingTask](./bitburner.graftingtask.md) + + + + +Grafting Work + + +
+ +[HackingFormulas](./bitburner.hackingformulas.md) + + + + +Hacking formulas + + +
+ +[HackingMultipliers](./bitburner.hackingmultipliers.md) + + + + +Hack related multipliers. + + +
+ +[Hacknet](./bitburner.hacknet.md) + + + + +Hacknet API + + +
+ +[HacknetCoresRequirement](./bitburner.hacknetcoresrequirement.md) + + + + +Player's Hacknet devices must have at least this many total cores. + + +
+ +[HacknetLevelsRequirement](./bitburner.hacknetlevelsrequirement.md) + + + + +Player's Hacknet devices must have at least this many total levels. + + +
+ +[HacknetMultipliers](./bitburner.hacknetmultipliers.md) + + + + +Hacknet related multipliers. + + +
+ +[HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) + + + + +Hacknet node related constants + + +
+ +[HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) + + + + +Hacknet Node formulas + + +
+ +[HacknetRAMRequirement](./bitburner.hacknetramrequirement.md) + + + + +Player's Hacknet devices must have at least this much total RAM. + + +
+ +[HacknetServerConstants](./bitburner.hacknetserverconstants.md) + + + + +Hacknet server related constants + + +
+ +[HacknetServersFormulas](./bitburner.hacknetserversformulas.md) + + + + +Hacknet Server formulas + + +
+ +[HostReturnOptions](./bitburner.hostreturnoptions.md) + + + + +Options to control how a server identifier (hostname or IP address) is returned. Affects the behavior of [scan](./bitburner.ns.scan.md), [getPurchasedServers](./bitburner.ns.getpurchasedservers.md), and [getCurrentServer](./bitburner.singularity.getcurrentserver.md) + + +
+ +[HP](./bitburner.hp.md) + + + + + + +
+ +[ILocation](./bitburner.ilocation.md) + + + + + + +
+ +[IndustryData](./bitburner.industrydata.md) + + + + +Corporation industry information + + +
+ +[Infiltration](./bitburner.infiltration.md) + + + + +Infiltration API. + + +
+ +[InfiltrationLocation](./bitburner.infiltrationlocation.md) + + + + + + +
+ +[InfiltrationReward](./bitburner.infiltrationreward.md) + + + + + + +
+ +[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. + + +
+ +[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. + + +
+ +[MoneySource](./bitburner.moneysource.md) + + + + + + +
+ +[MoneySources](./bitburner.moneysources.md) + + + + + + +
+ +[Multipliers](./bitburner.multipliers.md) + + + + + + +
+ +[NetscriptPort](./bitburner.netscriptport.md) + + + + +Object representing a port. A port is a serialized queue. + + +
+ +[NodeStats](./bitburner.nodestats.md) + + + + +Object representing all the values related to a hacknet node. + + +
+ +[NotRequirement](./bitburner.notrequirement.md) + + + + +The sub-condition must not be satisfied. + + +
+ +[NS](./bitburner.ns.md) + + + + +Collection of all functions passed to scripts + + +
+ +[NumAugmentationsRequirement](./bitburner.numaugmentationsrequirement.md) + + + + +Player must have at least this many augmentations installed (if positive). Player must have no augmentations installed (if zero). + + +
+ +[NumInfiltrationsRequirement](./bitburner.numinfiltrationsrequirement.md) + + + + +Player must have completed this many infiltrations. + + +
+ +[Office](./bitburner.office.md) + + + + +Office for a division in a city. + + +
+ +[OfficeAPI](./bitburner.officeapi.md) + + + + +Corporation Office API + + +
+ +[PeopleKilledRequirement](./bitburner.peoplekilledrequirement.md) + + + + +Player must have killed at least this many people. + + +
+ +[Person](./bitburner.person.md) + + + + + + +
+ +[Player](./bitburner.player.md) + + + + + + +
+ +[ProcessInfo](./bitburner.processinfo.md) + + + + +A single process on a server. + + +
+ +[Product](./bitburner.product.md) + + + + +Product in a warehouse + + +
+ +[ReactElement](./bitburner.reactelement.md) + + + + +A stand-in for the real React.ReactElement. Use React.createElement to make these. See [creating an element without jsx](https://react.dev/reference/react/createElement#creating-an-element-without-jsx) from the official React documentation. + + +
+ +[RecentScript](./bitburner.recentscript.md) + + + + + + +
+ +[ReputationFormulas](./bitburner.reputationformulas.md) + + + + +Reputation formulas + + +
+ +[ResetInfo](./bitburner.resetinfo.md) + + + + +Various info about resets + + +
+ +[RunningScript](./bitburner.runningscript.md) + + + + + + +
+ +[RunOptions](./bitburner.runoptions.md) + + + + + + +
+ +[Server](./bitburner.server.md) + + + + +A server. Not all servers have all of these properties - optional properties are missing on certain servers. + + +
+ +[Singularity](./bitburner.singularity.md) + + + + +Singularity API + + +
+ +[SkillRequirement](./bitburner.skillrequirement.md) + + + + +Player must have each listed skill at least this level. + + +
+ +[Skills](./bitburner.skills.md) + + + + + + +
+ +[SkillsFormulas](./bitburner.skillsformulas.md) + + + + +Skills formulas + + +
+ +[Sleeve](./bitburner.sleeve.md) + + + + +Sleeve API + + +
+ +[SleevePerson](./bitburner.sleeveperson.md) + + + + + + +
+ +[SomeRequirement](./bitburner.somerequirement.md) + + + + +At least one sub-condition must be satisfied. + + +
+ +[SourceFileLvl](./bitburner.sourcefilelvl.md) + + + + + + +
+ +[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 stock market game mechanic. + + +
+ +[StockOrder](./bitburner.stockorder.md) + + + + + + +
+ +[StudyTask](./bitburner.studytask.md) + + + + +Study + + +
+ +[TailProperties](./bitburner.tailproperties.md) + + + + + + +
+ +[TIX](./bitburner.tix.md) + + + + +Stock market API + + +
+ +[UserInterface](./bitburner.userinterface.md) + + + + +User Interface API. + + +
+ +[UserInterfaceTheme](./bitburner.userinterfacetheme.md) + + + + +Interface Theme + + +
+ +[Warehouse](./bitburner.warehouse.md) + + + + +Warehouse for a division in a city + + +
+ +[WarehouseAPI](./bitburner.warehouseapi.md) + + + + +Corporation Warehouse API + + +
+ +[WorkFormulas](./bitburner.workformulas.md) + + + + +Work formulas + + +
+ +[WorkStats](./bitburner.workstats.md) + + + + + + +
## Type Aliases -| Type Alias | Description | -| --- | --- | -| [\_ValueOf](./bitburner._valueof.md) | | -| [BladeburnerActionEnumType](./bitburner.bladeburneractionenumtype.md) | Action types of Bladeburner | -| [BladeburnerActionName](./bitburner.bladeburneractionname.md) | | -| [BladeburnerActionType](./bitburner.bladeburneractiontype.md) | | -| [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) | | -| [BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) | | -| [BladeburnerBlackOpNameEnumType](./bitburner.bladeburnerblackopnameenumtype.md) | Black Operation names of Bladeburner | -| [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | | -| [BladeburnerContractNameEnumType](./bitburner.bladeburnercontractnameenumtype.md) | Contract names of Bladeburner | -| [BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md) | | -| [BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md) | General action names of Bladeburner | -| [BladeburnerOperationName](./bitburner.bladeburneroperationname.md) | | -| [BladeburnerOperationNameEnumType](./bitburner.bladeburneroperationnameenumtype.md) | Operation names of Bladeburner | -| [BladeburnerSkillName](./bitburner.bladeburnerskillname.md) | | -| [BladeburnerSkillNameEnumType](./bitburner.bladeburnerskillnameenumtype.md) | Skill names type of Bladeburner | -| [CityName](./bitburner.cityname.md) | | -| [CityNameEnumType](./bitburner.citynameenumtype.md) | Names of all cities | -| [CodingContractName](./bitburner.codingcontractname.md) | | -| [CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md) | | -| [CodingContractObject](./bitburner.codingcontractobject.md) | | -| [CodingContractSignatures](./bitburner.codingcontractsignatures.md) | | -| [CompanyName](./bitburner.companyname.md) | | -| [CompanyNameEnumType](./bitburner.companynameenumtype.md) | Names of all companies | -| [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | | -| [CorpIndustryName](./bitburner.corpindustryname.md) | | -| [CorpMaterialName](./bitburner.corpmaterialname.md) | | -| [CorpResearchName](./bitburner.corpresearchname.md) | | -| [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) | | -| [CorpStateName](./bitburner.corpstatename.md) | | -| [CorpUnlockName](./bitburner.corpunlockname.md) | | -| [CorpUpgradeName](./bitburner.corpupgradename.md) | | -| [CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md) | | -| [CreatingCorporationCheckResultEnumType](./bitburner.creatingcorporationcheckresultenumtype.md) | | -| [CrimeEnumType](./bitburner.crimeenumtype.md) | | -| [CrimeType](./bitburner.crimetype.md) | | -| [FactionName](./bitburner.factionname.md) | | -| [FactionNameEnumType](./bitburner.factionnameenumtype.md) |

Names of all factions.

Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame.

| -| [FactionWorkEnumType](./bitburner.factionworkenumtype.md) | | -| [FactionWorkType](./bitburner.factionworktype.md) | | -| [FilenameOrPID](./bitburner.filenameorpid.md) | | -| [GoOpponent](./bitburner.goopponent.md) | | -| [GymEnumType](./bitburner.gymenumtype.md) | | -| [GymLocationName](./bitburner.gymlocationname.md) | | -| [GymLocationNameEnumType](./bitburner.gymlocationnameenumtype.md) | Locations of gym | -| [GymType](./bitburner.gymtype.md) | | -| [HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) | | -| [JobField](./bitburner.jobfield.md) | | -| [JobFieldEnumType](./bitburner.jobfieldenumtype.md) | | -| [JobName](./bitburner.jobname.md) | | -| [JobNameEnumType](./bitburner.jobnameenumtype.md) | | -| [LocationName](./bitburner.locationname.md) | | -| [LocationNameEnumType](./bitburner.locationnameenumtype.md) | Names of all locations | -| [NSEnums](./bitburner.nsenums.md) | | -| [OrderEnumType](./bitburner.orderenumtype.md) | | -| [OrderType](./bitburner.ordertype.md) | | -| [PlayerRequirement](./bitburner.playerrequirement.md) | Structured interface to requirements for joining a faction or company. For fields with numerical value > 0, the player must have at least this value. For fields with numerical value <= 0, the player must have at most this value. For "not", the sub-condition must be failed instead of passed. For "someCondition", at least one sub-condition must be passed. | -| [PositionEnumType](./bitburner.positionenumtype.md) | | -| [PositionType](./bitburner.positiontype.md) | | -| [ReactNode](./bitburner.reactnode.md) |

A stand-in for the real React.ReactNode. A [ReactElement](./bitburner.reactelement.md) is rendered dynamically with React. number and string are displayed directly. boolean, null, and undefined are ignored and not rendered. An array of ReactNodes will display all members of that array sequentially.

Use React.createElement to make the ReactElement type, see [creating an element without jsx](https://react.dev/reference/react/createElement#creating-an-element-without-jsx) from the official React documentation.

| -| [ScriptArg](./bitburner.scriptarg.md) | | -| [SimpleOpponentStats](./bitburner.simpleopponentstats.md) | | -| [SleeveBladeburnerTask](./bitburner.sleevebladeburnertask.md) | | -| [SleeveClassTask](./bitburner.sleeveclasstask.md) | | -| [SleeveCompanyTask](./bitburner.sleevecompanytask.md) | | -| [SleeveCrimeTask](./bitburner.sleevecrimetask.md) | | -| [SleeveFactionTask](./bitburner.sleevefactiontask.md) | | -| [SleeveInfiltrateTask](./bitburner.sleeveinfiltratetask.md) | | -| [SleeveRecoveryTask](./bitburner.sleeverecoverytask.md) | | -| [SleeveSupportTask](./bitburner.sleevesupporttask.md) | | -| [SleeveSynchroTask](./bitburner.sleevesynchrotask.md) | | -| [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. | -| [SpecialBladeburnerActionEnumTypeForSleeve](./bitburner.specialbladeburneractionenumtypeforsleeve.md) | These special Bladeburner action types are only for Sleeve | -| [SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) | | -| [Task](./bitburner.task.md) | Task | -| [ToastVariant](./bitburner.toastvariant.md) | | -| [ToastVariantEnumType](./bitburner.toastvariantenumtype.md) | | -| [UniversityClassEnumType](./bitburner.universityclassenumtype.md) | | -| [UniversityClassType](./bitburner.universityclasstype.md) | | -| [UniversityLocationName](./bitburner.universitylocationname.md) | | -| [UniversityLocationNameEnumType](./bitburner.universitylocationnameenumtype.md) | Locations of university | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Type Alias + + + + +Description + + +
+ +[\_ValueOf](./bitburner._valueof.md) + + + + + + +
+ +[BladeburnerActionEnumType](./bitburner.bladeburneractionenumtype.md) + + + + +Action types of Bladeburner + + +
+ +[BladeburnerActionName](./bitburner.bladeburneractionname.md) + + + + + + +
+ +[BladeburnerActionType](./bitburner.bladeburneractiontype.md) + + + + + + +
+ +[BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) + + + + + + +
+ +[BladeburnerBlackOpName](./bitburner.bladeburnerblackopname.md) + + + + + + +
+ +[BladeburnerBlackOpNameEnumType](./bitburner.bladeburnerblackopnameenumtype.md) + + + + +Black Operation names of Bladeburner + + +
+ +[BladeburnerContractName](./bitburner.bladeburnercontractname.md) + + + + + + +
+ +[BladeburnerContractNameEnumType](./bitburner.bladeburnercontractnameenumtype.md) + + + + +Contract names of Bladeburner + + +
+ +[BladeburnerGeneralActionName](./bitburner.bladeburnergeneralactionname.md) + + + + + + +
+ +[BladeburnerGeneralActionNameEnumType](./bitburner.bladeburnergeneralactionnameenumtype.md) + + + + +General action names of Bladeburner + + +
+ +[BladeburnerOperationName](./bitburner.bladeburneroperationname.md) + + + + + + +
+ +[BladeburnerOperationNameEnumType](./bitburner.bladeburneroperationnameenumtype.md) + + + + +Operation names of Bladeburner + + +
+ +[BladeburnerSkillName](./bitburner.bladeburnerskillname.md) + + + + + + +
+ +[BladeburnerSkillNameEnumType](./bitburner.bladeburnerskillnameenumtype.md) + + + + +Skill names type of Bladeburner + + +
+ +[CityName](./bitburner.cityname.md) + + + + + + +
+ +[CityNameEnumType](./bitburner.citynameenumtype.md) + + + + +Names of all cities + + +
+ +[CodingContractName](./bitburner.codingcontractname.md) + + + + + + +
+ +[CodingContractNameEnumType](./bitburner.codingcontractnameenumtype.md) + + + + + + +
+ +[CodingContractObject](./bitburner.codingcontractobject.md) + + + + + + +
+ +[CodingContractSignatures](./bitburner.codingcontractsignatures.md) + + + + + + +
+ +[CompanyName](./bitburner.companyname.md) + + + + + + +
+ +[CompanyNameEnumType](./bitburner.companynameenumtype.md) + + + + +Names of all companies + + +
+ +[CorpEmployeePosition](./bitburner.corpemployeeposition.md) + + + + + + +
+ +[CorpIndustryName](./bitburner.corpindustryname.md) + + + + + + +
+ +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + + + +
+ +[CorpResearchName](./bitburner.corpresearchname.md) + + + + + + +
+ +[CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) + + + + + + +
+ +[CorpStateName](./bitburner.corpstatename.md) + + + + + + +
+ +[CorpUnlockName](./bitburner.corpunlockname.md) + + + + + + +
+ +[CorpUpgradeName](./bitburner.corpupgradename.md) + + + + + + +
+ +[CreatingCorporationCheckResult](./bitburner.creatingcorporationcheckresult.md) + + + + + + +
+ +[CreatingCorporationCheckResultEnumType](./bitburner.creatingcorporationcheckresultenumtype.md) + + + + + + +
+ +[CrimeEnumType](./bitburner.crimeenumtype.md) + + + + + + +
+ +[CrimeType](./bitburner.crimetype.md) + + + + + + +
+ +[FactionName](./bitburner.factionname.md) + + + + + + +
+ +[FactionNameEnumType](./bitburner.factionnameenumtype.md) + + + + +Names of all factions. + +Warning: Spoiler ahead. This enum contains names of \*\*all\*\* factions. If you do not want to know what all the factions are, you should not check this enum. Some factions are only accessible in the endgame. + + +
+ +[FactionWorkEnumType](./bitburner.factionworkenumtype.md) + + + + + + +
+ +[FactionWorkType](./bitburner.factionworktype.md) + + + + + + +
+ +[FilenameOrPID](./bitburner.filenameorpid.md) + + + + + + +
+ +[GoOpponent](./bitburner.goopponent.md) + + + + + + +
+ +[GymEnumType](./bitburner.gymenumtype.md) + + + + + + +
+ +[GymLocationName](./bitburner.gymlocationname.md) + + + + + + +
+ +[GymLocationNameEnumType](./bitburner.gymlocationnameenumtype.md) + + + + +Locations of gym + + +
+ +[GymType](./bitburner.gymtype.md) + + + + + + +
+ +[HacknetServerHashUpgrade](./bitburner.hacknetserverhashupgrade.md) + + + + + + +
+ +[JobField](./bitburner.jobfield.md) + + + + + + +
+ +[JobFieldEnumType](./bitburner.jobfieldenumtype.md) + + + + + + +
+ +[JobName](./bitburner.jobname.md) + + + + + + +
+ +[JobNameEnumType](./bitburner.jobnameenumtype.md) + + + + + + +
+ +[LocationName](./bitburner.locationname.md) + + + + + + +
+ +[LocationNameEnumType](./bitburner.locationnameenumtype.md) + + + + +Names of all locations + + +
+ +[NSEnums](./bitburner.nsenums.md) + + + + + + +
+ +[OrderEnumType](./bitburner.orderenumtype.md) + + + + + + +
+ +[OrderType](./bitburner.ordertype.md) + + + + + + +
+ +[PlayerRequirement](./bitburner.playerrequirement.md) + + + + +Structured interface to requirements for joining a faction or company. For fields with numerical value > 0, the player must have at least this value. For fields with numerical value <= 0, the player must have at most this value. For "not", the sub-condition must be failed instead of passed. For "someCondition", at least one sub-condition must be passed. + + +
+ +[PositionEnumType](./bitburner.positionenumtype.md) + + + + + + +
+ +[PositionType](./bitburner.positiontype.md) + + + + + + +
+ +[ReactNode](./bitburner.reactnode.md) + + + + +A stand-in for the real React.ReactNode. A [ReactElement](./bitburner.reactelement.md) is rendered dynamically with React. number and string are displayed directly. boolean, null, and undefined are ignored and not rendered. An array of ReactNodes will display all members of that array sequentially. + +Use React.createElement to make the ReactElement type, see [creating an element without jsx](https://react.dev/reference/react/createElement#creating-an-element-without-jsx) from the official React documentation. + + +
+ +[ScriptArg](./bitburner.scriptarg.md) + + + + + + +
+ +[SimpleOpponentStats](./bitburner.simpleopponentstats.md) + + + + + + +
+ +[SleeveBladeburnerTask](./bitburner.sleevebladeburnertask.md) + + + + + + +
+ +[SleeveClassTask](./bitburner.sleeveclasstask.md) + + + + + + +
+ +[SleeveCompanyTask](./bitburner.sleevecompanytask.md) + + + + + + +
+ +[SleeveCrimeTask](./bitburner.sleevecrimetask.md) + + + + + + +
+ +[SleeveFactionTask](./bitburner.sleevefactiontask.md) + + + + + + +
+ +[SleeveInfiltrateTask](./bitburner.sleeveinfiltratetask.md) + + + + + + +
+ +[SleeveRecoveryTask](./bitburner.sleeverecoverytask.md) + + + + + + +
+ +[SleeveSupportTask](./bitburner.sleevesupporttask.md) + + + + + + +
+ +[SleeveSynchroTask](./bitburner.sleevesynchrotask.md) + + + + + + +
+ +[SleeveTask](./bitburner.sleevetask.md) + + + + +Object representing a sleeve current task. + + +
+ +[SpecialBladeburnerActionEnumTypeForSleeve](./bitburner.specialbladeburneractionenumtypeforsleeve.md) + + + + +These special Bladeburner action types are only for Sleeve + + +
+ +[SpecialBladeburnerActionTypeForSleeve](./bitburner.specialbladeburneractiontypeforsleeve.md) + + + + + + +
+ +[Task](./bitburner.task.md) + + + + +Task + + +
+ +[ToastVariant](./bitburner.toastvariant.md) + + + + + + +
+ +[ToastVariantEnumType](./bitburner.toastvariantenumtype.md) + + + + + + +
+ +[UniversityClassEnumType](./bitburner.universityclassenumtype.md) + + + + + + +
+ +[UniversityClassType](./bitburner.universityclasstype.md) + + + + + + +
+ +[UniversityLocationName](./bitburner.universitylocationname.md) + + + + + + +
+ +[UniversityLocationNameEnumType](./bitburner.universitylocationnameenumtype.md) + + + + +Locations of university + + +
diff --git a/markdown/bitburner.moneyrequirement.md b/markdown/bitburner.moneyrequirement.md index 591c61aec..baf8a0360 100644 --- a/markdown/bitburner.moneyrequirement.md +++ b/markdown/bitburner.moneyrequirement.md @@ -14,8 +14,60 @@ interface MoneyRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [money](./bitburner.moneyrequirement.money.md) | | number | | -| [type](./bitburner.moneyrequirement.type.md) | | "money" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[money](./bitburner.moneyrequirement.money.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.moneyrequirement.type.md) + + + + + + + +"money" + + + + + +
diff --git a/markdown/bitburner.moneysource.md b/markdown/bitburner.moneysource.md index b85ae8297..500bf9d26 100644 --- a/markdown/bitburner.moneysource.md +++ b/markdown/bitburner.moneysource.md @@ -13,26 +13,366 @@ interface MoneySource ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [augmentations](./bitburner.moneysource.augmentations.md) | | number | | -| [bladeburner](./bitburner.moneysource.bladeburner.md) | | number | | -| [casino](./bitburner.moneysource.casino.md) | | number | | -| [class](./bitburner.moneysource.class.md) | | number | | -| [codingcontract](./bitburner.moneysource.codingcontract.md) | | number | | -| [corporation](./bitburner.moneysource.corporation.md) | | number | | -| [crime](./bitburner.moneysource.crime.md) | | number | | -| [gang\_expenses](./bitburner.moneysource.gang_expenses.md) | | number | | -| [gang](./bitburner.moneysource.gang.md) | | number | | -| [hacking](./bitburner.moneysource.hacking.md) | | number | | -| [hacknet\_expenses](./bitburner.moneysource.hacknet_expenses.md) | | number | | -| [hacknet](./bitburner.moneysource.hacknet.md) | | number | | -| [hospitalization](./bitburner.moneysource.hospitalization.md) | | number | | -| [infiltration](./bitburner.moneysource.infiltration.md) | | number | | -| [other](./bitburner.moneysource.other.md) | | number | | -| [servers](./bitburner.moneysource.servers.md) | | number | | -| [sleeves](./bitburner.moneysource.sleeves.md) | | number | | -| [stock](./bitburner.moneysource.stock.md) | | number | | -| [total](./bitburner.moneysource.total.md) | | number | | -| [work](./bitburner.moneysource.work.md) | | number | | + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[augmentations](./bitburner.moneysource.augmentations.md) + + + + + + + +number + + + + + +
+ +[bladeburner](./bitburner.moneysource.bladeburner.md) + + + + + + + +number + + + + + +
+ +[casino](./bitburner.moneysource.casino.md) + + + + + + + +number + + + + + +
+ +[class](./bitburner.moneysource.class.md) + + + + + + + +number + + + + + +
+ +[codingcontract](./bitburner.moneysource.codingcontract.md) + + + + + + + +number + + + + + +
+ +[corporation](./bitburner.moneysource.corporation.md) + + + + + + + +number + + + + + +
+ +[crime](./bitburner.moneysource.crime.md) + + + + + + + +number + + + + + +
+ +[gang\_expenses](./bitburner.moneysource.gang_expenses.md) + + + + + + + +number + + + + + +
+ +[gang](./bitburner.moneysource.gang.md) + + + + + + + +number + + + + + +
+ +[hacking](./bitburner.moneysource.hacking.md) + + + + + + + +number + + + + + +
+ +[hacknet\_expenses](./bitburner.moneysource.hacknet_expenses.md) + + + + + + + +number + + + + + +
+ +[hacknet](./bitburner.moneysource.hacknet.md) + + + + + + + +number + + + + + +
+ +[hospitalization](./bitburner.moneysource.hospitalization.md) + + + + + + + +number + + + + + +
+ +[infiltration](./bitburner.moneysource.infiltration.md) + + + + + + + +number + + + + + +
+ +[other](./bitburner.moneysource.other.md) + + + + + + + +number + + + + + +
+ +[servers](./bitburner.moneysource.servers.md) + + + + + + + +number + + + + + +
+ +[sleeves](./bitburner.moneysource.sleeves.md) + + + + + + + +number + + + + + +
+ +[stock](./bitburner.moneysource.stock.md) + + + + + + + +number + + + + + +
+ +[total](./bitburner.moneysource.total.md) + + + + + + + +number + + + + + +
+ +[work](./bitburner.moneysource.work.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.moneysources.md b/markdown/bitburner.moneysources.md index 810b8fe88..716d4be31 100644 --- a/markdown/bitburner.moneysources.md +++ b/markdown/bitburner.moneysources.md @@ -13,8 +13,60 @@ interface MoneySources ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [sinceInstall](./bitburner.moneysources.sinceinstall.md) | | [MoneySource](./bitburner.moneysource.md) | | -| [sinceStart](./bitburner.moneysources.sincestart.md) | | [MoneySource](./bitburner.moneysource.md) | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[sinceInstall](./bitburner.moneysources.sinceinstall.md) + + + + + + + +[MoneySource](./bitburner.moneysource.md) + + + + + +
+ +[sinceStart](./bitburner.moneysources.sincestart.md) + + + + + + + +[MoneySource](./bitburner.moneysource.md) + + + + + +
diff --git a/markdown/bitburner.multipliers.md b/markdown/bitburner.multipliers.md index 1d8c82102..35bc695e8 100644 --- a/markdown/bitburner.multipliers.md +++ b/markdown/bitburner.multipliers.md @@ -13,36 +13,596 @@ interface Multipliers ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agility\_exp](./bitburner.multipliers.agility_exp.md) | | number | Multiplier to agility experience gain rate | -| [agility](./bitburner.multipliers.agility.md) | | number | Multiplier to agility skill | -| [bladeburner\_analysis](./bitburner.multipliers.bladeburner_analysis.md) | | number | Multiplier to effectiveness in Bladeburner Field Analysis | -| [bladeburner\_max\_stamina](./bitburner.multipliers.bladeburner_max_stamina.md) | | number | Multiplier to Bladeburner max stamina | -| [bladeburner\_stamina\_gain](./bitburner.multipliers.bladeburner_stamina_gain.md) | | number | Multiplier to Bladeburner stamina gain rate | -| [bladeburner\_success\_chance](./bitburner.multipliers.bladeburner_success_chance.md) | | number | Multiplier to success chance in Bladeburner contracts/operations | -| [charisma\_exp](./bitburner.multipliers.charisma_exp.md) | | number | Multiplier to charisma experience gain rate | -| [charisma](./bitburner.multipliers.charisma.md) | | number | Multiplier to charisma skill | -| [company\_rep](./bitburner.multipliers.company_rep.md) | | number | Multiplier to amount of reputation gained when working | -| [crime\_money](./bitburner.multipliers.crime_money.md) | | number | Multiplier to amount of money gained from crimes | -| [crime\_success](./bitburner.multipliers.crime_success.md) | | number | Multiplier to crime success rate | -| [defense\_exp](./bitburner.multipliers.defense_exp.md) | | number | Multiplier to defense experience gain rate | -| [defense](./bitburner.multipliers.defense.md) | | number | Multiplier to defense skill | -| [dexterity\_exp](./bitburner.multipliers.dexterity_exp.md) | | number | Multiplier to dexterity experience gain rate | -| [dexterity](./bitburner.multipliers.dexterity.md) | | number | Multiplier to dexterity skill | -| [faction\_rep](./bitburner.multipliers.faction_rep.md) | | number | Multiplier to amount of reputation gained when working | -| [hacking\_chance](./bitburner.multipliers.hacking_chance.md) | | number | Multiplier to chance of successfully performing a hack | -| [hacking\_exp](./bitburner.multipliers.hacking_exp.md) | | number | Multiplier to hacking experience gain rate | -| [hacking\_grow](./bitburner.multipliers.hacking_grow.md) | | number | Multiplier to amount of money injected into servers using grow | -| [hacking\_money](./bitburner.multipliers.hacking_money.md) | | number | Multiplier to amount of money the player gains from hacking | -| [hacking\_speed](./bitburner.multipliers.hacking_speed.md) | | number | Multiplier to hacking speed | -| [hacking](./bitburner.multipliers.hacking.md) | | number | Multiplier to hacking skill | -| [hacknet\_node\_core\_cost](./bitburner.multipliers.hacknet_node_core_cost.md) | | number | Multiplier to cost of core for a Hacknet Node | -| [hacknet\_node\_level\_cost](./bitburner.multipliers.hacknet_node_level_cost.md) | | number | Multiplier to cost of leveling up a Hacknet Node | -| [hacknet\_node\_money](./bitburner.multipliers.hacknet_node_money.md) | | number | Multiplier to amount of money produced by Hacknet Nodes | -| [hacknet\_node\_purchase\_cost](./bitburner.multipliers.hacknet_node_purchase_cost.md) | | number | Multiplier to cost of purchasing a Hacknet Node | -| [hacknet\_node\_ram\_cost](./bitburner.multipliers.hacknet_node_ram_cost.md) | | number | Multiplier to cost of ram for a Hacknet Node | -| [strength\_exp](./bitburner.multipliers.strength_exp.md) | | number | Multiplier to strength experience gain rate | -| [strength](./bitburner.multipliers.strength.md) | | number | Multiplier to strength skill | -| [work\_money](./bitburner.multipliers.work_money.md) | | number | Multiplier to amount of money gained from working | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agility\_exp](./bitburner.multipliers.agility_exp.md) + + + + + + + +number + + + + +Multiplier to agility experience gain rate + + +
+ +[agility](./bitburner.multipliers.agility.md) + + + + + + + +number + + + + +Multiplier to agility skill + + +
+ +[bladeburner\_analysis](./bitburner.multipliers.bladeburner_analysis.md) + + + + + + + +number + + + + +Multiplier to effectiveness in Bladeburner Field Analysis + + +
+ +[bladeburner\_max\_stamina](./bitburner.multipliers.bladeburner_max_stamina.md) + + + + + + + +number + + + + +Multiplier to Bladeburner max stamina + + +
+ +[bladeburner\_stamina\_gain](./bitburner.multipliers.bladeburner_stamina_gain.md) + + + + + + + +number + + + + +Multiplier to Bladeburner stamina gain rate + + +
+ +[bladeburner\_success\_chance](./bitburner.multipliers.bladeburner_success_chance.md) + + + + + + + +number + + + + +Multiplier to success chance in Bladeburner contracts/operations + + +
+ +[charisma\_exp](./bitburner.multipliers.charisma_exp.md) + + + + + + + +number + + + + +Multiplier to charisma experience gain rate + + +
+ +[charisma](./bitburner.multipliers.charisma.md) + + + + + + + +number + + + + +Multiplier to charisma skill + + +
+ +[company\_rep](./bitburner.multipliers.company_rep.md) + + + + + + + +number + + + + +Multiplier to amount of reputation gained when working + + +
+ +[crime\_money](./bitburner.multipliers.crime_money.md) + + + + + + + +number + + + + +Multiplier to amount of money gained from crimes + + +
+ +[crime\_success](./bitburner.multipliers.crime_success.md) + + + + + + + +number + + + + +Multiplier to crime success rate + + +
+ +[defense\_exp](./bitburner.multipliers.defense_exp.md) + + + + + + + +number + + + + +Multiplier to defense experience gain rate + + +
+ +[defense](./bitburner.multipliers.defense.md) + + + + + + + +number + + + + +Multiplier to defense skill + + +
+ +[dexterity\_exp](./bitburner.multipliers.dexterity_exp.md) + + + + + + + +number + + + + +Multiplier to dexterity experience gain rate + + +
+ +[dexterity](./bitburner.multipliers.dexterity.md) + + + + + + + +number + + + + +Multiplier to dexterity skill + + +
+ +[faction\_rep](./bitburner.multipliers.faction_rep.md) + + + + + + + +number + + + + +Multiplier to amount of reputation gained when working + + +
+ +[hacking\_chance](./bitburner.multipliers.hacking_chance.md) + + + + + + + +number + + + + +Multiplier to chance of successfully performing a hack + + +
+ +[hacking\_exp](./bitburner.multipliers.hacking_exp.md) + + + + + + + +number + + + + +Multiplier to hacking experience gain rate + + +
+ +[hacking\_grow](./bitburner.multipliers.hacking_grow.md) + + + + + + + +number + + + + +Multiplier to amount of money injected into servers using grow + + +
+ +[hacking\_money](./bitburner.multipliers.hacking_money.md) + + + + + + + +number + + + + +Multiplier to amount of money the player gains from hacking + + +
+ +[hacking\_speed](./bitburner.multipliers.hacking_speed.md) + + + + + + + +number + + + + +Multiplier to hacking speed + + +
+ +[hacking](./bitburner.multipliers.hacking.md) + + + + + + + +number + + + + +Multiplier to hacking skill + + +
+ +[hacknet\_node\_core\_cost](./bitburner.multipliers.hacknet_node_core_cost.md) + + + + + + + +number + + + + +Multiplier to cost of core for a Hacknet Node + + +
+ +[hacknet\_node\_level\_cost](./bitburner.multipliers.hacknet_node_level_cost.md) + + + + + + + +number + + + + +Multiplier to cost of leveling up a Hacknet Node + + +
+ +[hacknet\_node\_money](./bitburner.multipliers.hacknet_node_money.md) + + + + + + + +number + + + + +Multiplier to amount of money produced by Hacknet Nodes + + +
+ +[hacknet\_node\_purchase\_cost](./bitburner.multipliers.hacknet_node_purchase_cost.md) + + + + + + + +number + + + + +Multiplier to cost of purchasing a Hacknet Node + + +
+ +[hacknet\_node\_ram\_cost](./bitburner.multipliers.hacknet_node_ram_cost.md) + + + + + + + +number + + + + +Multiplier to cost of ram for a Hacknet Node + + +
+ +[strength\_exp](./bitburner.multipliers.strength_exp.md) + + + + + + + +number + + + + +Multiplier to strength experience gain rate + + +
+ +[strength](./bitburner.multipliers.strength.md) + + + + + + + +number + + + + +Multiplier to strength skill + + +
+ +[work\_money](./bitburner.multipliers.work_money.md) + + + + + + + +number + + + + +Multiplier to amount of money gained from working + + +
diff --git a/markdown/bitburner.netscriptport.md b/markdown/bitburner.netscriptport.md index 36b606aa6..3b6923f4b 100644 --- a/markdown/bitburner.netscriptport.md +++ b/markdown/bitburner.netscriptport.md @@ -14,14 +14,104 @@ export interface NetscriptPort ## Methods -| Method | Description | -| --- | --- | -| [clear()](./bitburner.netscriptport.clear.md) | Empties all data from the port. | -| [empty()](./bitburner.netscriptport.empty.md) | Check if the port is empty. | -| [full()](./bitburner.netscriptport.full.md) | Check if the port is full. | -| [nextWrite()](./bitburner.netscriptport.nextwrite.md) | Waits until the port is written to. | -| [peek()](./bitburner.netscriptport.peek.md) | Retrieve the first element from the port without removing it. | -| [read()](./bitburner.netscriptport.read.md) | Shift an element out of the port. | -| [tryWrite(value)](./bitburner.netscriptport.trywrite.md) | Attempt to write data to the port. | -| [write(value)](./bitburner.netscriptport.write.md) | Write data to a port. | + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[clear()](./bitburner.netscriptport.clear.md) + + + + +Empties all data from the port. + + +
+ +[empty()](./bitburner.netscriptport.empty.md) + + + + +Check if the port is empty. + + +
+ +[full()](./bitburner.netscriptport.full.md) + + + + +Check if the port is full. + + +
+ +[nextWrite()](./bitburner.netscriptport.nextwrite.md) + + + + +Waits until the port is written to. + + +
+ +[peek()](./bitburner.netscriptport.peek.md) + + + + +Retrieve the first element from the port without removing it. + + +
+ +[read()](./bitburner.netscriptport.read.md) + + + + +Shift an element out of the port. + + +
+ +[tryWrite(value)](./bitburner.netscriptport.trywrite.md) + + + + +Attempt to write data to the port. + + +
+ +[write(value)](./bitburner.netscriptport.write.md) + + + + +Write data to a port. + + +
diff --git a/markdown/bitburner.netscriptport.trywrite.md b/markdown/bitburner.netscriptport.trywrite.md index 92911676a..9625bb4b9 100644 --- a/markdown/bitburner.netscriptport.trywrite.md +++ b/markdown/bitburner.netscriptport.trywrite.md @@ -14,9 +14,39 @@ tryWrite(value: any): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| value | any | Data to write, it's cloned with structuredClone(). | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +value + + + + +any + + + + +Data to write, it's cloned with structuredClone(). + + +
**Returns:** diff --git a/markdown/bitburner.netscriptport.write.md b/markdown/bitburner.netscriptport.write.md index 5fdacf0ee..0d357a096 100644 --- a/markdown/bitburner.netscriptport.write.md +++ b/markdown/bitburner.netscriptport.write.md @@ -14,9 +14,39 @@ write(value: any): any; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| value | any | Data to write, it's cloned with structuredClone(). | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +value + + + + +any + + + + +Data to write, it's cloned with structuredClone(). + + +
**Returns:** diff --git a/markdown/bitburner.nodestats.md b/markdown/bitburner.nodestats.md index 88c5b8100..8d82ba5d0 100644 --- a/markdown/bitburner.nodestats.md +++ b/markdown/bitburner.nodestats.md @@ -14,16 +14,216 @@ interface NodeStats ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [cache?](./bitburner.nodestats.cache.md) | | number | _(Optional)_ Cache level. Only applicable for Hacknet Servers | -| [cores](./bitburner.nodestats.cores.md) | | number | Node's number of cores | -| [hashCapacity?](./bitburner.nodestats.hashcapacity.md) | | number | _(Optional)_ Hash Capacity provided by this Node. Only applicable for Hacknet Servers | -| [level](./bitburner.nodestats.level.md) | | number | Node's level | -| [name](./bitburner.nodestats.name.md) | | string | Node's name | -| [production](./bitburner.nodestats.production.md) | | number | Node's production per second | -| [ram](./bitburner.nodestats.ram.md) | | number | Node's RAM (GB) | -| [ramUsed?](./bitburner.nodestats.ramused.md) | | number | _(Optional)_ Node's used RAM (GB) | -| [timeOnline](./bitburner.nodestats.timeonline.md) | | number | Number of seconds since Node has been purchased | -| [totalProduction](./bitburner.nodestats.totalproduction.md) | | number | Total number of money Node has produced | + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[cache?](./bitburner.nodestats.cache.md) + + + + + + + +number + + + + +_(Optional)_ Cache level. Only applicable for Hacknet Servers + + +
+ +[cores](./bitburner.nodestats.cores.md) + + + + + + + +number + + + + +Node's number of cores + + +
+ +[hashCapacity?](./bitburner.nodestats.hashcapacity.md) + + + + + + + +number + + + + +_(Optional)_ Hash Capacity provided by this Node. Only applicable for Hacknet Servers + + +
+ +[level](./bitburner.nodestats.level.md) + + + + + + + +number + + + + +Node's level + + +
+ +[name](./bitburner.nodestats.name.md) + + + + + + + +string + + + + +Node's name + + +
+ +[production](./bitburner.nodestats.production.md) + + + + + + + +number + + + + +Node's production per second + + +
+ +[ram](./bitburner.nodestats.ram.md) + + + + + + + +number + + + + +Node's RAM (GB) + + +
+ +[ramUsed?](./bitburner.nodestats.ramused.md) + + + + + + + +number + + + + +_(Optional)_ Node's used RAM (GB) + + +
+ +[timeOnline](./bitburner.nodestats.timeonline.md) + + + + + + + +number + + + + +Number of seconds since Node has been purchased + + +
+ +[totalProduction](./bitburner.nodestats.totalproduction.md) + + + + + + + +number + + + + +Total number of money Node has produced + + +
diff --git a/markdown/bitburner.notrequirement.md b/markdown/bitburner.notrequirement.md index bb5aa6fbf..43dee6603 100644 --- a/markdown/bitburner.notrequirement.md +++ b/markdown/bitburner.notrequirement.md @@ -14,8 +14,60 @@ interface NotRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [condition](./bitburner.notrequirement.condition.md) | | [PlayerRequirement](./bitburner.playerrequirement.md) | | -| [type](./bitburner.notrequirement.type.md) | | "not" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[condition](./bitburner.notrequirement.condition.md) + + + + + + + +[PlayerRequirement](./bitburner.playerrequirement.md) + + + + + +
+ +[type](./bitburner.notrequirement.type.md) + + + + + + + +"not" + + + + + +
diff --git a/markdown/bitburner.ns.alert.md b/markdown/bitburner.ns.alert.md index ccdceb3d5..21eedeb54 100644 --- a/markdown/bitburner.ns.alert.md +++ b/markdown/bitburner.ns.alert.md @@ -14,9 +14,39 @@ alert(...args: any[]): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| args | any\[\] | Value(s) to be alerted. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +any\[\] + + + + +Value(s) to be alerted. + + +
**Returns:** diff --git a/markdown/bitburner.ns.asleep.md b/markdown/bitburner.ns.asleep.md index 7b5dee58d..e0a9ac33a 100644 --- a/markdown/bitburner.ns.asleep.md +++ b/markdown/bitburner.ns.asleep.md @@ -14,9 +14,39 @@ asleep(millis?: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| millis | number | _(Optional)_ Number of milliseconds to sleep. Default to 0. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +millis + + + + +number + + + + +_(Optional)_ Number of milliseconds to sleep. Default to 0. + + +
**Returns:** diff --git a/markdown/bitburner.ns.atexit.md b/markdown/bitburner.ns.atexit.md index 3f605ae50..ae71b5006 100644 --- a/markdown/bitburner.ns.atexit.md +++ b/markdown/bitburner.ns.atexit.md @@ -14,10 +14,55 @@ atExit(f: () => void, id?: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| f | () => void | A function to execute when the script dies. | -| id | string | _(Optional)_ Callback ID. Optional, defaults to "default". | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +f + + + + +() => void + + + + +A function to execute when the script dies. + + +
+ +id + + + + +string + + + + +_(Optional)_ Callback ID. Optional, defaults to `"default"`. + + +
**Returns:** diff --git a/markdown/bitburner.ns.brutessh.md b/markdown/bitburner.ns.brutessh.md index 9b2b7e51c..f28e3365c 100644 --- a/markdown/bitburner.ns.brutessh.md +++ b/markdown/bitburner.ns.brutessh.md @@ -14,9 +14,39 @@ brutessh(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.clear.md b/markdown/bitburner.ns.clear.md index 71e502544..784519425 100644 --- a/markdown/bitburner.ns.clear.md +++ b/markdown/bitburner.ns.clear.md @@ -14,9 +14,39 @@ clear(handle: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| handle | string | Text file to clear. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +handle + + + + +string + + + + +Text file to clear. + + +
**Returns:** diff --git a/markdown/bitburner.ns.clearport.md b/markdown/bitburner.ns.clearport.md index 3d36f6d23..fc9a7d081 100644 --- a/markdown/bitburner.ns.clearport.md +++ b/markdown/bitburner.ns.clearport.md @@ -14,9 +14,39 @@ clearPort(portNumber: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| portNumber | number | Port to clear data from. Must be a positive integer. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +portNumber + + + + +number + + + + +Port to clear data from. Must be a positive integer. + + +
**Returns:** diff --git a/markdown/bitburner.ns.deleteserver.md b/markdown/bitburner.ns.deleteserver.md index c346414ba..712e5faf5 100644 --- a/markdown/bitburner.ns.deleteserver.md +++ b/markdown/bitburner.ns.deleteserver.md @@ -14,9 +14,39 @@ deleteServer(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the server to delete. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the server to delete. + + +
**Returns:** diff --git a/markdown/bitburner.ns.disablelog.md b/markdown/bitburner.ns.disablelog.md index a795fdc37..41e1d1fdb 100644 --- a/markdown/bitburner.ns.disablelog.md +++ b/markdown/bitburner.ns.disablelog.md @@ -14,9 +14,39 @@ disableLog(fn: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| fn | string | Name of the NS function for which to disable logging. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +fn + + + + +string + + + + +Name of the NS function for which to disable logging. + + +
**Returns:** diff --git a/markdown/bitburner.ns.dnslookup.md b/markdown/bitburner.ns.dnslookup.md index e95d13773..654ef4873 100644 --- a/markdown/bitburner.ns.dnslookup.md +++ b/markdown/bitburner.ns.dnslookup.md @@ -14,9 +14,39 @@ dnsLookup(host: string): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.dynamicimport.md b/markdown/bitburner.ns.dynamicimport.md index 6af8c98db..5f6c131f0 100644 --- a/markdown/bitburner.ns.dynamicimport.md +++ b/markdown/bitburner.ns.dynamicimport.md @@ -14,9 +14,37 @@ dynamicImport(path: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| path | string | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +path + + + + +string + + + + + +
**Returns:** diff --git a/markdown/bitburner.ns.enablelog.md b/markdown/bitburner.ns.enablelog.md index 33a8aace9..6f1e9adef 100644 --- a/markdown/bitburner.ns.enablelog.md +++ b/markdown/bitburner.ns.enablelog.md @@ -14,9 +14,39 @@ enableLog(fn: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| fn | string | Name of the NS function for which to enable logging. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +fn + + + + +string + + + + +Name of the NS function for which to enable logging. + + +
**Returns:** diff --git a/markdown/bitburner.ns.exec.md b/markdown/bitburner.ns.exec.md index 539994282..9c4074d30 100644 --- a/markdown/bitburner.ns.exec.md +++ b/markdown/bitburner.ns.exec.md @@ -14,12 +14,87 @@ exec(script: string, host: string, threadOrOptions?: number | RunOptions, ...arg ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | string | Filename of script to execute. This file must already exist on the target server. | -| host | string | Hostname/IP of the target server on which to execute the script. | -| threadOrOptions | number \| [RunOptions](./bitburner.runoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument threadOrOptions must be filled in with a value. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +string + + + + +Filename of script to execute. This file must already exist on the target server. + + +
+ +host + + + + +string + + + + +Hostname/IP of the `target server` on which to execute the script. + + +
+ +threadOrOptions + + + + +number \| [RunOptions](./bitburner.runoptions.md) + + + + +_(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument threadOrOptions must be filled in with a value. + + +
**Returns:** diff --git a/markdown/bitburner.ns.fileexists.md b/markdown/bitburner.ns.fileexists.md index 1c8294707..994c4979e 100644 --- a/markdown/bitburner.ns.fileexists.md +++ b/markdown/bitburner.ns.fileexists.md @@ -14,10 +14,55 @@ fileExists(filename: string, host?: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Filename of file to check. | -| host | string | _(Optional)_ Hostname/IP of target server. Optional, defaults to the server the script is running on. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Filename of file to check. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of target server. Optional, defaults to the server the script is running on. + + +
**Returns:** diff --git a/markdown/bitburner.ns.flags.md b/markdown/bitburner.ns.flags.md index ec8e83bc5..e03efccc9 100644 --- a/markdown/bitburner.ns.flags.md +++ b/markdown/bitburner.ns.flags.md @@ -14,9 +14,37 @@ flags(schema: [string, string | number | boolean | string[]][]): { [key: string] ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +schema + + + + +\[string, string \| number \| boolean \| string\[\]\]\[\] + + + + + +
**Returns:** diff --git a/markdown/bitburner.ns.ftpcrack.md b/markdown/bitburner.ns.ftpcrack.md index 6461751c9..f95bfd0a4 100644 --- a/markdown/bitburner.ns.ftpcrack.md +++ b/markdown/bitburner.ns.ftpcrack.md @@ -14,9 +14,39 @@ ftpcrack(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getbitnodemultipliers.md b/markdown/bitburner.ns.getbitnodemultipliers.md index 212add578..0eabb1a2d 100644 --- a/markdown/bitburner.ns.getbitnodemultipliers.md +++ b/markdown/bitburner.ns.getbitnodemultipliers.md @@ -14,10 +14,55 @@ getBitNodeMultipliers(n?: number, lvl?: number): BitNodeMultipliers; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| n | number | _(Optional)_ | -| lvl | number | _(Optional)_ | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +n + + + + +number + + + + +_(Optional)_ + + +
+ +lvl + + + + +number + + + + +_(Optional)_ + + +
**Returns:** diff --git a/markdown/bitburner.ns.getfilemetadata.md b/markdown/bitburner.ns.getfilemetadata.md index cbcc22d13..fcd0f047c 100644 --- a/markdown/bitburner.ns.getfilemetadata.md +++ b/markdown/bitburner.ns.getfilemetadata.md @@ -14,9 +14,39 @@ getFileMetadata(filename: string): FileMetadata; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Name of the file to read the metadata from. It must be a text file (.txt, .json) or a script (.js, .jsx, .ts, .tsx). | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Name of the file to read the metadata from. It must be a text file (.txt, .json) or a script (.js, .jsx, .ts, .tsx). + + +
**Returns:** diff --git a/markdown/bitburner.ns.getfunctionramcost.md b/markdown/bitburner.ns.getfunctionramcost.md index 72d2cc2d2..fc0afe171 100644 --- a/markdown/bitburner.ns.getfunctionramcost.md +++ b/markdown/bitburner.ns.getfunctionramcost.md @@ -14,9 +14,39 @@ getFunctionRamCost(name: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | The fully-qualified function name, without the leading ns. Example inputs: hack, tprint, stock.getPosition. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +name + + + + +string + + + + +The fully-qualified function name, without the leading `ns`. Example inputs: `hack`, `tprint`, `stock.getPosition`. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getgrowtime.md b/markdown/bitburner.ns.getgrowtime.md index 46690896f..140157605 100644 --- a/markdown/bitburner.ns.getgrowtime.md +++ b/markdown/bitburner.ns.getgrowtime.md @@ -14,9 +14,39 @@ getGrowTime(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.gethacktime.md b/markdown/bitburner.ns.gethacktime.md index 3b0750eaa..b28eae569 100644 --- a/markdown/bitburner.ns.gethacktime.md +++ b/markdown/bitburner.ns.gethacktime.md @@ -14,9 +14,39 @@ getHackTime(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getporthandle.md b/markdown/bitburner.ns.getporthandle.md index 86c87f41d..05a7d2900 100644 --- a/markdown/bitburner.ns.getporthandle.md +++ b/markdown/bitburner.ns.getporthandle.md @@ -14,9 +14,39 @@ getPortHandle(portNumber: number): NetscriptPort; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| portNumber | number | Port number. Must be a positive integer. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +portNumber + + + + +number + + + + +Port number. Must be a positive integer. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getpurchasedservercost.md b/markdown/bitburner.ns.getpurchasedservercost.md index 6c8fd7442..8b86cc228 100644 --- a/markdown/bitburner.ns.getpurchasedservercost.md +++ b/markdown/bitburner.ns.getpurchasedservercost.md @@ -14,9 +14,39 @@ getPurchasedServerCost(ram: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| ram | number | Amount of RAM of a potential purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +ram + + + + +number + + + + +Amount of RAM of a potential purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + + +
**Returns:** diff --git a/markdown/bitburner.ns.getpurchasedservers.md b/markdown/bitburner.ns.getpurchasedservers.md index c144645d5..9a35590e9 100644 --- a/markdown/bitburner.ns.getpurchasedservers.md +++ b/markdown/bitburner.ns.getpurchasedservers.md @@ -14,9 +14,39 @@ getPurchasedServers(returnOpts?: HostReturnOptions): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| returnOpts | [HostReturnOptions](./bitburner.hostreturnoptions.md) | _(Optional)_ Optional. Controls whether the function returns IPs | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +returnOpts + + + + +[HostReturnOptions](./bitburner.hostreturnoptions.md) + + + + +_(Optional)_ Optional. Controls whether the function returns IPs + + +
**Returns:** diff --git a/markdown/bitburner.ns.getpurchasedserverupgradecost.md b/markdown/bitburner.ns.getpurchasedserverupgradecost.md index 04d22feeb..dc10a3d8e 100644 --- a/markdown/bitburner.ns.getpurchasedserverupgradecost.md +++ b/markdown/bitburner.ns.getpurchasedserverupgradecost.md @@ -14,10 +14,55 @@ getPurchasedServerUpgradeCost(host: string, ram: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the server to upgrade. | -| ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the server to upgrade. + + +
+ +ram + + + + +number + + + + +Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + + +
**Returns:** diff --git a/markdown/bitburner.ns.getrunningscript.md b/markdown/bitburner.ns.getrunningscript.md index 81eb0a610..4937ed7d7 100644 --- a/markdown/bitburner.ns.getrunningscript.md +++ b/markdown/bitburner.ns.getrunningscript.md @@ -14,11 +14,71 @@ getRunningScript(filename?: FilenameOrPID, host?: string, ...args: ScriptArg[]): ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of the script. | -| host | string | _(Optional)_ Hostname/IP of target server. Optional, defaults to the server the calling script is running on. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +[FilenameOrPID](./bitburner.filenameorpid.md) + + + + +_(Optional)_ Optional. Filename or PID of the script. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of target server. Optional, defaults to the server the calling script is running on. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getscriptexpgain.md b/markdown/bitburner.ns.getscriptexpgain.md index 08628a1d9..a9ce19675 100644 --- a/markdown/bitburner.ns.getscriptexpgain.md +++ b/markdown/bitburner.ns.getscriptexpgain.md @@ -14,11 +14,71 @@ getScriptExpGain(script: string, host: string, ...args: ScriptArg[]): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | string | Filename of script. | -| host | string | Hostname/IP of the server on which script is running. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments that the script is running with. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +string + + + + +Filename of script. + + +
+ +host + + + + +string + + + + +Hostname/IP of the server on which script is running. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments that the script is running with. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getscriptincome.md b/markdown/bitburner.ns.getscriptincome.md index 93a3badf2..14a54fe1e 100644 --- a/markdown/bitburner.ns.getscriptincome.md +++ b/markdown/bitburner.ns.getscriptincome.md @@ -14,11 +14,71 @@ getScriptIncome(script: string, host: string, ...args: ScriptArg[]): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | string | Filename of script. | -| host | string | Hostname/IP of the server on which script is running. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments that the script is running with. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +string + + + + +Filename of script. + + +
+ +host + + + + +string + + + + +Hostname/IP of the server on which script is running. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments that the script is running with. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getscriptlogs.md b/markdown/bitburner.ns.getscriptlogs.md index e7fcd3a26..dcdaf9dbb 100644 --- a/markdown/bitburner.ns.getscriptlogs.md +++ b/markdown/bitburner.ns.getscriptlogs.md @@ -14,11 +14,71 @@ getScriptLogs(fn?: FilenameOrPID, host?: string, ...args: ScriptArg[]): string[] ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of script to get logs from. | -| host | string | _(Optional)_ Optional. Hostname/IP of the server that the script is on. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments to identify which scripts to get logs for. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +fn + + + + +[FilenameOrPID](./bitburner.filenameorpid.md) + + + + +_(Optional)_ Optional. Filename or PID of script to get logs from. + + +
+ +host + + + + +string + + + + +_(Optional)_ Optional. Hostname/IP of the server that the script is on. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments to identify which scripts to get logs for. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getscriptram.md b/markdown/bitburner.ns.getscriptram.md index c7af39268..be6951d31 100644 --- a/markdown/bitburner.ns.getscriptram.md +++ b/markdown/bitburner.ns.getscriptram.md @@ -14,10 +14,55 @@ getScriptRam(script: string, host?: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | string | Filename of script. This is case-sensitive. | -| host | string | _(Optional)_ Hostname/IP of target server the script is located on. This is optional. If it is not specified then the function will use the current server as the target server. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +string + + + + +Filename of script. This is case-sensitive. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of target server the script is located on. This is optional. If it is not specified then the function will use the current server as the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getserver.md b/markdown/bitburner.ns.getserver.md index 8bd044a22..b34b7e30c 100644 --- a/markdown/bitburner.ns.getserver.md +++ b/markdown/bitburner.ns.getserver.md @@ -14,9 +14,39 @@ getServer(host?: string): Server; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | _(Optional)_ Optional. Hostname/IP for the requested server object. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +_(Optional)_ Optional. Hostname/IP for the requested server object. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getserverbasesecuritylevel.md b/markdown/bitburner.ns.getserverbasesecuritylevel.md index 0b028aafb..5cfdb352c 100644 --- a/markdown/bitburner.ns.getserverbasesecuritylevel.md +++ b/markdown/bitburner.ns.getserverbasesecuritylevel.md @@ -14,9 +14,39 @@ getServerBaseSecurityLevel(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getservergrowth.md b/markdown/bitburner.ns.getservergrowth.md index d2ce5dbbd..cec8689ab 100644 --- a/markdown/bitburner.ns.getservergrowth.md +++ b/markdown/bitburner.ns.getservergrowth.md @@ -14,9 +14,39 @@ getServerGrowth(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getservermaxmoney.md b/markdown/bitburner.ns.getservermaxmoney.md index d35b0688d..3e36c5a5a 100644 --- a/markdown/bitburner.ns.getservermaxmoney.md +++ b/markdown/bitburner.ns.getservermaxmoney.md @@ -14,9 +14,39 @@ getServerMaxMoney(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getservermaxram.md b/markdown/bitburner.ns.getservermaxram.md index bd9d6a0ba..5c8c13689 100644 --- a/markdown/bitburner.ns.getservermaxram.md +++ b/markdown/bitburner.ns.getservermaxram.md @@ -14,9 +14,39 @@ getServerMaxRam(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getserverminsecuritylevel.md b/markdown/bitburner.ns.getserverminsecuritylevel.md index fdeeaf0e8..d181f3f1a 100644 --- a/markdown/bitburner.ns.getserverminsecuritylevel.md +++ b/markdown/bitburner.ns.getserverminsecuritylevel.md @@ -14,9 +14,39 @@ getServerMinSecurityLevel(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getservermoneyavailable.md b/markdown/bitburner.ns.getservermoneyavailable.md index 90ba01799..8e4bcc932 100644 --- a/markdown/bitburner.ns.getservermoneyavailable.md +++ b/markdown/bitburner.ns.getservermoneyavailable.md @@ -14,9 +14,39 @@ getServerMoneyAvailable(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getservernumportsrequired.md b/markdown/bitburner.ns.getservernumportsrequired.md index 386bd586d..1eb4c088c 100644 --- a/markdown/bitburner.ns.getservernumportsrequired.md +++ b/markdown/bitburner.ns.getservernumportsrequired.md @@ -14,9 +14,39 @@ getServerNumPortsRequired(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getserverrequiredhackinglevel.md b/markdown/bitburner.ns.getserverrequiredhackinglevel.md index cb0b0cfaa..847c1e993 100644 --- a/markdown/bitburner.ns.getserverrequiredhackinglevel.md +++ b/markdown/bitburner.ns.getserverrequiredhackinglevel.md @@ -14,9 +14,39 @@ getServerRequiredHackingLevel(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getserversecuritylevel.md b/markdown/bitburner.ns.getserversecuritylevel.md index dd618d5c6..faf5ba3db 100644 --- a/markdown/bitburner.ns.getserversecuritylevel.md +++ b/markdown/bitburner.ns.getserversecuritylevel.md @@ -14,9 +14,39 @@ getServerSecurityLevel(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getserverusedram.md b/markdown/bitburner.ns.getserverusedram.md index bae3f47fb..ef4c03893 100644 --- a/markdown/bitburner.ns.getserverusedram.md +++ b/markdown/bitburner.ns.getserverusedram.md @@ -14,9 +14,39 @@ getServerUsedRam(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.getweakentime.md b/markdown/bitburner.ns.getweakentime.md index 193d2b6bd..9f5a09b81 100644 --- a/markdown/bitburner.ns.getweakentime.md +++ b/markdown/bitburner.ns.getweakentime.md @@ -14,9 +14,39 @@ getWeakenTime(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.grow.md b/markdown/bitburner.ns.grow.md index e8254ca50..bb84f075f 100644 --- a/markdown/bitburner.ns.grow.md +++ b/markdown/bitburner.ns.grow.md @@ -14,10 +14,55 @@ grow(host: string, opts?: BasicHGWOptions): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server to grow. | -| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | _(Optional)_ Optional parameters for configuring function behavior. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server to grow. + + +
+ +opts + + + + +[BasicHGWOptions](./bitburner.basichgwoptions.md) + + + + +_(Optional)_ Optional parameters for configuring function behavior. + + +
**Returns:** diff --git a/markdown/bitburner.ns.growthanalyze.md b/markdown/bitburner.ns.growthanalyze.md index a19465b02..e51d1c878 100644 --- a/markdown/bitburner.ns.growthanalyze.md +++ b/markdown/bitburner.ns.growthanalyze.md @@ -14,11 +14,71 @@ growthAnalyze(host: string, multiplier: number, cores?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | -| multiplier | number | Multiplier that will be applied to a server's money after applying additive growth. Decimal form. | -| cores | number | _(Optional)_ Number of cores on the host running the grow function. Optional, defaults to 1. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
+ +multiplier + + + + +number + + + + +Multiplier that will be applied to a server's money after applying additive growth. Decimal form. + + +
+ +cores + + + + +number + + + + +_(Optional)_ Number of cores on the host running the grow function. Optional, defaults to 1. + + +
**Returns:** diff --git a/markdown/bitburner.ns.growthanalyzesecurity.md b/markdown/bitburner.ns.growthanalyzesecurity.md index ec4ec5143..b9a4e795e 100644 --- a/markdown/bitburner.ns.growthanalyzesecurity.md +++ b/markdown/bitburner.ns.growthanalyzesecurity.md @@ -14,11 +14,71 @@ growthAnalyzeSecurity(threads: number, host?: string, cores?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| threads | number | Amount of threads that will be used. | -| host | string | _(Optional)_ Optional. Hostname/IP of the target server. If provided, security increase is limited by the number of threads needed to reach maximum money. | -| cores | number | _(Optional)_ Optional. The number of cores of the server that would run grow. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +threads + + + + +number + + + + +Amount of threads that will be used. + + +
+ +host + + + + +string + + + + +_(Optional)_ Optional. Hostname/IP of the target server. If provided, security increase is limited by the number of threads needed to reach maximum money. + + +
+ +cores + + + + +number + + + + +_(Optional)_ Optional. The number of cores of the server that would run grow. + + +
**Returns:** diff --git a/markdown/bitburner.ns.hack.md b/markdown/bitburner.ns.hack.md index cbecb0705..00e80e535 100644 --- a/markdown/bitburner.ns.hack.md +++ b/markdown/bitburner.ns.hack.md @@ -14,10 +14,55 @@ hack(host: string, opts?: BasicHGWOptions): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server to hack. | -| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | _(Optional)_ Optional parameters for configuring function behavior. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server to hack. + + +
+ +opts + + + + +[BasicHGWOptions](./bitburner.basichgwoptions.md) + + + + +_(Optional)_ Optional parameters for configuring function behavior. + + +
**Returns:** diff --git a/markdown/bitburner.ns.hackanalyze.md b/markdown/bitburner.ns.hackanalyze.md index f7c235d0f..7ccd39c09 100644 --- a/markdown/bitburner.ns.hackanalyze.md +++ b/markdown/bitburner.ns.hackanalyze.md @@ -14,9 +14,39 @@ hackAnalyze(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.hackanalyzechance.md b/markdown/bitburner.ns.hackanalyzechance.md index bd4190686..ec820846e 100644 --- a/markdown/bitburner.ns.hackanalyzechance.md +++ b/markdown/bitburner.ns.hackanalyzechance.md @@ -14,9 +14,39 @@ hackAnalyzeChance(host: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.hackanalyzesecurity.md b/markdown/bitburner.ns.hackanalyzesecurity.md index ec969d564..e520be0fd 100644 --- a/markdown/bitburner.ns.hackanalyzesecurity.md +++ b/markdown/bitburner.ns.hackanalyzesecurity.md @@ -14,10 +14,55 @@ hackAnalyzeSecurity(threads: number, host?: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| threads | number | Amount of threads that will be used. | -| host | string | _(Optional)_ Hostname/IP of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +threads + + + + +number + + + + +Amount of threads that will be used. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. + + +
**Returns:** diff --git a/markdown/bitburner.ns.hackanalyzethreads.md b/markdown/bitburner.ns.hackanalyzethreads.md index 5f2245163..d8de0a9aa 100644 --- a/markdown/bitburner.ns.hackanalyzethreads.md +++ b/markdown/bitburner.ns.hackanalyzethreads.md @@ -14,10 +14,55 @@ hackAnalyzeThreads(host: string, hackAmount: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname of the target server to analyze. | -| hackAmount | number | Amount of money you want to hack from the server. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname of the target server to analyze. + + +
+ +hackAmount + + + + +number + + + + +Amount of money you want to hack from the server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.hasrootaccess.md b/markdown/bitburner.ns.hasrootaccess.md index c709a0cec..112645d4e 100644 --- a/markdown/bitburner.ns.hasrootaccess.md +++ b/markdown/bitburner.ns.hasrootaccess.md @@ -14,9 +14,39 @@ hasRootAccess(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.httpworm.md b/markdown/bitburner.ns.httpworm.md index 0542ee64a..a0a84dfd7 100644 --- a/markdown/bitburner.ns.httpworm.md +++ b/markdown/bitburner.ns.httpworm.md @@ -14,9 +14,39 @@ httpworm(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.islogenabled.md b/markdown/bitburner.ns.islogenabled.md index aa01bfdce..72b86346c 100644 --- a/markdown/bitburner.ns.islogenabled.md +++ b/markdown/bitburner.ns.islogenabled.md @@ -14,9 +14,39 @@ isLogEnabled(fn: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| fn | string | Name of function to check. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +fn + + + + +string + + + + +Name of function to check. + + +
**Returns:** diff --git a/markdown/bitburner.ns.isrunning.md b/markdown/bitburner.ns.isrunning.md index 58cb42244..4e6c69140 100644 --- a/markdown/bitburner.ns.isrunning.md +++ b/markdown/bitburner.ns.isrunning.md @@ -14,11 +14,71 @@ isRunning(script: FilenameOrPID, host?: string, ...args: ScriptArg[]): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. | -| host | string | _(Optional)_ Hostname/IP of target server. Optional, defaults to the server the calling script is running on. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +[FilenameOrPID](./bitburner.filenameorpid.md) + + + + +Filename or PID of script to check. This is case-sensitive. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of target server. Optional, defaults to the server the calling script is running on. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments to specify/identify the script. Optional, when looking for scripts run without arguments. + + +
**Returns:** diff --git a/markdown/bitburner.ns.kill.md b/markdown/bitburner.ns.kill.md index 01f00973f..df191e6c6 100644 --- a/markdown/bitburner.ns.kill.md +++ b/markdown/bitburner.ns.kill.md @@ -14,9 +14,39 @@ kill(pid: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| pid | number | The PID of the script to kill. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +pid + + + + +number + + + + +The PID of the script to kill. + + +
**Returns:** diff --git a/markdown/bitburner.ns.kill_1.md b/markdown/bitburner.ns.kill_1.md index a915d12e8..1a73f81f6 100644 --- a/markdown/bitburner.ns.kill_1.md +++ b/markdown/bitburner.ns.kill_1.md @@ -14,11 +14,71 @@ kill(filename: string, host?: string, ...args: ScriptArg[]): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Filename of the script to kill. | -| host | string | _(Optional)_ Hostname/IP where the script to kill is running. Defaults to the current server. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments of the script to kill. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Filename of the script to kill. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP where the script to kill is running. Defaults to the current server. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments of the script to kill. + + +
**Returns:** diff --git a/markdown/bitburner.ns.killall.md b/markdown/bitburner.ns.killall.md index f8ab5bb83..dd8a55e46 100644 --- a/markdown/bitburner.ns.killall.md +++ b/markdown/bitburner.ns.killall.md @@ -14,10 +14,55 @@ killall(host?: string, safetyGuard?: boolean): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | _(Optional)_ Hostname/IP of the server on which to kill all scripts. | -| safetyGuard | boolean | _(Optional)_ Skips the script that calls this function | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the server on which to kill all scripts. + + +
+ +safetyGuard + + + + +boolean + + + + +_(Optional)_ Skips the script that calls this function + + +
**Returns:** diff --git a/markdown/bitburner.ns.ls.md b/markdown/bitburner.ns.ls.md index 90f51e336..ade1588e1 100644 --- a/markdown/bitburner.ns.ls.md +++ b/markdown/bitburner.ns.ls.md @@ -14,10 +14,55 @@ ls(host: string, substring?: string): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | -| substring | string | _(Optional)_ A substring to search for in the filename. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
+ +substring + + + + +string + + + + +_(Optional)_ A substring to search for in the filename. + + +
**Returns:** diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index 778688b2a..bb95d3d65 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -29,146 +29,1710 @@ export async function main(ns) { ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [args](./bitburner.ns.args.md) | readonly | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments passed into the script. | -| [bladeburner](./bitburner.ns.bladeburner.md) | readonly | [Bladeburner](./bitburner.bladeburner.md) | Namespace for [Bladeburner](./bitburner.bladeburner.md) functions. Contains spoilers. | -| [codingcontract](./bitburner.ns.codingcontract.md) | readonly | [CodingContract](./bitburner.codingcontract.md) | Namespace for [coding contract](./bitburner.codingcontract.md) functions. | -| [corporation](./bitburner.ns.corporation.md) | readonly | [Corporation](./bitburner.corporation.md) | Namespace for [corporation](./bitburner.corporation.md) functions. Contains spoilers. | -| [enums](./bitburner.ns.enums.md) | | [NSEnums](./bitburner.nsenums.md) | | -| [format](./bitburner.ns.format.md) | readonly | [Format](./bitburner.format.md) | Namespace for [formatting](./bitburner.format.md) functions. | -| [formulas](./bitburner.ns.formulas.md) | readonly | [Formulas](./bitburner.formulas.md) | Namespace for [formulas](./bitburner.formulas.md) functions. | -| [gang](./bitburner.ns.gang.md) | readonly | [Gang](./bitburner.gang.md) | Namespace for [gang](./bitburner.gang.md) functions. Contains spoilers. | -| [go](./bitburner.ns.go.md) | readonly | [Go](./bitburner.go.md) | Namespace for [Go](./bitburner.go.md) functions. | -| [grafting](./bitburner.ns.grafting.md) | readonly | [Grafting](./bitburner.grafting.md) | Namespace for [grafting](./bitburner.grafting.md) functions. Contains spoilers. | -| [hacknet](./bitburner.ns.hacknet.md) | readonly | [Hacknet](./bitburner.hacknet.md) | Namespace for [hacknet](./bitburner.hacknet.md) functions. Some of this API contains spoilers. | -| [heart](./bitburner.ns.heart.md) | readonly | { break(): number; } | | -| [infiltration](./bitburner.ns.infiltration.md) | readonly | [Infiltration](./bitburner.infiltration.md) | Namespace for [infiltration](./bitburner.infiltration.md) functions. | -| [pid](./bitburner.ns.pid.md) | readonly | number | The current script's PID | -| [singularity](./bitburner.ns.singularity.md) | readonly | [Singularity](./bitburner.singularity.md) | Namespace for [singularity](./bitburner.singularity.md) functions. Contains spoilers. | -| [sleeve](./bitburner.ns.sleeve.md) | readonly | [Sleeve](./bitburner.sleeve.md) | Namespace for [sleeve](./bitburner.sleeve.md) functions. Contains spoilers. | -| [stanek](./bitburner.ns.stanek.md) | readonly | [Stanek](./bitburner.stanek.md) | Namespace for [Stanek](./bitburner.stanek.md) functions. Contains spoilers. | -| [stock](./bitburner.ns.stock.md) | readonly | [TIX](./bitburner.tix.md) | Namespace for [stock](./bitburner.tix.md) functions. | -| [ui](./bitburner.ns.ui.md) | readonly | [UserInterface](./bitburner.userinterface.md) | Namespace for [user interface](./bitburner.userinterface.md) functions. | + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[args](./bitburner.ns.args.md) + + + + +`readonly` + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments passed into the script. + + +
+ +[bladeburner](./bitburner.ns.bladeburner.md) + + + + +`readonly` + + + + +[Bladeburner](./bitburner.bladeburner.md) + + + + +Namespace for [Bladeburner](./bitburner.bladeburner.md) functions. Contains spoilers. + + +
+ +[codingcontract](./bitburner.ns.codingcontract.md) + + + + +`readonly` + + + + +[CodingContract](./bitburner.codingcontract.md) + + + + +Namespace for [coding contract](./bitburner.codingcontract.md) functions. + + +
+ +[corporation](./bitburner.ns.corporation.md) + + + + +`readonly` + + + + +[Corporation](./bitburner.corporation.md) + + + + +Namespace for [corporation](./bitburner.corporation.md) functions. Contains spoilers. + + +
+ +[enums](./bitburner.ns.enums.md) + + + + + + + +[NSEnums](./bitburner.nsenums.md) + + + + + +
+ +[format](./bitburner.ns.format.md) + + + + +`readonly` + + + + +[Format](./bitburner.format.md) + + + + +Namespace for [formatting](./bitburner.format.md) functions. + + +
+ +[formulas](./bitburner.ns.formulas.md) + + + + +`readonly` + + + + +[Formulas](./bitburner.formulas.md) + + + + +Namespace for [formulas](./bitburner.formulas.md) functions. + + +
+ +[gang](./bitburner.ns.gang.md) + + + + +`readonly` + + + + +[Gang](./bitburner.gang.md) + + + + +Namespace for [gang](./bitburner.gang.md) functions. Contains spoilers. + + +
+ +[go](./bitburner.ns.go.md) + + + + +`readonly` + + + + +[Go](./bitburner.go.md) + + + + +Namespace for [Go](./bitburner.go.md) functions. + + +
+ +[grafting](./bitburner.ns.grafting.md) + + + + +`readonly` + + + + +[Grafting](./bitburner.grafting.md) + + + + +Namespace for [grafting](./bitburner.grafting.md) functions. Contains spoilers. + + +
+ +[hacknet](./bitburner.ns.hacknet.md) + + + + +`readonly` + + + + +[Hacknet](./bitburner.hacknet.md) + + + + +Namespace for [hacknet](./bitburner.hacknet.md) functions. Some of this API contains spoilers. + + +
+ +[heart](./bitburner.ns.heart.md) + + + + +`readonly` + + + + +{ break(): number; } + + + + + +
+ +[infiltration](./bitburner.ns.infiltration.md) + + + + +`readonly` + + + + +[Infiltration](./bitburner.infiltration.md) + + + + +Namespace for [infiltration](./bitburner.infiltration.md) functions. + + +
+ +[pid](./bitburner.ns.pid.md) + + + + +`readonly` + + + + +number + + + + +The current script's PID + + +
+ +[singularity](./bitburner.ns.singularity.md) + + + + +`readonly` + + + + +[Singularity](./bitburner.singularity.md) + + + + +Namespace for [singularity](./bitburner.singularity.md) functions. Contains spoilers. + + +
+ +[sleeve](./bitburner.ns.sleeve.md) + + + + +`readonly` + + + + +[Sleeve](./bitburner.sleeve.md) + + + + +Namespace for [sleeve](./bitburner.sleeve.md) functions. Contains spoilers. + + +
+ +[stanek](./bitburner.ns.stanek.md) + + + + +`readonly` + + + + +[Stanek](./bitburner.stanek.md) + + + + +Namespace for [Stanek](./bitburner.stanek.md) functions. Contains spoilers. + + +
+ +[stock](./bitburner.ns.stock.md) + + + + +`readonly` + + + + +[TIX](./bitburner.tix.md) + + + + +Namespace for [stock](./bitburner.tix.md) functions. + + +
+ +[ui](./bitburner.ns.ui.md) + + + + +`readonly` + + + + +[UserInterface](./bitburner.userinterface.md) + + + + +Namespace for [user interface](./bitburner.userinterface.md) functions. + + +
## Methods -| Method | Description | -| --- | --- | -| [alert(args)](./bitburner.ns.alert.md) | Open up a message box. | -| [asleep(millis)](./bitburner.ns.asleep.md) | Suspends the script for n milliseconds. Doesn't block with concurrent calls. | -| [atExit(f, id)](./bitburner.ns.atexit.md) | Add a callback to be executed when the script dies. | -| [brutessh(host)](./bitburner.ns.brutessh.md) | Runs BruteSSH.exe on a server. | -| [clear(handle)](./bitburner.ns.clear.md) | Clear data from a file. | -| [clearLog()](./bitburner.ns.clearlog.md) | Clears the script’s logs. | -| [clearPort(portNumber)](./bitburner.ns.clearport.md) | Clear data from a port. | -| [deleteServer(host)](./bitburner.ns.deleteserver.md) | Delete a purchased server. | -| [disableLog(fn)](./bitburner.ns.disablelog.md) | Disables logging for the given NS function. | -| [dnsLookup(host)](./bitburner.ns.dnslookup.md) | Given a hostname, returns its IP address; or given an IP address, returns its hostname. | -| [dynamicImport(path)](./bitburner.ns.dynamicimport.md) | Dynamically import a script. Only scripts located on the same server can be imported. A dynamic import will not adjust RAM usage. This must be done manually with [ramOverride](./bitburner.ns.ramoverride.md). | -| [enableLog(fn)](./bitburner.ns.enablelog.md) | Enables logging for the given NS function. | -| [exec(script, host, threadOrOptions, args)](./bitburner.ns.exec.md) | Start another script on any server. | -| [exit()](./bitburner.ns.exit.md) | Terminates the current script immediately. | -| [fileExists(filename, host)](./bitburner.ns.fileexists.md) | Check if a file exists. | -| [flags(schema)](./bitburner.ns.flags.md) | Parse command line flags. | -| [ftpcrack(host)](./bitburner.ns.ftpcrack.md) | Runs FTPCrack.exe on a server. | -| [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. | -| [getFileMetadata(filename)](./bitburner.ns.getfilemetadata.md) | Get the metadata of a file. | -| [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. | -| [getHackingLevel()](./bitburner.ns.gethackinglevel.md) | Returns the player’s current hacking level. | -| [getHackingMultipliers()](./bitburner.ns.gethackingmultipliers.md) | Get hacking related multipliers. | -| [getHacknetMultipliers()](./bitburner.ns.gethacknetmultipliers.md) | Get hacknet related multipliers. | -| [getHackTime(host)](./bitburner.ns.gethacktime.md) | Get the execution time of a hack() call. | -| [getHostname()](./bitburner.ns.gethostname.md) | Returns a string with the hostname of the server that the script is running on. | -| [getIP()](./bitburner.ns.getip.md) | Returns a string with the IP address of the server that the script is running on. | -| [getMoneySources()](./bitburner.ns.getmoneysources.md) | Get information about the sources of income for this run. | -| [getPlayer()](./bitburner.ns.getplayer.md) | Get information about the player. | -| [getPortHandle(portNumber)](./bitburner.ns.getporthandle.md) | Get all data on a port. | -| [getPurchasedServerCost(ram)](./bitburner.ns.getpurchasedservercost.md) | Get cost of purchasing a server. | -| [getPurchasedServerLimit()](./bitburner.ns.getpurchasedserverlimit.md) | Returns the maximum number of servers you can purchase. | -| [getPurchasedServerMaxRam()](./bitburner.ns.getpurchasedservermaxram.md) | Returns the maximum RAM that a purchased server can have. | -| [getPurchasedServers(returnOpts)](./bitburner.ns.getpurchasedservers.md) | Returns an array with the hostnames or IP addresses of all of the servers you have purchased. Returns hostnames by default. | -| [getPurchasedServerUpgradeCost(host, ram)](./bitburner.ns.getpurchasedserverupgradecost.md) | Get cost of upgrading a purchased server to the given ram. | -| [getRecentScripts()](./bitburner.ns.getrecentscripts.md) | Get an array of recently killed scripts across all servers. | -| [getResetInfo()](./bitburner.ns.getresetinfo.md) | Get information about resets. | -| [getRunningScript(filename, host, args)](./bitburner.ns.getrunningscript.md) | Get general info about a running script. | -| [getScriptExpGain(script, host, args)](./bitburner.ns.getscriptexpgain.md) | Get the exp gain of a script. | -| [getScriptIncome(script, host, args)](./bitburner.ns.getscriptincome.md) | Get the income of a script. | -| [getScriptLogs(fn, host, args)](./bitburner.ns.getscriptlogs.md) | Get all the logs of a script. | -| [getScriptName()](./bitburner.ns.getscriptname.md) | Returns the current script name. | -| [getScriptRam(script, host)](./bitburner.ns.getscriptram.md) | Get the ram cost of a script. | -| [getServer(host)](./bitburner.ns.getserver.md) | Returns a server object for the given server. Defaults to the running script's server if host is not specified. | -| [getServerBaseSecurityLevel(host)](./bitburner.ns.getserverbasesecuritylevel.md) | Get the base security level of a server. | -| [getServerGrowth(host)](./bitburner.ns.getservergrowth.md) | Get a server growth parameter. | -| [getServerMaxMoney(host)](./bitburner.ns.getservermaxmoney.md) | Get the maximum money available on a server. | -| [getServerMaxRam(host)](./bitburner.ns.getservermaxram.md) | Get the maximum amount of RAM on a server. | -| [getServerMinSecurityLevel(host)](./bitburner.ns.getserverminsecuritylevel.md) | Returns the minimum security level of the target server. | -| [getServerMoneyAvailable(host)](./bitburner.ns.getservermoneyavailable.md) | Get money available on a server. | -| [getServerNumPortsRequired(host)](./bitburner.ns.getservernumportsrequired.md) | Returns the number of open ports required to successfully run NUKE.exe on the specified server. | -| [getServerRequiredHackingLevel(host)](./bitburner.ns.getserverrequiredhackinglevel.md) | Returns the required hacking level of the target server. | -| [getServerSecurityLevel(host)](./bitburner.ns.getserversecuritylevel.md) | Get server security level. | -| [getServerUsedRam(host)](./bitburner.ns.getserverusedram.md) | Get the used RAM on a server. | -| [getSharePower()](./bitburner.ns.getsharepower.md) | Share power has a multiplicative effect on rep/second while doing work for a faction. Share power increases incrementally for every thread of share running on your server network, but at a sharply decreasing rate. | -| [getTotalScriptExpGain()](./bitburner.ns.gettotalscriptexpgain.md) | Get the exp gain of all scripts. | -| [getTotalScriptIncome()](./bitburner.ns.gettotalscriptincome.md) | Get the income of all scripts. | -| [getWeakenTime(host)](./bitburner.ns.getweakentime.md) | Get the execution time of a weaken() call. | -| [grow(host, opts)](./bitburner.ns.grow.md) | Spoof money in a server's bank account, increasing the amount available. | -| [growthAnalyze(host, multiplier, cores)](./bitburner.ns.growthanalyze.md) | Calculate the number of grow threads needed for a given multiplicative growth factor. | -| [growthAnalyzeSecurity(threads, host, cores)](./bitburner.ns.growthanalyzesecurity.md) | Calculate the security increase for a number of grow threads. | -| [hack(host, opts)](./bitburner.ns.hack.md) | Steal a server's money. | -| [hackAnalyze(host)](./bitburner.ns.hackanalyze.md) | Get the part of money stolen with a single thread. | -| [hackAnalyzeChance(host)](./bitburner.ns.hackanalyzechance.md) | Get the chance of successfully hacking a server. | -| [hackAnalyzeSecurity(threads, host)](./bitburner.ns.hackanalyzesecurity.md) | Get the security increase for a number of threads. | -| [hackAnalyzeThreads(host, hackAmount)](./bitburner.ns.hackanalyzethreads.md) | Calculate the decimal number of threads needed to hack a specified amount of money from a target host. | -| [hasRootAccess(host)](./bitburner.ns.hasrootaccess.md) | Check if you have root access on a server. | -| [hasTorRouter()](./bitburner.ns.hastorrouter.md) | Returns whether the player has access to the darkweb. | -| [httpworm(host)](./bitburner.ns.httpworm.md) | Runs HTTPWorm.exe on a server. | -| [isLogEnabled(fn)](./bitburner.ns.islogenabled.md) | Checks the status of the logging for the given NS function. | -| [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, host, args)](./bitburner.ns.kill_1.md) | Terminate the script(s) with the provided filename, host, and script arguments. | -| [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. | -| [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. | -| [nextPortWrite(port)](./bitburner.ns.nextportwrite.md) | Listen for a port write. | -| [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. | -| [peek(portNumber)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. | -| [print(args)](./bitburner.ns.print.md) | Prints one or more values or variables to the script’s logs. | -| [printf(format, args)](./bitburner.ns.printf.md) | Prints a formatted string to the script’s logs. | -| [printRaw(node)](./bitburner.ns.printraw.md) | Prints a ReactNode to the script logs. | -| [prompt(txt, options)](./bitburner.ns.prompt.md) | Prompt the player with an input modal. | -| [ps(host)](./bitburner.ns.ps.md) | List running scripts on a server. | -| [purchaseServer(hostname, ram)](./bitburner.ns.purchaseserver.md) | Purchase a server. | -| [ramOverride(ram)](./bitburner.ns.ramoverride.md) | Change the current static RAM allocation of the script. | -| [read(filename)](./bitburner.ns.read.md) | Read content of a file. | -| [readPort(portNumber)](./bitburner.ns.readport.md) | Read data from a port. | -| [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs relaySMTP.exe on a server. | -| [renamePurchasedServer(hostname, newName)](./bitburner.ns.renamepurchasedserver.md) | Rename a purchased server. | -| [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. | -| [run(script, threadOrOptions, args)](./bitburner.ns.run.md) | Start another script on the current server. | -| [scan(host, returnOpts)](./bitburner.ns.scan.md) | Get the list of hostnames or IP addresses connected to a server. | -| [scp(files, destination, source)](./bitburner.ns.scp.md) | Copy file between servers. | -| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. | -| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. | -| [self()](./bitburner.ns.self.md) | Returns the currently running script. | -| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. | -| [share()](./bitburner.ns.share.md) | Share the server's ram with your factions to increase the reputation gain rate of faction work. This boost is applied to all faction work of all factions. | -| [sleep(millis)](./bitburner.ns.sleep.md) | Suspends the script for n milliseconds. | -| [spawn(script, threadOrOptions, args)](./bitburner.ns.spawn.md) | Terminate current script and start another in a defined number of milliseconds. | -| [sprintf(format, args)](./bitburner.ns.sprintf.md) | Format a string. | -| [sqlinject(host)](./bitburner.ns.sqlinject.md) | Runs SQLInject.exe on a server. | -| [toast(msg, variant, duration)](./bitburner.ns.toast.md) | Queue a toast (bottom-right notification). | -| [tprint(args)](./bitburner.ns.tprint.md) | Prints one or more values or variables to the Terminal. | -| [tprintf(format, values)](./bitburner.ns.tprintf.md) | Prints a raw value or a variable to the Terminal. | -| [tprintRaw(node)](./bitburner.ns.tprintraw.md) | Prints a ReactNode to the terminal. | -| [tryWritePort(portNumber, data)](./bitburner.ns.trywriteport.md) | Attempt to write to a port. | -| [upgradePurchasedServer(host, ram)](./bitburner.ns.upgradepurchasedserver.md) | Upgrade a purchased server's RAM. | -| [vsprintf(format, args)](./bitburner.ns.vsprintf.md) | Format a string with an array of arguments. | -| [weaken(host, opts)](./bitburner.ns.weaken.md) | Reduce a server's security level. | -| [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Predict the effect of weaken. | -| [wget(url, target, host)](./bitburner.ns.wget.md) | Download a file from the internet. | -| [write(filename, data, mode)](./bitburner.ns.write.md) | Write data to a file. | -| [writePort(portNumber, data)](./bitburner.ns.writeport.md) | Write data to a port. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[alert(args)](./bitburner.ns.alert.md) + + + + +Open up a message box. + + +
+ +[asleep(millis)](./bitburner.ns.asleep.md) + + + + +Suspends the script for n milliseconds. Doesn't block with concurrent calls. + + +
+ +[atExit(f, id)](./bitburner.ns.atexit.md) + + + + +Add a callback to be executed when the script dies. + + +
+ +[brutessh(host)](./bitburner.ns.brutessh.md) + + + + +Runs BruteSSH.exe on a server. + + +
+ +[clear(handle)](./bitburner.ns.clear.md) + + + + +Clear data from a file. + + +
+ +[clearLog()](./bitburner.ns.clearlog.md) + + + + +Clears the script’s logs. + + +
+ +[clearPort(portNumber)](./bitburner.ns.clearport.md) + + + + +Clear data from a port. + + +
+ +[deleteServer(host)](./bitburner.ns.deleteserver.md) + + + + +Delete a purchased server. + + +
+ +[disableLog(fn)](./bitburner.ns.disablelog.md) + + + + +Disables logging for the given NS function. + + +
+ +[dnsLookup(host)](./bitburner.ns.dnslookup.md) + + + + +Given a hostname, returns its IP address; or given an IP address, returns its hostname. + + +
+ +[dynamicImport(path)](./bitburner.ns.dynamicimport.md) + + + + +Dynamically import a script. Only scripts located on the same server can be imported. A dynamic import will not adjust RAM usage. This must be done manually with [ramOverride](./bitburner.ns.ramoverride.md). + + +
+ +[enableLog(fn)](./bitburner.ns.enablelog.md) + + + + +Enables logging for the given NS function. + + +
+ +[exec(script, host, threadOrOptions, args)](./bitburner.ns.exec.md) + + + + +Start another script on any server. + + +
+ +[exit()](./bitburner.ns.exit.md) + + + + +Terminates the current script immediately. + + +
+ +[fileExists(filename, host)](./bitburner.ns.fileexists.md) + + + + +Check if a file exists. + + +
+ +[flags(schema)](./bitburner.ns.flags.md) + + + + +Parse command line flags. + + +
+ +[ftpcrack(host)](./bitburner.ns.ftpcrack.md) + + + + +Runs FTPCrack.exe on a server. + + +
+ +[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. + + +
+ +[getFileMetadata(filename)](./bitburner.ns.getfilemetadata.md) + + + + +Get the metadata of a file. + + +
+ +[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. + + +
+ +[getHackingLevel()](./bitburner.ns.gethackinglevel.md) + + + + +Returns the player’s current hacking level. + + +
+ +[getHackingMultipliers()](./bitburner.ns.gethackingmultipliers.md) + + + + +Get hacking related multipliers. + + +
+ +[getHacknetMultipliers()](./bitburner.ns.gethacknetmultipliers.md) + + + + +Get hacknet related multipliers. + + +
+ +[getHackTime(host)](./bitburner.ns.gethacktime.md) + + + + +Get the execution time of a hack() call. + + +
+ +[getHostname()](./bitburner.ns.gethostname.md) + + + + +Returns a string with the hostname of the server that the script is running on. + + +
+ +[getIP()](./bitburner.ns.getip.md) + + + + +Returns a string with the IP address of the server that the script is running on. + + +
+ +[getMoneySources()](./bitburner.ns.getmoneysources.md) + + + + +Get information about the sources of income for this run. + + +
+ +[getPlayer()](./bitburner.ns.getplayer.md) + + + + +Get information about the player. + + +
+ +[getPortHandle(portNumber)](./bitburner.ns.getporthandle.md) + + + + +Get all data on a port. + + +
+ +[getPurchasedServerCost(ram)](./bitburner.ns.getpurchasedservercost.md) + + + + +Get cost of purchasing a server. + + +
+ +[getPurchasedServerLimit()](./bitburner.ns.getpurchasedserverlimit.md) + + + + +Returns the maximum number of servers you can purchase. + + +
+ +[getPurchasedServerMaxRam()](./bitburner.ns.getpurchasedservermaxram.md) + + + + +Returns the maximum RAM that a purchased server can have. + + +
+ +[getPurchasedServers(returnOpts)](./bitburner.ns.getpurchasedservers.md) + + + + +Returns an array with the hostnames or IP addresses of all of the servers you have purchased. Returns hostnames by default. + + +
+ +[getPurchasedServerUpgradeCost(host, ram)](./bitburner.ns.getpurchasedserverupgradecost.md) + + + + +Get cost of upgrading a purchased server to the given ram. + + +
+ +[getRecentScripts()](./bitburner.ns.getrecentscripts.md) + + + + +Get an array of recently killed scripts across all servers. + + +
+ +[getResetInfo()](./bitburner.ns.getresetinfo.md) + + + + +Get information about resets. + + +
+ +[getRunningScript(filename, host, args)](./bitburner.ns.getrunningscript.md) + + + + +Get general info about a running script. + + +
+ +[getScriptExpGain(script, host, args)](./bitburner.ns.getscriptexpgain.md) + + + + +Get the exp gain of a script. + + +
+ +[getScriptIncome(script, host, args)](./bitburner.ns.getscriptincome.md) + + + + +Get the income of a script. + + +
+ +[getScriptLogs(fn, host, args)](./bitburner.ns.getscriptlogs.md) + + + + +Get all the logs of a script. + + +
+ +[getScriptName()](./bitburner.ns.getscriptname.md) + + + + +Returns the current script name. + + +
+ +[getScriptRam(script, host)](./bitburner.ns.getscriptram.md) + + + + +Get the ram cost of a script. + + +
+ +[getServer(host)](./bitburner.ns.getserver.md) + + + + +Returns a server object for the given server. Defaults to the running script's server if host is not specified. + + +
+ +[getServerBaseSecurityLevel(host)](./bitburner.ns.getserverbasesecuritylevel.md) + + + + +Get the base security level of a server. + + +
+ +[getServerGrowth(host)](./bitburner.ns.getservergrowth.md) + + + + +Get a server growth parameter. + + +
+ +[getServerMaxMoney(host)](./bitburner.ns.getservermaxmoney.md) + + + + +Get the maximum money available on a server. + + +
+ +[getServerMaxRam(host)](./bitburner.ns.getservermaxram.md) + + + + +Get the maximum amount of RAM on a server. + + +
+ +[getServerMinSecurityLevel(host)](./bitburner.ns.getserverminsecuritylevel.md) + + + + +Returns the minimum security level of the target server. + + +
+ +[getServerMoneyAvailable(host)](./bitburner.ns.getservermoneyavailable.md) + + + + +Get money available on a server. + + +
+ +[getServerNumPortsRequired(host)](./bitburner.ns.getservernumportsrequired.md) + + + + +Returns the number of open ports required to successfully run NUKE.exe on the specified server. + + +
+ +[getServerRequiredHackingLevel(host)](./bitburner.ns.getserverrequiredhackinglevel.md) + + + + +Returns the required hacking level of the target server. + + +
+ +[getServerSecurityLevel(host)](./bitburner.ns.getserversecuritylevel.md) + + + + +Get server security level. + + +
+ +[getServerUsedRam(host)](./bitburner.ns.getserverusedram.md) + + + + +Get the used RAM on a server. + + +
+ +[getSharePower()](./bitburner.ns.getsharepower.md) + + + + +Share power has a multiplicative effect on rep/second while doing work for a faction. Share power increases incrementally for every thread of share running on your server network, but at a sharply decreasing rate. + + +
+ +[getTotalScriptExpGain()](./bitburner.ns.gettotalscriptexpgain.md) + + + + +Get the exp gain of all scripts. + + +
+ +[getTotalScriptIncome()](./bitburner.ns.gettotalscriptincome.md) + + + + +Get the income of all scripts. + + +
+ +[getWeakenTime(host)](./bitburner.ns.getweakentime.md) + + + + +Get the execution time of a weaken() call. + + +
+ +[grow(host, opts)](./bitburner.ns.grow.md) + + + + +Spoof money in a server's bank account, increasing the amount available. + + +
+ +[growthAnalyze(host, multiplier, cores)](./bitburner.ns.growthanalyze.md) + + + + +Calculate the number of grow threads needed for a given multiplicative growth factor. + + +
+ +[growthAnalyzeSecurity(threads, host, cores)](./bitburner.ns.growthanalyzesecurity.md) + + + + +Calculate the security increase for a number of grow threads. + + +
+ +[hack(host, opts)](./bitburner.ns.hack.md) + + + + +Steal a server's money. + + +
+ +[hackAnalyze(host)](./bitburner.ns.hackanalyze.md) + + + + +Get the part of money stolen with a single thread. + + +
+ +[hackAnalyzeChance(host)](./bitburner.ns.hackanalyzechance.md) + + + + +Get the chance of successfully hacking a server. + + +
+ +[hackAnalyzeSecurity(threads, host)](./bitburner.ns.hackanalyzesecurity.md) + + + + +Get the security increase for a number of threads. + + +
+ +[hackAnalyzeThreads(host, hackAmount)](./bitburner.ns.hackanalyzethreads.md) + + + + +Calculate the decimal number of threads needed to hack a specified amount of money from a target host. + + +
+ +[hasRootAccess(host)](./bitburner.ns.hasrootaccess.md) + + + + +Check if you have root access on a server. + + +
+ +[hasTorRouter()](./bitburner.ns.hastorrouter.md) + + + + +Returns whether the player has access to the darkweb. + + +
+ +[httpworm(host)](./bitburner.ns.httpworm.md) + + + + +Runs HTTPWorm.exe on a server. + + +
+ +[isLogEnabled(fn)](./bitburner.ns.islogenabled.md) + + + + +Checks the status of the logging for the given NS function. + + +
+ +[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, host, args)](./bitburner.ns.kill_1.md) + + + + +Terminate the script(s) with the provided filename, host, and script arguments. + + +
+ +[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. + + +
+ +[mv(host, source, destination)](./bitburner.ns.mv.md) + + + + +Move a file on the target server. + + +
+ +[nextPortWrite(port)](./bitburner.ns.nextportwrite.md) + + + + +Listen for a port write. + + +
+ +[nuke(host)](./bitburner.ns.nuke.md) + + + + +Runs NUKE.exe on a server. + + +
+ +[peek(portNumber)](./bitburner.ns.peek.md) + + + + +Get a copy of the data from a port without popping it. + + +
+ +[print(args)](./bitburner.ns.print.md) + + + + +Prints one or more values or variables to the script’s logs. + + +
+ +[printf(format, args)](./bitburner.ns.printf.md) + + + + +Prints a formatted string to the script’s logs. + + +
+ +[printRaw(node)](./bitburner.ns.printraw.md) + + + + +Prints a ReactNode to the script logs. + + +
+ +[prompt(txt, options)](./bitburner.ns.prompt.md) + + + + +Prompt the player with an input modal. + + +
+ +[ps(host)](./bitburner.ns.ps.md) + + + + +List running scripts on a server. + + +
+ +[purchaseServer(hostname, ram)](./bitburner.ns.purchaseserver.md) + + + + +Purchase a server. + + +
+ +[ramOverride(ram)](./bitburner.ns.ramoverride.md) + + + + +Change the current static RAM allocation of the script. + + +
+ +[read(filename)](./bitburner.ns.read.md) + + + + +Read content of a file. + + +
+ +[readPort(portNumber)](./bitburner.ns.readport.md) + + + + +Read data from a port. + + +
+ +[relaysmtp(host)](./bitburner.ns.relaysmtp.md) + + + + +Runs relaySMTP.exe on a server. + + +
+ +[renamePurchasedServer(hostname, newName)](./bitburner.ns.renamepurchasedserver.md) + + + + +Rename a purchased server. + + +
+ +[rm(name, host)](./bitburner.ns.rm.md) + + + + +Delete a file. + + +
+ +[run(script, threadOrOptions, args)](./bitburner.ns.run.md) + + + + +Start another script on the current server. + + +
+ +[scan(host, returnOpts)](./bitburner.ns.scan.md) + + + + +Get the list of hostnames or IP addresses connected to a server. + + +
+ +[scp(files, destination, source)](./bitburner.ns.scp.md) + + + + +Copy file between servers. + + +
+ +[scriptKill(script, host)](./bitburner.ns.scriptkill.md) + + + + +Kill all scripts with a filename. + + +
+ +[scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) + + + + +Check if any script with a filename is running. + + +
+ +[self()](./bitburner.ns.self.md) + + + + +Returns the currently running script. + + +
+ +[serverExists(host)](./bitburner.ns.serverexists.md) + + + + +Returns a boolean denoting whether or not the specified server exists. + + +
+ +[share()](./bitburner.ns.share.md) + + + + +Share the server's ram with your factions to increase the reputation gain rate of faction work. This boost is applied to all faction work of all factions. + + +
+ +[sleep(millis)](./bitburner.ns.sleep.md) + + + + +Suspends the script for n milliseconds. + + +
+ +[spawn(script, threadOrOptions, args)](./bitburner.ns.spawn.md) + + + + +Terminate current script and start another in a defined number of milliseconds. + + +
+ +[sprintf(format, args)](./bitburner.ns.sprintf.md) + + + + +Format a string. + + +
+ +[sqlinject(host)](./bitburner.ns.sqlinject.md) + + + + +Runs SQLInject.exe on a server. + + +
+ +[toast(msg, variant, duration)](./bitburner.ns.toast.md) + + + + +Queue a toast (bottom-right notification). + + +
+ +[tprint(args)](./bitburner.ns.tprint.md) + + + + +Prints one or more values or variables to the Terminal. + + +
+ +[tprintf(format, values)](./bitburner.ns.tprintf.md) + + + + +Prints a raw value or a variable to the Terminal. + + +
+ +[tprintRaw(node)](./bitburner.ns.tprintraw.md) + + + + +Prints a ReactNode to the terminal. + + +
+ +[tryWritePort(portNumber, data)](./bitburner.ns.trywriteport.md) + + + + +Attempt to write to a port. + + +
+ +[upgradePurchasedServer(host, ram)](./bitburner.ns.upgradepurchasedserver.md) + + + + +Upgrade a purchased server's RAM. + + +
+ +[vsprintf(format, args)](./bitburner.ns.vsprintf.md) + + + + +Format a string with an array of arguments. + + +
+ +[weaken(host, opts)](./bitburner.ns.weaken.md) + + + + +Reduce a server's security level. + + +
+ +[weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) + + + + +Predict the effect of weaken. + + +
+ +[wget(url, target, host)](./bitburner.ns.wget.md) + + + + +Download a file from the internet. + + +
+ +[write(filename, data, mode)](./bitburner.ns.write.md) + + + + +Write data to a file. + + +
+ +[writePort(portNumber, data)](./bitburner.ns.writeport.md) + + + + +Write data to a port. + + +
diff --git a/markdown/bitburner.ns.mv.md b/markdown/bitburner.ns.mv.md index f22722650..15efb26ef 100644 --- a/markdown/bitburner.ns.mv.md +++ b/markdown/bitburner.ns.mv.md @@ -14,11 +14,71 @@ mv(host: string, source: string, destination: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | -| source | string | Filename of the source file. | -| destination | string | Filename of the destination file. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
+ +source + + + + +string + + + + +Filename of the source file. + + +
+ +destination + + + + +string + + + + +Filename of the destination file. + + +
**Returns:** diff --git a/markdown/bitburner.ns.nextportwrite.md b/markdown/bitburner.ns.nextportwrite.md index 5cde6f8f4..203a18771 100644 --- a/markdown/bitburner.ns.nextportwrite.md +++ b/markdown/bitburner.ns.nextportwrite.md @@ -14,9 +14,39 @@ nextPortWrite(port: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| port | number | Port to listen for a write on. Must be a positive integer. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +port + + + + +number + + + + +Port to listen for a write on. Must be a positive integer. + + +
**Returns:** diff --git a/markdown/bitburner.ns.nuke.md b/markdown/bitburner.ns.nuke.md index 9e5d109b5..35972641c 100644 --- a/markdown/bitburner.ns.nuke.md +++ b/markdown/bitburner.ns.nuke.md @@ -14,9 +14,39 @@ nuke(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.peek.md b/markdown/bitburner.ns.peek.md index 5eba73bda..7bfd6e843 100644 --- a/markdown/bitburner.ns.peek.md +++ b/markdown/bitburner.ns.peek.md @@ -14,9 +14,39 @@ peek(portNumber: number): any; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| portNumber | number | Port to peek. Must be a positive integer. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +portNumber + + + + +number + + + + +Port to peek. Must be a positive integer. + + +
**Returns:** diff --git a/markdown/bitburner.ns.print.md b/markdown/bitburner.ns.print.md index 6071b7e91..db96a6b75 100644 --- a/markdown/bitburner.ns.print.md +++ b/markdown/bitburner.ns.print.md @@ -14,9 +14,39 @@ print(...args: any[]): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| args | any\[\] | Value(s) to be printed. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +any\[\] + + + + +Value(s) to be printed. + + +
**Returns:** diff --git a/markdown/bitburner.ns.printf.md b/markdown/bitburner.ns.printf.md index bad684393..e769b6e1b 100644 --- a/markdown/bitburner.ns.printf.md +++ b/markdown/bitburner.ns.printf.md @@ -14,10 +14,55 @@ printf(format: string, ...args: any[]): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| format | string | Format of the message. | -| args | any\[\] | Value(s) to be printed. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +format + + + + +string + + + + +Format of the message. + + +
+ +args + + + + +any\[\] + + + + +Value(s) to be printed. + + +
**Returns:** diff --git a/markdown/bitburner.ns.printraw.md b/markdown/bitburner.ns.printraw.md index a94bc9795..1142f8f91 100644 --- a/markdown/bitburner.ns.printraw.md +++ b/markdown/bitburner.ns.printraw.md @@ -14,9 +14,39 @@ printRaw(node: ReactNode): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| node | [ReactNode](./bitburner.reactnode.md) | The React node to be printed. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +[ReactNode](./bitburner.reactnode.md) + + + + +The React node to be printed. + + +
**Returns:** diff --git a/markdown/bitburner.ns.prompt.md b/markdown/bitburner.ns.prompt.md index 38cbd1033..f5005a343 100644 --- a/markdown/bitburner.ns.prompt.md +++ b/markdown/bitburner.ns.prompt.md @@ -17,10 +17,55 @@ prompt( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| txt | string | Text to appear in the prompt dialog box. | -| options | { type?: "boolean" \| "text" \| "select"; choices?: string\[\] } | _(Optional)_ Options to modify the prompt the player is shown. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +txt + + + + +string + + + + +Text to appear in the prompt dialog box. + + +
+ +options + + + + +{ type?: "boolean" \| "text" \| "select"; choices?: string\[\] } + + + + +_(Optional)_ Options to modify the prompt the player is shown. + + +
**Returns:** diff --git a/markdown/bitburner.ns.ps.md b/markdown/bitburner.ns.ps.md index 259b5a745..9bb0be296 100644 --- a/markdown/bitburner.ns.ps.md +++ b/markdown/bitburner.ns.ps.md @@ -14,9 +14,39 @@ ps(host?: string): ProcessInfo[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | _(Optional)_ Hostname/IP of the target server. If not specified, it will be the current server’s IP by default. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the target server. If not specified, it will be the current server’s IP by default. + + +
**Returns:** diff --git a/markdown/bitburner.ns.purchaseserver.md b/markdown/bitburner.ns.purchaseserver.md index c2e4ea67d..abdd222db 100644 --- a/markdown/bitburner.ns.purchaseserver.md +++ b/markdown/bitburner.ns.purchaseserver.md @@ -14,10 +14,55 @@ purchaseServer(hostname: string, ram: number): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| hostname | string | Hostname of the purchased server. | -| ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +hostname + + + + +string + + + + +Hostname of the purchased server. + + +
+ +ram + + + + +number + + + + +Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + + +
**Returns:** diff --git a/markdown/bitburner.ns.ramoverride.md b/markdown/bitburner.ns.ramoverride.md index e4c8e8328..dcdeffc25 100644 --- a/markdown/bitburner.ns.ramoverride.md +++ b/markdown/bitburner.ns.ramoverride.md @@ -14,9 +14,39 @@ ramOverride(ram?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| ram | number | _(Optional)_ The new RAM limit to set. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +ram + + + + +number + + + + +_(Optional)_ The new RAM limit to set. + + +
**Returns:** diff --git a/markdown/bitburner.ns.read.md b/markdown/bitburner.ns.read.md index a0251493f..2d4454f74 100644 --- a/markdown/bitburner.ns.read.md +++ b/markdown/bitburner.ns.read.md @@ -14,9 +14,39 @@ read(filename: string): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Name of the file to be read. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Name of the file to be read. + + +
**Returns:** diff --git a/markdown/bitburner.ns.readport.md b/markdown/bitburner.ns.readport.md index 8560a09c8..24656fd8a 100644 --- a/markdown/bitburner.ns.readport.md +++ b/markdown/bitburner.ns.readport.md @@ -14,9 +14,39 @@ readPort(portNumber: number): any; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| portNumber | number | Port to read from. Must be a positive integer. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +portNumber + + + + +number + + + + +Port to read from. Must be a positive integer. + + +
**Returns:** diff --git a/markdown/bitburner.ns.relaysmtp.md b/markdown/bitburner.ns.relaysmtp.md index 7e110f954..e06312412 100644 --- a/markdown/bitburner.ns.relaysmtp.md +++ b/markdown/bitburner.ns.relaysmtp.md @@ -14,9 +14,39 @@ relaysmtp(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.renamepurchasedserver.md b/markdown/bitburner.ns.renamepurchasedserver.md index 210a95f71..d4aa067f5 100644 --- a/markdown/bitburner.ns.renamepurchasedserver.md +++ b/markdown/bitburner.ns.renamepurchasedserver.md @@ -14,10 +14,55 @@ renamePurchasedServer(hostname: string, newName: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| hostname | string | Current server hostname. | -| newName | string | New server hostname. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +hostname + + + + +string + + + + +Current server hostname. + + +
+ +newName + + + + +string + + + + +New server hostname. + + +
**Returns:** diff --git a/markdown/bitburner.ns.rm.md b/markdown/bitburner.ns.rm.md index 7b18971e1..724fc1be0 100644 --- a/markdown/bitburner.ns.rm.md +++ b/markdown/bitburner.ns.rm.md @@ -14,10 +14,55 @@ rm(name: string, host?: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | Filename of file to remove. Must include the extension. | -| host | string | _(Optional)_ Hostname/IP of the server on which to delete the file. Optional. Defaults to current server. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +name + + + + +string + + + + +Filename of file to remove. Must include the extension. + + +
+ +host + + + + +string + + + + +_(Optional)_ Hostname/IP of the server on which to delete the file. Optional. Defaults to current server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.run.md b/markdown/bitburner.ns.run.md index bf9682003..2838d9b1f 100644 --- a/markdown/bitburner.ns.run.md +++ b/markdown/bitburner.ns.run.md @@ -14,11 +14,71 @@ run(script: string, threadOrOptions?: number | RunOptions, ...args: ScriptArg[]) ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | string | Filename of script to run. | -| threadOrOptions | number \| [RunOptions](./bitburner.runoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument threadOrOptions must be filled in with a value. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +string + + + + +Filename of script to run. + + +
+ +threadOrOptions + + + + +number \| [RunOptions](./bitburner.runoptions.md) + + + + +_(Optional)_ Either an integer number of threads for new script, or a [RunOptions](./bitburner.runoptions.md) object. Threads defaults to 1. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument threadOrOptions must be filled in with a value. + + +
**Returns:** diff --git a/markdown/bitburner.ns.scan.md b/markdown/bitburner.ns.scan.md index b494a5324..576b546c7 100644 --- a/markdown/bitburner.ns.scan.md +++ b/markdown/bitburner.ns.scan.md @@ -14,10 +14,55 @@ scan(host?: string | null, returnOpts?: HostReturnOptions): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string \| null | _(Optional)_ Optional. Hostname/IP of the server to scan, default to current server. | -| returnOpts | [HostReturnOptions](./bitburner.hostreturnoptions.md) | _(Optional)_ Optional. Controls whether the function returns IPs. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string \| null + + + + +_(Optional)_ Optional. Hostname/IP of the server to scan, default to current server. + + +
+ +returnOpts + + + + +[HostReturnOptions](./bitburner.hostreturnoptions.md) + + + + +_(Optional)_ Optional. Controls whether the function returns IPs. + + +
**Returns:** diff --git a/markdown/bitburner.ns.scp.md b/markdown/bitburner.ns.scp.md index 2e4d7b915..2606d1e4c 100644 --- a/markdown/bitburner.ns.scp.md +++ b/markdown/bitburner.ns.scp.md @@ -14,11 +14,71 @@ scp(files: string | string[], destination: string, source?: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| files | string \| string\[\] | Filename or an array of filenames of script/literature files to copy. Note that if a file is located in a subdirectory, the filename must include the leading /. | -| destination | string | Hostname/IP of the destination server, which is the server to which the file will be copied. | -| source | string | _(Optional)_ Hostname/IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +files + + + + +string \| string\[\] + + + + +Filename or an array of filenames of script/literature files to copy. Note that if a file is located in a subdirectory, the filename must include the leading `/`. + + +
+ +destination + + + + +string + + + + +Hostname/IP of the destination server, which is the server to which the file will be copied. + + +
+ +source + + + + +string + + + + +_(Optional)_ Hostname/IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.scriptkill.md b/markdown/bitburner.ns.scriptkill.md index a9935a1ef..5dc6d35bd 100644 --- a/markdown/bitburner.ns.scriptkill.md +++ b/markdown/bitburner.ns.scriptkill.md @@ -14,10 +14,55 @@ scriptKill(script: string, host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | string | Filename of script to kill. This is case-sensitive. | -| host | string | Hostname/IP of target server. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +string + + + + +Filename of script to kill. This is case-sensitive. + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.scriptrunning.md b/markdown/bitburner.ns.scriptrunning.md index ed8a99601..22e48ddbf 100644 --- a/markdown/bitburner.ns.scriptrunning.md +++ b/markdown/bitburner.ns.scriptrunning.md @@ -14,10 +14,55 @@ scriptRunning(script: string, host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | string | Filename of script to check. This is case-sensitive. | -| host | string | Hostname/IP of target server. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +string + + + + +Filename of script to check. This is case-sensitive. + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.serverexists.md b/markdown/bitburner.ns.serverexists.md index d2c645f8a..167d9acad 100644 --- a/markdown/bitburner.ns.serverexists.md +++ b/markdown/bitburner.ns.serverexists.md @@ -14,9 +14,39 @@ serverExists(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.sleep.md b/markdown/bitburner.ns.sleep.md index a9c390627..37d0d841b 100644 --- a/markdown/bitburner.ns.sleep.md +++ b/markdown/bitburner.ns.sleep.md @@ -14,9 +14,39 @@ sleep(millis?: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| millis | number | _(Optional)_ Number of milliseconds to sleep. Default to 0. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +millis + + + + +number + + + + +_(Optional)_ Number of milliseconds to sleep. Default to 0. + + +
**Returns:** diff --git a/markdown/bitburner.ns.spawn.md b/markdown/bitburner.ns.spawn.md index 732a58ced..8db8e5cb3 100644 --- a/markdown/bitburner.ns.spawn.md +++ b/markdown/bitburner.ns.spawn.md @@ -14,11 +14,71 @@ spawn(script: string, threadOrOptions?: number | SpawnOptions, ...args: ScriptAr ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| script | string | Filename of script to execute. | -| threadOrOptions | number \| [SpawnOptions](./bitburner.spawnoptions.md) | _(Optional)_ Either an integer number of threads for new script, or a [SpawnOptions](./bitburner.spawnoptions.md) object. Threads defaults to 1 and spawnDelay defaults to 10,000 ms. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Additional arguments to pass into the new script that is being run. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +script + + + + +string + + + + +Filename of script to execute. + + +
+ +threadOrOptions + + + + +number \| [SpawnOptions](./bitburner.spawnoptions.md) + + + + +_(Optional)_ Either an integer number of threads for new script, or a [SpawnOptions](./bitburner.spawnoptions.md) object. Threads defaults to 1 and spawnDelay defaults to 10,000 ms. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Additional arguments to pass into the new script that is being run. + + +
**Returns:** diff --git a/markdown/bitburner.ns.sprintf.md b/markdown/bitburner.ns.sprintf.md index 6912ff691..793e25909 100644 --- a/markdown/bitburner.ns.sprintf.md +++ b/markdown/bitburner.ns.sprintf.md @@ -14,10 +14,55 @@ sprintf(format: string, ...args: any[]): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| format | string | String to format. | -| args | any\[\] | Formatting arguments. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +format + + + + +string + + + + +String to format. + + +
+ +args + + + + +any\[\] + + + + +Formatting arguments. + + +
**Returns:** diff --git a/markdown/bitburner.ns.sqlinject.md b/markdown/bitburner.ns.sqlinject.md index e793cab2a..e160f07eb 100644 --- a/markdown/bitburner.ns.sqlinject.md +++ b/markdown/bitburner.ns.sqlinject.md @@ -14,9 +14,39 @@ sqlinject(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server. + + +
**Returns:** diff --git a/markdown/bitburner.ns.toast.md b/markdown/bitburner.ns.toast.md index 8c71b74f1..4b5e160e3 100644 --- a/markdown/bitburner.ns.toast.md +++ b/markdown/bitburner.ns.toast.md @@ -14,11 +14,71 @@ toast(msg: string, variant?: ToastVariant, duration?: number | null): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| msg | string | Message in the toast. | -| variant | [ToastVariant](./bitburner.toastvariant.md) | _(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success. | -| duration | number \| null | _(Optional)_ Duration of toast in ms. Can also be null to create a persistent toast. Defaults to 2000. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +msg + + + + +string + + + + +Message in the toast. + + +
+ +variant + + + + +[ToastVariant](./bitburner.toastvariant.md) + + + + +_(Optional)_ Type of toast. Must be one of success, info, warning, error. Defaults to success. + + +
+ +duration + + + + +number \| null + + + + +_(Optional)_ Duration of toast in ms. Can also be `null` to create a persistent toast. Defaults to 2000. + + +
**Returns:** diff --git a/markdown/bitburner.ns.tprint.md b/markdown/bitburner.ns.tprint.md index ccd8ea126..db83555a7 100644 --- a/markdown/bitburner.ns.tprint.md +++ b/markdown/bitburner.ns.tprint.md @@ -14,9 +14,39 @@ tprint(...args: any[]): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| args | any\[\] | Value(s) to be printed. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +args + + + + +any\[\] + + + + +Value(s) to be printed. + + +
**Returns:** diff --git a/markdown/bitburner.ns.tprintf.md b/markdown/bitburner.ns.tprintf.md index e05129a1d..257bc3fa9 100644 --- a/markdown/bitburner.ns.tprintf.md +++ b/markdown/bitburner.ns.tprintf.md @@ -14,10 +14,55 @@ tprintf(format: string, ...values: any[]): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| format | string | Format of the message. | -| values | any\[\] | Value(s) to be printed. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +format + + + + +string + + + + +Format of the message. + + +
+ +values + + + + +any\[\] + + + + +Value(s) to be printed. + + +
**Returns:** diff --git a/markdown/bitburner.ns.tprintraw.md b/markdown/bitburner.ns.tprintraw.md index 418159874..da464a6ea 100644 --- a/markdown/bitburner.ns.tprintraw.md +++ b/markdown/bitburner.ns.tprintraw.md @@ -14,9 +14,39 @@ tprintRaw(node: ReactNode): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| node | [ReactNode](./bitburner.reactnode.md) | The React node to be printed. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +node + + + + +[ReactNode](./bitburner.reactnode.md) + + + + +The React node to be printed. + + +
**Returns:** diff --git a/markdown/bitburner.ns.trywriteport.md b/markdown/bitburner.ns.trywriteport.md index 5ca6ac6f1..b301cdb04 100644 --- a/markdown/bitburner.ns.trywriteport.md +++ b/markdown/bitburner.ns.trywriteport.md @@ -14,10 +14,55 @@ tryWritePort(portNumber: number, data: any): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| portNumber | number | Port to attempt to write to. Must be a positive integer. | -| data | any | Data to write, it's cloned with structuredClone(). | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +portNumber + + + + +number + + + + +Port to attempt to write to. Must be a positive integer. + + +
+ +data + + + + +any + + + + +Data to write, it's cloned with structuredClone(). + + +
**Returns:** diff --git a/markdown/bitburner.ns.upgradepurchasedserver.md b/markdown/bitburner.ns.upgradepurchasedserver.md index 3e0b58065..18ca138cd 100644 --- a/markdown/bitburner.ns.upgradepurchasedserver.md +++ b/markdown/bitburner.ns.upgradepurchasedserver.md @@ -14,10 +14,55 @@ upgradePurchasedServer(host: string, ram: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the server to upgrade. | -| ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the server to upgrade. + + +
+ +ram + + + + +number + + + + +Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + + +
**Returns:** diff --git a/markdown/bitburner.ns.vsprintf.md b/markdown/bitburner.ns.vsprintf.md index ef807f8ce..2832c7a97 100644 --- a/markdown/bitburner.ns.vsprintf.md +++ b/markdown/bitburner.ns.vsprintf.md @@ -14,10 +14,55 @@ vsprintf(format: string, args: any[]): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| format | string | String to format. | -| args | any\[\] | Formatting arguments. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +format + + + + +string + + + + +String to format. + + +
+ +args + + + + +any\[\] + + + + +Formatting arguments. + + +
**Returns:** diff --git a/markdown/bitburner.ns.weaken.md b/markdown/bitburner.ns.weaken.md index be17725b5..d53ffd271 100644 --- a/markdown/bitburner.ns.weaken.md +++ b/markdown/bitburner.ns.weaken.md @@ -14,10 +14,55 @@ weaken(host: string, opts?: BasicHGWOptions): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | Hostname/IP of the target server to weaken. | -| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | _(Optional)_ Optional parameters for configuring function behavior. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + +Hostname/IP of the target server to weaken. + + +
+ +opts + + + + +[BasicHGWOptions](./bitburner.basichgwoptions.md) + + + + +_(Optional)_ Optional parameters for configuring function behavior. + + +
**Returns:** diff --git a/markdown/bitburner.ns.weakenanalyze.md b/markdown/bitburner.ns.weakenanalyze.md index 211de8bb5..b6036d458 100644 --- a/markdown/bitburner.ns.weakenanalyze.md +++ b/markdown/bitburner.ns.weakenanalyze.md @@ -14,10 +14,55 @@ weakenAnalyze(threads: number, cores?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| threads | number | Amount of threads that will be used. | -| cores | number | _(Optional)_ Optional. The number of cores of the server that would run weaken. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +threads + + + + +number + + + + +Amount of threads that will be used. + + +
+ +cores + + + + +number + + + + +_(Optional)_ Optional. The number of cores of the server that would run weaken. + + +
**Returns:** diff --git a/markdown/bitburner.ns.wget.md b/markdown/bitburner.ns.wget.md index 26f2d25db..03aca5da3 100644 --- a/markdown/bitburner.ns.wget.md +++ b/markdown/bitburner.ns.wget.md @@ -14,11 +14,71 @@ wget(url: string, target: string, host?: string): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| url | string | URL to pull data from. | -| target | string | Filename to write data to. Must be script or text file. | -| host | string | _(Optional)_ Optional hostname/ip of server for target file. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +url + + + + +string + + + + +URL to pull data from. + + +
+ +target + + + + +string + + + + +Filename to write data to. Must be script or text file. + + +
+ +host + + + + +string + + + + +_(Optional)_ Optional hostname/ip of server for target file. + + +
**Returns:** diff --git a/markdown/bitburner.ns.write.md b/markdown/bitburner.ns.write.md index 97f752484..927632060 100644 --- a/markdown/bitburner.ns.write.md +++ b/markdown/bitburner.ns.write.md @@ -14,11 +14,71 @@ write(filename: string, data?: string, mode?: "w" | "a"): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Name of the file to be written to. | -| data | string | _(Optional)_ Data to write. | -| mode | "w" \| "a" | _(Optional)_ Defines the write mode. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Name of the file to be written to. + + +
+ +data + + + + +string + + + + +_(Optional)_ Data to write. + + +
+ +mode + + + + +"w" \| "a" + + + + +_(Optional)_ Defines the write mode. + + +
**Returns:** diff --git a/markdown/bitburner.ns.writeport.md b/markdown/bitburner.ns.writeport.md index 48e1ebee8..191fd1e05 100644 --- a/markdown/bitburner.ns.writeport.md +++ b/markdown/bitburner.ns.writeport.md @@ -14,10 +14,55 @@ writePort(portNumber: number, data: any): any; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| portNumber | number | Port to write to. Must be a positive integer. | -| data | any | Data to write, it's cloned with structuredClone(). | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +portNumber + + + + +number + + + + +Port to write to. Must be a positive integer. + + +
+ +data + + + + +any + + + + +Data to write, it's cloned with structuredClone(). + + +
**Returns:** diff --git a/markdown/bitburner.numaugmentationsrequirement.md b/markdown/bitburner.numaugmentationsrequirement.md index 3295388fc..2be443718 100644 --- a/markdown/bitburner.numaugmentationsrequirement.md +++ b/markdown/bitburner.numaugmentationsrequirement.md @@ -14,8 +14,60 @@ interface NumAugmentationsRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [numAugmentations](./bitburner.numaugmentationsrequirement.numaugmentations.md) | | number | | -| [type](./bitburner.numaugmentationsrequirement.type.md) | | "numAugmentations" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[numAugmentations](./bitburner.numaugmentationsrequirement.numaugmentations.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.numaugmentationsrequirement.type.md) + + + + + + + +"numAugmentations" + + + + + +
diff --git a/markdown/bitburner.numinfiltrationsrequirement.md b/markdown/bitburner.numinfiltrationsrequirement.md index 94160d9b9..5da33f0e1 100644 --- a/markdown/bitburner.numinfiltrationsrequirement.md +++ b/markdown/bitburner.numinfiltrationsrequirement.md @@ -14,8 +14,60 @@ interface NumInfiltrationsRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [numInfiltrations](./bitburner.numinfiltrationsrequirement.numinfiltrations.md) | | number | | -| [type](./bitburner.numinfiltrationsrequirement.type.md) | | "numInfiltrations" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[numInfiltrations](./bitburner.numinfiltrationsrequirement.numinfiltrations.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.numinfiltrationsrequirement.type.md) + + + + + + + +"numInfiltrations" + + + + + +
diff --git a/markdown/bitburner.office.md b/markdown/bitburner.office.md index 264166b37..92cac10c1 100644 --- a/markdown/bitburner.office.md +++ b/markdown/bitburner.office.md @@ -14,16 +14,216 @@ export interface Office ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [avgEnergy](./bitburner.office.avgenergy.md) | | number | Average energy of the employees | -| [avgMorale](./bitburner.office.avgmorale.md) | | number | Average morale of the employees | -| [city](./bitburner.office.city.md) | | [CityName](./bitburner.cityname.md) | City of the office | -| [employeeJobs](./bitburner.office.employeejobs.md) | | Record<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), number> | Positions of the employees | -| [employeeProductionByJob](./bitburner.office.employeeproductionbyjob.md) | | Record<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), number> | Production of the employees | -| [maxEnergy](./bitburner.office.maxenergy.md) | | number | Maximum amount of energy of the employees | -| [maxMorale](./bitburner.office.maxmorale.md) | | number | Maximum morale of the employees | -| [numEmployees](./bitburner.office.numemployees.md) | | number | Amount of employees | -| [size](./bitburner.office.size.md) | | number | Maximum number of employee | -| [totalExperience](./bitburner.office.totalexperience.md) | | number | Total experience of all employees | + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[avgEnergy](./bitburner.office.avgenergy.md) + + + + + + + +number + + + + +Average energy of the employees + + +
+ +[avgMorale](./bitburner.office.avgmorale.md) + + + + + + + +number + + + + +Average morale of the employees + + +
+ +[city](./bitburner.office.city.md) + + + + + + + +[CityName](./bitburner.cityname.md) + + + + +City of the office + + +
+ +[employeeJobs](./bitburner.office.employeejobs.md) + + + + + + + +Record<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), number> + + + + +Positions of the employees + + +
+ +[employeeProductionByJob](./bitburner.office.employeeproductionbyjob.md) + + + + + + + +Record<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), number> + + + + +Production of the employees + + +
+ +[maxEnergy](./bitburner.office.maxenergy.md) + + + + + + + +number + + + + +Maximum amount of energy of the employees + + +
+ +[maxMorale](./bitburner.office.maxmorale.md) + + + + + + + +number + + + + +Maximum morale of the employees + + +
+ +[numEmployees](./bitburner.office.numemployees.md) + + + + + + + +number + + + + +Amount of employees + + +
+ +[size](./bitburner.office.size.md) + + + + + + + +number + + + + +Maximum number of employee + + +
+ +[totalExperience](./bitburner.office.totalexperience.md) + + + + + + + +number + + + + +Total experience of all employees + + +
diff --git a/markdown/bitburner.officeapi.buytea.md b/markdown/bitburner.officeapi.buytea.md index 5f6304c46..5b650c27f 100644 --- a/markdown/bitburner.officeapi.buytea.md +++ b/markdown/bitburner.officeapi.buytea.md @@ -14,10 +14,55 @@ buyTea(divisionName: string, city: CityName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.gethireadvertcost.md b/markdown/bitburner.officeapi.gethireadvertcost.md index 49a585a03..84f507a5a 100644 --- a/markdown/bitburner.officeapi.gethireadvertcost.md +++ b/markdown/bitburner.officeapi.gethireadvertcost.md @@ -14,9 +14,39 @@ getHireAdVertCost(divisionName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division. + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.gethireadvertcount.md b/markdown/bitburner.officeapi.gethireadvertcount.md index 201912e3c..7b1a8f243 100644 --- a/markdown/bitburner.officeapi.gethireadvertcount.md +++ b/markdown/bitburner.officeapi.gethireadvertcount.md @@ -14,9 +14,39 @@ getHireAdVertCount(divisionName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division. + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.getoffice.md b/markdown/bitburner.officeapi.getoffice.md index fc56eeaaa..ffa964c31 100644 --- a/markdown/bitburner.officeapi.getoffice.md +++ b/markdown/bitburner.officeapi.getoffice.md @@ -14,10 +14,55 @@ getOffice(divisionName: string, city: CityName): Office; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.getofficesizeupgradecost.md b/markdown/bitburner.officeapi.getofficesizeupgradecost.md index 074deff0b..627f35191 100644 --- a/markdown/bitburner.officeapi.getofficesizeupgradecost.md +++ b/markdown/bitburner.officeapi.getofficesizeupgradecost.md @@ -14,11 +14,71 @@ getOfficeSizeUpgradeCost(divisionName: string, city: CityName, size: number): nu ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| size | number | Amount of positions to open | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +size + + + + +number + + + + +Amount of positions to open + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.getresearchcost.md b/markdown/bitburner.officeapi.getresearchcost.md index d08893602..2dd6c535a 100644 --- a/markdown/bitburner.officeapi.getresearchcost.md +++ b/markdown/bitburner.officeapi.getresearchcost.md @@ -14,10 +14,55 @@ getResearchCost(divisionName: string, researchName: CorpResearchName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| researchName | [CorpResearchName](./bitburner.corpresearchname.md) | Name of the research | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +researchName + + + + +[CorpResearchName](./bitburner.corpresearchname.md) + + + + +Name of the research + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.hasresearched.md b/markdown/bitburner.officeapi.hasresearched.md index 2b942d734..d44d424fe 100644 --- a/markdown/bitburner.officeapi.hasresearched.md +++ b/markdown/bitburner.officeapi.hasresearched.md @@ -14,10 +14,55 @@ hasResearched(divisionName: string, researchName: CorpResearchName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| researchName | [CorpResearchName](./bitburner.corpresearchname.md) | Name of the research | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +researchName + + + + +[CorpResearchName](./bitburner.corpresearchname.md) + + + + +Name of the research + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.hireadvert.md b/markdown/bitburner.officeapi.hireadvert.md index d6f23fbce..12bd55d7b 100644 --- a/markdown/bitburner.officeapi.hireadvert.md +++ b/markdown/bitburner.officeapi.hireadvert.md @@ -14,9 +14,39 @@ hireAdVert(divisionName: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.hireemployee.md b/markdown/bitburner.officeapi.hireemployee.md index 6d10b69c0..cdeffc033 100644 --- a/markdown/bitburner.officeapi.hireemployee.md +++ b/markdown/bitburner.officeapi.hireemployee.md @@ -14,11 +14,71 @@ hireEmployee(divisionName: string, city: CityName, employeePosition?: CorpEmploy ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| employeePosition | [CorpEmployeePosition](./bitburner.corpemployeeposition.md) | _(Optional)_ Position to place into. Defaults to "Unassigned". | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +employeePosition + + + + +[CorpEmployeePosition](./bitburner.corpemployeeposition.md) + + + + +_(Optional)_ Position to place into. Defaults to "Unassigned". + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.md b/markdown/bitburner.officeapi.md index 2e58ed28b..75c921d86 100644 --- a/markdown/bitburner.officeapi.md +++ b/markdown/bitburner.officeapi.md @@ -18,19 +18,161 @@ Requires the Office API upgrade from your corporation. ## Methods -| Method | Description | -| --- | --- | -| [buyTea(divisionName, city)](./bitburner.officeapi.buytea.md) | Buy tea for your employees. | -| [getHireAdVertCost(divisionName)](./bitburner.officeapi.gethireadvertcost.md) | Get the cost to hire AdVert. | -| [getHireAdVertCount(divisionName)](./bitburner.officeapi.gethireadvertcount.md) | Get the number of times you have hired AdVert. | -| [getOffice(divisionName, city)](./bitburner.officeapi.getoffice.md) | Get data about an office. | -| [getOfficeSizeUpgradeCost(divisionName, city, size)](./bitburner.officeapi.getofficesizeupgradecost.md) | Get the cost to upgrade an office. | -| [getResearchCost(divisionName, researchName)](./bitburner.officeapi.getresearchcost.md) | Get the cost to unlock a research. | -| [hasResearched(divisionName, researchName)](./bitburner.officeapi.hasresearched.md) | Check if you unlocked a research. | -| [hireAdVert(divisionName)](./bitburner.officeapi.hireadvert.md) | Hire AdVert. | -| [hireEmployee(divisionName, city, employeePosition)](./bitburner.officeapi.hireemployee.md) | Hire an employee. | -| [research(divisionName, researchName)](./bitburner.officeapi.research.md) |

Purchase a research.

Some research is only available for product industries. This function does not do anything if you purchase that research for a material industry.

| -| [setJobAssignment(divisionName, city, job, amount)](./bitburner.officeapi.setjobassignment.md) | Set the job assignment for a job. | -| [throwParty(divisionName, city, costPerEmployee)](./bitburner.officeapi.throwparty.md) | Throw a party for your employees. | -| [upgradeOfficeSize(divisionName, city, size)](./bitburner.officeapi.upgradeofficesize.md) | Upgrade office size. | + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[buyTea(divisionName, city)](./bitburner.officeapi.buytea.md) + + + + +Buy tea for your employees. + + +
+ +[getHireAdVertCost(divisionName)](./bitburner.officeapi.gethireadvertcost.md) + + + + +Get the cost to hire AdVert. + + +
+ +[getHireAdVertCount(divisionName)](./bitburner.officeapi.gethireadvertcount.md) + + + + +Get the number of times you have hired AdVert. + + +
+ +[getOffice(divisionName, city)](./bitburner.officeapi.getoffice.md) + + + + +Get data about an office. + + +
+ +[getOfficeSizeUpgradeCost(divisionName, city, size)](./bitburner.officeapi.getofficesizeupgradecost.md) + + + + +Get the cost to upgrade an office. + + +
+ +[getResearchCost(divisionName, researchName)](./bitburner.officeapi.getresearchcost.md) + + + + +Get the cost to unlock a research. + + +
+ +[hasResearched(divisionName, researchName)](./bitburner.officeapi.hasresearched.md) + + + + +Check if you unlocked a research. + + +
+ +[hireAdVert(divisionName)](./bitburner.officeapi.hireadvert.md) + + + + +Hire AdVert. + + +
+ +[hireEmployee(divisionName, city, employeePosition)](./bitburner.officeapi.hireemployee.md) + + + + +Hire an employee. + + +
+ +[research(divisionName, researchName)](./bitburner.officeapi.research.md) + + + + +Purchase a research. + +Some research is only available for product industries. This function does not do anything if you purchase that research for a material industry. + + +
+ +[setJobAssignment(divisionName, city, job, amount)](./bitburner.officeapi.setjobassignment.md) + + + + +Set the job assignment for a job. + + +
+ +[throwParty(divisionName, city, costPerEmployee)](./bitburner.officeapi.throwparty.md) + + + + +Throw a party for your employees. + + +
+ +[upgradeOfficeSize(divisionName, city, size)](./bitburner.officeapi.upgradeofficesize.md) + + + + +Upgrade office size. + + +
diff --git a/markdown/bitburner.officeapi.research.md b/markdown/bitburner.officeapi.research.md index f14b19728..d2c89cc27 100644 --- a/markdown/bitburner.officeapi.research.md +++ b/markdown/bitburner.officeapi.research.md @@ -16,10 +16,55 @@ research(divisionName: string, researchName: CorpResearchName): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| researchName | [CorpResearchName](./bitburner.corpresearchname.md) | Name of the research | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +researchName + + + + +[CorpResearchName](./bitburner.corpresearchname.md) + + + + +Name of the research + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.setjobassignment.md b/markdown/bitburner.officeapi.setjobassignment.md index c24a07635..706e07aea 100644 --- a/markdown/bitburner.officeapi.setjobassignment.md +++ b/markdown/bitburner.officeapi.setjobassignment.md @@ -19,12 +19,87 @@ setJobAssignment( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| job | Exclude<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), "Unassigned"> | Name of the job. Passing "Unassigned" will cause this API to not do anything and just return false. | -| amount | number | Number of employees to assign to that job | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +job + + + + +Exclude<[CorpEmployeePosition](./bitburner.corpemployeeposition.md), "Unassigned"> + + + + +Name of the job. Passing "Unassigned" will cause this API to not do anything and just return false. + + +
+ +amount + + + + +number + + + + +Number of employees to assign to that job + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.throwparty.md b/markdown/bitburner.officeapi.throwparty.md index 32d7478e5..cc80a4ceb 100644 --- a/markdown/bitburner.officeapi.throwparty.md +++ b/markdown/bitburner.officeapi.throwparty.md @@ -14,11 +14,71 @@ throwParty(divisionName: string, city: CityName, costPerEmployee: number): numbe ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| costPerEmployee | number | Amount to spend per employee. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +costPerEmployee + + + + +number + + + + +Amount to spend per employee. + + +
**Returns:** diff --git a/markdown/bitburner.officeapi.upgradeofficesize.md b/markdown/bitburner.officeapi.upgradeofficesize.md index 8ec0dce5d..0e2842c75 100644 --- a/markdown/bitburner.officeapi.upgradeofficesize.md +++ b/markdown/bitburner.officeapi.upgradeofficesize.md @@ -14,11 +14,71 @@ upgradeOfficeSize(divisionName: string, city: CityName, size: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| size | number | Amount of positions to open | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +size + + + + +number + + + + +Amount of positions to open + + +
**Returns:** diff --git a/markdown/bitburner.peoplekilledrequirement.md b/markdown/bitburner.peoplekilledrequirement.md index 4b6f67ee3..9195286b9 100644 --- a/markdown/bitburner.peoplekilledrequirement.md +++ b/markdown/bitburner.peoplekilledrequirement.md @@ -14,8 +14,60 @@ interface PeopleKilledRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [numPeopleKilled](./bitburner.peoplekilledrequirement.numpeoplekilled.md) | | number | | -| [type](./bitburner.peoplekilledrequirement.type.md) | | "numPeopleKilled" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[numPeopleKilled](./bitburner.peoplekilledrequirement.numpeoplekilled.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.peoplekilledrequirement.type.md) + + + + + + + +"numPeopleKilled" + + + + + +
diff --git a/markdown/bitburner.person.md b/markdown/bitburner.person.md index 571bc20ce..4b0383785 100644 --- a/markdown/bitburner.person.md +++ b/markdown/bitburner.person.md @@ -13,11 +13,111 @@ interface Person ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [city](./bitburner.person.city.md) | | [CityName](./bitburner.cityname.md) | | -| [exp](./bitburner.person.exp.md) | | [Skills](./bitburner.skills.md) | | -| [hp](./bitburner.person.hp.md) | | [HP](./bitburner.hp.md) | | -| [mults](./bitburner.person.mults.md) | | [Multipliers](./bitburner.multipliers.md) | | -| [skills](./bitburner.person.skills.md) | | [Skills](./bitburner.skills.md) | | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[city](./bitburner.person.city.md) + + + + + + + +[CityName](./bitburner.cityname.md) + + + + + +
+ +[exp](./bitburner.person.exp.md) + + + + + + + +[Skills](./bitburner.skills.md) + + + + + +
+ +[hp](./bitburner.person.hp.md) + + + + + + + +[HP](./bitburner.hp.md) + + + + + +
+ +[mults](./bitburner.person.mults.md) + + + + + + + +[Multipliers](./bitburner.multipliers.md) + + + + + +
+ +[skills](./bitburner.person.skills.md) + + + + + + + +[Skills](./bitburner.skills.md) + + + + + +
diff --git a/markdown/bitburner.player.md b/markdown/bitburner.player.md index 9a27dc91c..13989e130 100644 --- a/markdown/bitburner.player.md +++ b/markdown/bitburner.player.md @@ -14,14 +14,162 @@ interface Player extends Person ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [entropy](./bitburner.player.entropy.md) | | number | | -| [factions](./bitburner.player.factions.md) | | string\[\] | | -| [jobs](./bitburner.player.jobs.md) | | Partial<Record<[CompanyName](./bitburner.companyname.md), [JobName](./bitburner.jobname.md)>> | | -| [karma](./bitburner.player.karma.md) | | number | | -| [location](./bitburner.player.location.md) | | [LocationName](./bitburner.locationname.md) | | -| [money](./bitburner.player.money.md) | | number | | -| [numPeopleKilled](./bitburner.player.numpeoplekilled.md) | | number | | -| [totalPlaytime](./bitburner.player.totalplaytime.md) | | number | | + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[entropy](./bitburner.player.entropy.md) + + + + + + + +number + + + + + +
+ +[factions](./bitburner.player.factions.md) + + + + + + + +string\[\] + + + + + +
+ +[jobs](./bitburner.player.jobs.md) + + + + + + + +Partial<Record<[CompanyName](./bitburner.companyname.md), [JobName](./bitburner.jobname.md)>> + + + + + +
+ +[karma](./bitburner.player.karma.md) + + + + + + + +number + + + + + +
+ +[location](./bitburner.player.location.md) + + + + + + + +[LocationName](./bitburner.locationname.md) + + + + + +
+ +[money](./bitburner.player.money.md) + + + + + + + +number + + + + + +
+ +[numPeopleKilled](./bitburner.player.numpeoplekilled.md) + + + + + + + +number + + + + + +
+ +[totalPlaytime](./bitburner.player.totalplaytime.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.processinfo.md b/markdown/bitburner.processinfo.md index c139545f2..ffbe723cd 100644 --- a/markdown/bitburner.processinfo.md +++ b/markdown/bitburner.processinfo.md @@ -14,11 +14,121 @@ interface ProcessInfo ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [args](./bitburner.processinfo.args.md) | | [ScriptArg](./bitburner.scriptarg.md)\[\] | Script's arguments | -| [filename](./bitburner.processinfo.filename.md) | | string | Script name. | -| [pid](./bitburner.processinfo.pid.md) | | number | Process ID | -| [temporary](./bitburner.processinfo.temporary.md) | | boolean | Whether this process is excluded from saves | -| [threads](./bitburner.processinfo.threads.md) | | number | Number of threads script is running with | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[args](./bitburner.processinfo.args.md) + + + + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Script's arguments + + +
+ +[filename](./bitburner.processinfo.filename.md) + + + + + + + +string + + + + +Script name. + + +
+ +[pid](./bitburner.processinfo.pid.md) + + + + + + + +number + + + + +Process ID + + +
+ +[temporary](./bitburner.processinfo.temporary.md) + + + + + + + +boolean + + + + +Whether this process is excluded from saves + + +
+ +[threads](./bitburner.processinfo.threads.md) + + + + + + + +number + + + + +Number of threads script is running with + + +
diff --git a/markdown/bitburner.product.md b/markdown/bitburner.product.md index 8ff6ad02e..a5f52f437 100644 --- a/markdown/bitburner.product.md +++ b/markdown/bitburner.product.md @@ -14,22 +14,330 @@ interface Product ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [actualSellAmount](./bitburner.product.actualsellamount.md) | | number | Amount of product sold last cycle | -| [advertisingInvestment](./bitburner.product.advertisinginvestment.md) | | number | Funds that were spent on advertising the product | -| [competition](./bitburner.product.competition.md) | | number \| undefined | Competition for the product, only present if "Market Research - Competition" unlocked | -| [demand](./bitburner.product.demand.md) | | number \| undefined | Demand for the product, only present if "Market Research - Demand" unlocked | -| [designInvestment](./bitburner.product.designinvestment.md) | | number | Funds that were spent on designing the product | -| [desiredSellAmount](./bitburner.product.desiredsellamount.md) | | string \| number | Desired sell amount, e.g. "PROD/2" | -| [desiredSellPrice](./bitburner.product.desiredsellprice.md) | | string \| number | Desired sell price, can be "MP+5" | -| [developmentProgress](./bitburner.product.developmentprogress.md) | | number | A number between 0-100 representing percentage completion | -| [effectiveRating](./bitburner.product.effectiverating.md) | | number | Effective rating in the specific city | -| [name](./bitburner.product.name.md) | | string | Name of the product | -| [productionAmount](./bitburner.product.productionamount.md) | | number | Amount of product produced last cycle | -| [productionCost](./bitburner.product.productioncost.md) | | number | Production cost | -| [rating](./bitburner.product.rating.md) | | number | Rating based on stats | -| [size](./bitburner.product.size.md) | | number | How much warehouse space is occupied per unit of this product | -| [stats](./bitburner.product.stats.md) | | { quality: number; performance: number; durability: number; reliability: number; aesthetics: number; features: number; } | Product stats | -| [stored](./bitburner.product.stored.md) | | number | Amount of product stored in warehouse | + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[actualSellAmount](./bitburner.product.actualsellamount.md) + + + + + + + +number + + + + +Amount of product sold last cycle + + +
+ +[advertisingInvestment](./bitburner.product.advertisinginvestment.md) + + + + + + + +number + + + + +Funds that were spent on advertising the product + + +
+ +[competition](./bitburner.product.competition.md) + + + + + + + +number \| undefined + + + + +Competition for the product, only present if "Market Research - Competition" unlocked + + +
+ +[demand](./bitburner.product.demand.md) + + + + + + + +number \| undefined + + + + +Demand for the product, only present if "Market Research - Demand" unlocked + + +
+ +[designInvestment](./bitburner.product.designinvestment.md) + + + + + + + +number + + + + +Funds that were spent on designing the product + + +
+ +[desiredSellAmount](./bitburner.product.desiredsellamount.md) + + + + + + + +string \| number + + + + +Desired sell amount, e.g. "PROD/2" + + +
+ +[desiredSellPrice](./bitburner.product.desiredsellprice.md) + + + + + + + +string \| number + + + + +Desired sell price, can be "MP+5" + + +
+ +[developmentProgress](./bitburner.product.developmentprogress.md) + + + + + + + +number + + + + +A number between 0-100 representing percentage completion + + +
+ +[effectiveRating](./bitburner.product.effectiverating.md) + + + + + + + +number + + + + +Effective rating in the specific city + + +
+ +[name](./bitburner.product.name.md) + + + + + + + +string + + + + +Name of the product + + +
+ +[productionAmount](./bitburner.product.productionamount.md) + + + + + + + +number + + + + +Amount of product produced last cycle + + +
+ +[productionCost](./bitburner.product.productioncost.md) + + + + + + + +number + + + + +Production cost + + +
+ +[rating](./bitburner.product.rating.md) + + + + + + + +number + + + + +Rating based on stats + + +
+ +[size](./bitburner.product.size.md) + + + + + + + +number + + + + +How much warehouse space is occupied per unit of this product + + +
+ +[stats](./bitburner.product.stats.md) + + + + + + + +{ quality: number; performance: number; durability: number; reliability: number; aesthetics: number; features: number; } + + + + +Product stats + + +
+ +[stored](./bitburner.product.stored.md) + + + + + + + +number + + + + +Amount of product stored in warehouse + + +
diff --git a/markdown/bitburner.reactelement.md b/markdown/bitburner.reactelement.md index abb71adee..dbaf13841 100644 --- a/markdown/bitburner.reactelement.md +++ b/markdown/bitburner.reactelement.md @@ -14,9 +14,77 @@ interface ReactElement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [key](./bitburner.reactelement.key.md) | | string \| number \| null | | -| [props](./bitburner.reactelement.props.md) | | any | | -| [type](./bitburner.reactelement.type.md) | | string \| ((props: any) => [ReactElement](./bitburner.reactelement.md) \| null) \| (new (props: any) => object) | | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[key](./bitburner.reactelement.key.md) + + + + + + + +string \| number \| null + + + + + +
+ +[props](./bitburner.reactelement.props.md) + + + + + + + +any + + + + + +
+ +[type](./bitburner.reactelement.type.md) + + + + + + + +string \| ((props: any) => [ReactElement](./bitburner.reactelement.md) \| null) \| (new (props: any) => object) + + + + + +
diff --git a/markdown/bitburner.recentscript.md b/markdown/bitburner.recentscript.md index e1c57a34e..c806c3805 100644 --- a/markdown/bitburner.recentscript.md +++ b/markdown/bitburner.recentscript.md @@ -14,7 +14,45 @@ interface RecentScript extends RunningScript ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [timeOfDeath](./bitburner.recentscript.timeofdeath.md) | | Date | Timestamp of when the script was killed | + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[timeOfDeath](./bitburner.recentscript.timeofdeath.md) + + + + + + + +Date + + + + +Timestamp of when the script was killed + + +
diff --git a/markdown/bitburner.reputationformulas.calculatefavortorep.md b/markdown/bitburner.reputationformulas.calculatefavortorep.md index 5fab32e5b..4fc48e957 100644 --- a/markdown/bitburner.reputationformulas.calculatefavortorep.md +++ b/markdown/bitburner.reputationformulas.calculatefavortorep.md @@ -14,9 +14,39 @@ calculateFavorToRep(favor: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| favor | number | target faction favor. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +favor + + + + +number + + + + +target faction favor. + + +
**Returns:** diff --git a/markdown/bitburner.reputationformulas.calculatereptofavor.md b/markdown/bitburner.reputationformulas.calculatereptofavor.md index 053c2beb7..67155d3d5 100644 --- a/markdown/bitburner.reputationformulas.calculatereptofavor.md +++ b/markdown/bitburner.reputationformulas.calculatereptofavor.md @@ -14,9 +14,39 @@ calculateRepToFavor(rep: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| rep | number | amount of reputation. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +rep + + + + +number + + + + +amount of reputation. + + +
**Returns:** diff --git a/markdown/bitburner.reputationformulas.donationforrep.md b/markdown/bitburner.reputationformulas.donationforrep.md index b41b33df1..ed7b7a21d 100644 --- a/markdown/bitburner.reputationformulas.donationforrep.md +++ b/markdown/bitburner.reputationformulas.donationforrep.md @@ -14,10 +14,55 @@ donationForRep(reputation: number, player: Person): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| reputation | number | Amount of reputation | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +reputation + + + + +number + + + + +Amount of reputation + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
**Returns:** diff --git a/markdown/bitburner.reputationformulas.md b/markdown/bitburner.reputationformulas.md index c4bfc5253..acb103bdd 100644 --- a/markdown/bitburner.reputationformulas.md +++ b/markdown/bitburner.reputationformulas.md @@ -14,11 +14,71 @@ interface ReputationFormulas ## Methods -| Method | Description | -| --- | --- | -| [calculateFavorToRep(favor)](./bitburner.reputationformulas.calculatefavortorep.md) | Calculate the total required amount of faction reputation to reach a target favor. | -| [calculateRepToFavor(rep)](./bitburner.reputationformulas.calculatereptofavor.md) | Calculate the resulting faction favor of a total amount of reputation. (Faction favor is gained whenever you install an Augmentation.) | -| [donationForRep(reputation, player)](./bitburner.reputationformulas.donationforrep.md) | Calculate the donation needed to gain an amount of reputation. | -| [repFromDonation(amount, player)](./bitburner.reputationformulas.repfromdonation.md) | Calculate how much rep would be gained. | -| [sharePower(threads, cpuCores)](./bitburner.reputationformulas.sharepower.md) | Calculate the share power if you call [ns.share](./bitburner.ns.share.md) with the specified number of threads on a server having the specified number of CPU cores. | + + + + + + +
+ +Method + + + + +Description + + +
+ +[calculateFavorToRep(favor)](./bitburner.reputationformulas.calculatefavortorep.md) + + + + +Calculate the total required amount of faction reputation to reach a target favor. + + +
+ +[calculateRepToFavor(rep)](./bitburner.reputationformulas.calculatereptofavor.md) + + + + +Calculate the resulting faction favor of a total amount of reputation. (Faction favor is gained whenever you install an Augmentation.) + + +
+ +[donationForRep(reputation, player)](./bitburner.reputationformulas.donationforrep.md) + + + + +Calculate the donation needed to gain an amount of reputation. + + +
+ +[repFromDonation(amount, player)](./bitburner.reputationformulas.repfromdonation.md) + + + + +Calculate how much rep would be gained. + + +
+ +[sharePower(threads, cpuCores)](./bitburner.reputationformulas.sharepower.md) + + + + +Calculate the share power if you call [ns.share](./bitburner.ns.share.md) with the specified number of threads on a server having the specified number of CPU cores. + + +
diff --git a/markdown/bitburner.reputationformulas.repfromdonation.md b/markdown/bitburner.reputationformulas.repfromdonation.md index 2b003c106..fb62cd37e 100644 --- a/markdown/bitburner.reputationformulas.repfromdonation.md +++ b/markdown/bitburner.reputationformulas.repfromdonation.md @@ -14,10 +14,55 @@ repFromDonation(amount: number, player: Person): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| amount | number | Amount of money donated | -| player | [Person](./bitburner.person.md) | Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +amount + + + + +number + + + + +Amount of money donated + + +
+ +player + + + + +[Person](./bitburner.person.md) + + + + +Player info, typically from [getPlayer](./bitburner.ns.getplayer.md) + + +
**Returns:** diff --git a/markdown/bitburner.reputationformulas.sharepower.md b/markdown/bitburner.reputationformulas.sharepower.md index 708e1f576..41630c37f 100644 --- a/markdown/bitburner.reputationformulas.sharepower.md +++ b/markdown/bitburner.reputationformulas.sharepower.md @@ -14,10 +14,55 @@ sharePower(threads: number, cpuCores?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| threads | number | Number of threads. Must be a positive integer. | -| cpuCores | number | _(Optional)_ Number of CPU cores. Must be a positive integer. The default value is 1. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +threads + + + + +number + + + + +Number of threads. Must be a positive integer. + + +
+ +cpuCores + + + + +number + + + + +_(Optional)_ Number of CPU cores. Must be a positive integer. The default value is 1. + + +
**Returns:** diff --git a/markdown/bitburner.resetinfo.md b/markdown/bitburner.resetinfo.md index 023835a03..d1a414e78 100644 --- a/markdown/bitburner.resetinfo.md +++ b/markdown/bitburner.resetinfo.md @@ -14,12 +14,144 @@ interface ResetInfo ## Properties -| 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 | -| [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 | -| [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 source files. Its keys are the SF numbers. Its values are the active SF levels. This map takes BitNode options into account.

For example, let's say you have SF 1.3, but you overrode the active level of SF1 and set it to level 1. In this case, this map contains this entry: Key: 1 => Value: 1.

If the active level of a source file is 0, that source file won't be included in the result.

| + + + + + + + +
+ +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 + + +
+ +[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 + + +
+ +[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 source files. Its keys are the SF numbers. Its values are the active SF levels. This map takes BitNode options into account. + +For example, let's say you have SF 1.3, but you overrode the active level of SF1 and set it to level 1. In this case, this map contains this entry: Key: 1 => Value: 1. + +If the active level of a source file is 0, that source file won't be included in the result. + + +
diff --git a/markdown/bitburner.runningscript.md b/markdown/bitburner.runningscript.md index 248b36545..649d78c40 100644 --- a/markdown/bitburner.runningscript.md +++ b/markdown/bitburner.runningscript.md @@ -13,24 +13,372 @@ interface RunningScript ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [args](./bitburner.runningscript.args.md) | | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments the script was called with | -| [dynamicRamUsage](./bitburner.runningscript.dynamicramusage.md) | | number \| undefined |

The dynamic RAM usage of (one thread of) this script instance. Does not affect overall RAM consumption (ramUsage is for that), but rather shows how much of the reserved RAM is currently in use via all the ns functions the script has called. Initially 1.6GB, this increases as new functions are called.

Only set for scripts that are still running.

| -| [filename](./bitburner.runningscript.filename.md) | | string | Filename of the script | -| [logs](./bitburner.runningscript.logs.md) | | string\[\] | Script logs as an array. The newest log entries are at the bottom. Timestamps, if enabled, are placed inside [brackets] at the start of each line. | -| [offlineExpGained](./bitburner.runningscript.offlineexpgained.md) | | number | Total amount of hacking experience earned from this script when offline | -| [offlineMoneyMade](./bitburner.runningscript.offlinemoneymade.md) | | number | Total amount of money made by this script when offline | -| [offlineRunningTime](./bitburner.runningscript.offlinerunningtime.md) | | number | Number of seconds that the script has been running offline | -| [onlineExpGained](./bitburner.runningscript.onlineexpgained.md) | | number | Total amount of hacking experience earned from this script when online | -| [onlineMoneyMade](./bitburner.runningscript.onlinemoneymade.md) | | number | Total amount of money made by this script when online | -| [onlineRunningTime](./bitburner.runningscript.onlinerunningtime.md) | | number | Number of seconds that this script has been running online | -| [parent](./bitburner.runningscript.parent.md) | | number |

Process ID of the parent process.

If this script was started by another script, this will be the PID of that script. If this script was started directly through the terminal, the value will be 0.

| -| [pid](./bitburner.runningscript.pid.md) | | number | Process ID. Must be an integer | -| [ramUsage](./bitburner.runningscript.ramusage.md) | | number | How much RAM this script uses for ONE thread. Also known as "static RAM usage," this value does not change once the script is started, unless you call ns.ramOverride(). | -| [server](./bitburner.runningscript.server.md) | | string | Hostname of the server on which this script runs | -| [tailProperties](./bitburner.runningscript.tailproperties.md) | | [TailProperties](./bitburner.tailproperties.md) \| null | Properties of the tail window, or null if it is not shown | -| [temporary](./bitburner.runningscript.temporary.md) | | boolean | Whether this RunningScript is excluded from saves | -| [threads](./bitburner.runningscript.threads.md) | | number | Number of threads that this script runs with | -| [title](./bitburner.runningscript.title.md) | | string \| [ReactElement](./bitburner.reactelement.md) | The title, as shown in the script's log box. Defaults to the name + args, but can be changed by the user. If it is set to a React element (only by the user), that will not be persisted, and will be restored to default on load. | + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[args](./bitburner.runningscript.args.md) + + + + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments the script was called with + + +
+ +[dynamicRamUsage](./bitburner.runningscript.dynamicramusage.md) + + + + + + + +number \| undefined + + + + +The dynamic RAM usage of (one thread of) this script instance. Does not affect overall RAM consumption (ramUsage is for that), but rather shows how much of the reserved RAM is currently in use via all the ns functions the script has called. Initially 1.6GB, this increases as new functions are called. + +Only set for scripts that are still running. + + +
+ +[filename](./bitburner.runningscript.filename.md) + + + + + + + +string + + + + +Filename of the script + + +
+ +[logs](./bitburner.runningscript.logs.md) + + + + + + + +string\[\] + + + + +Script logs as an array. The newest log entries are at the bottom. Timestamps, if enabled, are placed inside `[brackets]` at the start of each line. + + +
+ +[offlineExpGained](./bitburner.runningscript.offlineexpgained.md) + + + + + + + +number + + + + +Total amount of hacking experience earned from this script when offline + + +
+ +[offlineMoneyMade](./bitburner.runningscript.offlinemoneymade.md) + + + + + + + +number + + + + +Total amount of money made by this script when offline + + +
+ +[offlineRunningTime](./bitburner.runningscript.offlinerunningtime.md) + + + + + + + +number + + + + +Number of seconds that the script has been running offline + + +
+ +[onlineExpGained](./bitburner.runningscript.onlineexpgained.md) + + + + + + + +number + + + + +Total amount of hacking experience earned from this script when online + + +
+ +[onlineMoneyMade](./bitburner.runningscript.onlinemoneymade.md) + + + + + + + +number + + + + +Total amount of money made by this script when online + + +
+ +[onlineRunningTime](./bitburner.runningscript.onlinerunningtime.md) + + + + + + + +number + + + + +Number of seconds that this script has been running online + + +
+ +[parent](./bitburner.runningscript.parent.md) + + + + + + + +number + + + + +Process ID of the parent process. + +If this script was started by another script, this will be the PID of that script. If this script was started directly through the terminal, the value will be 0. + + +
+ +[pid](./bitburner.runningscript.pid.md) + + + + + + + +number + + + + +Process ID. Must be an integer + + +
+ +[ramUsage](./bitburner.runningscript.ramusage.md) + + + + + + + +number + + + + +How much RAM this script uses for ONE thread. Also known as "static RAM usage," this value does not change once the script is started, unless you call ns.ramOverride(). + + +
+ +[server](./bitburner.runningscript.server.md) + + + + + + + +string + + + + +Hostname of the server on which this script runs + + +
+ +[tailProperties](./bitburner.runningscript.tailproperties.md) + + + + + + + +[TailProperties](./bitburner.tailproperties.md) \| null + + + + +Properties of the tail window, or null if it is not shown + + +
+ +[temporary](./bitburner.runningscript.temporary.md) + + + + + + + +boolean + + + + +Whether this RunningScript is excluded from saves + + +
+ +[threads](./bitburner.runningscript.threads.md) + + + + + + + +number + + + + +Number of threads that this script runs with + + +
+ +[title](./bitburner.runningscript.title.md) + + + + + + + +string \| [ReactElement](./bitburner.reactelement.md) + + + + +The title, as shown in the script's log box. Defaults to the name + args, but can be changed by the user. If it is set to a React element (only by the user), that will not be persisted, and will be restored to default on load. + + +
diff --git a/markdown/bitburner.runoptions.md b/markdown/bitburner.runoptions.md index 274958f0a..3deba55aa 100644 --- a/markdown/bitburner.runoptions.md +++ b/markdown/bitburner.runoptions.md @@ -13,10 +13,108 @@ interface RunOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [preventDuplicates?](./bitburner.runoptions.preventduplicates.md) | | boolean | _(Optional)_ Should we fail to run if another instance is running with the exact same arguments? This used to be the default behavior, now defaults to false. | -| [ramOverride?](./bitburner.runoptions.ramoverride.md) | | number |

_(Optional)_ The RAM allocation to launch each thread of the script with.

Lowering this will not automatically let you get away with using less RAM: the dynamic RAM check enforces that all [NS](./bitburner.ns.md) functions actually called incur their cost. However, if you know that certain functions that are statically present (and thus included in the static RAM cost) will never be called in a particular circumstance, you can use this to avoid paying for them.

You can also use this to increase the RAM if the static RAM checker has missed functions that you need to call.

Must be greater-or-equal to the base RAM cost. Will be rounded to the nearest hundredth-of-a-GB, which is the granularity of all RAM calculations. Defaults to the statically calculated cost.

| -| [temporary?](./bitburner.runoptions.temporary.md) | | boolean | _(Optional)_ Whether this script is excluded from saves, defaults to false | -| [threads?](./bitburner.runoptions.threads.md) | | number | _(Optional)_ Number of threads that the script will run with, defaults to 1 | + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[preventDuplicates?](./bitburner.runoptions.preventduplicates.md) + + + + + + + +boolean + + + + +_(Optional)_ Should we fail to run if another instance is running with the exact same arguments? This used to be the default behavior, now defaults to false. + + +
+ +[ramOverride?](./bitburner.runoptions.ramoverride.md) + + + + + + + +number + + + + +_(Optional)_ The RAM allocation to launch each thread of the script with. + +Lowering this will not automatically let you get away with using less RAM: the dynamic RAM check enforces that all [NS](./bitburner.ns.md) functions actually called incur their cost. However, if you know that certain functions that are statically present (and thus included in the static RAM cost) will never be called in a particular circumstance, you can use this to avoid paying for them. + +You can also use this to increase the RAM if the static RAM checker has missed functions that you need to call. + +Must be greater-or-equal to the base RAM cost. Will be rounded to the nearest hundredth-of-a-GB, which is the granularity of all RAM calculations. Defaults to the statically calculated cost. + + +
+ +[temporary?](./bitburner.runoptions.temporary.md) + + + + + + + +boolean + + + + +_(Optional)_ Whether this script is excluded from saves, defaults to false + + +
+ +[threads?](./bitburner.runoptions.threads.md) + + + + + + + +number + + + + +_(Optional)_ Number of threads that the script will run with, defaults to 1 + + +
diff --git a/markdown/bitburner.server.md b/markdown/bitburner.server.md index 6308a36bd..1b6f460b5 100644 --- a/markdown/bitburner.server.md +++ b/markdown/bitburner.server.md @@ -14,30 +14,482 @@ export interface Server ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [backdoorInstalled?](./bitburner.server.backdoorinstalled.md) | | boolean | _(Optional)_ Flag indicating whether this server has a backdoor installed by a player | -| [baseDifficulty?](./bitburner.server.basedifficulty.md) | | number | _(Optional)_ Server's initial server security level at creation. | -| [cpuCores](./bitburner.server.cpucores.md) | | number | How many CPU cores this server has. Affects magnitude of grow and weaken ran from this server. | -| [ftpPortOpen](./bitburner.server.ftpportopen.md) | | boolean | Whether or not the FTP port is open | -| [hackDifficulty?](./bitburner.server.hackdifficulty.md) | | number | _(Optional)_ Server Security Level | -| [hasAdminRights](./bitburner.server.hasadminrights.md) | | boolean | Flag indicating whether player has admin/root access to this server | -| [hostname](./bitburner.server.hostname.md) | | string | Hostname. Must be unique | -| [httpPortOpen](./bitburner.server.httpportopen.md) | | boolean | Whether or not the HTTP Port is open | -| [ip](./bitburner.server.ip.md) | | string | IP Address. Must be unique | -| [isConnectedTo](./bitburner.server.isconnectedto.md) | | boolean | Flag indicating whether player is currently connected to this server | -| [maxRam](./bitburner.server.maxram.md) | | number | RAM (GB) available on this server | -| [minDifficulty?](./bitburner.server.mindifficulty.md) | | number | _(Optional)_ Minimum server security level that this server can be weakened to | -| [moneyAvailable?](./bitburner.server.moneyavailable.md) | | number | _(Optional)_ How much money currently resides on the server and can be hacked | -| [moneyMax?](./bitburner.server.moneymax.md) | | number | _(Optional)_ Maximum amount of money that this server can hold | -| [numOpenPortsRequired?](./bitburner.server.numopenportsrequired.md) | | number | _(Optional)_ Number of open ports required in order to gain admin/root access | -| [openPortCount?](./bitburner.server.openportcount.md) | | number | _(Optional)_ How many ports are currently opened on the server | -| [organizationName](./bitburner.server.organizationname.md) | | string | Name of company/faction/etc. that this server belongs to, not applicable to all Servers | -| [purchasedByPlayer](./bitburner.server.purchasedbyplayer.md) | | boolean | Flag indicating whether this is a purchased server | -| [ramUsed](./bitburner.server.ramused.md) | | number | RAM (GB) used. i.e. unavailable RAM | -| [requiredHackingSkill?](./bitburner.server.requiredhackingskill.md) | | number | _(Optional)_ Hacking level required to hack this server | -| [serverGrowth?](./bitburner.server.servergrowth.md) | | number | _(Optional)_ Growth effectiveness statistic. Higher values produce more growth with ns.grow() | -| [smtpPortOpen](./bitburner.server.smtpportopen.md) | | boolean | Whether or not the SMTP Port is open | -| [sqlPortOpen](./bitburner.server.sqlportopen.md) | | boolean | Whether or not the SQL Port is open | -| [sshPortOpen](./bitburner.server.sshportopen.md) | | boolean | Whether or not the SSH Port is open | + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[backdoorInstalled?](./bitburner.server.backdoorinstalled.md) + + + + + + + +boolean + + + + +_(Optional)_ Flag indicating whether this server has a backdoor installed by a player + + +
+ +[baseDifficulty?](./bitburner.server.basedifficulty.md) + + + + + + + +number + + + + +_(Optional)_ Server's initial server security level at creation. + + +
+ +[cpuCores](./bitburner.server.cpucores.md) + + + + + + + +number + + + + +How many CPU cores this server has. Affects magnitude of grow and weaken ran from this server. + + +
+ +[ftpPortOpen](./bitburner.server.ftpportopen.md) + + + + + + + +boolean + + + + +Whether or not the FTP port is open + + +
+ +[hackDifficulty?](./bitburner.server.hackdifficulty.md) + + + + + + + +number + + + + +_(Optional)_ Server Security Level + + +
+ +[hasAdminRights](./bitburner.server.hasadminrights.md) + + + + + + + +boolean + + + + +Flag indicating whether player has admin/root access to this server + + +
+ +[hostname](./bitburner.server.hostname.md) + + + + + + + +string + + + + +Hostname. Must be unique + + +
+ +[httpPortOpen](./bitburner.server.httpportopen.md) + + + + + + + +boolean + + + + +Whether or not the HTTP Port is open + + +
+ +[ip](./bitburner.server.ip.md) + + + + + + + +string + + + + +IP Address. Must be unique + + +
+ +[isConnectedTo](./bitburner.server.isconnectedto.md) + + + + + + + +boolean + + + + +Flag indicating whether player is currently connected to this server + + +
+ +[maxRam](./bitburner.server.maxram.md) + + + + + + + +number + + + + +RAM (GB) available on this server + + +
+ +[minDifficulty?](./bitburner.server.mindifficulty.md) + + + + + + + +number + + + + +_(Optional)_ Minimum server security level that this server can be weakened to + + +
+ +[moneyAvailable?](./bitburner.server.moneyavailable.md) + + + + + + + +number + + + + +_(Optional)_ How much money currently resides on the server and can be hacked + + +
+ +[moneyMax?](./bitburner.server.moneymax.md) + + + + + + + +number + + + + +_(Optional)_ Maximum amount of money that this server can hold + + +
+ +[numOpenPortsRequired?](./bitburner.server.numopenportsrequired.md) + + + + + + + +number + + + + +_(Optional)_ Number of open ports required in order to gain admin/root access + + +
+ +[openPortCount?](./bitburner.server.openportcount.md) + + + + + + + +number + + + + +_(Optional)_ How many ports are currently opened on the server + + +
+ +[organizationName](./bitburner.server.organizationname.md) + + + + + + + +string + + + + +Name of company/faction/etc. that this server belongs to, not applicable to all Servers + + +
+ +[purchasedByPlayer](./bitburner.server.purchasedbyplayer.md) + + + + + + + +boolean + + + + +Flag indicating whether this is a purchased server + + +
+ +[ramUsed](./bitburner.server.ramused.md) + + + + + + + +number + + + + +RAM (GB) used. i.e. unavailable RAM + + +
+ +[requiredHackingSkill?](./bitburner.server.requiredhackingskill.md) + + + + + + + +number + + + + +_(Optional)_ Hacking level required to hack this server + + +
+ +[serverGrowth?](./bitburner.server.servergrowth.md) + + + + + + + +number + + + + +_(Optional)_ Growth effectiveness statistic. Higher values produce more growth with ns.grow() + + +
+ +[smtpPortOpen](./bitburner.server.smtpportopen.md) + + + + + + + +boolean + + + + +Whether or not the SMTP Port is open + + +
+ +[sqlPortOpen](./bitburner.server.sqlportopen.md) + + + + + + + +boolean + + + + +Whether or not the SQL Port is open + + +
+ +[sshPortOpen](./bitburner.server.sshportopen.md) + + + + + + + +boolean + + + + +Whether or not the SSH Port is open + + +
diff --git a/markdown/bitburner.singularity.applytocompany.md b/markdown/bitburner.singularity.applytocompany.md index 9c8579d86..8255a2faa 100644 --- a/markdown/bitburner.singularity.applytocompany.md +++ b/markdown/bitburner.singularity.applytocompany.md @@ -14,10 +14,55 @@ applyToCompany(companyName: CompanyName, field: JobField): JobName | null; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to apply to. | -| field | [JobField](./bitburner.jobfield.md) | Field to which you want to apply. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of company to apply to. + + +
+ +field + + + + +[JobField](./bitburner.jobfield.md) + + + + +Field to which you want to apply. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.b1tflum3.md b/markdown/bitburner.singularity.b1tflum3.md index 7977db281..07206c93c 100644 --- a/markdown/bitburner.singularity.b1tflum3.md +++ b/markdown/bitburner.singularity.b1tflum3.md @@ -14,11 +14,71 @@ b1tflum3(nextBN: number, callbackScript?: string, bitNodeOptions?: BitNodeOption ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| nextBN | number | BN number to jump to | -| callbackScript | string | _(Optional)_ Name of the script to launch in the next BN. | -| bitNodeOptions | [BitNodeOptions](./bitburner.bitnodeoptions.md) | _(Optional)_ BitNode options for the next BN. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +nextBN + + + + +number + + + + +BN number to jump to + + +
+ +callbackScript + + + + +string + + + + +_(Optional)_ Name of the script to launch in the next BN. + + +
+ +bitNodeOptions + + + + +[BitNodeOptions](./bitburner.bitnodeoptions.md) + + + + +_(Optional)_ BitNode options for the next BN. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.cat.md b/markdown/bitburner.singularity.cat.md index bcd4dd639..cade221c4 100644 --- a/markdown/bitburner.singularity.cat.md +++ b/markdown/bitburner.singularity.cat.md @@ -14,9 +14,39 @@ cat(filename: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| filename | string | Name of the file to display, including its extension. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +filename + + + + +string + + + + +Name of the file to display, including its extension. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.commitcrime.md b/markdown/bitburner.singularity.commitcrime.md index abd5229ca..d4b9801fa 100644 --- a/markdown/bitburner.singularity.commitcrime.md +++ b/markdown/bitburner.singularity.commitcrime.md @@ -14,10 +14,55 @@ commitCrime(crime: CrimeType, focus?: boolean): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime to attempt. | -| focus | boolean | _(Optional)_ Acquire player focus on this crime. Optional. Defaults to true. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +crime + + + + +[CrimeType](./bitburner.crimetype.md) + + + + +Name of crime to attempt. + + +
+ +focus + + + + +boolean + + + + +_(Optional)_ Acquire player focus on this crime. Optional. Defaults to true. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.connect.md b/markdown/bitburner.singularity.connect.md index 84f9d6148..6acb9a4ae 100644 --- a/markdown/bitburner.singularity.connect.md +++ b/markdown/bitburner.singularity.connect.md @@ -14,9 +14,37 @@ connect(host: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| host | string | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +host + + + + +string + + + + + +
**Returns:** diff --git a/markdown/bitburner.singularity.createprogram.md b/markdown/bitburner.singularity.createprogram.md index 82283aa33..47c969e96 100644 --- a/markdown/bitburner.singularity.createprogram.md +++ b/markdown/bitburner.singularity.createprogram.md @@ -14,10 +14,55 @@ createProgram(program: string, focus?: boolean): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| program | string | Name of program to create. | -| focus | boolean | _(Optional)_ Acquire player focus on this program creation. Optional. Defaults to true. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +program + + + + +string + + + + +Name of program to create. + + +
+ +focus + + + + +boolean + + + + +_(Optional)_ Acquire player focus on this program creation. Optional. Defaults to true. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.destroyw0r1dd43m0n.md b/markdown/bitburner.singularity.destroyw0r1dd43m0n.md index accdb02b1..8f53e7bff 100644 --- a/markdown/bitburner.singularity.destroyw0r1dd43m0n.md +++ b/markdown/bitburner.singularity.destroyw0r1dd43m0n.md @@ -14,11 +14,71 @@ destroyW0r1dD43m0n(nextBN: number, callbackScript?: string, bitNodeOptions?: Bit ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| nextBN | number | BN number to jump to | -| callbackScript | string | _(Optional)_ Name of the script to launch in the next BN. | -| bitNodeOptions | [BitNodeOptions](./bitburner.bitnodeoptions.md) | _(Optional)_ BitNode options for the next BN. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +nextBN + + + + +number + + + + +BN number to jump to + + +
+ +callbackScript + + + + +string + + + + +_(Optional)_ Name of the script to launch in the next BN. + + +
+ +bitNodeOptions + + + + +[BitNodeOptions](./bitburner.bitnodeoptions.md) + + + + +_(Optional)_ BitNode options for the next BN. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.donatetofaction.md b/markdown/bitburner.singularity.donatetofaction.md index d4380fcbf..2b87c7e25 100644 --- a/markdown/bitburner.singularity.donatetofaction.md +++ b/markdown/bitburner.singularity.donatetofaction.md @@ -14,10 +14,55 @@ donateToFaction(faction: FactionName, amount: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to donate to. | -| amount | number | Amount of money to donate. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction to donate to. + + +
+ +amount + + + + +number + + + + +Amount of money to donate. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getaugmentationbaseprice.md b/markdown/bitburner.singularity.getaugmentationbaseprice.md index 61309a968..4888bd3bb 100644 --- a/markdown/bitburner.singularity.getaugmentationbaseprice.md +++ b/markdown/bitburner.singularity.getaugmentationbaseprice.md @@ -14,9 +14,39 @@ getAugmentationBasePrice(augName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of Augmentation. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of Augmentation. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getaugmentationfactions.md b/markdown/bitburner.singularity.getaugmentationfactions.md index 2ffa06009..ed33495ba 100644 --- a/markdown/bitburner.singularity.getaugmentationfactions.md +++ b/markdown/bitburner.singularity.getaugmentationfactions.md @@ -14,9 +14,39 @@ getAugmentationFactions(augName: string): FactionName[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of Augmentation. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of Augmentation. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getaugmentationprereq.md b/markdown/bitburner.singularity.getaugmentationprereq.md index 754c21660..4c33aa556 100644 --- a/markdown/bitburner.singularity.getaugmentationprereq.md +++ b/markdown/bitburner.singularity.getaugmentationprereq.md @@ -14,9 +14,39 @@ getAugmentationPrereq(augName: string): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of Augmentation. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of Augmentation. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getaugmentationprice.md b/markdown/bitburner.singularity.getaugmentationprice.md index a21cd9cf2..0c1d08212 100644 --- a/markdown/bitburner.singularity.getaugmentationprice.md +++ b/markdown/bitburner.singularity.getaugmentationprice.md @@ -14,9 +14,39 @@ getAugmentationPrice(augName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of Augmentation. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of Augmentation. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getaugmentationrepreq.md b/markdown/bitburner.singularity.getaugmentationrepreq.md index d1583f4f4..9e9de3111 100644 --- a/markdown/bitburner.singularity.getaugmentationrepreq.md +++ b/markdown/bitburner.singularity.getaugmentationrepreq.md @@ -14,9 +14,39 @@ getAugmentationRepReq(augName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of Augmentation. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of Augmentation. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getaugmentationsfromfaction.md b/markdown/bitburner.singularity.getaugmentationsfromfaction.md index 31f7dfdbc..d6186960f 100644 --- a/markdown/bitburner.singularity.getaugmentationsfromfaction.md +++ b/markdown/bitburner.singularity.getaugmentationsfromfaction.md @@ -14,9 +14,39 @@ getAugmentationsFromFaction(faction: FactionName): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getaugmentationstats.md b/markdown/bitburner.singularity.getaugmentationstats.md index 2cd3134e5..2383fdc42 100644 --- a/markdown/bitburner.singularity.getaugmentationstats.md +++ b/markdown/bitburner.singularity.getaugmentationstats.md @@ -14,9 +14,39 @@ getAugmentationStats(name: string): Multipliers; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| name | string | Name of Augmentation. CASE-SENSITIVE. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +name + + + + +string + + + + +Name of Augmentation. CASE-SENSITIVE. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getcompanyfavor.md b/markdown/bitburner.singularity.getcompanyfavor.md index fb2bdc400..47a4f6e78 100644 --- a/markdown/bitburner.singularity.getcompanyfavor.md +++ b/markdown/bitburner.singularity.getcompanyfavor.md @@ -14,9 +14,39 @@ getCompanyFavor(companyName: CompanyName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of the company. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getcompanyfavorgain.md b/markdown/bitburner.singularity.getcompanyfavorgain.md index 7e68d0e2f..4a69943fc 100644 --- a/markdown/bitburner.singularity.getcompanyfavorgain.md +++ b/markdown/bitburner.singularity.getcompanyfavorgain.md @@ -14,9 +14,39 @@ getCompanyFavorGain(companyName: CompanyName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of the company. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getcompanypositioninfo.md b/markdown/bitburner.singularity.getcompanypositioninfo.md index 2f3b40969..4af8b6e99 100644 --- a/markdown/bitburner.singularity.getcompanypositioninfo.md +++ b/markdown/bitburner.singularity.getcompanypositioninfo.md @@ -14,10 +14,55 @@ getCompanyPositionInfo(companyName: CompanyName, positionName: JobName): Company ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to get the requirements for. Must be an exact match. | -| positionName | [JobName](./bitburner.jobname.md) | Name of position to get the requirements for. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of company to get the requirements for. Must be an exact match. + + +
+ +positionName + + + + +[JobName](./bitburner.jobname.md) + + + + +Name of position to get the requirements for. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getcompanypositions.md b/markdown/bitburner.singularity.getcompanypositions.md index 3e75b7a1c..19f1ce728 100644 --- a/markdown/bitburner.singularity.getcompanypositions.md +++ b/markdown/bitburner.singularity.getcompanypositions.md @@ -14,9 +14,39 @@ getCompanyPositions(companyName: CompanyName): JobName[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to get the position list for. Must be an exact match. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of company to get the position list for. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getcompanyrep.md b/markdown/bitburner.singularity.getcompanyrep.md index 3953d0367..c225536fa 100644 --- a/markdown/bitburner.singularity.getcompanyrep.md +++ b/markdown/bitburner.singularity.getcompanyrep.md @@ -14,9 +14,39 @@ getCompanyRep(companyName: CompanyName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of the company. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getcrimechance.md b/markdown/bitburner.singularity.getcrimechance.md index 202ec0d8b..11a909267 100644 --- a/markdown/bitburner.singularity.getcrimechance.md +++ b/markdown/bitburner.singularity.getcrimechance.md @@ -14,9 +14,39 @@ getCrimeChance(crime: CrimeType): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +crime + + + + +[CrimeType](./bitburner.crimetype.md) + + + + +Name of crime. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getcrimestats.md b/markdown/bitburner.singularity.getcrimestats.md index 3d411b4f7..acc9a8f34 100644 --- a/markdown/bitburner.singularity.getcrimestats.md +++ b/markdown/bitburner.singularity.getcrimestats.md @@ -14,9 +14,39 @@ getCrimeStats(crime: CrimeType): CrimeStats; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| crime | [CrimeType](./bitburner.crimetype.md) | Name of crime. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +crime + + + + +[CrimeType](./bitburner.crimetype.md) + + + + +Name of crime. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getcurrentserver.md b/markdown/bitburner.singularity.getcurrentserver.md index 1dbbfac4c..25017aa34 100644 --- a/markdown/bitburner.singularity.getcurrentserver.md +++ b/markdown/bitburner.singularity.getcurrentserver.md @@ -14,9 +14,39 @@ getCurrentServer(returnOpts?: HostReturnOptions): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| returnOpts | [HostReturnOptions](./bitburner.hostreturnoptions.md) | _(Optional)_ Optional. Controls whether the function returns an IP. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +returnOpts + + + + +[HostReturnOptions](./bitburner.hostreturnoptions.md) + + + + +_(Optional)_ Optional. Controls whether the function returns an IP. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getdarkwebprogramcost.md b/markdown/bitburner.singularity.getdarkwebprogramcost.md index 76474d573..cc3cb08de 100644 --- a/markdown/bitburner.singularity.getdarkwebprogramcost.md +++ b/markdown/bitburner.singularity.getdarkwebprogramcost.md @@ -14,9 +14,39 @@ getDarkwebProgramCost(programName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| programName | string | Name of program to check the price of | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +programName + + + + +string + + + + +Name of program to check the price of + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getfactionenemies.md b/markdown/bitburner.singularity.getfactionenemies.md index 7fd3b8d69..0a4020308 100644 --- a/markdown/bitburner.singularity.getfactionenemies.md +++ b/markdown/bitburner.singularity.getfactionenemies.md @@ -14,9 +14,39 @@ getFactionEnemies(faction: FactionName): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getfactionfavor.md b/markdown/bitburner.singularity.getfactionfavor.md index e689f9004..6ddde538a 100644 --- a/markdown/bitburner.singularity.getfactionfavor.md +++ b/markdown/bitburner.singularity.getfactionfavor.md @@ -14,9 +14,39 @@ getFactionFavor(faction: FactionName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getfactionfavorgain.md b/markdown/bitburner.singularity.getfactionfavorgain.md index 4fb07cdfa..883182384 100644 --- a/markdown/bitburner.singularity.getfactionfavorgain.md +++ b/markdown/bitburner.singularity.getfactionfavorgain.md @@ -14,9 +14,39 @@ getFactionFavorGain(faction: FactionName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getfactioninviterequirements.md b/markdown/bitburner.singularity.getfactioninviterequirements.md index 97e280b67..f701fe0de 100644 --- a/markdown/bitburner.singularity.getfactioninviterequirements.md +++ b/markdown/bitburner.singularity.getfactioninviterequirements.md @@ -14,9 +14,39 @@ getFactionInviteRequirements(faction: FactionName): PlayerRequirement[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of the faction | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of the faction + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getfactionrep.md b/markdown/bitburner.singularity.getfactionrep.md index a9067ade9..19ed40d83 100644 --- a/markdown/bitburner.singularity.getfactionrep.md +++ b/markdown/bitburner.singularity.getfactionrep.md @@ -14,9 +14,39 @@ getFactionRep(faction: FactionName): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to work for. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction to work for. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getfactionworktypes.md b/markdown/bitburner.singularity.getfactionworktypes.md index 37e2d1605..42611989d 100644 --- a/markdown/bitburner.singularity.getfactionworktypes.md +++ b/markdown/bitburner.singularity.getfactionworktypes.md @@ -14,9 +14,39 @@ getFactionWorkTypes(faction: FactionName): FactionWorkType[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of the faction. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of the faction. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.gethackinglevelrequirementofprogram.md b/markdown/bitburner.singularity.gethackinglevelrequirementofprogram.md index d37f56e9d..63b25568b 100644 --- a/markdown/bitburner.singularity.gethackinglevelrequirementofprogram.md +++ b/markdown/bitburner.singularity.gethackinglevelrequirementofprogram.md @@ -14,9 +14,39 @@ getHackingLevelRequirementOfProgram(program: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| program | string | Name of program to create. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +program + + + + +string + + + + +Name of program to create. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.getownedaugmentations.md b/markdown/bitburner.singularity.getownedaugmentations.md index c5d08c8a3..0369b1a91 100644 --- a/markdown/bitburner.singularity.getownedaugmentations.md +++ b/markdown/bitburner.singularity.getownedaugmentations.md @@ -14,9 +14,39 @@ getOwnedAugmentations(purchased?: boolean): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| purchased | boolean | _(Optional)_ Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +purchased + + + + +boolean + + + + +_(Optional)_ Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.gotolocation.md b/markdown/bitburner.singularity.gotolocation.md index 913f6100b..420a235ec 100644 --- a/markdown/bitburner.singularity.gotolocation.md +++ b/markdown/bitburner.singularity.gotolocation.md @@ -14,9 +14,39 @@ goToLocation(locationName: LocationName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| locationName | [LocationName](./bitburner.locationname.md) | Name of the location. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +locationName + + + + +[LocationName](./bitburner.locationname.md) + + + + +Name of the location. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.gymworkout.md b/markdown/bitburner.singularity.gymworkout.md index 427e3dfb5..fdae87259 100644 --- a/markdown/bitburner.singularity.gymworkout.md +++ b/markdown/bitburner.singularity.gymworkout.md @@ -14,11 +14,71 @@ gymWorkout(gymName: GymLocationName, stat: GymType, focus?: boolean): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| gymName | [GymLocationName](./bitburner.gymlocationname.md) | Name of gym. You must be in the correct city for whatever gym you specify. | -| stat | [GymType](./bitburner.gymtype.md) | The stat you want to train. | -| focus | boolean | _(Optional)_ Acquire player focus on this gym workout. Optional. Defaults to true. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +gymName + + + + +[GymLocationName](./bitburner.gymlocationname.md) + + + + +Name of gym. You must be in the correct city for whatever gym you specify. + + +
+ +stat + + + + +[GymType](./bitburner.gymtype.md) + + + + +The stat you want to train. + + +
+ +focus + + + + +boolean + + + + +_(Optional)_ Acquire player focus on this gym workout. Optional. Defaults to true. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.installaugmentations.md b/markdown/bitburner.singularity.installaugmentations.md index 5a23cbbb7..8ffe27295 100644 --- a/markdown/bitburner.singularity.installaugmentations.md +++ b/markdown/bitburner.singularity.installaugmentations.md @@ -14,9 +14,39 @@ installAugmentations(cbScript?: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| cbScript | string | _(Optional)_ This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +cbScript + + + + +string + + + + +_(Optional)_ This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.joinfaction.md b/markdown/bitburner.singularity.joinfaction.md index d47570cd9..c8629ba9b 100644 --- a/markdown/bitburner.singularity.joinfaction.md +++ b/markdown/bitburner.singularity.joinfaction.md @@ -14,9 +14,39 @@ joinFaction(faction: FactionName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to join. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction to join. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md index bd386e303..56fbbf147 100644 --- a/markdown/bitburner.singularity.md +++ b/markdown/bitburner.singularity.md @@ -18,70 +18,720 @@ This API requires Source-File 4 to use. The RAM cost of all these functions is m ## Methods -| Method | Description | -| --- | --- | -| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. | -| [b1tflum3(nextBN, callbackScript, bitNodeOptions)](./bitburner.singularity.b1tflum3.md) | b1t\_flum3 into a different BN. | -| [cat(filename)](./bitburner.singularity.cat.md) | Displays the content of a file on the currently connected server. | -| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | List all current faction invitations. | -| [commitCrime(crime, focus)](./bitburner.singularity.commitcrime.md) | Commit a crime. | -| [connect(host)](./bitburner.singularity.connect.md) | Connect to a server. | -| [createProgram(program, focus)](./bitburner.singularity.createprogram.md) | Create a program. | -| [destroyW0r1dD43m0n(nextBN, callbackScript, bitNodeOptions)](./bitburner.singularity.destroyw0r1dd43m0n.md) | Destroy the w0r1d\_d43m0n and move on to the next BN. | -| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | Donate to a faction. | -| [exportGame()](./bitburner.singularity.exportgame.md) | Backup game save. | -| [exportGameBonus()](./bitburner.singularity.exportgamebonus.md) | Returns Backup save bonus availability. | -| [getAugmentationBasePrice(augName)](./bitburner.singularity.getaugmentationbaseprice.md) | Get base price of an augmentation. | -| [getAugmentationFactions(augName)](./bitburner.singularity.getaugmentationfactions.md) | Get a list of faction(s) that have a specific Augmentation. | -| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | Get the pre-requisite of an augmentation. | -| [getAugmentationPrice(augName)](./bitburner.singularity.getaugmentationprice.md) | Get price of an augmentation. | -| [getAugmentationRepReq(augName)](./bitburner.singularity.getaugmentationrepreq.md) | Get reputation requirement of an augmentation. | -| [getAugmentationsFromFaction(faction)](./bitburner.singularity.getaugmentationsfromfaction.md) | Get a list of augmentation available from a faction. | -| [getAugmentationStats(name)](./bitburner.singularity.getaugmentationstats.md) | Get the stats of an augmentation. | -| [getCompanyFavor(companyName)](./bitburner.singularity.getcompanyfavor.md) | Get company favor. | -| [getCompanyFavorGain(companyName)](./bitburner.singularity.getcompanyfavorgain.md) | Get company favor gain. | -| [getCompanyPositionInfo(companyName, positionName)](./bitburner.singularity.getcompanypositioninfo.md) | Get Requirements for Company Position. | -| [getCompanyPositions(companyName)](./bitburner.singularity.getcompanypositions.md) | Get List of Company Positions. | -| [getCompanyRep(companyName)](./bitburner.singularity.getcompanyrep.md) | Get company reputation. | -| [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | Get chance to successfully commit a crime. | -| [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | Get stats related to a crime. | -| [getCurrentServer(returnOpts)](./bitburner.singularity.getcurrentserver.md) | Get the current server. Returns the hostname by default. | -| [getCurrentWork()](./bitburner.singularity.getcurrentwork.md) | Get the current work the player is doing. | -| [getDarkwebProgramCost(programName)](./bitburner.singularity.getdarkwebprogramcost.md) | Check the price of an exploit on the dark web | -| [getDarkwebPrograms()](./bitburner.singularity.getdarkwebprograms.md) | Get a list of programs offered on the dark web. | -| [getFactionEnemies(faction)](./bitburner.singularity.getfactionenemies.md) | Get a list of enemies of a faction. | -| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | Get faction favor. | -| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | Get faction favor gain. | -| [getFactionInviteRequirements(faction)](./bitburner.singularity.getfactioninviterequirements.md) | List conditions for being invited to a faction. | -| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | Get faction reputation. | -| [getFactionWorkTypes(faction)](./bitburner.singularity.getfactionworktypes.md) | Get the work types of a faction. | -| [getHackingLevelRequirementOfProgram(program)](./bitburner.singularity.gethackinglevelrequirementofprogram.md) | Get the hacking level requirement of a program. | -| [getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) | Get a list of owned augmentation. | -| [getOwnedSourceFiles()](./bitburner.singularity.getownedsourcefiles.md) | Get a list of acquired Source-Files. | -| [getSaveData()](./bitburner.singularity.getsavedata.md) | This function returns the save data. | -| [getUnlockedAchievements()](./bitburner.singularity.getunlockedachievements.md) | Get a list of all unlocked achievements. | -| [getUpgradeHomeCoresCost()](./bitburner.singularity.getupgradehomecorescost.md) | Get the price of upgrading home cores. | -| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | Get the price of upgrading home RAM. | -| [goToLocation(locationName)](./bitburner.singularity.gotolocation.md) | Go to a location. | -| [gymWorkout(gymName, stat, focus)](./bitburner.singularity.gymworkout.md) | Workout at the gym. | -| [hospitalize()](./bitburner.singularity.hospitalize.md) | Hospitalize the player. | -| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | Install your purchased augmentations. | -| [installBackdoor()](./bitburner.singularity.installbackdoor.md) | Run the backdoor command in the terminal. | -| [isBusy()](./bitburner.singularity.isbusy.md) | Check if the player is busy. | -| [isFocused()](./bitburner.singularity.isfocused.md) | Check if the player is focused. | -| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | Join a faction. | -| [manualHack()](./bitburner.singularity.manualhack.md) | Run the hack command in the terminal. | -| [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | Purchase an augmentation | -| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | Purchase a program from the dark web. | -| [purchaseTor()](./bitburner.singularity.purchasetor.md) | Purchase the TOR router. | -| [quitJob(companyName)](./bitburner.singularity.quitjob.md) | Quit jobs by company. | -| [setFocus(focus)](./bitburner.singularity.setfocus.md) | Set the players focus. | -| [softReset(cbScript)](./bitburner.singularity.softreset.md) | Soft reset the game. | -| [stopAction()](./bitburner.singularity.stopaction.md) | Stop the current action. | -| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | Travel to another city. | -| [universityCourse(universityName, courseName, focus)](./bitburner.singularity.universitycourse.md) | Take university class. | -| [upgradeHomeCores()](./bitburner.singularity.upgradehomecores.md) | Upgrade home computer cores. | -| [upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) | Upgrade home computer RAM. | -| [workForCompany(companyName, focus)](./bitburner.singularity.workforcompany.md) | Work for a company. | -| [workForFaction(faction, workType, focus)](./bitburner.singularity.workforfaction.md) | Work for a faction. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) + + + + +Apply for a job at a company. + + +
+ +[b1tflum3(nextBN, callbackScript, bitNodeOptions)](./bitburner.singularity.b1tflum3.md) + + + + +b1t\_flum3 into a different BN. + + +
+ +[cat(filename)](./bitburner.singularity.cat.md) + + + + +Displays the content of a file on the currently connected server. + + +
+ +[checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) + + + + +List all current faction invitations. + + +
+ +[commitCrime(crime, focus)](./bitburner.singularity.commitcrime.md) + + + + +Commit a crime. + + +
+ +[connect(host)](./bitburner.singularity.connect.md) + + + + +Connect to a server. + + +
+ +[createProgram(program, focus)](./bitburner.singularity.createprogram.md) + + + + +Create a program. + + +
+ +[destroyW0r1dD43m0n(nextBN, callbackScript, bitNodeOptions)](./bitburner.singularity.destroyw0r1dd43m0n.md) + + + + +Destroy the w0r1d\_d43m0n and move on to the next BN. + + +
+ +[donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) + + + + +Donate to a faction. + + +
+ +[exportGame()](./bitburner.singularity.exportgame.md) + + + + +Backup game save. + + +
+ +[exportGameBonus()](./bitburner.singularity.exportgamebonus.md) + + + + +Returns Backup save bonus availability. + + +
+ +[getAugmentationBasePrice(augName)](./bitburner.singularity.getaugmentationbaseprice.md) + + + + +Get base price of an augmentation. + + +
+ +[getAugmentationFactions(augName)](./bitburner.singularity.getaugmentationfactions.md) + + + + +Get a list of faction(s) that have a specific Augmentation. + + +
+ +[getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) + + + + +Get the pre-requisite of an augmentation. + + +
+ +[getAugmentationPrice(augName)](./bitburner.singularity.getaugmentationprice.md) + + + + +Get price of an augmentation. + + +
+ +[getAugmentationRepReq(augName)](./bitburner.singularity.getaugmentationrepreq.md) + + + + +Get reputation requirement of an augmentation. + + +
+ +[getAugmentationsFromFaction(faction)](./bitburner.singularity.getaugmentationsfromfaction.md) + + + + +Get a list of augmentation available from a faction. + + +
+ +[getAugmentationStats(name)](./bitburner.singularity.getaugmentationstats.md) + + + + +Get the stats of an augmentation. + + +
+ +[getCompanyFavor(companyName)](./bitburner.singularity.getcompanyfavor.md) + + + + +Get company favor. + + +
+ +[getCompanyFavorGain(companyName)](./bitburner.singularity.getcompanyfavorgain.md) + + + + +Get company favor gain. + + +
+ +[getCompanyPositionInfo(companyName, positionName)](./bitburner.singularity.getcompanypositioninfo.md) + + + + +Get Requirements for Company Position. + + +
+ +[getCompanyPositions(companyName)](./bitburner.singularity.getcompanypositions.md) + + + + +Get List of Company Positions. + + +
+ +[getCompanyRep(companyName)](./bitburner.singularity.getcompanyrep.md) + + + + +Get company reputation. + + +
+ +[getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) + + + + +Get chance to successfully commit a crime. + + +
+ +[getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) + + + + +Get stats related to a crime. + + +
+ +[getCurrentServer(returnOpts)](./bitburner.singularity.getcurrentserver.md) + + + + +Get the current server. Returns the hostname by default. + + +
+ +[getCurrentWork()](./bitburner.singularity.getcurrentwork.md) + + + + +Get the current work the player is doing. + + +
+ +[getDarkwebProgramCost(programName)](./bitburner.singularity.getdarkwebprogramcost.md) + + + + +Check the price of an exploit on the dark web + + +
+ +[getDarkwebPrograms()](./bitburner.singularity.getdarkwebprograms.md) + + + + +Get a list of programs offered on the dark web. + + +
+ +[getFactionEnemies(faction)](./bitburner.singularity.getfactionenemies.md) + + + + +Get a list of enemies of a faction. + + +
+ +[getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) + + + + +Get faction favor. + + +
+ +[getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) + + + + +Get faction favor gain. + + +
+ +[getFactionInviteRequirements(faction)](./bitburner.singularity.getfactioninviterequirements.md) + + + + +List conditions for being invited to a faction. + + +
+ +[getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) + + + + +Get faction reputation. + + +
+ +[getFactionWorkTypes(faction)](./bitburner.singularity.getfactionworktypes.md) + + + + +Get the work types of a faction. + + +
+ +[getHackingLevelRequirementOfProgram(program)](./bitburner.singularity.gethackinglevelrequirementofprogram.md) + + + + +Get the hacking level requirement of a program. + + +
+ +[getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) + + + + +Get a list of owned augmentation. + + +
+ +[getOwnedSourceFiles()](./bitburner.singularity.getownedsourcefiles.md) + + + + +Get a list of acquired Source-Files. + + +
+ +[getSaveData()](./bitburner.singularity.getsavedata.md) + + + + +This function returns the save data. + + +
+ +[getUnlockedAchievements()](./bitburner.singularity.getunlockedachievements.md) + + + + +Get a list of all unlocked achievements. + + +
+ +[getUpgradeHomeCoresCost()](./bitburner.singularity.getupgradehomecorescost.md) + + + + +Get the price of upgrading home cores. + + +
+ +[getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) + + + + +Get the price of upgrading home RAM. + + +
+ +[goToLocation(locationName)](./bitburner.singularity.gotolocation.md) + + + + +Go to a location. + + +
+ +[gymWorkout(gymName, stat, focus)](./bitburner.singularity.gymworkout.md) + + + + +Workout at the gym. + + +
+ +[hospitalize()](./bitburner.singularity.hospitalize.md) + + + + +Hospitalize the player. + + +
+ +[installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) + + + + +Install your purchased augmentations. + + +
+ +[installBackdoor()](./bitburner.singularity.installbackdoor.md) + + + + +Run the backdoor command in the terminal. + + +
+ +[isBusy()](./bitburner.singularity.isbusy.md) + + + + +Check if the player is busy. + + +
+ +[isFocused()](./bitburner.singularity.isfocused.md) + + + + +Check if the player is focused. + + +
+ +[joinFaction(faction)](./bitburner.singularity.joinfaction.md) + + + + +Join a faction. + + +
+ +[manualHack()](./bitburner.singularity.manualhack.md) + + + + +Run the hack command in the terminal. + + +
+ +[purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) + + + + +Purchase an augmentation + + +
+ +[purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) + + + + +Purchase a program from the dark web. + + +
+ +[purchaseTor()](./bitburner.singularity.purchasetor.md) + + + + +Purchase the TOR router. + + +
+ +[quitJob(companyName)](./bitburner.singularity.quitjob.md) + + + + +Quit jobs by company. + + +
+ +[setFocus(focus)](./bitburner.singularity.setfocus.md) + + + + +Set the players focus. + + +
+ +[softReset(cbScript)](./bitburner.singularity.softreset.md) + + + + +Soft reset the game. + + +
+ +[stopAction()](./bitburner.singularity.stopaction.md) + + + + +Stop the current action. + + +
+ +[travelToCity(city)](./bitburner.singularity.traveltocity.md) + + + + +Travel to another city. + + +
+ +[universityCourse(universityName, courseName, focus)](./bitburner.singularity.universitycourse.md) + + + + +Take university class. + + +
+ +[upgradeHomeCores()](./bitburner.singularity.upgradehomecores.md) + + + + +Upgrade home computer cores. + + +
+ +[upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) + + + + +Upgrade home computer RAM. + + +
+ +[workForCompany(companyName, focus)](./bitburner.singularity.workforcompany.md) + + + + +Work for a company. + + +
+ +[workForFaction(faction, workType, focus)](./bitburner.singularity.workforfaction.md) + + + + +Work for a faction. + + +
diff --git a/markdown/bitburner.singularity.purchaseaugmentation.md b/markdown/bitburner.singularity.purchaseaugmentation.md index 782450c4e..5ddd7f5b7 100644 --- a/markdown/bitburner.singularity.purchaseaugmentation.md +++ b/markdown/bitburner.singularity.purchaseaugmentation.md @@ -14,10 +14,55 @@ purchaseAugmentation(faction: FactionName, augmentation: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to purchase Augmentation from. | -| augmentation | string | Name of Augmentation to purchase. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction to purchase Augmentation from. + + +
+ +augmentation + + + + +string + + + + +Name of Augmentation to purchase. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.purchaseprogram.md b/markdown/bitburner.singularity.purchaseprogram.md index bb419c5ce..5ede80d88 100644 --- a/markdown/bitburner.singularity.purchaseprogram.md +++ b/markdown/bitburner.singularity.purchaseprogram.md @@ -14,9 +14,39 @@ purchaseProgram(programName: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| programName | string | Name of program to purchase. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +programName + + + + +string + + + + +Name of program to purchase. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.quitjob.md b/markdown/bitburner.singularity.quitjob.md index 74467bf09..3f60046eb 100644 --- a/markdown/bitburner.singularity.quitjob.md +++ b/markdown/bitburner.singularity.quitjob.md @@ -14,9 +14,39 @@ quitJob(companyName: CompanyName): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of the company. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.setfocus.md b/markdown/bitburner.singularity.setfocus.md index dca3cffaa..62a2336d8 100644 --- a/markdown/bitburner.singularity.setfocus.md +++ b/markdown/bitburner.singularity.setfocus.md @@ -14,9 +14,37 @@ setFocus(focus: boolean): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| focus | boolean | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +focus + + + + +boolean + + + + + +
**Returns:** diff --git a/markdown/bitburner.singularity.softreset.md b/markdown/bitburner.singularity.softreset.md index 5d03f4b52..77422dd79 100644 --- a/markdown/bitburner.singularity.softreset.md +++ b/markdown/bitburner.singularity.softreset.md @@ -14,9 +14,39 @@ softReset(cbScript?: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| cbScript | string | _(Optional)_ This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +cbScript + + + + +string + + + + +_(Optional)_ This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.traveltocity.md b/markdown/bitburner.singularity.traveltocity.md index cb3da9080..459c6591d 100644 --- a/markdown/bitburner.singularity.traveltocity.md +++ b/markdown/bitburner.singularity.traveltocity.md @@ -14,9 +14,39 @@ travelToCity(city: CityName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| city | [CityName](./bitburner.cityname.md) | City to travel to. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +City to travel to. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.universitycourse.md b/markdown/bitburner.singularity.universitycourse.md index b9019aa5d..3a07ee1c6 100644 --- a/markdown/bitburner.singularity.universitycourse.md +++ b/markdown/bitburner.singularity.universitycourse.md @@ -14,11 +14,71 @@ universityCourse(universityName: UniversityLocationName, courseName: UniversityC ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) | Name of university. You must be in the correct city for whatever university you specify. | -| courseName | [UniversityClassType](./bitburner.universityclasstype.md) | Name of course. | -| focus | boolean | _(Optional)_ Acquire player focus on this class. Optional. Defaults to true. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +universityName + + + + +[UniversityLocationName](./bitburner.universitylocationname.md) + + + + +Name of university. You must be in the correct city for whatever university you specify. + + +
+ +courseName + + + + +[UniversityClassType](./bitburner.universityclasstype.md) + + + + +Name of course. + + +
+ +focus + + + + +boolean + + + + +_(Optional)_ Acquire player focus on this class. Optional. Defaults to true. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.workforcompany.md b/markdown/bitburner.singularity.workforcompany.md index bd13a570d..37ff31e03 100644 --- a/markdown/bitburner.singularity.workforcompany.md +++ b/markdown/bitburner.singularity.workforcompany.md @@ -14,10 +14,55 @@ workForCompany(companyName: CompanyName, focus?: boolean): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to work for. Must be an exact match. | -| focus | boolean | _(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of company to work for. Must be an exact match. + + +
+ +focus + + + + +boolean + + + + +_(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. + + +
**Returns:** diff --git a/markdown/bitburner.singularity.workforfaction.md b/markdown/bitburner.singularity.workforfaction.md index 2052087b2..60d269b98 100644 --- a/markdown/bitburner.singularity.workforfaction.md +++ b/markdown/bitburner.singularity.workforfaction.md @@ -14,11 +14,71 @@ workForFaction(faction: FactionName, workType: FactionWorkType, focus?: boolean) ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| faction | [FactionName](./bitburner.factionname.md) | Name of faction to work for. | -| workType | [FactionWorkType](./bitburner.factionworktype.md) | Type of work to perform for the faction. | -| focus | boolean | _(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +faction + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of faction to work for. + + +
+ +workType + + + + +[FactionWorkType](./bitburner.factionworktype.md) + + + + +Type of work to perform for the faction. + + +
+ +focus + + + + +boolean + + + + +_(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true. + + +
**Returns:** diff --git a/markdown/bitburner.skillrequirement.md b/markdown/bitburner.skillrequirement.md index 4824ffcb3..e7921d00b 100644 --- a/markdown/bitburner.skillrequirement.md +++ b/markdown/bitburner.skillrequirement.md @@ -14,8 +14,60 @@ interface SkillRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [skills](./bitburner.skillrequirement.skills.md) | | Partial<[Skills](./bitburner.skills.md)> | | -| [type](./bitburner.skillrequirement.type.md) | | "skills" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[skills](./bitburner.skillrequirement.skills.md) + + + + + + + +Partial<[Skills](./bitburner.skills.md)> + + + + + +
+ +[type](./bitburner.skillrequirement.type.md) + + + + + + + +"skills" + + + + + +
diff --git a/markdown/bitburner.skills.md b/markdown/bitburner.skills.md index 6f12f94a7..d687f59a9 100644 --- a/markdown/bitburner.skills.md +++ b/markdown/bitburner.skills.md @@ -13,13 +13,145 @@ interface Skills ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agility](./bitburner.skills.agility.md) | | number | | -| [charisma](./bitburner.skills.charisma.md) | | number | | -| [defense](./bitburner.skills.defense.md) | | number | | -| [dexterity](./bitburner.skills.dexterity.md) | | number | | -| [hacking](./bitburner.skills.hacking.md) | | number | | -| [intelligence](./bitburner.skills.intelligence.md) | | number | | -| [strength](./bitburner.skills.strength.md) | | number | | + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agility](./bitburner.skills.agility.md) + + + + + + + +number + + + + + +
+ +[charisma](./bitburner.skills.charisma.md) + + + + + + + +number + + + + + +
+ +[defense](./bitburner.skills.defense.md) + + + + + + + +number + + + + + +
+ +[dexterity](./bitburner.skills.dexterity.md) + + + + + + + +number + + + + + +
+ +[hacking](./bitburner.skills.hacking.md) + + + + + + + +number + + + + + +
+ +[intelligence](./bitburner.skills.intelligence.md) + + + + + + + +number + + + + + +
+ +[strength](./bitburner.skills.strength.md) + + + + + + + +number + + + + + +
diff --git a/markdown/bitburner.skillsformulas.calculateexp.md b/markdown/bitburner.skillsformulas.calculateexp.md index 36824ffd1..616759c95 100644 --- a/markdown/bitburner.skillsformulas.calculateexp.md +++ b/markdown/bitburner.skillsformulas.calculateexp.md @@ -14,10 +14,55 @@ calculateExp(skill: number, skillMult?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| skill | number | target skill level | -| skillMult | number | _(Optional)_ Multiplier for that skill, defaults to 1. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +skill + + + + +number + + + + +target skill level + + +
+ +skillMult + + + + +number + + + + +_(Optional)_ Multiplier for that skill, defaults to 1. + + +
**Returns:** diff --git a/markdown/bitburner.skillsformulas.calculateskill.md b/markdown/bitburner.skillsformulas.calculateskill.md index e4b3645bc..ed0502453 100644 --- a/markdown/bitburner.skillsformulas.calculateskill.md +++ b/markdown/bitburner.skillsformulas.calculateskill.md @@ -14,10 +14,55 @@ calculateSkill(exp: number, skillMult?: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| exp | number | experience for that skill | -| skillMult | number | _(Optional)_ Multiplier for that skill, defaults to 1. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +exp + + + + +number + + + + +experience for that skill + + +
+ +skillMult + + + + +number + + + + +_(Optional)_ Multiplier for that skill, defaults to 1. + + +
**Returns:** diff --git a/markdown/bitburner.skillsformulas.md b/markdown/bitburner.skillsformulas.md index cc2ad1aa5..743cb910e 100644 --- a/markdown/bitburner.skillsformulas.md +++ b/markdown/bitburner.skillsformulas.md @@ -14,8 +14,38 @@ interface SkillsFormulas ## Methods -| Method | Description | -| --- | --- | -| [calculateExp(skill, skillMult)](./bitburner.skillsformulas.calculateexp.md) | Calculate exp for skill level. | -| [calculateSkill(exp, skillMult)](./bitburner.skillsformulas.calculateskill.md) | Calculate skill level. | + + + +
+ +Method + + + + +Description + + +
+ +[calculateExp(skill, skillMult)](./bitburner.skillsformulas.calculateexp.md) + + + + +Calculate exp for skill level. + + +
+ +[calculateSkill(exp, skillMult)](./bitburner.skillsformulas.calculateskill.md) + + + + +Calculate skill level. + + +
diff --git a/markdown/bitburner.sleeve.getsleeve.md b/markdown/bitburner.sleeve.getsleeve.md index fee90101c..7dd6ec9a1 100644 --- a/markdown/bitburner.sleeve.getsleeve.md +++ b/markdown/bitburner.sleeve.getsleeve.md @@ -14,9 +14,39 @@ getSleeve(sleeveNumber: number): SleevePerson; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to retrieve information. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to retrieve information. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.getsleeveaugmentationprice.md b/markdown/bitburner.sleeve.getsleeveaugmentationprice.md index 54110904e..b235b556e 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentationprice.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentationprice.md @@ -14,9 +14,39 @@ getSleeveAugmentationPrice(augName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of Augmentation. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of Augmentation. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md b/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md index 625654184..ed5350d55 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md @@ -14,9 +14,39 @@ getSleeveAugmentationRepReq(augName: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| augName | string | Name of Augmentation. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +augName + + + + +string + + + + +Name of Augmentation. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.getsleeveaugmentations.md b/markdown/bitburner.sleeve.getsleeveaugmentations.md index 4240fee16..a622e322f 100644 --- a/markdown/bitburner.sleeve.getsleeveaugmentations.md +++ b/markdown/bitburner.sleeve.getsleeveaugmentations.md @@ -14,9 +14,39 @@ getSleeveAugmentations(sleeveNumber: number): string[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to retrieve augmentations from. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to retrieve augmentations from. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md index 34ee999c6..ea274030c 100644 --- a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md +++ b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md @@ -14,9 +14,39 @@ getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to retrieve purchasable augmentations from. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to retrieve purchasable augmentations from. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.gettask.md b/markdown/bitburner.sleeve.gettask.md index 890636b8c..87dd5efa5 100644 --- a/markdown/bitburner.sleeve.gettask.md +++ b/markdown/bitburner.sleeve.gettask.md @@ -14,9 +14,39 @@ getTask(sleeveNumber: number): SleeveTask | null; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to retrieve task from. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to retrieve task from. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.md b/markdown/bitburner.sleeve.md index 66318687f..74e5e83ea 100644 --- a/markdown/bitburner.sleeve.md +++ b/markdown/bitburner.sleeve.md @@ -18,24 +18,214 @@ If you are not in BitNode-10, then you must have Source-File 10 in order to use ## Methods -| Method | Description | -| --- | --- | -| [getNumSleeves()](./bitburner.sleeve.getnumsleeves.md) | Get the number of sleeves you own. | -| [getSleeve(sleeveNumber)](./bitburner.sleeve.getsleeve.md) | Get information about a sleeve. | -| [getSleeveAugmentationPrice(augName)](./bitburner.sleeve.getsleeveaugmentationprice.md) | Get price of an augmentation. | -| [getSleeveAugmentationRepReq(augName)](./bitburner.sleeve.getsleeveaugmentationrepreq.md) | Get reputation requirement of an augmentation. | -| [getSleeveAugmentations(sleeveNumber)](./bitburner.sleeve.getsleeveaugmentations.md) | Get augmentations installed on a sleeve. | -| [getSleevePurchasableAugs(sleeveNumber)](./bitburner.sleeve.getsleevepurchasableaugs.md) | List purchasable augs for a sleeve. | -| [getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) | Get task of a sleeve. | -| [purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) | Purchase an aug for a sleeve. | -| [setToBladeburnerAction(sleeveNumber, action, contract)](./bitburner.sleeve.settobladeburneraction.md) | Set a sleeve to perform Bladeburner actions. | -| [setToCommitCrime(sleeveNumber, crimeType)](./bitburner.sleeve.settocommitcrime.md) | Set a sleeve to commit crime. | -| [setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) | Set a sleeve to work for a company. | -| [setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) | Set a sleeve to work for a faction. | -| [setToGymWorkout(sleeveNumber, gymName, stat)](./bitburner.sleeve.settogymworkout.md) | Set a sleeve to workout at the gym. | -| [setToIdle(sleeveNumber)](./bitburner.sleeve.settoidle.md) | Set a sleeve to idle. | -| [setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md) | Set a sleeve to shock recovery. | -| [setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md) | Set a sleeve to synchronize. | -| [setToUniversityCourse(sleeveNumber, universityName, courseName)](./bitburner.sleeve.settouniversitycourse.md) | Set a sleeve to take a class at a university. | -| [travel(sleeveNumber, city)](./bitburner.sleeve.travel.md) | Make a sleeve travel to another city. The cost for using this function is the same as for a player. | + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[getNumSleeves()](./bitburner.sleeve.getnumsleeves.md) + + + + +Get the number of sleeves you own. + + +
+ +[getSleeve(sleeveNumber)](./bitburner.sleeve.getsleeve.md) + + + + +Get information about a sleeve. + + +
+ +[getSleeveAugmentationPrice(augName)](./bitburner.sleeve.getsleeveaugmentationprice.md) + + + + +Get price of an augmentation. + + +
+ +[getSleeveAugmentationRepReq(augName)](./bitburner.sleeve.getsleeveaugmentationrepreq.md) + + + + +Get reputation requirement of an augmentation. + + +
+ +[getSleeveAugmentations(sleeveNumber)](./bitburner.sleeve.getsleeveaugmentations.md) + + + + +Get augmentations installed on a sleeve. + + +
+ +[getSleevePurchasableAugs(sleeveNumber)](./bitburner.sleeve.getsleevepurchasableaugs.md) + + + + +List purchasable augs for a sleeve. + + +
+ +[getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) + + + + +Get task of a sleeve. + + +
+ +[purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) + + + + +Purchase an aug for a sleeve. + + +
+ +[setToBladeburnerAction(sleeveNumber, action, contract)](./bitburner.sleeve.settobladeburneraction.md) + + + + +Set a sleeve to perform Bladeburner actions. + + +
+ +[setToCommitCrime(sleeveNumber, crimeType)](./bitburner.sleeve.settocommitcrime.md) + + + + +Set a sleeve to commit crime. + + +
+ +[setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) + + + + +Set a sleeve to work for a company. + + +
+ +[setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) + + + + +Set a sleeve to work for a faction. + + +
+ +[setToGymWorkout(sleeveNumber, gymName, stat)](./bitburner.sleeve.settogymworkout.md) + + + + +Set a sleeve to workout at the gym. + + +
+ +[setToIdle(sleeveNumber)](./bitburner.sleeve.settoidle.md) + + + + +Set a sleeve to idle. + + +
+ +[setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md) + + + + +Set a sleeve to shock recovery. + + +
+ +[setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md) + + + + +Set a sleeve to synchronize. + + +
+ +[setToUniversityCourse(sleeveNumber, universityName, courseName)](./bitburner.sleeve.settouniversitycourse.md) + + + + +Set a sleeve to take a class at a university. + + +
+ +[travel(sleeveNumber, city)](./bitburner.sleeve.travel.md) + + + + +Make a sleeve travel to another city. The cost for using this function is the same as for a player. + + +
diff --git a/markdown/bitburner.sleeve.purchasesleeveaug.md b/markdown/bitburner.sleeve.purchasesleeveaug.md index 423a23d0e..8ffcf06a5 100644 --- a/markdown/bitburner.sleeve.purchasesleeveaug.md +++ b/markdown/bitburner.sleeve.purchasesleeveaug.md @@ -14,10 +14,55 @@ purchaseSleeveAug(sleeveNumber: number, augName: string): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to buy an aug for. | -| augName | string | Name of the aug to buy. Must be an exact match. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to buy an aug for. + + +
+ +augName + + + + +string + + + + +Name of the aug to buy. Must be an exact match. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settobladeburneraction.md b/markdown/bitburner.sleeve.settobladeburneraction.md index 0debb28a8..7c936faf2 100644 --- a/markdown/bitburner.sleeve.settobladeburneraction.md +++ b/markdown/bitburner.sleeve.settobladeburneraction.md @@ -18,11 +18,71 @@ setToBladeburnerAction( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to perform a Bladeburner action. | -| action | [BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) | Name of the action to be performed. | -| contract | [BladeburnerContractName](./bitburner.bladeburnercontractname.md) | _(Optional)_ Name of the contract if applicable. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to perform a Bladeburner action. + + +
+ +action + + + + +[BladeburnerActionTypeForSleeve](./bitburner.bladeburneractiontypeforsleeve.md) + + + + +Name of the action to be performed. + + +
+ +contract + + + + +[BladeburnerContractName](./bitburner.bladeburnercontractname.md) + + + + +_(Optional)_ Name of the contract if applicable. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settocommitcrime.md b/markdown/bitburner.sleeve.settocommitcrime.md index fa15f40b9..f06139727 100644 --- a/markdown/bitburner.sleeve.settocommitcrime.md +++ b/markdown/bitburner.sleeve.settocommitcrime.md @@ -14,10 +14,55 @@ setToCommitCrime(sleeveNumber: number, crimeType: CrimeType): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to start committing crime. Sleeves are numbered starting from 0. | -| crimeType | [CrimeType](./bitburner.crimetype.md) | Name of the crime. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to start committing crime. Sleeves are numbered starting from 0. + + +
+ +crimeType + + + + +[CrimeType](./bitburner.crimetype.md) + + + + +Name of the crime. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settocompanywork.md b/markdown/bitburner.sleeve.settocompanywork.md index 7961196d9..c2b9fbccc 100644 --- a/markdown/bitburner.sleeve.settocompanywork.md +++ b/markdown/bitburner.sleeve.settocompanywork.md @@ -14,10 +14,55 @@ setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to work for the company. | -| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company to work for. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to work for the company. + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + +Name of the company to work for. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settofactionwork.md b/markdown/bitburner.sleeve.settofactionwork.md index 97f928527..0309edd18 100644 --- a/markdown/bitburner.sleeve.settofactionwork.md +++ b/markdown/bitburner.sleeve.settofactionwork.md @@ -18,11 +18,71 @@ setToFactionWork( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to work for the faction. | -| factionName | [FactionName](./bitburner.factionname.md) | Name of the faction to work for. | -| factionWorkType | [FactionWorkType](./bitburner.factionworktype.md) | Name of the action to perform for this faction. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to work for the faction. + + +
+ +factionName + + + + +[FactionName](./bitburner.factionname.md) + + + + +Name of the faction to work for. + + +
+ +factionWorkType + + + + +[FactionWorkType](./bitburner.factionworktype.md) + + + + +Name of the action to perform for this faction. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settogymworkout.md b/markdown/bitburner.sleeve.settogymworkout.md index 6e32d6eaa..1fcb157d5 100644 --- a/markdown/bitburner.sleeve.settogymworkout.md +++ b/markdown/bitburner.sleeve.settogymworkout.md @@ -14,11 +14,71 @@ setToGymWorkout(sleeveNumber: number, gymName: GymLocationName, stat: GymType): ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to workout at the gym. | -| gymName | [GymLocationName](./bitburner.gymlocationname.md) | Name of the gym. | -| stat | [GymType](./bitburner.gymtype.md) | Name of the stat to train. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to workout at the gym. + + +
+ +gymName + + + + +[GymLocationName](./bitburner.gymlocationname.md) + + + + +Name of the gym. + + +
+ +stat + + + + +[GymType](./bitburner.gymtype.md) + + + + +Name of the stat to train. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settoidle.md b/markdown/bitburner.sleeve.settoidle.md index 3a0df3d09..dad77bbbc 100644 --- a/markdown/bitburner.sleeve.settoidle.md +++ b/markdown/bitburner.sleeve.settoidle.md @@ -14,9 +14,39 @@ setToIdle(sleeveNumber: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to idle. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to idle. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settoshockrecovery.md b/markdown/bitburner.sleeve.settoshockrecovery.md index 07f1bb891..babcea46f 100644 --- a/markdown/bitburner.sleeve.settoshockrecovery.md +++ b/markdown/bitburner.sleeve.settoshockrecovery.md @@ -14,9 +14,39 @@ setToShockRecovery(sleeveNumber: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to start recovery. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to start recovery. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settosynchronize.md b/markdown/bitburner.sleeve.settosynchronize.md index 2c44e74f3..b8aae002e 100644 --- a/markdown/bitburner.sleeve.settosynchronize.md +++ b/markdown/bitburner.sleeve.settosynchronize.md @@ -14,9 +14,39 @@ setToSynchronize(sleeveNumber: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to start synchronizing. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to start synchronizing. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.settouniversitycourse.md b/markdown/bitburner.sleeve.settouniversitycourse.md index 60c7a4c1a..2b2513ca8 100644 --- a/markdown/bitburner.sleeve.settouniversitycourse.md +++ b/markdown/bitburner.sleeve.settouniversitycourse.md @@ -18,11 +18,71 @@ setToUniversityCourse( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to start taking class. | -| universityName | [UniversityLocationName](./bitburner.universitylocationname.md) | Name of the university to attend. | -| courseName | [UniversityClassType](./bitburner.universityclasstype.md) | Name of the course to follow. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to start taking class. + + +
+ +universityName + + + + +[UniversityLocationName](./bitburner.universitylocationname.md) + + + + +Name of the university to attend. + + +
+ +courseName + + + + +[UniversityClassType](./bitburner.universityclasstype.md) + + + + +Name of the course to follow. + + +
**Returns:** diff --git a/markdown/bitburner.sleeve.travel.md b/markdown/bitburner.sleeve.travel.md index ffba43753..c58d06a13 100644 --- a/markdown/bitburner.sleeve.travel.md +++ b/markdown/bitburner.sleeve.travel.md @@ -14,10 +14,55 @@ travel(sleeveNumber: number, city: CityName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to travel. | -| city | [CityName](./bitburner.cityname.md) | Name of the destination city. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sleeveNumber + + + + +number + + + + +Index of the sleeve to travel. + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the destination city. + + +
**Returns:** diff --git a/markdown/bitburner.sleeveperson.md b/markdown/bitburner.sleeveperson.md index 7454801e4..511cba9a8 100644 --- a/markdown/bitburner.sleeveperson.md +++ b/markdown/bitburner.sleeveperson.md @@ -14,10 +14,102 @@ interface SleevePerson extends Person ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [memory](./bitburner.sleeveperson.memory.md) | | number | Number 1-100 initial Value of sync on BN start | -| [shock](./bitburner.sleeveperson.shock.md) | | number | Number 0-100 Experience earned and shared is multiplied with shock% before sync% | -| [storedCycles](./bitburner.sleeveperson.storedcycles.md) | | number | Number of 200ms cycles which are stored as bonus time | -| [sync](./bitburner.sleeveperson.sync.md) | | number | Number 1-100 Experience earned by this sleeve and shared with the player is multiplied with sync% after shock% | + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[memory](./bitburner.sleeveperson.memory.md) + + + + + + + +number + + + + +Number 1-100 initial Value of sync on BN start + + +
+ +[shock](./bitburner.sleeveperson.shock.md) + + + + + + + +number + + + + +Number 0-100 Experience earned and shared is multiplied with shock% before sync% + + +
+ +[storedCycles](./bitburner.sleeveperson.storedcycles.md) + + + + + + + +number + + + + +Number of 200ms cycles which are stored as bonus time + + +
+ +[sync](./bitburner.sleeveperson.sync.md) + + + + + + + +number + + + + +Number 1-100 Experience earned by this sleeve and shared with the player is multiplied with sync% after shock% + + +
diff --git a/markdown/bitburner.somerequirement.md b/markdown/bitburner.somerequirement.md index d8029532b..50e0eb238 100644 --- a/markdown/bitburner.somerequirement.md +++ b/markdown/bitburner.somerequirement.md @@ -14,8 +14,60 @@ interface SomeRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [conditions](./bitburner.somerequirement.conditions.md) | | [PlayerRequirement](./bitburner.playerrequirement.md)\[\] | | -| [type](./bitburner.somerequirement.type.md) | | "someCondition" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[conditions](./bitburner.somerequirement.conditions.md) + + + + + + + +[PlayerRequirement](./bitburner.playerrequirement.md)\[\] + + + + + +
+ +[type](./bitburner.somerequirement.type.md) + + + + + + + +"someCondition" + + + + + +
diff --git a/markdown/bitburner.sourcefilelvl.md b/markdown/bitburner.sourcefilelvl.md index 65b0731c8..991ce60e9 100644 --- a/markdown/bitburner.sourcefilelvl.md +++ b/markdown/bitburner.sourcefilelvl.md @@ -13,8 +13,64 @@ interface SourceFileLvl ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [lvl](./bitburner.sourcefilelvl.lvl.md) | | number | The level of the source file | -| [n](./bitburner.sourcefilelvl.n.md) | | number | The number of the source file | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[lvl](./bitburner.sourcefilelvl.lvl.md) + + + + + + + +number + + + + +The level of the source file + + +
+ +[n](./bitburner.sourcefilelvl.n.md) + + + + + + + +number + + + + +The number of the source file + + +
diff --git a/markdown/bitburner.sourcefilerequirement.md b/markdown/bitburner.sourcefilerequirement.md index 2b7daaad4..bc580d8d9 100644 --- a/markdown/bitburner.sourcefilerequirement.md +++ b/markdown/bitburner.sourcefilerequirement.md @@ -14,8 +14,60 @@ interface SourceFileRequirement ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [sourceFile](./bitburner.sourcefilerequirement.sourcefile.md) | | number | | -| [type](./bitburner.sourcefilerequirement.type.md) | | "sourceFile" | | + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[sourceFile](./bitburner.sourcefilerequirement.sourcefile.md) + + + + + + + +number + + + + + +
+ +[type](./bitburner.sourcefilerequirement.type.md) + + + + + + + +"sourceFile" + + + + + +
diff --git a/markdown/bitburner.spawnoptions.md b/markdown/bitburner.spawnoptions.md index 4c0bd4f05..ec32f0ff5 100644 --- a/markdown/bitburner.spawnoptions.md +++ b/markdown/bitburner.spawnoptions.md @@ -14,7 +14,45 @@ interface SpawnOptions extends RunOptions ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [spawnDelay?](./bitburner.spawnoptions.spawndelay.md) | | number | _(Optional)_ Number of milliseconds to delay before spawning script, defaults to 10000 (10s). Must be a non-negative integer. If 0, the script will be spawned synchronously. | + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[spawnDelay?](./bitburner.spawnoptions.spawndelay.md) + + + + + + + +number + + + + +_(Optional)_ Number of milliseconds to delay before spawning script, defaults to 10000 (10s). Must be a non-negative integer. If 0, the script will be spawned synchronously. + + +
diff --git a/markdown/bitburner.stanek.canplacefragment.md b/markdown/bitburner.stanek.canplacefragment.md index e76e7f764..4366c9832 100644 --- a/markdown/bitburner.stanek.canplacefragment.md +++ b/markdown/bitburner.stanek.canplacefragment.md @@ -14,12 +14,87 @@ canPlaceFragment(rootX: number, rootY: number, rotation: number, fragmentId: num ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| rootX | number | Root X against which to align the top left of the fragment. | -| rootY | number | Root Y against which to align the top left of the fragment. | -| rotation | number | A number from 0 to 3, the amount of 90-degree turns to take. | -| fragmentId | number | ID of the fragment to place. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +rootX + + + + +number + + + + +Root X against which to align the top left of the fragment. + + +
+ +rootY + + + + +number + + + + +Root Y against which to align the top left of the fragment. + + +
+ +rotation + + + + +number + + + + +A number from 0 to 3, the amount of 90-degree turns to take. + + +
+ +fragmentId + + + + +number + + + + +ID of the fragment to place. + + +
**Returns:** diff --git a/markdown/bitburner.stanek.chargefragment.md b/markdown/bitburner.stanek.chargefragment.md index ca2735415..5f04c1995 100644 --- a/markdown/bitburner.stanek.chargefragment.md +++ b/markdown/bitburner.stanek.chargefragment.md @@ -14,10 +14,55 @@ chargeFragment(rootX: number, rootY: number): Promise; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| rootX | number | Root X against which to align the top left of the fragment. | -| rootY | number | Root Y against which to align the top left of the fragment. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +rootX + + + + +number + + + + +Root X against which to align the top left of the fragment. + + +
+ +rootY + + + + +number + + + + +Root Y against which to align the top left of the fragment. + + +
**Returns:** diff --git a/markdown/bitburner.stanek.getfragment.md b/markdown/bitburner.stanek.getfragment.md index 7430b753d..8bc1848a5 100644 --- a/markdown/bitburner.stanek.getfragment.md +++ b/markdown/bitburner.stanek.getfragment.md @@ -14,10 +14,55 @@ getFragment(rootX: number, rootY: number): ActiveFragment | undefined; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| rootX | number | X against which to align the top left of the fragment. | -| rootY | number | Y against which to align the top left of the fragment. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +rootX + + + + +number + + + + +X against which to align the top left of the fragment. + + +
+ +rootY + + + + +number + + + + +Y against which to align the top left of the fragment. + + +
**Returns:** diff --git a/markdown/bitburner.stanek.md b/markdown/bitburner.stanek.md index 8717576b0..c19bde329 100644 --- a/markdown/bitburner.stanek.md +++ b/markdown/bitburner.stanek.md @@ -14,17 +14,137 @@ interface Stanek ## Methods -| Method | Description | -| --- | --- | -| [acceptGift()](./bitburner.stanek.acceptgift.md) | Accept Stanek's Gift by joining the Church of the Machine God | -| [activeFragments()](./bitburner.stanek.activefragments.md) | List of fragments in Stanek's Gift. | -| [canPlaceFragment(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.canplacefragment.md) | Check if fragment can be placed at specified location. | -| [chargeFragment(rootX, rootY)](./bitburner.stanek.chargefragment.md) | Charge a fragment, increasing its power. | -| [clearGift()](./bitburner.stanek.cleargift.md) | Clear the board of all fragments. | -| [fragmentDefinitions()](./bitburner.stanek.fragmentdefinitions.md) | List possible fragments. | -| [getFragment(rootX, rootY)](./bitburner.stanek.getfragment.md) | Get placed fragment at location. | -| [giftHeight()](./bitburner.stanek.giftheight.md) | Stanek's Gift height. | -| [giftWidth()](./bitburner.stanek.giftwidth.md) | Stanek's Gift width. | -| [placeFragment(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.placefragment.md) | Place fragment on Stanek's Gift. | -| [removeFragment(rootX, rootY)](./bitburner.stanek.removefragment.md) | Remove fragment at location. | + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[acceptGift()](./bitburner.stanek.acceptgift.md) + + + + +Accept Stanek's Gift by joining the Church of the Machine God + + +
+ +[activeFragments()](./bitburner.stanek.activefragments.md) + + + + +List of fragments in Stanek's Gift. + + +
+ +[canPlaceFragment(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.canplacefragment.md) + + + + +Check if fragment can be placed at specified location. + + +
+ +[chargeFragment(rootX, rootY)](./bitburner.stanek.chargefragment.md) + + + + +Charge a fragment, increasing its power. + + +
+ +[clearGift()](./bitburner.stanek.cleargift.md) + + + + +Clear the board of all fragments. + + +
+ +[fragmentDefinitions()](./bitburner.stanek.fragmentdefinitions.md) + + + + +List possible fragments. + + +
+ +[getFragment(rootX, rootY)](./bitburner.stanek.getfragment.md) + + + + +Get placed fragment at location. + + +
+ +[giftHeight()](./bitburner.stanek.giftheight.md) + + + + +Stanek's Gift height. + + +
+ +[giftWidth()](./bitburner.stanek.giftwidth.md) + + + + +Stanek's Gift width. + + +
+ +[placeFragment(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.placefragment.md) + + + + +Place fragment on Stanek's Gift. + + +
+ +[removeFragment(rootX, rootY)](./bitburner.stanek.removefragment.md) + + + + +Remove fragment at location. + + +
diff --git a/markdown/bitburner.stanek.placefragment.md b/markdown/bitburner.stanek.placefragment.md index 19d13fefd..510cc3d1e 100644 --- a/markdown/bitburner.stanek.placefragment.md +++ b/markdown/bitburner.stanek.placefragment.md @@ -14,12 +14,87 @@ placeFragment(rootX: number, rootY: number, rotation: number, fragmentId: number ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| rootX | number | X against which to align the top left of the fragment. | -| rootY | number | Y against which to align the top left of the fragment. | -| rotation | number | A number from 0 to 3, the mount of 90 degree turn to take. | -| fragmentId | number | ID of the fragment to place. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +rootX + + + + +number + + + + +X against which to align the top left of the fragment. + + +
+ +rootY + + + + +number + + + + +Y against which to align the top left of the fragment. + + +
+ +rotation + + + + +number + + + + +A number from 0 to 3, the mount of 90 degree turn to take. + + +
+ +fragmentId + + + + +number + + + + +ID of the fragment to place. + + +
**Returns:** diff --git a/markdown/bitburner.stanek.removefragment.md b/markdown/bitburner.stanek.removefragment.md index 7d31389f1..fe30a2afa 100644 --- a/markdown/bitburner.stanek.removefragment.md +++ b/markdown/bitburner.stanek.removefragment.md @@ -14,10 +14,55 @@ removeFragment(rootX: number, rootY: number): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| rootX | number | X against which to align the top left of the fragment. | -| rootY | number | Y against which to align the top left of the fragment. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +rootX + + + + +number + + + + +X against which to align the top left of the fragment. + + +
+ +rootY + + + + +number + + + + +Y against which to align the top left of the fragment. + + +
**Returns:** diff --git a/markdown/bitburner.stockmarketconstants.md b/markdown/bitburner.stockmarketconstants.md index d8c3592a1..827e509ef 100644 --- a/markdown/bitburner.stockmarketconstants.md +++ b/markdown/bitburner.stockmarketconstants.md @@ -14,14 +14,178 @@ interface StockMarketConstants ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [MarketData4SCost](./bitburner.stockmarketconstants.marketdata4scost.md) | | number | Cost of the 4S Market Data | -| [MarketDataTixApi4SCost](./bitburner.stockmarketconstants.marketdatatixapi4scost.md) | | number | Cost of the 4S Market Data TIX API integration | -| [msPerStockUpdate](./bitburner.stockmarketconstants.msperstockupdate.md) | | number | Normal time in ms between stock market updates | -| [msPerStockUpdateMin](./bitburner.stockmarketconstants.msperstockupdatemin.md) | | number | Minimum time in ms between stock market updates if there is stored offline/bonus time | -| [StockMarketCommission](./bitburner.stockmarketconstants.stockmarketcommission.md) | | number | Commission fee for transactions | -| [TicksPerCycle](./bitburner.stockmarketconstants.tickspercycle.md) | | number | An internal constant used while determining when to flip a stock's forecast | -| [TixApiCost](./bitburner.stockmarketconstants.tixapicost.md) | | number | Cost of the TIX API | -| [WseAccountCost](./bitburner.stockmarketconstants.wseaccountcost.md) | | number | Cost of the WSE account | + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[MarketData4SCost](./bitburner.stockmarketconstants.marketdata4scost.md) + + + + + + + +number + + + + +Cost of the 4S Market Data + + +
+ +[MarketDataTixApi4SCost](./bitburner.stockmarketconstants.marketdatatixapi4scost.md) + + + + + + + +number + + + + +Cost of the 4S Market Data TIX API integration + + +
+ +[msPerStockUpdate](./bitburner.stockmarketconstants.msperstockupdate.md) + + + + + + + +number + + + + +Normal time in ms between stock market updates + + +
+ +[msPerStockUpdateMin](./bitburner.stockmarketconstants.msperstockupdatemin.md) + + + + + + + +number + + + + +Minimum time in ms between stock market updates if there is stored offline/bonus time + + +
+ +[StockMarketCommission](./bitburner.stockmarketconstants.stockmarketcommission.md) + + + + + + + +number + + + + +Commission fee for transactions + + +
+ +[TicksPerCycle](./bitburner.stockmarketconstants.tickspercycle.md) + + + + + + + +number + + + + +An internal constant used while determining when to flip a stock's forecast + + +
+ +[TixApiCost](./bitburner.stockmarketconstants.tixapicost.md) + + + + + + + +number + + + + +Cost of the TIX API + + +
+ +[WseAccountCost](./bitburner.stockmarketconstants.wseaccountcost.md) + + + + + + + +number + + + + +Cost of the WSE account + + +
diff --git a/markdown/bitburner.stockorder.md b/markdown/bitburner.stockorder.md index 0491a5839..5c079580f 100644 --- a/markdown/bitburner.stockorder.md +++ b/markdown/bitburner.stockorder.md @@ -13,10 +13,102 @@ interface StockOrder ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [position](./bitburner.stockorder.position.md) | | [PositionType](./bitburner.positiontype.md) | Order position | -| [price](./bitburner.stockorder.price.md) | | number | Price per share | -| [shares](./bitburner.stockorder.shares.md) | | number | Number of shares | -| [type](./bitburner.stockorder.type.md) | | [OrderType](./bitburner.ordertype.md) | Order type | + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[position](./bitburner.stockorder.position.md) + + + + + + + +[PositionType](./bitburner.positiontype.md) + + + + +Order position + + +
+ +[price](./bitburner.stockorder.price.md) + + + + + + + +number + + + + +Price per share + + +
+ +[shares](./bitburner.stockorder.shares.md) + + + + + + + +number + + + + +Number of shares + + +
+ +[type](./bitburner.stockorder.type.md) + + + + + + + +[OrderType](./bitburner.ordertype.md) + + + + +Order type + + +
diff --git a/markdown/bitburner.studytask.md b/markdown/bitburner.studytask.md index 65ff9d12a..d259e79ee 100644 --- a/markdown/bitburner.studytask.md +++ b/markdown/bitburner.studytask.md @@ -19,9 +19,77 @@ An object representing the current study task ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [classType](./bitburner.studytask.classtype.md) | | string | | -| [location](./bitburner.studytask.location.md) | | [LocationName](./bitburner.locationname.md) | | -| [type](./bitburner.studytask.type.md) | | "CLASS" | | + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[classType](./bitburner.studytask.classtype.md) + + + + + + + +string + + + + + +
+ +[location](./bitburner.studytask.location.md) + + + + + + + +[LocationName](./bitburner.locationname.md) + + + + + +
+ +[type](./bitburner.studytask.type.md) + + + + + + + +"CLASS" + + + + + +
diff --git a/markdown/bitburner.tailproperties.md b/markdown/bitburner.tailproperties.md index 4a3bcb0e0..624321248 100644 --- a/markdown/bitburner.tailproperties.md +++ b/markdown/bitburner.tailproperties.md @@ -13,11 +13,121 @@ interface TailProperties ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [fontSize](./bitburner.tailproperties.fontsize.md) | | number | The font size of the tail window. Defaults to the font size set in the style editor. | -| [height](./bitburner.tailproperties.height.md) | | number | Height of the log window content area | -| [width](./bitburner.tailproperties.width.md) | | number | Width of the log window content area | -| [x](./bitburner.tailproperties.x.md) | | number | X-coordinate of the log window | -| [y](./bitburner.tailproperties.y.md) | | number | Y-coordinate of the log window | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[fontSize](./bitburner.tailproperties.fontsize.md) + + + + + + + +number + + + + +The font size of the tail window. Defaults to the font size set in the style editor. + + +
+ +[height](./bitburner.tailproperties.height.md) + + + + + + + +number + + + + +Height of the log window content area + + +
+ +[width](./bitburner.tailproperties.width.md) + + + + + + + +number + + + + +Width of the log window content area + + +
+ +[x](./bitburner.tailproperties.x.md) + + + + + + + +number + + + + +X-coordinate of the log window + + +
+ +[y](./bitburner.tailproperties.y.md) + + + + + + + +number + + + + +Y-coordinate of the log window + + +
diff --git a/markdown/bitburner.tix.buyshort.md b/markdown/bitburner.tix.buyshort.md index b256d2e56..9fb93b86e 100644 --- a/markdown/bitburner.tix.buyshort.md +++ b/markdown/bitburner.tix.buyshort.md @@ -14,10 +14,55 @@ buyShort(sym: string, shares: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | -| shares | number | Number of shares to short. Must be positive. Will be rounded to the nearest integer. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
+ +shares + + + + +number + + + + +Number of shares to short. Must be positive. Will be rounded to the nearest integer. + + +
**Returns:** diff --git a/markdown/bitburner.tix.buystock.md b/markdown/bitburner.tix.buystock.md index a223c0733..9ae0049d2 100644 --- a/markdown/bitburner.tix.buystock.md +++ b/markdown/bitburner.tix.buystock.md @@ -14,10 +14,55 @@ buyStock(sym: string, shares: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | -| shares | number | Number of shares to purchase. Must be positive. Will be rounded to the nearest integer. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
+ +shares + + + + +number + + + + +Number of shares to purchase. Must be positive. Will be rounded to the nearest integer. + + +
**Returns:** diff --git a/markdown/bitburner.tix.cancelorder.md b/markdown/bitburner.tix.cancelorder.md index d6ab09734..d28561901 100644 --- a/markdown/bitburner.tix.cancelorder.md +++ b/markdown/bitburner.tix.cancelorder.md @@ -14,13 +14,103 @@ cancelOrder(sym: string, shares: number, price: number, orderType: OrderType, po ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | -| shares | number | Number of shares for order. Must be positive. Will be rounded to the nearest integer. | -| price | number | Execution price for the order. | -| orderType | [OrderType](./bitburner.ordertype.md) | Type of order. | -| positionType | [PositionType](./bitburner.positiontype.md) | Specifies whether the order is a Long ("L") or Short ("S") position. | + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
+ +shares + + + + +number + + + + +Number of shares for order. Must be positive. Will be rounded to the nearest integer. + + +
+ +price + + + + +number + + + + +Execution price for the order. + + +
+ +orderType + + + + +[OrderType](./bitburner.ordertype.md) + + + + +Type of order. + + +
+ +positionType + + + + +[PositionType](./bitburner.positiontype.md) + + + + +Specifies whether the order is a Long ("L") or Short ("S") position. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getaskprice.md b/markdown/bitburner.tix.getaskprice.md index f78b40e2f..b6304a589 100644 --- a/markdown/bitburner.tix.getaskprice.md +++ b/markdown/bitburner.tix.getaskprice.md @@ -14,9 +14,39 @@ getAskPrice(sym: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getbidprice.md b/markdown/bitburner.tix.getbidprice.md index bcebd8ff3..a51807c0d 100644 --- a/markdown/bitburner.tix.getbidprice.md +++ b/markdown/bitburner.tix.getbidprice.md @@ -14,9 +14,39 @@ getBidPrice(sym: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getforecast.md b/markdown/bitburner.tix.getforecast.md index a85b72a0d..bee59f952 100644 --- a/markdown/bitburner.tix.getforecast.md +++ b/markdown/bitburner.tix.getforecast.md @@ -14,9 +14,39 @@ getForecast(sym: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getmaxshares.md b/markdown/bitburner.tix.getmaxshares.md index 0715ec4d3..9def59552 100644 --- a/markdown/bitburner.tix.getmaxshares.md +++ b/markdown/bitburner.tix.getmaxshares.md @@ -14,9 +14,39 @@ getMaxShares(sym: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getorganization.md b/markdown/bitburner.tix.getorganization.md index c246255de..2de55c1a2 100644 --- a/markdown/bitburner.tix.getorganization.md +++ b/markdown/bitburner.tix.getorganization.md @@ -14,9 +14,39 @@ getOrganization(sym: string): string; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getposition.md b/markdown/bitburner.tix.getposition.md index e32345d64..4509347db 100644 --- a/markdown/bitburner.tix.getposition.md +++ b/markdown/bitburner.tix.getposition.md @@ -14,9 +14,39 @@ getPosition(sym: string): [number, number, number, number]; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getprice.md b/markdown/bitburner.tix.getprice.md index fd9656620..f0aa6b358 100644 --- a/markdown/bitburner.tix.getprice.md +++ b/markdown/bitburner.tix.getprice.md @@ -14,9 +14,39 @@ getPrice(sym: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getpurchasecost.md b/markdown/bitburner.tix.getpurchasecost.md index 04b22cfb0..7db3af3c1 100644 --- a/markdown/bitburner.tix.getpurchasecost.md +++ b/markdown/bitburner.tix.getpurchasecost.md @@ -14,11 +14,71 @@ getPurchaseCost(sym: string, shares: number, positionType: PositionType): number ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | -| shares | number | Number of shares to purchase. | -| positionType | [PositionType](./bitburner.positiontype.md) | Specifies whether the order is a Long ("L") or Short ("S") position. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
+ +shares + + + + +number + + + + +Number of shares to purchase. + + +
+ +positionType + + + + +[PositionType](./bitburner.positiontype.md) + + + + +Specifies whether the order is a Long ("L") or Short ("S") position. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getsalegain.md b/markdown/bitburner.tix.getsalegain.md index 21b2f6302..3ef21e612 100644 --- a/markdown/bitburner.tix.getsalegain.md +++ b/markdown/bitburner.tix.getsalegain.md @@ -14,11 +14,71 @@ getSaleGain(sym: string, shares: number, positionType: PositionType): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | -| shares | number | Number of shares to sell. | -| positionType | [PositionType](./bitburner.positiontype.md) | Specifies whether the order is a Long ("L") or Short ("S") position. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
+ +shares + + + + +number + + + + +Number of shares to sell. + + +
+ +positionType + + + + +[PositionType](./bitburner.positiontype.md) + + + + +Specifies whether the order is a Long ("L") or Short ("S") position. + + +
**Returns:** diff --git a/markdown/bitburner.tix.getvolatility.md b/markdown/bitburner.tix.getvolatility.md index 9bee73516..b287d20a3 100644 --- a/markdown/bitburner.tix.getvolatility.md +++ b/markdown/bitburner.tix.getvolatility.md @@ -14,9 +14,39 @@ getVolatility(sym: string): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
**Returns:** diff --git a/markdown/bitburner.tix.md b/markdown/bitburner.tix.md index b7fc85ac9..10f962c82 100644 --- a/markdown/bitburner.tix.md +++ b/markdown/bitburner.tix.md @@ -14,35 +14,335 @@ export interface TIX ## Methods -| Method | Description | -| --- | --- | -| [buyShort(sym, shares)](./bitburner.tix.buyshort.md) | Short stocks. | -| [buyStock(sym, shares)](./bitburner.tix.buystock.md) | Buy stocks. | -| [cancelOrder(sym, shares, price, orderType, positionType)](./bitburner.tix.cancelorder.md) | Cancel order for stocks. | -| [getAskPrice(sym)](./bitburner.tix.getaskprice.md) | Returns the ask price of that stock. | -| [getBidPrice(sym)](./bitburner.tix.getbidprice.md) | Returns the bid price of that stock. | -| [getBonusTime()](./bitburner.tix.getbonustime.md) | Get Stock Market bonus time. | -| [getConstants()](./bitburner.tix.getconstants.md) | Get game constants for the stock market mechanic. | -| [getForecast(sym)](./bitburner.tix.getforecast.md) | Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. | -| [getMaxShares(sym)](./bitburner.tix.getmaxshares.md) | Returns the maximum number of shares of a stock. | -| [getOrders()](./bitburner.tix.getorders.md) | Returns your order book for the stock market. | -| [getOrganization(sym)](./bitburner.tix.getorganization.md) | Returns the organization associated with a stock symbol. | -| [getPosition(sym)](./bitburner.tix.getposition.md) | Returns the player’s position in a stock. | -| [getPrice(sym)](./bitburner.tix.getprice.md) | Returns the price of a stock. | -| [getPurchaseCost(sym, shares, positionType)](./bitburner.tix.getpurchasecost.md) | Calculates cost of buying stocks. | -| [getSaleGain(sym, shares, positionType)](./bitburner.tix.getsalegain.md) | Calculate profit of selling stocks. | -| [getSymbols()](./bitburner.tix.getsymbols.md) | Returns an array of the symbols of the tradable stocks | -| [getVolatility(sym)](./bitburner.tix.getvolatility.md) | Returns the volatility of the specified stock. | -| [has4SData()](./bitburner.tix.has4sdata.md) | Returns true if the player has access to the 4S Data | -| [has4SDataTixApi()](./bitburner.tix.has4sdatatixapi.md) | Returns true if the player has access to the 4SData TIX API | -| [hasTixApiAccess()](./bitburner.tix.hastixapiaccess.md) | Returns true if the player has access to the TIX API | -| [hasWseAccount()](./bitburner.tix.haswseaccount.md) | Returns true if the player has access to a WSE Account | -| [nextUpdate()](./bitburner.tix.nextupdate.md) | Sleep until the next Stock Market price update has happened. | -| [placeOrder(sym, shares, price, orderType, positionType)](./bitburner.tix.placeorder.md) | Place order for stocks. | -| [purchase4SMarketData()](./bitburner.tix.purchase4smarketdata.md) | Purchase 4S Market Data Access. | -| [purchase4SMarketDataTixApi()](./bitburner.tix.purchase4smarketdatatixapi.md) | Purchase 4S Market Data TIX API Access. | -| [purchaseTixApi()](./bitburner.tix.purchasetixapi.md) | Purchase TIX API Access | -| [purchaseWseAccount()](./bitburner.tix.purchasewseaccount.md) | Purchase WSE Account. | -| [sellShort(sym, shares)](./bitburner.tix.sellshort.md) | Sell short stock. | -| [sellStock(sym, shares)](./bitburner.tix.sellstock.md) | Sell stocks. | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[buyShort(sym, shares)](./bitburner.tix.buyshort.md) + + + + +Short stocks. + + +
+ +[buyStock(sym, shares)](./bitburner.tix.buystock.md) + + + + +Buy stocks. + + +
+ +[cancelOrder(sym, shares, price, orderType, positionType)](./bitburner.tix.cancelorder.md) + + + + +Cancel order for stocks. + + +
+ +[getAskPrice(sym)](./bitburner.tix.getaskprice.md) + + + + +Returns the ask price of that stock. + + +
+ +[getBidPrice(sym)](./bitburner.tix.getbidprice.md) + + + + +Returns the bid price of that stock. + + +
+ +[getBonusTime()](./bitburner.tix.getbonustime.md) + + + + +Get Stock Market bonus time. + + +
+ +[getConstants()](./bitburner.tix.getconstants.md) + + + + +Get game constants for the stock market mechanic. + + +
+ +[getForecast(sym)](./bitburner.tix.getforecast.md) + + + + +Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. + + +
+ +[getMaxShares(sym)](./bitburner.tix.getmaxshares.md) + + + + +Returns the maximum number of shares of a stock. + + +
+ +[getOrders()](./bitburner.tix.getorders.md) + + + + +Returns your order book for the stock market. + + +
+ +[getOrganization(sym)](./bitburner.tix.getorganization.md) + + + + +Returns the organization associated with a stock symbol. + + +
+ +[getPosition(sym)](./bitburner.tix.getposition.md) + + + + +Returns the player’s position in a stock. + + +
+ +[getPrice(sym)](./bitburner.tix.getprice.md) + + + + +Returns the price of a stock. + + +
+ +[getPurchaseCost(sym, shares, positionType)](./bitburner.tix.getpurchasecost.md) + + + + +Calculates cost of buying stocks. + + +
+ +[getSaleGain(sym, shares, positionType)](./bitburner.tix.getsalegain.md) + + + + +Calculate profit of selling stocks. + + +
+ +[getSymbols()](./bitburner.tix.getsymbols.md) + + + + +Returns an array of the symbols of the tradable stocks + + +
+ +[getVolatility(sym)](./bitburner.tix.getvolatility.md) + + + + +Returns the volatility of the specified stock. + + +
+ +[has4SData()](./bitburner.tix.has4sdata.md) + + + + +Returns true if the player has access to the 4S Data + + +
+ +[has4SDataTixApi()](./bitburner.tix.has4sdatatixapi.md) + + + + +Returns true if the player has access to the 4SData TIX API + + +
+ +[hasTixApiAccess()](./bitburner.tix.hastixapiaccess.md) + + + + +Returns true if the player has access to the TIX API + + +
+ +[hasWseAccount()](./bitburner.tix.haswseaccount.md) + + + + +Returns true if the player has access to a WSE Account + + +
+ +[nextUpdate()](./bitburner.tix.nextupdate.md) + + + + +Sleep until the next Stock Market price update has happened. + + +
+ +[placeOrder(sym, shares, price, orderType, positionType)](./bitburner.tix.placeorder.md) + + + + +Place order for stocks. + + +
+ +[purchase4SMarketData()](./bitburner.tix.purchase4smarketdata.md) + + + + +Purchase 4S Market Data Access. + + +
+ +[purchase4SMarketDataTixApi()](./bitburner.tix.purchase4smarketdatatixapi.md) + + + + +Purchase 4S Market Data TIX API Access. + + +
+ +[purchaseTixApi()](./bitburner.tix.purchasetixapi.md) + + + + +Purchase TIX API Access + + +
+ +[purchaseWseAccount()](./bitburner.tix.purchasewseaccount.md) + + + + +Purchase WSE Account. + + +
+ +[sellShort(sym, shares)](./bitburner.tix.sellshort.md) + + + + +Sell short stock. + + +
+ +[sellStock(sym, shares)](./bitburner.tix.sellstock.md) + + + + +Sell stocks. + + +
diff --git a/markdown/bitburner.tix.placeorder.md b/markdown/bitburner.tix.placeorder.md index 1c7cd5b24..337ef8849 100644 --- a/markdown/bitburner.tix.placeorder.md +++ b/markdown/bitburner.tix.placeorder.md @@ -14,13 +14,103 @@ placeOrder(sym: string, shares: number, price: number, orderType: OrderType, pos ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | -| shares | number | Number of shares for order. Must be positive. Will be rounded to the nearest integer. | -| price | number | Execution price for the order. | -| orderType | [OrderType](./bitburner.ordertype.md) | Type of order. | -| positionType | [PositionType](./bitburner.positiontype.md) | Specifies whether the order is a Long ("L") or Short ("S") position. | + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
+ +shares + + + + +number + + + + +Number of shares for order. Must be positive. Will be rounded to the nearest integer. + + +
+ +price + + + + +number + + + + +Execution price for the order. + + +
+ +orderType + + + + +[OrderType](./bitburner.ordertype.md) + + + + +Type of order. + + +
+ +positionType + + + + +[PositionType](./bitburner.positiontype.md) + + + + +Specifies whether the order is a Long ("L") or Short ("S") position. + + +
**Returns:** diff --git a/markdown/bitburner.tix.sellshort.md b/markdown/bitburner.tix.sellshort.md index 5a850e8f2..3e8e73f32 100644 --- a/markdown/bitburner.tix.sellshort.md +++ b/markdown/bitburner.tix.sellshort.md @@ -14,10 +14,55 @@ sellShort(sym: string, shares: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | -| shares | number | Number of shares to sell. Must be positive. Will be rounded to the nearest integer. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
+ +shares + + + + +number + + + + +Number of shares to sell. Must be positive. Will be rounded to the nearest integer. + + +
**Returns:** diff --git a/markdown/bitburner.tix.sellstock.md b/markdown/bitburner.tix.sellstock.md index af5e2df87..544f4f6fb 100644 --- a/markdown/bitburner.tix.sellstock.md +++ b/markdown/bitburner.tix.sellstock.md @@ -14,10 +14,55 @@ sellStock(sym: string, shares: number): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sym | string | Stock symbol. | -| shares | number | Number of shares to sell. Must be positive. Will be rounded to the nearest integer. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sym + + + + +string + + + + +Stock symbol. + + +
+ +shares + + + + +number + + + + +Number of shares to sell. Must be positive. Will be rounded to the nearest integer. + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.closetail.md b/markdown/bitburner.userinterface.closetail.md index ff65dc588..c32c13904 100644 --- a/markdown/bitburner.userinterface.closetail.md +++ b/markdown/bitburner.userinterface.closetail.md @@ -14,9 +14,39 @@ closeTail(pid?: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| pid | number | _(Optional)_ Optional. PID of the script having its tail closed. If omitted, the current script is used. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +pid + + + + +number + + + + +_(Optional)_ Optional. PID of the script having its tail closed. If omitted, the current script is used. + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.md b/markdown/bitburner.userinterface.md index 92cf02799..115c1639a 100644 --- a/markdown/bitburner.userinterface.md +++ b/markdown/bitburner.userinterface.md @@ -14,22 +14,192 @@ interface UserInterface ## Methods -| Method | Description | -| --- | --- | -| [clearTerminal()](./bitburner.userinterface.clearterminal.md) | Clear the Terminal window, as if the player ran clear in the terminal | -| [closeTail(pid)](./bitburner.userinterface.closetail.md) | Close the tail window of a script. | -| [getGameInfo()](./bitburner.userinterface.getgameinfo.md) | Gets the current game information (version, commit, ...) | -| [getStyles()](./bitburner.userinterface.getstyles.md) | Get the current styles | -| [getTheme()](./bitburner.userinterface.gettheme.md) | Get the current theme | -| [moveTail(x, y, pid)](./bitburner.userinterface.movetail.md) | Move a tail window. | -| [openTail(fn, host, args)](./bitburner.userinterface.opentail.md) | Open the tail window of a script. | -| [renderTail(pid)](./bitburner.userinterface.rendertail.md) | Render a tail window. | -| [resetStyles()](./bitburner.userinterface.resetstyles.md) | Resets the player's styles to the default values | -| [resetTheme()](./bitburner.userinterface.resettheme.md) | Resets the player's theme to the default values | -| [resizeTail(width, height, pid)](./bitburner.userinterface.resizetail.md) | Resize a tail window. | -| [setStyles(newStyles)](./bitburner.userinterface.setstyles.md) | Sets the current styles | -| [setTailFontSize(pixel, fn, host, args)](./bitburner.userinterface.settailfontsize.md) | Set the font size of the tail window of a script. | -| [setTailTitle(title, pid)](./bitburner.userinterface.settailtitle.md) | Set the title of the tail window of a script. | -| [setTheme(newTheme)](./bitburner.userinterface.settheme.md) | Sets the current theme | -| [windowSize()](./bitburner.userinterface.windowsize.md) | Get the current window size | + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[clearTerminal()](./bitburner.userinterface.clearterminal.md) + + + + +Clear the Terminal window, as if the player ran `clear` in the terminal + + +
+ +[closeTail(pid)](./bitburner.userinterface.closetail.md) + + + + +Close the tail window of a script. + + +
+ +[getGameInfo()](./bitburner.userinterface.getgameinfo.md) + + + + +Gets the current game information (version, commit, ...) + + +
+ +[getStyles()](./bitburner.userinterface.getstyles.md) + + + + +Get the current styles + + +
+ +[getTheme()](./bitburner.userinterface.gettheme.md) + + + + +Get the current theme + + +
+ +[moveTail(x, y, pid)](./bitburner.userinterface.movetail.md) + + + + +Move a tail window. + + +
+ +[openTail(fn, host, args)](./bitburner.userinterface.opentail.md) + + + + +Open the tail window of a script. + + +
+ +[renderTail(pid)](./bitburner.userinterface.rendertail.md) + + + + +Render a tail window. + + +
+ +[resetStyles()](./bitburner.userinterface.resetstyles.md) + + + + +Resets the player's styles to the default values + + +
+ +[resetTheme()](./bitburner.userinterface.resettheme.md) + + + + +Resets the player's theme to the default values + + +
+ +[resizeTail(width, height, pid)](./bitburner.userinterface.resizetail.md) + + + + +Resize a tail window. + + +
+ +[setStyles(newStyles)](./bitburner.userinterface.setstyles.md) + + + + +Sets the current styles + + +
+ +[setTailFontSize(pixel, fn, host, args)](./bitburner.userinterface.settailfontsize.md) + + + + +Set the font size of the tail window of a script. + + +
+ +[setTailTitle(title, pid)](./bitburner.userinterface.settailtitle.md) + + + + +Set the title of the tail window of a script. + + +
+ +[setTheme(newTheme)](./bitburner.userinterface.settheme.md) + + + + +Sets the current theme + + +
+ +[windowSize()](./bitburner.userinterface.windowsize.md) + + + + +Get the current window size + + +
diff --git a/markdown/bitburner.userinterface.movetail.md b/markdown/bitburner.userinterface.movetail.md index c4cb4b934..e95cebd8c 100644 --- a/markdown/bitburner.userinterface.movetail.md +++ b/markdown/bitburner.userinterface.movetail.md @@ -14,11 +14,71 @@ moveTail(x: number, y: number, pid?: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| x | number | x coordinate. | -| y | number | y coordinate. | -| pid | number | _(Optional)_ Optional. PID of the script having its tail moved. If omitted, the current script is used. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +x + + + + +number + + + + +x coordinate. + + +
+ +y + + + + +number + + + + +y coordinate. + + +
+ +pid + + + + +number + + + + +_(Optional)_ Optional. PID of the script having its tail moved. If omitted, the current script is used. + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.opentail.md b/markdown/bitburner.userinterface.opentail.md index bec9a774a..59918e30a 100644 --- a/markdown/bitburner.userinterface.opentail.md +++ b/markdown/bitburner.userinterface.opentail.md @@ -14,11 +14,71 @@ openTail(fn?: FilenameOrPID, host?: string, ...args: ScriptArg[]): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. | -| host | string | _(Optional)_ Optional. Hostname/IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments for the script being tailed. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +fn + + + + +[FilenameOrPID](./bitburner.filenameorpid.md) + + + + +_(Optional)_ Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. + + +
+ +host + + + + +string + + + + +_(Optional)_ Optional. Hostname/IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments for the script being tailed. + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.rendertail.md b/markdown/bitburner.userinterface.rendertail.md index 5c7dd58f9..f6cc6d013 100644 --- a/markdown/bitburner.userinterface.rendertail.md +++ b/markdown/bitburner.userinterface.rendertail.md @@ -14,9 +14,39 @@ renderTail(pid?: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| pid | number | _(Optional)_ Optional. PID of the script having its tail rendered. If omitted, the current script is used. | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +pid + + + + +number + + + + +_(Optional)_ Optional. PID of the script having its tail rendered. If omitted, the current script is used. + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.resizetail.md b/markdown/bitburner.userinterface.resizetail.md index 1fb65f92d..0a6ae2af6 100644 --- a/markdown/bitburner.userinterface.resizetail.md +++ b/markdown/bitburner.userinterface.resizetail.md @@ -14,11 +14,71 @@ resizeTail(width: number, height: number, pid?: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| width | number | Width of the window. | -| height | number | Height of the window. | -| pid | number | _(Optional)_ Optional. PID of the script having its tail resized. If omitted, the current script is used. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +width + + + + +number + + + + +Width of the window. + + +
+ +height + + + + +number + + + + +Height of the window. + + +
+ +pid + + + + +number + + + + +_(Optional)_ Optional. PID of the script having its tail resized. If omitted, the current script is used. + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.setstyles.md b/markdown/bitburner.userinterface.setstyles.md index 06eebd200..c28aa3531 100644 --- a/markdown/bitburner.userinterface.setstyles.md +++ b/markdown/bitburner.userinterface.setstyles.md @@ -14,9 +14,37 @@ setStyles(newStyles: IStyleSettings): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| newStyles | [IStyleSettings](./bitburner.istylesettings.md) | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newStyles + + + + +[IStyleSettings](./bitburner.istylesettings.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.settailfontsize.md b/markdown/bitburner.userinterface.settailfontsize.md index d08986dea..a1d228ccc 100644 --- a/markdown/bitburner.userinterface.settailfontsize.md +++ b/markdown/bitburner.userinterface.settailfontsize.md @@ -14,12 +14,87 @@ setTailFontSize(pixel?: number, fn?: FilenameOrPID, host?: string, ...args: Scri ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| pixel | number | _(Optional)_ Optional. The new font size in pixels. If omitted, the default tail font size is used. | -| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | _(Optional)_ Optional. Filename or PID of the target script. If omitted, the current script is used. | -| host | string | _(Optional)_ Optional. Hostname/IP of the target script. Defaults to the server this script is running on. If args are specified, this is not optional. | -| args | [ScriptArg](./bitburner.scriptarg.md)\[\] | Arguments for the target script. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +pixel + + + + +number + + + + +_(Optional)_ Optional. The new font size in pixels. If omitted, the default tail font size is used. + + +
+ +fn + + + + +[FilenameOrPID](./bitburner.filenameorpid.md) + + + + +_(Optional)_ Optional. Filename or PID of the target script. If omitted, the current script is used. + + +
+ +host + + + + +string + + + + +_(Optional)_ Optional. Hostname/IP of the target script. Defaults to the server this script is running on. If args are specified, this is not optional. + + +
+ +args + + + + +[ScriptArg](./bitburner.scriptarg.md)\[\] + + + + +Arguments for the target script. + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.settailtitle.md b/markdown/bitburner.userinterface.settailtitle.md index c4a67e8cd..ca4fcfbd9 100644 --- a/markdown/bitburner.userinterface.settailtitle.md +++ b/markdown/bitburner.userinterface.settailtitle.md @@ -14,10 +14,55 @@ setTailTitle(title: string | ReactNode, pid?: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| title | string \| [ReactNode](./bitburner.reactnode.md) | The new title for the tail window. | -| pid | number | _(Optional)_ Optional. PID of the script having its tail closed. If omitted, the current script is used. | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +title + + + + +string \| [ReactNode](./bitburner.reactnode.md) + + + + +The new title for the tail window. + + +
+ +pid + + + + +number + + + + +_(Optional)_ Optional. PID of the script having its tail closed. If omitted, the current script is used. + + +
**Returns:** diff --git a/markdown/bitburner.userinterface.settheme.md b/markdown/bitburner.userinterface.settheme.md index a985dd145..426eb7d99 100644 --- a/markdown/bitburner.userinterface.settheme.md +++ b/markdown/bitburner.userinterface.settheme.md @@ -14,9 +14,37 @@ setTheme(newTheme: UserInterfaceTheme): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| newTheme | [UserInterfaceTheme](./bitburner.userinterfacetheme.md) | | + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +newTheme + + + + +[UserInterfaceTheme](./bitburner.userinterfacetheme.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.userinterfacetheme.md b/markdown/bitburner.userinterfacetheme.md index e087ef439..8ea73bc03 100644 --- a/markdown/bitburner.userinterfacetheme.md +++ b/markdown/bitburner.userinterfacetheme.md @@ -14,44 +14,672 @@ interface UserInterfaceTheme ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [backgroundprimary](./bitburner.userinterfacetheme.backgroundprimary.md) | | string | | -| [backgroundsecondary](./bitburner.userinterfacetheme.backgroundsecondary.md) | | string | | -| [black](./bitburner.userinterfacetheme.black.md) | | string | | -| [bnlvl0](./bitburner.userinterfacetheme.bnlvl0.md) | | string | | -| [bnlvl1](./bitburner.userinterfacetheme.bnlvl1.md) | | string | | -| [bnlvl2](./bitburner.userinterfacetheme.bnlvl2.md) | | string | | -| [bnlvl3](./bitburner.userinterfacetheme.bnlvl3.md) | | string | | -| [button](./bitburner.userinterfacetheme.button.md) | | string | | -| [cha](./bitburner.userinterfacetheme.cha.md) | | string | | -| [combat](./bitburner.userinterfacetheme.combat.md) | | string | | -| [disabled](./bitburner.userinterfacetheme.disabled.md) | | string | | -| [error](./bitburner.userinterfacetheme.error.md) | | string | | -| [errordark](./bitburner.userinterfacetheme.errordark.md) | | string | | -| [errorlight](./bitburner.userinterfacetheme.errorlight.md) | | string | | -| [hack](./bitburner.userinterfacetheme.hack.md) | | string | | -| [hp](./bitburner.userinterfacetheme.hp.md) | | string | | -| [info](./bitburner.userinterfacetheme.info.md) | | string | | -| [infodark](./bitburner.userinterfacetheme.infodark.md) | | string | | -| [infolight](./bitburner.userinterfacetheme.infolight.md) | | string | | -| [int](./bitburner.userinterfacetheme.int.md) | | string | | -| [maplocation](./bitburner.userinterfacetheme.maplocation.md) | | string | | -| [money](./bitburner.userinterfacetheme.money.md) | | string | | -| [primary](./bitburner.userinterfacetheme.primary.md) | | string | | -| [primarydark](./bitburner.userinterfacetheme.primarydark.md) | | string | | -| [primarylight](./bitburner.userinterfacetheme.primarylight.md) | | string | | -| [rep](./bitburner.userinterfacetheme.rep.md) | | string | | -| [secondary](./bitburner.userinterfacetheme.secondary.md) | | string | | -| [secondarydark](./bitburner.userinterfacetheme.secondarydark.md) | | string | | -| [secondarylight](./bitburner.userinterfacetheme.secondarylight.md) | | string | | -| [success](./bitburner.userinterfacetheme.success.md) | | string | | -| [successdark](./bitburner.userinterfacetheme.successdark.md) | | string | | -| [successlight](./bitburner.userinterfacetheme.successlight.md) | | string | | -| [warning](./bitburner.userinterfacetheme.warning.md) | | string | | -| [warningdark](./bitburner.userinterfacetheme.warningdark.md) | | string | | -| [warninglight](./bitburner.userinterfacetheme.warninglight.md) | | string | | -| [well](./bitburner.userinterfacetheme.well.md) | | string | | -| [welllight](./bitburner.userinterfacetheme.welllight.md) | | string | | -| [white](./bitburner.userinterfacetheme.white.md) | | string | | + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[backgroundprimary](./bitburner.userinterfacetheme.backgroundprimary.md) + + + + + + + +string + + + + + +
+ +[backgroundsecondary](./bitburner.userinterfacetheme.backgroundsecondary.md) + + + + + + + +string + + + + + +
+ +[black](./bitburner.userinterfacetheme.black.md) + + + + + + + +string + + + + + +
+ +[bnlvl0](./bitburner.userinterfacetheme.bnlvl0.md) + + + + + + + +string + + + + + +
+ +[bnlvl1](./bitburner.userinterfacetheme.bnlvl1.md) + + + + + + + +string + + + + + +
+ +[bnlvl2](./bitburner.userinterfacetheme.bnlvl2.md) + + + + + + + +string + + + + + +
+ +[bnlvl3](./bitburner.userinterfacetheme.bnlvl3.md) + + + + + + + +string + + + + + +
+ +[button](./bitburner.userinterfacetheme.button.md) + + + + + + + +string + + + + + +
+ +[cha](./bitburner.userinterfacetheme.cha.md) + + + + + + + +string + + + + + +
+ +[combat](./bitburner.userinterfacetheme.combat.md) + + + + + + + +string + + + + + +
+ +[disabled](./bitburner.userinterfacetheme.disabled.md) + + + + + + + +string + + + + + +
+ +[error](./bitburner.userinterfacetheme.error.md) + + + + + + + +string + + + + + +
+ +[errordark](./bitburner.userinterfacetheme.errordark.md) + + + + + + + +string + + + + + +
+ +[errorlight](./bitburner.userinterfacetheme.errorlight.md) + + + + + + + +string + + + + + +
+ +[hack](./bitburner.userinterfacetheme.hack.md) + + + + + + + +string + + + + + +
+ +[hp](./bitburner.userinterfacetheme.hp.md) + + + + + + + +string + + + + + +
+ +[info](./bitburner.userinterfacetheme.info.md) + + + + + + + +string + + + + + +
+ +[infodark](./bitburner.userinterfacetheme.infodark.md) + + + + + + + +string + + + + + +
+ +[infolight](./bitburner.userinterfacetheme.infolight.md) + + + + + + + +string + + + + + +
+ +[int](./bitburner.userinterfacetheme.int.md) + + + + + + + +string + + + + + +
+ +[maplocation](./bitburner.userinterfacetheme.maplocation.md) + + + + + + + +string + + + + + +
+ +[money](./bitburner.userinterfacetheme.money.md) + + + + + + + +string + + + + + +
+ +[primary](./bitburner.userinterfacetheme.primary.md) + + + + + + + +string + + + + + +
+ +[primarydark](./bitburner.userinterfacetheme.primarydark.md) + + + + + + + +string + + + + + +
+ +[primarylight](./bitburner.userinterfacetheme.primarylight.md) + + + + + + + +string + + + + + +
+ +[rep](./bitburner.userinterfacetheme.rep.md) + + + + + + + +string + + + + + +
+ +[secondary](./bitburner.userinterfacetheme.secondary.md) + + + + + + + +string + + + + + +
+ +[secondarydark](./bitburner.userinterfacetheme.secondarydark.md) + + + + + + + +string + + + + + +
+ +[secondarylight](./bitburner.userinterfacetheme.secondarylight.md) + + + + + + + +string + + + + + +
+ +[success](./bitburner.userinterfacetheme.success.md) + + + + + + + +string + + + + + +
+ +[successdark](./bitburner.userinterfacetheme.successdark.md) + + + + + + + +string + + + + + +
+ +[successlight](./bitburner.userinterfacetheme.successlight.md) + + + + + + + +string + + + + + +
+ +[warning](./bitburner.userinterfacetheme.warning.md) + + + + + + + +string + + + + + +
+ +[warningdark](./bitburner.userinterfacetheme.warningdark.md) + + + + + + + +string + + + + + +
+ +[warninglight](./bitburner.userinterfacetheme.warninglight.md) + + + + + + + +string + + + + + +
+ +[well](./bitburner.userinterfacetheme.well.md) + + + + + + + +string + + + + + +
+ +[welllight](./bitburner.userinterfacetheme.welllight.md) + + + + + + + +string + + + + + +
+ +[white](./bitburner.userinterfacetheme.white.md) + + + + + + + +string + + + + + +
diff --git a/markdown/bitburner.warehouse.md b/markdown/bitburner.warehouse.md index b71067ca6..12286dc9a 100644 --- a/markdown/bitburner.warehouse.md +++ b/markdown/bitburner.warehouse.md @@ -14,11 +14,121 @@ interface Warehouse ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [city](./bitburner.warehouse.city.md) | | [CityName](./bitburner.cityname.md) | City in which the warehouse is located | -| [level](./bitburner.warehouse.level.md) | | number | Amount of size upgrade bought | -| [size](./bitburner.warehouse.size.md) | | number | Total space in the warehouse | -| [sizeUsed](./bitburner.warehouse.sizeused.md) | | number | Used space in the warehouse | -| [smartSupplyEnabled](./bitburner.warehouse.smartsupplyenabled.md) | | boolean | Smart Supply status in the warehouse | + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[city](./bitburner.warehouse.city.md) + + + + + + + +[CityName](./bitburner.cityname.md) + + + + +City in which the warehouse is located + + +
+ +[level](./bitburner.warehouse.level.md) + + + + + + + +number + + + + +Amount of size upgrade bought + + +
+ +[size](./bitburner.warehouse.size.md) + + + + + + + +number + + + + +Total space in the warehouse + + +
+ +[sizeUsed](./bitburner.warehouse.sizeused.md) + + + + + + + +number + + + + +Used space in the warehouse + + +
+ +[smartSupplyEnabled](./bitburner.warehouse.smartsupplyenabled.md) + + + + + + + +boolean + + + + +Smart Supply status in the warehouse + + +
diff --git a/markdown/bitburner.warehouseapi.bulkpurchase.md b/markdown/bitburner.warehouseapi.bulkpurchase.md index 5bf613601..28dee1c0a 100644 --- a/markdown/bitburner.warehouseapi.bulkpurchase.md +++ b/markdown/bitburner.warehouseapi.bulkpurchase.md @@ -14,12 +14,87 @@ bulkPurchase(divisionName: string, city: CityName, materialName: CorpMaterialNam ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| amt | number | Amount of material to buy | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
+ +amt + + + + +number + + + + +Amount of material to buy + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.buymaterial.md b/markdown/bitburner.warehouseapi.buymaterial.md index 618115155..094f664fe 100644 --- a/markdown/bitburner.warehouseapi.buymaterial.md +++ b/markdown/bitburner.warehouseapi.buymaterial.md @@ -14,12 +14,87 @@ buyMaterial(divisionName: string, city: CityName, materialName: CorpMaterialName ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| amt | number | Amount of material to buy | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
+ +amt + + + + +number + + + + +Amount of material to buy + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.cancelexportmaterial.md b/markdown/bitburner.warehouseapi.cancelexportmaterial.md index c56ce580f..6515b6703 100644 --- a/markdown/bitburner.warehouseapi.cancelexportmaterial.md +++ b/markdown/bitburner.warehouseapi.cancelexportmaterial.md @@ -20,13 +20,103 @@ cancelExportMaterial( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sourceDivision | string | Source division | -| sourceCity | [CityName](./bitburner.cityname.md) | Source city | -| targetDivision | string | Target division | -| targetCity | [CityName](./bitburner.cityname.md) | Target city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sourceDivision + + + + +string + + + + +Source division + + +
+ +sourceCity + + + + +[CityName](./bitburner.cityname.md) + + + + +Source city + + +
+ +targetDivision + + + + +string + + + + +Target division + + +
+ +targetCity + + + + +[CityName](./bitburner.cityname.md) + + + + +Target city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.discontinueproduct.md b/markdown/bitburner.warehouseapi.discontinueproduct.md index ec1569fa2..083e40201 100644 --- a/markdown/bitburner.warehouseapi.discontinueproduct.md +++ b/markdown/bitburner.warehouseapi.discontinueproduct.md @@ -14,10 +14,55 @@ discontinueProduct(divisionName: string, productName: string): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| productName | string | Name of the product | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +productName + + + + +string + + + + +Name of the product + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.exportmaterial.md b/markdown/bitburner.warehouseapi.exportmaterial.md index 70222f53e..bc8974e28 100644 --- a/markdown/bitburner.warehouseapi.exportmaterial.md +++ b/markdown/bitburner.warehouseapi.exportmaterial.md @@ -21,14 +21,119 @@ exportMaterial( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| sourceDivision | string | Source division | -| sourceCity | [CityName](./bitburner.cityname.md) | Source city | -| targetDivision | string | Target division | -| targetCity | [CityName](./bitburner.cityname.md) | Target city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| amt | number \| string | Amount of material to export. | + + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +sourceDivision + + + + +string + + + + +Source division + + +
+ +sourceCity + + + + +[CityName](./bitburner.cityname.md) + + + + +Source city + + +
+ +targetDivision + + + + +string + + + + +Target division + + +
+ +targetCity + + + + +[CityName](./bitburner.cityname.md) + + + + +Target city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
+ +amt + + + + +number \| string + + + + +Amount of material to export. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.getmaterial.md b/markdown/bitburner.warehouseapi.getmaterial.md index 0d2c016be..d0861a2a9 100644 --- a/markdown/bitburner.warehouseapi.getmaterial.md +++ b/markdown/bitburner.warehouseapi.getmaterial.md @@ -14,11 +14,71 @@ getMaterial(divisionName: string, city: CityName, materialName: CorpMaterialName ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.getproduct.md b/markdown/bitburner.warehouseapi.getproduct.md index 8d78a4bce..b27940e74 100644 --- a/markdown/bitburner.warehouseapi.getproduct.md +++ b/markdown/bitburner.warehouseapi.getproduct.md @@ -14,11 +14,71 @@ getProduct(divisionName: string, cityName: CityName, productName: string): Produ ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| cityName | [CityName](./bitburner.cityname.md) | Name of the city | -| productName | string | Name of the product | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +cityName + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +productName + + + + +string + + + + +Name of the product + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.getupgradewarehousecost.md b/markdown/bitburner.warehouseapi.getupgradewarehousecost.md index 9f95f025e..0a7736f66 100644 --- a/markdown/bitburner.warehouseapi.getupgradewarehousecost.md +++ b/markdown/bitburner.warehouseapi.getupgradewarehousecost.md @@ -14,11 +14,71 @@ getUpgradeWarehouseCost(divisionName: string, city: CityName, amt?: number): num ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| amt | number | _(Optional)_ Amount of upgrades. Optional. Defaults to 1. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +amt + + + + +number + + + + +_(Optional)_ Amount of upgrades. Optional. Defaults to 1. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.getwarehouse.md b/markdown/bitburner.warehouseapi.getwarehouse.md index a976361ab..8b98eab90 100644 --- a/markdown/bitburner.warehouseapi.getwarehouse.md +++ b/markdown/bitburner.warehouseapi.getwarehouse.md @@ -14,10 +14,55 @@ getWarehouse(divisionName: string, city: CityName): Warehouse; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.haswarehouse.md b/markdown/bitburner.warehouseapi.haswarehouse.md index 29f1b5db6..fc9137f4f 100644 --- a/markdown/bitburner.warehouseapi.haswarehouse.md +++ b/markdown/bitburner.warehouseapi.haswarehouse.md @@ -14,10 +14,51 @@ hasWarehouse(divisionName: string, city: CityName): boolean; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | | -| city | [CityName](./bitburner.cityname.md) | | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.limitmaterialproduction.md b/markdown/bitburner.warehouseapi.limitmaterialproduction.md index 753d2d12b..c7345559c 100644 --- a/markdown/bitburner.warehouseapi.limitmaterialproduction.md +++ b/markdown/bitburner.warehouseapi.limitmaterialproduction.md @@ -14,12 +14,87 @@ limitMaterialProduction(divisionName: string, city: CityName, materialName: Corp ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division. | -| city | [CityName](./bitburner.cityname.md) | Name of the city. | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material. | -| qty | number | Amount to limit to. Pass a negative value to remove the limit instead. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division. + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city. + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material. + + +
+ +qty + + + + +number + + + + +Amount to limit to. Pass a negative value to remove the limit instead. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.limitproductproduction.md b/markdown/bitburner.warehouseapi.limitproductproduction.md index 75d2d5fa7..a663e92d7 100644 --- a/markdown/bitburner.warehouseapi.limitproductproduction.md +++ b/markdown/bitburner.warehouseapi.limitproductproduction.md @@ -14,12 +14,87 @@ limitProductProduction(divisionName: string, city: CityName, productName: string ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division. | -| city | [CityName](./bitburner.cityname.md) | Name of the city. | -| productName | string | Name of the product. | -| qty | number | Amount to limit to. Pass a negative value to remove the limit instead. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division. + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city. + + +
+ +productName + + + + +string + + + + +Name of the product. + + +
+ +qty + + + + +number + + + + +Amount to limit to. Pass a negative value to remove the limit instead. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.makeproduct.md b/markdown/bitburner.warehouseapi.makeproduct.md index b8ed5c2c6..e8148d1c8 100644 --- a/markdown/bitburner.warehouseapi.makeproduct.md +++ b/markdown/bitburner.warehouseapi.makeproduct.md @@ -20,13 +20,103 @@ makeProduct( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| productName | string | Name of the product | -| designInvest | number | Amount to invest for the design of the product. | -| marketingInvest | number | Amount to invest for the marketing of the product. | + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +productName + + + + +string + + + + +Name of the product + + +
+ +designInvest + + + + +number + + + + +Amount to invest for the design of the product. + + +
+ +marketingInvest + + + + +number + + + + +Amount to invest for the marketing of the product. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.md b/markdown/bitburner.warehouseapi.md index 6081f5928..5aa30eb3f 100644 --- a/markdown/bitburner.warehouseapi.md +++ b/markdown/bitburner.warehouseapi.md @@ -18,29 +18,269 @@ Requires the Warehouse API upgrade from your corporation. ## Methods -| Method | Description | -| --- | --- | -| [bulkPurchase(divisionName, city, materialName, amt)](./bitburner.warehouseapi.bulkpurchase.md) | Set material to bulk-buy. | -| [buyMaterial(divisionName, city, materialName, amt)](./bitburner.warehouseapi.buymaterial.md) | Set material buy data. | -| [cancelExportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName)](./bitburner.warehouseapi.cancelexportmaterial.md) | Cancel material export. | -| [discontinueProduct(divisionName, productName)](./bitburner.warehouseapi.discontinueproduct.md) | Discontinue a product. | -| [exportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./bitburner.warehouseapi.exportmaterial.md) | Set material export data. | -| [getMaterial(divisionName, city, materialName)](./bitburner.warehouseapi.getmaterial.md) | Get material data. | -| [getProduct(divisionName, cityName, productName)](./bitburner.warehouseapi.getproduct.md) | Get product data. | -| [getUpgradeWarehouseCost(divisionName, city, amt)](./bitburner.warehouseapi.getupgradewarehousecost.md) | Get the cost to upgrade a warehouse to the next level. | -| [getWarehouse(divisionName, city)](./bitburner.warehouseapi.getwarehouse.md) | Get warehouse data. | -| [hasWarehouse(divisionName, city)](./bitburner.warehouseapi.haswarehouse.md) | Check if you have a warehouse in city. | -| [limitMaterialProduction(divisionName, city, materialName, qty)](./bitburner.warehouseapi.limitmaterialproduction.md) | Limit material production. | -| [limitProductProduction(divisionName, city, productName, qty)](./bitburner.warehouseapi.limitproductproduction.md) | Limit product production. | -| [makeProduct(divisionName, city, productName, designInvest, marketingInvest)](./bitburner.warehouseapi.makeproduct.md) | Create a new product. | -| [purchaseWarehouse(divisionName, city)](./bitburner.warehouseapi.purchasewarehouse.md) | Purchase warehouse for a new city. | -| [sellMaterial(divisionName, city, materialName, amt, price)](./bitburner.warehouseapi.sellmaterial.md) | Set material sell data. | -| [sellProduct(divisionName, city, productName, amt, price, all)](./bitburner.warehouseapi.sellproduct.md) | Set product sell data. | -| [setMaterialMarketTA1(divisionName, city, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta1.md) | Set Market-TA1 for a material. | -| [setMaterialMarketTA2(divisionName, city, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta2.md) | Set Market-TA2 for a material. | -| [setProductMarketTA1(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta1.md) | Set Market-TA1 for a product. | -| [setProductMarketTA2(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta2.md) | Set Market-TA2 for a product. | -| [setSmartSupply(divisionName, city, enabled)](./bitburner.warehouseapi.setsmartsupply.md) | Set smart supply. | -| [setSmartSupplyOption(divisionName, city, materialName, option)](./bitburner.warehouseapi.setsmartsupplyoption.md) | Set whether smart supply uses leftovers before buying. | -| [upgradeWarehouse(divisionName, city, amt)](./bitburner.warehouseapi.upgradewarehouse.md) | Upgrade warehouse. | + + + + + + + + + + + + + + + + + + + + + + + + +
+ +Method + + + + +Description + + +
+ +[bulkPurchase(divisionName, city, materialName, amt)](./bitburner.warehouseapi.bulkpurchase.md) + + + + +Set material to bulk-buy. + + +
+ +[buyMaterial(divisionName, city, materialName, amt)](./bitburner.warehouseapi.buymaterial.md) + + + + +Set material buy data. + + +
+ +[cancelExportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName)](./bitburner.warehouseapi.cancelexportmaterial.md) + + + + +Cancel material export. + + +
+ +[discontinueProduct(divisionName, productName)](./bitburner.warehouseapi.discontinueproduct.md) + + + + +Discontinue a product. + + +
+ +[exportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./bitburner.warehouseapi.exportmaterial.md) + + + + +Set material export data. + + +
+ +[getMaterial(divisionName, city, materialName)](./bitburner.warehouseapi.getmaterial.md) + + + + +Get material data. + + +
+ +[getProduct(divisionName, cityName, productName)](./bitburner.warehouseapi.getproduct.md) + + + + +Get product data. + + +
+ +[getUpgradeWarehouseCost(divisionName, city, amt)](./bitburner.warehouseapi.getupgradewarehousecost.md) + + + + +Get the cost to upgrade a warehouse to the next level. + + +
+ +[getWarehouse(divisionName, city)](./bitburner.warehouseapi.getwarehouse.md) + + + + +Get warehouse data. + + +
+ +[hasWarehouse(divisionName, city)](./bitburner.warehouseapi.haswarehouse.md) + + + + +Check if you have a warehouse in city. + + +
+ +[limitMaterialProduction(divisionName, city, materialName, qty)](./bitburner.warehouseapi.limitmaterialproduction.md) + + + + +Limit material production. + + +
+ +[limitProductProduction(divisionName, city, productName, qty)](./bitburner.warehouseapi.limitproductproduction.md) + + + + +Limit product production. + + +
+ +[makeProduct(divisionName, city, productName, designInvest, marketingInvest)](./bitburner.warehouseapi.makeproduct.md) + + + + +Create a new product. + + +
+ +[purchaseWarehouse(divisionName, city)](./bitburner.warehouseapi.purchasewarehouse.md) + + + + +Purchase warehouse for a new city. + + +
+ +[sellMaterial(divisionName, city, materialName, amt, price)](./bitburner.warehouseapi.sellmaterial.md) + + + + +Set material sell data. + + +
+ +[sellProduct(divisionName, city, productName, amt, price, all)](./bitburner.warehouseapi.sellproduct.md) + + + + +Set product sell data. + + +
+ +[setMaterialMarketTA1(divisionName, city, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta1.md) + + + + +Set Market-TA1 for a material. + + +
+ +[setMaterialMarketTA2(divisionName, city, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta2.md) + + + + +Set Market-TA2 for a material. + + +
+ +[setProductMarketTA1(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta1.md) + + + + +Set Market-TA1 for a product. + + +
+ +[setProductMarketTA2(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta2.md) + + + + +Set Market-TA2 for a product. + + +
+ +[setSmartSupply(divisionName, city, enabled)](./bitburner.warehouseapi.setsmartsupply.md) + + + + +Set smart supply. + + +
+ +[setSmartSupplyOption(divisionName, city, materialName, option)](./bitburner.warehouseapi.setsmartsupplyoption.md) + + + + +Set whether smart supply uses leftovers before buying. + + +
+ +[upgradeWarehouse(divisionName, city, amt)](./bitburner.warehouseapi.upgradewarehouse.md) + + + + +Upgrade warehouse. + + +
diff --git a/markdown/bitburner.warehouseapi.purchasewarehouse.md b/markdown/bitburner.warehouseapi.purchasewarehouse.md index 57dbea450..8b6da8ae6 100644 --- a/markdown/bitburner.warehouseapi.purchasewarehouse.md +++ b/markdown/bitburner.warehouseapi.purchasewarehouse.md @@ -14,10 +14,55 @@ purchaseWarehouse(divisionName: string, city: CityName): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.sellmaterial.md b/markdown/bitburner.warehouseapi.sellmaterial.md index ea34a1640..4fb2a3b59 100644 --- a/markdown/bitburner.warehouseapi.sellmaterial.md +++ b/markdown/bitburner.warehouseapi.sellmaterial.md @@ -14,13 +14,103 @@ sellMaterial(divisionName: string, city: CityName, materialName: CorpMaterialNam ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| amt | string | Amount to sell, can be "MAX" | -| price | string | Price to sell, can be "MP" | + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
+ +amt + + + + +string + + + + +Amount to sell, can be "MAX" + + +
+ +price + + + + +string + + + + +Price to sell, can be "MP" + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.sellproduct.md b/markdown/bitburner.warehouseapi.sellproduct.md index 7c5cbccdd..90dde8a7d 100644 --- a/markdown/bitburner.warehouseapi.sellproduct.md +++ b/markdown/bitburner.warehouseapi.sellproduct.md @@ -21,14 +21,119 @@ sellProduct( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| productName | string | Name of the product | -| amt | string | Amount to sell, can be "MAX" | -| price | string | Price to sell, can be "MP" | -| all | boolean | Set sell amount and price in all cities | + + + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +productName + + + + +string + + + + +Name of the product + + +
+ +amt + + + + +string + + + + +Amount to sell, can be "MAX" + + +
+ +price + + + + +string + + + + +Price to sell, can be "MP" + + +
+ +all + + + + +boolean + + + + +Set sell amount and price in all cities + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.setmaterialmarketta1.md b/markdown/bitburner.warehouseapi.setmaterialmarketta1.md index 9c69f1db5..a48ac9d98 100644 --- a/markdown/bitburner.warehouseapi.setmaterialmarketta1.md +++ b/markdown/bitburner.warehouseapi.setmaterialmarketta1.md @@ -14,12 +14,87 @@ setMaterialMarketTA1(divisionName: string, city: CityName, materialName: CorpMat ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| on | boolean | Use true to enable, false otherwise. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
+ +on + + + + +boolean + + + + +Use true to enable, false otherwise. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.setmaterialmarketta2.md b/markdown/bitburner.warehouseapi.setmaterialmarketta2.md index 628fd39c0..c01c90256 100644 --- a/markdown/bitburner.warehouseapi.setmaterialmarketta2.md +++ b/markdown/bitburner.warehouseapi.setmaterialmarketta2.md @@ -14,12 +14,87 @@ setMaterialMarketTA2(divisionName: string, city: CityName, materialName: CorpMat ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| on | boolean | Use true to enable, false otherwise. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
+ +on + + + + +boolean + + + + +Use true to enable, false otherwise. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.setproductmarketta1.md b/markdown/bitburner.warehouseapi.setproductmarketta1.md index 5e986cc8a..c60385225 100644 --- a/markdown/bitburner.warehouseapi.setproductmarketta1.md +++ b/markdown/bitburner.warehouseapi.setproductmarketta1.md @@ -14,11 +14,71 @@ setProductMarketTA1(divisionName: string, productName: string, on: boolean): voi ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| productName | string | Name of the product | -| on | boolean | Use true to enable, false otherwise. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +productName + + + + +string + + + + +Name of the product + + +
+ +on + + + + +boolean + + + + +Use true to enable, false otherwise. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.setproductmarketta2.md b/markdown/bitburner.warehouseapi.setproductmarketta2.md index 6dc8982d7..a7658ce59 100644 --- a/markdown/bitburner.warehouseapi.setproductmarketta2.md +++ b/markdown/bitburner.warehouseapi.setproductmarketta2.md @@ -14,11 +14,71 @@ setProductMarketTA2(divisionName: string, productName: string, on: boolean): voi ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| productName | string | Name of the product | -| on | boolean | Use true to enable, false otherwise. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +productName + + + + +string + + + + +Name of the product + + +
+ +on + + + + +boolean + + + + +Use true to enable, false otherwise. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.setsmartsupply.md b/markdown/bitburner.warehouseapi.setsmartsupply.md index f6095221c..f463981c6 100644 --- a/markdown/bitburner.warehouseapi.setsmartsupply.md +++ b/markdown/bitburner.warehouseapi.setsmartsupply.md @@ -14,11 +14,71 @@ setSmartSupply(divisionName: string, city: CityName, enabled: boolean): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| enabled | boolean | Use true to enable, false otherwise. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +enabled + + + + +boolean + + + + +Use true to enable, false otherwise. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.setsmartsupplyoption.md b/markdown/bitburner.warehouseapi.setsmartsupplyoption.md index 5c0e61a1f..4e229a232 100644 --- a/markdown/bitburner.warehouseapi.setsmartsupplyoption.md +++ b/markdown/bitburner.warehouseapi.setsmartsupplyoption.md @@ -19,12 +19,87 @@ setSmartSupplyOption( ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | Name of the material | -| option | [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) | Smart supply option. Set "leftovers" to use leftovers, "imports" to use only imported materials, and "none" to not use stored materials. | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +materialName + + + + +[CorpMaterialName](./bitburner.corpmaterialname.md) + + + + +Name of the material + + +
+ +option + + + + +[CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) + + + + +Smart supply option. Set "leftovers" to use leftovers, "imports" to use only imported materials, and "none" to not use stored materials. + + +
**Returns:** diff --git a/markdown/bitburner.warehouseapi.upgradewarehouse.md b/markdown/bitburner.warehouseapi.upgradewarehouse.md index 0584dd22e..494087830 100644 --- a/markdown/bitburner.warehouseapi.upgradewarehouse.md +++ b/markdown/bitburner.warehouseapi.upgradewarehouse.md @@ -14,11 +14,71 @@ upgradeWarehouse(divisionName: string, city: CityName, amt?: number): void; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| divisionName | string | Name of the division | -| city | [CityName](./bitburner.cityname.md) | Name of the city | -| amt | number | _(Optional)_ Amount of upgrades. Defaults to 1. | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +divisionName + + + + +string + + + + +Name of the division + + +
+ +city + + + + +[CityName](./bitburner.cityname.md) + + + + +Name of the city + + +
+ +amt + + + + +number + + + + +_(Optional)_ Amount of upgrades. Defaults to 1. + + +
**Returns:** diff --git a/markdown/bitburner.workformulas.companygains.md b/markdown/bitburner.workformulas.companygains.md index 3dca1bd06..3a0836cbe 100644 --- a/markdown/bitburner.workformulas.companygains.md +++ b/markdown/bitburner.workformulas.companygains.md @@ -12,12 +12,79 @@ companyGains(person: Person, companyName: CompanyName, workType: JobName, favor: ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| person | [Person](./bitburner.person.md) | | -| companyName | [CompanyName](./bitburner.companyname.md) | | -| workType | [JobName](./bitburner.jobname.md) | | -| favor | number | | + + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +person + + + + +[Person](./bitburner.person.md) + + + + + +
+ +companyName + + + + +[CompanyName](./bitburner.companyname.md) + + + + + +
+ +workType + + + + +[JobName](./bitburner.jobname.md) + + + + + +
+ +favor + + + + +number + + + + + +
**Returns:** diff --git a/markdown/bitburner.workformulas.crimegains.md b/markdown/bitburner.workformulas.crimegains.md index 2d0e4ad62..2ec729714 100644 --- a/markdown/bitburner.workformulas.crimegains.md +++ b/markdown/bitburner.workformulas.crimegains.md @@ -12,10 +12,51 @@ crimeGains(person: Person, crimeType: CrimeType): WorkStats; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| person | [Person](./bitburner.person.md) | | -| crimeType | [CrimeType](./bitburner.crimetype.md) | | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +person + + + + +[Person](./bitburner.person.md) + + + + + +
+ +crimeType + + + + +[CrimeType](./bitburner.crimetype.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.workformulas.crimesuccesschance.md b/markdown/bitburner.workformulas.crimesuccesschance.md index f77f5d254..9716464db 100644 --- a/markdown/bitburner.workformulas.crimesuccesschance.md +++ b/markdown/bitburner.workformulas.crimesuccesschance.md @@ -12,10 +12,51 @@ crimeSuccessChance(person: Person, crimeType: CrimeType): number; ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| person | [Person](./bitburner.person.md) | | -| crimeType | [CrimeType](./bitburner.crimetype.md) | | + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +person + + + + +[Person](./bitburner.person.md) + + + + + +
+ +crimeType + + + + +[CrimeType](./bitburner.crimetype.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.workformulas.factiongains.md b/markdown/bitburner.workformulas.factiongains.md index 58d4eba11..1ff774080 100644 --- a/markdown/bitburner.workformulas.factiongains.md +++ b/markdown/bitburner.workformulas.factiongains.md @@ -12,11 +12,65 @@ factionGains(person: Person, workType: FactionWorkType, favor: number): WorkStat ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| person | [Person](./bitburner.person.md) | | -| workType | [FactionWorkType](./bitburner.factionworktype.md) | | -| favor | number | | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +person + + + + +[Person](./bitburner.person.md) + + + + + +
+ +workType + + + + +[FactionWorkType](./bitburner.factionworktype.md) + + + + + +
+ +favor + + + + +number + + + + + +
**Returns:** diff --git a/markdown/bitburner.workformulas.gymgains.md b/markdown/bitburner.workformulas.gymgains.md index 2b12dc033..e0240f3b0 100644 --- a/markdown/bitburner.workformulas.gymgains.md +++ b/markdown/bitburner.workformulas.gymgains.md @@ -12,11 +12,65 @@ gymGains(person: Person, gymType: GymType, locationName: LocationName): WorkStat ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| person | [Person](./bitburner.person.md) | | -| gymType | [GymType](./bitburner.gymtype.md) | | -| locationName | [LocationName](./bitburner.locationname.md) | | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +person + + + + +[Person](./bitburner.person.md) + + + + + +
+ +gymType + + + + +[GymType](./bitburner.gymtype.md) + + + + + +
+ +locationName + + + + +[LocationName](./bitburner.locationname.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.workformulas.md b/markdown/bitburner.workformulas.md index 9cc73a3aa..b31eddaf8 100644 --- a/markdown/bitburner.workformulas.md +++ b/markdown/bitburner.workformulas.md @@ -14,12 +14,70 @@ interface WorkFormulas ## Methods -| Method | Description | -| --- | --- | -| [companyGains(person, companyName, workType, favor)](./bitburner.workformulas.companygains.md) | | -| [crimeGains(person, crimeType)](./bitburner.workformulas.crimegains.md) | | -| [crimeSuccessChance(person, crimeType)](./bitburner.workformulas.crimesuccesschance.md) | | -| [factionGains(person, workType, favor)](./bitburner.workformulas.factiongains.md) | | -| [gymGains(person, gymType, locationName)](./bitburner.workformulas.gymgains.md) | | -| [universityGains(person, classType, locationName)](./bitburner.workformulas.universitygains.md) | | + + + + + + + +
+ +Method + + + + +Description + + +
+ +[companyGains(person, companyName, workType, favor)](./bitburner.workformulas.companygains.md) + + + + + +
+ +[crimeGains(person, crimeType)](./bitburner.workformulas.crimegains.md) + + + + + +
+ +[crimeSuccessChance(person, crimeType)](./bitburner.workformulas.crimesuccesschance.md) + + + + + +
+ +[factionGains(person, workType, favor)](./bitburner.workformulas.factiongains.md) + + + + + +
+ +[gymGains(person, gymType, locationName)](./bitburner.workformulas.gymgains.md) + + + + + +
+ +[universityGains(person, classType, locationName)](./bitburner.workformulas.universitygains.md) + + + + + +
diff --git a/markdown/bitburner.workformulas.universitygains.md b/markdown/bitburner.workformulas.universitygains.md index 650e9519a..31ca515c6 100644 --- a/markdown/bitburner.workformulas.universitygains.md +++ b/markdown/bitburner.workformulas.universitygains.md @@ -12,11 +12,65 @@ universityGains(person: Person, classType: UniversityClassType, locationName: Lo ## Parameters -| Parameter | Type | Description | -| --- | --- | --- | -| person | [Person](./bitburner.person.md) | | -| classType | [UniversityClassType](./bitburner.universityclasstype.md) | | -| locationName | [LocationName](./bitburner.locationname.md) | | + + + + +
+ +Parameter + + + + +Type + + + + +Description + + +
+ +person + + + + +[Person](./bitburner.person.md) + + + + + +
+ +classType + + + + +[UniversityClassType](./bitburner.universityclasstype.md) + + + + + +
+ +locationName + + + + +[LocationName](./bitburner.locationname.md) + + + + + +
**Returns:** diff --git a/markdown/bitburner.workstats.md b/markdown/bitburner.workstats.md index 1f8e7ac52..5dedea1e4 100644 --- a/markdown/bitburner.workstats.md +++ b/markdown/bitburner.workstats.md @@ -13,15 +13,179 @@ interface WorkStats ## Properties -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [agiExp](./bitburner.workstats.agiexp.md) | | number | | -| [chaExp](./bitburner.workstats.chaexp.md) | | number | | -| [defExp](./bitburner.workstats.defexp.md) | | number | | -| [dexExp](./bitburner.workstats.dexexp.md) | | number | | -| [hackExp](./bitburner.workstats.hackexp.md) | | number | | -| [intExp](./bitburner.workstats.intexp.md) | | number | | -| [money](./bitburner.workstats.money.md) | | number | | -| [reputation](./bitburner.workstats.reputation.md) | | number | | -| [strExp](./bitburner.workstats.strexp.md) | | number | | + + + + + + + + + + +
+ +Property + + + + +Modifiers + + + + +Type + + + + +Description + + +
+ +[agiExp](./bitburner.workstats.agiexp.md) + + + + + + + +number + + + + + +
+ +[chaExp](./bitburner.workstats.chaexp.md) + + + + + + + +number + + + + + +
+ +[defExp](./bitburner.workstats.defexp.md) + + + + + + + +number + + + + + +
+ +[dexExp](./bitburner.workstats.dexexp.md) + + + + + + + +number + + + + + +
+ +[hackExp](./bitburner.workstats.hackexp.md) + + + + + + + +number + + + + + +
+ +[intExp](./bitburner.workstats.intexp.md) + + + + + + + +number + + + + + +
+ +[money](./bitburner.workstats.money.md) + + + + + + + +number + + + + + +
+ +[reputation](./bitburner.workstats.reputation.md) + + + + + + + +number + + + + + +
+ +[strExp](./bitburner.workstats.strexp.md) + + + + + + + +number + + + + + +
diff --git a/markdown/index.md b/markdown/index.md index b6bea5e27..41709f91d 100644 --- a/markdown/index.md +++ b/markdown/index.md @@ -6,7 +6,25 @@ ## Packages -| Package | Description | -| --- | --- | -| [bitburner](./bitburner.md) | | + + +
+ +Package + + + + +Description + + +
+ +[bitburner](./bitburner.md) + + + + + +
diff --git a/package-lock.json b/package-lock.json index 391848611..0d00d2e3a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -55,8 +55,8 @@ "@babel/preset-react": "^7.27.1", "@babel/preset-typescript": "^7.27.1", "@electron/packager": "^18.4.4", - "@microsoft/api-documenter": "~7.23.38", - "@microsoft/api-extractor": "^7.52.8", + "@microsoft/api-documenter": "^7.26.34", + "@microsoft/api-extractor": "^7.52.13", "@pmmmwh/react-refresh-webpack-plugin": "^0.6.1", "@swc/core": "^1.12.14", "@types/babel__standalone": "^7.1.9", @@ -2360,44 +2360,6 @@ "semver": "bin/semver.js" } }, - "node_modules/@electron/packager/node_modules/fs-extra": { - "version": "11.3.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.1.tgz", - "integrity": "sha512-eXvGGwZ5CL17ZSwHWd3bbgk7UUpF6IFHtP57NYYakPvHOs8GDgDe5KJI36jIJzDkJ6eJjuzRA8eBQb6SkKue0g==", - "dev": true, - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" - }, - "engines": { - "node": ">=14.14" - } - }, - "node_modules/@electron/packager/node_modules/fs-extra/node_modules/jsonfile": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", - "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", - "dev": true, - "license": "MIT", - "dependencies": { - "universalify": "^2.0.0" - }, - "optionalDependencies": { - "graceful-fs": "^4.1.6" - } - }, - "node_modules/@electron/packager/node_modules/fs-extra/node_modules/universalify": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", - "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 10.0.0" - } - }, "node_modules/@electron/packager/node_modules/prettier": { "version": "3.6.2", "resolved": "https://registry.npmjs.org/prettier/-/prettier-3.6.2.tgz", @@ -2456,34 +2418,6 @@ "balanced-match": "^1.0.0" } }, - "node_modules/@electron/universal/node_modules/fs-extra": { - "version": "11.3.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.1.tgz", - "integrity": "sha512-eXvGGwZ5CL17ZSwHWd3bbgk7UUpF6IFHtP57NYYakPvHOs8GDgDe5KJI36jIJzDkJ6eJjuzRA8eBQb6SkKue0g==", - "dev": true, - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" - }, - "engines": { - "node": ">=14.14" - } - }, - "node_modules/@electron/universal/node_modules/jsonfile": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", - "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", - "dev": true, - "license": "MIT", - "dependencies": { - "universalify": "^2.0.0" - }, - "optionalDependencies": { - "graceful-fs": "^4.1.6" - } - }, "node_modules/@electron/universal/node_modules/minimatch": { "version": "9.0.5", "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-9.0.5.tgz", @@ -2500,16 +2434,6 @@ "url": "https://github.com/sponsors/isaacs" } }, - "node_modules/@electron/universal/node_modules/universalify": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", - "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 10.0.0" - } - }, "node_modules/@electron/windows-sign": { "version": "1.2.2", "resolved": "https://registry.npmjs.org/@electron/windows-sign/-/windows-sign-1.2.2.tgz", @@ -2530,44 +2454,6 @@ "node": ">=14.14" } }, - "node_modules/@electron/windows-sign/node_modules/fs-extra": { - "version": "11.3.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.1.tgz", - "integrity": "sha512-eXvGGwZ5CL17ZSwHWd3bbgk7UUpF6IFHtP57NYYakPvHOs8GDgDe5KJI36jIJzDkJ6eJjuzRA8eBQb6SkKue0g==", - "dev": true, - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" - }, - "engines": { - "node": ">=14.14" - } - }, - "node_modules/@electron/windows-sign/node_modules/jsonfile": { - "version": "6.2.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", - "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", - "dev": true, - "license": "MIT", - "dependencies": { - "universalify": "^2.0.0" - }, - "optionalDependencies": { - "graceful-fs": "^4.1.6" - } - }, - "node_modules/@electron/windows-sign/node_modules/universalify": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", - "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 10.0.0" - } - }, "node_modules/@emotion/babel-plugin": { "version": "11.11.0", "resolved": "https://registry.npmjs.org/@emotion/babel-plugin/-/babel-plugin-11.11.0.tgz", @@ -2906,6 +2792,29 @@ "integrity": "sha512-dvuCeX5fC9dXgJn9t+X5atfmgQAzUOWqS1254Gh0m6i8wKd10ebXkfNKiRK+1GWi/yTvvLDHpoxLr0xxxeslWw==", "dev": true }, + "node_modules/@isaacs/balanced-match": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/@isaacs/balanced-match/-/balanced-match-4.0.1.tgz", + "integrity": "sha512-yzMTt9lEb8Gv7zRioUilSglI0c0smZ9k5D65677DLWLtWJaXIS3CqcGyUFByYKlnUj6TkjLVs54fBl6+TiGQDQ==", + "dev": true, + "license": "MIT", + "engines": { + "node": "20 || >=22" + } + }, + "node_modules/@isaacs/brace-expansion": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/@isaacs/brace-expansion/-/brace-expansion-5.0.0.tgz", + "integrity": "sha512-ZT55BDLV0yv0RBm2czMiZ+SqCGO7AvmOM3G/w2xhVPH+te0aKgFjmBvGlL1dH+ql2tgGO3MVrbb3jCKyvpgnxA==", + "dev": true, + "license": "MIT", + "dependencies": { + "@isaacs/balanced-match": "^4.0.1" + }, + "engines": { + "node": "20 || >=22" + } + }, "node_modules/@istanbuljs/load-nyc-config": { "version": "1.1.0", "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.1.0.tgz", @@ -3637,16 +3546,17 @@ } }, "node_modules/@microsoft/api-documenter": { - "version": "7.23.38", - "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.23.38.tgz", - "integrity": "sha512-2uvz4456atUkm9BDfN4YnSsBtZtkvQUYos7/TSdADwlzDHNA+0KGuKS9+722O7zGvHZG5qHfoNi/mlQrxhi47w==", + "version": "7.26.34", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.26.34.tgz", + "integrity": "sha512-fpJbZnccXBKxXUc22hVdZA5tSPZCUg7zhKSkVDBXJknxrLpIthXl35Syg8+Uv3arIHsVkYYj4QvbMlRPwwAIuQ==", "dev": true, + "license": "MIT", "dependencies": { - "@microsoft/api-extractor-model": "7.28.13", - "@microsoft/tsdoc": "0.14.2", - "@rushstack/node-core-library": "4.0.2", - "@rushstack/terminal": "0.10.0", - "@rushstack/ts-command-line": "4.19.1", + "@microsoft/api-extractor-model": "7.30.7", + "@microsoft/tsdoc": "~0.15.1", + "@rushstack/node-core-library": "5.14.0", + "@rushstack/terminal": "0.16.0", + "@rushstack/ts-command-line": "5.0.3", "js-yaml": "~3.13.1", "resolve": "~1.22.1" }, @@ -3655,21 +3565,21 @@ } }, "node_modules/@microsoft/api-extractor": { - "version": "7.52.8", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.52.8.tgz", - "integrity": "sha512-cszYIcjiNscDoMB1CIKZ3My61+JOhpERGlGr54i6bocvGLrcL/wo9o+RNXMBrb7XgLtKaizZWUpqRduQuHQLdg==", + "version": "7.52.13", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.52.13.tgz", + "integrity": "sha512-K6/bBt8zZfn9yc06gNvA+/NlBGJC/iJlObpdufXHEJtqcD4Dln4ITCLZpwP3DNZ5NyBFeTkKdv596go3V72qlA==", "dev": true, "license": "MIT", "dependencies": { - "@microsoft/api-extractor-model": "7.30.6", + "@microsoft/api-extractor-model": "7.30.7", "@microsoft/tsdoc": "~0.15.1", "@microsoft/tsdoc-config": "~0.17.1", - "@rushstack/node-core-library": "5.13.1", + "@rushstack/node-core-library": "5.14.0", "@rushstack/rig-package": "0.5.3", - "@rushstack/terminal": "0.15.3", - "@rushstack/ts-command-line": "5.0.1", + "@rushstack/terminal": "0.16.0", + "@rushstack/ts-command-line": "5.0.3", "lodash": "~4.17.15", - "minimatch": "~3.0.3", + "minimatch": "10.0.3", "resolve": "~1.22.1", "semver": "~7.5.4", "source-map": "~0.6.1", @@ -3680,202 +3590,15 @@ } }, "node_modules/@microsoft/api-extractor-model": { - "version": "7.28.13", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.28.13.tgz", - "integrity": "sha512-39v/JyldX4MS9uzHcdfmjjfS6cYGAoXV+io8B5a338pkHiSt+gy2eXQ0Q7cGFJ7quSa1VqqlMdlPrB6sLR/cAw==", - "dev": true, - "dependencies": { - "@microsoft/tsdoc": "0.14.2", - "@microsoft/tsdoc-config": "~0.16.1", - "@rushstack/node-core-library": "4.0.2" - } - }, - "node_modules/@microsoft/api-extractor-model/node_modules/@microsoft/tsdoc-config": { - "version": "0.16.2", - "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz", - "integrity": "sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw==", - "dev": true, - "dependencies": { - "@microsoft/tsdoc": "0.14.2", - "ajv": "~6.12.6", - "jju": "~1.4.0", - "resolve": "~1.19.0" - } - }, - "node_modules/@microsoft/api-extractor-model/node_modules/ajv": { - "version": "6.12.6", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.12.6.tgz", - "integrity": "sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.1", - "fast-json-stable-stringify": "^2.0.0", - "json-schema-traverse": "^0.4.1", - "uri-js": "^4.2.2" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/@microsoft/api-extractor-model/node_modules/json-schema-traverse": { - "version": "0.4.1", - "resolved": "https://registry.npmjs.org/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz", - "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==", - "dev": true, - "license": "MIT" - }, - "node_modules/@microsoft/api-extractor-model/node_modules/resolve": { - "version": "1.19.0", - "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", - "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", - "dev": true, - "dependencies": { - "is-core-module": "^2.1.0", - "path-parse": "^1.0.6" - }, - "funding": { - "url": "https://github.com/sponsors/ljharb" - } - }, - "node_modules/@microsoft/api-extractor/node_modules/@microsoft/api-extractor-model": { - "version": "7.30.6", - "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.30.6.tgz", - "integrity": "sha512-znmFn69wf/AIrwHya3fxX6uB5etSIn6vg4Q4RB/tb5VDDs1rqREc+AvMC/p19MUN13CZ7+V/8pkYPTj7q8tftg==", + "version": "7.30.7", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.30.7.tgz", + "integrity": "sha512-TBbmSI2/BHpfR9YhQA7nH0nqVmGgJ0xH0Ex4D99/qBDAUpnhA2oikGmdXanbw9AWWY/ExBYIpkmY8dBHdla3YQ==", "dev": true, "license": "MIT", "dependencies": { "@microsoft/tsdoc": "~0.15.1", "@microsoft/tsdoc-config": "~0.17.1", - "@rushstack/node-core-library": "5.13.1" - } - }, - "node_modules/@microsoft/api-extractor/node_modules/@microsoft/tsdoc": { - "version": "0.15.1", - "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.15.1.tgz", - "integrity": "sha512-4aErSrCR/On/e5G2hDP0wjooqDdauzEbIq8hIkIe5pXV0rtWJZvdCEKL0ykZxex+IxIwBp0eGeV48hQN07dXtw==", - "dev": true, - "license": "MIT" - }, - "node_modules/@microsoft/api-extractor/node_modules/@rushstack/node-core-library": { - "version": "5.13.1", - "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-5.13.1.tgz", - "integrity": "sha512-5yXhzPFGEkVc9Fu92wsNJ9jlvdwz4RNb2bMso+/+TH0nMm1jDDDsOIf4l8GAkPxGuwPw5DH24RliWVfSPhlW/Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "ajv": "~8.13.0", - "ajv-draft-04": "~1.0.0", - "ajv-formats": "~3.0.1", - "fs-extra": "~11.3.0", - "import-lazy": "~4.0.0", - "jju": "~1.4.0", - "resolve": "~1.22.1", - "semver": "~7.5.4" - }, - "peerDependencies": { - "@types/node": "*" - }, - "peerDependenciesMeta": { - "@types/node": { - "optional": true - } - } - }, - "node_modules/@microsoft/api-extractor/node_modules/@rushstack/terminal": { - "version": "0.15.3", - "resolved": "https://registry.npmjs.org/@rushstack/terminal/-/terminal-0.15.3.tgz", - "integrity": "sha512-DGJ0B2Vm69468kZCJkPj3AH5nN+nR9SPmC0rFHtzsS4lBQ7/dgOwtwVxYP7W9JPDMuRBkJ4KHmWKr036eJsj9g==", - "dev": true, - "license": "MIT", - "dependencies": { - "@rushstack/node-core-library": "5.13.1", - "supports-color": "~8.1.1" - }, - "peerDependencies": { - "@types/node": "*" - }, - "peerDependenciesMeta": { - "@types/node": { - "optional": true - } - } - }, - "node_modules/@microsoft/api-extractor/node_modules/@rushstack/ts-command-line": { - "version": "5.0.1", - "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-5.0.1.tgz", - "integrity": "sha512-bsbUucn41UXrQK7wgM8CNM/jagBytEyJqXw/umtI8d68vFm1Jwxh1OtLrlW7uGZgjCWiiPH6ooUNa1aVsuVr3Q==", - "dev": true, - "license": "MIT", - "dependencies": { - "@rushstack/terminal": "0.15.3", - "@types/argparse": "1.0.38", - "argparse": "~1.0.9", - "string-argv": "~0.3.1" - } - }, - "node_modules/@microsoft/api-extractor/node_modules/ajv": { - "version": "8.13.0", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.13.0.tgz", - "integrity": "sha512-PRA911Blj99jR5RMeTunVbNXMF6Lp4vZXnk5GQjcnUWUTsrXtekg/pnmFFI2u/I36Y/2bITGS30GZCXei6uNkA==", - "dev": true, - "license": "MIT", - "dependencies": { - "fast-deep-equal": "^3.1.3", - "json-schema-traverse": "^1.0.0", - "require-from-string": "^2.0.2", - "uri-js": "^4.4.1" - }, - "funding": { - "type": "github", - "url": "https://github.com/sponsors/epoberezkin" - } - }, - "node_modules/@microsoft/api-extractor/node_modules/ajv-formats": { - "version": "3.0.1", - "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-3.0.1.tgz", - "integrity": "sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "ajv": "^8.0.0" - }, - "peerDependencies": { - "ajv": "^8.0.0" - }, - "peerDependenciesMeta": { - "ajv": { - "optional": true - } - } - }, - "node_modules/@microsoft/api-extractor/node_modules/fs-extra": { - "version": "11.3.0", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.0.tgz", - "integrity": "sha512-Z4XaCL6dUDHfP/jT25jJKMmtxvuwbkrD1vNSMFlo9lNLY2c5FHYSQgHPRZUjAB26TpDEoW9HCOgplrdbaPV/ew==", - "dev": true, - "license": "MIT", - "dependencies": { - "graceful-fs": "^4.2.0", - "jsonfile": "^6.0.1", - "universalify": "^2.0.0" - }, - "engines": { - "node": ">=14.14" - } - }, - "node_modules/@microsoft/api-extractor/node_modules/jsonfile": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.1.0.tgz", - "integrity": "sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==", - "dev": true, - "license": "MIT", - "dependencies": { - "universalify": "^2.0.0" - }, - "optionalDependencies": { - "graceful-fs": "^4.1.6" + "@rushstack/node-core-library": "5.14.0" } }, "node_modules/@microsoft/api-extractor/node_modules/lru-cache": { @@ -3892,15 +3615,19 @@ } }, "node_modules/@microsoft/api-extractor/node_modules/minimatch": { - "version": "3.0.8", - "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.8.tgz", - "integrity": "sha512-6FsRAQsxQ61mw+qP1ZzbL9Bc78x2p5OqNgNpnoAFLTrX8n5Kxph0CsnhmKKNXTWjXqU5L0pGPR7hYk+XWZr60Q==", + "version": "10.0.3", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-10.0.3.tgz", + "integrity": "sha512-IPZ167aShDZZUMdRk66cyQAW3qr0WzbHkPdMYa8bzZhlHhO3jALbKdxcaak7W9FfT2rZNpQuUu4Od7ILEpXSaw==", "dev": true, + "license": "ISC", "dependencies": { - "brace-expansion": "^1.1.7" + "@isaacs/brace-expansion": "^5.0.0" }, "engines": { - "node": "*" + "node": "20 || >=22" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" } }, "node_modules/@microsoft/api-extractor/node_modules/semver": { @@ -3942,16 +3669,6 @@ "node": ">=14.17" } }, - "node_modules/@microsoft/api-extractor/node_modules/universalify": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", - "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", - "dev": true, - "license": "MIT", - "engines": { - "node": ">= 10.0.0" - } - }, "node_modules/@microsoft/api-extractor/node_modules/yallist": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", @@ -3960,10 +3677,11 @@ "license": "ISC" }, "node_modules/@microsoft/tsdoc": { - "version": "0.14.2", - "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", - "integrity": "sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug==", - "dev": true + "version": "0.15.1", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.15.1.tgz", + "integrity": "sha512-4aErSrCR/On/e5G2hDP0wjooqDdauzEbIq8hIkIe5pXV0rtWJZvdCEKL0ykZxex+IxIwBp0eGeV48hQN07dXtw==", + "dev": true, + "license": "MIT" }, "node_modules/@microsoft/tsdoc-config": { "version": "0.17.1", @@ -3978,13 +3696,6 @@ "resolve": "~1.22.2" } }, - "node_modules/@microsoft/tsdoc-config/node_modules/@microsoft/tsdoc": { - "version": "0.15.1", - "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.15.1.tgz", - "integrity": "sha512-4aErSrCR/On/e5G2hDP0wjooqDdauzEbIq8hIkIe5pXV0rtWJZvdCEKL0ykZxex+IxIwBp0eGeV48hQN07dXtw==", - "dev": true, - "license": "MIT" - }, "node_modules/@microsoft/tsdoc-config/node_modules/ajv": { "version": "8.12.0", "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.12.0.tgz", @@ -4442,17 +4153,20 @@ } }, "node_modules/@rushstack/node-core-library": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-4.0.2.tgz", - "integrity": "sha512-hyES82QVpkfQMeBMteQUnrhASL/KHPhd7iJ8euduwNJG4mu2GSOKybf0rOEjOm1Wz7CwJEUm9y0yD7jg2C1bfg==", + "version": "5.14.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-5.14.0.tgz", + "integrity": "sha512-eRong84/rwQUlATGFW3TMTYVyqL1vfW9Lf10PH+mVGfIb9HzU3h5AASNIw+axnBLjnD0n3rT5uQBwu9fvzATrg==", "dev": true, + "license": "MIT", "dependencies": { - "fs-extra": "~7.0.1", + "ajv": "~8.13.0", + "ajv-draft-04": "~1.0.0", + "ajv-formats": "~3.0.1", + "fs-extra": "~11.3.0", "import-lazy": "~4.0.0", "jju": "~1.4.0", "resolve": "~1.22.1", - "semver": "~7.5.4", - "z-schema": "~5.0.2" + "semver": "~7.5.4" }, "peerDependencies": { "@types/node": "*" @@ -4463,11 +4177,47 @@ } } }, + "node_modules/@rushstack/node-core-library/node_modules/ajv": { + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-8.13.0.tgz", + "integrity": "sha512-PRA911Blj99jR5RMeTunVbNXMF6Lp4vZXnk5GQjcnUWUTsrXtekg/pnmFFI2u/I36Y/2bITGS30GZCXei6uNkA==", + "dev": true, + "license": "MIT", + "dependencies": { + "fast-deep-equal": "^3.1.3", + "json-schema-traverse": "^1.0.0", + "require-from-string": "^2.0.2", + "uri-js": "^4.4.1" + }, + "funding": { + "type": "github", + "url": "https://github.com/sponsors/epoberezkin" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/ajv-formats": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/ajv-formats/-/ajv-formats-3.0.1.tgz", + "integrity": "sha512-8iUql50EUR+uUcdRQ3HDqa6EVyo3docL8g5WJ3FNcWmu62IbkGUue/pEyLBW8VGKKucTPgqeks4fIU1DA4yowQ==", + "dev": true, + "license": "MIT", + "dependencies": { + "ajv": "^8.0.0" + }, + "peerDependencies": { + "ajv": "^8.0.0" + }, + "peerDependenciesMeta": { + "ajv": { + "optional": true + } + } + }, "node_modules/@rushstack/node-core-library/node_modules/lru-cache": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", "dev": true, + "license": "ISC", "dependencies": { "yallist": "^4.0.0" }, @@ -4480,6 +4230,7 @@ "resolved": "https://registry.npmjs.org/semver/-/semver-7.5.4.tgz", "integrity": "sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==", "dev": true, + "license": "ISC", "dependencies": { "lru-cache": "^6.0.0" }, @@ -4494,7 +4245,8 @@ "version": "4.0.0", "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true + "dev": true, + "license": "ISC" }, "node_modules/@rushstack/rig-package": { "version": "0.5.3", @@ -4507,12 +4259,13 @@ } }, "node_modules/@rushstack/terminal": { - "version": "0.10.0", - "resolved": "https://registry.npmjs.org/@rushstack/terminal/-/terminal-0.10.0.tgz", - "integrity": "sha512-UbELbXnUdc7EKwfH2sb8ChqNgapUOdqcCIdQP4NGxBpTZV2sQyeekuK3zmfQSa/MN+/7b4kBogl2wq0vpkpYGw==", + "version": "0.16.0", + "resolved": "https://registry.npmjs.org/@rushstack/terminal/-/terminal-0.16.0.tgz", + "integrity": "sha512-WEvNuKkoR1PXorr9SxO0dqFdSp1BA+xzDrIm/Bwlc5YHg2FFg6oS+uCTYjerOhFuqCW+A3vKBm6EmKWSHfgx/A==", "dev": true, + "license": "MIT", "dependencies": { - "@rushstack/node-core-library": "4.0.2", + "@rushstack/node-core-library": "5.14.0", "supports-color": "~8.1.1" }, "peerDependencies": { @@ -4525,12 +4278,13 @@ } }, "node_modules/@rushstack/ts-command-line": { - "version": "4.19.1", - "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.19.1.tgz", - "integrity": "sha512-J7H768dgcpG60d7skZ5uSSwyCZs/S2HrWP1Ds8d1qYAyaaeJmpmmLr9BVw97RjFzmQPOYnoXcKA4GkqDCkduQg==", + "version": "5.0.3", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-5.0.3.tgz", + "integrity": "sha512-bgPhQEqLVv/2hwKLYv/XvsTWNZ9B/+X1zJ7WgQE9rO5oiLzrOZvkIW4pk13yOQBhHyjcND5qMOa6p83t+Z66iQ==", "dev": true, + "license": "MIT", "dependencies": { - "@rushstack/terminal": "0.10.0", + "@rushstack/terminal": "0.16.0", "@types/argparse": "1.0.38", "argparse": "~1.0.9", "string-argv": "~0.3.1" @@ -4830,7 +4584,8 @@ "version": "1.0.38", "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/@types/babel__core": { "version": "7.20.5", @@ -9867,17 +9622,41 @@ } }, "node_modules/fs-extra": { - "version": "7.0.1", - "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", - "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "version": "11.3.2", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-11.3.2.tgz", + "integrity": "sha512-Xr9F6z6up6Ws+NjzMCZc6WXg2YFRlrLP9NQDO3VQrWrfiojdhS56TzueT88ze0uBdCTwEIhQ3ptnmKeWGFAe0A==", "dev": true, + "license": "MIT", "dependencies": { - "graceful-fs": "^4.1.2", - "jsonfile": "^4.0.0", - "universalify": "^0.1.0" + "graceful-fs": "^4.2.0", + "jsonfile": "^6.0.1", + "universalify": "^2.0.0" }, "engines": { - "node": ">=6 <7 || >=8" + "node": ">=14.14" + } + }, + "node_modules/fs-extra/node_modules/jsonfile": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-6.2.0.tgz", + "integrity": "sha512-FGuPw30AdOIUTRMC2OMRtQV+jkVj2cfPqSeWXv1NEAJ1qZ5zb1X6z1mFhbfOB/iy3ssJCD+3KuZ8r8C3uVFlAg==", + "dev": true, + "license": "MIT", + "dependencies": { + "universalify": "^2.0.0" + }, + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/fs-extra/node_modules/universalify": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-2.0.1.tgz", + "integrity": "sha512-gptHNQghINnc/vTGIk0SOFGFNXw7JVrlRUtConJRlvaw6DuX0wO5Jeko9sWrMBhh+PsYAZ7oXAiOnf/UKogyiw==", + "dev": true, + "license": "MIT", + "engines": { + "node": ">= 10.0.0" } }, "node_modules/fs-monkey": { @@ -11048,6 +10827,7 @@ "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", "dev": true, + "license": "MIT", "engines": { "node": ">=8" } @@ -12777,7 +12557,8 @@ "version": "1.4.0", "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", "integrity": "sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA==", - "dev": true + "dev": true, + "license": "MIT" }, "node_modules/js-tokens": { "version": "4.0.0", @@ -13213,12 +12994,6 @@ "integrity": "sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ==", "dev": true }, - "node_modules/lodash.isequal": { - "version": "4.5.0", - "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", - "integrity": "sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ==", - "dev": true - }, "node_modules/lodash.merge": { "version": "4.6.2", "resolved": "https://registry.npmjs.org/lodash.merge/-/lodash.merge-4.6.2.tgz", @@ -17428,6 +17203,7 @@ "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.2.tgz", "integrity": "sha512-aqD2Q0144Z+/RqG52NeHEkZauTAUWJO8c6yTftGJKO3Tja5tUgIfmIl6kExvhtxSDP7fXB6DvzkfMpCd/F3G+Q==", "dev": true, + "license": "MIT", "engines": { "node": ">=0.6.19" } @@ -18556,15 +18332,6 @@ "spdx-expression-parse": "^3.0.0" } }, - "node_modules/validator": { - "version": "13.12.0", - "resolved": "https://registry.npmjs.org/validator/-/validator-13.12.0.tgz", - "integrity": "sha512-c1Q0mCiPlgdTVVVIJIrBuxNicYE+t/7oKeI9MWLj3fh/uq2Pxh/3eeWbVZ4OcGW1TUf53At0njHw5SMdA3tmMg==", - "dev": true, - "engines": { - "node": ">= 0.10" - } - }, "node_modules/vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -19344,36 +19111,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/z-schema": { - "version": "5.0.5", - "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-5.0.5.tgz", - "integrity": "sha512-D7eujBWkLa3p2sIpJA0d1pr7es+a7m0vFAnZLlCEKq/Ij2k0MLi9Br2UPxoxdYystm5K1yeBGzub0FlYUEWj2Q==", - "dev": true, - "dependencies": { - "lodash.get": "^4.4.2", - "lodash.isequal": "^4.5.0", - "validator": "^13.7.0" - }, - "bin": { - "z-schema": "bin/z-schema" - }, - "engines": { - "node": ">=8.0.0" - }, - "optionalDependencies": { - "commander": "^9.4.1" - } - }, - "node_modules/z-schema/node_modules/commander": { - "version": "9.5.0", - "resolved": "https://registry.npmjs.org/commander/-/commander-9.5.0.tgz", - "integrity": "sha512-KRs7WVDKg86PWiuAqhDrAQnTXZKraVcCc6vFdL14qrZ/DcWwuRo7VoiYXalXO7S5GKpqYiVEwCbgFDfxNHKJBQ==", - "dev": true, - "optional": true, - "engines": { - "node": "^12.20.0 || >=14" - } - }, "node_modules/zwitch": { "version": "2.0.4", "resolved": "https://registry.npmjs.org/zwitch/-/zwitch-2.0.4.tgz", diff --git a/package.json b/package.json index 7e9dbe568..1f16173ea 100644 --- a/package.json +++ b/package.json @@ -56,8 +56,8 @@ "@babel/preset-react": "^7.27.1", "@babel/preset-typescript": "^7.27.1", "@electron/packager": "^18.4.4", - "@microsoft/api-documenter": "~7.23.38", - "@microsoft/api-extractor": "^7.52.8", + "@microsoft/api-documenter": "^7.26.34", + "@microsoft/api-extractor": "^7.52.13", "@pmmmwh/react-refresh-webpack-plugin": "^0.6.1", "@swc/core": "^1.12.14", "@types/babel__standalone": "^7.1.9", diff --git a/src/ui/MD/components.tsx b/src/ui/MD/components.tsx index 70108edff..c873b9183 100644 --- a/src/ui/MD/components.tsx +++ b/src/ui/MD/components.tsx @@ -114,7 +114,7 @@ export const Th = (props: React.PropsWithChildren): React. return ( - + {props.children}