diff --git a/.gitignore b/.gitignore index b13bae357..7ffbc4168 100644 --- a/.gitignore +++ b/.gitignore @@ -9,7 +9,6 @@ Netburner.txt /test/*.map /test/*.bundle.* /test/*.css -/markdown/ /input/bitburner.api.json .cypress diff --git a/markdown/bitburner.activefragment.highestcharge.md b/markdown/bitburner.activefragment.highestcharge.md new file mode 100644 index 000000000..d96c88926 --- /dev/null +++ b/markdown/bitburner.activefragment.highestcharge.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [highestCharge](./bitburner.activefragment.highestcharge.md) + +## ActiveFragment.highestCharge property + +Signature: + +```typescript +highestCharge: number; +``` diff --git a/markdown/bitburner.activefragment.id.md b/markdown/bitburner.activefragment.id.md new file mode 100644 index 000000000..8f5a71af1 --- /dev/null +++ b/markdown/bitburner.activefragment.id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [id](./bitburner.activefragment.id.md) + +## ActiveFragment.id property + +Signature: + +```typescript +id: number; +``` diff --git a/markdown/bitburner.activefragment.md b/markdown/bitburner.activefragment.md new file mode 100644 index 000000000..bce58a63e --- /dev/null +++ b/markdown/bitburner.activefragment.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) + +## ActiveFragment interface + + +Signature: + +```typescript +export interface ActiveFragment +``` + +## Properties + +| Property | 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.activefragment.numcharge.md b/markdown/bitburner.activefragment.numcharge.md new file mode 100644 index 000000000..a5bab3eb2 --- /dev/null +++ b/markdown/bitburner.activefragment.numcharge.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [numCharge](./bitburner.activefragment.numcharge.md) + +## ActiveFragment.numCharge property + +Signature: + +```typescript +numCharge: number; +``` diff --git a/markdown/bitburner.activefragment.rotation.md b/markdown/bitburner.activefragment.rotation.md new file mode 100644 index 000000000..6e0c81e88 --- /dev/null +++ b/markdown/bitburner.activefragment.rotation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [rotation](./bitburner.activefragment.rotation.md) + +## ActiveFragment.rotation property + +Signature: + +```typescript +rotation: number; +``` diff --git a/markdown/bitburner.activefragment.x.md b/markdown/bitburner.activefragment.x.md new file mode 100644 index 000000000..47a481c94 --- /dev/null +++ b/markdown/bitburner.activefragment.x.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [x](./bitburner.activefragment.x.md) + +## ActiveFragment.x property + +Signature: + +```typescript +x: number; +``` diff --git a/markdown/bitburner.activefragment.y.md b/markdown/bitburner.activefragment.y.md new file mode 100644 index 000000000..93582014f --- /dev/null +++ b/markdown/bitburner.activefragment.y.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ActiveFragment](./bitburner.activefragment.md) > [y](./bitburner.activefragment.y.md) + +## ActiveFragment.y property + +Signature: + +```typescript +y: number; +``` diff --git a/markdown/bitburner.augmentpair.cost.md b/markdown/bitburner.augmentpair.cost.md new file mode 100644 index 000000000..f165f095b --- /dev/null +++ b/markdown/bitburner.augmentpair.cost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentPair](./bitburner.augmentpair.md) > [cost](./bitburner.augmentpair.cost.md) + +## AugmentPair.cost property + +augmentation cost + +Signature: + +```typescript +cost: number; +``` diff --git a/markdown/bitburner.augmentpair.md b/markdown/bitburner.augmentpair.md new file mode 100644 index 000000000..473f5811b --- /dev/null +++ b/markdown/bitburner.augmentpair.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentPair](./bitburner.augmentpair.md) + +## AugmentPair interface + +Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) + +Signature: + +```typescript +export interface AugmentPair +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [cost](./bitburner.augmentpair.cost.md) | number | augmentation cost | +| [name](./bitburner.augmentpair.name.md) | string | augmentation name | + diff --git a/markdown/bitburner.augmentpair.name.md b/markdown/bitburner.augmentpair.name.md new file mode 100644 index 000000000..095ac60b7 --- /dev/null +++ b/markdown/bitburner.augmentpair.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentPair](./bitburner.augmentpair.md) > [name](./bitburner.augmentpair.name.md) + +## AugmentPair.name property + +augmentation name + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.autocompletedata.flags.md b/markdown/bitburner.autocompletedata.flags.md new file mode 100644 index 000000000..d0ecfc3f4 --- /dev/null +++ b/markdown/bitburner.autocompletedata.flags.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) > [flags](./bitburner.autocompletedata.flags.md) + +## AutocompleteData.flags() method + +Signature: + +```typescript +flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] }; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | | + +Returns: + +{ \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) \| string\[\] } + diff --git a/markdown/bitburner.autocompletedata.md b/markdown/bitburner.autocompletedata.md new file mode 100644 index 000000000..459b3c07a --- /dev/null +++ b/markdown/bitburner.autocompletedata.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) + +## AutocompleteData interface + +Used for autocompletion + +Signature: + +```typescript +interface AutocompleteData +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [scripts](./bitburner.autocompletedata.scripts.md) | string\[\] | | +| [servers](./bitburner.autocompletedata.servers.md) | string\[\] | | +| [txts](./bitburner.autocompletedata.txts.md) | string\[\] | | + +## Methods + +| Method | Description | +| --- | --- | +| [flags(schema)](./bitburner.autocompletedata.flags.md) | | + diff --git a/markdown/bitburner.autocompletedata.scripts.md b/markdown/bitburner.autocompletedata.scripts.md new file mode 100644 index 000000000..a61e16e63 --- /dev/null +++ b/markdown/bitburner.autocompletedata.scripts.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) > [scripts](./bitburner.autocompletedata.scripts.md) + +## AutocompleteData.scripts property + +Signature: + +```typescript +scripts: string[]; +``` diff --git a/markdown/bitburner.autocompletedata.servers.md b/markdown/bitburner.autocompletedata.servers.md new file mode 100644 index 000000000..c54df9876 --- /dev/null +++ b/markdown/bitburner.autocompletedata.servers.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) > [servers](./bitburner.autocompletedata.servers.md) + +## AutocompleteData.servers property + +Signature: + +```typescript +servers: string[]; +``` diff --git a/markdown/bitburner.autocompletedata.txts.md b/markdown/bitburner.autocompletedata.txts.md new file mode 100644 index 000000000..0b8d0776d --- /dev/null +++ b/markdown/bitburner.autocompletedata.txts.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) > [txts](./bitburner.autocompletedata.txts.md) + +## AutocompleteData.txts property + +Signature: + +```typescript +txts: string[]; +``` diff --git a/markdown/bitburner.basichgwoptions.md b/markdown/bitburner.basichgwoptions.md new file mode 100644 index 000000000..7b85718cc --- /dev/null +++ b/markdown/bitburner.basichgwoptions.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BasicHGWOptions](./bitburner.basichgwoptions.md) + +## BasicHGWOptions interface + +Options to affect the behavior of [hack](./bitburner.ns.hack.md), [grow](./bitburner.ns.grow.md), and [weaken](./bitburner.ns.weaken.md). + +Signature: + +```typescript +export interface BasicHGWOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [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. | + diff --git a/markdown/bitburner.basichgwoptions.stock.md b/markdown/bitburner.basichgwoptions.stock.md new file mode 100644 index 000000000..07641f528 --- /dev/null +++ b/markdown/bitburner.basichgwoptions.stock.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BasicHGWOptions](./bitburner.basichgwoptions.md) > [stock](./bitburner.basichgwoptions.stock.md) + +## BasicHGWOptions.stock property + +Set to true this action will affect the stock market. + +Signature: + +```typescript +stock?: boolean; +``` diff --git a/markdown/bitburner.basichgwoptions.threads.md b/markdown/bitburner.basichgwoptions.threads.md new file mode 100644 index 000000000..b13188693 --- /dev/null +++ b/markdown/bitburner.basichgwoptions.threads.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BasicHGWOptions](./bitburner.basichgwoptions.md) > [threads](./bitburner.basichgwoptions.threads.md) + +## BasicHGWOptions.threads property + +Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. + +Signature: + +```typescript +threads?: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md new file mode 100644 index 000000000..c142d8512 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [AgilityLevelMultiplier](./bitburner.bitnodemultipliers.agilitylevelmultiplier.md) + +## BitNodeMultipliers.AgilityLevelMultiplier property + +Influences how quickly the player's agility level (not exp) scales + +Signature: + +```typescript +AgilityLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md b/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md new file mode 100644 index 000000000..ef89b6397 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [AugmentationMoneyCost](./bitburner.bitnodemultipliers.augmentationmoneycost.md) + +## BitNodeMultipliers.AugmentationMoneyCost property + +Influences the base cost to purchase an augmentation. + +Signature: + +```typescript +AugmentationMoneyCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md b/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md new file mode 100644 index 000000000..4022dede5 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [AugmentationRepCost](./bitburner.bitnodemultipliers.augmentationrepcost.md) + +## BitNodeMultipliers.AugmentationRepCost property + +Influences the base rep the player must have with a faction to purchase an augmentation. + +Signature: + +```typescript +AugmentationRepCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md b/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md new file mode 100644 index 000000000..32493fb37 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [BladeburnerRank](./bitburner.bitnodemultipliers.bladeburnerrank.md) + +## BitNodeMultipliers.BladeburnerRank property + +Influences how quickly the player can gain rank within Bladeburner. + +Signature: + +```typescript +BladeburnerRank: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md b/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md new file mode 100644 index 000000000..cd881ac4b --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [BladeburnerSkillCost](./bitburner.bitnodemultipliers.bladeburnerskillcost.md) + +## BitNodeMultipliers.BladeburnerSkillCost property + +Influences the cost of skill levels from Bladeburner. + +Signature: + +```typescript +BladeburnerSkillCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md new file mode 100644 index 000000000..9b1baa72d --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CharismaLevelMultiplier](./bitburner.bitnodemultipliers.charismalevelmultiplier.md) + +## BitNodeMultipliers.CharismaLevelMultiplier property + +Influences how quickly the player's charisma level (not exp) scales + +Signature: + +```typescript +CharismaLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.classgymexpgain.md b/markdown/bitburner.bitnodemultipliers.classgymexpgain.md new file mode 100644 index 000000000..91cfa80cb --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.classgymexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ClassGymExpGain](./bitburner.bitnodemultipliers.classgymexpgain.md) + +## BitNodeMultipliers.ClassGymExpGain property + +Influences the experience gained for each ability when a player completes a class. + +Signature: + +```typescript +ClassGymExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md b/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md new file mode 100644 index 000000000..dab83a4f6 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) + +## BitNodeMultipliers.CodingContractMoney property + +Influences the amount of money gained from completing Coding Contracts + +Signature: + +```typescript +CodingContractMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md b/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md new file mode 100644 index 000000000..d24fed4b2 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CompanyWorkExpGain](./bitburner.bitnodemultipliers.companyworkexpgain.md) + +## BitNodeMultipliers.CompanyWorkExpGain property + +Influences the experience gained for each ability when the player completes working their job. + +Signature: + +```typescript +CompanyWorkExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.companyworkmoney.md b/markdown/bitburner.bitnodemultipliers.companyworkmoney.md new file mode 100644 index 000000000..be534d6c3 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.companyworkmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md) + +## BitNodeMultipliers.CompanyWorkMoney property + +Influences how much money the player earns when completing working their job. + +Signature: + +```typescript +CompanyWorkMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md b/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md new file mode 100644 index 000000000..603383abf --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) + +## BitNodeMultipliers.CorporationSoftcap property + +Influences the money gain from dividends of corporations created by the player. + +Signature: + +```typescript +CorporationSoftcap: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.corporationvaluation.md b/markdown/bitburner.bitnodemultipliers.corporationvaluation.md new file mode 100644 index 000000000..b9be862b8 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.corporationvaluation.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) + +## BitNodeMultipliers.CorporationValuation property + +Influences the valuation of corporations created by the player. + +Signature: + +```typescript +CorporationValuation: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.crimeexpgain.md b/markdown/bitburner.bitnodemultipliers.crimeexpgain.md new file mode 100644 index 000000000..472819f16 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.crimeexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md) + +## BitNodeMultipliers.CrimeExpGain property + +Influences the base experience gained for each ability when the player commits a crime. + +Signature: + +```typescript +CrimeExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.crimemoney.md b/markdown/bitburner.bitnodemultipliers.crimemoney.md new file mode 100644 index 000000000..c3fffbdac --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.crimemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) + +## BitNodeMultipliers.CrimeMoney property + +Influences the base money gained when the player commits a crime. + +Signature: + +```typescript +CrimeMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md b/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md new file mode 100644 index 000000000..b16ad9a81 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [DaedalusAugsRequirement](./bitburner.bitnodemultipliers.daedalusaugsrequirement.md) + +## BitNodeMultipliers.DaedalusAugsRequirement property + +Influences how many Augmentations you need in order to get invited to the Daedalus faction + +Signature: + +```typescript +DaedalusAugsRequirement: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md new file mode 100644 index 000000000..6ae574d3c --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [DefenseLevelMultiplier](./bitburner.bitnodemultipliers.defenselevelmultiplier.md) + +## BitNodeMultipliers.DefenseLevelMultiplier property + +Influences how quickly the player's defense level (not exp) scales + +Signature: + +```typescript +DefenseLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md new file mode 100644 index 000000000..2d1c6f2db --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [DexterityLevelMultiplier](./bitburner.bitnodemultipliers.dexteritylevelmultiplier.md) + +## BitNodeMultipliers.DexterityLevelMultiplier property + +Influences how quickly the player's dexterity level (not exp) scales + +Signature: + +```typescript +DexterityLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md b/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md new file mode 100644 index 000000000..0ae7112d6 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FactionPassiveRepGain](./bitburner.bitnodemultipliers.factionpassiverepgain.md) + +## BitNodeMultipliers.FactionPassiveRepGain property + +Influences how much rep the player gains in each faction simply by being a member. + +Signature: + +```typescript +FactionPassiveRepGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md b/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md new file mode 100644 index 000000000..0c248a1b9 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FactionWorkExpGain](./bitburner.bitnodemultipliers.factionworkexpgain.md) + +## BitNodeMultipliers.FactionWorkExpGain property + +Influences the experience gained for each ability when the player completes work for a Faction. + +Signature: + +```typescript +FactionWorkExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md b/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md new file mode 100644 index 000000000..7de8b0d31 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) + +## BitNodeMultipliers.FactionWorkRepGain property + +Influences how much rep the player gains when performing work for a faction. + +Signature: + +```typescript +FactionWorkRepGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md b/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md new file mode 100644 index 000000000..640bc066a --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md) + +## BitNodeMultipliers.FourSigmaMarketDataApiCost property + +Influences how much it costs to unlock the stock market's 4S Market Data API + +Signature: + +```typescript +FourSigmaMarketDataApiCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md b/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md new file mode 100644 index 000000000..781f09ad3 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md) + +## BitNodeMultipliers.FourSigmaMarketDataCost property + +Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) + +Signature: + +```typescript +FourSigmaMarketDataCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.gangsoftcap.md b/markdown/bitburner.bitnodemultipliers.gangsoftcap.md new file mode 100644 index 000000000..39e80cbcd --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.gangsoftcap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [GangSoftcap](./bitburner.bitnodemultipliers.gangsoftcap.md) + +## BitNodeMultipliers.GangSoftcap property + +Influences the respect gain and money gain of your gang. + +Signature: + +```typescript +GangSoftcap: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.hackexpgain.md b/markdown/bitburner.bitnodemultipliers.hackexpgain.md new file mode 100644 index 000000000..b31f69168 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.hackexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) + +## BitNodeMultipliers.HackExpGain property + +Influences the experienced gained when hacking a server. + +Signature: + +```typescript +HackExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md new file mode 100644 index 000000000..ae7779522 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) + +## BitNodeMultipliers.HackingLevelMultiplier property + +Influences how quickly the player's hacking level (not experience) scales + +Signature: + +```typescript +HackingLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md b/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md new file mode 100644 index 000000000..314143a8f --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) + +## BitNodeMultipliers.HacknetNodeMoney property + +Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) + +Signature: + +```typescript +HacknetNodeMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md b/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md new file mode 100644 index 000000000..b911069be --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HomeComputerRamCost](./bitburner.bitnodemultipliers.homecomputerramcost.md) + +## BitNodeMultipliers.HomeComputerRamCost property + +Influences how much money it costs to upgrade your home computer's RAM + +Signature: + +```typescript +HomeComputerRamCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md b/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md new file mode 100644 index 000000000..60a00b135 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [InfiltrationMoney](./bitburner.bitnodemultipliers.infiltrationmoney.md) + +## BitNodeMultipliers.InfiltrationMoney property + +Influences how much money is gained when the player infiltrates a company. + +Signature: + +```typescript +InfiltrationMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.infiltrationrep.md b/markdown/bitburner.bitnodemultipliers.infiltrationrep.md new file mode 100644 index 000000000..7c357559c --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.infiltrationrep.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [InfiltrationRep](./bitburner.bitnodemultipliers.infiltrationrep.md) + +## BitNodeMultipliers.InfiltrationRep property + +Influences how much rep the player can gain from factions when selling stolen documents and secrets + +Signature: + +```typescript +InfiltrationRep: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.manualhackmoney.md b/markdown/bitburner.bitnodemultipliers.manualhackmoney.md new file mode 100644 index 000000000..ed941abf9 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.manualhackmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md) + +## BitNodeMultipliers.ManualHackMoney property + +Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal. + +Signature: + +```typescript +ManualHackMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.md b/markdown/bitburner.bitnodemultipliers.md new file mode 100644 index 000000000..fe18b2f2f --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.md @@ -0,0 +1,65 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) + +## BitNodeMultipliers interface + +All multipliers affecting the difficulty of the current challenge. + +Signature: + +```typescript +export interface BitNodeMultipliers +``` + +## Properties + +| Property | 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. | +| [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | number | Influences the money gain from dividends of corporations created by the player. | +| [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. | +| [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. | +| [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. | +| [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) | number | Influences the experienced gained when hacking a server. | +| [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) | number | Influences how quickly the player's hacking level (not experience) scales | +| [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | number | Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) | +| [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 can be stolen from a server when the player performs a hack against it through the Terminal. | +| [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) | number | Influence how much it costs to purchase a server | +| [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) | number | Influences the maximum number of purchased servers you can have | +| [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) | number | Influences the maximum allowed RAM for a purchased server | +| [PurchasedServerSoftcap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) | number | Influences cost of any purchased server at or above 128GB | +| [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) | number | Influences the minimum favor the player must have with a faction before they can donate to gain rep. | +| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | number | Influences how much the money on a server can be reduced when a script performs a hack against it. | +| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | number | Influences how much of the money stolen by a scripted hack will be added to the player's money. | +| [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.bitnodemultipliers.purchasedservercost.md b/markdown/bitburner.bitnodemultipliers.purchasedservercost.md new file mode 100644 index 000000000..3881f4ba7 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.purchasedservercost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) + +## BitNodeMultipliers.PurchasedServerCost property + +Influence how much it costs to purchase a server + +Signature: + +```typescript +PurchasedServerCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md b/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md new file mode 100644 index 000000000..fdaf15067 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) + +## BitNodeMultipliers.PurchasedServerLimit property + +Influences the maximum number of purchased servers you can have + +Signature: + +```typescript +PurchasedServerLimit: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md b/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md new file mode 100644 index 000000000..91913734c --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) + +## BitNodeMultipliers.PurchasedServerMaxRam property + +Influences the maximum allowed RAM for a purchased server + +Signature: + +```typescript +PurchasedServerMaxRam: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md b/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md new file mode 100644 index 000000000..5f8e251e3 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.purchasedserversoftcap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerSoftcap](./bitburner.bitnodemultipliers.purchasedserversoftcap.md) + +## BitNodeMultipliers.PurchasedServerSoftcap property + +Influences cost of any purchased server at or above 128GB + +Signature: + +```typescript +PurchasedServerSoftcap: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md b/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md new file mode 100644 index 000000000..35f28e704 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) + +## BitNodeMultipliers.RepToDonateToFaction property + +Influences the minimum favor the player must have with a faction before they can donate to gain rep. + +Signature: + +```typescript +RepToDonateToFaction: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoney.md b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md new file mode 100644 index 000000000..c0fb0e02b --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) + +## BitNodeMultipliers.ScriptHackMoney property + +Influences how much the money on a server can be reduced when a script performs a hack against it. + +Signature: + +```typescript +ScriptHackMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md b/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md new file mode 100644 index 000000000..38b82f966 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.scripthackmoneygain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) + +## BitNodeMultipliers.ScriptHackMoneyGain property + +Influences how much of the money stolen by a scripted hack will be added to the player's money. + +Signature: + +```typescript +ScriptHackMoneyGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.servergrowthrate.md b/markdown/bitburner.bitnodemultipliers.servergrowthrate.md new file mode 100644 index 000000000..0f27490f1 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.servergrowthrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) + +## BitNodeMultipliers.ServerGrowthRate property + +Influences the growth percentage per cycle against a server. + +Signature: + +```typescript +ServerGrowthRate: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.servermaxmoney.md b/markdown/bitburner.bitnodemultipliers.servermaxmoney.md new file mode 100644 index 000000000..103d38bf7 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.servermaxmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) + +## BitNodeMultipliers.ServerMaxMoney property + +Influences the maximum money that a server can grow to. + +Signature: + +```typescript +ServerMaxMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md b/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md new file mode 100644 index 000000000..c7455592e --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) + +## BitNodeMultipliers.ServerStartingMoney property + +Influences the initial money that a server starts with. + +Signature: + +```typescript +ServerStartingMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md b/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md new file mode 100644 index 000000000..85eed7975 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) + +## BitNodeMultipliers.ServerStartingSecurity property + +Influences the initial security level (hackDifficulty) of a server. + +Signature: + +```typescript +ServerStartingSecurity: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.serverweakenrate.md b/markdown/bitburner.bitnodemultipliers.serverweakenrate.md new file mode 100644 index 000000000..152821446 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.serverweakenrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) + +## BitNodeMultipliers.ServerWeakenRate property + +Influences the weaken amount per invocation against a server. + +Signature: + +```typescript +ServerWeakenRate: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md b/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md new file mode 100644 index 000000000..8854881a4 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.staneksgiftextrasize.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [StaneksGiftExtraSize](./bitburner.bitnodemultipliers.staneksgiftextrasize.md) + +## BitNodeMultipliers.StaneksGiftExtraSize property + +Influences the size of the gift + +Signature: + +```typescript +StaneksGiftExtraSize: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md b/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md new file mode 100644 index 000000000..aba511247 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [StaneksGiftPowerMultiplier](./bitburner.bitnodemultipliers.staneksgiftpowermultiplier.md) + +## BitNodeMultipliers.StaneksGiftPowerMultiplier property + +Influences the power of the gift + +Signature: + +```typescript +StaneksGiftPowerMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md new file mode 100644 index 000000000..379d42239 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) + +## BitNodeMultipliers.StrengthLevelMultiplier property + +Influences how quickly the player's strength level (not exp) scales + +Signature: + +```typescript +StrengthLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md b/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md new file mode 100644 index 000000000..883a1a6c2 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.worlddaemondifficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [WorldDaemonDifficulty](./bitburner.bitnodemultipliers.worlddaemondifficulty.md) + +## BitNodeMultipliers.WorldDaemonDifficulty property + +Influences the hacking skill required to backdoor the world daemon. + +Signature: + +```typescript +WorldDaemonDifficulty: number; +``` diff --git a/markdown/bitburner.bladeburner.getactionautolevel.md b/markdown/bitburner.bladeburner.getactionautolevel.md new file mode 100644 index 000000000..c9e7175e0 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionautolevel.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionAutolevel](./bitburner.bladeburner.getactionautolevel.md) + +## Bladeburner.getActionAutolevel() method + +Get whether an action is set to autolevel. + +Signature: + +```typescript +getActionAutolevel(type: string, name: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | + +Returns: + +boolean + +True if the action is set to autolevel, and false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not this action is currently set to autolevel. + +Returns false if an invalid action is specified. + diff --git a/markdown/bitburner.bladeburner.getactioncountremaining.md b/markdown/bitburner.bladeburner.getactioncountremaining.md new file mode 100644 index 000000000..5ceebf6f8 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactioncountremaining.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionCountRemaining](./bitburner.bladeburner.getactioncountremaining.md) + +## Bladeburner.getActionCountRemaining() method + +Get action count remaining. + +Signature: + +```typescript +getActionCountRemaining(type: string, name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | + +Returns: + +number + +Remaining count of the specified action. + +## Remarks + +RAM cost: 4 GB + +Returns the remaining count of the specified action. + +Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of whether the player has the required rank to attempt the mission or not. + diff --git a/markdown/bitburner.bladeburner.getactioncurrentlevel.md b/markdown/bitburner.bladeburner.getactioncurrentlevel.md new file mode 100644 index 000000000..07b232f72 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactioncurrentlevel.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionCurrentLevel](./bitburner.bladeburner.getactioncurrentlevel.md) + +## Bladeburner.getActionCurrentLevel() method + +Get the current level of an action. + +Signature: + +```typescript +getActionCurrentLevel(type: string, name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | + +Returns: + +number + +Current level of the specified action. + +## Remarks + +RAM cost: 4 GB + +Returns the current level of this action. + +Returns -1 if an invalid action is specified. + diff --git a/markdown/bitburner.bladeburner.getactioncurrenttime.md b/markdown/bitburner.bladeburner.getactioncurrenttime.md new file mode 100644 index 000000000..8298d99a2 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactioncurrenttime.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionCurrentTime](./bitburner.bladeburner.getactioncurrenttime.md) + +## Bladeburner.getActionCurrentTime() method + +Get the time elapsed on current action. + +Signature: + +```typescript +getActionCurrentTime(): number; +``` +Returns: + +number + +Number of milliseconds already spent on the current action. + +## Remarks + +RAM cost: 4 GB + +Returns the number of milliseconds already spent on the current action. + diff --git a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md new file mode 100644 index 000000000..c6b480801 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionEstimatedSuccessChance](./bitburner.bladeburner.getactionestimatedsuccesschance.md) + +## Bladeburner.getActionEstimatedSuccessChance() method + +Get estimate success chance of an action. + +Signature: + +```typescript +getActionEstimatedSuccessChance(type: string, name: string): [number, number]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | + +Returns: + +\[number, number\] + +Estimated success chance for the specified action. + +## Remarks + +RAM cost: 4 GB + +Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). + diff --git a/markdown/bitburner.bladeburner.getactionmaxlevel.md b/markdown/bitburner.bladeburner.getactionmaxlevel.md new file mode 100644 index 000000000..5b4629ea5 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionmaxlevel.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionMaxLevel](./bitburner.bladeburner.getactionmaxlevel.md) + +## Bladeburner.getActionMaxLevel() method + +Get the maximum level of an action. + +Signature: + +```typescript +getActionMaxLevel(type: string, name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | + +Returns: + +number + +Maximum level of the specified action. + +## Remarks + +RAM cost: 4 GB + +Returns the maximum level for this action. + +Returns -1 if an invalid action is specified. + diff --git a/markdown/bitburner.bladeburner.getactionrepgain.md b/markdown/bitburner.bladeburner.getactionrepgain.md new file mode 100644 index 000000000..96bcc0f11 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionrepgain.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionRepGain](./bitburner.bladeburner.getactionrepgain.md) + +## Bladeburner.getActionRepGain() method + +Get the reputation gain of an action. + +Signature: + +```typescript +getActionRepGain(type: string, name: string, level: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | +| level | number | Optional action level at which to calculate the gain | + +Returns: + +number + +Average Bladeburner reputation gain for successfully completing the specified action. + +## Remarks + +RAM cost: 4 GB + +Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value. + diff --git a/markdown/bitburner.bladeburner.getactiontime.md b/markdown/bitburner.bladeburner.getactiontime.md new file mode 100644 index 000000000..ef920eec4 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactiontime.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionTime](./bitburner.bladeburner.getactiontime.md) + +## Bladeburner.getActionTime() method + +Get the time to complete an action. + +Signature: + +```typescript +getActionTime(type: string, name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | + +Returns: + +number + +Number of milliseconds it takes to complete the specified action. + +## Remarks + +RAM cost: 4 GB + +Returns the number of milliseconds it takes to complete the specified action + diff --git a/markdown/bitburner.bladeburner.getblackopnames.md b/markdown/bitburner.bladeburner.getblackopnames.md new file mode 100644 index 000000000..abd073e1a --- /dev/null +++ b/markdown/bitburner.bladeburner.getblackopnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getBlackOpNames](./bitburner.bladeburner.getblackopnames.md) + +## Bladeburner.getBlackOpNames() method + +List all black ops. + +Signature: + +```typescript +getBlackOpNames(): string[]; +``` +Returns: + +string\[\] + +Array of strings containing the names of all Bladeburner Black Ops. + +## Remarks + +RAM cost: 0.4 GB + +Returns an array of strings containing the names of all Bladeburner Black Ops. + diff --git a/markdown/bitburner.bladeburner.getblackoprank.md b/markdown/bitburner.bladeburner.getblackoprank.md new file mode 100644 index 000000000..cd05f50db --- /dev/null +++ b/markdown/bitburner.bladeburner.getblackoprank.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getBlackOpRank](./bitburner.bladeburner.getblackoprank.md) + +## Bladeburner.getBlackOpRank() method + +Get black op required rank. + +Signature: + +```typescript +getBlackOpRank(name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Name of BlackOp. Must be an exact match. | + +Returns: + +number + +Rank required to complete this BlackOp. + +## Remarks + +RAM cost: 2 GB + +Returns the rank required to complete this BlackOp. + +Returns -1 if an invalid action is specified. + diff --git a/markdown/bitburner.bladeburner.getbonustime.md b/markdown/bitburner.bladeburner.getbonustime.md new file mode 100644 index 000000000..1135fdf83 --- /dev/null +++ b/markdown/bitburner.bladeburner.getbonustime.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getBonusTime](./bitburner.bladeburner.getbonustime.md) + +## Bladeburner.getBonusTime() method + +Get bladeburner bonus time. + +Signature: + +```typescript +getBonusTime(): number; +``` +Returns: + +number + +Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic. + +## Remarks + +RAM cost: 0 GB + +Returns the amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic. + +“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. + +“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. + diff --git a/markdown/bitburner.bladeburner.getcity.md b/markdown/bitburner.bladeburner.getcity.md new file mode 100644 index 000000000..a97627638 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcity.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCity](./bitburner.bladeburner.getcity.md) + +## Bladeburner.getCity() method + +Get current city. + +Signature: + +```typescript +getCity(): string; +``` +Returns: + +string + +City that the player is currently in (for Bladeburner). + +## Remarks + +RAM cost: 4 GB + +Returns the city that the player is currently in (for Bladeburner). + diff --git a/markdown/bitburner.bladeburner.getcitychaos.md b/markdown/bitburner.bladeburner.getcitychaos.md new file mode 100644 index 000000000..20b997e38 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcitychaos.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCityChaos](./bitburner.bladeburner.getcitychaos.md) + +## Bladeburner.getCityChaos() method + +Get chaos of a city. + +Signature: + +```typescript +getCityChaos(name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +number + +Chaos in the specified city. + +## Remarks + +RAM cost: 4 GB + +Returns the chaos in the specified city, or -1 if an invalid city was specified. + diff --git a/markdown/bitburner.bladeburner.getcitycommunities.md b/markdown/bitburner.bladeburner.getcitycommunities.md new file mode 100644 index 000000000..3d9057fb2 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcitycommunities.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCityCommunities](./bitburner.bladeburner.getcitycommunities.md) + +## Bladeburner.getCityCommunities() method + +Get number of communities in a city. + +Signature: + +```typescript +getCityCommunities(name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +number + +Number of Synthoids communities in the specified city. + +## Remarks + +RAM cost: 4 GB + +Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified. + diff --git a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md new file mode 100644 index 000000000..7e9c07e68 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCityEstimatedPopulation](./bitburner.bladeburner.getcityestimatedpopulation.md) + +## Bladeburner.getCityEstimatedPopulation() method + +Get estimated population in city. + +Signature: + +```typescript +getCityEstimatedPopulation(name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +number + +Estimated number of Synthoids in the specified city. + +## Remarks + +RAM cost: 4 GB + +Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified. + diff --git a/markdown/bitburner.bladeburner.getcontractnames.md b/markdown/bitburner.bladeburner.getcontractnames.md new file mode 100644 index 000000000..9ea54b621 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcontractnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getContractNames](./bitburner.bladeburner.getcontractnames.md) + +## Bladeburner.getContractNames() method + +List all contracts. + +Signature: + +```typescript +getContractNames(): string[]; +``` +Returns: + +string\[\] + +Array of strings containing the names of all Bladeburner contracts. + +## Remarks + +RAM cost: 0.4 GB + +Returns an array of strings containing the names of all Bladeburner contracts. + diff --git a/markdown/bitburner.bladeburner.getcurrentaction.md b/markdown/bitburner.bladeburner.getcurrentaction.md new file mode 100644 index 000000000..a2a1b87d0 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcurrentaction.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCurrentAction](./bitburner.bladeburner.getcurrentaction.md) + +## Bladeburner.getCurrentAction() method + +Get current action. + +Signature: + +```typescript +getCurrentAction(): BladeburnerCurAction; +``` +Returns: + +[BladeburnerCurAction](./bitburner.bladeburnercuraction.md) + +Object that represents the player’s current Bladeburner action. + +## Remarks + +RAM cost: 1 GB + +Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”. + diff --git a/markdown/bitburner.bladeburner.getgeneralactionnames.md b/markdown/bitburner.bladeburner.getgeneralactionnames.md new file mode 100644 index 000000000..2786ddcc4 --- /dev/null +++ b/markdown/bitburner.bladeburner.getgeneralactionnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getGeneralActionNames](./bitburner.bladeburner.getgeneralactionnames.md) + +## Bladeburner.getGeneralActionNames() method + +List all general actions. + +Signature: + +```typescript +getGeneralActionNames(): string[]; +``` +Returns: + +string\[\] + +Array of strings containing the names of all general Bladeburner actions. + +## Remarks + +RAM cost: 0.4 GB + +Returns an array of strings containing the names of all general Bladeburner actions. + diff --git a/markdown/bitburner.bladeburner.getoperationnames.md b/markdown/bitburner.bladeburner.getoperationnames.md new file mode 100644 index 000000000..659f4718e --- /dev/null +++ b/markdown/bitburner.bladeburner.getoperationnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getOperationNames](./bitburner.bladeburner.getoperationnames.md) + +## Bladeburner.getOperationNames() method + +List all operations. + +Signature: + +```typescript +getOperationNames(): string[]; +``` +Returns: + +string\[\] + +Array of strings containing the names of all Bladeburner operations. + +## Remarks + +RAM cost: 0.4 GB + +Returns an array of strings containing the names of all Bladeburner operations. + diff --git a/markdown/bitburner.bladeburner.getrank.md b/markdown/bitburner.bladeburner.getrank.md new file mode 100644 index 000000000..a3160bdb4 --- /dev/null +++ b/markdown/bitburner.bladeburner.getrank.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getRank](./bitburner.bladeburner.getrank.md) + +## Bladeburner.getRank() method + +Get player bladeburner rank. + +Signature: + +```typescript +getRank(): number; +``` +Returns: + +number + +Player’s Bladeburner Rank. + +## Remarks + +RAM cost: 4 GB + +Returns the player’s Bladeburner Rank. + diff --git a/markdown/bitburner.bladeburner.getskilllevel.md b/markdown/bitburner.bladeburner.getskilllevel.md new file mode 100644 index 000000000..2c797f083 --- /dev/null +++ b/markdown/bitburner.bladeburner.getskilllevel.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getSkillLevel](./bitburner.bladeburner.getskilllevel.md) + +## Bladeburner.getSkillLevel() method + +Get skill level. + +Signature: + +```typescript +getSkillLevel(name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +number + +Level in the specified skill. + +## Remarks + +RAM cost: 4 GB + +This function returns your level in the specified skill. + +The function returns -1 if an invalid skill name is passed in. + diff --git a/markdown/bitburner.bladeburner.getskillnames.md b/markdown/bitburner.bladeburner.getskillnames.md new file mode 100644 index 000000000..14df6f225 --- /dev/null +++ b/markdown/bitburner.bladeburner.getskillnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getSkillNames](./bitburner.bladeburner.getskillnames.md) + +## Bladeburner.getSkillNames() method + +List all skills. + +Signature: + +```typescript +getSkillNames(): string[]; +``` +Returns: + +string\[\] + +Array of strings containing the names of all general Bladeburner skills. + +## Remarks + +RAM cost: 0.4 GB + +Returns an array of strings containing the names of all general Bladeburner skills. + diff --git a/markdown/bitburner.bladeburner.getskillpoints.md b/markdown/bitburner.bladeburner.getskillpoints.md new file mode 100644 index 000000000..466f82b6c --- /dev/null +++ b/markdown/bitburner.bladeburner.getskillpoints.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getSkillPoints](./bitburner.bladeburner.getskillpoints.md) + +## Bladeburner.getSkillPoints() method + +Get bladeburner skill points. + +Signature: + +```typescript +getSkillPoints(): number; +``` +Returns: + +number + +Number of Bladeburner skill points you have. + +## Remarks + +RAM cost: 4 GB + +Returns the number of Bladeburner skill points you have. + diff --git a/markdown/bitburner.bladeburner.getskillupgradecost.md b/markdown/bitburner.bladeburner.getskillupgradecost.md new file mode 100644 index 000000000..23986d91c --- /dev/null +++ b/markdown/bitburner.bladeburner.getskillupgradecost.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getSkillUpgradeCost](./bitburner.bladeburner.getskillupgradecost.md) + +## Bladeburner.getSkillUpgradeCost() method + +Get cost to upgrade skill. + +Signature: + +```typescript +getSkillUpgradeCost(name: string, count?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| count | number | Number of times to upgrade the skill. Defaults to 1 if not specified. | + +Returns: + +number + +Number of skill points needed to upgrade the specified skill. + +## Remarks + +RAM cost: 4 GB + +This function returns the number of skill points needed to upgrade the specified skill the specified number of times. + +The function returns -1 if an invalid skill name is passed in. + diff --git a/markdown/bitburner.bladeburner.getstamina.md b/markdown/bitburner.bladeburner.getstamina.md new file mode 100644 index 000000000..eec7b7c4a --- /dev/null +++ b/markdown/bitburner.bladeburner.getstamina.md @@ -0,0 +1,45 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getStamina](./bitburner.bladeburner.getstamina.md) + +## Bladeburner.getStamina() method + +Get bladeburner stamina. + +Signature: + +```typescript +getStamina(): [number, number]; +``` +Returns: + +\[number, number\] + +Array containing current stamina and max stamina. + +## Remarks + +RAM cost: 4 GB Returns an array with two elements: \* \[Current stamina, Max stamina\] + +## Example 1 + + +```ts +// NS1: +function getStaminaPercentage() { + var res = bladeburner.getStamina(); + return res[0] / res[1]; +} +``` + +## Example 2 + + +```ts +// NS2: +function getStaminaPercentage() { + const [current, max] = ns.bladeburner.getStamina(); + return current / max; +} +``` + diff --git a/markdown/bitburner.bladeburner.getteamsize.md b/markdown/bitburner.bladeburner.getteamsize.md new file mode 100644 index 000000000..aa3d2da47 --- /dev/null +++ b/markdown/bitburner.bladeburner.getteamsize.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getTeamSize](./bitburner.bladeburner.getteamsize.md) + +## Bladeburner.getTeamSize() method + +Get team size. + +Signature: + +```typescript +getTeamSize(type: string, name: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | + +Returns: + +number + +Number of Bladeburner team members that were assigned to the specified action. + +## Remarks + +RAM cost: 4 GB + +Returns the number of Bladeburner team members you have assigned to the specified action. + +Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types. + diff --git a/markdown/bitburner.bladeburner.joinbladeburnerdivision.md b/markdown/bitburner.bladeburner.joinbladeburnerdivision.md new file mode 100644 index 000000000..649f72e32 --- /dev/null +++ b/markdown/bitburner.bladeburner.joinbladeburnerdivision.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [joinBladeburnerDivision](./bitburner.bladeburner.joinbladeburnerdivision.md) + +## Bladeburner.joinBladeburnerDivision() method + +Join the bladeburner division. + +Signature: + +```typescript +joinBladeburnerDivision(): boolean; +``` +Returns: + +boolean + +True if you successfully join the Bladeburner division, or if you are already a member, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Attempts to join the Bladeburner division. + +Returns true if you successfully join the Bladeburner division, or if you are already a member. + +Returns false otherwise. + diff --git a/markdown/bitburner.bladeburner.joinbladeburnerfaction.md b/markdown/bitburner.bladeburner.joinbladeburnerfaction.md new file mode 100644 index 000000000..d2db36826 --- /dev/null +++ b/markdown/bitburner.bladeburner.joinbladeburnerfaction.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [joinBladeburnerFaction](./bitburner.bladeburner.joinbladeburnerfaction.md) + +## Bladeburner.joinBladeburnerFaction() method + +Join the bladeburner faction. + +Signature: + +```typescript +joinBladeburnerFaction(): boolean; +``` +Returns: + +boolean + +True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise. + +## Remarks + +RAM cost: 4 GB Attempts to join the Bladeburner faction. + +Returns true if you successfully join the Bladeburner faction, or if you are already a member. + +Returns false otherwise. + diff --git a/markdown/bitburner.bladeburner.md b/markdown/bitburner.bladeburner.md new file mode 100644 index 000000000..987465c7f --- /dev/null +++ b/markdown/bitburner.bladeburner.md @@ -0,0 +1,58 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) + +## Bladeburner interface + +Bladeburner API + +Signature: + +```typescript +export interface Bladeburner +``` + +## Remarks + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this API. + +## 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)](./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. | +| [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(name)](./bitburner.bladeburner.getcitychaos.md) | Get chaos of a city. | +| [getCityCommunities(name)](./bitburner.bladeburner.getcitycommunities.md) | Get number of communities in a city. | +| [getCityEstimatedPopulation(name)](./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. | +| [getOperationNames()](./bitburner.bladeburner.getoperationnames.md) | List all operations. | +| [getRank()](./bitburner.bladeburner.getrank.md) | Get player bladeburner rank. | +| [getSkillLevel(name)](./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(name, 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. | +| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the bladeburner division. | +| [joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) | Join the bladeburner faction. | +| [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(name)](./bitburner.bladeburner.switchcity.md) | Travel to another city in bladeburner. | +| [upgradeSkill(name, count)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. | + diff --git a/markdown/bitburner.bladeburner.setactionautolevel.md b/markdown/bitburner.bladeburner.setactionautolevel.md new file mode 100644 index 000000000..73f708f0d --- /dev/null +++ b/markdown/bitburner.bladeburner.setactionautolevel.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [setActionAutolevel](./bitburner.bladeburner.setactionautolevel.md) + +## Bladeburner.setActionAutolevel() method + +Set an action autolevel. + +Signature: + +```typescript +setActionAutolevel(type: string, name: string, autoLevel: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | +| autoLevel | boolean | Whether or not to autolevel this action | + +Returns: + +void + +## Remarks + +RAM cost: 4 GB + +Enable/disable autoleveling for the specified action. + diff --git a/markdown/bitburner.bladeburner.setactionlevel.md b/markdown/bitburner.bladeburner.setactionlevel.md new file mode 100644 index 000000000..398bde4dd --- /dev/null +++ b/markdown/bitburner.bladeburner.setactionlevel.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [setActionLevel](./bitburner.bladeburner.setactionlevel.md) + +## Bladeburner.setActionLevel() method + +Set the level of an action. + +Signature: + +```typescript +setActionLevel(type: string, name: string, level: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | +| level | number | Level to set this action to. | + +Returns: + +void + +## Remarks + +RAM cost: 4 GB + +Set the level for the specified action. + diff --git a/markdown/bitburner.bladeburner.setteamsize.md b/markdown/bitburner.bladeburner.setteamsize.md new file mode 100644 index 000000000..13a848cbe --- /dev/null +++ b/markdown/bitburner.bladeburner.setteamsize.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [setTeamSize](./bitburner.bladeburner.setteamsize.md) + +## Bladeburner.setTeamSize() method + +Set team size. + +Signature: + +```typescript +setTeamSize(type: string, name: string, size: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match. | +| size | number | Number of team members to set. Will be converted using Math.round(). | + +Returns: + +number + +Number of Bladeburner team members you assigned to the specified action. + +## Remarks + +RAM cost: 4 GB + +Set the team size for the specified Bladeburner action. + +Returns the team size that was set, or -1 if the function failed. + diff --git a/markdown/bitburner.bladeburner.startaction.md b/markdown/bitburner.bladeburner.startaction.md new file mode 100644 index 000000000..4d3af78db --- /dev/null +++ b/markdown/bitburner.bladeburner.startaction.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [startAction](./bitburner.bladeburner.startaction.md) + +## Bladeburner.startAction() method + +Start an action. + +Signature: + +```typescript +startAction(type: string, name: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of action. | +| name | string | Name of action. Must be an exact match | + +Returns: + +boolean + +True if the action was started successfully, and false otherwise. + +## Remarks + +RAM cost: 4 GB + +Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise. + diff --git a/markdown/bitburner.bladeburner.stopbladeburneraction.md b/markdown/bitburner.bladeburner.stopbladeburneraction.md new file mode 100644 index 000000000..2542767e6 --- /dev/null +++ b/markdown/bitburner.bladeburner.stopbladeburneraction.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [stopBladeburnerAction](./bitburner.bladeburner.stopbladeburneraction.md) + +## Bladeburner.stopBladeburnerAction() method + +Stop current action. + +Signature: + +```typescript +stopBladeburnerAction(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 2 GB + +Stops the current Bladeburner action. + diff --git a/markdown/bitburner.bladeburner.switchcity.md b/markdown/bitburner.bladeburner.switchcity.md new file mode 100644 index 000000000..77e414a9a --- /dev/null +++ b/markdown/bitburner.bladeburner.switchcity.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [switchCity](./bitburner.bladeburner.switchcity.md) + +## Bladeburner.switchCity() method + +Travel to another city in bladeburner. + +Signature: + +```typescript +switchCity(name: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | + +Returns: + +boolean + +true if successful, and false otherwise + +## Remarks + +RAM cost: 4 GB Attempts to switch to the specified city (for Bladeburner only). + +Returns true if successful, and false otherwise + diff --git a/markdown/bitburner.bladeburner.upgradeskill.md b/markdown/bitburner.bladeburner.upgradeskill.md new file mode 100644 index 000000000..f404b8f64 --- /dev/null +++ b/markdown/bitburner.bladeburner.upgradeskill.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [upgradeSkill](./bitburner.bladeburner.upgradeskill.md) + +## Bladeburner.upgradeSkill() method + +Upgrade skill. + +Signature: + +```typescript +upgradeSkill(name: string, count?: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | | +| count | number | Number of times to upgrade the skill. Defaults to 1 if not specified. | + +Returns: + +boolean + +true if the skill is successfully upgraded, and false otherwise. + +## Remarks + +RAM cost: 4 GB + +Attempts to upgrade the specified Bladeburner skill the specified number of times. + +Returns true if the skill is successfully upgraded, and false otherwise. + diff --git a/markdown/bitburner.bladeburnercuraction.md b/markdown/bitburner.bladeburnercuraction.md new file mode 100644 index 000000000..abf2ceabb --- /dev/null +++ b/markdown/bitburner.bladeburnercuraction.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) + +## BladeburnerCurAction interface + +Bladeburner current action. + +Signature: + +```typescript +export interface BladeburnerCurAction +``` + +## Properties + +| Property | 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.bladeburnercuraction.name.md b/markdown/bitburner.bladeburnercuraction.name.md new file mode 100644 index 000000000..3dbcfe79b --- /dev/null +++ b/markdown/bitburner.bladeburnercuraction.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) > [name](./bitburner.bladeburnercuraction.name.md) + +## BladeburnerCurAction.name property + +Name of Action + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.bladeburnercuraction.type.md b/markdown/bitburner.bladeburnercuraction.type.md new file mode 100644 index 000000000..63e21aec4 --- /dev/null +++ b/markdown/bitburner.bladeburnercuraction.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) > [type](./bitburner.bladeburnercuraction.type.md) + +## BladeburnerCurAction.type property + +Type of Action + +Signature: + +```typescript +type: string; +``` diff --git a/markdown/bitburner.charactermult.agility.md b/markdown/bitburner.charactermult.agility.md new file mode 100644 index 000000000..cc7c326db --- /dev/null +++ b/markdown/bitburner.charactermult.agility.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [agility](./bitburner.charactermult.agility.md) + +## CharacterMult.agility property + +Agility stat + +Signature: + +```typescript +agility: number; +``` diff --git a/markdown/bitburner.charactermult.agilityexp.md b/markdown/bitburner.charactermult.agilityexp.md new file mode 100644 index 000000000..2221c4f9a --- /dev/null +++ b/markdown/bitburner.charactermult.agilityexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [agilityExp](./bitburner.charactermult.agilityexp.md) + +## CharacterMult.agilityExp property + +Agility exp + +Signature: + +```typescript +agilityExp: number; +``` diff --git a/markdown/bitburner.charactermult.charisma.md b/markdown/bitburner.charactermult.charisma.md new file mode 100644 index 000000000..9a96106df --- /dev/null +++ b/markdown/bitburner.charactermult.charisma.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [charisma](./bitburner.charactermult.charisma.md) + +## CharacterMult.charisma property + +Charisma stat + +Signature: + +```typescript +charisma: number; +``` diff --git a/markdown/bitburner.charactermult.charismaexp.md b/markdown/bitburner.charactermult.charismaexp.md new file mode 100644 index 000000000..9c4ecea68 --- /dev/null +++ b/markdown/bitburner.charactermult.charismaexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [charismaExp](./bitburner.charactermult.charismaexp.md) + +## CharacterMult.charismaExp property + +Charisma exp + +Signature: + +```typescript +charismaExp: number; +``` diff --git a/markdown/bitburner.charactermult.companyrep.md b/markdown/bitburner.charactermult.companyrep.md new file mode 100644 index 000000000..e12e6b4c1 --- /dev/null +++ b/markdown/bitburner.charactermult.companyrep.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [companyRep](./bitburner.charactermult.companyrep.md) + +## CharacterMult.companyRep property + +Company reputation + +Signature: + +```typescript +companyRep: number; +``` diff --git a/markdown/bitburner.charactermult.crimemoney.md b/markdown/bitburner.charactermult.crimemoney.md new file mode 100644 index 000000000..4e3608874 --- /dev/null +++ b/markdown/bitburner.charactermult.crimemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [crimeMoney](./bitburner.charactermult.crimemoney.md) + +## CharacterMult.crimeMoney property + +Money earned from crimes + +Signature: + +```typescript +crimeMoney: number; +``` diff --git a/markdown/bitburner.charactermult.crimesuccess.md b/markdown/bitburner.charactermult.crimesuccess.md new file mode 100644 index 000000000..2660f01cc --- /dev/null +++ b/markdown/bitburner.charactermult.crimesuccess.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [crimeSuccess](./bitburner.charactermult.crimesuccess.md) + +## CharacterMult.crimeSuccess property + +Crime success chance + +Signature: + +```typescript +crimeSuccess: number; +``` diff --git a/markdown/bitburner.charactermult.defense.md b/markdown/bitburner.charactermult.defense.md new file mode 100644 index 000000000..1165811f2 --- /dev/null +++ b/markdown/bitburner.charactermult.defense.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [defense](./bitburner.charactermult.defense.md) + +## CharacterMult.defense property + +Defense stat + +Signature: + +```typescript +defense: number; +``` diff --git a/markdown/bitburner.charactermult.defenseexp.md b/markdown/bitburner.charactermult.defenseexp.md new file mode 100644 index 000000000..9b1b55e5e --- /dev/null +++ b/markdown/bitburner.charactermult.defenseexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [defenseExp](./bitburner.charactermult.defenseexp.md) + +## CharacterMult.defenseExp property + +Defense exp + +Signature: + +```typescript +defenseExp: number; +``` diff --git a/markdown/bitburner.charactermult.dexterity.md b/markdown/bitburner.charactermult.dexterity.md new file mode 100644 index 000000000..56a6fb1e5 --- /dev/null +++ b/markdown/bitburner.charactermult.dexterity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [dexterity](./bitburner.charactermult.dexterity.md) + +## CharacterMult.dexterity property + +Dexterity stat + +Signature: + +```typescript +dexterity: number; +``` diff --git a/markdown/bitburner.charactermult.dexterityexp.md b/markdown/bitburner.charactermult.dexterityexp.md new file mode 100644 index 000000000..8adadcad4 --- /dev/null +++ b/markdown/bitburner.charactermult.dexterityexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [dexterityExp](./bitburner.charactermult.dexterityexp.md) + +## CharacterMult.dexterityExp property + +Dexterity exp + +Signature: + +```typescript +dexterityExp: number; +``` diff --git a/markdown/bitburner.charactermult.factionrep.md b/markdown/bitburner.charactermult.factionrep.md new file mode 100644 index 000000000..ee97e45f4 --- /dev/null +++ b/markdown/bitburner.charactermult.factionrep.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [factionRep](./bitburner.charactermult.factionrep.md) + +## CharacterMult.factionRep property + +Faction reputation + +Signature: + +```typescript +factionRep: number; +``` diff --git a/markdown/bitburner.charactermult.hacking.md b/markdown/bitburner.charactermult.hacking.md new file mode 100644 index 000000000..b1a9d4c8f --- /dev/null +++ b/markdown/bitburner.charactermult.hacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [hacking](./bitburner.charactermult.hacking.md) + +## CharacterMult.hacking property + +Hacking stat + +Signature: + +```typescript +hacking: number; +``` diff --git a/markdown/bitburner.charactermult.hackingexp.md b/markdown/bitburner.charactermult.hackingexp.md new file mode 100644 index 000000000..3d715cdeb --- /dev/null +++ b/markdown/bitburner.charactermult.hackingexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [hackingExp](./bitburner.charactermult.hackingexp.md) + +## CharacterMult.hackingExp property + +Hacking exp + +Signature: + +```typescript +hackingExp: number; +``` diff --git a/markdown/bitburner.charactermult.md b/markdown/bitburner.charactermult.md new file mode 100644 index 000000000..92018ee12 --- /dev/null +++ b/markdown/bitburner.charactermult.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) + +## CharacterMult interface + + +Signature: + +```typescript +export interface CharacterMult +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility](./bitburner.charactermult.agility.md) | number | Agility stat | +| [agilityExp](./bitburner.charactermult.agilityexp.md) | number | Agility exp | +| [charisma](./bitburner.charactermult.charisma.md) | number | Charisma stat | +| [charismaExp](./bitburner.charactermult.charismaexp.md) | number | Charisma exp | +| [companyRep](./bitburner.charactermult.companyrep.md) | number | Company reputation | +| [crimeMoney](./bitburner.charactermult.crimemoney.md) | number | Money earned from crimes | +| [crimeSuccess](./bitburner.charactermult.crimesuccess.md) | number | Crime success chance | +| [defense](./bitburner.charactermult.defense.md) | number | Defense stat | +| [defenseExp](./bitburner.charactermult.defenseexp.md) | number | Defense exp | +| [dexterity](./bitburner.charactermult.dexterity.md) | number | Dexterity stat | +| [dexterityExp](./bitburner.charactermult.dexterityexp.md) | number | Dexterity exp | +| [factionRep](./bitburner.charactermult.factionrep.md) | number | Faction reputation | +| [hacking](./bitburner.charactermult.hacking.md) | number | Hacking stat | +| [hackingExp](./bitburner.charactermult.hackingexp.md) | number | Hacking exp | +| [strength](./bitburner.charactermult.strength.md) | number | Strength stat | +| [strengthExp](./bitburner.charactermult.strengthexp.md) | number | Strength exp | +| [workMoney](./bitburner.charactermult.workmoney.md) | number | Money earned from jobs | + diff --git a/markdown/bitburner.charactermult.strength.md b/markdown/bitburner.charactermult.strength.md new file mode 100644 index 000000000..57369507e --- /dev/null +++ b/markdown/bitburner.charactermult.strength.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [strength](./bitburner.charactermult.strength.md) + +## CharacterMult.strength property + +Strength stat + +Signature: + +```typescript +strength: number; +``` diff --git a/markdown/bitburner.charactermult.strengthexp.md b/markdown/bitburner.charactermult.strengthexp.md new file mode 100644 index 000000000..760e17669 --- /dev/null +++ b/markdown/bitburner.charactermult.strengthexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [strengthExp](./bitburner.charactermult.strengthexp.md) + +## CharacterMult.strengthExp property + +Strength exp + +Signature: + +```typescript +strengthExp: number; +``` diff --git a/markdown/bitburner.charactermult.workmoney.md b/markdown/bitburner.charactermult.workmoney.md new file mode 100644 index 000000000..0232e0f19 --- /dev/null +++ b/markdown/bitburner.charactermult.workmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [workMoney](./bitburner.charactermult.workmoney.md) + +## CharacterMult.workMoney property + +Money earned from jobs + +Signature: + +```typescript +workMoney: number; +``` diff --git a/markdown/bitburner.codingattemptoptions.md b/markdown/bitburner.codingattemptoptions.md new file mode 100644 index 000000000..22dfd0301 --- /dev/null +++ b/markdown/bitburner.codingattemptoptions.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingAttemptOptions](./bitburner.codingattemptoptions.md) + +## CodingAttemptOptions interface + +Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md) attempt. + +Signature: + +```typescript +export interface CodingAttemptOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [returnReward](./bitburner.codingattemptoptions.returnreward.md) | boolean | If truthy, then the function will return a string that states the contract’s reward when it is successfully solved. | + diff --git a/markdown/bitburner.codingattemptoptions.returnreward.md b/markdown/bitburner.codingattemptoptions.returnreward.md new file mode 100644 index 000000000..f97ed6959 --- /dev/null +++ b/markdown/bitburner.codingattemptoptions.returnreward.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingAttemptOptions](./bitburner.codingattemptoptions.md) > [returnReward](./bitburner.codingattemptoptions.returnreward.md) + +## CodingAttemptOptions.returnReward property + +If truthy, then the function will return a string that states the contract’s reward when it is successfully solved. + +Signature: + +```typescript +returnReward: boolean; +``` diff --git a/markdown/bitburner.codingcontract.attempt.md b/markdown/bitburner.codingcontract.attempt.md new file mode 100644 index 000000000..7737da8fa --- /dev/null +++ b/markdown/bitburner.codingcontract.attempt.md @@ -0,0 +1,40 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [attempt](./bitburner.codingcontract.attempt.md) + +## CodingContract.attempt() method + +Attempts a coding contract. + +Signature: + +```typescript +attempt( + answer: string | number | any[], + filename: string, + host?: string, + opts?: CodingAttemptOptions, + ): boolean | string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| answer | string \| number \| any\[\] | Solution for the contract. | +| filename | string | Filename of the contract. | +| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | +| opts | [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Optional parameters for configuring function behavior. | + +Returns: + +boolean \| string + +True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string. + +## Remarks + +RAM cost: 10 GB + +Attempts to solve the Coding Contract with the provided solution. + diff --git a/markdown/bitburner.codingcontract.createdummycontract.md b/markdown/bitburner.codingcontract.createdummycontract.md new file mode 100644 index 000000000..3b8520779 --- /dev/null +++ b/markdown/bitburner.codingcontract.createdummycontract.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [createDummyContract](./bitburner.codingcontract.createdummycontract.md) + +## CodingContract.createDummyContract() method + +Generate a dummy contract. + +Signature: + +```typescript +createDummyContract(type: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of contract to generate | + +Returns: + +void + +## Remarks + +RAM cost: 2 GB + +Generate a dummy contract on the home computer with no reward. Used to test various algorithms. + diff --git a/markdown/bitburner.codingcontract.getcontracttype.md b/markdown/bitburner.codingcontract.getcontracttype.md new file mode 100644 index 000000000..686bfa3db --- /dev/null +++ b/markdown/bitburner.codingcontract.getcontracttype.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getContractType](./bitburner.codingcontract.getcontracttype.md) + +## CodingContract.getContractType() method + +Get the type of a coding contract. + +Signature: + +```typescript +getContractType(filename: string, host?: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | Filename of the contract. | +| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +string + +Name describing the type of problem posed by the Coding Contract. + +## Remarks + +RAM cost: 5 GB + +Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) + diff --git a/markdown/bitburner.codingcontract.getcontracttypes.md b/markdown/bitburner.codingcontract.getcontracttypes.md new file mode 100644 index 000000000..c688b7b96 --- /dev/null +++ b/markdown/bitburner.codingcontract.getcontracttypes.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getContractTypes](./bitburner.codingcontract.getcontracttypes.md) + +## CodingContract.getContractTypes() method + +List all contract types. + +Signature: + +```typescript +getContractTypes(): string[]; +``` +Returns: + +string\[\] + +## Remarks + +RAM cost: 2 GB + diff --git a/markdown/bitburner.codingcontract.getdata.md b/markdown/bitburner.codingcontract.getdata.md new file mode 100644 index 000000000..703f25372 --- /dev/null +++ b/markdown/bitburner.codingcontract.getdata.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getData](./bitburner.codingcontract.getdata.md) + +## CodingContract.getData() method + +Get the input data. + +Signature: + +```typescript +getData(filename: string, host?: string): CodingContractData; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | Filename of the contract. | +| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +[CodingContractData](./bitburner.codingcontractdata.md) + +The specified contract’s data, data type depends on contract type. + +## Remarks + +RAM cost: 5 GB + +Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve the contract. + diff --git a/markdown/bitburner.codingcontract.getdescription.md b/markdown/bitburner.codingcontract.getdescription.md new file mode 100644 index 000000000..86ab2f16c --- /dev/null +++ b/markdown/bitburner.codingcontract.getdescription.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getDescription](./bitburner.codingcontract.getdescription.md) + +## CodingContract.getDescription() method + +Get the description. + +Signature: + +```typescript +getDescription(filename: string, host?: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | Filename of the contract. | +| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +string + +Contract’s text description. + +## Remarks + +RAM cost: 5 GB + +Get the full text description for the problem posed by the Coding Contract. + diff --git a/markdown/bitburner.codingcontract.getnumtriesremaining.md b/markdown/bitburner.codingcontract.getnumtriesremaining.md new file mode 100644 index 000000000..f2be5a0bd --- /dev/null +++ b/markdown/bitburner.codingcontract.getnumtriesremaining.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getNumTriesRemaining](./bitburner.codingcontract.getnumtriesremaining.md) + +## CodingContract.getNumTriesRemaining() method + +Get the number of attempts remaining. + +Signature: + +```typescript +getNumTriesRemaining(filename: string, host?: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | Filename of the contract. | +| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +number + +How many attempts are remaining for the contract. + +## Remarks + +RAM cost: 2 GB + +Get the number of tries remaining on the contract before it self-destructs. + diff --git a/markdown/bitburner.codingcontract.md b/markdown/bitburner.codingcontract.md new file mode 100644 index 000000000..1f1bf1ed3 --- /dev/null +++ b/markdown/bitburner.codingcontract.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) + +## CodingContract interface + +Coding Contract API + +Signature: + +```typescript +export interface CodingContract +``` + +## Methods + +| Method | Description | +| --- | --- | +| [attempt(answer, filename, host, opts)](./bitburner.codingcontract.attempt.md) | Attempts a coding contract. | +| [createDummyContract(type)](./bitburner.codingcontract.createdummycontract.md) | Generate a dummy 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.codingcontractdata.md b/markdown/bitburner.codingcontractdata.md new file mode 100644 index 000000000..5d237f0c4 --- /dev/null +++ b/markdown/bitburner.codingcontractdata.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContractData](./bitburner.codingcontractdata.md) + +## CodingContractData type + +Coding contract data will differ depending on coding contract. + +Signature: + +```typescript +type CodingContractData = any; +``` diff --git a/markdown/bitburner.corporation.acceptinvestmentoffer.md b/markdown/bitburner.corporation.acceptinvestmentoffer.md new file mode 100644 index 000000000..84ade55ce --- /dev/null +++ b/markdown/bitburner.corporation.acceptinvestmentoffer.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [acceptInvestmentOffer](./bitburner.corporation.acceptinvestmentoffer.md) + +## Corporation.acceptInvestmentOffer() method + +Accept investment based on you companies current valuation + +Signature: + +```typescript +acceptInvestmentOffer(): boolean; +``` +Returns: + +boolean + +An offer of investment + +## Remarks + +Is based on current valuation and will not honer a specific Offer + diff --git a/markdown/bitburner.corporation.bribe.md b/markdown/bitburner.corporation.bribe.md new file mode 100644 index 000000000..3cbb2ba10 --- /dev/null +++ b/markdown/bitburner.corporation.bribe.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [bribe](./bitburner.corporation.bribe.md) + +## Corporation.bribe() method + +Bribe a faction + +Signature: + +```typescript +bribe(factionName: string, amountCash: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| factionName | string | Faction name | +| amountCash | number | Amount of money to bribe | + +Returns: + +boolean + +True if successful, false if not + diff --git a/markdown/bitburner.corporation.buybackshares.md b/markdown/bitburner.corporation.buybackshares.md new file mode 100644 index 000000000..ccc0a787b --- /dev/null +++ b/markdown/bitburner.corporation.buybackshares.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [buyBackShares](./bitburner.corporation.buybackshares.md) + +## Corporation.buyBackShares() method + +Buyback Shares + +Signature: + +```typescript +buyBackShares(amount: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| amount | number | Amount of shares to buy back. | + +Returns: + +void + diff --git a/markdown/bitburner.corporation.createcorporation.md b/markdown/bitburner.corporation.createcorporation.md new file mode 100644 index 000000000..9e9cdb585 --- /dev/null +++ b/markdown/bitburner.corporation.createcorporation.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [createCorporation](./bitburner.corporation.createcorporation.md) + +## Corporation.createCorporation() method + +Create a Corporation + +Signature: + +```typescript +createCorporation(corporationName: string, selfFund: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| corporationName | string | | +| selfFund | boolean | If you should self fund, defaults to true, false will only work on Bitnode 3 | + +Returns: + +boolean + +true if created and false if not + diff --git a/markdown/bitburner.corporation.expandcity.md b/markdown/bitburner.corporation.expandcity.md new file mode 100644 index 000000000..d8b23cac4 --- /dev/null +++ b/markdown/bitburner.corporation.expandcity.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [expandCity](./bitburner.corporation.expandcity.md) + +## Corporation.expandCity() method + +Expand to a new city + +Signature: + +```typescript +expandCity(divisionName: string, cityName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | + +Returns: + +void + diff --git a/markdown/bitburner.corporation.expandindustry.md b/markdown/bitburner.corporation.expandindustry.md new file mode 100644 index 000000000..49cf37cdb --- /dev/null +++ b/markdown/bitburner.corporation.expandindustry.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [expandIndustry](./bitburner.corporation.expandindustry.md) + +## Corporation.expandIndustry() method + +Expand to a new industry + +Signature: + +```typescript +expandIndustry(industryType: string, divisionName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| industryType | string | Name of the industry | +| divisionName | string | Name of the division | + +Returns: + +void + diff --git a/markdown/bitburner.corporation.getbonustime.md b/markdown/bitburner.corporation.getbonustime.md new file mode 100644 index 000000000..49b5ff0b5 --- /dev/null +++ b/markdown/bitburner.corporation.getbonustime.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getBonusTime](./bitburner.corporation.getbonustime.md) + +## Corporation.getBonusTime() method + +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 game progress faster. + +Signature: + +```typescript +getBonusTime(): number; +``` +Returns: + +number + +Bonus time for the Corporation mechanic in milliseconds. + diff --git a/markdown/bitburner.corporation.getcorporation.md b/markdown/bitburner.corporation.getcorporation.md new file mode 100644 index 000000000..d175e0be5 --- /dev/null +++ b/markdown/bitburner.corporation.getcorporation.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getCorporation](./bitburner.corporation.getcorporation.md) + +## Corporation.getCorporation() method + +Get corporation data + +Signature: + +```typescript +getCorporation(): CorporationInfo; +``` +Returns: + +[CorporationInfo](./bitburner.corporationinfo.md) + +Corporation data + diff --git a/markdown/bitburner.corporation.getdivision.md b/markdown/bitburner.corporation.getdivision.md new file mode 100644 index 000000000..f8a89be20 --- /dev/null +++ b/markdown/bitburner.corporation.getdivision.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getDivision](./bitburner.corporation.getdivision.md) + +## Corporation.getDivision() method + +Get division data + +Signature: + +```typescript +getDivision(divisionName: string): Division; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | + +Returns: + +[Division](./bitburner.division.md) + +Division data + diff --git a/markdown/bitburner.corporation.getexpandcitycost.md b/markdown/bitburner.corporation.getexpandcitycost.md new file mode 100644 index 000000000..99726fc89 --- /dev/null +++ b/markdown/bitburner.corporation.getexpandcitycost.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getExpandCityCost](./bitburner.corporation.getexpandcitycost.md) + +## Corporation.getExpandCityCost() method + +Gets the cost to expand into a new city + +Signature: + +```typescript +getExpandCityCost(): number; +``` +Returns: + +number + +cost + diff --git a/markdown/bitburner.corporation.getexpandindustrycost.md b/markdown/bitburner.corporation.getexpandindustrycost.md new file mode 100644 index 000000000..335e99775 --- /dev/null +++ b/markdown/bitburner.corporation.getexpandindustrycost.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getExpandIndustryCost](./bitburner.corporation.getexpandindustrycost.md) + +## Corporation.getExpandIndustryCost() method + +Gets the cost to expand into a new industry + +Signature: + +```typescript +getExpandIndustryCost(industryName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| industryName | string | Name of the industry | + +Returns: + +number + +cost + diff --git a/markdown/bitburner.corporation.getindustrytypes.md b/markdown/bitburner.corporation.getindustrytypes.md new file mode 100644 index 000000000..518d10464 --- /dev/null +++ b/markdown/bitburner.corporation.getindustrytypes.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getIndustryTypes](./bitburner.corporation.getindustrytypes.md) + +## Corporation.getIndustryTypes() method + +Get list of industry types + +Signature: + +```typescript +getIndustryTypes(): string[]; +``` +Returns: + +string\[\] + +industry names + diff --git a/markdown/bitburner.corporation.getinvestmentoffer.md b/markdown/bitburner.corporation.getinvestmentoffer.md new file mode 100644 index 000000000..a1bce820e --- /dev/null +++ b/markdown/bitburner.corporation.getinvestmentoffer.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getInvestmentOffer](./bitburner.corporation.getinvestmentoffer.md) + +## Corporation.getInvestmentOffer() method + +Get an offer for investment based on you companies current valuation + +Signature: + +```typescript +getInvestmentOffer(): InvestmentOffer; +``` +Returns: + +[InvestmentOffer](./bitburner.investmentoffer.md) + +An offer of investment + diff --git a/markdown/bitburner.corporation.getmaterialnames.md b/markdown/bitburner.corporation.getmaterialnames.md new file mode 100644 index 000000000..65339c74b --- /dev/null +++ b/markdown/bitburner.corporation.getmaterialnames.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getMaterialNames](./bitburner.corporation.getmaterialnames.md) + +## Corporation.getMaterialNames() method + +Get list of materials + +Signature: + +```typescript +getMaterialNames(): string[]; +``` +Returns: + +string\[\] + +material names + diff --git a/markdown/bitburner.corporation.getresearchnames.md b/markdown/bitburner.corporation.getresearchnames.md new file mode 100644 index 000000000..55f0a1107 --- /dev/null +++ b/markdown/bitburner.corporation.getresearchnames.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getResearchNames](./bitburner.corporation.getresearchnames.md) + +## Corporation.getResearchNames() method + +Get list of research names + +Signature: + +```typescript +getResearchNames(): string[]; +``` +Returns: + +string\[\] + +research names + diff --git a/markdown/bitburner.corporation.getunlockables.md b/markdown/bitburner.corporation.getunlockables.md new file mode 100644 index 000000000..36f422178 --- /dev/null +++ b/markdown/bitburner.corporation.getunlockables.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getUnlockables](./bitburner.corporation.getunlockables.md) + +## Corporation.getUnlockables() method + +Get list of one-time unlockable upgrades + +Signature: + +```typescript +getUnlockables(): string[]; +``` +Returns: + +string\[\] + +unlockable upgrades names + diff --git a/markdown/bitburner.corporation.getunlockupgradecost.md b/markdown/bitburner.corporation.getunlockupgradecost.md new file mode 100644 index 000000000..328ba6239 --- /dev/null +++ b/markdown/bitburner.corporation.getunlockupgradecost.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getUnlockUpgradeCost](./bitburner.corporation.getunlockupgradecost.md) + +## Corporation.getUnlockUpgradeCost() method + +Gets the cost to unlock a one time unlockable upgrade + +Signature: + +```typescript +getUnlockUpgradeCost(upgradeName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgradeName | string | Name of the upgrade | + +Returns: + +number + +cost of the upgrade + diff --git a/markdown/bitburner.corporation.getupgradelevel.md b/markdown/bitburner.corporation.getupgradelevel.md new file mode 100644 index 000000000..e2e74b60a --- /dev/null +++ b/markdown/bitburner.corporation.getupgradelevel.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getUpgradeLevel](./bitburner.corporation.getupgradelevel.md) + +## Corporation.getUpgradeLevel() method + +Get the level of a levelable upgrade + +Signature: + +```typescript +getUpgradeLevel(upgradeName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgradeName | string | Name of the upgrade | + +Returns: + +number + +the level of the upgrade + diff --git a/markdown/bitburner.corporation.getupgradelevelcost.md b/markdown/bitburner.corporation.getupgradelevelcost.md new file mode 100644 index 000000000..fb26cd29a --- /dev/null +++ b/markdown/bitburner.corporation.getupgradelevelcost.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getUpgradeLevelCost](./bitburner.corporation.getupgradelevelcost.md) + +## Corporation.getUpgradeLevelCost() method + +Gets the cost to unlock the next level of a levelable upgrade + +Signature: + +```typescript +getUpgradeLevelCost(upgradeName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgradeName | string | Name of the upgrade | + +Returns: + +number + +cost of the upgrade + diff --git a/markdown/bitburner.corporation.getupgradenames.md b/markdown/bitburner.corporation.getupgradenames.md new file mode 100644 index 000000000..936891689 --- /dev/null +++ b/markdown/bitburner.corporation.getupgradenames.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [getUpgradeNames](./bitburner.corporation.getupgradenames.md) + +## Corporation.getUpgradeNames() method + +Get list of upgrade names + +Signature: + +```typescript +getUpgradeNames(): string[]; +``` +Returns: + +string\[\] + +upgrade names + diff --git a/markdown/bitburner.corporation.gopublic.md b/markdown/bitburner.corporation.gopublic.md new file mode 100644 index 000000000..e5f370e3b --- /dev/null +++ b/markdown/bitburner.corporation.gopublic.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [goPublic](./bitburner.corporation.gopublic.md) + +## Corporation.goPublic() method + +Go public + +Signature: + +```typescript +goPublic(numShares: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| numShares | number | number of shares you would like to issue for your IPO | + +Returns: + +boolean + +true if you successfully go public, false if not + diff --git a/markdown/bitburner.corporation.hasunlockupgrade.md b/markdown/bitburner.corporation.hasunlockupgrade.md new file mode 100644 index 000000000..869a78456 --- /dev/null +++ b/markdown/bitburner.corporation.hasunlockupgrade.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [hasUnlockUpgrade](./bitburner.corporation.hasunlockupgrade.md) + +## Corporation.hasUnlockUpgrade() method + +Check if you have a one time unlockable upgrade + +Signature: + +```typescript +hasUnlockUpgrade(upgradeName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgradeName | string | Name of the upgrade | + +Returns: + +boolean + +true if unlocked and false if not + diff --git a/markdown/bitburner.corporation.issuedividends.md b/markdown/bitburner.corporation.issuedividends.md new file mode 100644 index 000000000..ce4552387 --- /dev/null +++ b/markdown/bitburner.corporation.issuedividends.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [issueDividends](./bitburner.corporation.issuedividends.md) + +## Corporation.issueDividends() method + +Issue dividends + +Signature: + +```typescript +issueDividends(rate: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| rate | number | Fraction of profit to issue as dividends. | + +Returns: + +void + diff --git a/markdown/bitburner.corporation.levelupgrade.md b/markdown/bitburner.corporation.levelupgrade.md new file mode 100644 index 000000000..f42f9d89b --- /dev/null +++ b/markdown/bitburner.corporation.levelupgrade.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [levelUpgrade](./bitburner.corporation.levelupgrade.md) + +## Corporation.levelUpgrade() method + +Level an upgrade. + +Signature: + +```typescript +levelUpgrade(upgradeName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgradeName | string | Name of the upgrade | + +Returns: + +void + diff --git a/markdown/bitburner.corporation.md b/markdown/bitburner.corporation.md new file mode 100644 index 000000000..83cfcb358 --- /dev/null +++ b/markdown/bitburner.corporation.md @@ -0,0 +1,46 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) + +## Corporation interface + +Corporation API + +Signature: + +```typescript +export interface Corporation extends WarehouseAPI, OfficeAPI +``` +Extends: [WarehouseAPI](./bitburner.warehouseapi.md), [OfficeAPI](./bitburner.officeapi.md) + +## Methods + +| Method | Description | +| --- | --- | +| [acceptInvestmentOffer()](./bitburner.corporation.acceptinvestmentoffer.md) | Accept investment based on you companies current valuation | +| [bribe(factionName, amountCash)](./bitburner.corporation.bribe.md) | Bribe a faction | +| [buyBackShares(amount)](./bitburner.corporation.buybackshares.md) | Buyback Shares | +| [createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md) | Create a Corporation | +| [expandCity(divisionName, cityName)](./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 game progress faster. | +| [getCorporation()](./bitburner.corporation.getcorporation.md) | Get corporation data | +| [getDivision(divisionName)](./bitburner.corporation.getdivision.md) | Get division data | +| [getExpandCityCost()](./bitburner.corporation.getexpandcitycost.md) | Gets the cost to expand into a new city | +| [getExpandIndustryCost(industryName)](./bitburner.corporation.getexpandindustrycost.md) | Gets the cost to expand into a new industry | +| [getIndustryTypes()](./bitburner.corporation.getindustrytypes.md) | Get list of industry types | +| [getInvestmentOffer()](./bitburner.corporation.getinvestmentoffer.md) | Get an offer for investment based on you companies current valuation | +| [getMaterialNames()](./bitburner.corporation.getmaterialnames.md) | Get list of materials | +| [getResearchNames()](./bitburner.corporation.getresearchnames.md) | Get list of research names | +| [getUnlockables()](./bitburner.corporation.getunlockables.md) | Get list of one-time unlockable upgrades | +| [getUnlockUpgradeCost(upgradeName)](./bitburner.corporation.getunlockupgradecost.md) | Gets 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) | Gets the cost to unlock the next level of a levelable upgrade | +| [getUpgradeNames()](./bitburner.corporation.getupgradenames.md) | Get list of upgrade names | +| [goPublic(numShares)](./bitburner.corporation.gopublic.md) | Go public | +| [hasUnlockUpgrade(upgradeName)](./bitburner.corporation.hasunlockupgrade.md) | Check if you have a one time unlockable upgrade | +| [issueDividends(rate)](./bitburner.corporation.issuedividends.md) | Issue dividends | +| [levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) | Level an upgrade. | +| [sellShares(amount)](./bitburner.corporation.sellshares.md) | Sell Shares | +| [unlockUpgrade(upgradeName)](./bitburner.corporation.unlockupgrade.md) | Unlock an upgrade | + diff --git a/markdown/bitburner.corporation.sellshares.md b/markdown/bitburner.corporation.sellshares.md new file mode 100644 index 000000000..6ee2b480a --- /dev/null +++ b/markdown/bitburner.corporation.sellshares.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [sellShares](./bitburner.corporation.sellshares.md) + +## Corporation.sellShares() method + +Sell Shares + +Signature: + +```typescript +sellShares(amount: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| amount | number | Amount of shares to sell. | + +Returns: + +void + diff --git a/markdown/bitburner.corporation.unlockupgrade.md b/markdown/bitburner.corporation.unlockupgrade.md new file mode 100644 index 000000000..581d1bfb2 --- /dev/null +++ b/markdown/bitburner.corporation.unlockupgrade.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md) > [unlockUpgrade](./bitburner.corporation.unlockupgrade.md) + +## Corporation.unlockUpgrade() method + +Unlock an upgrade + +Signature: + +```typescript +unlockUpgrade(upgradeName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgradeName | string | Name of the upgrade | + +Returns: + +void + diff --git a/markdown/bitburner.corporationinfo.dividendearnings.md b/markdown/bitburner.corporationinfo.dividendearnings.md new file mode 100644 index 000000000..83ae2d741 --- /dev/null +++ b/markdown/bitburner.corporationinfo.dividendearnings.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [dividendEarnings](./bitburner.corporationinfo.dividendearnings.md) + +## CorporationInfo.dividendEarnings property + +Your earnings as a shareholder per second this cycle + +Signature: + +```typescript +dividendEarnings: number; +``` diff --git a/markdown/bitburner.corporationinfo.dividendrate.md b/markdown/bitburner.corporationinfo.dividendrate.md new file mode 100644 index 000000000..f3aa95f42 --- /dev/null +++ b/markdown/bitburner.corporationinfo.dividendrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [dividendRate](./bitburner.corporationinfo.dividendrate.md) + +## CorporationInfo.dividendRate property + +Fraction of profits issued as dividends + +Signature: + +```typescript +dividendRate: number; +``` diff --git a/markdown/bitburner.corporationinfo.dividendtax.md b/markdown/bitburner.corporationinfo.dividendtax.md new file mode 100644 index 000000000..5627593a2 --- /dev/null +++ b/markdown/bitburner.corporationinfo.dividendtax.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [dividendTax](./bitburner.corporationinfo.dividendtax.md) + +## CorporationInfo.dividendTax property + +Tax applied on your earnings as a shareholder + +Signature: + +```typescript +dividendTax: number; +``` diff --git a/markdown/bitburner.corporationinfo.divisions.md b/markdown/bitburner.corporationinfo.divisions.md new file mode 100644 index 000000000..eb58a0f87 --- /dev/null +++ b/markdown/bitburner.corporationinfo.divisions.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [divisions](./bitburner.corporationinfo.divisions.md) + +## CorporationInfo.divisions property + +Array of all divisions + +Signature: + +```typescript +divisions: Division[]; +``` diff --git a/markdown/bitburner.corporationinfo.expenses.md b/markdown/bitburner.corporationinfo.expenses.md new file mode 100644 index 000000000..85f7bb246 --- /dev/null +++ b/markdown/bitburner.corporationinfo.expenses.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [expenses](./bitburner.corporationinfo.expenses.md) + +## CorporationInfo.expenses property + +Expenses per second this cycle + +Signature: + +```typescript +expenses: number; +``` diff --git a/markdown/bitburner.corporationinfo.funds.md b/markdown/bitburner.corporationinfo.funds.md new file mode 100644 index 000000000..9484ae098 --- /dev/null +++ b/markdown/bitburner.corporationinfo.funds.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [funds](./bitburner.corporationinfo.funds.md) + +## CorporationInfo.funds property + +Funds available + +Signature: + +```typescript +funds: number; +``` diff --git a/markdown/bitburner.corporationinfo.issuedshares.md b/markdown/bitburner.corporationinfo.issuedshares.md new file mode 100644 index 000000000..2ad061a78 --- /dev/null +++ b/markdown/bitburner.corporationinfo.issuedshares.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [issuedShares](./bitburner.corporationinfo.issuedshares.md) + +## CorporationInfo.issuedShares property + +Amount of acquirable shares. + +Signature: + +```typescript +issuedShares: number; +``` diff --git a/markdown/bitburner.corporationinfo.md b/markdown/bitburner.corporationinfo.md new file mode 100644 index 000000000..5f61a9567 --- /dev/null +++ b/markdown/bitburner.corporationinfo.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) + +## CorporationInfo interface + +General info about a corporation + +Signature: + +```typescript +interface CorporationInfo +``` + +## Properties + +| Property | 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 | +| [dividendTax](./bitburner.corporationinfo.dividendtax.md) | number | Tax applied on your earnings as a shareholder | +| [divisions](./bitburner.corporationinfo.divisions.md) | [Division](./bitburner.division.md)\[\] | Array of all divisions | +| [expenses](./bitburner.corporationinfo.expenses.md) | number | Expenses per second this cycle | +| [funds](./bitburner.corporationinfo.funds.md) | number | Funds available | +| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | Amount of acquirable shares. | +| [name](./bitburner.corporationinfo.name.md) | string | Name of the corporation | +| [numShares](./bitburner.corporationinfo.numshares.md) | number | Amount of share owned | +| [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 | +| [state](./bitburner.corporationinfo.state.md) | string | State of the corporation. Possible states are START, PURCHASE, PRODUCTION, SALE, EXPORT. | +| [totalShares](./bitburner.corporationinfo.totalshares.md) | number | Total number of shares issues by this corporation | + diff --git a/markdown/bitburner.corporationinfo.name.md b/markdown/bitburner.corporationinfo.name.md new file mode 100644 index 000000000..03d66d85c --- /dev/null +++ b/markdown/bitburner.corporationinfo.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [name](./bitburner.corporationinfo.name.md) + +## CorporationInfo.name property + +Name of the corporation + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.corporationinfo.numshares.md b/markdown/bitburner.corporationinfo.numshares.md new file mode 100644 index 000000000..1d44dd998 --- /dev/null +++ b/markdown/bitburner.corporationinfo.numshares.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [numShares](./bitburner.corporationinfo.numshares.md) + +## CorporationInfo.numShares property + +Amount of share owned + +Signature: + +```typescript +numShares: number; +``` diff --git a/markdown/bitburner.corporationinfo.public.md b/markdown/bitburner.corporationinfo.public.md new file mode 100644 index 000000000..91fe2bbd9 --- /dev/null +++ b/markdown/bitburner.corporationinfo.public.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [public](./bitburner.corporationinfo.public.md) + +## CorporationInfo.public property + +Indicating if the company is public + +Signature: + +```typescript +public: boolean; +``` diff --git a/markdown/bitburner.corporationinfo.revenue.md b/markdown/bitburner.corporationinfo.revenue.md new file mode 100644 index 000000000..45c2cf8a0 --- /dev/null +++ b/markdown/bitburner.corporationinfo.revenue.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [revenue](./bitburner.corporationinfo.revenue.md) + +## CorporationInfo.revenue property + +Revenue per second this cycle + +Signature: + +```typescript +revenue: number; +``` diff --git a/markdown/bitburner.corporationinfo.shareprice.md b/markdown/bitburner.corporationinfo.shareprice.md new file mode 100644 index 000000000..406c5abd2 --- /dev/null +++ b/markdown/bitburner.corporationinfo.shareprice.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [sharePrice](./bitburner.corporationinfo.shareprice.md) + +## CorporationInfo.sharePrice property + +Price of the shares + +Signature: + +```typescript +sharePrice: number; +``` diff --git a/markdown/bitburner.corporationinfo.sharesalecooldown.md b/markdown/bitburner.corporationinfo.sharesalecooldown.md new file mode 100644 index 000000000..dfc4128e1 --- /dev/null +++ b/markdown/bitburner.corporationinfo.sharesalecooldown.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md) + +## CorporationInfo.shareSaleCooldown property + +Cooldown until shares can be sold again + +Signature: + +```typescript +shareSaleCooldown: number; +``` diff --git a/markdown/bitburner.corporationinfo.state.md b/markdown/bitburner.corporationinfo.state.md new file mode 100644 index 000000000..8319c609d --- /dev/null +++ b/markdown/bitburner.corporationinfo.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [state](./bitburner.corporationinfo.state.md) + +## CorporationInfo.state property + +State of the corporation. Possible states are START, PURCHASE, PRODUCTION, SALE, EXPORT. + +Signature: + +```typescript +state: string; +``` diff --git a/markdown/bitburner.corporationinfo.totalshares.md b/markdown/bitburner.corporationinfo.totalshares.md new file mode 100644 index 000000000..991235960 --- /dev/null +++ b/markdown/bitburner.corporationinfo.totalshares.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md) > [totalShares](./bitburner.corporationinfo.totalshares.md) + +## CorporationInfo.totalShares property + +Total number of shares issues by this corporation + +Signature: + +```typescript +totalShares: number; +``` diff --git a/markdown/bitburner.crimestats.agility_exp.md b/markdown/bitburner.crimestats.agility_exp.md new file mode 100644 index 000000000..0ed46e84f --- /dev/null +++ b/markdown/bitburner.crimestats.agility_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [agility\_exp](./bitburner.crimestats.agility_exp.md) + +## CrimeStats.agility\_exp property + +agility exp gained from crime + +Signature: + +```typescript +agility_exp: number; +``` diff --git a/markdown/bitburner.crimestats.agility_success_weight.md b/markdown/bitburner.crimestats.agility_success_weight.md new file mode 100644 index 000000000..6f803dd53 --- /dev/null +++ b/markdown/bitburner.crimestats.agility_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [agility\_success\_weight](./bitburner.crimestats.agility_success_weight.md) + +## CrimeStats.agility\_success\_weight property + +agility level impact on success change of the crime + +Signature: + +```typescript +agility_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.charisma_exp.md b/markdown/bitburner.crimestats.charisma_exp.md new file mode 100644 index 000000000..c4e10072c --- /dev/null +++ b/markdown/bitburner.crimestats.charisma_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [charisma\_exp](./bitburner.crimestats.charisma_exp.md) + +## CrimeStats.charisma\_exp property + +charisma exp gained from crime + +Signature: + +```typescript +charisma_exp: number; +``` diff --git a/markdown/bitburner.crimestats.charisma_success_weight.md b/markdown/bitburner.crimestats.charisma_success_weight.md new file mode 100644 index 000000000..37e0d18d0 --- /dev/null +++ b/markdown/bitburner.crimestats.charisma_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [charisma\_success\_weight](./bitburner.crimestats.charisma_success_weight.md) + +## CrimeStats.charisma\_success\_weight property + +charisma level impact on success change of the crime + +Signature: + +```typescript +charisma_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.defense_exp.md b/markdown/bitburner.crimestats.defense_exp.md new file mode 100644 index 000000000..e9f24d83c --- /dev/null +++ b/markdown/bitburner.crimestats.defense_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [defense\_exp](./bitburner.crimestats.defense_exp.md) + +## CrimeStats.defense\_exp property + +defense exp gained from crime + +Signature: + +```typescript +defense_exp: number; +``` diff --git a/markdown/bitburner.crimestats.defense_success_weight.md b/markdown/bitburner.crimestats.defense_success_weight.md new file mode 100644 index 000000000..1afef799a --- /dev/null +++ b/markdown/bitburner.crimestats.defense_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [defense\_success\_weight](./bitburner.crimestats.defense_success_weight.md) + +## CrimeStats.defense\_success\_weight property + +defense level impact on success change of the crime + +Signature: + +```typescript +defense_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.dexterity_exp.md b/markdown/bitburner.crimestats.dexterity_exp.md new file mode 100644 index 000000000..960176994 --- /dev/null +++ b/markdown/bitburner.crimestats.dexterity_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [dexterity\_exp](./bitburner.crimestats.dexterity_exp.md) + +## CrimeStats.dexterity\_exp property + +dexterity exp gained from crime + +Signature: + +```typescript +dexterity_exp: number; +``` diff --git a/markdown/bitburner.crimestats.dexterity_success_weight.md b/markdown/bitburner.crimestats.dexterity_success_weight.md new file mode 100644 index 000000000..26b846f7a --- /dev/null +++ b/markdown/bitburner.crimestats.dexterity_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [dexterity\_success\_weight](./bitburner.crimestats.dexterity_success_weight.md) + +## CrimeStats.dexterity\_success\_weight property + +dexterity level impact on success change of the crime + +Signature: + +```typescript +dexterity_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.difficulty.md b/markdown/bitburner.crimestats.difficulty.md new file mode 100644 index 000000000..36bfa92ea --- /dev/null +++ b/markdown/bitburner.crimestats.difficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [difficulty](./bitburner.crimestats.difficulty.md) + +## CrimeStats.difficulty property + +Number representing the difficulty of the crime. Used for success chance calculations + +Signature: + +```typescript +difficulty: number; +``` diff --git a/markdown/bitburner.crimestats.hacking_exp.md b/markdown/bitburner.crimestats.hacking_exp.md new file mode 100644 index 000000000..56a96c971 --- /dev/null +++ b/markdown/bitburner.crimestats.hacking_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [hacking\_exp](./bitburner.crimestats.hacking_exp.md) + +## CrimeStats.hacking\_exp property + +hacking exp gained from crime + +Signature: + +```typescript +hacking_exp: number; +``` diff --git a/markdown/bitburner.crimestats.hacking_success_weight.md b/markdown/bitburner.crimestats.hacking_success_weight.md new file mode 100644 index 000000000..f57d9fbb8 --- /dev/null +++ b/markdown/bitburner.crimestats.hacking_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [hacking\_success\_weight](./bitburner.crimestats.hacking_success_weight.md) + +## CrimeStats.hacking\_success\_weight property + +hacking level impact on success change of the crime + +Signature: + +```typescript +hacking_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.intelligence_exp.md b/markdown/bitburner.crimestats.intelligence_exp.md new file mode 100644 index 000000000..b2fb67f2a --- /dev/null +++ b/markdown/bitburner.crimestats.intelligence_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [intelligence\_exp](./bitburner.crimestats.intelligence_exp.md) + +## CrimeStats.intelligence\_exp property + +intelligence exp gained from crime + +Signature: + +```typescript +intelligence_exp: number; +``` diff --git a/markdown/bitburner.crimestats.karma.md b/markdown/bitburner.crimestats.karma.md new file mode 100644 index 000000000..fdcc4c7f6 --- /dev/null +++ b/markdown/bitburner.crimestats.karma.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [karma](./bitburner.crimestats.karma.md) + +## CrimeStats.karma property + +Amount of karma lost for successfully committing this crime + +Signature: + +```typescript +karma: number; +``` diff --git a/markdown/bitburner.crimestats.kills.md b/markdown/bitburner.crimestats.kills.md new file mode 100644 index 000000000..963b8edc4 --- /dev/null +++ b/markdown/bitburner.crimestats.kills.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [kills](./bitburner.crimestats.kills.md) + +## CrimeStats.kills property + +How many people die as a result of this crime + +Signature: + +```typescript +kills: number; +``` diff --git a/markdown/bitburner.crimestats.md b/markdown/bitburner.crimestats.md new file mode 100644 index 000000000..ea96891d0 --- /dev/null +++ b/markdown/bitburner.crimestats.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) + +## CrimeStats interface + +Data representing the internal values of a crime. + +Signature: + +```typescript +export interface CrimeStats +``` + +## Properties + +| Property | 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 | agility level impact on success change 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 | charisma level impact on success change 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 | defense level impact on success change 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 | dexterity level impact on success change 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 | hacking level impact on success change 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 | +| [name](./bitburner.crimestats.name.md) | string | Name of crime | +| [strength\_exp](./bitburner.crimestats.strength_exp.md) | number | strength exp gained from crime | +| [strength\_success\_weight](./bitburner.crimestats.strength_success_weight.md) | number | strength level impact on success change 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.crimestats.money.md b/markdown/bitburner.crimestats.money.md new file mode 100644 index 000000000..6260a2059 --- /dev/null +++ b/markdown/bitburner.crimestats.money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [money](./bitburner.crimestats.money.md) + +## CrimeStats.money property + +How much money is given + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.crimestats.name.md b/markdown/bitburner.crimestats.name.md new file mode 100644 index 000000000..0746c5756 --- /dev/null +++ b/markdown/bitburner.crimestats.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [name](./bitburner.crimestats.name.md) + +## CrimeStats.name property + +Name of crime + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.crimestats.strength_exp.md b/markdown/bitburner.crimestats.strength_exp.md new file mode 100644 index 000000000..e30f029b7 --- /dev/null +++ b/markdown/bitburner.crimestats.strength_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [strength\_exp](./bitburner.crimestats.strength_exp.md) + +## CrimeStats.strength\_exp property + +strength exp gained from crime + +Signature: + +```typescript +strength_exp: number; +``` diff --git a/markdown/bitburner.crimestats.strength_success_weight.md b/markdown/bitburner.crimestats.strength_success_weight.md new file mode 100644 index 000000000..e8806edeb --- /dev/null +++ b/markdown/bitburner.crimestats.strength_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [strength\_success\_weight](./bitburner.crimestats.strength_success_weight.md) + +## CrimeStats.strength\_success\_weight property + +strength level impact on success change of the crime + +Signature: + +```typescript +strength_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.time.md b/markdown/bitburner.crimestats.time.md new file mode 100644 index 000000000..60218a10f --- /dev/null +++ b/markdown/bitburner.crimestats.time.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [time](./bitburner.crimestats.time.md) + +## CrimeStats.time property + +Milliseconds it takes to attempt the crime + +Signature: + +```typescript +time: number; +``` diff --git a/markdown/bitburner.crimestats.type.md b/markdown/bitburner.crimestats.type.md new file mode 100644 index 000000000..d6fba340b --- /dev/null +++ b/markdown/bitburner.crimestats.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [type](./bitburner.crimestats.type.md) + +## CrimeStats.type property + +Description of the crime activity + +Signature: + +```typescript +type: string; +``` diff --git a/markdown/bitburner.division.awareness.md b/markdown/bitburner.division.awareness.md new file mode 100644 index 000000000..73daec486 --- /dev/null +++ b/markdown/bitburner.division.awareness.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [awareness](./bitburner.division.awareness.md) + +## Division.awareness property + +Awareness of the division + +Signature: + +```typescript +awareness: number; +``` diff --git a/markdown/bitburner.division.cities.md b/markdown/bitburner.division.cities.md new file mode 100644 index 000000000..0f24b160c --- /dev/null +++ b/markdown/bitburner.division.cities.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [cities](./bitburner.division.cities.md) + +## Division.cities property + +Cities in which this division has expanded + +Signature: + +```typescript +cities: string[]; +``` diff --git a/markdown/bitburner.division.lastcycleexpenses.md b/markdown/bitburner.division.lastcycleexpenses.md new file mode 100644 index 000000000..b29350d75 --- /dev/null +++ b/markdown/bitburner.division.lastcycleexpenses.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) + +## Division.lastCycleExpenses property + +Expenses last cycle + +Signature: + +```typescript +lastCycleExpenses: number; +``` diff --git a/markdown/bitburner.division.lastcyclerevenue.md b/markdown/bitburner.division.lastcyclerevenue.md new file mode 100644 index 000000000..9a26db7ab --- /dev/null +++ b/markdown/bitburner.division.lastcyclerevenue.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) + +## Division.lastCycleRevenue property + +Revenue last cycle + +Signature: + +```typescript +lastCycleRevenue: number; +``` diff --git a/markdown/bitburner.division.makesproducts.md b/markdown/bitburner.division.makesproducts.md new file mode 100644 index 000000000..f624b2267 --- /dev/null +++ b/markdown/bitburner.division.makesproducts.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [makesProducts](./bitburner.division.makesproducts.md) + +## Division.makesProducts property + +Whether the industry this division is in is capable of making products + +Signature: + +```typescript +makesProducts: boolean; +``` diff --git a/markdown/bitburner.division.md b/markdown/bitburner.division.md new file mode 100644 index 000000000..48d3e2de4 --- /dev/null +++ b/markdown/bitburner.division.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) + +## Division interface + +Corporation division + +Signature: + +```typescript +interface Division +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [awareness](./bitburner.division.awareness.md) | number | Awareness of the division | +| [cities](./bitburner.division.cities.md) | string\[\] | Cities in which this division has expanded | +| [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 this division is in is capable of making products | +| [name](./bitburner.division.name.md) | string | Name of the division | +| [popularity](./bitburner.division.popularity.md) | number | Popularity of the division | +| [prodMult](./bitburner.division.prodmult.md) | number | Production multiplier | +| [products](./bitburner.division.products.md) | string\[\] | Products developed by this division | +| [research](./bitburner.division.research.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 | +| [type](./bitburner.division.type.md) | string | Type of division, like Agriculture | +| [upgrades](./bitburner.division.upgrades.md) | number\[\] | All research bought | + diff --git a/markdown/bitburner.division.name.md b/markdown/bitburner.division.name.md new file mode 100644 index 000000000..2896df398 --- /dev/null +++ b/markdown/bitburner.division.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [name](./bitburner.division.name.md) + +## Division.name property + +Name of the division + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.division.popularity.md b/markdown/bitburner.division.popularity.md new file mode 100644 index 000000000..50bdb7986 --- /dev/null +++ b/markdown/bitburner.division.popularity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [popularity](./bitburner.division.popularity.md) + +## Division.popularity property + +Popularity of the division + +Signature: + +```typescript +popularity: number; +``` diff --git a/markdown/bitburner.division.prodmult.md b/markdown/bitburner.division.prodmult.md new file mode 100644 index 000000000..13e563abf --- /dev/null +++ b/markdown/bitburner.division.prodmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [prodMult](./bitburner.division.prodmult.md) + +## Division.prodMult property + +Production multiplier + +Signature: + +```typescript +prodMult: number; +``` diff --git a/markdown/bitburner.division.products.md b/markdown/bitburner.division.products.md new file mode 100644 index 000000000..182c8e1f4 --- /dev/null +++ b/markdown/bitburner.division.products.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [products](./bitburner.division.products.md) + +## Division.products property + +Products developed by this division + +Signature: + +```typescript +products: string[]; +``` diff --git a/markdown/bitburner.division.research.md b/markdown/bitburner.division.research.md new file mode 100644 index 000000000..927f2c924 --- /dev/null +++ b/markdown/bitburner.division.research.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [research](./bitburner.division.research.md) + +## Division.research property + +Amount of research in that division + +Signature: + +```typescript +research: number; +``` diff --git a/markdown/bitburner.division.thiscycleexpenses.md b/markdown/bitburner.division.thiscycleexpenses.md new file mode 100644 index 000000000..b6db4ad28 --- /dev/null +++ b/markdown/bitburner.division.thiscycleexpenses.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [thisCycleExpenses](./bitburner.division.thiscycleexpenses.md) + +## Division.thisCycleExpenses property + +Expenses this cycle + +Signature: + +```typescript +thisCycleExpenses: number; +``` diff --git a/markdown/bitburner.division.thiscyclerevenue.md b/markdown/bitburner.division.thiscyclerevenue.md new file mode 100644 index 000000000..1a66b28fc --- /dev/null +++ b/markdown/bitburner.division.thiscyclerevenue.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [thisCycleRevenue](./bitburner.division.thiscyclerevenue.md) + +## Division.thisCycleRevenue property + +Revenue this cycle + +Signature: + +```typescript +thisCycleRevenue: number; +``` diff --git a/markdown/bitburner.division.type.md b/markdown/bitburner.division.type.md new file mode 100644 index 000000000..30b7a7c79 --- /dev/null +++ b/markdown/bitburner.division.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [type](./bitburner.division.type.md) + +## Division.type property + +Type of division, like Agriculture + +Signature: + +```typescript +type: string; +``` diff --git a/markdown/bitburner.division.upgrades.md b/markdown/bitburner.division.upgrades.md new file mode 100644 index 000000000..616f2209f --- /dev/null +++ b/markdown/bitburner.division.upgrades.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Division](./bitburner.division.md) > [upgrades](./bitburner.division.upgrades.md) + +## Division.upgrades property + +All research bought + +Signature: + +```typescript +upgrades: number[]; +``` diff --git a/markdown/bitburner.employee.cha.md b/markdown/bitburner.employee.cha.md new file mode 100644 index 000000000..e4eefcff6 --- /dev/null +++ b/markdown/bitburner.employee.cha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [cha](./bitburner.employee.cha.md) + +## Employee.cha property + +Charisma of the employee + +Signature: + +```typescript +cha: number; +``` diff --git a/markdown/bitburner.employee.cre.md b/markdown/bitburner.employee.cre.md new file mode 100644 index 000000000..6071773e8 --- /dev/null +++ b/markdown/bitburner.employee.cre.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [cre](./bitburner.employee.cre.md) + +## Employee.cre property + +Creativity of the employee + +Signature: + +```typescript +cre: number; +``` diff --git a/markdown/bitburner.employee.eff.md b/markdown/bitburner.employee.eff.md new file mode 100644 index 000000000..db9a82e19 --- /dev/null +++ b/markdown/bitburner.employee.eff.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [eff](./bitburner.employee.eff.md) + +## Employee.eff property + +Efficiency of the employee + +Signature: + +```typescript +eff: number; +``` diff --git a/markdown/bitburner.employee.ene.md b/markdown/bitburner.employee.ene.md new file mode 100644 index 000000000..573874d5e --- /dev/null +++ b/markdown/bitburner.employee.ene.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [ene](./bitburner.employee.ene.md) + +## Employee.ene property + +Energy of the employee + +Signature: + +```typescript +ene: number; +``` diff --git a/markdown/bitburner.employee.exp.md b/markdown/bitburner.employee.exp.md new file mode 100644 index 000000000..1f88b53e4 --- /dev/null +++ b/markdown/bitburner.employee.exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [exp](./bitburner.employee.exp.md) + +## Employee.exp property + +Experience of the employee + +Signature: + +```typescript +exp: number; +``` diff --git a/markdown/bitburner.employee.hap.md b/markdown/bitburner.employee.hap.md new file mode 100644 index 000000000..9d72d277b --- /dev/null +++ b/markdown/bitburner.employee.hap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [hap](./bitburner.employee.hap.md) + +## Employee.hap property + +Happiness of the employee + +Signature: + +```typescript +hap: number; +``` diff --git a/markdown/bitburner.employee.int.md b/markdown/bitburner.employee.int.md new file mode 100644 index 000000000..5a5a710c2 --- /dev/null +++ b/markdown/bitburner.employee.int.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [int](./bitburner.employee.int.md) + +## Employee.int property + +Intelligence of the employee + +Signature: + +```typescript +int: number; +``` diff --git a/markdown/bitburner.employee.loc.md b/markdown/bitburner.employee.loc.md new file mode 100644 index 000000000..4bc4964d3 --- /dev/null +++ b/markdown/bitburner.employee.loc.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [loc](./bitburner.employee.loc.md) + +## Employee.loc property + +Current Location (city) + +Signature: + +```typescript +loc: string; +``` diff --git a/markdown/bitburner.employee.md b/markdown/bitburner.employee.md new file mode 100644 index 000000000..13846eec6 --- /dev/null +++ b/markdown/bitburner.employee.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) + +## Employee interface + +Employee in an office + +Signature: + +```typescript +export interface Employee +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [cha](./bitburner.employee.cha.md) | number | Charisma of the employee | +| [cre](./bitburner.employee.cre.md) | number | Creativity of the employee | +| [eff](./bitburner.employee.eff.md) | number | Efficiency of the employee | +| [ene](./bitburner.employee.ene.md) | number | Energy of the employee | +| [exp](./bitburner.employee.exp.md) | number | Experience of the employee | +| [hap](./bitburner.employee.hap.md) | number | Happiness of the employee | +| [int](./bitburner.employee.int.md) | number | Intelligence of the employee | +| [loc](./bitburner.employee.loc.md) | string | Current Location (city) | +| [mor](./bitburner.employee.mor.md) | number | Morale of the employee | +| [name](./bitburner.employee.name.md) | string | Name of the employee | +| [pos](./bitburner.employee.pos.md) | string | Current job position | +| [sal](./bitburner.employee.sal.md) | number | Salary of the employee | + diff --git a/markdown/bitburner.employee.mor.md b/markdown/bitburner.employee.mor.md new file mode 100644 index 000000000..8b58c409d --- /dev/null +++ b/markdown/bitburner.employee.mor.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [mor](./bitburner.employee.mor.md) + +## Employee.mor property + +Morale of the employee + +Signature: + +```typescript +mor: number; +``` diff --git a/markdown/bitburner.employee.name.md b/markdown/bitburner.employee.name.md new file mode 100644 index 000000000..1eff9ff46 --- /dev/null +++ b/markdown/bitburner.employee.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [name](./bitburner.employee.name.md) + +## Employee.name property + +Name of the employee + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.employee.pos.md b/markdown/bitburner.employee.pos.md new file mode 100644 index 000000000..cfdb00fd5 --- /dev/null +++ b/markdown/bitburner.employee.pos.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [pos](./bitburner.employee.pos.md) + +## Employee.pos property + +Current job position + +Signature: + +```typescript +pos: string; +``` diff --git a/markdown/bitburner.employee.sal.md b/markdown/bitburner.employee.sal.md new file mode 100644 index 000000000..b70aa48ec --- /dev/null +++ b/markdown/bitburner.employee.sal.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Employee](./bitburner.employee.md) > [sal](./bitburner.employee.sal.md) + +## Employee.sal property + +Salary of the employee + +Signature: + +```typescript +sal: number; +``` diff --git a/markdown/bitburner.employeejobs._research___development_.md b/markdown/bitburner.employeejobs._research___development_.md new file mode 100644 index 000000000..4b53d50f6 --- /dev/null +++ b/markdown/bitburner.employeejobs._research___development_.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EmployeeJobs](./bitburner.employeejobs.md) > ["Research & Development"](./bitburner.employeejobs._research___development_.md) + +## EmployeeJobs."Research & Development" property + +Signature: + +```typescript +"Research & Development": number; +``` diff --git a/markdown/bitburner.employeejobs.business.md b/markdown/bitburner.employeejobs.business.md new file mode 100644 index 000000000..8f46f7be1 --- /dev/null +++ b/markdown/bitburner.employeejobs.business.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EmployeeJobs](./bitburner.employeejobs.md) > [Business](./bitburner.employeejobs.business.md) + +## EmployeeJobs.Business property + +Signature: + +```typescript +Business: number; +``` diff --git a/markdown/bitburner.employeejobs.engineer.md b/markdown/bitburner.employeejobs.engineer.md new file mode 100644 index 000000000..eb8d854a4 --- /dev/null +++ b/markdown/bitburner.employeejobs.engineer.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EmployeeJobs](./bitburner.employeejobs.md) > [Engineer](./bitburner.employeejobs.engineer.md) + +## EmployeeJobs.Engineer property + +Signature: + +```typescript +Engineer: number; +``` diff --git a/markdown/bitburner.employeejobs.management.md b/markdown/bitburner.employeejobs.management.md new file mode 100644 index 000000000..8d521ae74 --- /dev/null +++ b/markdown/bitburner.employeejobs.management.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EmployeeJobs](./bitburner.employeejobs.md) > [Management](./bitburner.employeejobs.management.md) + +## EmployeeJobs.Management property + +Signature: + +```typescript +Management: number; +``` diff --git a/markdown/bitburner.employeejobs.md b/markdown/bitburner.employeejobs.md new file mode 100644 index 000000000..861cffdf1 --- /dev/null +++ b/markdown/bitburner.employeejobs.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EmployeeJobs](./bitburner.employeejobs.md) + +## EmployeeJobs interface + +Object representing the number of employee in each job. + +Signature: + +```typescript +interface EmployeeJobs +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| ["Research & Development"](./bitburner.employeejobs._research___development_.md) | number | | +| [Business](./bitburner.employeejobs.business.md) | number | | +| [Engineer](./bitburner.employeejobs.engineer.md) | number | | +| [Management](./bitburner.employeejobs.management.md) | number | | +| [Operations](./bitburner.employeejobs.operations.md) | number | | +| [Training](./bitburner.employeejobs.training.md) | number | | +| [Unassigned](./bitburner.employeejobs.unassigned.md) | number | | + diff --git a/markdown/bitburner.employeejobs.operations.md b/markdown/bitburner.employeejobs.operations.md new file mode 100644 index 000000000..523d3286b --- /dev/null +++ b/markdown/bitburner.employeejobs.operations.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EmployeeJobs](./bitburner.employeejobs.md) > [Operations](./bitburner.employeejobs.operations.md) + +## EmployeeJobs.Operations property + +Signature: + +```typescript +Operations: number; +``` diff --git a/markdown/bitburner.employeejobs.training.md b/markdown/bitburner.employeejobs.training.md new file mode 100644 index 000000000..e8d4b77e8 --- /dev/null +++ b/markdown/bitburner.employeejobs.training.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EmployeeJobs](./bitburner.employeejobs.md) > [Training](./bitburner.employeejobs.training.md) + +## EmployeeJobs.Training property + +Signature: + +```typescript +Training: number; +``` diff --git a/markdown/bitburner.employeejobs.unassigned.md b/markdown/bitburner.employeejobs.unassigned.md new file mode 100644 index 000000000..49733f518 --- /dev/null +++ b/markdown/bitburner.employeejobs.unassigned.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EmployeeJobs](./bitburner.employeejobs.md) > [Unassigned](./bitburner.employeejobs.unassigned.md) + +## EmployeeJobs.Unassigned property + +Signature: + +```typescript +Unassigned: number; +``` diff --git a/markdown/bitburner.enums.md b/markdown/bitburner.enums.md new file mode 100644 index 000000000..9ef174a1d --- /dev/null +++ b/markdown/bitburner.enums.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [enums](./bitburner.enums.md) + +## enums variable + + +Signature: + +```typescript +enums = { + toast: { + SUCCESS: "success", + WARNING: "warning", + ERROR: "error", + INFO: "info", + }, +} +``` diff --git a/markdown/bitburner.equipmentstats.agi.md b/markdown/bitburner.equipmentstats.agi.md new file mode 100644 index 000000000..c300582de --- /dev/null +++ b/markdown/bitburner.equipmentstats.agi.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EquipmentStats](./bitburner.equipmentstats.md) > [agi](./bitburner.equipmentstats.agi.md) + +## EquipmentStats.agi property + +Agility multiplier + +Signature: + +```typescript +agi?: number; +``` diff --git a/markdown/bitburner.equipmentstats.cha.md b/markdown/bitburner.equipmentstats.cha.md new file mode 100644 index 000000000..b31da6453 --- /dev/null +++ b/markdown/bitburner.equipmentstats.cha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EquipmentStats](./bitburner.equipmentstats.md) > [cha](./bitburner.equipmentstats.cha.md) + +## EquipmentStats.cha property + +Charisma multiplier + +Signature: + +```typescript +cha?: number; +``` diff --git a/markdown/bitburner.equipmentstats.def.md b/markdown/bitburner.equipmentstats.def.md new file mode 100644 index 000000000..369dc7de2 --- /dev/null +++ b/markdown/bitburner.equipmentstats.def.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EquipmentStats](./bitburner.equipmentstats.md) > [def](./bitburner.equipmentstats.def.md) + +## EquipmentStats.def property + +Defense multiplier + +Signature: + +```typescript +def?: number; +``` diff --git a/markdown/bitburner.equipmentstats.dex.md b/markdown/bitburner.equipmentstats.dex.md new file mode 100644 index 000000000..feadd6180 --- /dev/null +++ b/markdown/bitburner.equipmentstats.dex.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EquipmentStats](./bitburner.equipmentstats.md) > [dex](./bitburner.equipmentstats.dex.md) + +## EquipmentStats.dex property + +Dexterity multiplier + +Signature: + +```typescript +dex?: number; +``` diff --git a/markdown/bitburner.equipmentstats.hack.md b/markdown/bitburner.equipmentstats.hack.md new file mode 100644 index 000000000..96609431e --- /dev/null +++ b/markdown/bitburner.equipmentstats.hack.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EquipmentStats](./bitburner.equipmentstats.md) > [hack](./bitburner.equipmentstats.hack.md) + +## EquipmentStats.hack property + +Hacking multiplier + +Signature: + +```typescript +hack?: number; +``` diff --git a/markdown/bitburner.equipmentstats.md b/markdown/bitburner.equipmentstats.md new file mode 100644 index 000000000..34cad3470 --- /dev/null +++ b/markdown/bitburner.equipmentstats.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EquipmentStats](./bitburner.equipmentstats.md) + +## EquipmentStats interface + +Object representing data representing a gang member equipment. + +Signature: + +```typescript +export interface EquipmentStats +``` + +## Properties + +| Property | 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.equipmentstats.str.md b/markdown/bitburner.equipmentstats.str.md new file mode 100644 index 000000000..6a9bc64ca --- /dev/null +++ b/markdown/bitburner.equipmentstats.str.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [EquipmentStats](./bitburner.equipmentstats.md) > [str](./bitburner.equipmentstats.str.md) + +## EquipmentStats.str property + +Strength multiplier + +Signature: + +```typescript +str?: number; +``` diff --git a/markdown/bitburner.export.amt.md b/markdown/bitburner.export.amt.md new file mode 100644 index 000000000..670b14ca5 --- /dev/null +++ b/markdown/bitburner.export.amt.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Export](./bitburner.export.md) > [amt](./bitburner.export.amt.md) + +## Export.amt property + +Amount of material exported + +Signature: + +```typescript +amt: string; +``` diff --git a/markdown/bitburner.export.div.md b/markdown/bitburner.export.div.md new file mode 100644 index 000000000..eb4c78f97 --- /dev/null +++ b/markdown/bitburner.export.div.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Export](./bitburner.export.md) > [div](./bitburner.export.div.md) + +## Export.div property + +Division the material is being exported to + +Signature: + +```typescript +div: string; +``` diff --git a/markdown/bitburner.export.loc.md b/markdown/bitburner.export.loc.md new file mode 100644 index 000000000..dc969ffc9 --- /dev/null +++ b/markdown/bitburner.export.loc.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Export](./bitburner.export.md) > [loc](./bitburner.export.loc.md) + +## Export.loc property + +City the material is being exported to + +Signature: + +```typescript +loc: string; +``` diff --git a/markdown/bitburner.export.md b/markdown/bitburner.export.md new file mode 100644 index 000000000..60d5300c0 --- /dev/null +++ b/markdown/bitburner.export.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Export](./bitburner.export.md) + +## Export interface + +Export order for a material + +Signature: + +```typescript +interface Export +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [amt](./bitburner.export.amt.md) | string | Amount of material exported | +| [div](./bitburner.export.div.md) | string | Division the material is being exported to | +| [loc](./bitburner.export.loc.md) | string | City the material is being exported to | + diff --git a/markdown/bitburner.filenameorpid.md b/markdown/bitburner.filenameorpid.md new file mode 100644 index 000000000..df48b9af4 --- /dev/null +++ b/markdown/bitburner.filenameorpid.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [FilenameOrPID](./bitburner.filenameorpid.md) + +## FilenameOrPID type + + +Signature: + +```typescript +type FilenameOrPID = number | string; +``` diff --git a/markdown/bitburner.formulas.gang.md b/markdown/bitburner.formulas.gang.md new file mode 100644 index 000000000..6a2b07ff7 --- /dev/null +++ b/markdown/bitburner.formulas.gang.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [gang](./bitburner.formulas.gang.md) + +## Formulas.gang property + +Gang formulas + +Signature: + +```typescript +gang: GangFormulas; +``` diff --git a/markdown/bitburner.formulas.hacking.md b/markdown/bitburner.formulas.hacking.md new file mode 100644 index 000000000..51407977d --- /dev/null +++ b/markdown/bitburner.formulas.hacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [hacking](./bitburner.formulas.hacking.md) + +## Formulas.hacking property + +Hacking formulas + +Signature: + +```typescript +hacking: HackingFormulas; +``` diff --git a/markdown/bitburner.formulas.hacknetnodes.md b/markdown/bitburner.formulas.hacknetnodes.md new file mode 100644 index 000000000..6e264ea35 --- /dev/null +++ b/markdown/bitburner.formulas.hacknetnodes.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [hacknetNodes](./bitburner.formulas.hacknetnodes.md) + +## Formulas.hacknetNodes property + +Hacknet Nodes formulas + +Signature: + +```typescript +hacknetNodes: HacknetNodesFormulas; +``` diff --git a/markdown/bitburner.formulas.hacknetservers.md b/markdown/bitburner.formulas.hacknetservers.md new file mode 100644 index 000000000..6b969f00e --- /dev/null +++ b/markdown/bitburner.formulas.hacknetservers.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [hacknetServers](./bitburner.formulas.hacknetservers.md) + +## Formulas.hacknetServers property + +Hacknet Servers formulas + +Signature: + +```typescript +hacknetServers: HacknetServersFormulas; +``` diff --git a/markdown/bitburner.formulas.md b/markdown/bitburner.formulas.md new file mode 100644 index 000000000..7836b12ef --- /dev/null +++ b/markdown/bitburner.formulas.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) + +## Formulas interface + +Formulas API + +Signature: + +```typescript +export interface Formulas +``` + +## Remarks + +You need Formulas.exe on your home computer to use this API. + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [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 | +| --- | --- | +| [mockPlayer()](./bitburner.formulas.mockplayer.md) | | +| [mockServer()](./bitburner.formulas.mockserver.md) | | + diff --git a/markdown/bitburner.formulas.mockplayer.md b/markdown/bitburner.formulas.mockplayer.md new file mode 100644 index 000000000..395abcd43 --- /dev/null +++ b/markdown/bitburner.formulas.mockplayer.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [mockPlayer](./bitburner.formulas.mockplayer.md) + +## Formulas.mockPlayer() method + +Signature: + +```typescript +mockPlayer(): Player; +``` +Returns: + +[Player](./bitburner.player.md) + diff --git a/markdown/bitburner.formulas.mockserver.md b/markdown/bitburner.formulas.mockserver.md new file mode 100644 index 000000000..0921e33cd --- /dev/null +++ b/markdown/bitburner.formulas.mockserver.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [mockServer](./bitburner.formulas.mockserver.md) + +## Formulas.mockServer() method + +Signature: + +```typescript +mockServer(): Server; +``` +Returns: + +[Server](./bitburner.server.md) + diff --git a/markdown/bitburner.formulas.reputation.md b/markdown/bitburner.formulas.reputation.md new file mode 100644 index 000000000..647861041 --- /dev/null +++ b/markdown/bitburner.formulas.reputation.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [reputation](./bitburner.formulas.reputation.md) + +## Formulas.reputation property + +Reputation formulas + +Signature: + +```typescript +reputation: ReputationFormulas; +``` diff --git a/markdown/bitburner.formulas.skills.md b/markdown/bitburner.formulas.skills.md new file mode 100644 index 000000000..5ea345a6c --- /dev/null +++ b/markdown/bitburner.formulas.skills.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [skills](./bitburner.formulas.skills.md) + +## Formulas.skills property + +Skills formulas + +Signature: + +```typescript +skills: SkillsFormulas; +``` diff --git a/markdown/bitburner.formulas.work.md b/markdown/bitburner.formulas.work.md new file mode 100644 index 000000000..0ee012fb6 --- /dev/null +++ b/markdown/bitburner.formulas.work.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Formulas](./bitburner.formulas.md) > [work](./bitburner.formulas.work.md) + +## Formulas.work property + +Work formulas + +Signature: + +```typescript +work: WorkFormulas; +``` diff --git a/markdown/bitburner.fragment.id.md b/markdown/bitburner.fragment.id.md new file mode 100644 index 000000000..cf6e6d4f1 --- /dev/null +++ b/markdown/bitburner.fragment.id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [id](./bitburner.fragment.id.md) + +## Fragment.id property + +Signature: + +```typescript +id: number; +``` diff --git a/markdown/bitburner.fragment.limit.md b/markdown/bitburner.fragment.limit.md new file mode 100644 index 000000000..b24873ef3 --- /dev/null +++ b/markdown/bitburner.fragment.limit.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [limit](./bitburner.fragment.limit.md) + +## Fragment.limit property + +Signature: + +```typescript +limit: number; +``` diff --git a/markdown/bitburner.fragment.md b/markdown/bitburner.fragment.md new file mode 100644 index 000000000..959849efd --- /dev/null +++ b/markdown/bitburner.fragment.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) + +## Fragment interface + + +Signature: + +```typescript +export interface Fragment +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [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.fragment.power.md b/markdown/bitburner.fragment.power.md new file mode 100644 index 000000000..59ce83d87 --- /dev/null +++ b/markdown/bitburner.fragment.power.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [power](./bitburner.fragment.power.md) + +## Fragment.power property + +Signature: + +```typescript +power: number; +``` diff --git a/markdown/bitburner.fragment.shape.md b/markdown/bitburner.fragment.shape.md new file mode 100644 index 000000000..ffd1404e5 --- /dev/null +++ b/markdown/bitburner.fragment.shape.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [shape](./bitburner.fragment.shape.md) + +## Fragment.shape property + +Signature: + +```typescript +shape: boolean[][]; +``` diff --git a/markdown/bitburner.fragment.type.md b/markdown/bitburner.fragment.type.md new file mode 100644 index 000000000..de88217bc --- /dev/null +++ b/markdown/bitburner.fragment.type.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Fragment](./bitburner.fragment.md) > [type](./bitburner.fragment.type.md) + +## Fragment.type property + +Signature: + +```typescript +type: number; +``` diff --git a/markdown/bitburner.gameinfo.commit.md b/markdown/bitburner.gameinfo.commit.md new file mode 100644 index 000000000..f54c06d2b --- /dev/null +++ b/markdown/bitburner.gameinfo.commit.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GameInfo](./bitburner.gameinfo.md) > [commit](./bitburner.gameinfo.commit.md) + +## GameInfo.commit property + +Signature: + +```typescript +commit: string; +``` diff --git a/markdown/bitburner.gameinfo.md b/markdown/bitburner.gameinfo.md new file mode 100644 index 000000000..135e8047f --- /dev/null +++ b/markdown/bitburner.gameinfo.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GameInfo](./bitburner.gameinfo.md) + +## GameInfo interface + +Game Information + +Signature: + +```typescript +interface GameInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [commit](./bitburner.gameinfo.commit.md) | string | | +| [platform](./bitburner.gameinfo.platform.md) | string | | +| [version](./bitburner.gameinfo.version.md) | string | | + diff --git a/markdown/bitburner.gameinfo.platform.md b/markdown/bitburner.gameinfo.platform.md new file mode 100644 index 000000000..b8c96d41f --- /dev/null +++ b/markdown/bitburner.gameinfo.platform.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GameInfo](./bitburner.gameinfo.md) > [platform](./bitburner.gameinfo.platform.md) + +## GameInfo.platform property + +Signature: + +```typescript +platform: string; +``` diff --git a/markdown/bitburner.gameinfo.version.md b/markdown/bitburner.gameinfo.version.md new file mode 100644 index 000000000..9b19ac008 --- /dev/null +++ b/markdown/bitburner.gameinfo.version.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GameInfo](./bitburner.gameinfo.md) > [version](./bitburner.gameinfo.version.md) + +## GameInfo.version property + +Signature: + +```typescript +version: string; +``` diff --git a/markdown/bitburner.gang.ascendmember.md b/markdown/bitburner.gang.ascendmember.md new file mode 100644 index 000000000..1932ed0ba --- /dev/null +++ b/markdown/bitburner.gang.ascendmember.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [ascendMember](./bitburner.gang.ascendmember.md) + +## Gang.ascendMember() method + +Ascend a gang member. + +Signature: + +```typescript +ascendMember(memberName: string): GangMemberAscension | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| memberName | string | Name of member to ascend. | + +Returns: + +[GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined + +Object with info about the ascension results. Undefined if ascension did not occur. + +## Remarks + +RAM cost: 4 GB + +Ascend the specified Gang Member. + diff --git a/markdown/bitburner.gang.canrecruitmember.md b/markdown/bitburner.gang.canrecruitmember.md new file mode 100644 index 000000000..5710fed44 --- /dev/null +++ b/markdown/bitburner.gang.canrecruitmember.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [canRecruitMember](./bitburner.gang.canrecruitmember.md) + +## Gang.canRecruitMember() method + +Check if you can recruit a new gang member. + +Signature: + +```typescript +canRecruitMember(): boolean; +``` +Returns: + +boolean + +True if a member can currently be recruited, false otherwise. + +## Remarks + +RAM cost: 1 GB + +Returns boolean indicating whether a member can currently be recruited + diff --git a/markdown/bitburner.gang.creategang.md b/markdown/bitburner.gang.creategang.md new file mode 100644 index 000000000..cf57b8a8a --- /dev/null +++ b/markdown/bitburner.gang.creategang.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [createGang](./bitburner.gang.creategang.md) + +## Gang.createGang() method + +Create a gang. + +Signature: + +```typescript +createGang(faction: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | | + +Returns: + +boolean + +True if the gang was created, false otherwise. + +## Remarks + +RAM cost: 1GB + +Create a gang with the specified faction. + diff --git a/markdown/bitburner.gang.getascensionresult.md b/markdown/bitburner.gang.getascensionresult.md new file mode 100644 index 000000000..3e6787b21 --- /dev/null +++ b/markdown/bitburner.gang.getascensionresult.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getAscensionResult](./bitburner.gang.getascensionresult.md) + +## Gang.getAscensionResult() method + +Get the result of an ascension without ascending. + +Signature: + +```typescript +getAscensionResult(memberName: string): GangMemberAscension | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| memberName | string | Name of member. | + +Returns: + +[GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined + +Object with info about the ascension results. Undefined if ascension is impossible. + +## Remarks + +RAM cost: 2 GB + +Get the result of an ascension without ascending. + diff --git a/markdown/bitburner.gang.getbonustime.md b/markdown/bitburner.gang.getbonustime.md new file mode 100644 index 000000000..89d8dd9b6 --- /dev/null +++ b/markdown/bitburner.gang.getbonustime.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getBonusTime](./bitburner.gang.getbonustime.md) + +## Gang.getBonusTime() method + +Get bonus time. + +Signature: + +```typescript +getBonusTime(): number; +``` +Returns: + +number + +Bonus time for the Gang mechanic in milliseconds. + +## Remarks + +RAM cost: 0 GB + +Returns the amount of accumulated “bonus time” (milliseconds) for the Gang mechanic. + +“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. + +“Bonus time” makes the game progress faster, up to 10x the normal speed. + diff --git a/markdown/bitburner.gang.getchancetowinclash.md b/markdown/bitburner.gang.getchancetowinclash.md new file mode 100644 index 000000000..fa6d46455 --- /dev/null +++ b/markdown/bitburner.gang.getchancetowinclash.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getChanceToWinClash](./bitburner.gang.getchancetowinclash.md) + +## Gang.getChanceToWinClash() method + +Get chance to win clash with other gang. + +Signature: + +```typescript +getChanceToWinClash(gangName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| gangName | string | Target gang | + +Returns: + +number + +Chance you have to win a clash with the specified gang. + +## Remarks + +RAM cost: 4 GB + +Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage + diff --git a/markdown/bitburner.gang.getequipmentcost.md b/markdown/bitburner.gang.getequipmentcost.md new file mode 100644 index 000000000..8deb184e4 --- /dev/null +++ b/markdown/bitburner.gang.getequipmentcost.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getEquipmentCost](./bitburner.gang.getequipmentcost.md) + +## Gang.getEquipmentCost() method + +Get cost of equipment. + +Signature: + +```typescript +getEquipmentCost(equipName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| equipName | string | Name of equipment. | + +Returns: + +number + +Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments + +## Remarks + +RAM cost: 2 GB + +Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity. + diff --git a/markdown/bitburner.gang.getequipmentnames.md b/markdown/bitburner.gang.getequipmentnames.md new file mode 100644 index 000000000..931d31d76 --- /dev/null +++ b/markdown/bitburner.gang.getequipmentnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getEquipmentNames](./bitburner.gang.getequipmentnames.md) + +## Gang.getEquipmentNames() method + +List equipment names. + +Signature: + +```typescript +getEquipmentNames(): string[]; +``` +Returns: + +string\[\] + +Names of all Equipments/Augmentations. + +## Remarks + +RAM cost: 1 GB + +Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations. + diff --git a/markdown/bitburner.gang.getequipmentstats.md b/markdown/bitburner.gang.getequipmentstats.md new file mode 100644 index 000000000..d78d067e5 --- /dev/null +++ b/markdown/bitburner.gang.getequipmentstats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getEquipmentStats](./bitburner.gang.getequipmentstats.md) + +## Gang.getEquipmentStats() method + +Get stats of an equipment. + +Signature: + +```typescript +getEquipmentStats(equipName: string): EquipmentStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| equipName | string | Name of equipment. | + +Returns: + +[EquipmentStats](./bitburner.equipmentstats.md) + +A dictionary containing the stats of the equipment. + +## Remarks + +RAM cost: 2 GB + +Get the specified equipment stats. + diff --git a/markdown/bitburner.gang.getequipmenttype.md b/markdown/bitburner.gang.getequipmenttype.md new file mode 100644 index 000000000..0958e5696 --- /dev/null +++ b/markdown/bitburner.gang.getequipmenttype.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getEquipmentType](./bitburner.gang.getequipmenttype.md) + +## Gang.getEquipmentType() method + +Get type of an equipment. + +Signature: + +```typescript +getEquipmentType(equipName: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| equipName | string | Name of equipment. | + +Returns: + +string + +Type of the equipment. + +## Remarks + +RAM cost: 2 GB + +Get the specified equipment type. + diff --git a/markdown/bitburner.gang.getganginformation.md b/markdown/bitburner.gang.getganginformation.md new file mode 100644 index 000000000..5e325c073 --- /dev/null +++ b/markdown/bitburner.gang.getganginformation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getGangInformation](./bitburner.gang.getganginformation.md) + +## Gang.getGangInformation() method + +Get information about your gang. + +Signature: + +```typescript +getGangInformation(): GangGenInfo; +``` +Returns: + +[GangGenInfo](./bitburner.ganggeninfo.md) + +Object containing general information about the gang. + +## Remarks + +RAM cost: 2 GB + +Get general information about the gang. + diff --git a/markdown/bitburner.gang.getmemberinformation.md b/markdown/bitburner.gang.getmemberinformation.md new file mode 100644 index 000000000..13033bfaa --- /dev/null +++ b/markdown/bitburner.gang.getmemberinformation.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getMemberInformation](./bitburner.gang.getmemberinformation.md) + +## Gang.getMemberInformation() method + +Get information about a specific gang member. + +Signature: + +```typescript +getMemberInformation(name: string): GangMemberInfo; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Name of member. | + +Returns: + +[GangMemberInfo](./bitburner.gangmemberinfo.md) + +Object containing stat and equipment-related information about a Gang Member. + +## Remarks + +RAM cost: 2 GB + +Get stat and equipment-related information about a Gang Member + diff --git a/markdown/bitburner.gang.getmembernames.md b/markdown/bitburner.gang.getmembernames.md new file mode 100644 index 000000000..08a766c42 --- /dev/null +++ b/markdown/bitburner.gang.getmembernames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getMemberNames](./bitburner.gang.getmembernames.md) + +## Gang.getMemberNames() method + +List all gang members. + +Signature: + +```typescript +getMemberNames(): string[]; +``` +Returns: + +string\[\] + +Names of all Gang members. + +## Remarks + +RAM cost: 1 GB + +Get the names of all Gang members + diff --git a/markdown/bitburner.gang.getotherganginformation.md b/markdown/bitburner.gang.getotherganginformation.md new file mode 100644 index 000000000..6764033f3 --- /dev/null +++ b/markdown/bitburner.gang.getotherganginformation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getOtherGangInformation](./bitburner.gang.getotherganginformation.md) + +## Gang.getOtherGangInformation() method + +Get information about the other gangs. + +Signature: + +```typescript +getOtherGangInformation(): GangOtherInfo; +``` +Returns: + +[GangOtherInfo](./bitburner.gangotherinfo.md) + +Object containing territory and power information about all gangs. + +## Remarks + +RAM cost: 2 GB + +Get territory and power information about all gangs. + diff --git a/markdown/bitburner.gang.gettasknames.md b/markdown/bitburner.gang.gettasknames.md new file mode 100644 index 000000000..4e1b1d885 --- /dev/null +++ b/markdown/bitburner.gang.gettasknames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getTaskNames](./bitburner.gang.gettasknames.md) + +## Gang.getTaskNames() method + +List member task names. + +Signature: + +```typescript +getTaskNames(): string[]; +``` +Returns: + +string\[\] + +All valid tasks that Gang members can be assigned to. + +## Remarks + +RAM cost: 1 GB + +Get the name of all valid tasks that Gang members can be assigned to. + diff --git a/markdown/bitburner.gang.gettaskstats.md b/markdown/bitburner.gang.gettaskstats.md new file mode 100644 index 000000000..cfd2a62a5 --- /dev/null +++ b/markdown/bitburner.gang.gettaskstats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getTaskStats](./bitburner.gang.gettaskstats.md) + +## Gang.getTaskStats() method + +Get stats of a task. + +Signature: + +```typescript +getTaskStats(name: string): GangTaskStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Name of the task. | + +Returns: + +[GangTaskStats](./bitburner.gangtaskstats.md) + +Detailed stats of a task. + +## Remarks + +RAM cost: 1 GB + +Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. + diff --git a/markdown/bitburner.gang.ingang.md b/markdown/bitburner.gang.ingang.md new file mode 100644 index 000000000..4cd0021f9 --- /dev/null +++ b/markdown/bitburner.gang.ingang.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [inGang](./bitburner.gang.ingang.md) + +## Gang.inGang() method + +Check if you're in a gang. + +Signature: + +```typescript +inGang(): boolean; +``` +Returns: + +boolean + +True if you're in a gang, false otherwise. + +## Remarks + +RAM cost: 1GB + diff --git a/markdown/bitburner.gang.md b/markdown/bitburner.gang.md new file mode 100644 index 000000000..de2e20ca5 --- /dev/null +++ b/markdown/bitburner.gang.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) + +## Gang interface + +Gang API + +Signature: + +```typescript +export interface Gang +``` + +## Remarks + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this API. + +## 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. | +| [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 the other gangs. | +| [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. | +| [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. | +| [setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) | Set gang member to task. | +| [setTerritoryWarfare(engage)](./bitburner.gang.setterritorywarfare.md) | Enable/Disable territory warfare. | + diff --git a/markdown/bitburner.gang.purchaseequipment.md b/markdown/bitburner.gang.purchaseequipment.md new file mode 100644 index 000000000..c5cb20db2 --- /dev/null +++ b/markdown/bitburner.gang.purchaseequipment.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [purchaseEquipment](./bitburner.gang.purchaseequipment.md) + +## Gang.purchaseEquipment() method + +Purchase an equipment for a gang member. + +Signature: + +```typescript +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. | + +Returns: + +boolean + +True if the equipment was successfully purchased. False otherwise + +## Remarks + +RAM cost: 4 GB + +Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. + diff --git a/markdown/bitburner.gang.recruitmember.md b/markdown/bitburner.gang.recruitmember.md new file mode 100644 index 000000000..d74689ed8 --- /dev/null +++ b/markdown/bitburner.gang.recruitmember.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [recruitMember](./bitburner.gang.recruitmember.md) + +## Gang.recruitMember() method + +Recruit a new gang member. + +Signature: + +```typescript +recruitMember(name: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Name of member to recruit. | + +Returns: + +boolean + +True if the member was successfully recruited, false otherwise. + +## Remarks + +RAM cost: 2 GB + +Attempt to recruit a new gang member. + +Possible reasons for failure: \* Cannot currently recruit a new member \* There already exists a member with the specified name + diff --git a/markdown/bitburner.gang.setmembertask.md b/markdown/bitburner.gang.setmembertask.md new file mode 100644 index 000000000..972af190b --- /dev/null +++ b/markdown/bitburner.gang.setmembertask.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [setMemberTask](./bitburner.gang.setmembertask.md) + +## Gang.setMemberTask() method + +Set gang member to task. + +Signature: + +```typescript +setMemberTask(memberName: string, taskName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| memberName | string | Name of Gang member to assign. | +| taskName | string | Task to assign. | + +Returns: + +boolean + +True if the Gang Member was successfully assigned to the task, false otherwise. + +## Remarks + +RAM cost: 2 GB + +Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”). + diff --git a/markdown/bitburner.gang.setterritorywarfare.md b/markdown/bitburner.gang.setterritorywarfare.md new file mode 100644 index 000000000..068b0abce --- /dev/null +++ b/markdown/bitburner.gang.setterritorywarfare.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [setTerritoryWarfare](./bitburner.gang.setterritorywarfare.md) + +## Gang.setTerritoryWarfare() method + +Enable/Disable territory warfare. + +Signature: + +```typescript +setTerritoryWarfare(engage: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| engage | boolean | Whether or not to engage in territory warfare. | + +Returns: + +void + +## Remarks + +RAM cost: 2 GB + +Set whether or not the gang should engage in territory warfare + diff --git a/markdown/bitburner.gangformulas.ascensionmultiplier.md b/markdown/bitburner.gangformulas.ascensionmultiplier.md new file mode 100644 index 000000000..b654ddf26 --- /dev/null +++ b/markdown/bitburner.gangformulas.ascensionmultiplier.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangFormulas](./bitburner.gangformulas.md) > [ascensionMultiplier](./bitburner.gangformulas.ascensionmultiplier.md) + +## GangFormulas.ascensionMultiplier() method + +Calculate ascension mult. + +Signature: + +```typescript +ascensionMultiplier(points: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| points | number | Amount of ascension points. | + +Returns: + +number + +The calculated ascension mult. + diff --git a/markdown/bitburner.gangformulas.ascensionpointsgain.md b/markdown/bitburner.gangformulas.ascensionpointsgain.md new file mode 100644 index 000000000..796be6b58 --- /dev/null +++ b/markdown/bitburner.gangformulas.ascensionpointsgain.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangFormulas](./bitburner.gangformulas.md) > [ascensionPointsGain](./bitburner.gangformulas.ascensionpointsgain.md) + +## GangFormulas.ascensionPointsGain() method + +Calculate ascension point gain. + +Signature: + +```typescript +ascensionPointsGain(exp: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| exp | number | Experience point before ascension. | + +Returns: + +number + +The calculated ascension point gain. + diff --git a/markdown/bitburner.gangformulas.md b/markdown/bitburner.gangformulas.md new file mode 100644 index 000000000..eea043ad0 --- /dev/null +++ b/markdown/bitburner.gangformulas.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangFormulas](./bitburner.gangformulas.md) + +## GangFormulas interface + +Gang formulas + +Signature: + +```typescript +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. | + diff --git a/markdown/bitburner.gangformulas.moneygain.md b/markdown/bitburner.gangformulas.moneygain.md new file mode 100644 index 000000000..4eec2828a --- /dev/null +++ b/markdown/bitburner.gangformulas.moneygain.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangFormulas](./bitburner.gangformulas.md) > [moneyGain](./bitburner.gangformulas.moneygain.md) + +## GangFormulas.moneyGain() method + +Calculate money gain per tick. + +Signature: + +```typescript +moneyGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; +``` + +## 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) | + +Returns: + +number + +The calculated money gain. + diff --git a/markdown/bitburner.gangformulas.respectgain.md b/markdown/bitburner.gangformulas.respectgain.md new file mode 100644 index 000000000..3bc6e4f49 --- /dev/null +++ b/markdown/bitburner.gangformulas.respectgain.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangFormulas](./bitburner.gangformulas.md) > [respectGain](./bitburner.gangformulas.respectgain.md) + +## GangFormulas.respectGain() method + +Calculate respect gain per tick. + +Signature: + +```typescript +respectGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; +``` + +## 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) | + +Returns: + +number + +The calculated respect gain. + diff --git a/markdown/bitburner.gangformulas.wantedlevelgain.md b/markdown/bitburner.gangformulas.wantedlevelgain.md new file mode 100644 index 000000000..f86d30fef --- /dev/null +++ b/markdown/bitburner.gangformulas.wantedlevelgain.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangFormulas](./bitburner.gangformulas.md) > [wantedLevelGain](./bitburner.gangformulas.wantedlevelgain.md) + +## GangFormulas.wantedLevelGain() method + +Calculate wanted gain per tick. + +Signature: + +```typescript +wantedLevelGain(gang: GangGenInfo, member: GangMemberInfo, task: GangTaskStats): number; +``` + +## 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) | + +Returns: + +number + +The calculated wanted gain. + diff --git a/markdown/bitburner.gangformulas.wantedpenalty.md b/markdown/bitburner.gangformulas.wantedpenalty.md new file mode 100644 index 000000000..966de0885 --- /dev/null +++ b/markdown/bitburner.gangformulas.wantedpenalty.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangFormulas](./bitburner.gangformulas.md) > [wantedPenalty](./bitburner.gangformulas.wantedpenalty.md) + +## GangFormulas.wantedPenalty() method + +Calculate the wanted penalty. + +Signature: + +```typescript +wantedPenalty(gang: GangGenInfo): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| gang | [GangGenInfo](./bitburner.ganggeninfo.md) | Gang info from [getGangInformation](./bitburner.gang.getganginformation.md) | + +Returns: + +number + +The calculated wanted penalty. + diff --git a/markdown/bitburner.ganggeninfo.faction.md b/markdown/bitburner.ganggeninfo.faction.md new file mode 100644 index 000000000..0b36ac034 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.faction.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [faction](./bitburner.ganggeninfo.faction.md) + +## GangGenInfo.faction property + +Name of faction that the gang belongs to ("Slum Snakes", etc.) + +Signature: + +```typescript +faction: string; +``` diff --git a/markdown/bitburner.ganggeninfo.ishacking.md b/markdown/bitburner.ganggeninfo.ishacking.md new file mode 100644 index 000000000..e92362c16 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.ishacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [isHacking](./bitburner.ganggeninfo.ishacking.md) + +## GangGenInfo.isHacking property + +Indicating whether or not it's a hacking gang + +Signature: + +```typescript +isHacking: boolean; +``` diff --git a/markdown/bitburner.ganggeninfo.md b/markdown/bitburner.ganggeninfo.md new file mode 100644 index 000000000..def8fab44 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) + +## GangGenInfo interface + +Gang general info. + +Signature: + +```typescript +export interface GangGenInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [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 | +| [respectGainRate](./bitburner.ganggeninfo.respectgainrate.md) | number | Respect earned per game cycle | +| [territory](./bitburner.ganggeninfo.territory.md) | number | Amount of territory held | +| [territoryClashChance](./bitburner.ganggeninfo.territoryclashchance.md) | number | Clash chance | +| [territoryWarfareEngaged](./bitburner.ganggeninfo.territorywarfareengaged.md) | boolean | Indicating if territory warfare is 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.ganggeninfo.moneygainrate.md b/markdown/bitburner.ganggeninfo.moneygainrate.md new file mode 100644 index 000000000..4045ca547 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.moneygainrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) + +## GangGenInfo.moneyGainRate property + +Money earned per game cycle + +Signature: + +```typescript +moneyGainRate: number; +``` diff --git a/markdown/bitburner.ganggeninfo.power.md b/markdown/bitburner.ganggeninfo.power.md new file mode 100644 index 000000000..013893ba8 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.power.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [power](./bitburner.ganggeninfo.power.md) + +## GangGenInfo.power property + +Gang's power for territory warfare + +Signature: + +```typescript +power: number; +``` diff --git a/markdown/bitburner.ganggeninfo.respect.md b/markdown/bitburner.ganggeninfo.respect.md new file mode 100644 index 000000000..981fd3014 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.respect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [respect](./bitburner.ganggeninfo.respect.md) + +## GangGenInfo.respect property + +Gang's respect + +Signature: + +```typescript +respect: number; +``` diff --git a/markdown/bitburner.ganggeninfo.respectgainrate.md b/markdown/bitburner.ganggeninfo.respectgainrate.md new file mode 100644 index 000000000..c1046e588 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.respectgainrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [respectGainRate](./bitburner.ganggeninfo.respectgainrate.md) + +## GangGenInfo.respectGainRate property + +Respect earned per game cycle + +Signature: + +```typescript +respectGainRate: number; +``` diff --git a/markdown/bitburner.ganggeninfo.territory.md b/markdown/bitburner.ganggeninfo.territory.md new file mode 100644 index 000000000..5bd6f7ece --- /dev/null +++ b/markdown/bitburner.ganggeninfo.territory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [territory](./bitburner.ganggeninfo.territory.md) + +## GangGenInfo.territory property + +Amount of territory held + +Signature: + +```typescript +territory: number; +``` diff --git a/markdown/bitburner.ganggeninfo.territoryclashchance.md b/markdown/bitburner.ganggeninfo.territoryclashchance.md new file mode 100644 index 000000000..179bf2381 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.territoryclashchance.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [territoryClashChance](./bitburner.ganggeninfo.territoryclashchance.md) + +## GangGenInfo.territoryClashChance property + +Clash chance + +Signature: + +```typescript +territoryClashChance: number; +``` diff --git a/markdown/bitburner.ganggeninfo.territorywarfareengaged.md b/markdown/bitburner.ganggeninfo.territorywarfareengaged.md new file mode 100644 index 000000000..d0f4a02f0 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.territorywarfareengaged.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [territoryWarfareEngaged](./bitburner.ganggeninfo.territorywarfareengaged.md) + +## GangGenInfo.territoryWarfareEngaged property + +Indicating if territory warfare is enabled + +Signature: + +```typescript +territoryWarfareEngaged: boolean; +``` diff --git a/markdown/bitburner.ganggeninfo.wantedlevel.md b/markdown/bitburner.ganggeninfo.wantedlevel.md new file mode 100644 index 000000000..62e803bd4 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.wantedlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [wantedLevel](./bitburner.ganggeninfo.wantedlevel.md) + +## GangGenInfo.wantedLevel property + +Gang's wanted level + +Signature: + +```typescript +wantedLevel: number; +``` diff --git a/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md b/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md new file mode 100644 index 000000000..20f3e1fa3 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [wantedLevelGainRate](./bitburner.ganggeninfo.wantedlevelgainrate.md) + +## GangGenInfo.wantedLevelGainRate property + +Wanted level gained/lost per game cycle (negative for losses) + +Signature: + +```typescript +wantedLevelGainRate: number; +``` diff --git a/markdown/bitburner.ganggeninfo.wantedpenalty.md b/markdown/bitburner.ganggeninfo.wantedpenalty.md new file mode 100644 index 000000000..17719bd2a --- /dev/null +++ b/markdown/bitburner.ganggeninfo.wantedpenalty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [wantedPenalty](./bitburner.ganggeninfo.wantedpenalty.md) + +## GangGenInfo.wantedPenalty property + +Number indicating the current wanted penalty + +Signature: + +```typescript +wantedPenalty: number; +``` diff --git a/markdown/bitburner.gangmemberascension.agi.md b/markdown/bitburner.gangmemberascension.agi.md new file mode 100644 index 000000000..75e15dc39 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.agi.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [agi](./bitburner.gangmemberascension.agi.md) + +## GangMemberAscension.agi property + +Agility multiplier gained from ascending + +Signature: + +```typescript +agi: number; +``` diff --git a/markdown/bitburner.gangmemberascension.cha.md b/markdown/bitburner.gangmemberascension.cha.md new file mode 100644 index 000000000..24eb2cb04 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.cha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [cha](./bitburner.gangmemberascension.cha.md) + +## GangMemberAscension.cha property + +Charisma multiplier gained from ascending + +Signature: + +```typescript +cha: number; +``` diff --git a/markdown/bitburner.gangmemberascension.def.md b/markdown/bitburner.gangmemberascension.def.md new file mode 100644 index 000000000..3ed9ae655 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.def.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [def](./bitburner.gangmemberascension.def.md) + +## GangMemberAscension.def property + +Defense multiplier gained from ascending + +Signature: + +```typescript +def: number; +``` diff --git a/markdown/bitburner.gangmemberascension.dex.md b/markdown/bitburner.gangmemberascension.dex.md new file mode 100644 index 000000000..d081d35a6 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.dex.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [dex](./bitburner.gangmemberascension.dex.md) + +## GangMemberAscension.dex property + +Dexterity multiplier gained from ascending + +Signature: + +```typescript +dex: number; +``` diff --git a/markdown/bitburner.gangmemberascension.hack.md b/markdown/bitburner.gangmemberascension.hack.md new file mode 100644 index 000000000..b42e99ebb --- /dev/null +++ b/markdown/bitburner.gangmemberascension.hack.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [hack](./bitburner.gangmemberascension.hack.md) + +## GangMemberAscension.hack property + +Hacking multiplier gained from ascending + +Signature: + +```typescript +hack: number; +``` diff --git a/markdown/bitburner.gangmemberascension.md b/markdown/bitburner.gangmemberascension.md new file mode 100644 index 000000000..38d96416a --- /dev/null +++ b/markdown/bitburner.gangmemberascension.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) + +## GangMemberAscension interface + + +Signature: + +```typescript +export interface GangMemberAscension +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agi](./bitburner.gangmemberascension.agi.md) | number | Agility multiplier gained from ascending | +| [cha](./bitburner.gangmemberascension.cha.md) | number | Charisma multiplier gained from ascending | +| [def](./bitburner.gangmemberascension.def.md) | number | Defense multiplier gained from ascending | +| [dex](./bitburner.gangmemberascension.dex.md) | number | Dexterity multiplier gained from ascending | +| [hack](./bitburner.gangmemberascension.hack.md) | number | Hacking multiplier gained from ascending | +| [respect](./bitburner.gangmemberascension.respect.md) | number | Amount of respect lost from ascending | +| [str](./bitburner.gangmemberascension.str.md) | number | Strength multiplier gained from ascending | + diff --git a/markdown/bitburner.gangmemberascension.respect.md b/markdown/bitburner.gangmemberascension.respect.md new file mode 100644 index 000000000..45b3bd042 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.respect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [respect](./bitburner.gangmemberascension.respect.md) + +## GangMemberAscension.respect property + +Amount of respect lost from ascending + +Signature: + +```typescript +respect: number; +``` diff --git a/markdown/bitburner.gangmemberascension.str.md b/markdown/bitburner.gangmemberascension.str.md new file mode 100644 index 000000000..647d4ca28 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.str.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [str](./bitburner.gangmemberascension.str.md) + +## GangMemberAscension.str property + +Strength multiplier gained from ascending + +Signature: + +```typescript +str: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.agi.md b/markdown/bitburner.gangmemberinfo.agi.md new file mode 100644 index 000000000..90deb5f11 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.agi.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [agi](./bitburner.gangmemberinfo.agi.md) + +## GangMemberInfo.agi property + +Agility skill level + +Signature: + +```typescript +agi: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.agi_asc_mult.md b/markdown/bitburner.gangmemberinfo.agi_asc_mult.md new file mode 100644 index 000000000..d3c2b2451 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.agi_asc_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [agi\_asc\_mult](./bitburner.gangmemberinfo.agi_asc_mult.md) + +## GangMemberInfo.agi\_asc\_mult property + +Agility multiplier from ascensions + +Signature: + +```typescript +agi_asc_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.agi_asc_points.md b/markdown/bitburner.gangmemberinfo.agi_asc_points.md new file mode 100644 index 000000000..d1c3d5d8b --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.agi_asc_points.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [agi\_asc\_points](./bitburner.gangmemberinfo.agi_asc_points.md) + +## GangMemberInfo.agi\_asc\_points property + +Total earned agility experience + +Signature: + +```typescript +agi_asc_points: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.agi_exp.md b/markdown/bitburner.gangmemberinfo.agi_exp.md new file mode 100644 index 000000000..c5e9be1e0 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.agi_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [agi\_exp](./bitburner.gangmemberinfo.agi_exp.md) + +## GangMemberInfo.agi\_exp property + +Current agility experience + +Signature: + +```typescript +agi_exp: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.agi_mult.md b/markdown/bitburner.gangmemberinfo.agi_mult.md new file mode 100644 index 000000000..f44c859f0 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.agi_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [agi\_mult](./bitburner.gangmemberinfo.agi_mult.md) + +## GangMemberInfo.agi\_mult property + +Agility multiplier from equipment + +Signature: + +```typescript +agi_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.augmentations.md b/markdown/bitburner.gangmemberinfo.augmentations.md new file mode 100644 index 000000000..64ae3a6f3 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.augmentations.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [augmentations](./bitburner.gangmemberinfo.augmentations.md) + +## GangMemberInfo.augmentations property + +Signature: + +```typescript +augmentations: string[]; +``` diff --git a/markdown/bitburner.gangmemberinfo.cha.md b/markdown/bitburner.gangmemberinfo.cha.md new file mode 100644 index 000000000..1f1ef5676 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.cha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [cha](./bitburner.gangmemberinfo.cha.md) + +## GangMemberInfo.cha property + +Charisma skill level + +Signature: + +```typescript +cha: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.cha_asc_mult.md b/markdown/bitburner.gangmemberinfo.cha_asc_mult.md new file mode 100644 index 000000000..fffb9ccbd --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.cha_asc_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [cha\_asc\_mult](./bitburner.gangmemberinfo.cha_asc_mult.md) + +## GangMemberInfo.cha\_asc\_mult property + +Charisma multiplier from ascensions + +Signature: + +```typescript +cha_asc_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.cha_asc_points.md b/markdown/bitburner.gangmemberinfo.cha_asc_points.md new file mode 100644 index 000000000..79a736e04 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.cha_asc_points.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [cha\_asc\_points](./bitburner.gangmemberinfo.cha_asc_points.md) + +## GangMemberInfo.cha\_asc\_points property + +Total earned charisma experience + +Signature: + +```typescript +cha_asc_points: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.cha_exp.md b/markdown/bitburner.gangmemberinfo.cha_exp.md new file mode 100644 index 000000000..77f6e0829 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.cha_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [cha\_exp](./bitburner.gangmemberinfo.cha_exp.md) + +## GangMemberInfo.cha\_exp property + +Current charisma experience + +Signature: + +```typescript +cha_exp: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.cha_mult.md b/markdown/bitburner.gangmemberinfo.cha_mult.md new file mode 100644 index 000000000..fc68dffbc --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.cha_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [cha\_mult](./bitburner.gangmemberinfo.cha_mult.md) + +## GangMemberInfo.cha\_mult property + +Charisma multiplier from equipment + +Signature: + +```typescript +cha_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.def.md b/markdown/bitburner.gangmemberinfo.def.md new file mode 100644 index 000000000..e4b278562 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.def.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [def](./bitburner.gangmemberinfo.def.md) + +## GangMemberInfo.def property + +Defense skill level + +Signature: + +```typescript +def: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.def_asc_mult.md b/markdown/bitburner.gangmemberinfo.def_asc_mult.md new file mode 100644 index 000000000..d21d98510 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.def_asc_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [def\_asc\_mult](./bitburner.gangmemberinfo.def_asc_mult.md) + +## GangMemberInfo.def\_asc\_mult property + +Defense multiplier from ascensions + +Signature: + +```typescript +def_asc_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.def_asc_points.md b/markdown/bitburner.gangmemberinfo.def_asc_points.md new file mode 100644 index 000000000..bcd5d4fe2 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.def_asc_points.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [def\_asc\_points](./bitburner.gangmemberinfo.def_asc_points.md) + +## GangMemberInfo.def\_asc\_points property + +Total earned defense experience + +Signature: + +```typescript +def_asc_points: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.def_exp.md b/markdown/bitburner.gangmemberinfo.def_exp.md new file mode 100644 index 000000000..5910078a4 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.def_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [def\_exp](./bitburner.gangmemberinfo.def_exp.md) + +## GangMemberInfo.def\_exp property + +Current defense experience + +Signature: + +```typescript +def_exp: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.def_mult.md b/markdown/bitburner.gangmemberinfo.def_mult.md new file mode 100644 index 000000000..82799b327 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.def_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [def\_mult](./bitburner.gangmemberinfo.def_mult.md) + +## GangMemberInfo.def\_mult property + +Defense multiplier from equipment + +Signature: + +```typescript +def_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.dex.md b/markdown/bitburner.gangmemberinfo.dex.md new file mode 100644 index 000000000..e610fadab --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.dex.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [dex](./bitburner.gangmemberinfo.dex.md) + +## GangMemberInfo.dex property + +Dexterity skill level + +Signature: + +```typescript +dex: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.dex_asc_mult.md b/markdown/bitburner.gangmemberinfo.dex_asc_mult.md new file mode 100644 index 000000000..79c2d80e6 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.dex_asc_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [dex\_asc\_mult](./bitburner.gangmemberinfo.dex_asc_mult.md) + +## GangMemberInfo.dex\_asc\_mult property + +Dexterity multiplier from ascensions + +Signature: + +```typescript +dex_asc_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.dex_asc_points.md b/markdown/bitburner.gangmemberinfo.dex_asc_points.md new file mode 100644 index 000000000..d66448989 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.dex_asc_points.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [dex\_asc\_points](./bitburner.gangmemberinfo.dex_asc_points.md) + +## GangMemberInfo.dex\_asc\_points property + +Total earned dexterity experience + +Signature: + +```typescript +dex_asc_points: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.dex_exp.md b/markdown/bitburner.gangmemberinfo.dex_exp.md new file mode 100644 index 000000000..ee7dafe70 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.dex_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [dex\_exp](./bitburner.gangmemberinfo.dex_exp.md) + +## GangMemberInfo.dex\_exp property + +Current dexterity experience + +Signature: + +```typescript +dex_exp: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.dex_mult.md b/markdown/bitburner.gangmemberinfo.dex_mult.md new file mode 100644 index 000000000..4cdf259b0 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.dex_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [dex\_mult](./bitburner.gangmemberinfo.dex_mult.md) + +## GangMemberInfo.dex\_mult property + +Dexterity multiplier from equipment + +Signature: + +```typescript +dex_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.earnedrespect.md b/markdown/bitburner.gangmemberinfo.earnedrespect.md new file mode 100644 index 000000000..561b98833 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.earnedrespect.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [earnedRespect](./bitburner.gangmemberinfo.earnedrespect.md) + +## GangMemberInfo.earnedRespect property + +Signature: + +```typescript +earnedRespect: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.hack.md b/markdown/bitburner.gangmemberinfo.hack.md new file mode 100644 index 000000000..8e133a4dc --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.hack.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [hack](./bitburner.gangmemberinfo.hack.md) + +## GangMemberInfo.hack property + +Hack skill level + +Signature: + +```typescript +hack: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.hack_asc_mult.md b/markdown/bitburner.gangmemberinfo.hack_asc_mult.md new file mode 100644 index 000000000..bc554e6bc --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.hack_asc_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [hack\_asc\_mult](./bitburner.gangmemberinfo.hack_asc_mult.md) + +## GangMemberInfo.hack\_asc\_mult property + +Hack multiplier from ascensions + +Signature: + +```typescript +hack_asc_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.hack_asc_points.md b/markdown/bitburner.gangmemberinfo.hack_asc_points.md new file mode 100644 index 000000000..1c825d553 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.hack_asc_points.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [hack\_asc\_points](./bitburner.gangmemberinfo.hack_asc_points.md) + +## GangMemberInfo.hack\_asc\_points property + +Total earned hack experience + +Signature: + +```typescript +hack_asc_points: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.hack_exp.md b/markdown/bitburner.gangmemberinfo.hack_exp.md new file mode 100644 index 000000000..b8ec2236b --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.hack_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [hack\_exp](./bitburner.gangmemberinfo.hack_exp.md) + +## GangMemberInfo.hack\_exp property + +Current hack experience + +Signature: + +```typescript +hack_exp: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.hack_mult.md b/markdown/bitburner.gangmemberinfo.hack_mult.md new file mode 100644 index 000000000..f30e70624 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.hack_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [hack\_mult](./bitburner.gangmemberinfo.hack_mult.md) + +## GangMemberInfo.hack\_mult property + +Hack multiplier from equipment + +Signature: + +```typescript +hack_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.md b/markdown/bitburner.gangmemberinfo.md new file mode 100644 index 000000000..51afe2946 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) + +## GangMemberInfo interface + + +Signature: + +```typescript +export interface GangMemberInfo +``` + +## Properties + +| Property | 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 earned agility experience | +| [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\[\] | | +| [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 earned charisma experience | +| [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 earned defense experience | +| [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 earned dexterity experience | +| [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 | | +| [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 earned hack experience | +| [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 | | +| [name](./bitburner.gangmemberinfo.name.md) | string | Name of the gang member | +| [respectGain](./bitburner.gangmemberinfo.respectgain.md) | number | | +| [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 earned strength experience | +| [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\[\] | | +| [wantedLevelGain](./bitburner.gangmemberinfo.wantedlevelgain.md) | number | | + diff --git a/markdown/bitburner.gangmemberinfo.moneygain.md b/markdown/bitburner.gangmemberinfo.moneygain.md new file mode 100644 index 000000000..98b42f676 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.moneygain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [moneyGain](./bitburner.gangmemberinfo.moneygain.md) + +## GangMemberInfo.moneyGain property + +Signature: + +```typescript +moneyGain: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.name.md b/markdown/bitburner.gangmemberinfo.name.md new file mode 100644 index 000000000..f98233e8a --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [name](./bitburner.gangmemberinfo.name.md) + +## GangMemberInfo.name property + +Name of the gang member + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.gangmemberinfo.respectgain.md b/markdown/bitburner.gangmemberinfo.respectgain.md new file mode 100644 index 000000000..55654de17 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.respectgain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [respectGain](./bitburner.gangmemberinfo.respectgain.md) + +## GangMemberInfo.respectGain property + +Signature: + +```typescript +respectGain: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.str.md b/markdown/bitburner.gangmemberinfo.str.md new file mode 100644 index 000000000..ad8745274 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.str.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [str](./bitburner.gangmemberinfo.str.md) + +## GangMemberInfo.str property + +Strength skill level + +Signature: + +```typescript +str: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.str_asc_mult.md b/markdown/bitburner.gangmemberinfo.str_asc_mult.md new file mode 100644 index 000000000..b0f512cac --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.str_asc_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [str\_asc\_mult](./bitburner.gangmemberinfo.str_asc_mult.md) + +## GangMemberInfo.str\_asc\_mult property + +Strength multiplier from ascensions + +Signature: + +```typescript +str_asc_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.str_asc_points.md b/markdown/bitburner.gangmemberinfo.str_asc_points.md new file mode 100644 index 000000000..9255896bf --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.str_asc_points.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [str\_asc\_points](./bitburner.gangmemberinfo.str_asc_points.md) + +## GangMemberInfo.str\_asc\_points property + +Total earned strength experience + +Signature: + +```typescript +str_asc_points: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.str_exp.md b/markdown/bitburner.gangmemberinfo.str_exp.md new file mode 100644 index 000000000..5d2480a94 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.str_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [str\_exp](./bitburner.gangmemberinfo.str_exp.md) + +## GangMemberInfo.str\_exp property + +Current strength experience + +Signature: + +```typescript +str_exp: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.str_mult.md b/markdown/bitburner.gangmemberinfo.str_mult.md new file mode 100644 index 000000000..dffeb8b13 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.str_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [str\_mult](./bitburner.gangmemberinfo.str_mult.md) + +## GangMemberInfo.str\_mult property + +Strength multiplier from equipment + +Signature: + +```typescript +str_mult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.task.md b/markdown/bitburner.gangmemberinfo.task.md new file mode 100644 index 000000000..ff967194a --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.task.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [task](./bitburner.gangmemberinfo.task.md) + +## GangMemberInfo.task property + +Currently assigned task + +Signature: + +```typescript +task: string; +``` diff --git a/markdown/bitburner.gangmemberinfo.upgrades.md b/markdown/bitburner.gangmemberinfo.upgrades.md new file mode 100644 index 000000000..c0296de6d --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.upgrades.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [upgrades](./bitburner.gangmemberinfo.upgrades.md) + +## GangMemberInfo.upgrades property + +Signature: + +```typescript +upgrades: string[]; +``` diff --git a/markdown/bitburner.gangmemberinfo.wantedlevelgain.md b/markdown/bitburner.gangmemberinfo.wantedlevelgain.md new file mode 100644 index 000000000..d259fa0dd --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.wantedlevelgain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [wantedLevelGain](./bitburner.gangmemberinfo.wantedlevelgain.md) + +## GangMemberInfo.wantedLevelGain property + +Signature: + +```typescript +wantedLevelGain: number; +``` diff --git a/markdown/bitburner.gangotherinfo.md b/markdown/bitburner.gangotherinfo.md new file mode 100644 index 000000000..add42849b --- /dev/null +++ b/markdown/bitburner.gangotherinfo.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangOtherInfo](./bitburner.gangotherinfo.md) + +## GangOtherInfo interface + + +Signature: + +```typescript +export interface GangOtherInfo +``` diff --git a/markdown/bitburner.gangotherinfoobject.md b/markdown/bitburner.gangotherinfoobject.md new file mode 100644 index 000000000..a5a262017 --- /dev/null +++ b/markdown/bitburner.gangotherinfoobject.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) + +## GangOtherInfoObject interface + + +Signature: + +```typescript +export interface GangOtherInfoObject +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [power](./bitburner.gangotherinfoobject.power.md) | number | Gang power | +| [territory](./bitburner.gangotherinfoobject.territory.md) | number | Gang territory, in decimal form | + diff --git a/markdown/bitburner.gangotherinfoobject.power.md b/markdown/bitburner.gangotherinfoobject.power.md new file mode 100644 index 000000000..58986c561 --- /dev/null +++ b/markdown/bitburner.gangotherinfoobject.power.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) > [power](./bitburner.gangotherinfoobject.power.md) + +## GangOtherInfoObject.power property + +Gang power + +Signature: + +```typescript +power: number; +``` diff --git a/markdown/bitburner.gangotherinfoobject.territory.md b/markdown/bitburner.gangotherinfoobject.territory.md new file mode 100644 index 000000000..9314c4fc4 --- /dev/null +++ b/markdown/bitburner.gangotherinfoobject.territory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) > [territory](./bitburner.gangotherinfoobject.territory.md) + +## GangOtherInfoObject.territory property + +Gang territory, in decimal form + +Signature: + +```typescript +territory: number; +``` diff --git a/markdown/bitburner.gangtaskstats.agiweight.md b/markdown/bitburner.gangtaskstats.agiweight.md new file mode 100644 index 000000000..422d3db6c --- /dev/null +++ b/markdown/bitburner.gangtaskstats.agiweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [agiWeight](./bitburner.gangtaskstats.agiweight.md) + +## GangTaskStats.agiWeight property + +Agility skill impact on task scaling + +Signature: + +```typescript +agiWeight: number; +``` diff --git a/markdown/bitburner.gangtaskstats.basemoney.md b/markdown/bitburner.gangtaskstats.basemoney.md new file mode 100644 index 000000000..95e86a01a --- /dev/null +++ b/markdown/bitburner.gangtaskstats.basemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [baseMoney](./bitburner.gangtaskstats.basemoney.md) + +## GangTaskStats.baseMoney property + +Base money earned + +Signature: + +```typescript +baseMoney: number; +``` diff --git a/markdown/bitburner.gangtaskstats.baserespect.md b/markdown/bitburner.gangtaskstats.baserespect.md new file mode 100644 index 000000000..4eebb322f --- /dev/null +++ b/markdown/bitburner.gangtaskstats.baserespect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [baseRespect](./bitburner.gangtaskstats.baserespect.md) + +## GangTaskStats.baseRespect property + +Base respect earned + +Signature: + +```typescript +baseRespect: number; +``` diff --git a/markdown/bitburner.gangtaskstats.basewanted.md b/markdown/bitburner.gangtaskstats.basewanted.md new file mode 100644 index 000000000..789a2baf8 --- /dev/null +++ b/markdown/bitburner.gangtaskstats.basewanted.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [baseWanted](./bitburner.gangtaskstats.basewanted.md) + +## GangTaskStats.baseWanted property + +Base wanted earned + +Signature: + +```typescript +baseWanted: number; +``` diff --git a/markdown/bitburner.gangtaskstats.chaweight.md b/markdown/bitburner.gangtaskstats.chaweight.md new file mode 100644 index 000000000..760e96a50 --- /dev/null +++ b/markdown/bitburner.gangtaskstats.chaweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [chaWeight](./bitburner.gangtaskstats.chaweight.md) + +## GangTaskStats.chaWeight property + +Charisma skill impact on task scaling + +Signature: + +```typescript +chaWeight: number; +``` diff --git a/markdown/bitburner.gangtaskstats.defweight.md b/markdown/bitburner.gangtaskstats.defweight.md new file mode 100644 index 000000000..ed2399bba --- /dev/null +++ b/markdown/bitburner.gangtaskstats.defweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [defWeight](./bitburner.gangtaskstats.defweight.md) + +## GangTaskStats.defWeight property + +Defense skill impact on task scaling + +Signature: + +```typescript +defWeight: number; +``` diff --git a/markdown/bitburner.gangtaskstats.desc.md b/markdown/bitburner.gangtaskstats.desc.md new file mode 100644 index 000000000..972036267 --- /dev/null +++ b/markdown/bitburner.gangtaskstats.desc.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [desc](./bitburner.gangtaskstats.desc.md) + +## GangTaskStats.desc property + +Task Description + +Signature: + +```typescript +desc: string; +``` diff --git a/markdown/bitburner.gangtaskstats.dexweight.md b/markdown/bitburner.gangtaskstats.dexweight.md new file mode 100644 index 000000000..95eb529dd --- /dev/null +++ b/markdown/bitburner.gangtaskstats.dexweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [dexWeight](./bitburner.gangtaskstats.dexweight.md) + +## GangTaskStats.dexWeight property + +Dexterity skill impact on task scaling + +Signature: + +```typescript +dexWeight: number; +``` diff --git a/markdown/bitburner.gangtaskstats.difficulty.md b/markdown/bitburner.gangtaskstats.difficulty.md new file mode 100644 index 000000000..ae6f83cca --- /dev/null +++ b/markdown/bitburner.gangtaskstats.difficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [difficulty](./bitburner.gangtaskstats.difficulty.md) + +## GangTaskStats.difficulty property + +Number representing the difficulty of the task + +Signature: + +```typescript +difficulty: number; +``` diff --git a/markdown/bitburner.gangtaskstats.hackweight.md b/markdown/bitburner.gangtaskstats.hackweight.md new file mode 100644 index 000000000..2c1e81c26 --- /dev/null +++ b/markdown/bitburner.gangtaskstats.hackweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [hackWeight](./bitburner.gangtaskstats.hackweight.md) + +## GangTaskStats.hackWeight property + +Hacking skill impact on task scaling + +Signature: + +```typescript +hackWeight: number; +``` diff --git a/markdown/bitburner.gangtaskstats.iscombat.md b/markdown/bitburner.gangtaskstats.iscombat.md new file mode 100644 index 000000000..b32351902 --- /dev/null +++ b/markdown/bitburner.gangtaskstats.iscombat.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [isCombat](./bitburner.gangtaskstats.iscombat.md) + +## GangTaskStats.isCombat property + +Is a task of a combat gang + +Signature: + +```typescript +isCombat: boolean; +``` diff --git a/markdown/bitburner.gangtaskstats.ishacking.md b/markdown/bitburner.gangtaskstats.ishacking.md new file mode 100644 index 000000000..dcc183b74 --- /dev/null +++ b/markdown/bitburner.gangtaskstats.ishacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [isHacking](./bitburner.gangtaskstats.ishacking.md) + +## GangTaskStats.isHacking property + +Is a task of a hacking gang + +Signature: + +```typescript +isHacking: boolean; +``` diff --git a/markdown/bitburner.gangtaskstats.md b/markdown/bitburner.gangtaskstats.md new file mode 100644 index 000000000..825940c02 --- /dev/null +++ b/markdown/bitburner.gangtaskstats.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) + +## GangTaskStats interface + +Object representing data representing a gang member task. + +Signature: + +```typescript +export interface GangTaskStats +``` + +## Properties + +| Property | 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.gangtaskstats.name.md b/markdown/bitburner.gangtaskstats.name.md new file mode 100644 index 000000000..51cfbd6a5 --- /dev/null +++ b/markdown/bitburner.gangtaskstats.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [name](./bitburner.gangtaskstats.name.md) + +## GangTaskStats.name property + +Task name + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.gangtaskstats.strweight.md b/markdown/bitburner.gangtaskstats.strweight.md new file mode 100644 index 000000000..5c3b92f7f --- /dev/null +++ b/markdown/bitburner.gangtaskstats.strweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [strWeight](./bitburner.gangtaskstats.strweight.md) + +## GangTaskStats.strWeight property + +Strength skill impact on task scaling + +Signature: + +```typescript +strWeight: number; +``` diff --git a/markdown/bitburner.gangtaskstats.territory.md b/markdown/bitburner.gangtaskstats.territory.md new file mode 100644 index 000000000..65737c79f --- /dev/null +++ b/markdown/bitburner.gangtaskstats.territory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTaskStats](./bitburner.gangtaskstats.md) > [territory](./bitburner.gangtaskstats.territory.md) + +## GangTaskStats.territory property + +Territory impact on task scaling + +Signature: + +```typescript +territory: GangTerritory; +``` diff --git a/markdown/bitburner.gangterritory.md b/markdown/bitburner.gangterritory.md new file mode 100644 index 000000000..c42e62060 --- /dev/null +++ b/markdown/bitburner.gangterritory.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTerritory](./bitburner.gangterritory.md) + +## GangTerritory interface + + +Signature: + +```typescript +export interface GangTerritory +``` + +## Properties + +| Property | 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.gangterritory.money.md b/markdown/bitburner.gangterritory.money.md new file mode 100644 index 000000000..9648f795f --- /dev/null +++ b/markdown/bitburner.gangterritory.money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTerritory](./bitburner.gangterritory.md) > [money](./bitburner.gangterritory.money.md) + +## GangTerritory.money property + +Money gain impact on task scaling + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.gangterritory.respect.md b/markdown/bitburner.gangterritory.respect.md new file mode 100644 index 000000000..ebbe5fac6 --- /dev/null +++ b/markdown/bitburner.gangterritory.respect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTerritory](./bitburner.gangterritory.md) > [respect](./bitburner.gangterritory.respect.md) + +## GangTerritory.respect property + +Respect gain impact on task scaling + +Signature: + +```typescript +respect: number; +``` diff --git a/markdown/bitburner.gangterritory.wanted.md b/markdown/bitburner.gangterritory.wanted.md new file mode 100644 index 000000000..5e6c4f12e --- /dev/null +++ b/markdown/bitburner.gangterritory.wanted.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTerritory](./bitburner.gangterritory.md) > [wanted](./bitburner.gangterritory.wanted.md) + +## GangTerritory.wanted property + +Wanted gain impact on task scaling + +Signature: + +```typescript +wanted: number; +``` diff --git a/markdown/bitburner.grafting.getaugmentationgraftprice.md b/markdown/bitburner.grafting.getaugmentationgraftprice.md new file mode 100644 index 000000000..1766e60d7 --- /dev/null +++ b/markdown/bitburner.grafting.getaugmentationgraftprice.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Grafting](./bitburner.grafting.md) > [getAugmentationGraftPrice](./bitburner.grafting.getaugmentationgraftprice.md) + +## Grafting.getAugmentationGraftPrice() method + +Retrieve the grafting cost of an aug. + +Signature: + +```typescript +getAugmentationGraftPrice(augName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | string | Name of the aug to check the price of. Must be an exact match. | + +Returns: + +number + +The cost required to graft the named augmentation. + +## Exceptions + +Will error if an invalid Augmentation name is provided. + +## Remarks + +RAM cost: 3.75 GB + diff --git a/markdown/bitburner.grafting.getaugmentationgrafttime.md b/markdown/bitburner.grafting.getaugmentationgrafttime.md new file mode 100644 index 000000000..2e4488d92 --- /dev/null +++ b/markdown/bitburner.grafting.getaugmentationgrafttime.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Grafting](./bitburner.grafting.md) > [getAugmentationGraftTime](./bitburner.grafting.getaugmentationgrafttime.md) + +## Grafting.getAugmentationGraftTime() method + +Retrieves the time required to graft an aug. + +Signature: + +```typescript +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. | + +Returns: + +number + +The time required, in millis, to graft the named augmentation. + +## Exceptions + +Will error if an invalid Augmentation name is provided. + +## Remarks + +RAM cost: 3.75 GB + diff --git a/markdown/bitburner.grafting.getgraftableaugmentations.md b/markdown/bitburner.grafting.getgraftableaugmentations.md new file mode 100644 index 000000000..6bb0af8d9 --- /dev/null +++ b/markdown/bitburner.grafting.getgraftableaugmentations.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Grafting](./bitburner.grafting.md) > [getGraftableAugmentations](./bitburner.grafting.getgraftableaugmentations.md) + +## Grafting.getGraftableAugmentations() method + +Retrieves a list of Augmentations that can be grafted. + +Signature: + +```typescript +getGraftableAugmentations(): string[]; +``` +Returns: + +string\[\] + +An array of graftable Augmentations. + +## Remarks + +RAM cost: 5 GB + +Note that this function returns a list of currently graftable Augmentations, based off of the Augmentations that you already own. + diff --git a/markdown/bitburner.grafting.graftaugmentation.md b/markdown/bitburner.grafting.graftaugmentation.md new file mode 100644 index 000000000..8d44d0185 --- /dev/null +++ b/markdown/bitburner.grafting.graftaugmentation.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Grafting](./bitburner.grafting.md) > [graftAugmentation](./bitburner.grafting.graftaugmentation.md) + +## Grafting.graftAugmentation() method + +Begins grafting the named aug. You must be in New Tokyo to use this. + +Signature: + +```typescript +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 | Acquire player focus on this Augmentation grafting. Optional. Defaults to true. | + +Returns: + +boolean + +True if the aug successfully began grafting, false otherwise (e.g. not enough money, or invalid Augmentation name provided). + +## Exceptions + +Will error if called while you are not in New Tokyo. + +## Remarks + +RAM cost: 7.5 GB + diff --git a/markdown/bitburner.grafting.md b/markdown/bitburner.grafting.md new file mode 100644 index 000000000..ddb90014c --- /dev/null +++ b/markdown/bitburner.grafting.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Grafting](./bitburner.grafting.md) + +## Grafting interface + +Grafting API + +Signature: + +```typescript +export interface Grafting +``` + +## Remarks + +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. | +| [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. | + diff --git a/markdown/bitburner.hackingformulas.growpercent.md b/markdown/bitburner.hackingformulas.growpercent.md new file mode 100644 index 000000000..99c3b71bf --- /dev/null +++ b/markdown/bitburner.hackingformulas.growpercent.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) > [growPercent](./bitburner.hackingformulas.growpercent.md) + +## HackingFormulas.growPercent() method + +Calculate the percent a server would grow to. (Ex: 3.0 would would grow the server to 300% of its current value.) + +Signature: + +```typescript +growPercent(server: Server, threads: number, player: Player, cores?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | +| threads | number | Amount of thread. | +| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | +| cores | number | Number of cores on the computer that will execute grow. | + +Returns: + +number + +The calculated grow percent. + diff --git a/markdown/bitburner.hackingformulas.growtime.md b/markdown/bitburner.hackingformulas.growtime.md new file mode 100644 index 000000000..8d9f9c2b0 --- /dev/null +++ b/markdown/bitburner.hackingformulas.growtime.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) > [growTime](./bitburner.hackingformulas.growtime.md) + +## HackingFormulas.growTime() method + +Calculate grow time. + +Signature: + +```typescript +growTime(server: Server, player: Player): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | +| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | + +Returns: + +number + +The calculated grow time. + diff --git a/markdown/bitburner.hackingformulas.hackchance.md b/markdown/bitburner.hackingformulas.hackchance.md new file mode 100644 index 000000000..92c1a27b1 --- /dev/null +++ b/markdown/bitburner.hackingformulas.hackchance.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) > [hackChance](./bitburner.hackingformulas.hackchance.md) + +## HackingFormulas.hackChance() method + +Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.) + +Signature: + +```typescript +hackChance(server: Server, player: Player): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | +| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | + +Returns: + +number + +The calculated hack chance. + diff --git a/markdown/bitburner.hackingformulas.hackexp.md b/markdown/bitburner.hackingformulas.hackexp.md new file mode 100644 index 000000000..5992a5f94 --- /dev/null +++ b/markdown/bitburner.hackingformulas.hackexp.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) > [hackExp](./bitburner.hackingformulas.hackexp.md) + +## HackingFormulas.hackExp() method + +Calculate hack exp for one thread. + +Signature: + +```typescript +hackExp(server: Server, player: Player): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | +| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | + +Returns: + +number + +The calculated hack exp. + +## Remarks + +Multiply by thread to get total exp + diff --git a/markdown/bitburner.hackingformulas.hackpercent.md b/markdown/bitburner.hackingformulas.hackpercent.md new file mode 100644 index 000000000..400621104 --- /dev/null +++ b/markdown/bitburner.hackingformulas.hackpercent.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) > [hackPercent](./bitburner.hackingformulas.hackpercent.md) + +## HackingFormulas.hackPercent() method + +Calculate hack percent for one thread. (Ex: 0.25 would steal 25% of the server's current value.) + +Signature: + +```typescript +hackPercent(server: Server, player: Player): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | +| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | + +Returns: + +number + +The calculated hack percent. + +## Remarks + +Multiply by thread to get total percent hacked. + diff --git a/markdown/bitburner.hackingformulas.hacktime.md b/markdown/bitburner.hackingformulas.hacktime.md new file mode 100644 index 000000000..b1bcd35e0 --- /dev/null +++ b/markdown/bitburner.hackingformulas.hacktime.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) > [hackTime](./bitburner.hackingformulas.hacktime.md) + +## HackingFormulas.hackTime() method + +Calculate hack time. + +Signature: + +```typescript +hackTime(server: Server, player: Player): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | +| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | + +Returns: + +number + +The calculated hack time. + diff --git a/markdown/bitburner.hackingformulas.md b/markdown/bitburner.hackingformulas.md new file mode 100644 index 000000000..5e2c23b7b --- /dev/null +++ b/markdown/bitburner.hackingformulas.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) + +## HackingFormulas interface + +Hacking formulas + +Signature: + +```typescript +interface HackingFormulas +``` + +## Methods + +| Method | Description | +| --- | --- | +| [growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) | Calculate the percent a server would grow to. (Ex: 3.0 would would grow the server to 300% of its current value.) | +| [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 new file mode 100644 index 000000000..78190bb40 --- /dev/null +++ b/markdown/bitburner.hackingformulas.weakentime.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingFormulas](./bitburner.hackingformulas.md) > [weakenTime](./bitburner.hackingformulas.weakentime.md) + +## HackingFormulas.weakenTime() method + +Calculate weaken time. + +Signature: + +```typescript +weakenTime(server: Server, player: Player): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| server | [Server](./bitburner.server.md) | Server info from [getServer](./bitburner.ns.getserver.md) | +| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | + +Returns: + +number + +The calculated weaken time. + diff --git a/markdown/bitburner.hackingmultipliers.chance.md b/markdown/bitburner.hackingmultipliers.chance.md new file mode 100644 index 000000000..9f7b5c2b5 --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.chance.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) > [chance](./bitburner.hackingmultipliers.chance.md) + +## HackingMultipliers.chance property + +Player's hacking chance multiplier. + +Signature: + +```typescript +chance: number; +``` diff --git a/markdown/bitburner.hackingmultipliers.growth.md b/markdown/bitburner.hackingmultipliers.growth.md new file mode 100644 index 000000000..43ad29e2d --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.growth.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) > [growth](./bitburner.hackingmultipliers.growth.md) + +## HackingMultipliers.growth property + +Player's hacking growth multiplier + +Signature: + +```typescript +growth: number; +``` diff --git a/markdown/bitburner.hackingmultipliers.md b/markdown/bitburner.hackingmultipliers.md new file mode 100644 index 000000000..425caecc8 --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) + +## HackingMultipliers interface + +Hack related multipliers. + +Signature: + +```typescript +export interface HackingMultipliers +``` + +## Properties + +| Property | 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.hackingmultipliers.money.md b/markdown/bitburner.hackingmultipliers.money.md new file mode 100644 index 000000000..e578aaa14 --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) > [money](./bitburner.hackingmultipliers.money.md) + +## HackingMultipliers.money property + +Player's hacking money stolen multiplier. + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.hackingmultipliers.speed.md b/markdown/bitburner.hackingmultipliers.speed.md new file mode 100644 index 000000000..646bec789 --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.speed.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) > [speed](./bitburner.hackingmultipliers.speed.md) + +## HackingMultipliers.speed property + +Player's hacking speed multiplier. + +Signature: + +```typescript +speed: number; +``` diff --git a/markdown/bitburner.hacknet.getcacheupgradecost.md b/markdown/bitburner.hacknet.getcacheupgradecost.md new file mode 100644 index 000000000..6a9d5055c --- /dev/null +++ b/markdown/bitburner.hacknet.getcacheupgradecost.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getCacheUpgradeCost](./bitburner.hacknet.getcacheupgradecost.md) + +## Hacknet.getCacheUpgradeCost() method + +Calculate the cost of upgrading hacknet node cache. + +Signature: + +```typescript +getCacheUpgradeCost(index: number, n: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of times to upgrade cache. Must be positive. Rounded to nearest integer. | + +Returns: + +number + +Cost of upgrading the specified Hacknet Node's cache. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Returns the cost of upgrading the cache level of the specified Hacknet Server by n. + +If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. + diff --git a/markdown/bitburner.hacknet.getcoreupgradecost.md b/markdown/bitburner.hacknet.getcoreupgradecost.md new file mode 100644 index 000000000..47447d33c --- /dev/null +++ b/markdown/bitburner.hacknet.getcoreupgradecost.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getCoreUpgradeCost](./bitburner.hacknet.getcoreupgradecost.md) + +## Hacknet.getCoreUpgradeCost() method + +Calculate the cost of upgrading hacknet node cores. + +Signature: + +```typescript +getCoreUpgradeCost(index: number, n: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of times to upgrade cores. Must be positive. Rounded to nearest integer. | + +Returns: + +number + +Cost of upgrading the specified Hacknet Node's number of cores. + +## Remarks + +RAM cost: 0 GB + +Returns the cost of upgrading the number of cores of the specified Hacknet Node by n. + +If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. + diff --git a/markdown/bitburner.hacknet.gethashupgradelevel.md b/markdown/bitburner.hacknet.gethashupgradelevel.md new file mode 100644 index 000000000..db2237ae2 --- /dev/null +++ b/markdown/bitburner.hacknet.gethashupgradelevel.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getHashUpgradeLevel](./bitburner.hacknet.gethashupgradelevel.md) + +## Hacknet.getHashUpgradeLevel() method + +Get the level of a hash upgrade. + +Signature: + +```typescript +getHashUpgradeLevel(upgName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgName | string | | + +Returns: + +number + +Level of the upgrade. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + diff --git a/markdown/bitburner.hacknet.gethashupgrades.md b/markdown/bitburner.hacknet.gethashupgrades.md new file mode 100644 index 000000000..b0ef78eb1 --- /dev/null +++ b/markdown/bitburner.hacknet.gethashupgrades.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getHashUpgrades](./bitburner.hacknet.gethashupgrades.md) + +## Hacknet.getHashUpgrades() method + +Get the list of hash upgrades + +Signature: + +```typescript +getHashUpgrades(): string[]; +``` +Returns: + +string\[\] + +An array containing the available upgrades + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Returns the list of all available hash upgrades that can be used in the spendHashes function. + +## Example 1 + + +```ts +// NS1: +var upgrades = hacknet.getHashUpgrades(); // ["Sell for Money","Sell for Corporation Funds",...] +``` + +## Example 2 + + +```ts +// NS2: +const upgrades = ns.hacknet.getHashUpgrades(); // ["Sell for Money","Sell for Corporation Funds",...] +``` + diff --git a/markdown/bitburner.hacknet.getlevelupgradecost.md b/markdown/bitburner.hacknet.getlevelupgradecost.md new file mode 100644 index 000000000..13f8d07fa --- /dev/null +++ b/markdown/bitburner.hacknet.getlevelupgradecost.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getLevelUpgradeCost](./bitburner.hacknet.getlevelupgradecost.md) + +## Hacknet.getLevelUpgradeCost() method + +Calculate the cost of upgrading hacknet node levels. + +Signature: + +```typescript +getLevelUpgradeCost(index: number, n: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of levels to upgrade. Must be positive. Rounded to nearest integer. | + +Returns: + +number + +Cost of upgrading the specified Hacknet Node. + +## Remarks + +RAM cost: 0 GB + +Returns the cost of upgrading the specified Hacknet Node by n levels. + +If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. + diff --git a/markdown/bitburner.hacknet.getnodestats.md b/markdown/bitburner.hacknet.getnodestats.md new file mode 100644 index 000000000..117d9d41c --- /dev/null +++ b/markdown/bitburner.hacknet.getnodestats.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getNodeStats](./bitburner.hacknet.getnodestats.md) + +## Hacknet.getNodeStats() method + +Get the stats of a hacknet node. + +Signature: + +```typescript +getNodeStats(index: number): NodeStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node | + +Returns: + +[NodeStats](./bitburner.nodestats.md) + +Object containing a variety of stats about the specified Hacknet Node. + +## Remarks + +RAM cost: 0 GB + +Returns an object containing a variety of stats about the specified Hacknet Node. + +Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates. + diff --git a/markdown/bitburner.hacknet.getpurchasenodecost.md b/markdown/bitburner.hacknet.getpurchasenodecost.md new file mode 100644 index 000000000..a1d1908d1 --- /dev/null +++ b/markdown/bitburner.hacknet.getpurchasenodecost.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getPurchaseNodeCost](./bitburner.hacknet.getpurchasenodecost.md) + +## Hacknet.getPurchaseNodeCost() method + +Get the price of the next hacknet node. + +Signature: + +```typescript +getPurchaseNodeCost(): number; +``` +Returns: + +number + +Cost of purchasing a new Hacknet Node. + +## Remarks + +RAM cost: 0 GB + +Returns the cost of purchasing a new Hacknet Node. + diff --git a/markdown/bitburner.hacknet.getramupgradecost.md b/markdown/bitburner.hacknet.getramupgradecost.md new file mode 100644 index 000000000..7d449d345 --- /dev/null +++ b/markdown/bitburner.hacknet.getramupgradecost.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getRamUpgradeCost](./bitburner.hacknet.getramupgradecost.md) + +## Hacknet.getRamUpgradeCost() method + +Calculate the cost of upgrading hacknet node RAM. + +Signature: + +```typescript +getRamUpgradeCost(index: number, n: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. | + +Returns: + +number + +Cost of upgrading the specified Hacknet Node's RAM. + +## Remarks + +RAM cost: 0 GB + +Returns the cost of upgrading the RAM of the specified Hacknet Node n times. + +If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node already has max RAM, then Infinity is returned. + diff --git a/markdown/bitburner.hacknet.getstudymult.md b/markdown/bitburner.hacknet.getstudymult.md new file mode 100644 index 000000000..509dfe9a3 --- /dev/null +++ b/markdown/bitburner.hacknet.getstudymult.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getStudyMult](./bitburner.hacknet.getstudymult.md) + +## Hacknet.getStudyMult() method + +Get the multiplier to study. + +Signature: + +```typescript +getStudyMult(): number; +``` +Returns: + +number + +Multiplier. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + diff --git a/markdown/bitburner.hacknet.gettrainingmult.md b/markdown/bitburner.hacknet.gettrainingmult.md new file mode 100644 index 000000000..8f657f402 --- /dev/null +++ b/markdown/bitburner.hacknet.gettrainingmult.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [getTrainingMult](./bitburner.hacknet.gettrainingmult.md) + +## Hacknet.getTrainingMult() method + +Get the multiplier to training. + +Signature: + +```typescript +getTrainingMult(): number; +``` +Returns: + +number + +Multiplier. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + diff --git a/markdown/bitburner.hacknet.hashcapacity.md b/markdown/bitburner.hacknet.hashcapacity.md new file mode 100644 index 000000000..833a621f9 --- /dev/null +++ b/markdown/bitburner.hacknet.hashcapacity.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [hashCapacity](./bitburner.hacknet.hashcapacity.md) + +## Hacknet.hashCapacity() method + +Get the maximum number of hashes you can store. + +Signature: + +```typescript +hashCapacity(): number; +``` +Returns: + +number + +Number of hashes you can store. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Returns the number of hashes you can store. + diff --git a/markdown/bitburner.hacknet.hashcost.md b/markdown/bitburner.hacknet.hashcost.md new file mode 100644 index 000000000..fcf2de983 --- /dev/null +++ b/markdown/bitburner.hacknet.hashcost.md @@ -0,0 +1,57 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [hashCost](./bitburner.hacknet.hashcost.md) + +## Hacknet.hashCost() method + +Get the cost of a hash upgrade. + +Signature: + +```typescript +hashCost(upgName: string, count?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgName | string | Name of the upgrade of Hacknet Node. | +| count | number | Number of upgrades to buy at once. Defaults to 1 if not specified. | + +Returns: + +number + +Number of hashes required for the specified upgrade. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match. + +## Example 1 + + +```ts +// NS1: +var upgradeName = "Sell for Corporation Funds"; +if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) { + hacknet.spendHashes(upgradeName); +} +``` + +## Example 2 + + +```ts +// NS2: +const upgradeName = "Sell for Corporation Funds"; +if (ns.hacknet.numHashes() > ns.hacknet.hashCost(upgradeName)) { + ns.hacknet.spendHashes(upgradeName); +} +``` + diff --git a/markdown/bitburner.hacknet.maxnumnodes.md b/markdown/bitburner.hacknet.maxnumnodes.md new file mode 100644 index 000000000..dfb249f5d --- /dev/null +++ b/markdown/bitburner.hacknet.maxnumnodes.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [maxNumNodes](./bitburner.hacknet.maxnumnodes.md) + +## Hacknet.maxNumNodes() method + +Get the maximum number of hacknet nodes. + +Signature: + +```typescript +maxNumNodes(): number; +``` +Returns: + +number + +Maximum number of hacknet nodes. + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.hacknet.md b/markdown/bitburner.hacknet.md new file mode 100644 index 000000000..ccff15191 --- /dev/null +++ b/markdown/bitburner.hacknet.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) + +## Hacknet interface + +Hacknet API + +Signature: + +```typescript +export interface Hacknet +``` + +## Remarks + +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. | + diff --git a/markdown/bitburner.hacknet.numhashes.md b/markdown/bitburner.hacknet.numhashes.md new file mode 100644 index 000000000..9c20440b2 --- /dev/null +++ b/markdown/bitburner.hacknet.numhashes.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [numHashes](./bitburner.hacknet.numhashes.md) + +## Hacknet.numHashes() method + +Get the total number of hashes stored. + +Signature: + +```typescript +numHashes(): number; +``` +Returns: + +number + +Number of hashes you have. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Returns the number of hashes you have. + diff --git a/markdown/bitburner.hacknet.numnodes.md b/markdown/bitburner.hacknet.numnodes.md new file mode 100644 index 000000000..420f1d83a --- /dev/null +++ b/markdown/bitburner.hacknet.numnodes.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [numNodes](./bitburner.hacknet.numnodes.md) + +## Hacknet.numNodes() method + +Get the number of hacknet nodes you own. + +Signature: + +```typescript +numNodes(): number; +``` +Returns: + +number + +Number of hacknet nodes. + +## Remarks + +RAM cost: 0 GB + +Returns the number of Hacknet Nodes you own. + diff --git a/markdown/bitburner.hacknet.purchasenode.md b/markdown/bitburner.hacknet.purchasenode.md new file mode 100644 index 000000000..762a8845e --- /dev/null +++ b/markdown/bitburner.hacknet.purchasenode.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [purchaseNode](./bitburner.hacknet.purchasenode.md) + +## Hacknet.purchaseNode() method + +Purchase a new hacknet node. + +Signature: + +```typescript +purchaseNode(): number; +``` +Returns: + +number + +The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1. + +## Remarks + +RAM cost: 0 GB + +Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named `hacknet-node-4` will have an index of 4). + +If the player cannot afford to purchase a new Hacknet Node then the function will return -1. + diff --git a/markdown/bitburner.hacknet.spendhashes.md b/markdown/bitburner.hacknet.spendhashes.md new file mode 100644 index 000000000..c71f063a4 --- /dev/null +++ b/markdown/bitburner.hacknet.spendhashes.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [spendHashes](./bitburner.hacknet.spendhashes.md) + +## Hacknet.spendHashes() method + +Purchase a hash upgrade. + +Signature: + +```typescript +spendHashes(upgName: string, upgTarget?: string, count?: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgName | string | Name of the upgrade of Hacknet Node. | +| upgTarget | string | Object to which upgrade applies. Required for certain upgrades. | +| count | number | Number of upgrades to buy at once. 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: + +boolean + +True if the upgrade is successfully purchased, and false otherwise. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise. + +The name of the upgrade must be an exact match. The `upgTarget` argument is used for upgrades such as `Reduce Minimum Security`, which applies to a specific server. In this case, the `upgTarget` argument must be the hostname of the server. + +## Example 1 + + +```ts +// NS1: +hacknet.spendHashes("Sell for Corporation Funds"); +hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); +``` + +## Example 2 + + +```ts +NS2: +ns.hacknet.spendHashes("Sell for Corporation Funds"); +ns.hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); +``` + diff --git a/markdown/bitburner.hacknet.upgradecache.md b/markdown/bitburner.hacknet.upgradecache.md new file mode 100644 index 000000000..df6febe57 --- /dev/null +++ b/markdown/bitburner.hacknet.upgradecache.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [upgradeCache](./bitburner.hacknet.upgradecache.md) + +## Hacknet.upgradeCache() method + +Upgrade the cache of a hacknet node. + +Signature: + +```typescript +upgradeCache(index: number, n: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of cache levels to purchase. Must be positive. Rounded to nearest integer. | + +Returns: + +boolean + +True if the Hacknet Node’s cache level is successfully upgraded, false otherwise. + +## Remarks + +RAM cost: 0 GB + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Tries to upgrade the specified Hacknet Server’s cache n times. + +Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level. + +Returns false otherwise. + diff --git a/markdown/bitburner.hacknet.upgradecore.md b/markdown/bitburner.hacknet.upgradecore.md new file mode 100644 index 000000000..cab7fe4bb --- /dev/null +++ b/markdown/bitburner.hacknet.upgradecore.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [upgradeCore](./bitburner.hacknet.upgradecore.md) + +## Hacknet.upgradeCore() method + +Upgrade the core of a hacknet node. + +Signature: + +```typescript +upgradeCore(index: number, n: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of cores to purchase. Must be positive. Rounded to nearest integer. | + +Returns: + +boolean + +True if the Hacknet Node’s cores are successfully purchased, false otherwise. + +## Remarks + +RAM cost: 0 GB + +Tries to purchase n cores for the specified Hacknet Node. + +Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores. + +Returns false otherwise. + diff --git a/markdown/bitburner.hacknet.upgradelevel.md b/markdown/bitburner.hacknet.upgradelevel.md new file mode 100644 index 000000000..fa286db87 --- /dev/null +++ b/markdown/bitburner.hacknet.upgradelevel.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [upgradeLevel](./bitburner.hacknet.upgradelevel.md) + +## Hacknet.upgradeLevel() method + +Upgrade the level of a hacknet node. + +Signature: + +```typescript +upgradeLevel(index: number, n: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of levels to purchase. Must be positive. Rounded to nearest integer. | + +Returns: + +boolean + +True if the Hacknet Node’s level is successfully upgraded, false otherwise. + +## Remarks + +RAM cost: 0 GB + +Tries to upgrade the level of the specified Hacknet Node by n. + +Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level. + +Returns false otherwise. + diff --git a/markdown/bitburner.hacknet.upgraderam.md b/markdown/bitburner.hacknet.upgraderam.md new file mode 100644 index 000000000..c69dbcbe0 --- /dev/null +++ b/markdown/bitburner.hacknet.upgraderam.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Hacknet](./bitburner.hacknet.md) > [upgradeRam](./bitburner.hacknet.upgraderam.md) + +## Hacknet.upgradeRam() method + +Upgrade the RAM of a hacknet node. + +Signature: + +```typescript +upgradeRam(index: number, n: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. | + +Returns: + +boolean + +True if the Hacknet Node’s RAM is successfully upgraded, false otherwise. + +## Remarks + +RAM cost: 0 GB + +Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n. + +Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches its max RAM. + +Returns false otherwise. + diff --git a/markdown/bitburner.hacknetmultipliers.corecost.md b/markdown/bitburner.hacknetmultipliers.corecost.md new file mode 100644 index 000000000..2e9abb0dc --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.corecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [coreCost](./bitburner.hacknetmultipliers.corecost.md) + +## HacknetMultipliers.coreCost property + +Player's hacknet core cost multiplier + +Signature: + +```typescript +coreCost: number; +``` diff --git a/markdown/bitburner.hacknetmultipliers.levelcost.md b/markdown/bitburner.hacknetmultipliers.levelcost.md new file mode 100644 index 000000000..a09526c7e --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.levelcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [levelCost](./bitburner.hacknetmultipliers.levelcost.md) + +## HacknetMultipliers.levelCost property + +Player's hacknet level cost multiplier + +Signature: + +```typescript +levelCost: number; +``` diff --git a/markdown/bitburner.hacknetmultipliers.md b/markdown/bitburner.hacknetmultipliers.md new file mode 100644 index 000000000..c04b83fa4 --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) + +## HacknetMultipliers interface + +Hacknet related multipliers. + +Signature: + +```typescript +export interface HacknetMultipliers +``` + +## Properties + +| Property | 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.hacknetmultipliers.production.md b/markdown/bitburner.hacknetmultipliers.production.md new file mode 100644 index 000000000..5b60f1d4a --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.production.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [production](./bitburner.hacknetmultipliers.production.md) + +## HacknetMultipliers.production property + +Player's hacknet production multiplier + +Signature: + +```typescript +production: number; +``` diff --git a/markdown/bitburner.hacknetmultipliers.purchasecost.md b/markdown/bitburner.hacknetmultipliers.purchasecost.md new file mode 100644 index 000000000..04a481172 --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.purchasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [purchaseCost](./bitburner.hacknetmultipliers.purchasecost.md) + +## HacknetMultipliers.purchaseCost property + +Player's hacknet purchase cost multiplier + +Signature: + +```typescript +purchaseCost: number; +``` diff --git a/markdown/bitburner.hacknetmultipliers.ramcost.md b/markdown/bitburner.hacknetmultipliers.ramcost.md new file mode 100644 index 000000000..94ac4a3c8 --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.ramcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [ramCost](./bitburner.hacknetmultipliers.ramcost.md) + +## HacknetMultipliers.ramCost property + +Player's hacknet ram cost multiplier + +Signature: + +```typescript +ramCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.basecost.md b/markdown/bitburner.hacknetnodeconstants.basecost.md new file mode 100644 index 000000000..2f696b00c --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.basecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [BaseCost](./bitburner.hacknetnodeconstants.basecost.md) + +## HacknetNodeConstants.BaseCost property + +Base cost for a new node + +Signature: + +```typescript +BaseCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.corebasecost.md b/markdown/bitburner.hacknetnodeconstants.corebasecost.md new file mode 100644 index 000000000..23431d27d --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.corebasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [CoreBaseCost](./bitburner.hacknetnodeconstants.corebasecost.md) + +## HacknetNodeConstants.CoreBaseCost property + +Base cost to increase cores + +Signature: + +```typescript +CoreBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.levelbasecost.md b/markdown/bitburner.hacknetnodeconstants.levelbasecost.md new file mode 100644 index 000000000..4bc92f2d7 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.levelbasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [LevelBaseCost](./bitburner.hacknetnodeconstants.levelbasecost.md) + +## HacknetNodeConstants.LevelBaseCost property + +Base cost per level + +Signature: + +```typescript +LevelBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.maxcores.md b/markdown/bitburner.hacknetnodeconstants.maxcores.md new file mode 100644 index 000000000..4484421ac --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.maxcores.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxCores](./bitburner.hacknetnodeconstants.maxcores.md) + +## HacknetNodeConstants.MaxCores property + +Max number of cores + +Signature: + +```typescript +MaxCores: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.maxlevel.md b/markdown/bitburner.hacknetnodeconstants.maxlevel.md new file mode 100644 index 000000000..87cf76ee8 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.maxlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxLevel](./bitburner.hacknetnodeconstants.maxlevel.md) + +## HacknetNodeConstants.MaxLevel property + +Max node level + +Signature: + +```typescript +MaxLevel: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.maxram.md b/markdown/bitburner.hacknetnodeconstants.maxram.md new file mode 100644 index 000000000..f3c6ee99e --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.maxram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MaxRam](./bitburner.hacknetnodeconstants.maxram.md) + +## HacknetNodeConstants.MaxRam property + +Max amount of RAM in GB + +Signature: + +```typescript +MaxRam: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.md b/markdown/bitburner.hacknetnodeconstants.md new file mode 100644 index 000000000..92febb288 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) + +## HacknetNodeConstants interface + +Hacknet node related constants + +Signature: + +```typescript +export interface HacknetNodeConstants +``` + +## Properties + +| Property | 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.hacknetnodeconstants.moneygainperlevel.md b/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md new file mode 100644 index 000000000..456437ca2 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.moneygainperlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) + +## HacknetNodeConstants.MoneyGainPerLevel property + +Amount of money gained per level + +Signature: + +```typescript +MoneyGainPerLevel: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md b/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md new file mode 100644 index 000000000..fc9981f6a --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.purchasenextmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) + +## HacknetNodeConstants.PurchaseNextMult property + +Multiplier to purchase new node + +Signature: + +```typescript +PurchaseNextMult: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.rambasecost.md b/markdown/bitburner.hacknetnodeconstants.rambasecost.md new file mode 100644 index 000000000..41e3e4045 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.rambasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) + +## HacknetNodeConstants.RamBaseCost property + +Base cost to increase RAM + +Signature: + +```typescript +RamBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md b/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md new file mode 100644 index 000000000..4ddd2bbc2 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.upgradecoremult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) + +## HacknetNodeConstants.UpgradeCoreMult property + +Multiplier to increase cores + +Signature: + +```typescript +UpgradeCoreMult: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md b/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md new file mode 100644 index 000000000..daa8553c4 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.upgradelevelmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) + +## HacknetNodeConstants.UpgradeLevelMult property + +Multiplier to increase node level + +Signature: + +```typescript +UpgradeLevelMult: number; +``` diff --git a/markdown/bitburner.hacknetnodeconstants.upgraderammult.md b/markdown/bitburner.hacknetnodeconstants.upgraderammult.md new file mode 100644 index 000000000..899902b70 --- /dev/null +++ b/markdown/bitburner.hacknetnodeconstants.upgraderammult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) > [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) + +## HacknetNodeConstants.UpgradeRamMult property + +Multiplier to increase RAM + +Signature: + +```typescript +UpgradeRamMult: number; +``` diff --git a/markdown/bitburner.hacknetnodesformulas.constants.md b/markdown/bitburner.hacknetnodesformulas.constants.md new file mode 100644 index 000000000..455463122 --- /dev/null +++ b/markdown/bitburner.hacknetnodesformulas.constants.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) > [constants](./bitburner.hacknetnodesformulas.constants.md) + +## HacknetNodesFormulas.constants() method + +All constants used by the game. + +Signature: + +```typescript +constants(): HacknetNodeConstants; +``` +Returns: + +[HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) + +An object with all hacknet node constants used by the game. + diff --git a/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md b/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md new file mode 100644 index 000000000..3217b4cb7 --- /dev/null +++ b/markdown/bitburner.hacknetnodesformulas.coreupgradecost.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) > [coreUpgradeCost](./bitburner.hacknetnodesformulas.coreupgradecost.md) + +## HacknetNodesFormulas.coreUpgradeCost() method + +Calculate cost of upgrading hacknet node cores. + +Signature: + +```typescript +coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| startingCore | number | starting cores | +| extraCores | number | amount of cores to purchase (defaults to 1) | +| costMult | number | player cost reduction (default to 1) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md b/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md new file mode 100644 index 000000000..7d88ecf86 --- /dev/null +++ b/markdown/bitburner.hacknetnodesformulas.hacknetnodecost.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) > [hacknetNodeCost](./bitburner.hacknetnodesformulas.hacknetnodecost.md) + +## HacknetNodesFormulas.hacknetNodeCost() method + +Calculate the cost of a hacknet node. + +Signature: + +```typescript +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) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md b/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md new file mode 100644 index 000000000..53ac8090c --- /dev/null +++ b/markdown/bitburner.hacknetnodesformulas.levelupgradecost.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) > [levelUpgradeCost](./bitburner.hacknetnodesformulas.levelupgradecost.md) + +## HacknetNodesFormulas.levelUpgradeCost() method + +Calculate cost of upgrading hacknet node level. + +Signature: + +```typescript +levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| startingLevel | number | starting level | +| extraLevels | number | amount of level to purchase (defaults to 1) | +| costMult | number | player cost reduction (default to 1) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hacknetnodesformulas.md b/markdown/bitburner.hacknetnodesformulas.md new file mode 100644 index 000000000..90f7bc4ee --- /dev/null +++ b/markdown/bitburner.hacknetnodesformulas.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) + +## HacknetNodesFormulas interface + +Hacknet Node formulas + +Signature: + +```typescript +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. | + diff --git a/markdown/bitburner.hacknetnodesformulas.moneygainrate.md b/markdown/bitburner.hacknetnodesformulas.moneygainrate.md new file mode 100644 index 000000000..deb51878f --- /dev/null +++ b/markdown/bitburner.hacknetnodesformulas.moneygainrate.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) > [moneyGainRate](./bitburner.hacknetnodesformulas.moneygainrate.md) + +## HacknetNodesFormulas.moneyGainRate() method + +Calculate money gain rate. + +Signature: + +```typescript +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 | player production mult (default to 1) | + +Returns: + +number + +The calculated money gain rate. + diff --git a/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md b/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md new file mode 100644 index 000000000..6be6a5c01 --- /dev/null +++ b/markdown/bitburner.hacknetnodesformulas.ramupgradecost.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) > [ramUpgradeCost](./bitburner.hacknetnodesformulas.ramupgradecost.md) + +## HacknetNodesFormulas.ramUpgradeCost() method + +Calculate cost of upgrading hacknet node ram. + +Signature: + +```typescript +ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| startingRam | number | starting ram | +| extraLevels | number | amount of level of ram to purchase (defaults to 1) | +| costMult | number | player cost reduction (default to 1) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hacknetserverconstants.basecost.md b/markdown/bitburner.hacknetserverconstants.basecost.md new file mode 100644 index 000000000..ea787cddc --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.basecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [BaseCost](./bitburner.hacknetserverconstants.basecost.md) + +## HacknetServerConstants.BaseCost property + +Base cost for a new server + +Signature: + +```typescript +BaseCost: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.cachebasecost.md b/markdown/bitburner.hacknetserverconstants.cachebasecost.md new file mode 100644 index 000000000..d532f156d --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.cachebasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [CacheBaseCost](./bitburner.hacknetserverconstants.cachebasecost.md) + +## HacknetServerConstants.CacheBaseCost property + +Base cost to upgrade cache + +Signature: + +```typescript +CacheBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.corebasecost.md b/markdown/bitburner.hacknetserverconstants.corebasecost.md new file mode 100644 index 000000000..856c37f59 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.corebasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [CoreBaseCost](./bitburner.hacknetserverconstants.corebasecost.md) + +## HacknetServerConstants.CoreBaseCost property + +Base cost to increase cores + +Signature: + +```typescript +CoreBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.hashesperlevel.md b/markdown/bitburner.hacknetserverconstants.hashesperlevel.md new file mode 100644 index 000000000..4c0a296e2 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.hashesperlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [HashesPerLevel](./bitburner.hacknetserverconstants.hashesperlevel.md) + +## HacknetServerConstants.HashesPerLevel property + +Number of hashes calculated per level + +Signature: + +```typescript +HashesPerLevel: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxcache.md b/markdown/bitburner.hacknetserverconstants.maxcache.md new file mode 100644 index 000000000..b5beb72a2 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxcache.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxCache](./bitburner.hacknetserverconstants.maxcache.md) + +## HacknetServerConstants.MaxCache property + +Max cache size + +Signature: + +```typescript +MaxCache: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxcores.md b/markdown/bitburner.hacknetserverconstants.maxcores.md new file mode 100644 index 000000000..eecad52ca --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxcores.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxCores](./bitburner.hacknetserverconstants.maxcores.md) + +## HacknetServerConstants.MaxCores property + +Max number of cores + +Signature: + +```typescript +MaxCores: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxlevel.md b/markdown/bitburner.hacknetserverconstants.maxlevel.md new file mode 100644 index 000000000..20a1d3167 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxLevel](./bitburner.hacknetserverconstants.maxlevel.md) + +## HacknetServerConstants.MaxLevel property + +Max level for a server + +Signature: + +```typescript +MaxLevel: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxram.md b/markdown/bitburner.hacknetserverconstants.maxram.md new file mode 100644 index 000000000..d67e2bb32 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxRam](./bitburner.hacknetserverconstants.maxram.md) + +## HacknetServerConstants.MaxRam property + +Max amount of RAM in GB + +Signature: + +```typescript +MaxRam: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.maxservers.md b/markdown/bitburner.hacknetserverconstants.maxservers.md new file mode 100644 index 000000000..d4808ddf9 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.maxservers.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [MaxServers](./bitburner.hacknetserverconstants.maxservers.md) + +## HacknetServerConstants.MaxServers property + +Max number of servers + +Signature: + +```typescript +MaxServers: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.md b/markdown/bitburner.hacknetserverconstants.md new file mode 100644 index 000000000..e12db4ba9 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) + +## HacknetServerConstants interface + +Hacknet server related constants + +Signature: + +```typescript +export interface HacknetServerConstants +``` + +## Properties + +| Property | 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.hacknetserverconstants.purchasemult.md b/markdown/bitburner.hacknetserverconstants.purchasemult.md new file mode 100644 index 000000000..32eef9e8a --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.purchasemult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [PurchaseMult](./bitburner.hacknetserverconstants.purchasemult.md) + +## HacknetServerConstants.PurchaseMult property + +Multiplier to purchase a new server + +Signature: + +```typescript +PurchaseMult: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.rambasecost.md b/markdown/bitburner.hacknetserverconstants.rambasecost.md new file mode 100644 index 000000000..365a154ae --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.rambasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [RamBaseCost](./bitburner.hacknetserverconstants.rambasecost.md) + +## HacknetServerConstants.RamBaseCost property + +Base cost to increase RAM + +Signature: + +```typescript +RamBaseCost: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.upgradecachemult.md b/markdown/bitburner.hacknetserverconstants.upgradecachemult.md new file mode 100644 index 000000000..7fdfe9eb0 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.upgradecachemult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeCacheMult](./bitburner.hacknetserverconstants.upgradecachemult.md) + +## HacknetServerConstants.UpgradeCacheMult property + +Multiplier to upgrade cache + +Signature: + +```typescript +UpgradeCacheMult: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.upgradecoremult.md b/markdown/bitburner.hacknetserverconstants.upgradecoremult.md new file mode 100644 index 000000000..2c6541d46 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.upgradecoremult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeCoreMult](./bitburner.hacknetserverconstants.upgradecoremult.md) + +## HacknetServerConstants.UpgradeCoreMult property + +Multiplier to increase cores + +Signature: + +```typescript +UpgradeCoreMult: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md b/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md new file mode 100644 index 000000000..81a67ecff --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.upgradelevelmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeLevelMult](./bitburner.hacknetserverconstants.upgradelevelmult.md) + +## HacknetServerConstants.UpgradeLevelMult property + +Multiplier to increase server level + +Signature: + +```typescript +UpgradeLevelMult: number; +``` diff --git a/markdown/bitburner.hacknetserverconstants.upgraderammult.md b/markdown/bitburner.hacknetserverconstants.upgraderammult.md new file mode 100644 index 000000000..5273537c3 --- /dev/null +++ b/markdown/bitburner.hacknetserverconstants.upgraderammult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServerConstants](./bitburner.hacknetserverconstants.md) > [UpgradeRamMult](./bitburner.hacknetserverconstants.upgraderammult.md) + +## HacknetServerConstants.UpgradeRamMult property + +Multiplier to increase RAM + +Signature: + +```typescript +UpgradeRamMult: number; +``` diff --git a/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md b/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md new file mode 100644 index 000000000..cf7a00710 --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.cacheupgradecost.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) > [cacheUpgradeCost](./bitburner.hacknetserversformulas.cacheupgradecost.md) + +## HacknetServersFormulas.cacheUpgradeCost() method + +Calculate cost of upgrading hacknet server cache. + +Signature: + +```typescript +cacheUpgradeCost(startingCache: number, extraCache?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| startingCache | number | starting cache level | +| extraCache | number | amount of levels of cache to purchase (defaults to 1) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hacknetserversformulas.constants.md b/markdown/bitburner.hacknetserversformulas.constants.md new file mode 100644 index 000000000..e17c88b5a --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.constants.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) > [constants](./bitburner.hacknetserversformulas.constants.md) + +## HacknetServersFormulas.constants() method + +All constants used by the game. + +Signature: + +```typescript +constants(): HacknetServerConstants; +``` +Returns: + +[HacknetServerConstants](./bitburner.hacknetserverconstants.md) + +An object with all hacknet server constants used by the game. + diff --git a/markdown/bitburner.hacknetserversformulas.coreupgradecost.md b/markdown/bitburner.hacknetserversformulas.coreupgradecost.md new file mode 100644 index 000000000..82bcc923d --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.coreupgradecost.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) > [coreUpgradeCost](./bitburner.hacknetserversformulas.coreupgradecost.md) + +## HacknetServersFormulas.coreUpgradeCost() method + +Calculate cost of upgrading hacknet server cores. + +Signature: + +```typescript +coreUpgradeCost(startingCore: number, extraCores?: number, costMult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| startingCore | number | starting cores | +| extraCores | number | amount of cores to purchase (defaults to 1) | +| costMult | number | player cost reduction (default to 1) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hacknetserversformulas.hacknetservercost.md b/markdown/bitburner.hacknetserversformulas.hacknetservercost.md new file mode 100644 index 000000000..55f7fd29a --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.hacknetservercost.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) > [hacknetServerCost](./bitburner.hacknetserversformulas.hacknetservercost.md) + +## HacknetServersFormulas.hacknetServerCost() method + +Calculate the cost of a hacknet server. + +Signature: + +```typescript +hacknetServerCost(n: number, mult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| n | number | number of the hacknet server | +| mult | number | player cost reduction (defaults to 1) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hacknetserversformulas.hashgainrate.md b/markdown/bitburner.hacknetserversformulas.hashgainrate.md new file mode 100644 index 000000000..51c960448 --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.hashgainrate.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) > [hashGainRate](./bitburner.hacknetserversformulas.hashgainrate.md) + +## HacknetServersFormulas.hashGainRate() method + +Calculate hash gain rate. + +Signature: + +```typescript +hashGainRate(level: number, ramUsed: number, maxRam: number, cores: number, mult?: number): number; +``` + +## 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 | player production mult (default to 1) | + +Returns: + +number + +The calculated hash gain rate. + diff --git a/markdown/bitburner.hacknetserversformulas.hashupgradecost.md b/markdown/bitburner.hacknetserversformulas.hashupgradecost.md new file mode 100644 index 000000000..0cc4ec42b --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.hashupgradecost.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) > [hashUpgradeCost](./bitburner.hacknetserversformulas.hashupgradecost.md) + +## HacknetServersFormulas.hashUpgradeCost() method + +Calculate hash cost of an upgrade. + +Signature: + +```typescript +hashUpgradeCost(upgName: number, level: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgName | number | name of the upgrade | +| level | number | level of the upgrade | + +Returns: + +number + +The calculated hash cost. + diff --git a/markdown/bitburner.hacknetserversformulas.levelupgradecost.md b/markdown/bitburner.hacknetserversformulas.levelupgradecost.md new file mode 100644 index 000000000..de10d2a62 --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.levelupgradecost.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) > [levelUpgradeCost](./bitburner.hacknetserversformulas.levelupgradecost.md) + +## HacknetServersFormulas.levelUpgradeCost() method + +Calculate cost of upgrading hacknet server level. + +Signature: + +```typescript +levelUpgradeCost(startingLevel: number, extraLevels?: number, costMult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| startingLevel | number | starting level | +| extraLevels | number | amount of level to purchase (defaults to 1) | +| costMult | number | player cost reduction (default to 1) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hacknetserversformulas.md b/markdown/bitburner.hacknetserversformulas.md new file mode 100644 index 000000000..059e4ba39 --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) + +## HacknetServersFormulas interface + +Hacknet Server formulas + +Signature: + +```typescript +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. | + diff --git a/markdown/bitburner.hacknetserversformulas.ramupgradecost.md b/markdown/bitburner.hacknetserversformulas.ramupgradecost.md new file mode 100644 index 000000000..1cd2c4b43 --- /dev/null +++ b/markdown/bitburner.hacknetserversformulas.ramupgradecost.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) > [ramUpgradeCost](./bitburner.hacknetserversformulas.ramupgradecost.md) + +## HacknetServersFormulas.ramUpgradeCost() method + +Calculate cost of upgrading hacknet server ram. + +Signature: + +```typescript +ramUpgradeCost(startingRam: number, extraLevels?: number, costMult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| startingRam | number | starting ram | +| extraLevels | number | amount of level of ram to purchase (defaults to 1) | +| costMult | number | player cost reduction (default to 1) | + +Returns: + +number + +The calculated cost. + diff --git a/markdown/bitburner.hp.current.md b/markdown/bitburner.hp.current.md new file mode 100644 index 000000000..cebd3cbc7 --- /dev/null +++ b/markdown/bitburner.hp.current.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HP](./bitburner.hp.md) > [current](./bitburner.hp.current.md) + +## HP.current property + +Signature: + +```typescript +current: number; +``` diff --git a/markdown/bitburner.hp.max.md b/markdown/bitburner.hp.max.md new file mode 100644 index 000000000..e0a023eb6 --- /dev/null +++ b/markdown/bitburner.hp.max.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HP](./bitburner.hp.md) > [max](./bitburner.hp.max.md) + +## HP.max property + +Signature: + +```typescript +max: number; +``` diff --git a/markdown/bitburner.hp.md b/markdown/bitburner.hp.md new file mode 100644 index 000000000..109299a2f --- /dev/null +++ b/markdown/bitburner.hp.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HP](./bitburner.hp.md) + +## HP interface + + +Signature: + +```typescript +export interface HP +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [current](./bitburner.hp.current.md) | number | | +| [max](./bitburner.hp.max.md) | number | | + diff --git a/markdown/bitburner.ilocation.city.md b/markdown/bitburner.ilocation.city.md new file mode 100644 index 000000000..5ff25d8df --- /dev/null +++ b/markdown/bitburner.ilocation.city.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ILocation](./bitburner.ilocation.md) > [city](./bitburner.ilocation.city.md) + +## ILocation.city property + +Signature: + +```typescript +city: string; +``` diff --git a/markdown/bitburner.ilocation.md b/markdown/bitburner.ilocation.md new file mode 100644 index 000000000..847b00d79 --- /dev/null +++ b/markdown/bitburner.ilocation.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ILocation](./bitburner.ilocation.md) + +## ILocation interface + + +Signature: + +```typescript +export interface ILocation +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [city](./bitburner.ilocation.city.md) | string | | +| [name](./bitburner.ilocation.name.md) | string | | + diff --git a/markdown/bitburner.ilocation.name.md b/markdown/bitburner.ilocation.name.md new file mode 100644 index 000000000..d91bf6201 --- /dev/null +++ b/markdown/bitburner.ilocation.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ILocation](./bitburner.ilocation.md) > [name](./bitburner.ilocation.name.md) + +## ILocation.name property + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.infiltration.getinfiltration.md b/markdown/bitburner.infiltration.getinfiltration.md new file mode 100644 index 000000000..7dc5c5cf4 --- /dev/null +++ b/markdown/bitburner.infiltration.getinfiltration.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Infiltration](./bitburner.infiltration.md) > [getInfiltration](./bitburner.infiltration.getinfiltration.md) + +## Infiltration.getInfiltration() method + +Get all infiltrations with difficulty, location and rewards. + +Signature: + +```typescript +getInfiltration(location: string): InfiltrationLocation; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| location | string | | + +Returns: + +[InfiltrationLocation](./bitburner.infiltrationlocation.md) + +Infiltration data for given location. + +## Remarks + +RAM cost: 15 GB + diff --git a/markdown/bitburner.infiltration.getpossiblelocations.md b/markdown/bitburner.infiltration.getpossiblelocations.md new file mode 100644 index 000000000..010b1a1a1 --- /dev/null +++ b/markdown/bitburner.infiltration.getpossiblelocations.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Infiltration](./bitburner.infiltration.md) > [getPossibleLocations](./bitburner.infiltration.getpossiblelocations.md) + +## Infiltration.getPossibleLocations() method + +Get all locations that can be infiltrated. + +Signature: + +```typescript +getPossibleLocations(): PossibleInfiltrationLocation[]; +``` +Returns: + +[PossibleInfiltrationLocation](./bitburner.possibleinfiltrationlocation.md)\[\] + +all locations that can be infiltrated. + +## Remarks + +RAM cost: 5 GB + diff --git a/markdown/bitburner.infiltration.md b/markdown/bitburner.infiltration.md new file mode 100644 index 000000000..cfcd284ac --- /dev/null +++ b/markdown/bitburner.infiltration.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Infiltration](./bitburner.infiltration.md) + +## Infiltration interface + +Infiltration API. + +Signature: + +```typescript +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. | + diff --git a/markdown/bitburner.infiltrationlocation.difficulty.md b/markdown/bitburner.infiltrationlocation.difficulty.md new file mode 100644 index 000000000..849f0cbe7 --- /dev/null +++ b/markdown/bitburner.infiltrationlocation.difficulty.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InfiltrationLocation](./bitburner.infiltrationlocation.md) > [difficulty](./bitburner.infiltrationlocation.difficulty.md) + +## InfiltrationLocation.difficulty property + +Signature: + +```typescript +difficulty: number; +``` diff --git a/markdown/bitburner.infiltrationlocation.location.md b/markdown/bitburner.infiltrationlocation.location.md new file mode 100644 index 000000000..d884e5c99 --- /dev/null +++ b/markdown/bitburner.infiltrationlocation.location.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InfiltrationLocation](./bitburner.infiltrationlocation.md) > [location](./bitburner.infiltrationlocation.location.md) + +## InfiltrationLocation.location property + +Signature: + +```typescript +location: ILocation; +``` diff --git a/markdown/bitburner.infiltrationlocation.md b/markdown/bitburner.infiltrationlocation.md new file mode 100644 index 000000000..bf904135e --- /dev/null +++ b/markdown/bitburner.infiltrationlocation.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InfiltrationLocation](./bitburner.infiltrationlocation.md) + +## InfiltrationLocation interface + + +Signature: + +```typescript +export interface InfiltrationLocation +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [difficulty](./bitburner.infiltrationlocation.difficulty.md) | number | | +| [location](./bitburner.infiltrationlocation.location.md) | [ILocation](./bitburner.ilocation.md) | | +| [reward](./bitburner.infiltrationlocation.reward.md) | [InfiltrationReward](./bitburner.infiltrationreward.md) | | + diff --git a/markdown/bitburner.infiltrationlocation.reward.md b/markdown/bitburner.infiltrationlocation.reward.md new file mode 100644 index 000000000..a6c38142e --- /dev/null +++ b/markdown/bitburner.infiltrationlocation.reward.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InfiltrationLocation](./bitburner.infiltrationlocation.md) > [reward](./bitburner.infiltrationlocation.reward.md) + +## InfiltrationLocation.reward property + +Signature: + +```typescript +reward: InfiltrationReward; +``` diff --git a/markdown/bitburner.infiltrationreward.md b/markdown/bitburner.infiltrationreward.md new file mode 100644 index 000000000..3cb0ad38b --- /dev/null +++ b/markdown/bitburner.infiltrationreward.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InfiltrationReward](./bitburner.infiltrationreward.md) + +## InfiltrationReward interface + + +Signature: + +```typescript +export interface InfiltrationReward +``` + +## Properties + +| Property | 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.infiltrationreward.sellcash.md b/markdown/bitburner.infiltrationreward.sellcash.md new file mode 100644 index 000000000..d98b2b67b --- /dev/null +++ b/markdown/bitburner.infiltrationreward.sellcash.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InfiltrationReward](./bitburner.infiltrationreward.md) > [sellCash](./bitburner.infiltrationreward.sellcash.md) + +## InfiltrationReward.sellCash property + +Signature: + +```typescript +sellCash: number; +``` diff --git a/markdown/bitburner.infiltrationreward.soarep.md b/markdown/bitburner.infiltrationreward.soarep.md new file mode 100644 index 000000000..cac6ac50d --- /dev/null +++ b/markdown/bitburner.infiltrationreward.soarep.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InfiltrationReward](./bitburner.infiltrationreward.md) > [SoARep](./bitburner.infiltrationreward.soarep.md) + +## InfiltrationReward.SoARep property + +Signature: + +```typescript +SoARep: number; +``` diff --git a/markdown/bitburner.infiltrationreward.traderep.md b/markdown/bitburner.infiltrationreward.traderep.md new file mode 100644 index 000000000..c3d1d8c79 --- /dev/null +++ b/markdown/bitburner.infiltrationreward.traderep.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InfiltrationReward](./bitburner.infiltrationreward.md) > [tradeRep](./bitburner.infiltrationreward.traderep.md) + +## InfiltrationReward.tradeRep property + +Signature: + +```typescript +tradeRep: number; +``` diff --git a/markdown/bitburner.investmentoffer.funds.md b/markdown/bitburner.investmentoffer.funds.md new file mode 100644 index 000000000..77822d27f --- /dev/null +++ b/markdown/bitburner.investmentoffer.funds.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InvestmentOffer](./bitburner.investmentoffer.md) > [funds](./bitburner.investmentoffer.funds.md) + +## InvestmentOffer.funds property + +Amount of funds you will get from this investment + +Signature: + +```typescript +funds: number; +``` diff --git a/markdown/bitburner.investmentoffer.md b/markdown/bitburner.investmentoffer.md new file mode 100644 index 000000000..4768cc622 --- /dev/null +++ b/markdown/bitburner.investmentoffer.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InvestmentOffer](./bitburner.investmentoffer.md) + +## InvestmentOffer interface + +Corporation investment offer + +Signature: + +```typescript +interface InvestmentOffer +``` + +## Properties + +| Property | 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.investmentoffer.round.md b/markdown/bitburner.investmentoffer.round.md new file mode 100644 index 000000000..05095029c --- /dev/null +++ b/markdown/bitburner.investmentoffer.round.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InvestmentOffer](./bitburner.investmentoffer.md) > [round](./bitburner.investmentoffer.round.md) + +## InvestmentOffer.round property + +Current round of funding (max 4) + +Signature: + +```typescript +round: number; +``` diff --git a/markdown/bitburner.investmentoffer.shares.md b/markdown/bitburner.investmentoffer.shares.md new file mode 100644 index 000000000..7c3a2e0a1 --- /dev/null +++ b/markdown/bitburner.investmentoffer.shares.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [InvestmentOffer](./bitburner.investmentoffer.md) > [shares](./bitburner.investmentoffer.shares.md) + +## InvestmentOffer.shares property + +Amount of share you will give in exchange for this investment + +Signature: + +```typescript +shares: number; +``` diff --git a/markdown/bitburner.istylesettings.fontfamily.md b/markdown/bitburner.istylesettings.fontfamily.md new file mode 100644 index 000000000..f4cbd265c --- /dev/null +++ b/markdown/bitburner.istylesettings.fontfamily.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [IStyleSettings](./bitburner.istylesettings.md) > [fontFamily](./bitburner.istylesettings.fontfamily.md) + +## IStyleSettings.fontFamily property + +Signature: + +```typescript +fontFamily: string; +``` diff --git a/markdown/bitburner.istylesettings.lineheight.md b/markdown/bitburner.istylesettings.lineheight.md new file mode 100644 index 000000000..23fa29863 --- /dev/null +++ b/markdown/bitburner.istylesettings.lineheight.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [IStyleSettings](./bitburner.istylesettings.md) > [lineHeight](./bitburner.istylesettings.lineheight.md) + +## IStyleSettings.lineHeight property + +Signature: + +```typescript +lineHeight: number; +``` diff --git a/markdown/bitburner.istylesettings.md b/markdown/bitburner.istylesettings.md new file mode 100644 index 000000000..0b88e86ba --- /dev/null +++ b/markdown/bitburner.istylesettings.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [IStyleSettings](./bitburner.istylesettings.md) + +## IStyleSettings interface + +Interface Styles + +Signature: + +```typescript +interface IStyleSettings +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fontFamily](./bitburner.istylesettings.fontfamily.md) | string | | +| [lineHeight](./bitburner.istylesettings.lineheight.md) | number | | + diff --git a/markdown/bitburner.material.cmp.md b/markdown/bitburner.material.cmp.md new file mode 100644 index 000000000..6abd37461 --- /dev/null +++ b/markdown/bitburner.material.cmp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [cmp](./bitburner.material.cmp.md) + +## Material.cmp property + +Competition for the material, only present if "Market Research - Competition" unlocked + +Signature: + +```typescript +cmp: number | undefined; +``` diff --git a/markdown/bitburner.material.cost.md b/markdown/bitburner.material.cost.md new file mode 100644 index 000000000..48f248d17 --- /dev/null +++ b/markdown/bitburner.material.cost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [cost](./bitburner.material.cost.md) + +## Material.cost property + +Cost to buy material + +Signature: + +```typescript +cost: number; +``` diff --git a/markdown/bitburner.material.dmd.md b/markdown/bitburner.material.dmd.md new file mode 100644 index 000000000..e68f29afd --- /dev/null +++ b/markdown/bitburner.material.dmd.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [dmd](./bitburner.material.dmd.md) + +## Material.dmd property + +Demand for the material, only present if "Market Research - Demand" unlocked + +Signature: + +```typescript +dmd: number | undefined; +``` diff --git a/markdown/bitburner.material.exp.md b/markdown/bitburner.material.exp.md new file mode 100644 index 000000000..539a1d902 --- /dev/null +++ b/markdown/bitburner.material.exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [exp](./bitburner.material.exp.md) + +## Material.exp property + +Export orders + +Signature: + +```typescript +exp: Export[]; +``` diff --git a/markdown/bitburner.material.md b/markdown/bitburner.material.md new file mode 100644 index 000000000..29836ebee --- /dev/null +++ b/markdown/bitburner.material.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) + +## Material interface + +Material in a warehouse + +Signature: + +```typescript +interface Material +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [cmp](./bitburner.material.cmp.md) | number \| undefined | Competition for the material, only present if "Market Research - Competition" unlocked | +| [cost](./bitburner.material.cost.md) | number | Cost to buy material | +| [dmd](./bitburner.material.dmd.md) | number \| undefined | Demand for the material, only present if "Market Research - Demand" unlocked | +| [exp](./bitburner.material.exp.md) | [Export](./bitburner.export.md)\[\] | Export orders | +| [name](./bitburner.material.name.md) | string | Name of the material | +| [prod](./bitburner.material.prod.md) | number | Amount of material produced | +| [qlt](./bitburner.material.qlt.md) | number | Quality of the material | +| [qty](./bitburner.material.qty.md) | number | Amount of material | +| [sCost](./bitburner.material.scost.md) | string \| number | Sell cost, can be "MP+5" | +| [sell](./bitburner.material.sell.md) | number | Amount of material sold | + diff --git a/markdown/bitburner.material.name.md b/markdown/bitburner.material.name.md new file mode 100644 index 000000000..04f62762f --- /dev/null +++ b/markdown/bitburner.material.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [name](./bitburner.material.name.md) + +## Material.name property + +Name of the material + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.material.prod.md b/markdown/bitburner.material.prod.md new file mode 100644 index 000000000..e45e4f946 --- /dev/null +++ b/markdown/bitburner.material.prod.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [prod](./bitburner.material.prod.md) + +## Material.prod property + +Amount of material produced + +Signature: + +```typescript +prod: number; +``` diff --git a/markdown/bitburner.material.qlt.md b/markdown/bitburner.material.qlt.md new file mode 100644 index 000000000..1b0eccadc --- /dev/null +++ b/markdown/bitburner.material.qlt.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [qlt](./bitburner.material.qlt.md) + +## Material.qlt property + +Quality of the material + +Signature: + +```typescript +qlt: number; +``` diff --git a/markdown/bitburner.material.qty.md b/markdown/bitburner.material.qty.md new file mode 100644 index 000000000..148a724ac --- /dev/null +++ b/markdown/bitburner.material.qty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [qty](./bitburner.material.qty.md) + +## Material.qty property + +Amount of material + +Signature: + +```typescript +qty: number; +``` diff --git a/markdown/bitburner.material.scost.md b/markdown/bitburner.material.scost.md new file mode 100644 index 000000000..3a1fadbae --- /dev/null +++ b/markdown/bitburner.material.scost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [sCost](./bitburner.material.scost.md) + +## Material.sCost property + +Sell cost, can be "MP+5" + +Signature: + +```typescript +sCost: string | number; +``` diff --git a/markdown/bitburner.material.sell.md b/markdown/bitburner.material.sell.md new file mode 100644 index 000000000..bde611e26 --- /dev/null +++ b/markdown/bitburner.material.sell.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Material](./bitburner.material.md) > [sell](./bitburner.material.sell.md) + +## Material.sell property + +Amount of material sold + +Signature: + +```typescript +sell: number; +``` diff --git a/markdown/bitburner.md b/markdown/bitburner.md new file mode 100644 index 000000000..062079181 --- /dev/null +++ b/markdown/bitburner.md @@ -0,0 +1,116 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) + +## bitburner package + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [OrderTypes](./bitburner.ordertypes.md) | | +| [PositionTypes](./bitburner.positiontypes.md) | | + +## 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 | +| [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). | +| [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. | +| [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API | +| [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | Bladeburner current action. | +| [CharacterMult](./bitburner.charactermult.md) | | +| [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md) attempt. | +| [CodingContract](./bitburner.codingcontract.md) | Coding Contract API | +| [Corporation](./bitburner.corporation.md) | Corporation API | +| [CorporationInfo](./bitburner.corporationinfo.md) | General info about a corporation | +| [CrimeStats](./bitburner.crimestats.md) | Data representing the internal values of a crime. | +| [Division](./bitburner.division.md) | Corporation division | +| [Employee](./bitburner.employee.md) | Employee in an office | +| [EmployeeJobs](./bitburner.employeejobs.md) | Object representing the number of employee in each job. | +| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. | +| [Export](./bitburner.export.md) | Export order for a material | +| [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) | | +| [GangMemberInfo](./bitburner.gangmemberinfo.md) | | +| [GangOtherInfo](./bitburner.gangotherinfo.md) | | +| [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | | +| [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. | +| [GangTerritory](./bitburner.gangterritory.md) | | +| [Grafting](./bitburner.grafting.md) | Grafting API | +| [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas | +| [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. | +| [Hacknet](./bitburner.hacknet.md) | Hacknet API | +| [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | Hacknet related multipliers. | +| [HacknetNodeConstants](./bitburner.hacknetnodeconstants.md) | Hacknet node related constants | +| [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas | +| [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants | +| [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas | +| [HP](./bitburner.hp.md) | | +| [ILocation](./bitburner.ilocation.md) | | +| [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 | +| [Material](./bitburner.material.md) | Material in a warehouse | +| [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. | +| [NS](./bitburner.ns.md) | Collection of all functions passed to scripts | +| [Office](./bitburner.office.md) | Office for a division in a city. | +| [OfficeAPI](./bitburner.officeapi.md) | Corporation Office API | +| [Player](./bitburner.player.md) | | +| [PossibleInfiltrationLocation](./bitburner.possibleinfiltrationlocation.md) | | +| [ProcessInfo](./bitburner.processinfo.md) | A single process on a server. | +| [Product](./bitburner.product.md) | Product in a warehouse | +| [RecentScript](./bitburner.recentscript.md) | | +| [ReputationFormulas](./bitburner.reputationformulas.md) | Reputation formulas | +| [RunningScript](./bitburner.runningscript.md) | | +| [Server](./bitburner.server.md) | A single server. | +| [Singularity](./bitburner.singularity.md) | Singularity API | +| [Skills](./bitburner.skills.md) | | +| [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas | +| [Sleeve](./bitburner.sleeve.md) | Sleeve API | +| [SleeveInformation](./bitburner.sleeveinformation.md) | Object representing sleeve information. | +| [SleeveSkills](./bitburner.sleeveskills.md) | Object representing a sleeve stats. | +| [SleeveWorkGains](./bitburner.sleeveworkgains.md) | | +| [SourceFileLvl](./bitburner.sourcefilelvl.md) | | +| [Stanek](./bitburner.stanek.md) | Stanek's Gift API. | +| [StockOrder](./bitburner.stockorder.md) | Return value of [getOrders](./bitburner.tix.getorders.md)Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) | +| [StockOrderObject](./bitburner.stockorderobject.md) | Value in map of [StockOrder](./bitburner.stockorder.md) | +| [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) | | + +## Variables + +| Variable | Description | +| --- | --- | +| [enums](./bitburner.enums.md) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [CodingContractData](./bitburner.codingcontractdata.md) | Coding contract data will differ depending on coding contract. | +| [FilenameOrPID](./bitburner.filenameorpid.md) | | +| [NSEnums](./bitburner.nsenums.md) | | +| [PortData](./bitburner.portdata.md) | | +| [ScriptArg](./bitburner.scriptarg.md) | | +| [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. | +| [ToastVariant](./bitburner.toastvariant.md) | | +| [ValuesFrom](./bitburner.valuesfrom.md) | | + diff --git a/markdown/bitburner.multipliers.agility.md b/markdown/bitburner.multipliers.agility.md new file mode 100644 index 000000000..765b2b389 --- /dev/null +++ b/markdown/bitburner.multipliers.agility.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [agility](./bitburner.multipliers.agility.md) + +## Multipliers.agility property + +Multiplier to agility skill + +Signature: + +```typescript +agility?: number; +``` diff --git a/markdown/bitburner.multipliers.agility_exp.md b/markdown/bitburner.multipliers.agility_exp.md new file mode 100644 index 000000000..356a09b92 --- /dev/null +++ b/markdown/bitburner.multipliers.agility_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [agility\_exp](./bitburner.multipliers.agility_exp.md) + +## Multipliers.agility\_exp property + +Multiplier to agility experience gain rate + +Signature: + +```typescript +agility_exp?: number; +``` diff --git a/markdown/bitburner.multipliers.bladeburner_analysis.md b/markdown/bitburner.multipliers.bladeburner_analysis.md new file mode 100644 index 000000000..634add122 --- /dev/null +++ b/markdown/bitburner.multipliers.bladeburner_analysis.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [bladeburner\_analysis](./bitburner.multipliers.bladeburner_analysis.md) + +## Multipliers.bladeburner\_analysis property + +Multiplier to effectiveness in Bladeburner Field Analysis + +Signature: + +```typescript +bladeburner_analysis?: number; +``` diff --git a/markdown/bitburner.multipliers.bladeburner_max_stamina.md b/markdown/bitburner.multipliers.bladeburner_max_stamina.md new file mode 100644 index 000000000..1c1882cd4 --- /dev/null +++ b/markdown/bitburner.multipliers.bladeburner_max_stamina.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [bladeburner\_max\_stamina](./bitburner.multipliers.bladeburner_max_stamina.md) + +## Multipliers.bladeburner\_max\_stamina property + +Multiplier to Bladeburner max stamina + +Signature: + +```typescript +bladeburner_max_stamina?: number; +``` diff --git a/markdown/bitburner.multipliers.bladeburner_stamina_gain.md b/markdown/bitburner.multipliers.bladeburner_stamina_gain.md new file mode 100644 index 000000000..97f122b64 --- /dev/null +++ b/markdown/bitburner.multipliers.bladeburner_stamina_gain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [bladeburner\_stamina\_gain](./bitburner.multipliers.bladeburner_stamina_gain.md) + +## Multipliers.bladeburner\_stamina\_gain property + +Multiplier to Bladeburner stamina gain rate + +Signature: + +```typescript +bladeburner_stamina_gain?: number; +``` diff --git a/markdown/bitburner.multipliers.bladeburner_success_chance.md b/markdown/bitburner.multipliers.bladeburner_success_chance.md new file mode 100644 index 000000000..e53d9a6cd --- /dev/null +++ b/markdown/bitburner.multipliers.bladeburner_success_chance.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [bladeburner\_success\_chance](./bitburner.multipliers.bladeburner_success_chance.md) + +## Multipliers.bladeburner\_success\_chance property + +Multiplier to success chance in Bladeburner contracts/operations + +Signature: + +```typescript +bladeburner_success_chance?: number; +``` diff --git a/markdown/bitburner.multipliers.charisma.md b/markdown/bitburner.multipliers.charisma.md new file mode 100644 index 000000000..80b9b90a5 --- /dev/null +++ b/markdown/bitburner.multipliers.charisma.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [charisma](./bitburner.multipliers.charisma.md) + +## Multipliers.charisma property + +Multiplier to charisma skill + +Signature: + +```typescript +charisma?: number; +``` diff --git a/markdown/bitburner.multipliers.charisma_exp.md b/markdown/bitburner.multipliers.charisma_exp.md new file mode 100644 index 000000000..8e80b5d45 --- /dev/null +++ b/markdown/bitburner.multipliers.charisma_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [charisma\_exp](./bitburner.multipliers.charisma_exp.md) + +## Multipliers.charisma\_exp property + +Multiplier to charisma experience gain rate + +Signature: + +```typescript +charisma_exp?: number; +``` diff --git a/markdown/bitburner.multipliers.company_rep.md b/markdown/bitburner.multipliers.company_rep.md new file mode 100644 index 000000000..d49068477 --- /dev/null +++ b/markdown/bitburner.multipliers.company_rep.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [company\_rep](./bitburner.multipliers.company_rep.md) + +## Multipliers.company\_rep property + +Multiplier to amount of reputation gained when working + +Signature: + +```typescript +company_rep?: number; +``` diff --git a/markdown/bitburner.multipliers.crime_money.md b/markdown/bitburner.multipliers.crime_money.md new file mode 100644 index 000000000..07d5c5145 --- /dev/null +++ b/markdown/bitburner.multipliers.crime_money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [crime\_money](./bitburner.multipliers.crime_money.md) + +## Multipliers.crime\_money property + +Multiplier to amount of money gained from crimes + +Signature: + +```typescript +crime_money?: number; +``` diff --git a/markdown/bitburner.multipliers.crime_success.md b/markdown/bitburner.multipliers.crime_success.md new file mode 100644 index 000000000..f24feebc1 --- /dev/null +++ b/markdown/bitburner.multipliers.crime_success.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [crime\_success](./bitburner.multipliers.crime_success.md) + +## Multipliers.crime\_success property + +Multiplier to crime success rate + +Signature: + +```typescript +crime_success?: number; +``` diff --git a/markdown/bitburner.multipliers.defense.md b/markdown/bitburner.multipliers.defense.md new file mode 100644 index 000000000..009d0ff84 --- /dev/null +++ b/markdown/bitburner.multipliers.defense.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [defense](./bitburner.multipliers.defense.md) + +## Multipliers.defense property + +Multiplier to defense skill + +Signature: + +```typescript +defense?: number; +``` diff --git a/markdown/bitburner.multipliers.defense_exp.md b/markdown/bitburner.multipliers.defense_exp.md new file mode 100644 index 000000000..b56689287 --- /dev/null +++ b/markdown/bitburner.multipliers.defense_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [defense\_exp](./bitburner.multipliers.defense_exp.md) + +## Multipliers.defense\_exp property + +Multiplier to defense experience gain rate + +Signature: + +```typescript +defense_exp?: number; +``` diff --git a/markdown/bitburner.multipliers.dexterity.md b/markdown/bitburner.multipliers.dexterity.md new file mode 100644 index 000000000..ea6b6eb1d --- /dev/null +++ b/markdown/bitburner.multipliers.dexterity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [dexterity](./bitburner.multipliers.dexterity.md) + +## Multipliers.dexterity property + +Multiplier to dexterity skill + +Signature: + +```typescript +dexterity?: number; +``` diff --git a/markdown/bitburner.multipliers.dexterity_exp.md b/markdown/bitburner.multipliers.dexterity_exp.md new file mode 100644 index 000000000..12a60aa4e --- /dev/null +++ b/markdown/bitburner.multipliers.dexterity_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [dexterity\_exp](./bitburner.multipliers.dexterity_exp.md) + +## Multipliers.dexterity\_exp property + +Multiplier to dexterity experience gain rate + +Signature: + +```typescript +dexterity_exp?: number; +``` diff --git a/markdown/bitburner.multipliers.faction_rep.md b/markdown/bitburner.multipliers.faction_rep.md new file mode 100644 index 000000000..0d7acb11e --- /dev/null +++ b/markdown/bitburner.multipliers.faction_rep.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [faction\_rep](./bitburner.multipliers.faction_rep.md) + +## Multipliers.faction\_rep property + +Multiplier to amount of reputation gained when working + +Signature: + +```typescript +faction_rep?: number; +``` diff --git a/markdown/bitburner.multipliers.hacking.md b/markdown/bitburner.multipliers.hacking.md new file mode 100644 index 000000000..8c7cc3e35 --- /dev/null +++ b/markdown/bitburner.multipliers.hacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacking](./bitburner.multipliers.hacking.md) + +## Multipliers.hacking property + +Multiplier to hacking skill + +Signature: + +```typescript +hacking?: number; +``` diff --git a/markdown/bitburner.multipliers.hacking_chance.md b/markdown/bitburner.multipliers.hacking_chance.md new file mode 100644 index 000000000..4fcc91a2b --- /dev/null +++ b/markdown/bitburner.multipliers.hacking_chance.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacking\_chance](./bitburner.multipliers.hacking_chance.md) + +## Multipliers.hacking\_chance property + +Multiplier to chance of successfully performing a hack + +Signature: + +```typescript +hacking_chance?: number; +``` diff --git a/markdown/bitburner.multipliers.hacking_exp.md b/markdown/bitburner.multipliers.hacking_exp.md new file mode 100644 index 000000000..98a584335 --- /dev/null +++ b/markdown/bitburner.multipliers.hacking_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacking\_exp](./bitburner.multipliers.hacking_exp.md) + +## Multipliers.hacking\_exp property + +Multiplier to hacking experience gain rate + +Signature: + +```typescript +hacking_exp?: number; +``` diff --git a/markdown/bitburner.multipliers.hacking_grow.md b/markdown/bitburner.multipliers.hacking_grow.md new file mode 100644 index 000000000..0eaf8a0ee --- /dev/null +++ b/markdown/bitburner.multipliers.hacking_grow.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacking\_grow](./bitburner.multipliers.hacking_grow.md) + +## Multipliers.hacking\_grow property + +Multiplier to amount of money injected into servers using grow + +Signature: + +```typescript +hacking_grow?: number; +``` diff --git a/markdown/bitburner.multipliers.hacking_money.md b/markdown/bitburner.multipliers.hacking_money.md new file mode 100644 index 000000000..7f232f867 --- /dev/null +++ b/markdown/bitburner.multipliers.hacking_money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacking\_money](./bitburner.multipliers.hacking_money.md) + +## Multipliers.hacking\_money property + +Multiplier to amount of money the player gains from hacking + +Signature: + +```typescript +hacking_money?: number; +``` diff --git a/markdown/bitburner.multipliers.hacking_speed.md b/markdown/bitburner.multipliers.hacking_speed.md new file mode 100644 index 000000000..51de83858 --- /dev/null +++ b/markdown/bitburner.multipliers.hacking_speed.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacking\_speed](./bitburner.multipliers.hacking_speed.md) + +## Multipliers.hacking\_speed property + +Multiplier to hacking speed + +Signature: + +```typescript +hacking_speed?: number; +``` diff --git a/markdown/bitburner.multipliers.hacknet_node_core_cost.md b/markdown/bitburner.multipliers.hacknet_node_core_cost.md new file mode 100644 index 000000000..b4b74bcb4 --- /dev/null +++ b/markdown/bitburner.multipliers.hacknet_node_core_cost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacknet\_node\_core\_cost](./bitburner.multipliers.hacknet_node_core_cost.md) + +## Multipliers.hacknet\_node\_core\_cost property + +Multiplier to cost of core for a Hacknet Node + +Signature: + +```typescript +hacknet_node_core_cost?: number; +``` diff --git a/markdown/bitburner.multipliers.hacknet_node_level_cost.md b/markdown/bitburner.multipliers.hacknet_node_level_cost.md new file mode 100644 index 000000000..c13d39f63 --- /dev/null +++ b/markdown/bitburner.multipliers.hacknet_node_level_cost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacknet\_node\_level\_cost](./bitburner.multipliers.hacknet_node_level_cost.md) + +## Multipliers.hacknet\_node\_level\_cost property + +Multiplier to cost of leveling up a Hacknet Node + +Signature: + +```typescript +hacknet_node_level_cost?: number; +``` diff --git a/markdown/bitburner.multipliers.hacknet_node_money.md b/markdown/bitburner.multipliers.hacknet_node_money.md new file mode 100644 index 000000000..cf2821d02 --- /dev/null +++ b/markdown/bitburner.multipliers.hacknet_node_money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacknet\_node\_money](./bitburner.multipliers.hacknet_node_money.md) + +## Multipliers.hacknet\_node\_money property + +Multiplier to amount of money produced by Hacknet Nodes + +Signature: + +```typescript +hacknet_node_money?: number; +``` diff --git a/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md b/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md new file mode 100644 index 000000000..f0be66630 --- /dev/null +++ b/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacknet\_node\_purchase\_cost](./bitburner.multipliers.hacknet_node_purchase_cost.md) + +## Multipliers.hacknet\_node\_purchase\_cost property + +Multiplier to cost of purchasing a Hacknet Node + +Signature: + +```typescript +hacknet_node_purchase_cost?: number; +``` diff --git a/markdown/bitburner.multipliers.hacknet_node_ram_cost.md b/markdown/bitburner.multipliers.hacknet_node_ram_cost.md new file mode 100644 index 000000000..a2927fc51 --- /dev/null +++ b/markdown/bitburner.multipliers.hacknet_node_ram_cost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [hacknet\_node\_ram\_cost](./bitburner.multipliers.hacknet_node_ram_cost.md) + +## Multipliers.hacknet\_node\_ram\_cost property + +Multiplier to cost of ram for a Hacknet Node + +Signature: + +```typescript +hacknet_node_ram_cost?: number; +``` diff --git a/markdown/bitburner.multipliers.md b/markdown/bitburner.multipliers.md new file mode 100644 index 000000000..073de8c05 --- /dev/null +++ b/markdown/bitburner.multipliers.md @@ -0,0 +1,48 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) + +## Multipliers interface + + +Signature: + +```typescript +export interface Multipliers +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility\_exp?](./bitburner.multipliers.agility_exp.md) | number | (Optional) Multiplier to agility experience gain rate | +| [agility?](./bitburner.multipliers.agility.md) | number | (Optional) Multiplier to agility skill | +| [bladeburner\_analysis?](./bitburner.multipliers.bladeburner_analysis.md) | number | (Optional) Multiplier to effectiveness in Bladeburner Field Analysis | +| [bladeburner\_max\_stamina?](./bitburner.multipliers.bladeburner_max_stamina.md) | number | (Optional) Multiplier to Bladeburner max stamina | +| [bladeburner\_stamina\_gain?](./bitburner.multipliers.bladeburner_stamina_gain.md) | number | (Optional) Multiplier to Bladeburner stamina gain rate | +| [bladeburner\_success\_chance?](./bitburner.multipliers.bladeburner_success_chance.md) | number | (Optional) Multiplier to success chance in Bladeburner contracts/operations | +| [charisma\_exp?](./bitburner.multipliers.charisma_exp.md) | number | (Optional) Multiplier to charisma experience gain rate | +| [charisma?](./bitburner.multipliers.charisma.md) | number | (Optional) Multiplier to charisma skill | +| [company\_rep?](./bitburner.multipliers.company_rep.md) | number | (Optional) Multiplier to amount of reputation gained when working | +| [crime\_money?](./bitburner.multipliers.crime_money.md) | number | (Optional) Multiplier to amount of money gained from crimes | +| [crime\_success?](./bitburner.multipliers.crime_success.md) | number | (Optional) Multiplier to crime success rate | +| [defense\_exp?](./bitburner.multipliers.defense_exp.md) | number | (Optional) Multiplier to defense experience gain rate | +| [defense?](./bitburner.multipliers.defense.md) | number | (Optional) Multiplier to defense skill | +| [dexterity\_exp?](./bitburner.multipliers.dexterity_exp.md) | number | (Optional) Multiplier to dexterity experience gain rate | +| [dexterity?](./bitburner.multipliers.dexterity.md) | number | (Optional) Multiplier to dexterity skill | +| [faction\_rep?](./bitburner.multipliers.faction_rep.md) | number | (Optional) Multiplier to amount of reputation gained when working | +| [hacking\_chance?](./bitburner.multipliers.hacking_chance.md) | number | (Optional) Multiplier to chance of successfully performing a hack | +| [hacking\_exp?](./bitburner.multipliers.hacking_exp.md) | number | (Optional) Multiplier to hacking experience gain rate | +| [hacking\_grow?](./bitburner.multipliers.hacking_grow.md) | number | (Optional) Multiplier to amount of money injected into servers using grow | +| [hacking\_money?](./bitburner.multipliers.hacking_money.md) | number | (Optional) Multiplier to amount of money the player gains from hacking | +| [hacking\_speed?](./bitburner.multipliers.hacking_speed.md) | number | (Optional) Multiplier to hacking speed | +| [hacking?](./bitburner.multipliers.hacking.md) | number | (Optional) Multiplier to hacking skill | +| [hacknet\_node\_core\_cost?](./bitburner.multipliers.hacknet_node_core_cost.md) | number | (Optional) Multiplier to cost of core for a Hacknet Node | +| [hacknet\_node\_level\_cost?](./bitburner.multipliers.hacknet_node_level_cost.md) | number | (Optional) Multiplier to cost of leveling up a Hacknet Node | +| [hacknet\_node\_money?](./bitburner.multipliers.hacknet_node_money.md) | number | (Optional) Multiplier to amount of money produced by Hacknet Nodes | +| [hacknet\_node\_purchase\_cost?](./bitburner.multipliers.hacknet_node_purchase_cost.md) | number | (Optional) Multiplier to cost of purchasing a Hacknet Node | +| [hacknet\_node\_ram\_cost?](./bitburner.multipliers.hacknet_node_ram_cost.md) | number | (Optional) Multiplier to cost of ram for a Hacknet Node | +| [strength\_exp?](./bitburner.multipliers.strength_exp.md) | number | (Optional) Multiplier to strength experience gain rate | +| [strength?](./bitburner.multipliers.strength.md) | number | (Optional) Multiplier to strength skill | +| [work\_money?](./bitburner.multipliers.work_money.md) | number | (Optional) Multiplier to amount of money gained from working | + diff --git a/markdown/bitburner.multipliers.strength.md b/markdown/bitburner.multipliers.strength.md new file mode 100644 index 000000000..408b69020 --- /dev/null +++ b/markdown/bitburner.multipliers.strength.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [strength](./bitburner.multipliers.strength.md) + +## Multipliers.strength property + +Multiplier to strength skill + +Signature: + +```typescript +strength?: number; +``` diff --git a/markdown/bitburner.multipliers.strength_exp.md b/markdown/bitburner.multipliers.strength_exp.md new file mode 100644 index 000000000..351dcc112 --- /dev/null +++ b/markdown/bitburner.multipliers.strength_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [strength\_exp](./bitburner.multipliers.strength_exp.md) + +## Multipliers.strength\_exp property + +Multiplier to strength experience gain rate + +Signature: + +```typescript +strength_exp?: number; +``` diff --git a/markdown/bitburner.multipliers.work_money.md b/markdown/bitburner.multipliers.work_money.md new file mode 100644 index 000000000..ffad7e676 --- /dev/null +++ b/markdown/bitburner.multipliers.work_money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Multipliers](./bitburner.multipliers.md) > [work\_money](./bitburner.multipliers.work_money.md) + +## Multipliers.work\_money property + +Multiplier to amount of money gained from working + +Signature: + +```typescript +work_money?: number; +``` diff --git a/markdown/bitburner.netscriptport.clear.md b/markdown/bitburner.netscriptport.clear.md new file mode 100644 index 000000000..a3c2d5267 --- /dev/null +++ b/markdown/bitburner.netscriptport.clear.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [clear](./bitburner.netscriptport.clear.md) + +## NetscriptPort.clear() method + +Empties all data from the port. + +Signature: + +```typescript +clear(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.netscriptport.empty.md b/markdown/bitburner.netscriptport.empty.md new file mode 100644 index 000000000..50e3b972d --- /dev/null +++ b/markdown/bitburner.netscriptport.empty.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [empty](./bitburner.netscriptport.empty.md) + +## NetscriptPort.empty() method + +Check if the port is empty. + +Signature: + +```typescript +empty(): boolean; +``` +Returns: + +boolean + +true if the port is empty, otherwise false + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.netscriptport.full.md b/markdown/bitburner.netscriptport.full.md new file mode 100644 index 000000000..b21d20999 --- /dev/null +++ b/markdown/bitburner.netscriptport.full.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [full](./bitburner.netscriptport.full.md) + +## NetscriptPort.full() method + +Check if the port is full. + +Signature: + +```typescript +full(): boolean; +``` +Returns: + +boolean + +true if the port is full, otherwise false + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.netscriptport.md b/markdown/bitburner.netscriptport.md new file mode 100644 index 000000000..e18dc5bf0 --- /dev/null +++ b/markdown/bitburner.netscriptport.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) + +## NetscriptPort interface + +Object representing a port. A port is a serialized queue. + +Signature: + +```typescript +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. | +| [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.peek.md b/markdown/bitburner.netscriptport.peek.md new file mode 100644 index 000000000..0eff71996 --- /dev/null +++ b/markdown/bitburner.netscriptport.peek.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [peek](./bitburner.netscriptport.peek.md) + +## NetscriptPort.peek() method + +Retrieve the first element from the port without removing it. + +Signature: + +```typescript +peek(): string | number; +``` +Returns: + +string \| number + +the data read + +## Remarks + +RAM cost: 0 GB + +This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned. + diff --git a/markdown/bitburner.netscriptport.read.md b/markdown/bitburner.netscriptport.read.md new file mode 100644 index 000000000..ecb741f7d --- /dev/null +++ b/markdown/bitburner.netscriptport.read.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [read](./bitburner.netscriptport.read.md) + +## NetscriptPort.read() method + +Shift an element out of the port. + +Signature: + +```typescript +read(): string | number; +``` +Returns: + +string \| number + +the data read. + +## Remarks + +RAM cost: 0 GB + +This function will remove the first element from the port and return it. If the port is empty, then the string “NULL PORT DATA” will be returned. + diff --git a/markdown/bitburner.netscriptport.trywrite.md b/markdown/bitburner.netscriptport.trywrite.md new file mode 100644 index 000000000..0a7df6d19 --- /dev/null +++ b/markdown/bitburner.netscriptport.trywrite.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [tryWrite](./bitburner.netscriptport.trywrite.md) + +## NetscriptPort.tryWrite() method + +Attempt to write data to the port. + +Signature: + +```typescript +tryWrite(value: string | number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | string \| number | | + +Returns: + +boolean + +True if the data was added to the port, false if the port was full + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.netscriptport.write.md b/markdown/bitburner.netscriptport.write.md new file mode 100644 index 000000000..bce036633 --- /dev/null +++ b/markdown/bitburner.netscriptport.write.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NetscriptPort](./bitburner.netscriptport.md) > [write](./bitburner.netscriptport.write.md) + +## NetscriptPort.write() method + +Write data to a port. + +Signature: + +```typescript +write(value: string | number): null | string | number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | string \| number | | + +Returns: + +null \| string \| number + +The data popped off the queue if it was full. + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.nodestats.cache.md b/markdown/bitburner.nodestats.cache.md new file mode 100644 index 000000000..dc7f46034 --- /dev/null +++ b/markdown/bitburner.nodestats.cache.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [cache](./bitburner.nodestats.cache.md) + +## NodeStats.cache property + +Cache level. Only applicable for Hacknet Servers + +Signature: + +```typescript +cache?: number; +``` diff --git a/markdown/bitburner.nodestats.cores.md b/markdown/bitburner.nodestats.cores.md new file mode 100644 index 000000000..1f172625d --- /dev/null +++ b/markdown/bitburner.nodestats.cores.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [cores](./bitburner.nodestats.cores.md) + +## NodeStats.cores property + +Node's number of cores + +Signature: + +```typescript +cores: number; +``` diff --git a/markdown/bitburner.nodestats.hashcapacity.md b/markdown/bitburner.nodestats.hashcapacity.md new file mode 100644 index 000000000..c63301993 --- /dev/null +++ b/markdown/bitburner.nodestats.hashcapacity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [hashCapacity](./bitburner.nodestats.hashcapacity.md) + +## NodeStats.hashCapacity property + +Hash Capacity provided by this Node. Only applicable for Hacknet Servers + +Signature: + +```typescript +hashCapacity?: number; +``` diff --git a/markdown/bitburner.nodestats.level.md b/markdown/bitburner.nodestats.level.md new file mode 100644 index 000000000..f4831524c --- /dev/null +++ b/markdown/bitburner.nodestats.level.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [level](./bitburner.nodestats.level.md) + +## NodeStats.level property + +Node's level + +Signature: + +```typescript +level: number; +``` diff --git a/markdown/bitburner.nodestats.md b/markdown/bitburner.nodestats.md new file mode 100644 index 000000000..538a3fa0e --- /dev/null +++ b/markdown/bitburner.nodestats.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) + +## NodeStats interface + +Object representing all the values related to a hacknet node. + +Signature: + +```typescript +export interface NodeStats +``` + +## Properties + +| Property | 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.nodestats.name.md b/markdown/bitburner.nodestats.name.md new file mode 100644 index 000000000..04b7ec8d2 --- /dev/null +++ b/markdown/bitburner.nodestats.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [name](./bitburner.nodestats.name.md) + +## NodeStats.name property + +Node's name + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.nodestats.production.md b/markdown/bitburner.nodestats.production.md new file mode 100644 index 000000000..efa0eecb0 --- /dev/null +++ b/markdown/bitburner.nodestats.production.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [production](./bitburner.nodestats.production.md) + +## NodeStats.production property + +Node's production per second + +Signature: + +```typescript +production: number; +``` diff --git a/markdown/bitburner.nodestats.ram.md b/markdown/bitburner.nodestats.ram.md new file mode 100644 index 000000000..4160f7b9c --- /dev/null +++ b/markdown/bitburner.nodestats.ram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [ram](./bitburner.nodestats.ram.md) + +## NodeStats.ram property + +Node's RAM (GB) + +Signature: + +```typescript +ram: number; +``` diff --git a/markdown/bitburner.nodestats.ramused.md b/markdown/bitburner.nodestats.ramused.md new file mode 100644 index 000000000..a7f79cfb0 --- /dev/null +++ b/markdown/bitburner.nodestats.ramused.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [ramUsed](./bitburner.nodestats.ramused.md) + +## NodeStats.ramUsed property + +Node's used RAM (GB) + +Signature: + +```typescript +ramUsed?: number; +``` diff --git a/markdown/bitburner.nodestats.timeonline.md b/markdown/bitburner.nodestats.timeonline.md new file mode 100644 index 000000000..0ce7e92e9 --- /dev/null +++ b/markdown/bitburner.nodestats.timeonline.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [timeOnline](./bitburner.nodestats.timeonline.md) + +## NodeStats.timeOnline property + +Number of seconds since Node has been purchased + +Signature: + +```typescript +timeOnline: number; +``` diff --git a/markdown/bitburner.nodestats.totalproduction.md b/markdown/bitburner.nodestats.totalproduction.md new file mode 100644 index 000000000..d5e3c7b7e --- /dev/null +++ b/markdown/bitburner.nodestats.totalproduction.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [totalProduction](./bitburner.nodestats.totalproduction.md) + +## NodeStats.totalProduction property + +Total number of money Node has produced + +Signature: + +```typescript +totalProduction: number; +``` diff --git a/markdown/bitburner.ns.alert.md b/markdown/bitburner.ns.alert.md new file mode 100644 index 000000000..0a9f1ccce --- /dev/null +++ b/markdown/bitburner.ns.alert.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [alert](./bitburner.ns.alert.md) + +## NS.alert() method + +Open up a message box. + +Signature: + +```typescript +alert(msg: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| msg | string | Message to alert. | + +Returns: + +void + diff --git a/markdown/bitburner.ns.args.md b/markdown/bitburner.ns.args.md new file mode 100644 index 000000000..463ae0bd5 --- /dev/null +++ b/markdown/bitburner.ns.args.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [args](./bitburner.ns.args.md) + +## NS.args property + +Arguments passed into the script. + +Signature: + +```typescript +readonly args: (string | number | boolean)[]; +``` + +## Remarks + +RAM cost: 0 GB + +Arguments passed into a script can be accessed using a normal array using the \[\] operator (args\[0\], args\[1\], etc…). + +It is also possible to get the number of arguments that was passed into a script using: 'args.length' WARNING: Do not try to modify the args array. This will break the game. + diff --git a/markdown/bitburner.ns.asleep.md b/markdown/bitburner.ns.asleep.md new file mode 100644 index 000000000..275690aa0 --- /dev/null +++ b/markdown/bitburner.ns.asleep.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [asleep](./bitburner.ns.asleep.md) + +## NS.asleep() method + +Suspends the script for n milliseconds. Doesn't block with concurrent calls. You should prefer 'sleep' over 'asleep' except when doing very complex UI work. + +Signature: + +```typescript +asleep(millis: number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| millis | number | Number of milliseconds to sleep. | + +Returns: + +Promise<true> + + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.atexit.md b/markdown/bitburner.ns.atexit.md new file mode 100644 index 000000000..872dbfc8c --- /dev/null +++ b/markdown/bitburner.ns.atexit.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [atExit](./bitburner.ns.atexit.md) + +## NS.atExit() method + +Add callback function when the script dies + +Signature: + +```typescript +atExit(f: () => void): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| f | () => void | | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +NS2 exclusive + +Add callback to be executed when the script dies. + diff --git a/markdown/bitburner.ns.bladeburner.md b/markdown/bitburner.ns.bladeburner.md new file mode 100644 index 000000000..77ab1fef7 --- /dev/null +++ b/markdown/bitburner.ns.bladeburner.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [bladeburner](./bitburner.ns.bladeburner.md) + +## NS.bladeburner property + +Namespace for bladeburner functions. + +Signature: + +```typescript +readonly bladeburner: Bladeburner; +``` + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.brutessh.md b/markdown/bitburner.ns.brutessh.md new file mode 100644 index 000000000..071fc6854 --- /dev/null +++ b/markdown/bitburner.ns.brutessh.md @@ -0,0 +1,46 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [brutessh](./bitburner.ns.brutessh.md) + +## NS.brutessh() method + +Runs BruteSSH.exe on a server. + +Signature: + +```typescript +brutessh(host: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +void + +## Remarks + +RAM cost: 0.05 GB + +Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer. + +## Example 1 + + +```ts +// NS1: +brutessh("foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +ns.brutessh("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.clear.md b/markdown/bitburner.ns.clear.md new file mode 100644 index 000000000..263f0f969 --- /dev/null +++ b/markdown/bitburner.ns.clear.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [clear](./bitburner.ns.clear.md) + +## NS.clear() method + +Clear data from a file. + +Signature: + +```typescript +clear(handle: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| handle | string | Text file to clear. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +Delete all data from that text file. + diff --git a/markdown/bitburner.ns.clearlog.md b/markdown/bitburner.ns.clearlog.md new file mode 100644 index 000000000..9e33e2d42 --- /dev/null +++ b/markdown/bitburner.ns.clearlog.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [clearLog](./bitburner.ns.clearlog.md) + +## NS.clearLog() method + +Clears the script’s logs. + +Signature: + +```typescript +clearLog(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.clearport.md b/markdown/bitburner.ns.clearport.md new file mode 100644 index 000000000..50038926f --- /dev/null +++ b/markdown/bitburner.ns.clearport.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [clearPort](./bitburner.ns.clearport.md) + +## NS.clearPort() method + +Clear data from a port. + +Signature: + +```typescript +clearPort(handle: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| handle | number | Port to clear. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +Delete all data from the underlying queue. + diff --git a/markdown/bitburner.ns.closetail.md b/markdown/bitburner.ns.closetail.md new file mode 100644 index 000000000..261f0ece4 --- /dev/null +++ b/markdown/bitburner.ns.closetail.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [closeTail](./bitburner.ns.closetail.md) + +## NS.closeTail() method + +Close the tail window of a script. + +Signature: + +```typescript +closeTail(pid?: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| pid | number | Optional. PID of the script having its tail closed. If omitted, the current script is used. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +Closes a script’s logs. This is functionally the same pressing the "Close" button on the tail window. + +If the function is called with no arguments, it will close the current script’s logs. + +Otherwise, the pid argument can be used to close the logs from another script. + diff --git a/markdown/bitburner.ns.codingcontract.md b/markdown/bitburner.ns.codingcontract.md new file mode 100644 index 000000000..2b4cd02cc --- /dev/null +++ b/markdown/bitburner.ns.codingcontract.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [codingcontract](./bitburner.ns.codingcontract.md) + +## NS.codingcontract property + +Namespace for codingcontract functions. + +Signature: + +```typescript +readonly codingcontract: CodingContract; +``` + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.corporation.md b/markdown/bitburner.ns.corporation.md new file mode 100644 index 000000000..92ffd5222 --- /dev/null +++ b/markdown/bitburner.ns.corporation.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [corporation](./bitburner.ns.corporation.md) + +## NS.corporation property + +Namespace for corporation functions. RAM cost: 1022.4 GB + +Signature: + +```typescript +readonly corporation: Corporation; +``` diff --git a/markdown/bitburner.ns.deleteserver.md b/markdown/bitburner.ns.deleteserver.md new file mode 100644 index 000000000..6e1255dcf --- /dev/null +++ b/markdown/bitburner.ns.deleteserver.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [deleteServer](./bitburner.ns.deleteserver.md) + +## NS.deleteServer() method + +Delete a purchased server. + +Signature: + +```typescript +deleteServer(host: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of the server to delete. | + +Returns: + +boolean + +True if successful, and false otherwise. + +## Remarks + +2.25 GB + +Deletes one of your purchased servers, which is specified by its hostname. + +The hostname argument can be any data type, but it will be converted to a string. Whitespace is automatically removed from the string. This function will not delete a server that still has scripts running on it. + diff --git a/markdown/bitburner.ns.disablelog.md b/markdown/bitburner.ns.disablelog.md new file mode 100644 index 000000000..c04b5e939 --- /dev/null +++ b/markdown/bitburner.ns.disablelog.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [disableLog](./bitburner.ns.disablelog.md) + +## NS.disableLog() method + +Disables logging for the given function. + +Signature: + +```typescript +disableLog(fn: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Name of function for which to disable logging. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +Logging can be disabled for all functions by passing `ALL` as the argument. + +Note that this does not completely remove all logging functionality. This only stops a function from logging when the function is successful. If the function fails, it will still log the reason for failure. + diff --git a/markdown/bitburner.ns.enablelog.md b/markdown/bitburner.ns.enablelog.md new file mode 100644 index 000000000..415e3a145 --- /dev/null +++ b/markdown/bitburner.ns.enablelog.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [enableLog](./bitburner.ns.enablelog.md) + +## NS.enableLog() method + +Enable logging for a certain function. + +Signature: + +```typescript +enableLog(fn: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Name of function for which to enable logging. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +Re-enables logging for the given function. If `ALL` is passed into this function as an argument, then it will revert the effects of disableLog(`ALL`). + diff --git a/markdown/bitburner.ns.enums.md b/markdown/bitburner.ns.enums.md new file mode 100644 index 000000000..8e1654518 --- /dev/null +++ b/markdown/bitburner.ns.enums.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [enums](./bitburner.ns.enums.md) + +## NS.enums property + +Signature: + +```typescript +enums: NSEnums; +``` diff --git a/markdown/bitburner.ns.exec.md b/markdown/bitburner.ns.exec.md new file mode 100644 index 000000000..3aea59eca --- /dev/null +++ b/markdown/bitburner.ns.exec.md @@ -0,0 +1,81 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [exec](./bitburner.ns.exec.md) + +## NS.exec() method + +Start another script on any server. + +Signature: + +```typescript +exec(script: string, host: string, numThreads?: number, ...args: (string | number | boolean)[]): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename of script to execute. | +| host | string | Hostname of the target server on which to execute the script. | +| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded down to the nearest integer. | +| args | (string \| number \| boolean)\[\] | 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 numThreads must be filled in with a value. | + +Returns: + +number + +Returns the PID of a successfully started script, and 0 otherwise. + +## Remarks + +RAM cost: 1.3 GB + +Run a script as a separate process on a specified server. This is similar to the function [run](./bitburner.ns.run.md) except that it can be used to run a script on any server, instead of just the current server. + +If the script was successfully started, then this function returns the PID of that script. Otherwise, it returns 0. + +PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. + +Running this function with a numThreads argument of 0 or less will cause a runtime error. + +## Example 1 + + +```ts +// NS1: +// The simplest way to use the exec command is to call it with just the script name +// and the target server. The following example will try to run generic-hack.script +// on the foodnstuff server. +exec("generic-hack.script", "foodnstuff"); + +// The following example will try to run the script generic-hack.script on the +// joesguns server with 10 threads. +exec("generic-hack.script", "joesguns", 10); + +// This last example will try to run the script foo.script on the foodnstuff server +// with 5 threads. It will also pass the number 1 and the string “test” in as +// arguments to the script. +exec("foo.script", "foodnstuff", 5, 1, "test"); +``` + +## Example 2 + + +```ts +// NS2: +// The simplest way to use the exec command is to call it with just the script name +// and the target server. The following example will try to run generic-hack.script +// on the foodnstuff server. +ns.exec("generic-hack.script", "foodnstuff"); + +// The following example will try to run the script generic-hack.script on the +// joesguns server with 10 threads. +ns.exec("generic-hack.script", "joesguns", 10); + +// This last example will try to run the script foo.script on the foodnstuff server +// with 5 threads. It will also pass the number 1 and the string “test” in as +// arguments to the script. +ns.exec("foo.script", "foodnstuff", 5, 1, "test"); +``` + diff --git a/markdown/bitburner.ns.exit.md b/markdown/bitburner.ns.exit.md new file mode 100644 index 000000000..de6dd483c --- /dev/null +++ b/markdown/bitburner.ns.exit.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [exit](./bitburner.ns.exit.md) + +## NS.exit() method + +Terminates the current script immediately. + +Signature: + +```typescript +exit(): never; +``` +Returns: + +never + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.fileexists.md b/markdown/bitburner.ns.fileexists.md new file mode 100644 index 000000000..839830b48 --- /dev/null +++ b/markdown/bitburner.ns.fileexists.md @@ -0,0 +1,60 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [fileExists](./bitburner.ns.fileexists.md) + +## NS.fileExists() method + +Check if a file exists. + +Signature: + +```typescript +fileExists(filename: string, host?: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | Filename of file to check. | +| host | string | Host of target server. This is optional. If it is not specified then the function will use the current server as the target server. | + +Returns: + +boolean + +True if specified file exists, and false otherwise. + +## Remarks + +RAM cost: 0.1 GB + +Returns a boolean indicating whether the specified file exists on the target server. The filename for scripts is case-sensitive, but for other types of files it is not. For example, fileExists(“brutessh.exe”) will work fine, even though the actual program is named 'BruteSSH.exe'. + +If the hostname/ip argument is omitted, then the function will search through the current server (the server running the script that calls this function) for the file. + +## Example 1 + + +```ts +// NS1: +//The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise. +fileExists("foo.script", "foodnstuff"); + +//The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise. +fileExists("ftpcrack.exe"); +``` +\* + +## Example 2 + + +```ts +// NS2: +// The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise. +ns.fileExists("foo.script", "foodnstuff"); + +// The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise. +ns.fileExists("ftpcrack.exe"); +``` + diff --git a/markdown/bitburner.ns.flags.md b/markdown/bitburner.ns.flags.md new file mode 100644 index 000000000..efdae5512 --- /dev/null +++ b/markdown/bitburner.ns.flags.md @@ -0,0 +1,68 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [flags](./bitburner.ns.flags.md) + +## NS.flags() method + +Parse command line flags. + +Signature: + +```typescript +flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] }; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | | + +Returns: + +{ \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) \| string\[\] } + +## Remarks + +RAM cost: 0 GB + +Allows unix like flag parsing. + +## Example + + +```ts +// example.script +var data = flags([ + ['delay', 0], // a default number means this flag is a number + ['server', 'foodnstuff'], // a default string means this flag is a string + ['exclude', []], // a default array means this flag is a default array of string + ['help', false], // a default boolean means this flag is a boolean +]); +tprint(data); + +// example.js +export async function main(ns) { + const data = ns.flags([ + ['delay', 0], // a default number means this flag is a number + ['server', 'foodnstuff'], // a default string means this flag is a string + ['exclude', []], // a default array means this flag is a default array of string + ['help', false], // a default boolean means this flag is a boolean + ]); + ns.tprint(data); +} + +// [home ~/]> run example.script +// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false} +// [home ~/]> run example.script --delay 3000 +// {"_":[],"server":"foodnstuff","exclude":[],"help":false,"delay":3000} +// [home ~/]> run example.script --delay 3000 --server harakiri-sushi +// {"_":[],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"} +// [home ~/]> run example.script --delay 3000 --server harakiri-sushi hello world +// {"_":["hello","world"],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"} +// [home ~/]> run example.script --delay 3000 --server harakiri-sushi hello world --exclude a --exclude b +// {"_":["hello","world"],"help":false,"delay":3000,"server":"harakiri-sushi","exclude":["a","b"]} +// [home ~/]> run example.script --help +// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true} +``` + diff --git a/markdown/bitburner.ns.formulas.md b/markdown/bitburner.ns.formulas.md new file mode 100644 index 000000000..0d7de9755 --- /dev/null +++ b/markdown/bitburner.ns.formulas.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [formulas](./bitburner.ns.formulas.md) + +## NS.formulas property + +Namespace for formulas functions. + +Signature: + +```typescript +readonly formulas: Formulas; +``` + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.ftpcrack.md b/markdown/bitburner.ns.ftpcrack.md new file mode 100644 index 000000000..27b58dc53 --- /dev/null +++ b/markdown/bitburner.ns.ftpcrack.md @@ -0,0 +1,46 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [ftpcrack](./bitburner.ns.ftpcrack.md) + +## NS.ftpcrack() method + +Runs FTPCrack.exe on a server. + +Signature: + +```typescript +ftpcrack(host: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +void + +## Remarks + +RAM cost: 0.05 GB + +Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer. + +## Example 1 + + +```ts +// NS1: +ftpcrack("foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +ns.ftpcrack("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.gang.md b/markdown/bitburner.ns.gang.md new file mode 100644 index 000000000..b9c0918bc --- /dev/null +++ b/markdown/bitburner.ns.gang.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [gang](./bitburner.ns.gang.md) + +## NS.gang property + +Namespace for gang functions. + +Signature: + +```typescript +readonly gang: Gang; +``` + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.getbitnodemultipliers.md b/markdown/bitburner.ns.getbitnodemultipliers.md new file mode 100644 index 000000000..ff929436e --- /dev/null +++ b/markdown/bitburner.ns.getbitnodemultipliers.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getBitNodeMultipliers](./bitburner.ns.getbitnodemultipliers.md) + +## NS.getBitNodeMultipliers() method + +Get the current Bitnode multipliers. + +Signature: + +```typescript +getBitNodeMultipliers(): BitNodeMultipliers; +``` +Returns: + +[BitNodeMultipliers](./bitburner.bitnodemultipliers.md) + +Object containing the current BitNode multipliers. + +## Remarks + +RAM cost: 4 GB + +Returns an object containing the current BitNode multipliers. This function requires you to be in Bitnode 5 or have Source-File 5 in order to run. The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). The multipliers represent the difference between the current BitNode and the original BitNode (BitNode-1). + +For example, if the CrimeMoney multiplier has a value of 0.1, then that means that committing crimes in the current BitNode will only give 10% of the money you would have received in BitNode-1. + +## Example 1 + + +```ts +// NS1: +var mults = getBitNodeMultipliers(); +print(mults.ServerMaxMoney); +print(mults.HackExpGain); +``` + +## Example 2 + + +```ts +// NS2: +const {ServerMaxMoney, HackExpGain} = ns.getBitNodeMultipliers(); +print(ServerMaxMoney); +print(HackExpGain); +``` + diff --git a/markdown/bitburner.ns.getfavortodonate.md b/markdown/bitburner.ns.getfavortodonate.md new file mode 100644 index 000000000..0d4ac030b --- /dev/null +++ b/markdown/bitburner.ns.getfavortodonate.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getFavorToDonate](./bitburner.ns.getfavortodonate.md) + +## NS.getFavorToDonate() method + +Returns the amount of Faction favor required to be able to donate to a faction. + +Signature: + +```typescript +getFavorToDonate(): number; +``` +Returns: + +number + +Amount of Faction favor required to be able to donate to a faction. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.getgrowtime.md b/markdown/bitburner.ns.getgrowtime.md new file mode 100644 index 000000000..5f98d3132 --- /dev/null +++ b/markdown/bitburner.ns.getgrowtime.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getGrowTime](./bitburner.ns.getgrowtime.md) + +## NS.getGrowTime() method + +Get the execution time of a grow() call. + +Signature: + +```typescript +getGrowTime(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +Returns the amount of time in milliseconds it takes to execute the grow Netscript function. + +## Remarks + +RAM cost: 0.05 GB + +Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server. The required time is increased by the security level of the target server and decreased by the player's hacking level. + diff --git a/markdown/bitburner.ns.gethackinglevel.md b/markdown/bitburner.ns.gethackinglevel.md new file mode 100644 index 000000000..2499e349c --- /dev/null +++ b/markdown/bitburner.ns.gethackinglevel.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHackingLevel](./bitburner.ns.gethackinglevel.md) + +## NS.getHackingLevel() method + +Returns the player’s current hacking level. + +Signature: + +```typescript +getHackingLevel(): number; +``` +Returns: + +number + +Player’s current hacking level + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.ns.gethackingmultipliers.md b/markdown/bitburner.ns.gethackingmultipliers.md new file mode 100644 index 000000000..f44258729 --- /dev/null +++ b/markdown/bitburner.ns.gethackingmultipliers.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHackingMultipliers](./bitburner.ns.gethackingmultipliers.md) + +## NS.getHackingMultipliers() method + +Get hacking related multipliers. + +Signature: + +```typescript +getHackingMultipliers(): HackingMultipliers; +``` +Returns: + +[HackingMultipliers](./bitburner.hackingmultipliers.md) + +Object containing the Player’s hacking related multipliers. + +## Remarks + +RAM cost: 4 GB + +Returns an object containing the Player’s hacking related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%). + +## Example 1 + + +```ts +// NS1: +// Example of how this can be used: +var mults = getHackingMultipliers(); +print(mults.chance); +print(mults.growth); +``` + +## Example 2 + + +```ts +// NS2: +// Example of how this can be used: +const {chance, growth} = ns.getHackingMultipliers(); +print(chance); +print(growth); +``` + diff --git a/markdown/bitburner.ns.gethacknetmultipliers.md b/markdown/bitburner.ns.gethacknetmultipliers.md new file mode 100644 index 000000000..c720f04a4 --- /dev/null +++ b/markdown/bitburner.ns.gethacknetmultipliers.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHacknetMultipliers](./bitburner.ns.gethacknetmultipliers.md) + +## NS.getHacknetMultipliers() method + +Get hacknet related multipliers. + +Signature: + +```typescript +getHacknetMultipliers(): HacknetMultipliers; +``` +Returns: + +[HacknetMultipliers](./bitburner.hacknetmultipliers.md) + +Object containing the Player’s hacknet related multipliers. + +## Remarks + +RAM cost: 4 GB + +Returns an object containing the Player’s hacknet related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%). + +## Example 1 + + +```ts +// NS1: +// Example of how this can be used: +var mults = getHacknetMultipliers(); +print(mults.production); +print(mults.purchaseCost); +``` + +## Example 2 + + +```ts +// NS2: +// Example of how this can be used: +const {production, purchaseCost} = ns.getHacknetMultipliers(); +print(production); +print(purchaseCost); +``` + diff --git a/markdown/bitburner.ns.gethacktime.md b/markdown/bitburner.ns.gethacktime.md new file mode 100644 index 000000000..4f293549a --- /dev/null +++ b/markdown/bitburner.ns.gethacktime.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHackTime](./bitburner.ns.gethacktime.md) + +## NS.getHackTime() method + +Get the execution time of a hack() call. + +Signature: + +```typescript +getHackTime(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +Returns the amount of time in milliseconds it takes to execute the hack Netscript function. + +## Remarks + +RAM cost: 0.05 GB + +When `hack` completes an amount of money is stolen depending on the player's skills. Returns the amount of time in milliseconds it takes to execute the hack Netscript function on the target server. The required time is increased by the security level of the target server and decreased by the player's hacking level. + diff --git a/markdown/bitburner.ns.gethostname.md b/markdown/bitburner.ns.gethostname.md new file mode 100644 index 000000000..5813ff78b --- /dev/null +++ b/markdown/bitburner.ns.gethostname.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHostname](./bitburner.ns.gethostname.md) + +## NS.getHostname() method + +Returns a string with the hostname of the server that the script is running on. + +Signature: + +```typescript +getHostname(): string; +``` +Returns: + +string + +Hostname of the server that the script is on. + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.ns.getplayer.md b/markdown/bitburner.ns.getplayer.md new file mode 100644 index 000000000..737a9a447 --- /dev/null +++ b/markdown/bitburner.ns.getplayer.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPlayer](./bitburner.ns.getplayer.md) + +## NS.getPlayer() method + +Get information about the player. + +Signature: + +```typescript +getPlayer(): Player; +``` +Returns: + +[Player](./bitburner.player.md) + +Player info + +## Remarks + +RAM cost: 0.5 GB + +Returns an object with information on the current player. + diff --git a/markdown/bitburner.ns.getporthandle.md b/markdown/bitburner.ns.getporthandle.md new file mode 100644 index 000000000..b448275ca --- /dev/null +++ b/markdown/bitburner.ns.getporthandle.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPortHandle](./bitburner.ns.getporthandle.md) + +## NS.getPortHandle() method + +Get all data on a port. + +Signature: + +```typescript +getPortHandle(port: number): NetscriptPort; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| port | number | Port number. Must be an integer between 1 and 20. | + +Returns: + +[NetscriptPort](./bitburner.netscriptport.md) + +## Remarks + +RAM cost: 0 GB + +Get a handle to a Netscript Port. + +WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0. + diff --git a/markdown/bitburner.ns.getpurchasedservercost.md b/markdown/bitburner.ns.getpurchasedservercost.md new file mode 100644 index 000000000..ece08176d --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedservercost.md @@ -0,0 +1,52 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServerCost](./bitburner.ns.getpurchasedservercost.md) + +## NS.getPurchasedServerCost() method + +Get cost of purchasing a server. + +Signature: + +```typescript +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). | + +Returns: + +number + +The cost to purchase a server with the specified amount of ram. + +## Remarks + +RAM cost: 0.25 GB + +Returns the cost to purchase a server with the specified amount of ram. + +## Example 1 + + +```ts +// NS1: +for (i = 1; i <= 20; i++) { + tprint(i + " -- " + getPurchasedServerCost(Math.pow(2, i))); +} +``` + +## Example 2 + + +```ts +// NS2: +for (i = 1; i <= 20; i++) { + ns.tprint(i + " -- " + ns.getPurchasedServerCost(Math.pow(2, i))); +} +``` + diff --git a/markdown/bitburner.ns.getpurchasedserverlimit.md b/markdown/bitburner.ns.getpurchasedserverlimit.md new file mode 100644 index 000000000..b4c0de297 --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedserverlimit.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServerLimit](./bitburner.ns.getpurchasedserverlimit.md) + +## NS.getPurchasedServerLimit() method + +Returns the maximum number of servers you can purchase. + +Signature: + +```typescript +getPurchasedServerLimit(): number; +``` +Returns: + +number + +Returns the maximum number of servers you can purchase. + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.ns.getpurchasedservermaxram.md b/markdown/bitburner.ns.getpurchasedservermaxram.md new file mode 100644 index 000000000..d48a0ef88 --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedservermaxram.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServerMaxRam](./bitburner.ns.getpurchasedservermaxram.md) + +## NS.getPurchasedServerMaxRam() method + +Returns the maximum RAM that a purchased server can have. + +Signature: + +```typescript +getPurchasedServerMaxRam(): number; +``` +Returns: + +number + +Returns the maximum RAM (in GB) that a purchased server can have. + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.ns.getpurchasedservers.md b/markdown/bitburner.ns.getpurchasedservers.md new file mode 100644 index 000000000..3117ef93c --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedservers.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServers](./bitburner.ns.getpurchasedservers.md) + +## NS.getPurchasedServers() method + +Returns an array with the hostnames of all of the servers you have purchased. + +Signature: + +```typescript +getPurchasedServers(): string[]; +``` +Returns: + +string\[\] + +Returns an array with the hostnames of all of the servers you have purchased. + +## Remarks + +2.25 GB + diff --git a/markdown/bitburner.ns.getpurchasedserverupgradecost.md b/markdown/bitburner.ns.getpurchasedserverupgradecost.md new file mode 100644 index 000000000..f00891b60 --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedserverupgradecost.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServerUpgradeCost](./bitburner.ns.getpurchasedserverupgradecost.md) + +## NS.getPurchasedServerUpgradeCost() method + +Get cost of upgrading a purchased server to the given ram. + +Signature: + +```typescript +getPurchasedServerUpgradeCost(hostname: string, ram: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | Hostname 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: + +number + +The price to upgrade. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.getrecentscripts.md b/markdown/bitburner.ns.getrecentscripts.md new file mode 100644 index 000000000..d02afe86c --- /dev/null +++ b/markdown/bitburner.ns.getrecentscripts.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getRecentScripts](./bitburner.ns.getrecentscripts.md) + +## NS.getRecentScripts() method + +Get an array of recently killed scripts across all servers. + +Signature: + +```typescript +getRecentScripts(): RecentScript[]; +``` +Returns: + +[RecentScript](./bitburner.recentscript.md)\[\] + +Array with information about previously killed scripts. + +## Remarks + +RAM cost: 0.2 GB + +The most recently killed script is the first element in the array. Note that there is a maximum number of recently killed scripts which are tracked. This is configurable in the game's options as `Recently killed scripts size`. + +## Example + + +```ts +let recentScripts = ns.getRecentScripts(); +let mostRecent = recentScripts.shift() +if (mostRecent) + ns.tprint(mostRecent.logs.join('\n')) +``` + diff --git a/markdown/bitburner.ns.getrunningscript.md b/markdown/bitburner.ns.getrunningscript.md new file mode 100644 index 000000000..dc7488f17 --- /dev/null +++ b/markdown/bitburner.ns.getrunningscript.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getRunningScript](./bitburner.ns.getrunningscript.md) + +## NS.getRunningScript() method + +Get general info about a running script. + +Signature: + +```typescript +getRunningScript( + filename?: FilenameOrPID, + hostname?: string, + ...args: (string | number | boolean)[] + ): RunningScript | null; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. | +| hostname | string | Optional. Name of host server the script is running on. | +| args | (string \| number \| boolean)\[\] | Arguments to identify the script | + +Returns: + +[RunningScript](./bitburner.runningscript.md) \| null + +The info about the running script if found, and null otherwise. + +## Remarks + +RAM cost: 0.3 GB + +Running with no args returns current script. If you use a PID as the first parameter, the hostname and args parameters are unnecessary. + diff --git a/markdown/bitburner.ns.getscriptexpgain.md b/markdown/bitburner.ns.getscriptexpgain.md new file mode 100644 index 000000000..0e4baa4f3 --- /dev/null +++ b/markdown/bitburner.ns.getscriptexpgain.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptExpGain](./bitburner.ns.getscriptexpgain.md) + +## NS.getScriptExpGain() method + +Get the exp gain of a script. + +Signature: + +```typescript +getScriptExpGain(script: string, host: string, ...args: (string | number | boolean)[]): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename of script. | +| host | string | Server on which script is running. | +| args | (string \| number \| boolean)\[\] | Arguments that the script is running with. | + +Returns: + +number + +Amount of hacking experience the specified script generates while online. + +## Remarks + +RAM cost: 0.1 GB + +Returns the amount of hacking experience the specified script generates while online (when the game is open, does not apply for offline experience gains). Remember that a script is uniquely identified by both its name and its arguments. + +This function can also return the total experience gain rate of all of your active scripts by running the function with no arguments. + diff --git a/markdown/bitburner.ns.getscriptincome.md b/markdown/bitburner.ns.getscriptincome.md new file mode 100644 index 000000000..8d226d597 --- /dev/null +++ b/markdown/bitburner.ns.getscriptincome.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptIncome](./bitburner.ns.getscriptincome.md) + +## NS.getScriptIncome() method + +Get the income of a script. + +Signature: + +```typescript +getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename of script. | +| host | string | Server on which script is running. | +| args | (string \| number \| boolean)\[\] | Arguments that the script is running with. | + +Returns: + +number + +Amount of income the specified script generates while online. + +## Remarks + +RAM cost: 0.1 GB + +Returns the amount of income the specified script generates while online (when the game is open, does not apply for offline income). Remember that a script is uniquely identified by both its name and its arguments. So for example if you ran a script with the arguments “foodnstuff” and “5” then in order to use this function to get that script’s income you must specify those same arguments in the same order in this function call. + diff --git a/markdown/bitburner.ns.getscriptlogs.md b/markdown/bitburner.ns.getscriptlogs.md new file mode 100644 index 000000000..4d950fdb3 --- /dev/null +++ b/markdown/bitburner.ns.getscriptlogs.md @@ -0,0 +1,66 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptLogs](./bitburner.ns.getscriptlogs.md) + +## NS.getScriptLogs() method + +Get all the logs of a script. + +Signature: + +```typescript +getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Optional. Filename of script to get logs from. | +| host | string | Optional. Hostname of the server that the script is on. | +| args | (string \| number \| boolean)\[\] | Arguments to identify which scripts to get logs for. | + +Returns: + +string\[\] + +Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array. + +## Remarks + +RAM cost: 0 GB + +Returns a script’s logs. The logs are returned as an array, where each line is an element in the array. The most recently logged line is at the end of the array. Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the game’s options. If the function is called with no arguments, it will return the current script’s logs. + +Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments. + +## Example 1 + + +```ts +// NS1: +//Get logs from foo.script on the current server that was run with no args +getScriptLogs("foo.script"); + +//Open logs from foo.script on the foodnstuff server that was run with no args +getScriptLogs("foo.script", "foodnstuff"); + +//Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] +getScriptLogs("foo.script", "foodnstuff", 1, "test"); +``` + +## Example 2 + + +```ts +// NS2: +//Get logs from foo.script on the current server that was run with no args +ns.getScriptLogs("foo.script"); + +//Open logs from foo.script on the foodnstuff server that was run with no args +ns.getScriptLogs("foo.script", "foodnstuff"); + +//Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] +ns.getScriptLogs("foo.script", "foodnstuff", 1, "test"); +``` + diff --git a/markdown/bitburner.ns.getscriptname.md b/markdown/bitburner.ns.getscriptname.md new file mode 100644 index 000000000..99566c884 --- /dev/null +++ b/markdown/bitburner.ns.getscriptname.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptName](./bitburner.ns.getscriptname.md) + +## NS.getScriptName() method + +Returns the current script name. + +Signature: + +```typescript +getScriptName(): string; +``` +Returns: + +string + +Current script name. + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.getscriptram.md b/markdown/bitburner.ns.getscriptram.md new file mode 100644 index 000000000..1e487458d --- /dev/null +++ b/markdown/bitburner.ns.getscriptram.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptRam](./bitburner.ns.getscriptram.md) + +## NS.getScriptRam() method + +Get the ram cost of a script. + +Signature: + +```typescript +getScriptRam(script: string, host?: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename of script. This is case-sensitive. | +| host | string | Host 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: + +number + +Amount of RAM (in GB) required to run the specified script on the target server, and 0 if the script does not exist. + +## Remarks + +RAM cost: 0.1 GB + +Returns the amount of RAM required to run the specified script on the target server. Returns 0 if the script does not exist. + diff --git a/markdown/bitburner.ns.getserver.md b/markdown/bitburner.ns.getserver.md new file mode 100644 index 000000000..95d130658 --- /dev/null +++ b/markdown/bitburner.ns.getserver.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServer](./bitburner.ns.getserver.md) + +## NS.getServer() method + +Returns a server object for the given server. Defaults to the running script's server if host is not specified. + +Signature: + +```typescript +getServer(host?: string): Server; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Optional. Hostname for the requested server object. | + +Returns: + +[Server](./bitburner.server.md) + +The requested server object. + +## Remarks + +RAM cost: 2 GB + diff --git a/markdown/bitburner.ns.getserverbasesecuritylevel.md b/markdown/bitburner.ns.getserverbasesecuritylevel.md new file mode 100644 index 000000000..14394b32e --- /dev/null +++ b/markdown/bitburner.ns.getserverbasesecuritylevel.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerBaseSecurityLevel](./bitburner.ns.getserverbasesecuritylevel.md) + +## NS.getServerBaseSecurityLevel() method + +> Warning: This API is now obsolete. +> +> useless +> + +Signature: + +```typescript +getServerBaseSecurityLevel(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +Base security level of the target server. + +## Remarks + +RAM cost: 0.1 GB Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s). + diff --git a/markdown/bitburner.ns.getservergrowth.md b/markdown/bitburner.ns.getservergrowth.md new file mode 100644 index 000000000..b0e24966b --- /dev/null +++ b/markdown/bitburner.ns.getservergrowth.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerGrowth](./bitburner.ns.getservergrowth.md) + +## NS.getServerGrowth() method + +Get a server growth parameter. + +Signature: + +```typescript +getServerGrowth(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +Parameter that affects the percentage by which the server’s money is increased when using the grow function. + +## Remarks + +RAM cost: 0.1 GB + +Returns the server’s intrinsic “growth parameter”. This growth parameter is a number typically between 0 and 100 that represents how quickly the server’s money grows. This parameter affects the percentage by which the server’s money is increased when using the grow function. A higher growth parameter will result in a higher percentage increase from grow. + diff --git a/markdown/bitburner.ns.getservermaxmoney.md b/markdown/bitburner.ns.getservermaxmoney.md new file mode 100644 index 000000000..6302af323 --- /dev/null +++ b/markdown/bitburner.ns.getservermaxmoney.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerMaxMoney](./bitburner.ns.getservermaxmoney.md) + +## NS.getServerMaxMoney() method + +Get maximum money available on a server. + +Signature: + +```typescript +getServerMaxMoney(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +Maximum amount of money available on the server. + +## Remarks + +RAM cost: 0.1 GB + +Returns the maximum amount of money that can be available on a server. + diff --git a/markdown/bitburner.ns.getservermaxram.md b/markdown/bitburner.ns.getservermaxram.md new file mode 100644 index 000000000..6a0cca314 --- /dev/null +++ b/markdown/bitburner.ns.getservermaxram.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerMaxRam](./bitburner.ns.getservermaxram.md) + +## NS.getServerMaxRam() method + +Get the max RAM on a server. + +Signature: + +```typescript +getServerMaxRam(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +number + +max ram (GB) + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.ns.getserverminsecuritylevel.md b/markdown/bitburner.ns.getserverminsecuritylevel.md new file mode 100644 index 000000000..5cdf56e77 --- /dev/null +++ b/markdown/bitburner.ns.getserverminsecuritylevel.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerMinSecurityLevel](./bitburner.ns.getserverminsecuritylevel.md) + +## NS.getServerMinSecurityLevel() method + +Returns the minimum security level of the target server. + +Signature: + +```typescript +getServerMinSecurityLevel(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +Minimum security level of the target server. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.getservermoneyavailable.md b/markdown/bitburner.ns.getservermoneyavailable.md new file mode 100644 index 000000000..de3232ae3 --- /dev/null +++ b/markdown/bitburner.ns.getservermoneyavailable.md @@ -0,0 +1,50 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerMoneyAvailable](./bitburner.ns.getservermoneyavailable.md) + +## NS.getServerMoneyAvailable() method + +Get money available on a server. + +Signature: + +```typescript +getServerMoneyAvailable(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server | + +Returns: + +number + +Amount of money available on the server. + +## Remarks + +RAM cost: 0.1 GB + +Returns the amount of money available on a server. Running this function on the home computer will return the player’s money. + +## Example 1 + + +```ts +// NS1: +getServerMoneyAvailable("foodnstuff"); +getServerMoneyAvailable("home"); //Returns player's money +``` + +## Example 2 + + +```ts +// NS2: +ns.getServerMoneyAvailable("foodnstuff"); +ns.getServerMoneyAvailable("home"); // Returns player's money +``` + diff --git a/markdown/bitburner.ns.getservernumportsrequired.md b/markdown/bitburner.ns.getservernumportsrequired.md new file mode 100644 index 000000000..5237a9967 --- /dev/null +++ b/markdown/bitburner.ns.getservernumportsrequired.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerNumPortsRequired](./bitburner.ns.getservernumportsrequired.md) + +## NS.getServerNumPortsRequired() method + +Returns the number of open ports required to successfully run NUKE.exe on the specified server. + +Signature: + +```typescript +getServerNumPortsRequired(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +The number of open ports required to successfully run NUKE.exe on the specified server. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.getserverram.md b/markdown/bitburner.ns.getserverram.md new file mode 100644 index 000000000..8e0844bd8 --- /dev/null +++ b/markdown/bitburner.ns.getserverram.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerRam](./bitburner.ns.getserverram.md) + +## NS.getServerRam() method + +> Warning: This API is now obsolete. +> +> use getServerMaxRam / getServerUsedRam +> + +Signature: + +```typescript +getServerRam(host: string): [number, number]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +\[number, number\] + +Array with total and used memory on the specified server, in GB. + +## Remarks + +RAM cost: 0.1 GB + +Returns an array with two elements that gives information about a server’s memory (RAM). The first element in the array is the amount of RAM that the server has total (in GB). The second element in the array is the amount of RAM that is currently being used on the server (in GB). + +## Example 1 + + +```ts +// NS1: +var serverRam = getServerRam("helios"); +var totalRam = serverRam[0]; +var ramUsed = serverRam[1]; +``` + +## Example 2 + + +```ts +// NS2: +const [totalRam, ramUsed] = ns.getServerRam("helios"); +``` + diff --git a/markdown/bitburner.ns.getserverrequiredhackinglevel.md b/markdown/bitburner.ns.getserverrequiredhackinglevel.md new file mode 100644 index 000000000..1816e21ba --- /dev/null +++ b/markdown/bitburner.ns.getserverrequiredhackinglevel.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerRequiredHackingLevel](./bitburner.ns.getserverrequiredhackinglevel.md) + +## NS.getServerRequiredHackingLevel() method + +Returns the required hacking level of the target server. + +Signature: + +```typescript +getServerRequiredHackingLevel(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +The required hacking level of the target server. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.getserversecuritylevel.md b/markdown/bitburner.ns.getserversecuritylevel.md new file mode 100644 index 000000000..afcca10e3 --- /dev/null +++ b/markdown/bitburner.ns.getserversecuritylevel.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerSecurityLevel](./bitburner.ns.getserversecuritylevel.md) + +## NS.getServerSecurityLevel() method + +Get server security level. + +Signature: + +```typescript +getServerSecurityLevel(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +Security level of the target server. + +## Remarks + +RAM cost: 0.1 GB + +Returns the security level of the target server. A server’s security level is denoted by a number, typically between 1 and 100 (but it can go above 100). + diff --git a/markdown/bitburner.ns.getserverusedram.md b/markdown/bitburner.ns.getserverusedram.md new file mode 100644 index 000000000..a208b3a99 --- /dev/null +++ b/markdown/bitburner.ns.getserverusedram.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerUsedRam](./bitburner.ns.getserverusedram.md) + +## NS.getServerUsedRam() method + +Get the used RAM on a server. + +Signature: + +```typescript +getServerUsedRam(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +number + +used ram (GB) + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.ns.getsharepower.md b/markdown/bitburner.ns.getsharepower.md new file mode 100644 index 000000000..d615c728f --- /dev/null +++ b/markdown/bitburner.ns.getsharepower.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getSharePower](./bitburner.ns.getsharepower.md) + +## NS.getSharePower() method + +Calculate your share power. Based on all the active share calls. + +Signature: + +```typescript +getSharePower(): number; +``` +Returns: + +number + +## Remarks + +RAM cost: 0.2 GB + diff --git a/markdown/bitburner.ns.gettimesincelastaug.md b/markdown/bitburner.ns.gettimesincelastaug.md new file mode 100644 index 000000000..8b5fdd543 --- /dev/null +++ b/markdown/bitburner.ns.gettimesincelastaug.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getTimeSinceLastAug](./bitburner.ns.gettimesincelastaug.md) + +## NS.getTimeSinceLastAug() method + +Returns the amount of time in milliseconds that have passed since you last installed Augmentations. + +Signature: + +```typescript +getTimeSinceLastAug(): number; +``` +Returns: + +number + +Time in milliseconds that have passed since you last installed Augmentations. + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.ns.gettotalscriptexpgain.md b/markdown/bitburner.ns.gettotalscriptexpgain.md new file mode 100644 index 000000000..492d3c80b --- /dev/null +++ b/markdown/bitburner.ns.gettotalscriptexpgain.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getTotalScriptExpGain](./bitburner.ns.gettotalscriptexpgain.md) + +## NS.getTotalScriptExpGain() method + +Get the exp gain of all script. + +Signature: + +```typescript +getTotalScriptExpGain(): number; +``` +Returns: + +number + +total experience gain rate of all of your active scripts. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.gettotalscriptincome.md b/markdown/bitburner.ns.gettotalscriptincome.md new file mode 100644 index 000000000..a5faa9f1b --- /dev/null +++ b/markdown/bitburner.ns.gettotalscriptincome.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getTotalScriptIncome](./bitburner.ns.gettotalscriptincome.md) + +## NS.getTotalScriptIncome() method + +Get the income of all script. + +Signature: + +```typescript +getTotalScriptIncome(): [number, number]; +``` +Returns: + +\[number, number\] + +an array of two values. The first value is the total income (dollar / second) of all of your active scripts (scripts that are currently running on any server). The second value is the total income (dollar / second) that you’ve earned from scripts since you last installed Augmentations. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.getweakentime.md b/markdown/bitburner.ns.getweakentime.md new file mode 100644 index 000000000..d48e02059 --- /dev/null +++ b/markdown/bitburner.ns.getweakentime.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getWeakenTime](./bitburner.ns.getweakentime.md) + +## NS.getWeakenTime() method + +Get the execution time of a weaken() call. + +Signature: + +```typescript +getWeakenTime(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +number + +Returns the amount of time in milliseconds it takes to execute the weaken Netscript function. + +## Remarks + +RAM cost: 0.05 GB + +Returns the amount of time in milliseconds it takes to execute the weaken Netscript function on the target server. The required time is increased by the security level of the target server and decreased by the player's hacking level. + diff --git a/markdown/bitburner.ns.grafting.md b/markdown/bitburner.ns.grafting.md new file mode 100644 index 000000000..ef2cafa5d --- /dev/null +++ b/markdown/bitburner.ns.grafting.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [grafting](./bitburner.ns.grafting.md) + +## NS.grafting property + +Namespace for grafting functions. + +Signature: + +```typescript +readonly grafting: Grafting; +``` + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.grow.md b/markdown/bitburner.ns.grow.md new file mode 100644 index 000000000..7ad16f0cf --- /dev/null +++ b/markdown/bitburner.ns.grow.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [grow](./bitburner.ns.grow.md) + +## NS.grow() method + +Spoof money in a servers bank account, increasing the amount available. + +Signature: + +```typescript +grow(host: string, opts?: BasicHGWOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server to grow. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | + +Returns: + +Promise<number> + +The number by which the money on the server was multiplied for the growth. + +## Remarks + +RAM cost: 0.15 GB + +Use your hacking skills to increase the amount of money available on a server. The runtime for this command depends on your hacking level and the target server’s security level. When `grow` completes, the money available on a target server will be increased by a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate. + +Like hack, `grow` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004. + +## Example 1 + + +```ts +// NS1: +var currentMoney = getServerMoneyAvailable("foodnstuff"); +currentMoney = currentMoney * (1 + grow("foodnstuff")); +``` + +## Example 2 + + +```ts +// NS2: +let currentMoney = ns.getServerMoneyAvailable("foodnstuff"); +currentMoney *= (1 + await ns.grow("foodnstuff")); +``` + diff --git a/markdown/bitburner.ns.growthanalyze.md b/markdown/bitburner.ns.growthanalyze.md new file mode 100644 index 000000000..fa092a769 --- /dev/null +++ b/markdown/bitburner.ns.growthanalyze.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [growthAnalyze](./bitburner.ns.growthanalyze.md) + +## NS.growthAnalyze() method + +Calculate the number of grow thread needed to grow a server by a certain multiplier. + +Signature: + +```typescript +growthAnalyze(host: string, growthAmount: number, cores?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | +| growthAmount | number | Multiplicative factor by which the server is grown. Decimal form.. | +| cores | number | | + +Returns: + +number + +The amount of grow calls needed to grow the specified server by the specified amount + +## Remarks + +RAM cost: 1 GB + +This function returns the number of “growths” needed in order to increase the amount of money available on the specified server by the specified amount. The specified amount is multiplicative and is in decimal form, not percentage. + +Warning: The value returned by this function isn’t necessarily a whole number. + +## Example 1 + + +```ts +// NS1: +//For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use: +var growTimes = growthAnalyze("foodnstuff", 2); +//If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads). +``` + +## Example 2 + + +```ts +// NS2: +//For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use: +const growTimes = ns.growthAnalyze("foodnstuff", 2); +//If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads). +``` + diff --git a/markdown/bitburner.ns.growthanalyzesecurity.md b/markdown/bitburner.ns.growthanalyzesecurity.md new file mode 100644 index 000000000..89477d216 --- /dev/null +++ b/markdown/bitburner.ns.growthanalyzesecurity.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [growthAnalyzeSecurity](./bitburner.ns.growthanalyzesecurity.md) + +## NS.growthAnalyzeSecurity() method + +Calculate the security increase for a number of thread. + +Signature: + +```typescript +growthAnalyzeSecurity(threads: number, hostname?: string, cores?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| threads | number | Amount of threads that will be used. | +| hostname | string | Optional. Hostname of the target server. The number of threads is limited to the number needed to hack the servers maximum amount of money. | +| cores | number | Optional. The number of cores of the server that would run grow. | + +Returns: + +number + +The security increase. + +## Remarks + +RAM cost: 1 GB + +Returns the security increase that would occur if a grow with this many threads happened. + diff --git a/markdown/bitburner.ns.hack.md b/markdown/bitburner.ns.hack.md new file mode 100644 index 000000000..c38aab5c0 --- /dev/null +++ b/markdown/bitburner.ns.hack.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hack](./bitburner.ns.hack.md) + +## NS.hack() method + +Steal a servers money. + +Signature: + +```typescript +hack(host: string, opts?: BasicHGWOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server to hack. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | + +Returns: + +Promise<number> + +The amount of money stolen if the hack is successful, and zero otherwise. + +## Remarks + +RAM cost: 0.1 GB + +Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target server’s security level when this function is called. In order to hack a server you must first gain root access to that server and also have the required hacking level. + +A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the `foodnstuff` server and run that script on any server in the game. + +A successful `hack()` on a server will raise that server’s security level by 0.002. + +## Example 1 + + +```ts +// NS1: +var earnedMoney = hack("foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +let earnedMoney = await ns.hack("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.hackanalyze.md b/markdown/bitburner.ns.hackanalyze.md new file mode 100644 index 000000000..51499edb1 --- /dev/null +++ b/markdown/bitburner.ns.hackanalyze.md @@ -0,0 +1,52 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hackAnalyze](./bitburner.ns.hackanalyze.md) + +## NS.hackAnalyze() method + +Get the part of money stolen with a single thread. + +Signature: + +```typescript +hackAnalyze(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +number + +The part of money you will steal from the target server with a single thread hack. + +## Remarks + +RAM cost: 1 GB + +Returns the part of the specified server’s money you will steal with a single thread hack. + +## Example 1 + + +```ts +// NS1: +//For example, assume the following returns 0.01: +var hackAmount = hackAnalyze("foodnstuff"); +//This means that if hack the foodnstuff server using a single thread, then you will steal 1%, or 0.01 of its total money. If you hack using N threads, then you will steal N*0.01 times its total money. +``` + +## Example 2 + + +```ts +// NS2: +//For example, assume the following returns 0.01: +const hackAmount = ns.hackAnalyze("foodnstuff"); +//This means that if hack the foodnstuff server using a single thread, then you will steal 1%, or 0.01 of its total money. If you hack using N threads, then you will steal N*0.01 times its total money. +``` + diff --git a/markdown/bitburner.ns.hackanalyzechance.md b/markdown/bitburner.ns.hackanalyzechance.md new file mode 100644 index 000000000..123adf014 --- /dev/null +++ b/markdown/bitburner.ns.hackanalyzechance.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hackAnalyzeChance](./bitburner.ns.hackanalyzechance.md) + +## NS.hackAnalyzeChance() method + +Get the chance of successfully hacking a server. + +Signature: + +```typescript +hackAnalyzeChance(host: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +number + +The chance you have of successfully hacking the target server. + +## Remarks + +RAM cost: 1 GB + +Returns the chance you have of successfully hacking the specified server. + +This returned value is in decimal form, not percentage. + diff --git a/markdown/bitburner.ns.hackanalyzesecurity.md b/markdown/bitburner.ns.hackanalyzesecurity.md new file mode 100644 index 000000000..299597e48 --- /dev/null +++ b/markdown/bitburner.ns.hackanalyzesecurity.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hackAnalyzeSecurity](./bitburner.ns.hackanalyzesecurity.md) + +## NS.hackAnalyzeSecurity() method + +Get the security increase for a number of thread. + +Signature: + +```typescript +hackAnalyzeSecurity(threads: number, hostname?: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| threads | number | Amount of threads that will be used. | +| hostname | string | Hostname of the target server. The number of threads is limited to the number needed to hack the servers maximum amount of money. | + +Returns: + +number + +The security increase. + +## Remarks + +RAM cost: 1 GB + +Returns the security increase that would occur if a hack with this many threads happened. + diff --git a/markdown/bitburner.ns.hackanalyzethreads.md b/markdown/bitburner.ns.hackanalyzethreads.md new file mode 100644 index 000000000..ef07429c2 --- /dev/null +++ b/markdown/bitburner.ns.hackanalyzethreads.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hackAnalyzeThreads](./bitburner.ns.hackanalyzethreads.md) + +## NS.hackAnalyzeThreads() method + +Predict the effect of hack. + +Signature: + +```typescript +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. | + +Returns: + +number + +The number of threads needed to hack the server for hackAmount money. + +## Remarks + +RAM cost: 1 GB + +This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1. + +Warning: The value returned by this function isn’t necessarily a whole number. + +## Example + + +```ts +//For example, let’s say the foodnstuff server has $10m and you run: +hackAnalyzeThreads("foodnstuff", 1e6); +//If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server. +``` + diff --git a/markdown/bitburner.ns.hacknet.md b/markdown/bitburner.ns.hacknet.md new file mode 100644 index 000000000..d4413dc59 --- /dev/null +++ b/markdown/bitburner.ns.hacknet.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hacknet](./bitburner.ns.hacknet.md) + +## NS.hacknet property + +Namespace for hacknet functions. + +Signature: + +```typescript +readonly hacknet: Hacknet; +``` + +## Remarks + +RAM cost: 4 GB + diff --git a/markdown/bitburner.ns.hasrootaccess.md b/markdown/bitburner.ns.hasrootaccess.md new file mode 100644 index 000000000..012cb458d --- /dev/null +++ b/markdown/bitburner.ns.hasrootaccess.md @@ -0,0 +1,52 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hasRootAccess](./bitburner.ns.hasrootaccess.md) + +## NS.hasRootAccess() method + +Check if your have root access on a server. + +Signature: + +```typescript +hasRootAccess(host: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of the target server | + +Returns: + +boolean + +True if player has root access to the specified target server, and false otherwise. + +## Remarks + +RAM cost: 0.05 GB + +Returns a boolean indicating whether or not the player has root access to the specified target server. + +## Example 1 + + +```ts +// NS1: +if (hasRootAccess("foodnstuff") == false) { + nuke("foodnstuff"); +} +``` + +## Example 2 + + +```ts +// NS2: +if (ns.hasRootAccess("foodnstuff") == false) { + ns.nuke("foodnstuff"); +} +``` + diff --git a/markdown/bitburner.ns.httpworm.md b/markdown/bitburner.ns.httpworm.md new file mode 100644 index 000000000..1d8c3f154 --- /dev/null +++ b/markdown/bitburner.ns.httpworm.md @@ -0,0 +1,46 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [httpworm](./bitburner.ns.httpworm.md) + +## NS.httpworm() method + +Runs HTTPWorm.exe on a server. + +Signature: + +```typescript +httpworm(host: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +void + +## Remarks + +RAM cost: 0.05 GB + +Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer. + +## Example 1 + + +```ts +// NS1: +httpworm("foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +ns.httpworm("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.infiltration.md b/markdown/bitburner.ns.infiltration.md new file mode 100644 index 000000000..009fb148e --- /dev/null +++ b/markdown/bitburner.ns.infiltration.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [infiltration](./bitburner.ns.infiltration.md) + +## NS.infiltration property + +Namespace for infiltration functions. RAM cost: 0 GB + +Signature: + +```typescript +readonly infiltration: Infiltration; +``` diff --git a/markdown/bitburner.ns.islogenabled.md b/markdown/bitburner.ns.islogenabled.md new file mode 100644 index 000000000..e0f0196ae --- /dev/null +++ b/markdown/bitburner.ns.islogenabled.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [isLogEnabled](./bitburner.ns.islogenabled.md) + +## NS.isLogEnabled() method + +Checks the status of the logging for the given function. + +Signature: + +```typescript +isLogEnabled(fn: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Name of function to check. | + +Returns: + +boolean + +Returns a boolean indicating whether or not logging is enabled for that function (or `ALL`) + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.isrunning.md b/markdown/bitburner.ns.isrunning.md new file mode 100644 index 000000000..2dfde841e --- /dev/null +++ b/markdown/bitburner.ns.isrunning.md @@ -0,0 +1,64 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [isRunning](./bitburner.ns.isrunning.md) + +## NS.isRunning() method + +Check if a script is running. + +Signature: + +```typescript +isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. | +| host | string | Host of target server. | +| args | (string \| number \| boolean)\[\] | Arguments to specify/identify which scripts to search for. | + +Returns: + +boolean + +True if specified script is running on the target server, and false otherwise. + +## Remarks + +RAM cost: 0.1 GB + +Returns a boolean indicating whether the specified script is running on the target server. If you use a PID instead of a filename, the hostname and args parameters are unnecessary. Remember that a script is uniquely identified by both its name and its arguments. + +## Example 1 + + +```ts +// NS1: +//The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise: +isRunning("foo.script", "foodnstuff"); + +//The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise: +isRunning("foo.script", getHostname()); + +//The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise: +isRunning("foo.script", "joesguns", 1, 5, "test"); +``` + +## Example 2 + + +```ts +// NS2: +//The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise: +ns.isRunning("foo.script", "foodnstuff"); + +//The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise: +ns.isRunning("foo.script", ns.getHostname()); + +//The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise: +ns.isRunning("foo.script", "joesguns", 1, 5, "test"); +``` + diff --git a/markdown/bitburner.ns.kill.md b/markdown/bitburner.ns.kill.md new file mode 100644 index 000000000..76b2d8109 --- /dev/null +++ b/markdown/bitburner.ns.kill.md @@ -0,0 +1,62 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [kill](./bitburner.ns.kill.md) + +## NS.kill() method + +Terminate another script. + +Signature: + +```typescript +kill(script: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | number | Filename or pid of the script to kill | + +Returns: + +boolean + +True if the script is successfully killed, and false otherwise. + +## Remarks + +RAM cost: 0.5 GB + +Kills the script on the target server specified by the script’s name and arguments. Remember that scripts are uniquely identified by both their name and arguments. For example, if `foo.script` is run with the argument 1, then this is not the same as `foo.script` run with the argument 2, even though they have the same code. + +## Example 1 + + +```ts +// NS1: +//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: +kill("foo.script", "foodnstuff"); + +//The following will try to kill a script named foo.script on the current server that was ran with no arguments: +kill("foo.script", getHostname()); + +//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: +kill("foo.script", getHostname(), 1, "foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: +ns.kill("foo.script", "foodnstuff"); + +//The following will try to kill a script named foo.script on the current server that was ran with no arguments: +ns.kill("foo.script", getHostname()); + +//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: +ns.kill("foo.script", getHostname(), 1, "foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.kill_1.md b/markdown/bitburner.ns.kill_1.md new file mode 100644 index 000000000..aa7814f2a --- /dev/null +++ b/markdown/bitburner.ns.kill_1.md @@ -0,0 +1,64 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [kill](./bitburner.ns.kill_1.md) + +## NS.kill() method + +Terminate another script. + +Signature: + +```typescript +kill(script: string, host: string, ...args: (string | number | boolean)[]): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename or pid of the script to kill | +| host | string | Hostname of the server on which to kill the script. | +| args | (string \| number \| boolean)\[\] | Arguments to identify which script to kill. | + +Returns: + +boolean + +True if the script is successfully killed, and false otherwise. + +## Remarks + +RAM cost: 0.5 GB + +Kills the script on the target server specified by the script’s name and arguments. Remember that scripts are uniquely identified by both their name and arguments. For example, if `foo.script` is run with the argument 1, then this is not the same as `foo.script` run with the argument 2, even though they have the same code. + +## Example 1 + + +```ts +// NS1: +//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: +kill("foo.script", "foodnstuff"); + +//The following will try to kill a script named foo.script on the current server that was ran with no arguments: +kill("foo.script", getHostname()); + +//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: +kill("foo.script", getHostname(), 1, "foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: +ns.kill("foo.script", "foodnstuff"); + +//The following will try to kill a script named foo.script on the current server that was ran with no arguments: +ns.kill("foo.script", getHostname()); + +//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: +ns.kill("foo.script", getHostname(), 1, "foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.killall.md b/markdown/bitburner.ns.killall.md new file mode 100644 index 000000000..f7b9cff6c --- /dev/null +++ b/markdown/bitburner.ns.killall.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [killall](./bitburner.ns.killall.md) + +## NS.killall() method + +Terminate all scripts on a server. + +Signature: + +```typescript +killall(host?: string, safetyguard?: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | IP or hostname of the server on which to kill all scripts. | +| safetyguard | boolean | Skips the script that calls this function | + +Returns: + +boolean + +True if any scripts were killed, and false otherwise. + +## Remarks + +RAM cost: 0.5 GB + +Kills all running scripts on the specified server. This function returns true if any scripts were killed, and false otherwise. In other words, it will return true if there are any scripts running on the target server. If no host is defined, it will kill all scripts, where the script is running. + diff --git a/markdown/bitburner.ns.ls.md b/markdown/bitburner.ns.ls.md new file mode 100644 index 000000000..a51eac7d4 --- /dev/null +++ b/markdown/bitburner.ns.ls.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [ls](./bitburner.ns.ls.md) + +## NS.ls() method + +List files on a server. + +Signature: + +```typescript +ls(host: string, grep?: string): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of the target server. | +| grep | string | A substring to search for in the filename. | + +Returns: + +string\[\] + +Array with the filenames of all files on the specified server. + +## Remarks + +RAM cost: 0.2 GB + +Returns an array with the filenames of all files on the specified server (as strings). The returned array is sorted in alphabetic order. + diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md new file mode 100644 index 000000000..7291ba0d1 --- /dev/null +++ b/markdown/bitburner.ns.md @@ -0,0 +1,174 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) + +## NS interface + +Collection of all functions passed to scripts + +Signature: + +```typescript +export interface NS +``` + +## Remarks + +Basic ns1 usage example: + +```ts + // Basic ns functions can be used directly + getHostname(); + // Some related functions are gathered within a common namespace + stock.getPrice(); +``` +[ns1 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscript1.html)
Basic ns2 usage example: + +```ts +export async function main(ns) { + // Basic ns functions can be accessed on the ns object + ns.getHostname(); + // Some related functions are gathered under a sub-property of the ns object + ns.stock.getPrice(); + // Some functions need to be awaited + await ns.hack('n00dles'); +} +``` +[ns2 in-game docs](https://bitburner.readthedocs.io/en/latest/netscript/netscriptjs.html)
+ +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [args](./bitburner.ns.args.md) | (string \| number \| boolean)\[\] | Arguments passed into the script. | +| [bladeburner](./bitburner.ns.bladeburner.md) | [Bladeburner](./bitburner.bladeburner.md) | Namespace for bladeburner functions. | +| [codingcontract](./bitburner.ns.codingcontract.md) | [CodingContract](./bitburner.codingcontract.md) | Namespace for codingcontract functions. | +| [corporation](./bitburner.ns.corporation.md) | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 1022.4 GB | +| [enums](./bitburner.ns.enums.md) | [NSEnums](./bitburner.nsenums.md) | | +| [formulas](./bitburner.ns.formulas.md) | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. | +| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. | +| [grafting](./bitburner.ns.grafting.md) | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. | +| [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. | +| [infiltration](./bitburner.ns.infiltration.md) | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. RAM cost: 0 GB | +| [singularity](./bitburner.ns.singularity.md) | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB | +| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. | +| [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB | +| [stock](./bitburner.ns.stock.md) | [TIX](./bitburner.tix.md) | Namespace for stock functions. | +| [ui](./bitburner.ns.ui.md) | [UserInterface](./bitburner.userinterface.md) | Namespace for user interface functions. RAM cost: 0 GB | + +## Methods + +| Method | Description | +| --- | --- | +| [alert(msg)](./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. You should prefer 'sleep' over 'asleep' except when doing very complex UI work. | +| [atExit(f)](./bitburner.ns.atexit.md) | Add callback function 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(handle)](./bitburner.ns.clearport.md) | Clear data from a port. | +| [closeTail(pid)](./bitburner.ns.closetail.md) | Close the tail window of a script. | +| [deleteServer(host)](./bitburner.ns.deleteserver.md) | Delete a purchased server. | +| [disableLog(fn)](./bitburner.ns.disablelog.md) | Disables logging for the given function. | +| [enableLog(fn)](./bitburner.ns.enablelog.md) | Enable logging for a certain function. | +| [exec(script, host, numThreads, 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()](./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. | +| [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. | +| [getPlayer()](./bitburner.ns.getplayer.md) | Get information about the player. | +| [getPortHandle(port)](./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()](./bitburner.ns.getpurchasedservers.md) | Returns an array with the hostnames of all of the servers you have purchased. | +| [getPurchasedServerUpgradeCost(hostname, 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. | +| [getRunningScript(filename, hostname, 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) | | +| [getServerGrowth(host)](./bitburner.ns.getservergrowth.md) | Get a server growth parameter. | +| [getServerMaxMoney(host)](./bitburner.ns.getservermaxmoney.md) | Get maximum money available on a server. | +| [getServerMaxRam(host)](./bitburner.ns.getservermaxram.md) | Get the max 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. | +| [getServerRam(host)](./bitburner.ns.getserverram.md) | | +| [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) | Calculate your share power. Based on all the active share calls. | +| [getTimeSinceLastAug()](./bitburner.ns.gettimesincelastaug.md) | Returns the amount of time in milliseconds that have passed since you last installed Augmentations. | +| [getTotalScriptExpGain()](./bitburner.ns.gettotalscriptexpgain.md) | Get the exp gain of all script. | +| [getTotalScriptIncome()](./bitburner.ns.gettotalscriptincome.md) | Get the income of all script. | +| [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 servers bank account, increasing the amount available. | +| [growthAnalyze(host, growthAmount, cores)](./bitburner.ns.growthanalyze.md) | Calculate the number of grow thread needed to grow a server by a certain multiplier. | +| [growthAnalyzeSecurity(threads, hostname, cores)](./bitburner.ns.growthanalyzesecurity.md) | Calculate the security increase for a number of thread. | +| [hack(host, opts)](./bitburner.ns.hack.md) | Steal a servers 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, hostname)](./bitburner.ns.hackanalyzesecurity.md) | Get the security increase for a number of thread. | +| [hackAnalyzeThreads(host, hackAmount)](./bitburner.ns.hackanalyzethreads.md) | Predict the effect of hack. | +| [hasRootAccess(host)](./bitburner.ns.hasrootaccess.md) | Check if your have root access on a server. | +| [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 function. | +| [isRunning(script, host, args)](./bitburner.ns.isrunning.md) | Check if a script is running. | +| [kill(script)](./bitburner.ns.kill.md) | Terminate another script. | +| [kill(script, host, args)](./bitburner.ns.kill_1.md) | Terminate another script. | +| [killall(host, safetyguard)](./bitburner.ns.killall.md) | Terminate all scripts on a server. | +| [ls(host, grep)](./bitburner.ns.ls.md) | List files on a server. | +| [moveTail(x, y, pid)](./bitburner.ns.movetail.md) | Move a tail window | +| [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. | +| [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number | +| [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. | +| [peek(port)](./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 move values or variables to the script’s logs. | +| [printf(format, args)](./bitburner.ns.printf.md) | Prints a formatted string to the script’s 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. | +| [read(filename)](./bitburner.ns.read.md) | Read content of a file. | +| [readPort(port)](./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. | +| [resizeTail(width, height, pid)](./bitburner.ns.resizetail.md) | Resize a tail window | +| [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. | +| [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. | +| [scan(host)](./bitburner.ns.scan.md) | Get the list of servers 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. | +| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. | +| [share()](./bitburner.ns.share.md) | Share your computer with your factions. | +| [sleep(millis)](./bitburner.ns.sleep.md) | Suspends the script for n milliseconds. | +| [spawn(script, numThreads, args)](./bitburner.ns.spawn.md) | Terminate current script and start another in 10s. | +| [sprintf(format, args)](./bitburner.ns.sprintf.md) | Format a string. | +| [sqlinject(host)](./bitburner.ns.sqlinject.md) | Runs SQLInject.exe on a server. | +| [tail(fn, host, args)](./bitburner.ns.tail.md) | Open the tail window of a script. | +| [tFormat(milliseconds, milliPrecision)](./bitburner.ns.tformat.md) | Format time to readable string | +| [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. | +| [tryWritePort(port, data)](./bitburner.ns.trywriteport.md) | Attempt to write to a port. | +| [upgradePurchasedServer(hostname, ram)](./bitburner.ns.upgradepurchasedserver.md) | Upgrade a purchased servers 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 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(port, data)](./bitburner.ns.writeport.md) | Write data to a port. | + diff --git a/markdown/bitburner.ns.movetail.md b/markdown/bitburner.ns.movetail.md new file mode 100644 index 000000000..b8ff6cde2 --- /dev/null +++ b/markdown/bitburner.ns.movetail.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [moveTail](./bitburner.ns.movetail.md) + +## NS.moveTail() method + +Move a tail window + +Signature: + +```typescript +moveTail(x: number, y: number, pid?: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| x | number | x coordinate. | +| y | number | y coordinate. | +| pid | number | Optional. PID of the script having its tail moved. If omitted, the current script is used. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +Moves a tail window. Coordinates are in screenspace pixels (top left is 0,0) + diff --git a/markdown/bitburner.ns.mv.md b/markdown/bitburner.ns.mv.md new file mode 100644 index 000000000..8b3628f1a --- /dev/null +++ b/markdown/bitburner.ns.mv.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [mv](./bitburner.ns.mv.md) + +## NS.mv() method + +Move a file on the target server. + +Signature: + +```typescript +mv(host: string, source: string, destination: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | +| source | string | Filename of the source file. | +| destination | string | Filename of the destination file. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +NS2 exclusive + +Move the source file to the specified destination on the target server. + +This command only works for scripts and text files (.txt). It cannot, however, be used to convert from script to text file, or vice versa. + +This function can also be used to rename files. + diff --git a/markdown/bitburner.ns.nformat.md b/markdown/bitburner.ns.nformat.md new file mode 100644 index 000000000..60b4211ce --- /dev/null +++ b/markdown/bitburner.ns.nformat.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [nFormat](./bitburner.ns.nformat.md) + +## NS.nFormat() method + +Format a number + +Signature: + +```typescript +nFormat(n: number, format: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| n | number | Number to format. | +| format | string | Formatter. | + +Returns: + +string + +Formatted number. + +## Remarks + +RAM cost: 0 GB + +Converts a number into a string with the specified formatter. This uses the numeral.js library, so the formatters must be compatible with that. This is the same function that the game itself uses to display numbers. + +see: http://numeraljs.com/ + diff --git a/markdown/bitburner.ns.nuke.md b/markdown/bitburner.ns.nuke.md new file mode 100644 index 000000000..dcf630bf0 --- /dev/null +++ b/markdown/bitburner.ns.nuke.md @@ -0,0 +1,46 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [nuke](./bitburner.ns.nuke.md) + +## NS.nuke() method + +Runs NUKE.exe on a server. + +Signature: + +```typescript +nuke(host: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +void + +## Remarks + +RAM cost: 0.05 GB + +Running NUKE.exe on a target server gives you root access which means you can executes scripts on said server. NUKE.exe must exist on your home computer. + +## Example 1 + + +```ts +// NS1: +nuke("foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +ns.nuke("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.peek.md b/markdown/bitburner.ns.peek.md new file mode 100644 index 000000000..017d79d04 --- /dev/null +++ b/markdown/bitburner.ns.peek.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [peek](./bitburner.ns.peek.md) + +## NS.peek() method + +Get a copy of the data from a port without popping it. + +Signature: + +```typescript +peek(port: number): PortData; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| port | number | Port to peek. Must be an integer between 1 and 20. | + +Returns: + +[PortData](./bitburner.portdata.md) + +Data in the specified port. + +## Remarks + +RAM cost: 0 GB + +This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned. + diff --git a/markdown/bitburner.ns.print.md b/markdown/bitburner.ns.print.md new file mode 100644 index 000000000..75a4b0bfc --- /dev/null +++ b/markdown/bitburner.ns.print.md @@ -0,0 +1,94 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [print](./bitburner.ns.print.md) + +## NS.print() method + +Prints one or move values or variables to the script’s logs. + +Signature: + +```typescript +print(...args: any[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| args | any\[\] | Value(s) to be printed. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +If the argument is a string, you can color code your message by prefixing your string with one of these strings: + +- `"ERROR"`: The whole string will be printed in red. Use this prefix to indicate that an error has occurred. + +- `"SUCCESS"`: The whole string will be printed in green, similar to the default theme of the Terminal. Use this prefix to indicate that something is correct. + +- `"WARN"`: The whole string will be printed in yellow. Use this prefix to indicate that you or a user of your script should be careful of something. + +- `"INFO"`: The whole string will be printed in purplish blue. Use this prefix to remind yourself or a user of your script of something. Think of this prefix as indicating an FYI (for your information). + +For custom coloring, use ANSI escape sequences. The examples below use the Unicode escape code `\u001b`. The color coding also works if `\u001b` is replaced with the hexadecimal escape code `\x1b`. The Bash escape code `\e` is not supported. The octal escape code `\033` is not allowed because the game runs JavaScript in strict mode. + +## Example 1 + + +```ts +// NS1 +// Default color coding. +print("ERROR means something's wrong."); +print("SUCCESS means everything's OK."); +print("WARN Tread with caution!"); +print("WARNING, warning, danger, danger!"); +print("WARNing! Here be dragons."); +print("INFO for your I's only (FYI)."); +print("INFOrmation overload!"); +// Custom color coding. +var cyan = "\u001b[36m"; +var green = "\u001b[32m"; +var red = "\u001b[31m"; +var reset = "\u001b[0m"; +var msgError = red + "Ugh! What a mess." + reset; +var msgSuccess = green + "Well done!" + reset; +var msgMixed = cyan + "ERROR Should this be in red?" + reset; +print(msgError); +print(msgSuccess); +print(msgMixed); +tail(); +``` + +## Example 2 + + +```ts +// NS2 +// Default color coding. +ns.print("ERROR means something's wrong."); +ns.print("SUCCESS means everything's OK."); +ns.print("WARN Tread with caution!"); +ns.print("WARNING, warning, danger, danger!"); +ns.print("WARNing! Here be dragons."); +ns.print("INFO for your I's only (FYI)."); +ns.print("INFOrmation overload!"); +// Custom color coding. +const cyan = "\u001b[36m"; +const green = "\u001b[32m"; +const red = "\u001b[31m"; +const reset = "\u001b[0m"; +const msgError = "Ugh! What a mess."; +const msgSuccess = "Well done!"; +const msgMixed = "ERROR Should this be in red?"; +ns.print(`${red + msgError + reset}`); +ns.print(`${green + msgSuccess + reset}`); +ns.print(`${cyan + msgMixed + reset}`); +ns.tail(); +``` + diff --git a/markdown/bitburner.ns.printf.md b/markdown/bitburner.ns.printf.md new file mode 100644 index 000000000..2ca1f16c1 --- /dev/null +++ b/markdown/bitburner.ns.printf.md @@ -0,0 +1,65 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [printf](./bitburner.ns.printf.md) + +## NS.printf() method + +Prints a formatted string to the script’s logs. + +Signature: + +```typescript +printf(format: string, ...args: any[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | Format of the message. | +| args | any\[\] | Value(s) to be printed. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +- See [print](./bitburner.ns.print.md) for how to add color to your printed strings. + +- For more detail, see: https://github.com/alexei/sprintf.js + +## Example 1 + + +```ts +// NS1 +var name = "Bit"; +var age = 4; +printf("My name is %s.", name); +printf("I'm %d seconds old.", age); +printf("My age in binary is %b.", age); +printf("My age in scientific notation is %e.", age); +printf("In %d seconds, I'll be %s.", 6, "Byte"); +printf("Am I a nibble? %t", (4 == age)); +tail(); +``` + +## Example 2 + + +```ts +// NS2 +const name = "Bit"; +const age = 4; +ns.printf("My name is %s.", name); +ns.printf("I'm %d seconds old.", age); +ns.printf("My age in binary is %b.", age); +ns.printf("My age in scientific notation is %e.", age); +ns.printf("In %d seconds, I'll be %s.", 6, "Byte"); +ns.printf("Am I a nibble? %t", (4 == age)); +ns.tail(); +``` + diff --git a/markdown/bitburner.ns.prompt.md b/markdown/bitburner.ns.prompt.md new file mode 100644 index 000000000..830ee7f6c --- /dev/null +++ b/markdown/bitburner.ns.prompt.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [prompt](./bitburner.ns.prompt.md) + +## NS.prompt() method + +Prompt the player with an input modal. + +Signature: + +```typescript +prompt( + txt: string, + options?: { type?: "boolean" | "text" | "select" | undefined; choices?: string[] }, + ): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| txt | string | Text to appear in the prompt dialog box. | +| options | { type?: "boolean" \| "text" \| "select" \| undefined; choices?: string\[\] } | Options to modify the prompt the player is shown. | + +Returns: + +Promise<boolean \| string> + +True if the player click “Yes”; false if the player clicks “No”; or the value entered by the player. + +## Remarks + +RAM cost: 0 GB + +Prompts the player with a dialog box. If `options.type` is undefined or "boolean", the player is shown "Yes" and "No" prompts, which return true and false respectively. Passing a type of "text" will give the player a text field and a value of "select" will show a drop-down field. Choosing type "select" will require an array or object to be passed via the `options.choices` property. The script’s execution is halted until the player selects one of the options. + diff --git a/markdown/bitburner.ns.ps.md b/markdown/bitburner.ns.ps.md new file mode 100644 index 000000000..532969c20 --- /dev/null +++ b/markdown/bitburner.ns.ps.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [ps](./bitburner.ns.ps.md) + +## NS.ps() method + +List running scripts on a server. + +Signature: + +```typescript +ps(host?: string): ProcessInfo[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host address of the target server. If not specified, it will be the current server’s IP by default. | + +Returns: + +[ProcessInfo](./bitburner.processinfo.md)\[\] + +Array with general information about all scripts running on the specified target server. + +## Remarks + +RAM cost: 0.2 GB + +Returns an array with general information about all scripts running on the specified target server. + +## Example 1 + + +```ts +// NS1: +var scripts = ps("home"); +for (var i = 0; i < scripts.length; ++i) { + tprint(scripts[i].filename + ' ' + scripts[i].threads); + tprint(scripts[i].args); +} +``` + +## Example 2 + + +```ts +// NS2: +const ps = ns.ps("home"); +for (let script of ps) { + ns.tprint(`${script.filename} ${script.threads}`); + ns.tprint(script.args); +} +``` + diff --git a/markdown/bitburner.ns.purchaseserver.md b/markdown/bitburner.ns.purchaseserver.md new file mode 100644 index 000000000..9260c9b70 --- /dev/null +++ b/markdown/bitburner.ns.purchaseserver.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [purchaseServer](./bitburner.ns.purchaseserver.md) + +## NS.purchaseServer() method + +Purchase a server. + +Signature: + +```typescript +purchaseServer(hostname: string, ram: number): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | Host 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: + +string + +The hostname of the newly purchased server. + +## Remarks + +2.25 GB + +Purchased a server with the specified hostname and amount of RAM. + +The hostname argument can be any data type, but it will be converted to a string and have whitespace removed. Anything that resolves to an empty string will cause the function to fail. If there is already a server with the specified hostname, then the function will automatically append a number at the end of the hostname argument value until it finds a unique hostname. For example, if the script calls `purchaseServer(“foo”, 4)` but a server named “foo” already exists, the it will automatically change the hostname to `foo-0`. If there is already a server with the hostname `foo-0`, then it will change the hostname to `foo-1`, and so on. + +Note that there is a maximum limit to the amount of servers you can purchase. + +Returns the hostname of the newly purchased server as a string. If the function fails to purchase a server, then it will return an empty string. The function will fail if the arguments passed in are invalid, if the player does not have enough money to purchase the specified server, or if the player has exceeded the maximum amount of servers. + +## Example 1 + + +```ts +// NS1: +var ram = 64; +var prefix = "pserv-"; +for (i = 0; i < 5; ++i) { + purchaseServer(prefix + i, ram); +} +``` + +## Example 2 + + +```ts +// NS2: +const ram = 64; +const prefix = "pserv-"; +for (i = 0; i < 5; ++i) { + ns.purchaseServer(prefix + i, ram); +} +``` + diff --git a/markdown/bitburner.ns.read.md b/markdown/bitburner.ns.read.md new file mode 100644 index 000000000..005316929 --- /dev/null +++ b/markdown/bitburner.ns.read.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [read](./bitburner.ns.read.md) + +## NS.read() method + +Read content of a file. + +Signature: + +```typescript +read(filename: string): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | Name of the file to be read. | + +Returns: + +string + +Data in the specified text file. + +## Remarks + +RAM cost: 0 GB + +This function is used to read data from a text file (.txt) or script (.script, .js). + +This function will return the data in the specified file. If the file does not exist, an empty string will be returned. + diff --git a/markdown/bitburner.ns.readport.md b/markdown/bitburner.ns.readport.md new file mode 100644 index 000000000..bd8ccf0d9 --- /dev/null +++ b/markdown/bitburner.ns.readport.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [readPort](./bitburner.ns.readport.md) + +## NS.readPort() method + +Read data from a port. + +Signature: + +```typescript +readPort(port: number): PortData; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| port | number | | + +Returns: + +[PortData](./bitburner.portdata.md) + +the data read. + +## Remarks + +RAM cost: 0 GB + +Read data from that port. A port is a serialized queue. This function will remove the first element from that queue and return it. If the queue is empty, then the string “NULL PORT DATA” will be returned. + diff --git a/markdown/bitburner.ns.relaysmtp.md b/markdown/bitburner.ns.relaysmtp.md new file mode 100644 index 000000000..ccbeb6016 --- /dev/null +++ b/markdown/bitburner.ns.relaysmtp.md @@ -0,0 +1,46 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [relaysmtp](./bitburner.ns.relaysmtp.md) + +## NS.relaysmtp() method + +Runs relaySMTP.exe on a server. + +Signature: + +```typescript +relaysmtp(host: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +void + +## Remarks + +RAM cost: 0.05 GB + +Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer. + +## Example 1 + + +```ts +// NS1: +relaysmtp("foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +ns.relaysmtp("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.renamepurchasedserver.md b/markdown/bitburner.ns.renamepurchasedserver.md new file mode 100644 index 000000000..3830a78a4 --- /dev/null +++ b/markdown/bitburner.ns.renamepurchasedserver.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [renamePurchasedServer](./bitburner.ns.renamepurchasedserver.md) + +## NS.renamePurchasedServer() method + +Rename a purchased server. + +Signature: + +```typescript +renamePurchasedServer(hostname: string, newName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | current server hostname | +| newName | string | new server hostname | + +Returns: + +boolean + +True if the upgrade succeeded. + +## Remarks + +RAM cost: 2.00 GB + diff --git a/markdown/bitburner.ns.resizetail.md b/markdown/bitburner.ns.resizetail.md new file mode 100644 index 000000000..7598ee40a --- /dev/null +++ b/markdown/bitburner.ns.resizetail.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [resizeTail](./bitburner.ns.resizetail.md) + +## NS.resizeTail() method + +Resize a tail window + +Signature: + +```typescript +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. PID of the script having its tail resized. If omitted, the current script is used. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +Resize a tail window. Size are in pixel + diff --git a/markdown/bitburner.ns.rm.md b/markdown/bitburner.ns.rm.md new file mode 100644 index 000000000..207fc919f --- /dev/null +++ b/markdown/bitburner.ns.rm.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [rm](./bitburner.ns.rm.md) + +## NS.rm() method + +Delete a file. + +Signature: + +```typescript +rm(name: string, host?: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Filename of file to remove. Must include the extension. | +| host | string | Host Address of the server on which to delete the file. Optional. Defaults to current server. | + +Returns: + +boolean + +True if it successfully deletes the file, and false otherwise. + +## Remarks + +RAM cost: 1 GB + +Removes the specified file from the current server. This function works for every file type except message (.msg) files. + diff --git a/markdown/bitburner.ns.run.md b/markdown/bitburner.ns.run.md new file mode 100644 index 000000000..842d46bca --- /dev/null +++ b/markdown/bitburner.ns.run.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [run](./bitburner.ns.run.md) + +## NS.run() method + +Start another script on the current server. + +Signature: + +```typescript +run(script: string, numThreads?: number, ...args: (string | number | boolean)[]): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename of script to run. | +| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | +| args | (string \| number \| boolean)\[\] | 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 numThreads must be filled in with a value. | + +Returns: + +number + +Returns the PID of a successfully started script, and 0 otherwise. + +## Remarks + +RAM cost: 1 GB + +Run a script as a separate process. This function can only be used to run scripts located on the current server (the server running the script that calls this function). Requires a significant amount of RAM to run this command. + +If the script was successfully started, then this functions returns the PID of that script. Otherwise, it returns 0. + +PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. + +Running this function with a numThreads argument of 0 or less will cause a runtime error. + +## Example 1 + + +```ts +// NS1: +//The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.script’ single-threaded with no arguments: +run("foo.script"); + +//The following example will run ‘foo.script’ but with 5 threads instead of single-threaded: +run("foo.script", 5); + +//This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument: +run("foo.script", 1, 'foodnstuff'); +``` + +## Example 2 + + +```ts +// NS2: +//The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.script’ single-threaded with no arguments: +ns.run("foo.script"); + +//The following example will run ‘foo.script’ but with 5 threads instead of single-threaded: +ns.run("foo.script", 5); + +//This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument: +ns.run("foo.script", 1, 'foodnstuff'); +``` + diff --git a/markdown/bitburner.ns.scan.md b/markdown/bitburner.ns.scan.md new file mode 100644 index 000000000..0bf88f7ba --- /dev/null +++ b/markdown/bitburner.ns.scan.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scan](./bitburner.ns.scan.md) + +## NS.scan() method + +Get the list of servers connected to a server. + +Signature: + +```typescript +scan(host?: string): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Optional, Hostname of the server to scan, default to current server. | + +Returns: + +string\[\] + +Returns an string of hostnames. + +## Remarks + +RAM cost: 0.2 GB + +Returns an array containing the hostnames of all servers that are one node way from the specified target server. The hostnames in the returned array are strings. + diff --git a/markdown/bitburner.ns.scp.md b/markdown/bitburner.ns.scp.md new file mode 100644 index 000000000..25546f4a8 --- /dev/null +++ b/markdown/bitburner.ns.scp.md @@ -0,0 +1,70 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scp](./bitburner.ns.scp.md) + +## NS.scp() method + +Copy file between servers. + +Signature: + +```typescript +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. | +| destination | string | Host of the destination server, which is the server to which the file will be copied. | +| source | string | Host 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: + +boolean + +True if the file is successfully copied over and false otherwise. If the files argument is an array then this function will return false if any of the operations failed. + +## Remarks + +RAM cost: 0.6 GB + +Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy. + +## Example 1 + + +```ts +// NS1: +//Copies foo.lit from the helios server to the home computer: +scp("foo.lit", "home", "helios"); + +//Tries to copy three files from rothman-uni to home computer: +files = ["foo1.lit", "foo2.script", "foo3.script"]; +scp(files, "home", "rothman-uni"); +``` + +## Example 2 + + +```ts +// NS2: +//Copies foo.lit from the helios server to the home computer: +ns.scp("foo.lit", "home", "helios" ); + +//Tries to copy three files from rothman-uni to home computer: +files = ["foo1.lit", "foo2.script", "foo3.script"]; +ns.scp(files, "home", "rothman-uni"); +``` + +## Example 3 + + +```ts +//ns2, copies files from home to a target server +const server = ns.args[0]; +const files = ["hack.js","weaken.js","grow.js"]; +ns.scp(files, server, "home"); +``` + diff --git a/markdown/bitburner.ns.scriptkill.md b/markdown/bitburner.ns.scriptkill.md new file mode 100644 index 000000000..2d7615805 --- /dev/null +++ b/markdown/bitburner.ns.scriptkill.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scriptKill](./bitburner.ns.scriptkill.md) + +## NS.scriptKill() method + +Kill all scripts with a filename. + +Signature: + +```typescript +scriptKill(script: string, host: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename of script to kill. This is case-sensitive. | +| host | string | Host of target server. | + +Returns: + +boolean + +true if one or more scripts were successfully killed, and false if none were. + +## Remarks + +RAM cost: 1 GB + +Kills all scripts with the specified filename on the target server specified by hostname, regardless of arguments. + diff --git a/markdown/bitburner.ns.scriptrunning.md b/markdown/bitburner.ns.scriptrunning.md new file mode 100644 index 000000000..ebeac6b5d --- /dev/null +++ b/markdown/bitburner.ns.scriptrunning.md @@ -0,0 +1,60 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scriptRunning](./bitburner.ns.scriptrunning.md) + +## NS.scriptRunning() method + +Check if any script with a filename is running. + +Signature: + +```typescript +scriptRunning(script: string, host: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename of script to check. This is case-sensitive. | +| host | string | Host of target server. | + +Returns: + +boolean + +True if the specified script is running, and false otherwise. + +## Remarks + +RAM cost: 1 GB + +Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments. + +This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments. + +## Example 1 + + +```ts +// NS1: +//The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise: +scriptRunning("foo.script", "foodnstuff"); + +//The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise: +scriptRunning("foo.script", getHostname()); +``` +\* + +## Example 2 + + +```ts +// NS2: +//The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise: +ns.scriptRunning("foo.script", "foodnstuff"); + +//The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise: +ns.scriptRunning("foo.script", ns.getHostname()); +``` + diff --git a/markdown/bitburner.ns.serverexists.md b/markdown/bitburner.ns.serverexists.md new file mode 100644 index 000000000..b0f66a4bc --- /dev/null +++ b/markdown/bitburner.ns.serverexists.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [serverExists](./bitburner.ns.serverexists.md) + +## NS.serverExists() method + +Returns a boolean denoting whether or not the specified server exists. + +Signature: + +```typescript +serverExists(host: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Host of target server. | + +Returns: + +boolean + +True if specified server exists, and false otherwise. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.share.md b/markdown/bitburner.ns.share.md new file mode 100644 index 000000000..421e3e032 --- /dev/null +++ b/markdown/bitburner.ns.share.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [share](./bitburner.ns.share.md) + +## NS.share() method + +Share your computer with your factions. + +Signature: + +```typescript +share(): Promise; +``` +Returns: + +Promise<void> + +## Remarks + +RAM cost: 2.4 GB + +Increases your rep gain of hacking contracts while share is called. Scales with thread count. + diff --git a/markdown/bitburner.ns.singularity.md b/markdown/bitburner.ns.singularity.md new file mode 100644 index 000000000..23f31db42 --- /dev/null +++ b/markdown/bitburner.ns.singularity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [singularity](./bitburner.ns.singularity.md) + +## NS.singularity property + +Namespace for singularity functions. RAM cost: 0 GB + +Signature: + +```typescript +readonly singularity: Singularity; +``` diff --git a/markdown/bitburner.ns.sleep.md b/markdown/bitburner.ns.sleep.md new file mode 100644 index 000000000..857992f86 --- /dev/null +++ b/markdown/bitburner.ns.sleep.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [sleep](./bitburner.ns.sleep.md) + +## NS.sleep() method + +Suspends the script for n milliseconds. + +Signature: + +```typescript +sleep(millis: number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| millis | number | Number of milliseconds to sleep. | + +Returns: + +Promise<true> + + +## Remarks + +RAM cost: 0 GB + +## Example 1 + + +```ts +// NS1: +// This will count from 1 to 10 in your terminal, with one number every 5 seconds +for (var i=0; i<10; i++) { + tprint(i + 1); + sleep(5000); +} +``` + +## Example 2 + + +```ts +// NS2: +// This will count from 1 to 10 in your terminal, with one number every 5 seconds +for (var i=0; i<10; i++) { + ns.tprint(i + 1); + await ns.sleep(5000); +} +``` + diff --git a/markdown/bitburner.ns.sleeve.md b/markdown/bitburner.ns.sleeve.md new file mode 100644 index 000000000..bc3be1dd9 --- /dev/null +++ b/markdown/bitburner.ns.sleeve.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [sleeve](./bitburner.ns.sleeve.md) + +## NS.sleeve property + +Namespace for sleeve functions. + +Signature: + +```typescript +readonly sleeve: Sleeve; +``` + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.spawn.md b/markdown/bitburner.ns.spawn.md new file mode 100644 index 000000000..5360c3478 --- /dev/null +++ b/markdown/bitburner.ns.spawn.md @@ -0,0 +1,54 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [spawn](./bitburner.ns.spawn.md) + +## NS.spawn() method + +Terminate current script and start another in 10s. + +Signature: + +```typescript +spawn(script: string, numThreads?: number, ...args: (string | number | boolean)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | string | Filename of script to execute. | +| numThreads | number | Number of threads to spawn new script with. Will be rounded to nearest integer. | +| args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. | + +Returns: + +void + +## Remarks + +RAM cost: 2 GB + +Terminates the current script, and then after a delay of about 10 seconds it will execute the newly-specified script. The purpose of this function is to execute a new script without being constrained by the RAM usage of the current one. This function can only be used to run scripts on the local server. + +Because this function immediately terminates the script, it does not have a return value. + +Running this function with a numThreads argument of 0 or less will cause a runtime error. + +## Example 1 + + +```ts +// NS1: +//The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90: +spawn('foo.script', 10, 'foodnstuff', 90); +``` + +## Example 2 + + +```ts +// NS2: +//The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90: +ns.spawn('foo.script', 10, 'foodnstuff', 90); +``` + diff --git a/markdown/bitburner.ns.sprintf.md b/markdown/bitburner.ns.sprintf.md new file mode 100644 index 000000000..cda063926 --- /dev/null +++ b/markdown/bitburner.ns.sprintf.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [sprintf](./bitburner.ns.sprintf.md) + +## NS.sprintf() method + +Format a string. + +Signature: + +```typescript +sprintf(format: string, ...args: any[]): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | String to format. | +| args | any\[\] | Formatting arguments. | + +Returns: + +string + +Formatted text. + +## Remarks + +RAM cost: 0 GB + +see: https://github.com/alexei/sprintf.js + diff --git a/markdown/bitburner.ns.sqlinject.md b/markdown/bitburner.ns.sqlinject.md new file mode 100644 index 000000000..e5b4797cf --- /dev/null +++ b/markdown/bitburner.ns.sqlinject.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [sqlinject](./bitburner.ns.sqlinject.md) + +## NS.sqlinject() method + +Runs SQLInject.exe on a server. + +Signature: + +```typescript +sqlinject(host: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server. | + +Returns: + +void + +## Remarks + +RAM cost: 0.05 GB + +## Example 1 + + +```ts +// NS1: +sqlinject("foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +ns.sqlinject("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.stanek.md b/markdown/bitburner.ns.stanek.md new file mode 100644 index 000000000..b1d10e2e7 --- /dev/null +++ b/markdown/bitburner.ns.stanek.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [stanek](./bitburner.ns.stanek.md) + +## NS.stanek property + +Namespace for stanek functions. RAM cost: 0 GB + +Signature: + +```typescript +readonly stanek: Stanek; +``` diff --git a/markdown/bitburner.ns.stock.md b/markdown/bitburner.ns.stock.md new file mode 100644 index 000000000..14a1bc388 --- /dev/null +++ b/markdown/bitburner.ns.stock.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [stock](./bitburner.ns.stock.md) + +## NS.stock property + +Namespace for stock functions. + +Signature: + +```typescript +readonly stock: TIX; +``` + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.tail.md b/markdown/bitburner.ns.tail.md new file mode 100644 index 000000000..333d594af --- /dev/null +++ b/markdown/bitburner.ns.tail.md @@ -0,0 +1,66 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [tail](./bitburner.ns.tail.md) + +## NS.tail() method + +Open the tail window of a script. + +Signature: + +```typescript +tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. | +| host | string | Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. | +| args | (string \| number \| boolean)\[\] | Arguments for the script being tailed. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +Opens a script’s logs. This is functionally the same as the tail Terminal command. + +If the function is called with no arguments, it will open the current script’s logs. + +Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments. + +## Example 1 + + +```ts +// NS1: +//Open logs from foo.script on the current server that was run with no args +tail("foo.script"); + +//Get logs from foo.script on the foodnstuff server that was run with no args +tail("foo.script", "foodnstuff"); + +//Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] +tail("foo.script", "foodnstuff", 1, "test"); +``` + +## Example 2 + + +```ts +// NS2: +//Open logs from foo.script on the current server that was run with no args +ns.tail("foo.script"); + +//Get logs from foo.script on the foodnstuff server that was run with no args +ns.tail("foo.script", "foodnstuff"); + +//Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] +ns.tail("foo.script", "foodnstuff", 1, "test"); +``` + diff --git a/markdown/bitburner.ns.tformat.md b/markdown/bitburner.ns.tformat.md new file mode 100644 index 000000000..2e8ed2ca6 --- /dev/null +++ b/markdown/bitburner.ns.tformat.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [tFormat](./bitburner.ns.tformat.md) + +## NS.tFormat() method + +Format time to readable string + +Signature: + +```typescript +tFormat(milliseconds: number, milliPrecision?: boolean): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| milliseconds | number | Number of millisecond to format. | +| milliPrecision | boolean | Format time with subsecond precision, defaults to false. | + +Returns: + +string + +The formatted time. + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.ns.toast.md b/markdown/bitburner.ns.toast.md new file mode 100644 index 000000000..f58fbbe69 --- /dev/null +++ b/markdown/bitburner.ns.toast.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [toast](./bitburner.ns.toast.md) + +## NS.toast() method + +Queue a toast (bottom-right notification). + +Signature: + +```typescript +toast(msg: string, variant?: ToastVariant, duration?: number | null): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| msg | string | Message in the toast. | +| variant | [ToastVariant](./bitburner.toastvariant.md) | Type of toast, must be one of success, info, warning, error. Defaults to success. | +| duration | number \| null | Duration of toast in ms. Can also be null to create a persistent toast. Defaults to 2000 | + +Returns: + +void + diff --git a/markdown/bitburner.ns.tprint.md b/markdown/bitburner.ns.tprint.md new file mode 100644 index 000000000..4e8cd8d8a --- /dev/null +++ b/markdown/bitburner.ns.tprint.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [tprint](./bitburner.ns.tprint.md) + +## NS.tprint() method + +Prints one or more values or variables to the Terminal. + +Signature: + +```typescript +tprint(...args: any[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| args | any\[\] | Value(s) to be printed. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +See [print](./bitburner.ns.print.md) for how to add color to your printed strings. + diff --git a/markdown/bitburner.ns.tprintf.md b/markdown/bitburner.ns.tprintf.md new file mode 100644 index 000000000..1005b9be8 --- /dev/null +++ b/markdown/bitburner.ns.tprintf.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [tprintf](./bitburner.ns.tprintf.md) + +## NS.tprintf() method + +Prints a raw value or a variable to the Terminal. + +Signature: + +```typescript +tprintf(format: string, ...values: any[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | Format of the message. | +| values | any\[\] | Value(s) to be printed. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +- See [print](./bitburner.ns.print.md) for how to add color to your printed strings. + +- See [printf](./bitburner.ns.printf.md) for examples on formatted strings. + +- For more detail, see: https://github.com/alexei/sprintf.js + diff --git a/markdown/bitburner.ns.trywriteport.md b/markdown/bitburner.ns.trywriteport.md new file mode 100644 index 000000000..62aea2493 --- /dev/null +++ b/markdown/bitburner.ns.trywriteport.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [tryWritePort](./bitburner.ns.trywriteport.md) + +## NS.tryWritePort() method + +Attempt to write to a port. + +Signature: + +```typescript +tryWritePort(port: number, data: string | number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| port | number | Port or text file that will be written to. | +| data | string \| number | Data to write. | + +Returns: + +boolean + +True if the data is successfully written to the port, and false otherwise. + +## Remarks + +RAM cost: 0 GB + +Attempts to write data to the specified Netscript Port. If the port is full, the data will not be written. Otherwise, the data will be written normally. + diff --git a/markdown/bitburner.ns.ui.md b/markdown/bitburner.ns.ui.md new file mode 100644 index 000000000..445717055 --- /dev/null +++ b/markdown/bitburner.ns.ui.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [ui](./bitburner.ns.ui.md) + +## NS.ui property + +Namespace for user interface functions. RAM cost: 0 GB + +Signature: + +```typescript +readonly ui: UserInterface; +``` diff --git a/markdown/bitburner.ns.upgradepurchasedserver.md b/markdown/bitburner.ns.upgradepurchasedserver.md new file mode 100644 index 000000000..70c3b31c4 --- /dev/null +++ b/markdown/bitburner.ns.upgradepurchasedserver.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [upgradePurchasedServer](./bitburner.ns.upgradepurchasedserver.md) + +## NS.upgradePurchasedServer() method + +Upgrade a purchased servers ram. + +Signature: + +```typescript +upgradePurchasedServer(hostname: string, ram: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | Hostname 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: + +boolean + +True if the upgrade succeeded. + +## Remarks + +RAM cost: 0.25 GB + diff --git a/markdown/bitburner.ns.vsprintf.md b/markdown/bitburner.ns.vsprintf.md new file mode 100644 index 000000000..17b4c4ae7 --- /dev/null +++ b/markdown/bitburner.ns.vsprintf.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [vsprintf](./bitburner.ns.vsprintf.md) + +## NS.vsprintf() method + +Format a string with an array of arguments. + +Signature: + +```typescript +vsprintf(format: string, args: any[]): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | String to format. | +| args | any\[\] | Formatting arguments. | + +Returns: + +string + +Formatted text. + +## Remarks + +RAM cost: 0 GB + +see: https://github.com/alexei/sprintf.js + diff --git a/markdown/bitburner.ns.weaken.md b/markdown/bitburner.ns.weaken.md new file mode 100644 index 000000000..3ee0175ff --- /dev/null +++ b/markdown/bitburner.ns.weaken.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [weaken](./bitburner.ns.weaken.md) + +## NS.weaken() method + +Reduce a server security level. + +Signature: + +```typescript +weaken(host: string, opts?: BasicHGWOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | string | Hostname of the target server to weaken. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | + +Returns: + +Promise<number> + +The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads. + +## Remarks + +RAM cost: 0.15 GB + +Use your hacking skills to attack a server’s security, lowering the server’s security level. The runtime for this command depends on your hacking level and the target server’s security level when this function is called. This function lowers the security level of the target server by 0.05. + +Like hack and grow, `weaken` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command. + +## Example 1 + + +```ts +// NS1: +var currentSecurity = getServerSecurityLevel("foodnstuff"); +currentSecurity = currentSecurity - weaken("foodnstuff"); +``` + +## Example 2 + + +```ts +// NS2: +let currentSecurity = ns.getServerSecurityLevel("foodnstuff"); +currentSecurity -= await ns.weaken("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.weakenanalyze.md b/markdown/bitburner.ns.weakenanalyze.md new file mode 100644 index 000000000..4dabf061a --- /dev/null +++ b/markdown/bitburner.ns.weakenanalyze.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [weakenAnalyze](./bitburner.ns.weakenanalyze.md) + +## NS.weakenAnalyze() method + +Predict the effect of weaken. + +Signature: + +```typescript +weakenAnalyze(threads: number, cores?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| threads | number | Amount of threads that will be used. | +| cores | number | Optional. The number of cores of the server that would run weaken. | + +Returns: + +number + +The security decrease. + +## Remarks + +RAM cost: 1 GB + +Returns the security decrease that would occur if a weaken with this many threads happened. + diff --git a/markdown/bitburner.ns.wget.md b/markdown/bitburner.ns.wget.md new file mode 100644 index 000000000..01850c158 --- /dev/null +++ b/markdown/bitburner.ns.wget.md @@ -0,0 +1,54 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [wget](./bitburner.ns.wget.md) + +## NS.wget() method + +Download a file from the internet. + +Signature: + +```typescript +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 hostname/ip of server for target file. | + +Returns: + +Promise<boolean> + +True if the data was successfully retrieved from the URL, false otherwise. + +## Remarks + +RAM cost: 0 GB + +Retrieves data from a URL and downloads it to a file on the specified server. The data can only be downloaded to a script (.script, .js) or a text file (.txt). If the file already exists, it will be overwritten by this command. Note that it will not be possible to download data from many websites because they do not allow cross-origin resource sharing (CORS). + +IMPORTANT: This is an asynchronous function that returns a Promise. The Promise’s resolved value will be a boolean indicating whether or not the data was successfully retrieved from the URL. Because the function is async and returns a Promise, it is recommended you use wget in NetscriptJS (Netscript 2.0). + +In NetscriptJS, you must preface any call to wget with the await keyword (like you would hack or sleep). wget will still work in Netscript 1.0, but the functions execution will not be synchronous (i.e. it may not execute when you expect/want it to). Furthermore, since Promises are not supported in ES5, you will not be able to process the returned value of wget in Netscript 1.0. + +## Example 1 + + +```ts +// NS1: +wget("https://raw.githubusercontent.com/bitburner-official/bitburner-src/master/README.md", "game_readme.txt"); +``` + +## Example 2 + + +```ts +// NS2: +await ns.wget("https://raw.githubusercontent.com/bitburner-official/bitburner-src/master/README.md", "game_readme.txt"); +``` + diff --git a/markdown/bitburner.ns.write.md b/markdown/bitburner.ns.write.md new file mode 100644 index 000000000..c6ceee4ac --- /dev/null +++ b/markdown/bitburner.ns.write.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [write](./bitburner.ns.write.md) + +## NS.write() method + +Write data to a file. + +Signature: + +```typescript +write(filename: string, data?: string[] | number | string, mode?: "w" | "a"): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | Name of the file to be written to. | +| data | string\[\] \| number \| string | Data to write. | +| mode | "w" \| "a" | Defines the write mode. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +This function can be used to write data to a text file (.txt) or a script (.js or .script). + +This function will write data to that file. If the specified file does not exist, then it will be created. The third argument mode, defines how the data will be written to the file. If \*mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the file. + diff --git a/markdown/bitburner.ns.writeport.md b/markdown/bitburner.ns.writeport.md new file mode 100644 index 000000000..9f3fd36b2 --- /dev/null +++ b/markdown/bitburner.ns.writeport.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [writePort](./bitburner.ns.writeport.md) + +## NS.writePort() method + +Write data to a port. + +Signature: + +```typescript +writePort(port: number, data: string | number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| port | number | | +| data | string \| number | | + +Returns: + +Promise<[PortData](./bitburner.portdata.md)> + +The data popped off the queue if it was full. + +## Remarks + +RAM cost: 0 GB + +Write data to that netscript port. + diff --git a/markdown/bitburner.nsenums.md b/markdown/bitburner.nsenums.md new file mode 100644 index 000000000..2bb42da8c --- /dev/null +++ b/markdown/bitburner.nsenums.md @@ -0,0 +1,14 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NSEnums](./bitburner.nsenums.md) + +## NSEnums type + + +Signature: + +```typescript +export type NSEnums = typeof enums; +``` +References: [enums](./bitburner.enums.md) + diff --git a/markdown/bitburner.office.employeejobs.md b/markdown/bitburner.office.employeejobs.md new file mode 100644 index 000000000..34fe34842 --- /dev/null +++ b/markdown/bitburner.office.employeejobs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [employeeJobs](./bitburner.office.employeejobs.md) + +## Office.employeeJobs property + +Positions of the employees + +Signature: + +```typescript +employeeJobs: EmployeeJobs; +``` diff --git a/markdown/bitburner.office.employeeprod.md b/markdown/bitburner.office.employeeprod.md new file mode 100644 index 000000000..56c54a74a --- /dev/null +++ b/markdown/bitburner.office.employeeprod.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [employeeProd](./bitburner.office.employeeprod.md) + +## Office.employeeProd property + +Production of the employees + +Signature: + +```typescript +employeeProd: EmployeeJobs; +``` diff --git a/markdown/bitburner.office.employees.md b/markdown/bitburner.office.employees.md new file mode 100644 index 000000000..4d54145cd --- /dev/null +++ b/markdown/bitburner.office.employees.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [employees](./bitburner.office.employees.md) + +## Office.employees property + +Name of all the employees + +Signature: + +```typescript +employees: string[]; +``` diff --git a/markdown/bitburner.office.loc.md b/markdown/bitburner.office.loc.md new file mode 100644 index 000000000..7944150f1 --- /dev/null +++ b/markdown/bitburner.office.loc.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [loc](./bitburner.office.loc.md) + +## Office.loc property + +City of the office + +Signature: + +```typescript +loc: string; +``` diff --git a/markdown/bitburner.office.maxene.md b/markdown/bitburner.office.maxene.md new file mode 100644 index 000000000..92554bb97 --- /dev/null +++ b/markdown/bitburner.office.maxene.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [maxEne](./bitburner.office.maxene.md) + +## Office.maxEne property + +Maximum amount of energy of the employees + +Signature: + +```typescript +maxEne: number; +``` diff --git a/markdown/bitburner.office.maxhap.md b/markdown/bitburner.office.maxhap.md new file mode 100644 index 000000000..03e619dec --- /dev/null +++ b/markdown/bitburner.office.maxhap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [maxHap](./bitburner.office.maxhap.md) + +## Office.maxHap property + +Maximum happiness of the employees + +Signature: + +```typescript +maxHap: number; +``` diff --git a/markdown/bitburner.office.maxmor.md b/markdown/bitburner.office.maxmor.md new file mode 100644 index 000000000..ae0c55f3d --- /dev/null +++ b/markdown/bitburner.office.maxmor.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [maxMor](./bitburner.office.maxmor.md) + +## Office.maxMor property + +Maximum morale of the employees + +Signature: + +```typescript +maxMor: number; +``` diff --git a/markdown/bitburner.office.md b/markdown/bitburner.office.md new file mode 100644 index 000000000..41495d00e --- /dev/null +++ b/markdown/bitburner.office.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) + +## Office interface + +Office for a division in a city. + +Signature: + +```typescript +export interface Office +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [employeeJobs](./bitburner.office.employeejobs.md) | [EmployeeJobs](./bitburner.employeejobs.md) | Positions of the employees | +| [employeeProd](./bitburner.office.employeeprod.md) | [EmployeeJobs](./bitburner.employeejobs.md) | Production of the employees | +| [employees](./bitburner.office.employees.md) | string\[\] | Name of all the employees | +| [loc](./bitburner.office.loc.md) | string | City of the office | +| [maxEne](./bitburner.office.maxene.md) | number | Maximum amount of energy of the employees | +| [maxHap](./bitburner.office.maxhap.md) | number | Maximum happiness of the employees | +| [maxMor](./bitburner.office.maxmor.md) | number | Maximum morale of the employees | +| [minEne](./bitburner.office.minene.md) | number | Minimum amount of energy of the employees | +| [minHap](./bitburner.office.minhap.md) | number | Minimum happiness of the employees | +| [minMor](./bitburner.office.minmor.md) | number | Minimum morale of the employees | +| [size](./bitburner.office.size.md) | number | Maximum number of employee | + diff --git a/markdown/bitburner.office.minene.md b/markdown/bitburner.office.minene.md new file mode 100644 index 000000000..e3149862f --- /dev/null +++ b/markdown/bitburner.office.minene.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [minEne](./bitburner.office.minene.md) + +## Office.minEne property + +Minimum amount of energy of the employees + +Signature: + +```typescript +minEne: number; +``` diff --git a/markdown/bitburner.office.minhap.md b/markdown/bitburner.office.minhap.md new file mode 100644 index 000000000..68a7da897 --- /dev/null +++ b/markdown/bitburner.office.minhap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [minHap](./bitburner.office.minhap.md) + +## Office.minHap property + +Minimum happiness of the employees + +Signature: + +```typescript +minHap: number; +``` diff --git a/markdown/bitburner.office.minmor.md b/markdown/bitburner.office.minmor.md new file mode 100644 index 000000000..f91751f1d --- /dev/null +++ b/markdown/bitburner.office.minmor.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [minMor](./bitburner.office.minmor.md) + +## Office.minMor property + +Minimum morale of the employees + +Signature: + +```typescript +minMor: number; +``` diff --git a/markdown/bitburner.office.size.md b/markdown/bitburner.office.size.md new file mode 100644 index 000000000..696e614c0 --- /dev/null +++ b/markdown/bitburner.office.size.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Office](./bitburner.office.md) > [size](./bitburner.office.size.md) + +## Office.size property + +Maximum number of employee + +Signature: + +```typescript +size: number; +``` diff --git a/markdown/bitburner.officeapi.assignjob.md b/markdown/bitburner.officeapi.assignjob.md new file mode 100644 index 000000000..a62fbb084 --- /dev/null +++ b/markdown/bitburner.officeapi.assignjob.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [assignJob](./bitburner.officeapi.assignjob.md) + +## OfficeAPI.assignJob() method + +Assign an employee to a job. + +Signature: + +```typescript +assignJob(divisionName: string, cityName: string, employeeName: string, job: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| employeeName | string | name of the employee | +| job | string | Name of the job. | + +Returns: + +void + diff --git a/markdown/bitburner.officeapi.buycoffee.md b/markdown/bitburner.officeapi.buycoffee.md new file mode 100644 index 000000000..75558d76f --- /dev/null +++ b/markdown/bitburner.officeapi.buycoffee.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [buyCoffee](./bitburner.officeapi.buycoffee.md) + +## OfficeAPI.buyCoffee() method + +Buy coffee for your employees + +Signature: + +```typescript +buyCoffee(divisionName: string, cityName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | + +Returns: + +boolean + +true if buying coffee was successful, false otherwise + diff --git a/markdown/bitburner.officeapi.getemployee.md b/markdown/bitburner.officeapi.getemployee.md new file mode 100644 index 000000000..e26029b33 --- /dev/null +++ b/markdown/bitburner.officeapi.getemployee.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [getEmployee](./bitburner.officeapi.getemployee.md) + +## OfficeAPI.getEmployee() method + +Get data about an employee + +Signature: + +```typescript +getEmployee(divisionName: string, cityName: string, employeeName: string): Employee; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| employeeName | string | Name of the employee | + +Returns: + +[Employee](./bitburner.employee.md) + +Employee data + diff --git a/markdown/bitburner.officeapi.gethireadvertcost.md b/markdown/bitburner.officeapi.gethireadvertcost.md new file mode 100644 index 000000000..3be571d6b --- /dev/null +++ b/markdown/bitburner.officeapi.gethireadvertcost.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [getHireAdVertCost](./bitburner.officeapi.gethireadvertcost.md) + +## OfficeAPI.getHireAdVertCost() method + +Get the cost to Hire AdVert + +Signature: + +```typescript +getHireAdVertCost(divisionName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | + +Returns: + +number + +Cost + diff --git a/markdown/bitburner.officeapi.gethireadvertcount.md b/markdown/bitburner.officeapi.gethireadvertcount.md new file mode 100644 index 000000000..6fade9cf7 --- /dev/null +++ b/markdown/bitburner.officeapi.gethireadvertcount.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [getHireAdVertCount](./bitburner.officeapi.gethireadvertcount.md) + +## OfficeAPI.getHireAdVertCount() method + +Get the number of times you have Hired AdVert + +Signature: + +```typescript +getHireAdVertCount(adivisionName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| adivisionName | string | | + +Returns: + +number + +Number of times you have Hired AdVert + diff --git a/markdown/bitburner.officeapi.getoffice.md b/markdown/bitburner.officeapi.getoffice.md new file mode 100644 index 000000000..a1f78ff56 --- /dev/null +++ b/markdown/bitburner.officeapi.getoffice.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [getOffice](./bitburner.officeapi.getoffice.md) + +## OfficeAPI.getOffice() method + +Get data about an office + +Signature: + +```typescript +getOffice(divisionName: string, cityName: string): Office; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | + +Returns: + +[Office](./bitburner.office.md) + +Office data + diff --git a/markdown/bitburner.officeapi.getofficesizeupgradecost.md b/markdown/bitburner.officeapi.getofficesizeupgradecost.md new file mode 100644 index 000000000..1488a0d85 --- /dev/null +++ b/markdown/bitburner.officeapi.getofficesizeupgradecost.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [getOfficeSizeUpgradeCost](./bitburner.officeapi.getofficesizeupgradecost.md) + +## OfficeAPI.getOfficeSizeUpgradeCost() method + +Cost to Upgrade office size. + +Signature: + +```typescript +getOfficeSizeUpgradeCost(divisionName: string, cityName: string, asize: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| asize | number | | + +Returns: + +number + +Cost of upgrading the office + diff --git a/markdown/bitburner.officeapi.getresearchcost.md b/markdown/bitburner.officeapi.getresearchcost.md new file mode 100644 index 000000000..14899201a --- /dev/null +++ b/markdown/bitburner.officeapi.getresearchcost.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [getResearchCost](./bitburner.officeapi.getresearchcost.md) + +## OfficeAPI.getResearchCost() method + +Get the cost to unlock research + +Signature: + +```typescript +getResearchCost(divisionName: string, researchName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| researchName | string | Name of the research | + +Returns: + +number + +cost + diff --git a/markdown/bitburner.officeapi.hasresearched.md b/markdown/bitburner.officeapi.hasresearched.md new file mode 100644 index 000000000..362af2bd7 --- /dev/null +++ b/markdown/bitburner.officeapi.hasresearched.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [hasResearched](./bitburner.officeapi.hasresearched.md) + +## OfficeAPI.hasResearched() method + +Gets if you have unlocked a research + +Signature: + +```typescript +hasResearched(divisionName: string, researchName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| researchName | string | Name of the research | + +Returns: + +boolean + +true is unlocked, false if not + diff --git a/markdown/bitburner.officeapi.hireadvert.md b/markdown/bitburner.officeapi.hireadvert.md new file mode 100644 index 000000000..87a6cd787 --- /dev/null +++ b/markdown/bitburner.officeapi.hireadvert.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [hireAdVert](./bitburner.officeapi.hireadvert.md) + +## OfficeAPI.hireAdVert() method + +Hire AdVert. + +Signature: + +```typescript +hireAdVert(divisionName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | + +Returns: + +void + diff --git a/markdown/bitburner.officeapi.hireemployee.md b/markdown/bitburner.officeapi.hireemployee.md new file mode 100644 index 000000000..d72ec4407 --- /dev/null +++ b/markdown/bitburner.officeapi.hireemployee.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [hireEmployee](./bitburner.officeapi.hireemployee.md) + +## OfficeAPI.hireEmployee() method + +Hire an employee. + +Signature: + +```typescript +hireEmployee(divisionName: string, cityName: string): Employee | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | + +Returns: + +[Employee](./bitburner.employee.md) \| undefined + +The newly hired employee, if any + diff --git a/markdown/bitburner.officeapi.md b/markdown/bitburner.officeapi.md new file mode 100644 index 000000000..ecb622aab --- /dev/null +++ b/markdown/bitburner.officeapi.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) + +## OfficeAPI interface + +Corporation Office API + +Signature: + +```typescript +export interface OfficeAPI +``` + +## Remarks + +requires the Office API upgrade from your corporation. + +## Methods + +| Method | Description | +| --- | --- | +| [assignJob(divisionName, cityName, employeeName, job)](./bitburner.officeapi.assignjob.md) | Assign an employee to a job. | +| [buyCoffee(divisionName, cityName)](./bitburner.officeapi.buycoffee.md) | Buy coffee for your employees | +| [getEmployee(divisionName, cityName, employeeName)](./bitburner.officeapi.getemployee.md) | Get data about an employee | +| [getHireAdVertCost(divisionName)](./bitburner.officeapi.gethireadvertcost.md) | Get the cost to Hire AdVert | +| [getHireAdVertCount(adivisionName)](./bitburner.officeapi.gethireadvertcount.md) | Get the number of times you have Hired AdVert | +| [getOffice(divisionName, cityName)](./bitburner.officeapi.getoffice.md) | Get data about an office | +| [getOfficeSizeUpgradeCost(divisionName, cityName, asize)](./bitburner.officeapi.getofficesizeupgradecost.md) | Cost to Upgrade office size. | +| [getResearchCost(divisionName, researchName)](./bitburner.officeapi.getresearchcost.md) | Get the cost to unlock research | +| [hasResearched(divisionName, researchName)](./bitburner.officeapi.hasresearched.md) | Gets if you have unlocked a research | +| [hireAdVert(divisionName)](./bitburner.officeapi.hireadvert.md) | Hire AdVert. | +| [hireEmployee(divisionName, cityName)](./bitburner.officeapi.hireemployee.md) | Hire an employee. | +| [research(divisionName, researchName)](./bitburner.officeapi.research.md) | Purchase a research | +| [setAutoJobAssignment(divisionName, cityName, job, amount)](./bitburner.officeapi.setautojobassignment.md) | Set the auto job assignment for a job | +| [throwParty(divisionName, cityName, costPerEmployee)](./bitburner.officeapi.throwparty.md) | Throw a party for your employees | +| [upgradeOfficeSize(divisionName, cityName, size)](./bitburner.officeapi.upgradeofficesize.md) | Upgrade office size. | + diff --git a/markdown/bitburner.officeapi.research.md b/markdown/bitburner.officeapi.research.md new file mode 100644 index 000000000..112f48f38 --- /dev/null +++ b/markdown/bitburner.officeapi.research.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [research](./bitburner.officeapi.research.md) + +## OfficeAPI.research() method + +Purchase a research + +Signature: + +```typescript +research(divisionName: string, researchName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| researchName | string | Name of the research | + +Returns: + +void + diff --git a/markdown/bitburner.officeapi.setautojobassignment.md b/markdown/bitburner.officeapi.setautojobassignment.md new file mode 100644 index 000000000..ed92c21f8 --- /dev/null +++ b/markdown/bitburner.officeapi.setautojobassignment.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [setAutoJobAssignment](./bitburner.officeapi.setautojobassignment.md) + +## OfficeAPI.setAutoJobAssignment() method + +Set the auto job assignment for a job + +Signature: + +```typescript +setAutoJobAssignment(divisionName: string, cityName: string, job: string, amount: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| job | string | Name of the job | +| amount | number | Number of employees to assign to that job | + +Returns: + +boolean + +true if the employee count reached the target amount, false if not + diff --git a/markdown/bitburner.officeapi.throwparty.md b/markdown/bitburner.officeapi.throwparty.md new file mode 100644 index 000000000..5b8543a90 --- /dev/null +++ b/markdown/bitburner.officeapi.throwparty.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [throwParty](./bitburner.officeapi.throwparty.md) + +## OfficeAPI.throwParty() method + +Throw a party for your employees + +Signature: + +```typescript +throwParty(divisionName: string, cityName: string, costPerEmployee: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| costPerEmployee | number | Amount to spend per employee. | + +Returns: + +number + +Multiplier for happiness and morale, or zero on failure + diff --git a/markdown/bitburner.officeapi.upgradeofficesize.md b/markdown/bitburner.officeapi.upgradeofficesize.md new file mode 100644 index 000000000..25c7f46af --- /dev/null +++ b/markdown/bitburner.officeapi.upgradeofficesize.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OfficeAPI](./bitburner.officeapi.md) > [upgradeOfficeSize](./bitburner.officeapi.upgradeofficesize.md) + +## OfficeAPI.upgradeOfficeSize() method + +Upgrade office size. + +Signature: + +```typescript +upgradeOfficeSize(divisionName: string, cityName: string, size: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| size | number | Amount of positions to open | + +Returns: + +void + diff --git a/markdown/bitburner.ordertypes.md b/markdown/bitburner.ordertypes.md new file mode 100644 index 000000000..4753ee345 --- /dev/null +++ b/markdown/bitburner.ordertypes.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OrderTypes](./bitburner.ordertypes.md) + +## OrderTypes enum + + +Signature: + +```typescript +export enum OrderTypes +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| LimitBuy | "Limit Buy Order" | | +| LimitSell | "Limit Sell Order" | | +| StopBuy | "Stop Buy Order" | | +| StopSell | "Stop Sell Order" | | + diff --git a/markdown/bitburner.player.bitnoden.md b/markdown/bitburner.player.bitnoden.md new file mode 100644 index 000000000..dc10d8bce --- /dev/null +++ b/markdown/bitburner.player.bitnoden.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [bitNodeN](./bitburner.player.bitnoden.md) + +## Player.bitNodeN property + +Signature: + +```typescript +bitNodeN: number; +``` diff --git a/markdown/bitburner.player.city.md b/markdown/bitburner.player.city.md new file mode 100644 index 000000000..d5bcfbe21 --- /dev/null +++ b/markdown/bitburner.player.city.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [city](./bitburner.player.city.md) + +## Player.city property + +Signature: + +```typescript +city: string; +``` diff --git a/markdown/bitburner.player.entropy.md b/markdown/bitburner.player.entropy.md new file mode 100644 index 000000000..2209c8c9e --- /dev/null +++ b/markdown/bitburner.player.entropy.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [entropy](./bitburner.player.entropy.md) + +## Player.entropy property + +Signature: + +```typescript +entropy: number; +``` diff --git a/markdown/bitburner.player.exp.md b/markdown/bitburner.player.exp.md new file mode 100644 index 000000000..4bf123f6f --- /dev/null +++ b/markdown/bitburner.player.exp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [exp](./bitburner.player.exp.md) + +## Player.exp property + +Signature: + +```typescript +exp: Skills; +``` diff --git a/markdown/bitburner.player.factions.md b/markdown/bitburner.player.factions.md new file mode 100644 index 000000000..929d0df30 --- /dev/null +++ b/markdown/bitburner.player.factions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [factions](./bitburner.player.factions.md) + +## Player.factions property + +Signature: + +```typescript +factions: string[]; +``` diff --git a/markdown/bitburner.player.hascorporation.md b/markdown/bitburner.player.hascorporation.md new file mode 100644 index 000000000..3f9d9e6b2 --- /dev/null +++ b/markdown/bitburner.player.hascorporation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [hasCorporation](./bitburner.player.hascorporation.md) + +## Player.hasCorporation property + +Signature: + +```typescript +hasCorporation: boolean; +``` diff --git a/markdown/bitburner.player.hp.md b/markdown/bitburner.player.hp.md new file mode 100644 index 000000000..c201a7123 --- /dev/null +++ b/markdown/bitburner.player.hp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [hp](./bitburner.player.hp.md) + +## Player.hp property + +Signature: + +```typescript +hp: HP; +``` diff --git a/markdown/bitburner.player.inbladeburner.md b/markdown/bitburner.player.inbladeburner.md new file mode 100644 index 000000000..1bfe078fd --- /dev/null +++ b/markdown/bitburner.player.inbladeburner.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [inBladeburner](./bitburner.player.inbladeburner.md) + +## Player.inBladeburner property + +Signature: + +```typescript +inBladeburner: boolean; +``` diff --git a/markdown/bitburner.player.jobs.md b/markdown/bitburner.player.jobs.md new file mode 100644 index 000000000..708eee8b8 --- /dev/null +++ b/markdown/bitburner.player.jobs.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [jobs](./bitburner.player.jobs.md) + +## Player.jobs property + +Signature: + +```typescript +jobs: Record; +``` diff --git a/markdown/bitburner.player.location.md b/markdown/bitburner.player.location.md new file mode 100644 index 000000000..306830baf --- /dev/null +++ b/markdown/bitburner.player.location.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [location](./bitburner.player.location.md) + +## Player.location property + +Signature: + +```typescript +location: string; +``` diff --git a/markdown/bitburner.player.md b/markdown/bitburner.player.md new file mode 100644 index 000000000..93c240f2e --- /dev/null +++ b/markdown/bitburner.player.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) + +## Player interface + + +Signature: + +```typescript +interface Player +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [bitNodeN](./bitburner.player.bitnoden.md) | number | | +| [city](./bitburner.player.city.md) | string | | +| [entropy](./bitburner.player.entropy.md) | number | | +| [exp](./bitburner.player.exp.md) | [Skills](./bitburner.skills.md) | | +| [factions](./bitburner.player.factions.md) | string\[\] | | +| [hasCorporation](./bitburner.player.hascorporation.md) | boolean | | +| [hp](./bitburner.player.hp.md) | [HP](./bitburner.hp.md) | | +| [inBladeburner](./bitburner.player.inbladeburner.md) | boolean | | +| [jobs](./bitburner.player.jobs.md) | Record<string, string> | | +| [location](./bitburner.player.location.md) | string | | +| [money](./bitburner.player.money.md) | number | | +| [mults](./bitburner.player.mults.md) | [Multipliers](./bitburner.multipliers.md) | | +| [numPeopleKilled](./bitburner.player.numpeoplekilled.md) | number | | +| [playtimeSinceLastAug](./bitburner.player.playtimesincelastaug.md) | number | | +| [playtimeSinceLastBitnode](./bitburner.player.playtimesincelastbitnode.md) | number | | +| [skills](./bitburner.player.skills.md) | [Skills](./bitburner.skills.md) | | +| [tor](./bitburner.player.tor.md) | boolean | | +| [totalPlaytime](./bitburner.player.totalplaytime.md) | number | | + diff --git a/markdown/bitburner.player.money.md b/markdown/bitburner.player.money.md new file mode 100644 index 000000000..8aafa95d0 --- /dev/null +++ b/markdown/bitburner.player.money.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [money](./bitburner.player.money.md) + +## Player.money property + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.player.mults.md b/markdown/bitburner.player.mults.md new file mode 100644 index 000000000..43860cc6f --- /dev/null +++ b/markdown/bitburner.player.mults.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [mults](./bitburner.player.mults.md) + +## Player.mults property + +Signature: + +```typescript +mults: Multipliers; +``` diff --git a/markdown/bitburner.player.numpeoplekilled.md b/markdown/bitburner.player.numpeoplekilled.md new file mode 100644 index 000000000..10c50bc2f --- /dev/null +++ b/markdown/bitburner.player.numpeoplekilled.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [numPeopleKilled](./bitburner.player.numpeoplekilled.md) + +## Player.numPeopleKilled property + +Signature: + +```typescript +numPeopleKilled: number; +``` diff --git a/markdown/bitburner.player.playtimesincelastaug.md b/markdown/bitburner.player.playtimesincelastaug.md new file mode 100644 index 000000000..a35e3d02d --- /dev/null +++ b/markdown/bitburner.player.playtimesincelastaug.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [playtimeSinceLastAug](./bitburner.player.playtimesincelastaug.md) + +## Player.playtimeSinceLastAug property + +Signature: + +```typescript +playtimeSinceLastAug: number; +``` diff --git a/markdown/bitburner.player.playtimesincelastbitnode.md b/markdown/bitburner.player.playtimesincelastbitnode.md new file mode 100644 index 000000000..7023b6780 --- /dev/null +++ b/markdown/bitburner.player.playtimesincelastbitnode.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [playtimeSinceLastBitnode](./bitburner.player.playtimesincelastbitnode.md) + +## Player.playtimeSinceLastBitnode property + +Signature: + +```typescript +playtimeSinceLastBitnode: number; +``` diff --git a/markdown/bitburner.player.skills.md b/markdown/bitburner.player.skills.md new file mode 100644 index 000000000..04f4038a6 --- /dev/null +++ b/markdown/bitburner.player.skills.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [skills](./bitburner.player.skills.md) + +## Player.skills property + +Signature: + +```typescript +skills: Skills; +``` diff --git a/markdown/bitburner.player.tor.md b/markdown/bitburner.player.tor.md new file mode 100644 index 000000000..bd3af11bd --- /dev/null +++ b/markdown/bitburner.player.tor.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [tor](./bitburner.player.tor.md) + +## Player.tor property + +Signature: + +```typescript +tor: boolean; +``` diff --git a/markdown/bitburner.player.totalplaytime.md b/markdown/bitburner.player.totalplaytime.md new file mode 100644 index 000000000..0a0469be7 --- /dev/null +++ b/markdown/bitburner.player.totalplaytime.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [totalPlaytime](./bitburner.player.totalplaytime.md) + +## Player.totalPlaytime property + +Signature: + +```typescript +totalPlaytime: number; +``` diff --git a/markdown/bitburner.portdata.md b/markdown/bitburner.portdata.md new file mode 100644 index 000000000..c5b77a426 --- /dev/null +++ b/markdown/bitburner.portdata.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PortData](./bitburner.portdata.md) + +## PortData type + + +Signature: + +```typescript +type PortData = string | number; +``` diff --git a/markdown/bitburner.positiontypes.md b/markdown/bitburner.positiontypes.md new file mode 100644 index 000000000..8946c1037 --- /dev/null +++ b/markdown/bitburner.positiontypes.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PositionTypes](./bitburner.positiontypes.md) + +## PositionTypes enum + + +Signature: + +```typescript +export enum PositionTypes +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Long | "L" | | +| Short | "S" | | + diff --git a/markdown/bitburner.possibleinfiltrationlocation.city.md b/markdown/bitburner.possibleinfiltrationlocation.city.md new file mode 100644 index 000000000..7ebe6325e --- /dev/null +++ b/markdown/bitburner.possibleinfiltrationlocation.city.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PossibleInfiltrationLocation](./bitburner.possibleinfiltrationlocation.md) > [city](./bitburner.possibleinfiltrationlocation.city.md) + +## PossibleInfiltrationLocation.city property + +Signature: + +```typescript +city: string; +``` diff --git a/markdown/bitburner.possibleinfiltrationlocation.md b/markdown/bitburner.possibleinfiltrationlocation.md new file mode 100644 index 000000000..f38cb53c1 --- /dev/null +++ b/markdown/bitburner.possibleinfiltrationlocation.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PossibleInfiltrationLocation](./bitburner.possibleinfiltrationlocation.md) + +## PossibleInfiltrationLocation interface + + +Signature: + +```typescript +export interface PossibleInfiltrationLocation +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [city](./bitburner.possibleinfiltrationlocation.city.md) | string | | +| [name](./bitburner.possibleinfiltrationlocation.name.md) | string | | + diff --git a/markdown/bitburner.possibleinfiltrationlocation.name.md b/markdown/bitburner.possibleinfiltrationlocation.name.md new file mode 100644 index 000000000..5c5d39dc8 --- /dev/null +++ b/markdown/bitburner.possibleinfiltrationlocation.name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PossibleInfiltrationLocation](./bitburner.possibleinfiltrationlocation.md) > [name](./bitburner.possibleinfiltrationlocation.name.md) + +## PossibleInfiltrationLocation.name property + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.processinfo.args.md b/markdown/bitburner.processinfo.args.md new file mode 100644 index 000000000..868fad1cd --- /dev/null +++ b/markdown/bitburner.processinfo.args.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) > [args](./bitburner.processinfo.args.md) + +## ProcessInfo.args property + +Script's arguments + +Signature: + +```typescript +args: (string | number | boolean)[]; +``` diff --git a/markdown/bitburner.processinfo.filename.md b/markdown/bitburner.processinfo.filename.md new file mode 100644 index 000000000..1a969a65b --- /dev/null +++ b/markdown/bitburner.processinfo.filename.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) > [filename](./bitburner.processinfo.filename.md) + +## ProcessInfo.filename property + +Script name. + +Signature: + +```typescript +filename: string; +``` diff --git a/markdown/bitburner.processinfo.md b/markdown/bitburner.processinfo.md new file mode 100644 index 000000000..009b5b5e8 --- /dev/null +++ b/markdown/bitburner.processinfo.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) + +## ProcessInfo interface + +A single process on a server. + +Signature: + +```typescript +export interface ProcessInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [args](./bitburner.processinfo.args.md) | (string \| number \| boolean)\[\] | Script's arguments | +| [filename](./bitburner.processinfo.filename.md) | string | Script name. | +| [pid](./bitburner.processinfo.pid.md) | number | Process ID | +| [threads](./bitburner.processinfo.threads.md) | number | Number of threads script is running with | + diff --git a/markdown/bitburner.processinfo.pid.md b/markdown/bitburner.processinfo.pid.md new file mode 100644 index 000000000..395a72be3 --- /dev/null +++ b/markdown/bitburner.processinfo.pid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) > [pid](./bitburner.processinfo.pid.md) + +## ProcessInfo.pid property + +Process ID + +Signature: + +```typescript +pid: number; +``` diff --git a/markdown/bitburner.processinfo.threads.md b/markdown/bitburner.processinfo.threads.md new file mode 100644 index 000000000..8ba00b6ce --- /dev/null +++ b/markdown/bitburner.processinfo.threads.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) > [threads](./bitburner.processinfo.threads.md) + +## ProcessInfo.threads property + +Number of threads script is running with + +Signature: + +```typescript +threads: number; +``` diff --git a/markdown/bitburner.product.citydata.md b/markdown/bitburner.product.citydata.md new file mode 100644 index 000000000..aad8ca9c2 --- /dev/null +++ b/markdown/bitburner.product.citydata.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [cityData](./bitburner.product.citydata.md) + +## Product.cityData property + +Data refers to the production, sale, and quantity of the products These values are specific to a city For each city, the data is \[qty, prod, sell\] + +Signature: + +```typescript +cityData: { [key: string]: number[] }; +``` diff --git a/markdown/bitburner.product.cmp.md b/markdown/bitburner.product.cmp.md new file mode 100644 index 000000000..88e186780 --- /dev/null +++ b/markdown/bitburner.product.cmp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [cmp](./bitburner.product.cmp.md) + +## Product.cmp property + +Competition for the product, only present if "Market Research - Competition" unlocked + +Signature: + +```typescript +cmp: number | undefined; +``` diff --git a/markdown/bitburner.product.developmentprogress.md b/markdown/bitburner.product.developmentprogress.md new file mode 100644 index 000000000..0949fb793 --- /dev/null +++ b/markdown/bitburner.product.developmentprogress.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [developmentProgress](./bitburner.product.developmentprogress.md) + +## Product.developmentProgress property + +Creation progress - A number between 0-100 representing percentage + +Signature: + +```typescript +developmentProgress: number; +``` diff --git a/markdown/bitburner.product.dmd.md b/markdown/bitburner.product.dmd.md new file mode 100644 index 000000000..f771d6e4b --- /dev/null +++ b/markdown/bitburner.product.dmd.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [dmd](./bitburner.product.dmd.md) + +## Product.dmd property + +Demand for the product, only present if "Market Research - Demand" unlocked + +Signature: + +```typescript +dmd: number | undefined; +``` diff --git a/markdown/bitburner.product.md b/markdown/bitburner.product.md new file mode 100644 index 000000000..be31c122d --- /dev/null +++ b/markdown/bitburner.product.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) + +## Product interface + +Product in a warehouse + +Signature: + +```typescript +interface Product +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [cityData](./bitburner.product.citydata.md) | { \[key: string\]: number\[\] } | Data refers to the production, sale, and quantity of the products These values are specific to a city For each city, the data is \[qty, prod, sell\] | +| [cmp](./bitburner.product.cmp.md) | number \| undefined | Competition for the product, only present if "Market Research - Competition" unlocked | +| [developmentProgress](./bitburner.product.developmentprogress.md) | number | Creation progress - A number between 0-100 representing percentage | +| [dmd](./bitburner.product.dmd.md) | number \| undefined | Demand for the product, only present if "Market Research - Demand" unlocked | +| [name](./bitburner.product.name.md) | string | Name of the product | +| [pCost](./bitburner.product.pcost.md) | number | Production cost | +| [properties](./bitburner.product.properties.md) | { \[key: string\]: number } | Product Properties. The data is {qlt, per, dur, rel, aes, fea} | +| [rat](./bitburner.product.rat.md) | number | Product Rating | +| [sCost](./bitburner.product.scost.md) | string \| number | Sell cost, can be "MP+5" | + diff --git a/markdown/bitburner.product.name.md b/markdown/bitburner.product.name.md new file mode 100644 index 000000000..1652c1672 --- /dev/null +++ b/markdown/bitburner.product.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [name](./bitburner.product.name.md) + +## Product.name property + +Name of the product + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.product.pcost.md b/markdown/bitburner.product.pcost.md new file mode 100644 index 000000000..b1b130910 --- /dev/null +++ b/markdown/bitburner.product.pcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [pCost](./bitburner.product.pcost.md) + +## Product.pCost property + +Production cost + +Signature: + +```typescript +pCost: number; +``` diff --git a/markdown/bitburner.product.properties.md b/markdown/bitburner.product.properties.md new file mode 100644 index 000000000..bd202079d --- /dev/null +++ b/markdown/bitburner.product.properties.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [properties](./bitburner.product.properties.md) + +## Product.properties property + +Product Properties. The data is {qlt, per, dur, rel, aes, fea} + +Signature: + +```typescript +properties: { [key: string]: number }; +``` diff --git a/markdown/bitburner.product.rat.md b/markdown/bitburner.product.rat.md new file mode 100644 index 000000000..d65342786 --- /dev/null +++ b/markdown/bitburner.product.rat.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [rat](./bitburner.product.rat.md) + +## Product.rat property + +Product Rating + +Signature: + +```typescript +rat: number; +``` diff --git a/markdown/bitburner.product.scost.md b/markdown/bitburner.product.scost.md new file mode 100644 index 000000000..b226e879e --- /dev/null +++ b/markdown/bitburner.product.scost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Product](./bitburner.product.md) > [sCost](./bitburner.product.scost.md) + +## Product.sCost property + +Sell cost, can be "MP+5" + +Signature: + +```typescript +sCost: string | number; +``` diff --git a/markdown/bitburner.recentscript.md b/markdown/bitburner.recentscript.md new file mode 100644 index 000000000..7be1b56c1 --- /dev/null +++ b/markdown/bitburner.recentscript.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RecentScript](./bitburner.recentscript.md) + +## RecentScript interface + + +Signature: + +```typescript +export interface RecentScript extends RunningScript +``` +Extends: [RunningScript](./bitburner.runningscript.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [timeOfDeath](./bitburner.recentscript.timeofdeath.md) | Date | Timestamp of when the script was killed | + diff --git a/markdown/bitburner.recentscript.timeofdeath.md b/markdown/bitburner.recentscript.timeofdeath.md new file mode 100644 index 000000000..306281be1 --- /dev/null +++ b/markdown/bitburner.recentscript.timeofdeath.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RecentScript](./bitburner.recentscript.md) > [timeOfDeath](./bitburner.recentscript.timeofdeath.md) + +## RecentScript.timeOfDeath property + +Timestamp of when the script was killed + +Signature: + +```typescript +timeOfDeath: Date; +``` diff --git a/markdown/bitburner.reputationformulas.calculatefavortorep.md b/markdown/bitburner.reputationformulas.calculatefavortorep.md new file mode 100644 index 000000000..eeb6f6a5b --- /dev/null +++ b/markdown/bitburner.reputationformulas.calculatefavortorep.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ReputationFormulas](./bitburner.reputationformulas.md) > [calculateFavorToRep](./bitburner.reputationformulas.calculatefavortorep.md) + +## ReputationFormulas.calculateFavorToRep() method + +Calculate the total required amount of faction reputation to reach a target favor. + +Signature: + +```typescript +calculateFavorToRep(favor: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| favor | number | target faction favor. | + +Returns: + +number + +The calculated faction reputation required. + diff --git a/markdown/bitburner.reputationformulas.calculatereptofavor.md b/markdown/bitburner.reputationformulas.calculatereptofavor.md new file mode 100644 index 000000000..98790966c --- /dev/null +++ b/markdown/bitburner.reputationformulas.calculatereptofavor.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ReputationFormulas](./bitburner.reputationformulas.md) > [calculateRepToFavor](./bitburner.reputationformulas.calculatereptofavor.md) + +## ReputationFormulas.calculateRepToFavor() method + +Calculate the resulting faction favor of a total amount of reputation. (Faction favor is gained whenever you install an Augmentation.) + +Signature: + +```typescript +calculateRepToFavor(rep: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| rep | number | amount of reputation. | + +Returns: + +number + +The calculated faction favor. + diff --git a/markdown/bitburner.reputationformulas.md b/markdown/bitburner.reputationformulas.md new file mode 100644 index 000000000..65e3bc7ea --- /dev/null +++ b/markdown/bitburner.reputationformulas.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ReputationFormulas](./bitburner.reputationformulas.md) + +## ReputationFormulas interface + +Reputation formulas + +Signature: + +```typescript +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.) | +| [repFromDonation(amount, player)](./bitburner.reputationformulas.repfromdonation.md) | Calculate how much rep would be gained. | + diff --git a/markdown/bitburner.reputationformulas.repfromdonation.md b/markdown/bitburner.reputationformulas.repfromdonation.md new file mode 100644 index 000000000..fef8669d8 --- /dev/null +++ b/markdown/bitburner.reputationformulas.repfromdonation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ReputationFormulas](./bitburner.reputationformulas.md) > [repFromDonation](./bitburner.reputationformulas.repfromdonation.md) + +## ReputationFormulas.repFromDonation() method + +Calculate how much rep would be gained. + +Signature: + +```typescript +repFromDonation(amount: number, player: Player): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| amount | number | Amount of money donated | +| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) | + +Returns: + +number + diff --git a/markdown/bitburner.runningscript.args.md b/markdown/bitburner.runningscript.args.md new file mode 100644 index 000000000..c615d1534 --- /dev/null +++ b/markdown/bitburner.runningscript.args.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [args](./bitburner.runningscript.args.md) + +## RunningScript.args property + +Arguments the script was called with + +Signature: + +```typescript +args: (string | number | boolean)[]; +``` diff --git a/markdown/bitburner.runningscript.filename.md b/markdown/bitburner.runningscript.filename.md new file mode 100644 index 000000000..9df32ed16 --- /dev/null +++ b/markdown/bitburner.runningscript.filename.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [filename](./bitburner.runningscript.filename.md) + +## RunningScript.filename property + +Filename of the script + +Signature: + +```typescript +filename: string; +``` diff --git a/markdown/bitburner.runningscript.logs.md b/markdown/bitburner.runningscript.logs.md new file mode 100644 index 000000000..503a0861e --- /dev/null +++ b/markdown/bitburner.runningscript.logs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [logs](./bitburner.runningscript.logs.md) + +## RunningScript.logs property + +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. + +Signature: + +```typescript +logs: string[]; +``` diff --git a/markdown/bitburner.runningscript.md b/markdown/bitburner.runningscript.md new file mode 100644 index 000000000..feaa91818 --- /dev/null +++ b/markdown/bitburner.runningscript.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) + +## RunningScript interface + + +Signature: + +```typescript +export interface RunningScript +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [args](./bitburner.runningscript.args.md) | (string \| number \| boolean)\[\] | Arguments the script was called with | +| [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 | +| [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 | +| [server](./bitburner.runningscript.server.md) | string | Hostname of the server on which this script runs | +| [threads](./bitburner.runningscript.threads.md) | number | Number of threads that this script runs with | + diff --git a/markdown/bitburner.runningscript.offlineexpgained.md b/markdown/bitburner.runningscript.offlineexpgained.md new file mode 100644 index 000000000..34b8aa729 --- /dev/null +++ b/markdown/bitburner.runningscript.offlineexpgained.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [offlineExpGained](./bitburner.runningscript.offlineexpgained.md) + +## RunningScript.offlineExpGained property + +Total amount of hacking experience earned from this script when offline + +Signature: + +```typescript +offlineExpGained: number; +``` diff --git a/markdown/bitburner.runningscript.offlinemoneymade.md b/markdown/bitburner.runningscript.offlinemoneymade.md new file mode 100644 index 000000000..e55bccd89 --- /dev/null +++ b/markdown/bitburner.runningscript.offlinemoneymade.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [offlineMoneyMade](./bitburner.runningscript.offlinemoneymade.md) + +## RunningScript.offlineMoneyMade property + +Total amount of money made by this script when offline + +Signature: + +```typescript +offlineMoneyMade: number; +``` diff --git a/markdown/bitburner.runningscript.offlinerunningtime.md b/markdown/bitburner.runningscript.offlinerunningtime.md new file mode 100644 index 000000000..ebe6b1467 --- /dev/null +++ b/markdown/bitburner.runningscript.offlinerunningtime.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [offlineRunningTime](./bitburner.runningscript.offlinerunningtime.md) + +## RunningScript.offlineRunningTime property + +Number of seconds that the script has been running offline + +Signature: + +```typescript +offlineRunningTime: number; +``` diff --git a/markdown/bitburner.runningscript.onlineexpgained.md b/markdown/bitburner.runningscript.onlineexpgained.md new file mode 100644 index 000000000..dafe1fcdf --- /dev/null +++ b/markdown/bitburner.runningscript.onlineexpgained.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [onlineExpGained](./bitburner.runningscript.onlineexpgained.md) + +## RunningScript.onlineExpGained property + +Total amount of hacking experience earned from this script when online + +Signature: + +```typescript +onlineExpGained: number; +``` diff --git a/markdown/bitburner.runningscript.onlinemoneymade.md b/markdown/bitburner.runningscript.onlinemoneymade.md new file mode 100644 index 000000000..d206f7b33 --- /dev/null +++ b/markdown/bitburner.runningscript.onlinemoneymade.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [onlineMoneyMade](./bitburner.runningscript.onlinemoneymade.md) + +## RunningScript.onlineMoneyMade property + +Total amount of money made by this script when online + +Signature: + +```typescript +onlineMoneyMade: number; +``` diff --git a/markdown/bitburner.runningscript.onlinerunningtime.md b/markdown/bitburner.runningscript.onlinerunningtime.md new file mode 100644 index 000000000..280d2ab44 --- /dev/null +++ b/markdown/bitburner.runningscript.onlinerunningtime.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [onlineRunningTime](./bitburner.runningscript.onlinerunningtime.md) + +## RunningScript.onlineRunningTime property + +Number of seconds that this script has been running online + +Signature: + +```typescript +onlineRunningTime: number; +``` diff --git a/markdown/bitburner.runningscript.pid.md b/markdown/bitburner.runningscript.pid.md new file mode 100644 index 000000000..0399d5593 --- /dev/null +++ b/markdown/bitburner.runningscript.pid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [pid](./bitburner.runningscript.pid.md) + +## RunningScript.pid property + +Process ID. Must be an integer + +Signature: + +```typescript +pid: number; +``` diff --git a/markdown/bitburner.runningscript.ramusage.md b/markdown/bitburner.runningscript.ramusage.md new file mode 100644 index 000000000..ce45ffc33 --- /dev/null +++ b/markdown/bitburner.runningscript.ramusage.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [ramUsage](./bitburner.runningscript.ramusage.md) + +## RunningScript.ramUsage property + +How much RAM this script uses for ONE thread + +Signature: + +```typescript +ramUsage: number; +``` diff --git a/markdown/bitburner.runningscript.server.md b/markdown/bitburner.runningscript.server.md new file mode 100644 index 000000000..246ca1a75 --- /dev/null +++ b/markdown/bitburner.runningscript.server.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [server](./bitburner.runningscript.server.md) + +## RunningScript.server property + +Hostname of the server on which this script runs + +Signature: + +```typescript +server: string; +``` diff --git a/markdown/bitburner.runningscript.threads.md b/markdown/bitburner.runningscript.threads.md new file mode 100644 index 000000000..83ec797c5 --- /dev/null +++ b/markdown/bitburner.runningscript.threads.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [RunningScript](./bitburner.runningscript.md) > [threads](./bitburner.runningscript.threads.md) + +## RunningScript.threads property + +Number of threads that this script runs with + +Signature: + +```typescript +threads: number; +``` diff --git a/markdown/bitburner.scriptarg.md b/markdown/bitburner.scriptarg.md new file mode 100644 index 000000000..d898c4053 --- /dev/null +++ b/markdown/bitburner.scriptarg.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ScriptArg](./bitburner.scriptarg.md) + +## ScriptArg type + + +Signature: + +```typescript +type ScriptArg = string | number | boolean; +``` diff --git a/markdown/bitburner.server.backdoorinstalled.md b/markdown/bitburner.server.backdoorinstalled.md new file mode 100644 index 000000000..dc8b9f19e --- /dev/null +++ b/markdown/bitburner.server.backdoorinstalled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [backdoorInstalled](./bitburner.server.backdoorinstalled.md) + +## Server.backdoorInstalled property + +Flag indicating whether this server has a backdoor installed by a player + +Signature: + +```typescript +backdoorInstalled: boolean; +``` diff --git a/markdown/bitburner.server.basedifficulty.md b/markdown/bitburner.server.basedifficulty.md new file mode 100644 index 000000000..56a418311 --- /dev/null +++ b/markdown/bitburner.server.basedifficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [baseDifficulty](./bitburner.server.basedifficulty.md) + +## Server.baseDifficulty property + +Initial server security level (i.e. security level when the server was created) + +Signature: + +```typescript +baseDifficulty: number; +``` diff --git a/markdown/bitburner.server.cpucores.md b/markdown/bitburner.server.cpucores.md new file mode 100644 index 000000000..0bf4287dc --- /dev/null +++ b/markdown/bitburner.server.cpucores.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [cpuCores](./bitburner.server.cpucores.md) + +## Server.cpuCores property + +How many CPU cores this server has. Maximum of 8. Affects magnitude of grow and weaken. + +Signature: + +```typescript +cpuCores: number; +``` diff --git a/markdown/bitburner.server.ftpportopen.md b/markdown/bitburner.server.ftpportopen.md new file mode 100644 index 000000000..6d1fd9490 --- /dev/null +++ b/markdown/bitburner.server.ftpportopen.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [ftpPortOpen](./bitburner.server.ftpportopen.md) + +## Server.ftpPortOpen property + +Flag indicating whether the FTP port is open + +Signature: + +```typescript +ftpPortOpen: boolean; +``` diff --git a/markdown/bitburner.server.hackdifficulty.md b/markdown/bitburner.server.hackdifficulty.md new file mode 100644 index 000000000..e9c8b4b68 --- /dev/null +++ b/markdown/bitburner.server.hackdifficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [hackDifficulty](./bitburner.server.hackdifficulty.md) + +## Server.hackDifficulty property + +Server Security Level + +Signature: + +```typescript +hackDifficulty: number; +``` diff --git a/markdown/bitburner.server.hasadminrights.md b/markdown/bitburner.server.hasadminrights.md new file mode 100644 index 000000000..4dc4892d7 --- /dev/null +++ b/markdown/bitburner.server.hasadminrights.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [hasAdminRights](./bitburner.server.hasadminrights.md) + +## Server.hasAdminRights property + +Flag indicating whether player has admin/root access to this server + +Signature: + +```typescript +hasAdminRights: boolean; +``` diff --git a/markdown/bitburner.server.hostname.md b/markdown/bitburner.server.hostname.md new file mode 100644 index 000000000..f0aaea4bd --- /dev/null +++ b/markdown/bitburner.server.hostname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [hostname](./bitburner.server.hostname.md) + +## Server.hostname property + +Hostname. Must be unique + +Signature: + +```typescript +hostname: string; +``` diff --git a/markdown/bitburner.server.httpportopen.md b/markdown/bitburner.server.httpportopen.md new file mode 100644 index 000000000..6c5568a8a --- /dev/null +++ b/markdown/bitburner.server.httpportopen.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [httpPortOpen](./bitburner.server.httpportopen.md) + +## Server.httpPortOpen property + +Flag indicating whether HTTP Port is open + +Signature: + +```typescript +httpPortOpen: boolean; +``` diff --git a/markdown/bitburner.server.ip.md b/markdown/bitburner.server.ip.md new file mode 100644 index 000000000..64e46a81b --- /dev/null +++ b/markdown/bitburner.server.ip.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [ip](./bitburner.server.ip.md) + +## Server.ip property + +IP Address. Must be unique + +Signature: + +```typescript +ip: string; +``` diff --git a/markdown/bitburner.server.isconnectedto.md b/markdown/bitburner.server.isconnectedto.md new file mode 100644 index 000000000..d32099e16 --- /dev/null +++ b/markdown/bitburner.server.isconnectedto.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [isConnectedTo](./bitburner.server.isconnectedto.md) + +## Server.isConnectedTo property + +Flag indicating whether player is currently connected to this server + +Signature: + +```typescript +isConnectedTo: boolean; +``` diff --git a/markdown/bitburner.server.maxram.md b/markdown/bitburner.server.maxram.md new file mode 100644 index 000000000..75bb5bcb3 --- /dev/null +++ b/markdown/bitburner.server.maxram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [maxRam](./bitburner.server.maxram.md) + +## Server.maxRam property + +RAM (GB) available on this server + +Signature: + +```typescript +maxRam: number; +``` diff --git a/markdown/bitburner.server.md b/markdown/bitburner.server.md new file mode 100644 index 000000000..b47cd3ff9 --- /dev/null +++ b/markdown/bitburner.server.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) + +## Server interface + +A single server. + +Signature: + +```typescript +export interface Server +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [backdoorInstalled](./bitburner.server.backdoorinstalled.md) | boolean | Flag indicating whether this server has a backdoor installed by a player | +| [baseDifficulty](./bitburner.server.basedifficulty.md) | number | Initial server security level (i.e. security level when the server was created) | +| [cpuCores](./bitburner.server.cpucores.md) | number | How many CPU cores this server has. Maximum of 8. Affects magnitude of grow and weaken. | +| [ftpPortOpen](./bitburner.server.ftpportopen.md) | boolean | Flag indicating whether the FTP port is open | +| [hackDifficulty](./bitburner.server.hackdifficulty.md) | number | 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 | Flag indicating whether 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 | Minimum server security level that this server can be weakened to | +| [moneyAvailable](./bitburner.server.moneyavailable.md) | number | How much money currently resides on the server and can be hacked | +| [moneyMax](./bitburner.server.moneymax.md) | number | Maximum amount of money that this server can hold | +| [numOpenPortsRequired](./bitburner.server.numopenportsrequired.md) | number | Number of open ports required in order to gain admin/root access | +| [openPortCount](./bitburner.server.openportcount.md) | number | 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. Optional, 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 | Hacking level required to hack this server | +| [serverGrowth](./bitburner.server.servergrowth.md) | number | Parameter that affects how effectively this server's money can be increased using the grow() Netscript function | +| [smtpPortOpen](./bitburner.server.smtpportopen.md) | boolean | Flag indicating whether SMTP Port is open | +| [sqlPortOpen](./bitburner.server.sqlportopen.md) | boolean | Flag indicating whether SQL Port is open | +| [sshPortOpen](./bitburner.server.sshportopen.md) | boolean | Flag indicating whether the SSH Port is open | + diff --git a/markdown/bitburner.server.mindifficulty.md b/markdown/bitburner.server.mindifficulty.md new file mode 100644 index 000000000..4f8ad40ae --- /dev/null +++ b/markdown/bitburner.server.mindifficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [minDifficulty](./bitburner.server.mindifficulty.md) + +## Server.minDifficulty property + +Minimum server security level that this server can be weakened to + +Signature: + +```typescript +minDifficulty: number; +``` diff --git a/markdown/bitburner.server.moneyavailable.md b/markdown/bitburner.server.moneyavailable.md new file mode 100644 index 000000000..f8c3ed2ad --- /dev/null +++ b/markdown/bitburner.server.moneyavailable.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [moneyAvailable](./bitburner.server.moneyavailable.md) + +## Server.moneyAvailable property + +How much money currently resides on the server and can be hacked + +Signature: + +```typescript +moneyAvailable: number; +``` diff --git a/markdown/bitburner.server.moneymax.md b/markdown/bitburner.server.moneymax.md new file mode 100644 index 000000000..40fba72c0 --- /dev/null +++ b/markdown/bitburner.server.moneymax.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [moneyMax](./bitburner.server.moneymax.md) + +## Server.moneyMax property + +Maximum amount of money that this server can hold + +Signature: + +```typescript +moneyMax: number; +``` diff --git a/markdown/bitburner.server.numopenportsrequired.md b/markdown/bitburner.server.numopenportsrequired.md new file mode 100644 index 000000000..eb8d16369 --- /dev/null +++ b/markdown/bitburner.server.numopenportsrequired.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [numOpenPortsRequired](./bitburner.server.numopenportsrequired.md) + +## Server.numOpenPortsRequired property + +Number of open ports required in order to gain admin/root access + +Signature: + +```typescript +numOpenPortsRequired: number; +``` diff --git a/markdown/bitburner.server.openportcount.md b/markdown/bitburner.server.openportcount.md new file mode 100644 index 000000000..f57694725 --- /dev/null +++ b/markdown/bitburner.server.openportcount.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [openPortCount](./bitburner.server.openportcount.md) + +## Server.openPortCount property + +How many ports are currently opened on the server + +Signature: + +```typescript +openPortCount: number; +``` diff --git a/markdown/bitburner.server.organizationname.md b/markdown/bitburner.server.organizationname.md new file mode 100644 index 000000000..5becf3a28 --- /dev/null +++ b/markdown/bitburner.server.organizationname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [organizationName](./bitburner.server.organizationname.md) + +## Server.organizationName property + +Name of company/faction/etc. that this server belongs to. Optional, not applicable to all Servers + +Signature: + +```typescript +organizationName: string; +``` diff --git a/markdown/bitburner.server.purchasedbyplayer.md b/markdown/bitburner.server.purchasedbyplayer.md new file mode 100644 index 000000000..c1bf7862a --- /dev/null +++ b/markdown/bitburner.server.purchasedbyplayer.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [purchasedByPlayer](./bitburner.server.purchasedbyplayer.md) + +## Server.purchasedByPlayer property + +Flag indicating whether this is a purchased server + +Signature: + +```typescript +purchasedByPlayer: boolean; +``` diff --git a/markdown/bitburner.server.ramused.md b/markdown/bitburner.server.ramused.md new file mode 100644 index 000000000..59c5d1447 --- /dev/null +++ b/markdown/bitburner.server.ramused.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [ramUsed](./bitburner.server.ramused.md) + +## Server.ramUsed property + +RAM (GB) used. i.e. unavailable RAM + +Signature: + +```typescript +ramUsed: number; +``` diff --git a/markdown/bitburner.server.requiredhackingskill.md b/markdown/bitburner.server.requiredhackingskill.md new file mode 100644 index 000000000..0617859a4 --- /dev/null +++ b/markdown/bitburner.server.requiredhackingskill.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [requiredHackingSkill](./bitburner.server.requiredhackingskill.md) + +## Server.requiredHackingSkill property + +Hacking level required to hack this server + +Signature: + +```typescript +requiredHackingSkill: number; +``` diff --git a/markdown/bitburner.server.servergrowth.md b/markdown/bitburner.server.servergrowth.md new file mode 100644 index 000000000..549490455 --- /dev/null +++ b/markdown/bitburner.server.servergrowth.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [serverGrowth](./bitburner.server.servergrowth.md) + +## Server.serverGrowth property + +Parameter that affects how effectively this server's money can be increased using the grow() Netscript function + +Signature: + +```typescript +serverGrowth: number; +``` diff --git a/markdown/bitburner.server.smtpportopen.md b/markdown/bitburner.server.smtpportopen.md new file mode 100644 index 000000000..e958832fa --- /dev/null +++ b/markdown/bitburner.server.smtpportopen.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [smtpPortOpen](./bitburner.server.smtpportopen.md) + +## Server.smtpPortOpen property + +Flag indicating whether SMTP Port is open + +Signature: + +```typescript +smtpPortOpen: boolean; +``` diff --git a/markdown/bitburner.server.sqlportopen.md b/markdown/bitburner.server.sqlportopen.md new file mode 100644 index 000000000..1b964977d --- /dev/null +++ b/markdown/bitburner.server.sqlportopen.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [sqlPortOpen](./bitburner.server.sqlportopen.md) + +## Server.sqlPortOpen property + +Flag indicating whether SQL Port is open + +Signature: + +```typescript +sqlPortOpen: boolean; +``` diff --git a/markdown/bitburner.server.sshportopen.md b/markdown/bitburner.server.sshportopen.md new file mode 100644 index 000000000..b1f086ab5 --- /dev/null +++ b/markdown/bitburner.server.sshportopen.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [sshPortOpen](./bitburner.server.sshportopen.md) + +## Server.sshPortOpen property + +Flag indicating whether the SSH Port is open + +Signature: + +```typescript +sshPortOpen: boolean; +``` diff --git a/markdown/bitburner.singularity.applytocompany.md b/markdown/bitburner.singularity.applytocompany.md new file mode 100644 index 000000000..eeeb6b45a --- /dev/null +++ b/markdown/bitburner.singularity.applytocompany.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [applyToCompany](./bitburner.singularity.applytocompany.md) + +## Singularity.applyToCompany() method + +Apply for a job at a company. + +Signature: + +```typescript +applyToCompany(companyName: string, field: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | string | Name of company to apply to. | +| field | string | Field to which you want to apply. | + +Returns: + +boolean + +True if the player successfully get a job/promotion, and false otherwise. + +## Remarks + +RAM cost: 3 GB \* 16/4/1 + +This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at. + +This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false. + diff --git a/markdown/bitburner.singularity.b1tflum3.md b/markdown/bitburner.singularity.b1tflum3.md new file mode 100644 index 000000000..0b3c6b451 --- /dev/null +++ b/markdown/bitburner.singularity.b1tflum3.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [b1tflum3](./bitburner.singularity.b1tflum3.md) + +## Singularity.b1tflum3() method + +b1t\_flum3 into a different BN. + +Signature: + +```typescript +b1tflum3(nextBN: number, callbackScript?: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| nextBN | number | BN number to jump to | +| callbackScript | string | Name of the script to launch in the next BN. | + +Returns: + +void + +## Remarks + +RAM cost: 16 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.checkfactioninvitations.md b/markdown/bitburner.singularity.checkfactioninvitations.md new file mode 100644 index 000000000..6c75e54c7 --- /dev/null +++ b/markdown/bitburner.singularity.checkfactioninvitations.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [checkFactionInvitations](./bitburner.singularity.checkfactioninvitations.md) + +## Singularity.checkFactionInvitations() method + +List all current faction invitations. + +Signature: + +```typescript +checkFactionInvitations(): string[]; +``` +Returns: + +string\[\] + +Array with the name of all Factions you currently have outstanding invitations from. + +## Remarks + +RAM cost: 3 GB \* 16/4/1 + +Returns an array with the name of all Factions you currently have outstanding invitations from. + diff --git a/markdown/bitburner.singularity.commitcrime.md b/markdown/bitburner.singularity.commitcrime.md new file mode 100644 index 000000000..c124998dd --- /dev/null +++ b/markdown/bitburner.singularity.commitcrime.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [commitCrime](./bitburner.singularity.commitcrime.md) + +## Singularity.commitCrime() method + +Commit a crime. + +Signature: + +```typescript +commitCrime(crime: string, focus?: boolean): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| crime | string | Name of crime to attempt. | +| focus | boolean | Acquire player focus on this crime. Optional. Defaults to true. | + +Returns: + +number + +The number of milliseconds it takes to attempt the specified crime. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings. + +This function returns the number of milliseconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running `commitCrime('rob store')` will return 60,000). + +Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit. + diff --git a/markdown/bitburner.singularity.connect.md b/markdown/bitburner.singularity.connect.md new file mode 100644 index 000000000..97fe2ffa0 --- /dev/null +++ b/markdown/bitburner.singularity.connect.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [connect](./bitburner.singularity.connect.md) + +## Singularity.connect() method + +Connect to a server. + +Signature: + +```typescript +connect(hostname: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | | + +Returns: + +boolean + +True if the connect command was successful, false otherwise. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + +Run the connect HOSTNAME command in the terminal. Can only connect to neighbors. + diff --git a/markdown/bitburner.singularity.createprogram.md b/markdown/bitburner.singularity.createprogram.md new file mode 100644 index 000000000..f856dcc9e --- /dev/null +++ b/markdown/bitburner.singularity.createprogram.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [createProgram](./bitburner.singularity.createprogram.md) + +## Singularity.createProgram() method + +Create a program. + +Signature: + +```typescript +createProgram(program: string, focus?: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| program | string | Name of program to create. | +| focus | boolean | Acquire player focus on this program creation. Optional. Defaults to true. | + +Returns: + +boolean + +True if you successfully start working on the specified program, and false otherwise. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings. + +This function returns true if you successfully start working on the specified program, and false otherwise. + +Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: \* BruteSSH.exe: 50 \* FTPCrack.exe: 100 \* relaySMTP.exe: 250 \* HTTPWorm.exe: 500 \* SQLInject.exe: 750 \* DeepscanV1.exe: 75 \* DeepscanV2.exe: 400 \* ServerProfiler.exe: 75 \* AutoLink.exe: 25 + +## Example 1 + + +```ts +// NS1: +createProgram(“relaysmtp.exe”); +``` + +## Example 2 + + +```ts +// NS2: +ns.createProgram(“relaysmtp.exe”); +``` + diff --git a/markdown/bitburner.singularity.destroyw0r1dd43m0n.md b/markdown/bitburner.singularity.destroyw0r1dd43m0n.md new file mode 100644 index 000000000..a0987f783 --- /dev/null +++ b/markdown/bitburner.singularity.destroyw0r1dd43m0n.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [destroyW0r1dD43m0n](./bitburner.singularity.destroyw0r1dd43m0n.md) + +## Singularity.destroyW0r1dD43m0n() method + +Destroy the w0r1d\_d43m0n and move on to the next BN. + +Signature: + +```typescript +destroyW0r1dD43m0n(nextBN: number, callbackScript?: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| nextBN | number | BN number to jump to | +| callbackScript | string | Name of the script to launch in the next BN. | + +Returns: + +void + +## Remarks + +RAM cost: 32 GB \* 16/4/1 + +You must have the special augment installed and the required hacking level OR Completed the final black op. + diff --git a/markdown/bitburner.singularity.donatetofaction.md b/markdown/bitburner.singularity.donatetofaction.md new file mode 100644 index 000000000..1fa0e81b6 --- /dev/null +++ b/markdown/bitburner.singularity.donatetofaction.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [donateToFaction](./bitburner.singularity.donatetofaction.md) + +## Singularity.donateToFaction() method + +Donate to a faction. + +Signature: + +```typescript +donateToFaction(faction: string, amount: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | Name of faction to donate to. | +| amount | number | Amount of money to donate. | + +Returns: + +boolean + +True if the money was donated, and false otherwise. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise. + diff --git a/markdown/bitburner.singularity.exportgame.md b/markdown/bitburner.singularity.exportgame.md new file mode 100644 index 000000000..3f97fe5cb --- /dev/null +++ b/markdown/bitburner.singularity.exportgame.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [exportGame](./bitburner.singularity.exportgame.md) + +## Singularity.exportGame() method + +Backup game save. + +Signature: + +```typescript +exportGame(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 1 GB \* 16/4/1 + +This function will automatically opens the backup save prompt and claim the free faction favour if available. + diff --git a/markdown/bitburner.singularity.exportgamebonus.md b/markdown/bitburner.singularity.exportgamebonus.md new file mode 100644 index 000000000..b439ffa0e --- /dev/null +++ b/markdown/bitburner.singularity.exportgamebonus.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [exportGameBonus](./bitburner.singularity.exportgamebonus.md) + +## Singularity.exportGameBonus() method + +Returns Backup save bonus availability. + +Signature: + +```typescript +exportGameBonus(): boolean; +``` +Returns: + +boolean + +## Remarks + +RAM cost: 0.5 GB \* 16/4/1 + +This function will check if there is a bonus for backing up your save. + diff --git a/markdown/bitburner.singularity.getaugmentationbaseprice.md b/markdown/bitburner.singularity.getaugmentationbaseprice.md new file mode 100644 index 000000000..7a4fcb5df --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationbaseprice.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationBasePrice](./bitburner.singularity.getaugmentationbaseprice.md) + +## Singularity.getAugmentationBasePrice() method + +Get base price of an augmentation. + +Signature: + +```typescript +getAugmentationBasePrice(augName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | string | Name of Augmentation. | + +Returns: + +number + +Base price of the augmentation, before price multiplier. + +## Remarks + +RAM cost: 2.5 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.getaugmentationcost.md b/markdown/bitburner.singularity.getaugmentationcost.md new file mode 100644 index 000000000..af7f3b7fa --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationcost.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationCost](./bitburner.singularity.getaugmentationcost.md) + +## Singularity.getAugmentationCost() method + +> Warning: This API is now obsolete. +> +> use getAugmentationPrice getAugmentationRepCost +> + +Get the price and reputation of an augmentation. + +Signature: + +```typescript +getAugmentationCost(augName: string): [number, number]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | string | Name of Augmentation. | + +Returns: + +\[number, number\] + +Array with first element as a reputation requirement and second element as the money cost. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost. + +If an invalid Augmentation name is passed in for the augName argument, this function will return the array \[-1, -1\]. + diff --git a/markdown/bitburner.singularity.getaugmentationprereq.md b/markdown/bitburner.singularity.getaugmentationprereq.md new file mode 100644 index 000000000..5eea5c996 --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationprereq.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationPrereq](./bitburner.singularity.getaugmentationprereq.md) + +## Singularity.getAugmentationPrereq() method + +Get the pre-requisite of an augmentation. + +Signature: + +```typescript +getAugmentationPrereq(augName: string): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | string | Name of Augmentation. | + +Returns: + +string\[\] + +Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned. + diff --git a/markdown/bitburner.singularity.getaugmentationprice.md b/markdown/bitburner.singularity.getaugmentationprice.md new file mode 100644 index 000000000..d071bd667 --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationprice.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationPrice](./bitburner.singularity.getaugmentationprice.md) + +## Singularity.getAugmentationPrice() method + +Get price of an augmentation. + +Signature: + +```typescript +getAugmentationPrice(augName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | string | Name of Augmentation. | + +Returns: + +number + +Price of the augmentation. + +## Remarks + +RAM cost: 2.5 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.getaugmentationrepreq.md b/markdown/bitburner.singularity.getaugmentationrepreq.md new file mode 100644 index 000000000..4813a92dc --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationrepreq.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationRepReq](./bitburner.singularity.getaugmentationrepreq.md) + +## Singularity.getAugmentationRepReq() method + +Get reputation requirement of an augmentation. + +Signature: + +```typescript +getAugmentationRepReq(augName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | string | Name of Augmentation. | + +Returns: + +number + +Reputation requirement of the augmentation. + +## Remarks + +RAM cost: 2.5 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.getaugmentationsfromfaction.md b/markdown/bitburner.singularity.getaugmentationsfromfaction.md new file mode 100644 index 000000000..d12b08943 --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationsfromfaction.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationsFromFaction](./bitburner.singularity.getaugmentationsfromfaction.md) + +## Singularity.getAugmentationsFromFaction() method + +Get a list of augmentation available from a faction. + +Signature: + +```typescript +getAugmentationsFromFaction(faction: string): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | Name of faction. | + +Returns: + +string\[\] + +Array containing the names of all Augmentations. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction. + diff --git a/markdown/bitburner.singularity.getaugmentationstats.md b/markdown/bitburner.singularity.getaugmentationstats.md new file mode 100644 index 000000000..12056f334 --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationstats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationStats](./bitburner.singularity.getaugmentationstats.md) + +## Singularity.getAugmentationStats() method + +Get the stats of an augmentation. + +Signature: + +```typescript +getAugmentationStats(name: string): Multipliers; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Name of Augmentation. CASE-SENSITIVE. | + +Returns: + +[Multipliers](./bitburner.multipliers.md) + +Augmentation stats. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function returns augmentation stats. + diff --git a/markdown/bitburner.singularity.getcompanyfavor.md b/markdown/bitburner.singularity.getcompanyfavor.md new file mode 100644 index 000000000..5d43bce39 --- /dev/null +++ b/markdown/bitburner.singularity.getcompanyfavor.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCompanyFavor](./bitburner.singularity.getcompanyfavor.md) + +## Singularity.getCompanyFavor() method + +Get company favor. + +Signature: + +```typescript +getCompanyFavor(companyName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | string | Name of the company. | + +Returns: + +number + +Amount of favor you have at the specified company. + +## Remarks + +RAM cost: 1 GB \* 16/4/1 + +This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. + diff --git a/markdown/bitburner.singularity.getcompanyfavorgain.md b/markdown/bitburner.singularity.getcompanyfavorgain.md new file mode 100644 index 000000000..84582a29a --- /dev/null +++ b/markdown/bitburner.singularity.getcompanyfavorgain.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCompanyFavorGain](./bitburner.singularity.getcompanyfavorgain.md) + +## Singularity.getCompanyFavorGain() method + +Get company favor gain. + +Signature: + +```typescript +getCompanyFavorGain(companyName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | string | Name of the company. | + +Returns: + +number + +Amount of favor you gain at the specified company when you reset by installing Augmentations. + +## Remarks + +RAM cost: 0.75 GB \* 16/4/1 + +This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations. + diff --git a/markdown/bitburner.singularity.getcompanyrep.md b/markdown/bitburner.singularity.getcompanyrep.md new file mode 100644 index 000000000..d0e0755ce --- /dev/null +++ b/markdown/bitburner.singularity.getcompanyrep.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCompanyRep](./bitburner.singularity.getcompanyrep.md) + +## Singularity.getCompanyRep() method + +Get company reputation. + +Signature: + +```typescript +getCompanyRep(companyName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | string | Name of the company. | + +Returns: + +number + +Amount of reputation you have at the specified company. + +## Remarks + +RAM cost: 1 GB \* 16/4/1 + +This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. + diff --git a/markdown/bitburner.singularity.getcrimechance.md b/markdown/bitburner.singularity.getcrimechance.md new file mode 100644 index 000000000..22e65a839 --- /dev/null +++ b/markdown/bitburner.singularity.getcrimechance.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCrimeChance](./bitburner.singularity.getcrimechance.md) + +## Singularity.getCrimeChance() method + +Get chance to successfully commit a crime. + +Signature: + +```typescript +getCrimeChance(crime: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| crime | string | Name of crime. | + +Returns: + +number + +Chance of success at committing the specified crime. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function returns your chance of success at committing the specified crime. + diff --git a/markdown/bitburner.singularity.getcrimestats.md b/markdown/bitburner.singularity.getcrimestats.md new file mode 100644 index 000000000..01ace9598 --- /dev/null +++ b/markdown/bitburner.singularity.getcrimestats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCrimeStats](./bitburner.singularity.getcrimestats.md) + +## Singularity.getCrimeStats() method + +Get stats related to a crime. + +Signature: + +```typescript +getCrimeStats(crime: string): CrimeStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| crime | string | Name of crime. Not case-sensitive | + +Returns: + +[CrimeStats](./bitburner.crimestats.md) + +The stats of the crime. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +Returns the stats of the crime. + diff --git a/markdown/bitburner.singularity.getcurrentserver.md b/markdown/bitburner.singularity.getcurrentserver.md new file mode 100644 index 000000000..32aab3285 --- /dev/null +++ b/markdown/bitburner.singularity.getcurrentserver.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCurrentServer](./bitburner.singularity.getcurrentserver.md) + +## Singularity.getCurrentServer() method + +Get the current server. + +Signature: + +```typescript +getCurrentServer(): string; +``` +Returns: + +string + +Name of the current server. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.getcurrentwork.md b/markdown/bitburner.singularity.getcurrentwork.md new file mode 100644 index 000000000..3bdd61d08 --- /dev/null +++ b/markdown/bitburner.singularity.getcurrentwork.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCurrentWork](./bitburner.singularity.getcurrentwork.md) + +## Singularity.getCurrentWork() method + +Get the current work the player is doing. + +Signature: + +```typescript +getCurrentWork(): any | null; +``` +Returns: + +any \| null + +- An object representing the current work. Fields depend on the kind of work. + +## Remarks + +RAM cost: 0.5 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.getdarkwebprogramcost.md b/markdown/bitburner.singularity.getdarkwebprogramcost.md new file mode 100644 index 000000000..fb32cae82 --- /dev/null +++ b/markdown/bitburner.singularity.getdarkwebprogramcost.md @@ -0,0 +1,50 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getDarkwebProgramCost](./bitburner.singularity.getdarkwebprogramcost.md) + +## Singularity.getDarkwebProgramCost() method + +Check the price of an exploit on the dark web + +Signature: + +```typescript +getDarkwebProgramCost(programName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| programName | string | Name of program to check the price of | + +Returns: + +number + +Price of the specified darkweb program (if not yet purchased), 0 if it has already been purchased, or -1 if Tor has not been purchased. Throws an error if the specified program/exploit does not exist + +## Remarks + +RAM cost: 0.5 GB \* 16/4/1 + +This function allows you to check the price of a darkweb exploit/program. You MUST have a TOR router in order to use this function. The price returned by this function is the same price you would see with buy -l from the terminal. Returns the cost of the program if it has not been purchased yet, 0 if it has already been purchased, or -1 if Tor has not been purchased (and thus the program/exploit is not available for purchase). + +If the program does not exist, an error is thrown. + +## Example 1 + + +```ts +// NS1 +getDarkwebProgramCost("brutessh.exe"); +``` + +## Example 2 + + +```ts +// NS2 +ns.getDarkwebProgramCost("brutessh.exe"); +``` + diff --git a/markdown/bitburner.singularity.getdarkwebprograms.md b/markdown/bitburner.singularity.getdarkwebprograms.md new file mode 100644 index 000000000..3887dcfd9 --- /dev/null +++ b/markdown/bitburner.singularity.getdarkwebprograms.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getDarkwebPrograms](./bitburner.singularity.getdarkwebprograms.md) + +## Singularity.getDarkwebPrograms() method + +Get a list of programs offered on the dark web. + +Signature: + +```typescript +getDarkwebPrograms(): string[]; +``` +Returns: + +string\[\] + +- a list of programs available for purchase on the dark web, or \[\] if Tor has not been purchased + +## Remarks + +RAM cost: 1 GB \* 16/4/1 + +This function allows the player to get a list of programs available for purchase on the dark web. Players MUST have purchased Tor to get the list of programs available. If Tor has not been purchased yet, this function will return an empty list. + +## Example 1 + + +```ts +// NS1 +getDarkwebPrograms(); +// returns ['BruteSSH.exe', 'FTPCrack.exe'...etc] +``` + +## Example 2 + + +```ts +// NS2 +ns.getDarkwebPrograms(); +// returns ['BruteSSH.exe', 'FTPCrack.exe'...etc] +``` + diff --git a/markdown/bitburner.singularity.getfactionfavor.md b/markdown/bitburner.singularity.getfactionfavor.md new file mode 100644 index 000000000..abdfc46f7 --- /dev/null +++ b/markdown/bitburner.singularity.getfactionfavor.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getFactionFavor](./bitburner.singularity.getfactionfavor.md) + +## Singularity.getFactionFavor() method + +Get faction favor. + +Signature: + +```typescript +getFactionFavor(faction: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | Name of faction. | + +Returns: + +number + +Amount of favor you have for the specified faction. + +## Remarks + +RAM cost: 1 GB \* 16/4/1 + +This function returns the amount of favor you have for the specified faction. + diff --git a/markdown/bitburner.singularity.getfactionfavorgain.md b/markdown/bitburner.singularity.getfactionfavorgain.md new file mode 100644 index 000000000..ca8d8b384 --- /dev/null +++ b/markdown/bitburner.singularity.getfactionfavorgain.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getFactionFavorGain](./bitburner.singularity.getfactionfavorgain.md) + +## Singularity.getFactionFavorGain() method + +Get faction favor gain. + +Signature: + +```typescript +getFactionFavorGain(faction: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | Name of faction. | + +Returns: + +number + +Amount of favor you will gain for the specified faction when you reset by installing Augmentations. + +## Remarks + +RAM cost: 0.75 GB \* 16/4/1 + +This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations. + diff --git a/markdown/bitburner.singularity.getfactionrep.md b/markdown/bitburner.singularity.getfactionrep.md new file mode 100644 index 000000000..5c2f0b661 --- /dev/null +++ b/markdown/bitburner.singularity.getfactionrep.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getFactionRep](./bitburner.singularity.getfactionrep.md) + +## Singularity.getFactionRep() method + +Get faction reputation. + +Signature: + +```typescript +getFactionRep(faction: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | Name of faction to work for. | + +Returns: + +number + +Amount of reputation you have for the specified faction. + +## Remarks + +RAM cost: 1 GB \* 16/4/1 + +This function returns the amount of reputation you have for the specified faction. + diff --git a/markdown/bitburner.singularity.getownedaugmentations.md b/markdown/bitburner.singularity.getownedaugmentations.md new file mode 100644 index 000000000..34cd7f36f --- /dev/null +++ b/markdown/bitburner.singularity.getownedaugmentations.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getOwnedAugmentations](./bitburner.singularity.getownedaugmentations.md) + +## Singularity.getOwnedAugmentations() method + +Get a list of owned augmentation. + +Signature: + +```typescript +getOwnedAugmentations(purchased?: boolean): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| purchased | boolean | 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: + +string\[\] + +Array containing the names (as strings) of all Augmentations you have. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function returns an array containing the names (as strings) of all Augmentations you have. + diff --git a/markdown/bitburner.singularity.getownedsourcefiles.md b/markdown/bitburner.singularity.getownedsourcefiles.md new file mode 100644 index 000000000..de472bff2 --- /dev/null +++ b/markdown/bitburner.singularity.getownedsourcefiles.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getOwnedSourceFiles](./bitburner.singularity.getownedsourcefiles.md) + +## Singularity.getOwnedSourceFiles() method + +Get a list of acquired Source-Files. + +Signature: + +```typescript +getOwnedSourceFiles(): SourceFileLvl[]; +``` +Returns: + +[SourceFileLvl](./bitburner.sourcefilelvl.md)\[\] + +Array containing an object with number and level of the source file. + +## Remarks + +RAM cost: 5 GB + +Returns an array of source files + diff --git a/markdown/bitburner.singularity.getupgradehomecorescost.md b/markdown/bitburner.singularity.getupgradehomecorescost.md new file mode 100644 index 000000000..1c1ee5944 --- /dev/null +++ b/markdown/bitburner.singularity.getupgradehomecorescost.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getUpgradeHomeCoresCost](./bitburner.singularity.getupgradehomecorescost.md) + +## Singularity.getUpgradeHomeCoresCost() method + +Get the price of upgrading home cores. + +Signature: + +```typescript +getUpgradeHomeCoresCost(): number; +``` +Returns: + +number + +Cost of upgrading the player’s home computer cores. + +## Remarks + +RAM cost: 1.5 GB \* 16/4/1 + +Returns the cost of upgrading the player’s home computer cores. + diff --git a/markdown/bitburner.singularity.getupgradehomeramcost.md b/markdown/bitburner.singularity.getupgradehomeramcost.md new file mode 100644 index 000000000..5e250742f --- /dev/null +++ b/markdown/bitburner.singularity.getupgradehomeramcost.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getUpgradeHomeRamCost](./bitburner.singularity.getupgradehomeramcost.md) + +## Singularity.getUpgradeHomeRamCost() method + +Get the price of upgrading home RAM. + +Signature: + +```typescript +getUpgradeHomeRamCost(): number; +``` +Returns: + +number + +Cost of upgrading the player’s home computer RAM. + +## Remarks + +RAM cost: 1.5 GB \* 16/4/1 + +Returns the cost of upgrading the player’s home computer RAM. + diff --git a/markdown/bitburner.singularity.gotolocation.md b/markdown/bitburner.singularity.gotolocation.md new file mode 100644 index 000000000..6f40592e4 --- /dev/null +++ b/markdown/bitburner.singularity.gotolocation.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [goToLocation](./bitburner.singularity.gotolocation.md) + +## Singularity.goToLocation() method + +Go to a location. + +Signature: + +```typescript +goToLocation(locationName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| locationName | string | Name of the location. | + +Returns: + +boolean + +True if the player was moved there, false otherwise. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +Move the player to a specific location. + diff --git a/markdown/bitburner.singularity.gymworkout.md b/markdown/bitburner.singularity.gymworkout.md new file mode 100644 index 000000000..7b57d4736 --- /dev/null +++ b/markdown/bitburner.singularity.gymworkout.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [gymWorkout](./bitburner.singularity.gymworkout.md) + +## Singularity.gymWorkout() method + +Workout at the gym. + +Signature: + +```typescript +gymWorkout(gymName: string, stat: string, focus?: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| gymName | string | Name of gym. You must be in the correct city for whatever gym you specify. | +| stat | string | The stat you want to train. | +| focus | boolean | Acquire player focus on this gym workout. Optional. Defaults to true. | + +Returns: + +boolean + +True if actions is successfully started, false otherwise. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + +This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings. + +The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train + diff --git a/markdown/bitburner.singularity.hospitalize.md b/markdown/bitburner.singularity.hospitalize.md new file mode 100644 index 000000000..16f491c4b --- /dev/null +++ b/markdown/bitburner.singularity.hospitalize.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [hospitalize](./bitburner.singularity.hospitalize.md) + +## Singularity.hospitalize() method + +Hospitalize the player. + +Signature: + +```typescript +hospitalize(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 0.25 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.installaugmentations.md b/markdown/bitburner.singularity.installaugmentations.md new file mode 100644 index 000000000..d6cc103b9 --- /dev/null +++ b/markdown/bitburner.singularity.installaugmentations.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [installAugmentations](./bitburner.singularity.installaugmentations.md) + +## Singularity.installAugmentations() method + +Install your purchased augmentations. + +Signature: + +```typescript +installAugmentations(cbScript?: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| cbScript | string | 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: + +void + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function will automatically install your Augmentations, resetting the game as usual. If you do not own uninstalled Augmentations then the game will not reset. + diff --git a/markdown/bitburner.singularity.installbackdoor.md b/markdown/bitburner.singularity.installbackdoor.md new file mode 100644 index 000000000..3d85dac5c --- /dev/null +++ b/markdown/bitburner.singularity.installbackdoor.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [installBackdoor](./bitburner.singularity.installbackdoor.md) + +## Singularity.installBackdoor() method + +Run the backdoor command in the terminal. + +Signature: + +```typescript +installBackdoor(): Promise; +``` +Returns: + +Promise<void> + +Promise waiting for the installation to finish. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.isbusy.md b/markdown/bitburner.singularity.isbusy.md new file mode 100644 index 000000000..5c0e5725b --- /dev/null +++ b/markdown/bitburner.singularity.isbusy.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [isBusy](./bitburner.singularity.isbusy.md) + +## Singularity.isBusy() method + +Check if the player is busy. + +Signature: + +```typescript +isBusy(): boolean; +``` +Returns: + +boolean + +True if the player is currently performing an ‘action’, false otherwise. + +## Remarks + +RAM cost: 0.5 GB \* 16/4/1 + +Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a university, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. + diff --git a/markdown/bitburner.singularity.isfocused.md b/markdown/bitburner.singularity.isfocused.md new file mode 100644 index 000000000..4f65c51ce --- /dev/null +++ b/markdown/bitburner.singularity.isfocused.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [isFocused](./bitburner.singularity.isfocused.md) + +## Singularity.isFocused() method + +Check if the player is focused. + +Signature: + +```typescript +isFocused(): boolean; +``` +Returns: + +boolean + +True if the player is focused. + +## Remarks + +RAM cost: 0.1 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.joinfaction.md b/markdown/bitburner.singularity.joinfaction.md new file mode 100644 index 000000000..4fe141f51 --- /dev/null +++ b/markdown/bitburner.singularity.joinfaction.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [joinFaction](./bitburner.singularity.joinfaction.md) + +## Singularity.joinFaction() method + +Join a faction. + +Signature: + +```typescript +joinFaction(faction: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | Name of faction to join. | + +Returns: + +boolean + +True if player joined the faction, and false otherwise. + +## Remarks + +RAM cost: 3 GB \* 16/4/1 + +This function will automatically accept an invitation from a faction and join it. + diff --git a/markdown/bitburner.singularity.manualhack.md b/markdown/bitburner.singularity.manualhack.md new file mode 100644 index 000000000..f36865fac --- /dev/null +++ b/markdown/bitburner.singularity.manualhack.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [manualHack](./bitburner.singularity.manualhack.md) + +## Singularity.manualHack() method + +Run the hack command in the terminal. + +Signature: + +```typescript +manualHack(): Promise; +``` +Returns: + +Promise<number> + +Amount of money stolen by manual hacking. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md new file mode 100644 index 000000000..870364d09 --- /dev/null +++ b/markdown/bitburner.singularity.md @@ -0,0 +1,78 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) + +## Singularity interface + +Singularity API + +Signature: + +```typescript +export interface Singularity +``` + +## Remarks + +This API requires Source-File 4 to use. The RAM cost of all these functions is multiplied by 16/4/1 based on Source-File 4 levels. + +## Methods + +| Method | Description | +| --- | --- | +| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. | +| [b1tflum3(nextBN, callbackScript)](./bitburner.singularity.b1tflum3.md) | b1t\_flum3 into a different BN. | +| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | List all current faction invitations. | +| [commitCrime(crime, focus)](./bitburner.singularity.commitcrime.md) | Commit a crime. | +| [connect(hostname)](./bitburner.singularity.connect.md) | Connect to a server. | +| [createProgram(program, focus)](./bitburner.singularity.createprogram.md) | Create a program. | +| [destroyW0r1dD43m0n(nextBN, callbackScript)](./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. | +| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | Get the price and reputation of an 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. | +| [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()](./bitburner.singularity.getcurrentserver.md) | Get the current server. | +| [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. | +| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | Get faction favor. | +| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | Get faction favor gain. | +| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | Get faction reputation. | +| [getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) | Get a list of owned augmentation. | +| [getOwnedSourceFiles()](./bitburner.singularity.getownedsourcefiles.md) | Get a list of acquired Source-Files. | +| [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 new file mode 100644 index 000000000..b7d8645a4 --- /dev/null +++ b/markdown/bitburner.singularity.purchaseaugmentation.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [purchaseAugmentation](./bitburner.singularity.purchaseaugmentation.md) + +## Singularity.purchaseAugmentation() method + +Purchase an augmentation + +Signature: + +```typescript +purchaseAugmentation(faction: string, augmentation: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | Name of faction to purchase Augmentation from. | +| augmentation | string | Name of Augmentation to purchase. | + +Returns: + +boolean + +True if the Augmentation is successfully purchased, and false otherwise. + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function will try to purchase the specified Augmentation through the given Faction. + +This function will return true if the Augmentation is successfully purchased, and false otherwise. + diff --git a/markdown/bitburner.singularity.purchaseprogram.md b/markdown/bitburner.singularity.purchaseprogram.md new file mode 100644 index 000000000..3f1e7c4a0 --- /dev/null +++ b/markdown/bitburner.singularity.purchaseprogram.md @@ -0,0 +1,48 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [purchaseProgram](./bitburner.singularity.purchaseprogram.md) + +## Singularity.purchaseProgram() method + +Purchase a program from the dark web. + +Signature: + +```typescript +purchaseProgram(programName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| programName | string | Name of program to purchase. | + +Returns: + +boolean + +True if the specified program is purchased, and false otherwise. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + +This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command. + +## Example 1 + + +```ts +// NS1 +purchaseProgram("brutessh.exe"); +``` + +## Example 2 + + +```ts +// NS2 +ns.purchaseProgram("brutessh.exe"); +``` + diff --git a/markdown/bitburner.singularity.purchasetor.md b/markdown/bitburner.singularity.purchasetor.md new file mode 100644 index 000000000..5989ae07d --- /dev/null +++ b/markdown/bitburner.singularity.purchasetor.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [purchaseTor](./bitburner.singularity.purchasetor.md) + +## Singularity.purchaseTor() method + +Purchase the TOR router. + +Signature: + +```typescript +purchaseTor(): boolean; +``` +Returns: + +boolean + +True if actions is successful or you already own TOR router, false otherwise. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + +This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one. + diff --git a/markdown/bitburner.singularity.quitjob.md b/markdown/bitburner.singularity.quitjob.md new file mode 100644 index 000000000..08ae0b937 --- /dev/null +++ b/markdown/bitburner.singularity.quitjob.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [quitJob](./bitburner.singularity.quitjob.md) + +## Singularity.quitJob() method + +Quit jobs by company. + +Signature: + +```typescript +quitJob(companyName?: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | string | Name of the company. | + +Returns: + +void + +## Remarks + +RAM cost: 3 GB \* 16/4/1 + +This function will finish work with the company provided and quit any jobs. + diff --git a/markdown/bitburner.singularity.setfocus.md b/markdown/bitburner.singularity.setfocus.md new file mode 100644 index 000000000..febb40905 --- /dev/null +++ b/markdown/bitburner.singularity.setfocus.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [setFocus](./bitburner.singularity.setfocus.md) + +## Singularity.setFocus() method + +Set the players focus. + +Signature: + +```typescript +setFocus(focus: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| focus | boolean | | + +Returns: + +boolean + +True if the focus was changed. + +## Remarks + +RAM cost: 0.1 GB \* 16/4/1 + diff --git a/markdown/bitburner.singularity.softreset.md b/markdown/bitburner.singularity.softreset.md new file mode 100644 index 000000000..f55ac6dc9 --- /dev/null +++ b/markdown/bitburner.singularity.softreset.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [softReset](./bitburner.singularity.softreset.md) + +## Singularity.softReset() method + +Soft reset the game. + +Signature: + +```typescript +softReset(cbScript: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| cbScript | string | 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: + +void + +## Remarks + +RAM cost: 5 GB \* 16/4/1 + +This function will perform a reset even if you don’t have any augmentation installed. + diff --git a/markdown/bitburner.singularity.stopaction.md b/markdown/bitburner.singularity.stopaction.md new file mode 100644 index 000000000..b5331446e --- /dev/null +++ b/markdown/bitburner.singularity.stopaction.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [stopAction](./bitburner.singularity.stopaction.md) + +## Singularity.stopAction() method + +Stop the current action. + +Signature: + +```typescript +stopAction(): boolean; +``` +Returns: + +boolean + +True if the player’s action was ended, false if the player was not performing an action. + +## Remarks + +RAM cost: 1 GB \* 16/4/1 + +This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action. + +The actions that can be stopped with this function are: + +\* Studying at a university \* Working out at a gym \* Working for a company/faction \* Creating a program \* Committing a crime + +This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called. + diff --git a/markdown/bitburner.singularity.traveltocity.md b/markdown/bitburner.singularity.traveltocity.md new file mode 100644 index 000000000..89a5faa9c --- /dev/null +++ b/markdown/bitburner.singularity.traveltocity.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [travelToCity](./bitburner.singularity.traveltocity.md) + +## Singularity.travelToCity() method + +Travel to another city. + +Signature: + +```typescript +travelToCity(city: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| city | string | City to travel to. | + +Returns: + +boolean + +True if action is successful, false otherwise. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + +This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency. + diff --git a/markdown/bitburner.singularity.universitycourse.md b/markdown/bitburner.singularity.universitycourse.md new file mode 100644 index 000000000..fcf4bc8e7 --- /dev/null +++ b/markdown/bitburner.singularity.universitycourse.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [universityCourse](./bitburner.singularity.universitycourse.md) + +## Singularity.universityCourse() method + +Take university class. + +Signature: + +```typescript +universityCourse(universityName: string, courseName: string, focus?: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| universityName | string | Name of university. You must be in the correct city for whatever university you specify. | +| courseName | string | Name of course. | +| focus | boolean | Acquire player focus on this class. Optional. Defaults to true. | + +Returns: + +boolean + +True if action is successfully started, false otherwise. + +## Remarks + +RAM cost: 2 GB \* 16/4/1 + +This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings. + +The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes. + diff --git a/markdown/bitburner.singularity.upgradehomecores.md b/markdown/bitburner.singularity.upgradehomecores.md new file mode 100644 index 000000000..4351e56b5 --- /dev/null +++ b/markdown/bitburner.singularity.upgradehomecores.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [upgradeHomeCores](./bitburner.singularity.upgradehomecores.md) + +## Singularity.upgradeHomeCores() method + +Upgrade home computer cores. + +Signature: + +```typescript +upgradeHomeCores(): boolean; +``` +Returns: + +boolean + +True if the player’s home computer cores is successfully upgraded, and false otherwise. + +## Remarks + +RAM cost: 3 GB \* 16/4/1 + +This function will upgrade amount of cores on the player’s home computer. The cost is the same as if you were to do it manually. + +This function will return true if the player’s home computer cores is successfully upgraded, and false otherwise. + diff --git a/markdown/bitburner.singularity.upgradehomeram.md b/markdown/bitburner.singularity.upgradehomeram.md new file mode 100644 index 000000000..f8f0e700d --- /dev/null +++ b/markdown/bitburner.singularity.upgradehomeram.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [upgradeHomeRam](./bitburner.singularity.upgradehomeram.md) + +## Singularity.upgradeHomeRam() method + +Upgrade home computer RAM. + +Signature: + +```typescript +upgradeHomeRam(): boolean; +``` +Returns: + +boolean + +True if the player’s home computer RAM is successfully upgraded, and false otherwise. + +## Remarks + +RAM cost: 3 GB \* 16/4/1 + +This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually. + +This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. + diff --git a/markdown/bitburner.singularity.workforcompany.md b/markdown/bitburner.singularity.workforcompany.md new file mode 100644 index 000000000..59d4338a0 --- /dev/null +++ b/markdown/bitburner.singularity.workforcompany.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [workForCompany](./bitburner.singularity.workforcompany.md) + +## Singularity.workForCompany() method + +Work for a company. + +Signature: + +```typescript +workForCompany(companyName: string, focus?: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | string | Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked | +| focus | boolean | Acquire player focus on this work operation. Optional. Defaults to true. | + +Returns: + +boolean + +True if the player starts working, and false otherwise. + +## Remarks + +RAM cost: 3 GB \* 16/4/1 + +This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings. + +This function will return true if the player starts working, and false otherwise. + +Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action. + +## Example 1 + + +```ts +// NS1: +//If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings: +while (getCompanyRep(COMPANY HERE) < VALUE) { + workForCompany(); + sleep(60000); +} +//This way, your company reputation will be updated every minute. +``` + +## Example 2 + + +```ts +// NS2: +//If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings: +while (ns.getCompanyRep(COMPANY HERE) < VALUE) { + ns.workForCompany(); + await ns.sleep(60000); +} +//This way, your company reputation will be updated every minute. +``` + diff --git a/markdown/bitburner.singularity.workforfaction.md b/markdown/bitburner.singularity.workforfaction.md new file mode 100644 index 000000000..c4b76d094 --- /dev/null +++ b/markdown/bitburner.singularity.workforfaction.md @@ -0,0 +1,64 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [workForFaction](./bitburner.singularity.workforfaction.md) + +## Singularity.workForFaction() method + +Work for a faction. + +Signature: + +```typescript +workForFaction(faction: string, workType: string, focus?: boolean): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | string | Name of faction to work for. | +| workType | string | Type of work to perform for the faction. | +| focus | boolean | Acquire player focus on this work operation. Optional. Defaults to true. | + +Returns: + +boolean + +True if the player starts working, and false otherwise. + +## Remarks + +RAM cost: 3 GB \* 16/4/1 + +This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings. + +This function will return true if you successfully start working for the specified faction, and false otherwise. + +Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action. + +## Example 1 + + +```ts +// NS1: +//If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings: +while (getFactionRep(FACTION NAME) < VALUE) { + workForFaction(FACNAME, WORKTYPE); + sleep(60000); +} +//This way, your faction reputation will be updated every minute. +``` + +## Example 2 + + +```ts +// NS2: +//If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings: +while (ns.getFactionRep(FACTION NAME) < VALUE) { + ns.workForFaction(FACNAME, WORKTYPE); + await ns.sleep(60000); +} +//This way, your faction reputation will be updated every minute. +``` + diff --git a/markdown/bitburner.skills.agility.md b/markdown/bitburner.skills.agility.md new file mode 100644 index 000000000..fd430d5ee --- /dev/null +++ b/markdown/bitburner.skills.agility.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Skills](./bitburner.skills.md) > [agility](./bitburner.skills.agility.md) + +## Skills.agility property + +Signature: + +```typescript +agility: number; +``` diff --git a/markdown/bitburner.skills.charisma.md b/markdown/bitburner.skills.charisma.md new file mode 100644 index 000000000..060c46db2 --- /dev/null +++ b/markdown/bitburner.skills.charisma.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Skills](./bitburner.skills.md) > [charisma](./bitburner.skills.charisma.md) + +## Skills.charisma property + +Signature: + +```typescript +charisma: number; +``` diff --git a/markdown/bitburner.skills.defense.md b/markdown/bitburner.skills.defense.md new file mode 100644 index 000000000..1a0be1730 --- /dev/null +++ b/markdown/bitburner.skills.defense.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Skills](./bitburner.skills.md) > [defense](./bitburner.skills.defense.md) + +## Skills.defense property + +Signature: + +```typescript +defense: number; +``` diff --git a/markdown/bitburner.skills.dexterity.md b/markdown/bitburner.skills.dexterity.md new file mode 100644 index 000000000..80aca09ad --- /dev/null +++ b/markdown/bitburner.skills.dexterity.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Skills](./bitburner.skills.md) > [dexterity](./bitburner.skills.dexterity.md) + +## Skills.dexterity property + +Signature: + +```typescript +dexterity: number; +``` diff --git a/markdown/bitburner.skills.hacking.md b/markdown/bitburner.skills.hacking.md new file mode 100644 index 000000000..97b169f6e --- /dev/null +++ b/markdown/bitburner.skills.hacking.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Skills](./bitburner.skills.md) > [hacking](./bitburner.skills.hacking.md) + +## Skills.hacking property + +Signature: + +```typescript +hacking: number; +``` diff --git a/markdown/bitburner.skills.intelligence.md b/markdown/bitburner.skills.intelligence.md new file mode 100644 index 000000000..c64a3ebca --- /dev/null +++ b/markdown/bitburner.skills.intelligence.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Skills](./bitburner.skills.md) > [intelligence](./bitburner.skills.intelligence.md) + +## Skills.intelligence property + +Signature: + +```typescript +intelligence: number; +``` diff --git a/markdown/bitburner.skills.md b/markdown/bitburner.skills.md new file mode 100644 index 000000000..43e40ec10 --- /dev/null +++ b/markdown/bitburner.skills.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Skills](./bitburner.skills.md) + +## Skills interface + + +Signature: + +```typescript +export interface Skills +``` + +## Properties + +| Property | 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.skills.strength.md b/markdown/bitburner.skills.strength.md new file mode 100644 index 000000000..67cda549f --- /dev/null +++ b/markdown/bitburner.skills.strength.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Skills](./bitburner.skills.md) > [strength](./bitburner.skills.strength.md) + +## Skills.strength property + +Signature: + +```typescript +strength: number; +``` diff --git a/markdown/bitburner.skillsformulas.calculateexp.md b/markdown/bitburner.skillsformulas.calculateexp.md new file mode 100644 index 000000000..bf4dd7027 --- /dev/null +++ b/markdown/bitburner.skillsformulas.calculateexp.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SkillsFormulas](./bitburner.skillsformulas.md) > [calculateExp](./bitburner.skillsformulas.calculateexp.md) + +## SkillsFormulas.calculateExp() method + +Calculate exp for skill level. + +Signature: + +```typescript +calculateExp(skill: number, skillMult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| skill | number | target skill level | +| skillMult | number | Multiplier for that skill, defaults to 1. | + +Returns: + +number + +The calculated exp required. + diff --git a/markdown/bitburner.skillsformulas.calculateskill.md b/markdown/bitburner.skillsformulas.calculateskill.md new file mode 100644 index 000000000..09a1609d2 --- /dev/null +++ b/markdown/bitburner.skillsformulas.calculateskill.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SkillsFormulas](./bitburner.skillsformulas.md) > [calculateSkill](./bitburner.skillsformulas.calculateskill.md) + +## SkillsFormulas.calculateSkill() method + +Calculate skill level. + +Signature: + +```typescript +calculateSkill(exp: number, skillMult?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| exp | number | experience for that skill | +| skillMult | number | Multiplier for that skill, defaults to 1. | + +Returns: + +number + +The calculated skill level. + diff --git a/markdown/bitburner.skillsformulas.md b/markdown/bitburner.skillsformulas.md new file mode 100644 index 000000000..223495210 --- /dev/null +++ b/markdown/bitburner.skillsformulas.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SkillsFormulas](./bitburner.skillsformulas.md) + +## SkillsFormulas interface + +Skills formulas + +Signature: + +```typescript +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. | + diff --git a/markdown/bitburner.sleeve.getinformation.md b/markdown/bitburner.sleeve.getinformation.md new file mode 100644 index 000000000..d36a20f73 --- /dev/null +++ b/markdown/bitburner.sleeve.getinformation.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getInformation](./bitburner.sleeve.getinformation.md) + +## Sleeve.getInformation() method + +Get information about a sleeve. + +Signature: + +```typescript +getInformation(sleeveNumber: number): SleeveInformation; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to retrieve information. | + +Returns: + +[SleeveInformation](./bitburner.sleeveinformation.md) + +Object containing tons of information about this sleeve. + +## Remarks + +RAM cost: 4 GB + +Return a struct containing tons of information about this sleeve + diff --git a/markdown/bitburner.sleeve.getnumsleeves.md b/markdown/bitburner.sleeve.getnumsleeves.md new file mode 100644 index 000000000..e456fed41 --- /dev/null +++ b/markdown/bitburner.sleeve.getnumsleeves.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getNumSleeves](./bitburner.sleeve.getnumsleeves.md) + +## Sleeve.getNumSleeves() method + +Get the number of sleeves you own. + +Signature: + +```typescript +getNumSleeves(): number; +``` +Returns: + +number + +number of duplicate sleeves the player has. + +## Remarks + +RAM cost: 4 GB + +Return the number of duplicate sleeves the player has. + diff --git a/markdown/bitburner.sleeve.getsleeveaugmentationprice.md b/markdown/bitburner.sleeve.getsleeveaugmentationprice.md new file mode 100644 index 000000000..387a4ee49 --- /dev/null +++ b/markdown/bitburner.sleeve.getsleeveaugmentationprice.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveAugmentationPrice](./bitburner.sleeve.getsleeveaugmentationprice.md) + +## Sleeve.getSleeveAugmentationPrice() method + +Get price of an augmentation. + +Signature: + +```typescript +getSleeveAugmentationPrice(augName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | string | Name of Augmentation. | + +Returns: + +number + +Price of the augmentation. + +## Remarks + +RAM cost: 4 GB + diff --git a/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md b/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md new file mode 100644 index 000000000..9fd86d7b6 --- /dev/null +++ b/markdown/bitburner.sleeve.getsleeveaugmentationrepreq.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveAugmentationRepReq](./bitburner.sleeve.getsleeveaugmentationrepreq.md) + +## Sleeve.getSleeveAugmentationRepReq() method + +Get reputation requirement of an augmentation. + +Signature: + +```typescript +getSleeveAugmentationRepReq(augName: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | string | Name of Augmentation. | + +Returns: + +number + +Reputation requirement of the augmentation. + +## Remarks + +RAM cost: 4 GB + diff --git a/markdown/bitburner.sleeve.getsleeveaugmentations.md b/markdown/bitburner.sleeve.getsleeveaugmentations.md new file mode 100644 index 000000000..d3835eac0 --- /dev/null +++ b/markdown/bitburner.sleeve.getsleeveaugmentations.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveAugmentations](./bitburner.sleeve.getsleeveaugmentations.md) + +## Sleeve.getSleeveAugmentations() method + +Get augmentations installed on a sleeve. + +Signature: + +```typescript +getSleeveAugmentations(sleeveNumber: number): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to retrieve augmentations from. | + +Returns: + +string\[\] + +List of augmentation names that this sleeve has installed. + +## Remarks + +RAM cost: 4 GB + +Return a list of augmentation names that this sleeve has installed. + diff --git a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md new file mode 100644 index 000000000..b4c635a4f --- /dev/null +++ b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) + +## Sleeve.getSleevePurchasableAugs() method + +List purchasable augs for a sleeve. + +Signature: + +```typescript +getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to retrieve purchasable augmentations from. | + +Returns: + +[AugmentPair](./bitburner.augmentpair.md)\[\] + +List of augmentations that the player can buy for this sleeve. + +## Remarks + +RAM cost: 4 GB + +Return a list of augmentations that the player can buy for this sleeve. + diff --git a/markdown/bitburner.sleeve.getsleevestats.md b/markdown/bitburner.sleeve.getsleevestats.md new file mode 100644 index 000000000..26fc5b68d --- /dev/null +++ b/markdown/bitburner.sleeve.getsleevestats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveStats](./bitburner.sleeve.getsleevestats.md) + +## Sleeve.getSleeveStats() method + +Get the stats of a sleeve. + +Signature: + +```typescript +getSleeveStats(sleeveNumber: number): SleeveSkills; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to get stats of. | + +Returns: + +[SleeveSkills](./bitburner.sleeveskills.md) + +Object containing the stats of the sleeve. + +## Remarks + +RAM cost: 4 GB + +Return a structure containing the stats of the sleeve. + diff --git a/markdown/bitburner.sleeve.gettask.md b/markdown/bitburner.sleeve.gettask.md new file mode 100644 index 000000000..b9c08fb1d --- /dev/null +++ b/markdown/bitburner.sleeve.gettask.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getTask](./bitburner.sleeve.gettask.md) + +## Sleeve.getTask() method + +Get task of a sleeve. + +Signature: + +```typescript +getTask(sleeveNumber: number): SleeveTask; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to retrieve task from. | + +Returns: + +[SleeveTask](./bitburner.sleevetask.md) + +Object containing information the current task that the sleeve is performing. + +## Remarks + +RAM cost: 4 GB + +Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. + diff --git a/markdown/bitburner.sleeve.md b/markdown/bitburner.sleeve.md new file mode 100644 index 000000000..64abf31d9 --- /dev/null +++ b/markdown/bitburner.sleeve.md @@ -0,0 +1,41 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) + +## Sleeve interface + +Sleeve API + +Signature: + +```typescript +export interface Sleeve +``` + +## Remarks + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this API. + +## Methods + +| Method | Description | +| --- | --- | +| [getInformation(sleeveNumber)](./bitburner.sleeve.getinformation.md) | Get information about a sleeve. | +| [getNumSleeves()](./bitburner.sleeve.getnumsleeves.md) | Get the number of sleeves you own. | +| [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. | +| [getSleeveStats(sleeveNumber)](./bitburner.sleeve.getsleevestats.md) | Get the stats of 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, name)](./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. | +| [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, university, className)](./bitburner.sleeve.settouniversitycourse.md) | Set a sleeve to take a class at a university. | +| [travel(sleeveNumber, cityName)](./bitburner.sleeve.travel.md) | Make a sleeve travel to another city. | + diff --git a/markdown/bitburner.sleeve.purchasesleeveaug.md b/markdown/bitburner.sleeve.purchasesleeveaug.md new file mode 100644 index 000000000..16d6f836a --- /dev/null +++ b/markdown/bitburner.sleeve.purchasesleeveaug.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [purchaseSleeveAug](./bitburner.sleeve.purchasesleeveaug.md) + +## Sleeve.purchaseSleeveAug() method + +Purchase an aug for a sleeve. + +Signature: + +```typescript +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. | + +Returns: + +boolean + +True if the aug was purchased and installed on the sleeve, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return true if the aug was purchased and installed on the sleeve. + diff --git a/markdown/bitburner.sleeve.settobladeburneraction.md b/markdown/bitburner.sleeve.settobladeburneraction.md new file mode 100644 index 000000000..3d9bf246c --- /dev/null +++ b/markdown/bitburner.sleeve.settobladeburneraction.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToBladeburnerAction](./bitburner.sleeve.settobladeburneraction.md) + +## Sleeve.setToBladeburnerAction() method + +Set a sleeve to perform bladeburner actions. + +Signature: + +```typescript +setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to workout at the gym. | +| action | string | Name of the action to be performed. | +| contract | string | Name of the contract if applicable. | + +Returns: + +boolean + +True if the sleeve started working out, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not the sleeve started working out. + diff --git a/markdown/bitburner.sleeve.settocommitcrime.md b/markdown/bitburner.sleeve.settocommitcrime.md new file mode 100644 index 000000000..3165d1f6e --- /dev/null +++ b/markdown/bitburner.sleeve.settocommitcrime.md @@ -0,0 +1,65 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToCommitCrime](./bitburner.sleeve.settocommitcrime.md) + +## Sleeve.setToCommitCrime() method + +Set a sleeve to commit crime. + +Signature: + +```typescript +setToCommitCrime(sleeveNumber: number, name: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to start committing crime. Sleeves are numbered starting from 0. | +| name | string | Name of the crime. Must be an exact match. Refer to the list of crimes. | + +Returns: + +boolean + +True if this action was set successfully, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not this action was set successfully. + +Returns false if an invalid action is specified. + +You can set a sleeve to commit one of the following crimes. The crime names are not case sensitive. For example, you can pass in the crime name as `"Shoplift"`, `"shoplift"`, `"shopLift"`, or even `"SHOPLIFT"`. + +- Assassination - Bond forgery - Deal drugs - Grand theft auto - Heist - Homicide - Kidnap - Larceny - Mug - Rob store - Shoplift - Traffick arms + +## Example 1 + + +```ts +// NS1 +// Assign the first 3 sleeves to commit various crimes. +var crime = ["mug", "rob store", "shoplift"]; +for (var i = 0; i < crime.length; i++) { + tprintf("Sleeve %d commits crime: %s", i, crime[i]); + sleeve.setToCommitCrime(i, crime[i]); +} +``` + +## Example 2 + + +```ts +// NS2 +// Assign the first 3 sleeves to commit various crimes. +const crime = ["mug", "rob store", "shoplift"]; +for (let i = 0; i < crime.length; i++) { + ns.tprintf("Sleeve %d commits crime: %s", i, crime[i]); + ns.sleeve.setToCommitCrime(i, crime[i]); +} +``` + diff --git a/markdown/bitburner.sleeve.settocompanywork.md b/markdown/bitburner.sleeve.settocompanywork.md new file mode 100644 index 000000000..bc8d93a0d --- /dev/null +++ b/markdown/bitburner.sleeve.settocompanywork.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToCompanyWork](./bitburner.sleeve.settocompanywork.md) + +## Sleeve.setToCompanyWork() method + +Set a sleeve to work for a company. + +Signature: + +```typescript +setToCompanyWork(sleeveNumber: number, companyName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to work for the company. | +| companyName | string | Name of the company to work for. | + +Returns: + +boolean + +True if the sleeve started working on this company, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not the sleeve started working or this company. + diff --git a/markdown/bitburner.sleeve.settofactionwork.md b/markdown/bitburner.sleeve.settofactionwork.md new file mode 100644 index 000000000..b3c5e56f1 --- /dev/null +++ b/markdown/bitburner.sleeve.settofactionwork.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToFactionWork](./bitburner.sleeve.settofactionwork.md) + +## Sleeve.setToFactionWork() method + +Set a sleeve to work for a faction. + +Signature: + +```typescript +setToFactionWork(sleeveNumber: number, factionName: string, factionWorkType: string): boolean | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to work for the faction. | +| factionName | string | Name of the faction to work for. | +| factionWorkType | string | Name of the action to perform for this faction. | + +Returns: + +boolean \| undefined + +True if the sleeve started working on this faction, false otherwise, can also throw on errors + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not the sleeve started working or this faction. + diff --git a/markdown/bitburner.sleeve.settogymworkout.md b/markdown/bitburner.sleeve.settogymworkout.md new file mode 100644 index 000000000..b092838eb --- /dev/null +++ b/markdown/bitburner.sleeve.settogymworkout.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToGymWorkout](./bitburner.sleeve.settogymworkout.md) + +## Sleeve.setToGymWorkout() method + +Set a sleeve to workout at the gym. + +Signature: + +```typescript +setToGymWorkout(sleeveNumber: number, gymName: string, stat: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to workout at the gym. | +| gymName | string | Name of the gym. | +| stat | string | Name of the stat to train. | + +Returns: + +boolean + +True if the sleeve started working out, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not the sleeve started working out. + diff --git a/markdown/bitburner.sleeve.settoshockrecovery.md b/markdown/bitburner.sleeve.settoshockrecovery.md new file mode 100644 index 000000000..93a1ef01c --- /dev/null +++ b/markdown/bitburner.sleeve.settoshockrecovery.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToShockRecovery](./bitburner.sleeve.settoshockrecovery.md) + +## Sleeve.setToShockRecovery() method + +Set a sleeve to shock recovery. + +Signature: + +```typescript +setToShockRecovery(sleeveNumber: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to start recovery. | + +Returns: + +boolean + +True if this action was set successfully, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not this action was set successfully. + diff --git a/markdown/bitburner.sleeve.settosynchronize.md b/markdown/bitburner.sleeve.settosynchronize.md new file mode 100644 index 000000000..17fa4ca6d --- /dev/null +++ b/markdown/bitburner.sleeve.settosynchronize.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToSynchronize](./bitburner.sleeve.settosynchronize.md) + +## Sleeve.setToSynchronize() method + +Set a sleeve to synchronize. + +Signature: + +```typescript +setToSynchronize(sleeveNumber: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to start synchronizing. | + +Returns: + +boolean + +True if this action was set successfully, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not this action was set successfully. + diff --git a/markdown/bitburner.sleeve.settouniversitycourse.md b/markdown/bitburner.sleeve.settouniversitycourse.md new file mode 100644 index 000000000..f96d60a8b --- /dev/null +++ b/markdown/bitburner.sleeve.settouniversitycourse.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToUniversityCourse](./bitburner.sleeve.settouniversitycourse.md) + +## Sleeve.setToUniversityCourse() method + +Set a sleeve to take a class at a university. + +Signature: + +```typescript +setToUniversityCourse(sleeveNumber: number, university: string, className: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to start taking class. | +| university | string | Name of the university to attend. | +| className | string | Name of the class to follow. | + +Returns: + +boolean + +True if this action was set successfully, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not this action was set successfully. + diff --git a/markdown/bitburner.sleeve.travel.md b/markdown/bitburner.sleeve.travel.md new file mode 100644 index 000000000..e3d98cbfa --- /dev/null +++ b/markdown/bitburner.sleeve.travel.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [travel](./bitburner.sleeve.travel.md) + +## Sleeve.travel() method + +Make a sleeve travel to another city. + +Signature: + +```typescript +travel(sleeveNumber: number, cityName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to travel. | +| cityName | string | Name of the destination city. | + +Returns: + +boolean + +True if the sleeve reached destination, false otherwise. + +## Remarks + +RAM cost: 4 GB + +Return a boolean indicating whether or not the sleeve reached destination. + diff --git a/markdown/bitburner.sleeveinformation.city.md b/markdown/bitburner.sleeveinformation.city.md new file mode 100644 index 000000000..e55b917c7 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.city.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [city](./bitburner.sleeveinformation.city.md) + +## SleeveInformation.city property + +Location of the sleeve + +Signature: + +```typescript +city: string; +``` diff --git a/markdown/bitburner.sleeveinformation.hp.md b/markdown/bitburner.sleeveinformation.hp.md new file mode 100644 index 000000000..0a598b2c2 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.hp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [hp](./bitburner.sleeveinformation.hp.md) + +## SleeveInformation.hp property + +hp of the sleeve + +Signature: + +```typescript +hp: HP; +``` diff --git a/markdown/bitburner.sleeveinformation.jobs.md b/markdown/bitburner.sleeveinformation.jobs.md new file mode 100644 index 000000000..07717259d --- /dev/null +++ b/markdown/bitburner.sleeveinformation.jobs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [jobs](./bitburner.sleeveinformation.jobs.md) + +## SleeveInformation.jobs property + +Jobs available to the sleeve + +Signature: + +```typescript +jobs: string[]; +``` diff --git a/markdown/bitburner.sleeveinformation.jobtitle.md b/markdown/bitburner.sleeveinformation.jobtitle.md new file mode 100644 index 000000000..7f1d2f444 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.jobtitle.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [jobTitle](./bitburner.sleeveinformation.jobtitle.md) + +## SleeveInformation.jobTitle property + +Job titles available to the sleeve + +Signature: + +```typescript +jobTitle: string[]; +``` diff --git a/markdown/bitburner.sleeveinformation.md b/markdown/bitburner.sleeveinformation.md new file mode 100644 index 000000000..1c93331e7 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) + +## SleeveInformation interface + +Object representing sleeve information. + +Signature: + +```typescript +export interface SleeveInformation +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [city](./bitburner.sleeveinformation.city.md) | string | Location of the sleeve | +| [hp](./bitburner.sleeveinformation.hp.md) | [HP](./bitburner.hp.md) | hp of the sleeve | +| [jobs](./bitburner.sleeveinformation.jobs.md) | string\[\] | Jobs available to the sleeve | +| [jobTitle](./bitburner.sleeveinformation.jobtitle.md) | string\[\] | Job titles available to the sleeve | +| [mult](./bitburner.sleeveinformation.mult.md) | [CharacterMult](./bitburner.charactermult.md) | Sleeve multipliers | +| [tor](./bitburner.sleeveinformation.tor.md) | boolean | Does this sleeve have access to the tor router | + diff --git a/markdown/bitburner.sleeveinformation.mult.md b/markdown/bitburner.sleeveinformation.mult.md new file mode 100644 index 000000000..32255f3b3 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [mult](./bitburner.sleeveinformation.mult.md) + +## SleeveInformation.mult property + +Sleeve multipliers + +Signature: + +```typescript +mult: CharacterMult; +``` diff --git a/markdown/bitburner.sleeveinformation.tor.md b/markdown/bitburner.sleeveinformation.tor.md new file mode 100644 index 000000000..5b084487e --- /dev/null +++ b/markdown/bitburner.sleeveinformation.tor.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [tor](./bitburner.sleeveinformation.tor.md) + +## SleeveInformation.tor property + +Does this sleeve have access to the tor router + +Signature: + +```typescript +tor: boolean; +``` diff --git a/markdown/bitburner.sleeveskills.agility.md b/markdown/bitburner.sleeveskills.agility.md new file mode 100644 index 000000000..f687b5214 --- /dev/null +++ b/markdown/bitburner.sleeveskills.agility.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [agility](./bitburner.sleeveskills.agility.md) + +## SleeveSkills.agility property + +Current agility of the sleeve + +Signature: + +```typescript +agility: number; +``` diff --git a/markdown/bitburner.sleeveskills.charisma.md b/markdown/bitburner.sleeveskills.charisma.md new file mode 100644 index 000000000..8916dcb67 --- /dev/null +++ b/markdown/bitburner.sleeveskills.charisma.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [charisma](./bitburner.sleeveskills.charisma.md) + +## SleeveSkills.charisma property + +Current charisma of the sleeve + +Signature: + +```typescript +charisma: number; +``` diff --git a/markdown/bitburner.sleeveskills.defense.md b/markdown/bitburner.sleeveskills.defense.md new file mode 100644 index 000000000..d68f03b2b --- /dev/null +++ b/markdown/bitburner.sleeveskills.defense.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [defense](./bitburner.sleeveskills.defense.md) + +## SleeveSkills.defense property + +Current defense of the sleeve + +Signature: + +```typescript +defense: number; +``` diff --git a/markdown/bitburner.sleeveskills.dexterity.md b/markdown/bitburner.sleeveskills.dexterity.md new file mode 100644 index 000000000..aa7430eee --- /dev/null +++ b/markdown/bitburner.sleeveskills.dexterity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [dexterity](./bitburner.sleeveskills.dexterity.md) + +## SleeveSkills.dexterity property + +Current dexterity of the sleeve + +Signature: + +```typescript +dexterity: number; +``` diff --git a/markdown/bitburner.sleeveskills.hacking.md b/markdown/bitburner.sleeveskills.hacking.md new file mode 100644 index 000000000..2ed1e2b1a --- /dev/null +++ b/markdown/bitburner.sleeveskills.hacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [hacking](./bitburner.sleeveskills.hacking.md) + +## SleeveSkills.hacking property + +Current hacking skill of the sleeve + +Signature: + +```typescript +hacking: number; +``` diff --git a/markdown/bitburner.sleeveskills.md b/markdown/bitburner.sleeveskills.md new file mode 100644 index 000000000..0b0980728 --- /dev/null +++ b/markdown/bitburner.sleeveskills.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) + +## SleeveSkills interface + +Object representing a sleeve stats. + +Signature: + +```typescript +export interface SleeveSkills +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility](./bitburner.sleeveskills.agility.md) | number | Current agility of the sleeve | +| [charisma](./bitburner.sleeveskills.charisma.md) | number | Current charisma of the sleeve | +| [defense](./bitburner.sleeveskills.defense.md) | number | Current defense of the sleeve | +| [dexterity](./bitburner.sleeveskills.dexterity.md) | number | Current dexterity of the sleeve | +| [hacking](./bitburner.sleeveskills.hacking.md) | number | Current hacking skill of the sleeve | +| [memory](./bitburner.sleeveskills.memory.md) | number | Current memory of the sleeve \[1-100\] | +| [shock](./bitburner.sleeveskills.shock.md) | number | Current shock of the sleeve \[0-100\] | +| [strength](./bitburner.sleeveskills.strength.md) | number | Current strength of the sleeve | +| [sync](./bitburner.sleeveskills.sync.md) | number | Current sync of the sleeve \[0-100\] | + diff --git a/markdown/bitburner.sleeveskills.memory.md b/markdown/bitburner.sleeveskills.memory.md new file mode 100644 index 000000000..3dac02f01 --- /dev/null +++ b/markdown/bitburner.sleeveskills.memory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [memory](./bitburner.sleeveskills.memory.md) + +## SleeveSkills.memory property + +Current memory of the sleeve \[1-100\] + +Signature: + +```typescript +memory: number; +``` diff --git a/markdown/bitburner.sleeveskills.shock.md b/markdown/bitburner.sleeveskills.shock.md new file mode 100644 index 000000000..730175a5a --- /dev/null +++ b/markdown/bitburner.sleeveskills.shock.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [shock](./bitburner.sleeveskills.shock.md) + +## SleeveSkills.shock property + +Current shock of the sleeve \[0-100\] + +Signature: + +```typescript +shock: number; +``` diff --git a/markdown/bitburner.sleeveskills.strength.md b/markdown/bitburner.sleeveskills.strength.md new file mode 100644 index 000000000..56720e1ce --- /dev/null +++ b/markdown/bitburner.sleeveskills.strength.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [strength](./bitburner.sleeveskills.strength.md) + +## SleeveSkills.strength property + +Current strength of the sleeve + +Signature: + +```typescript +strength: number; +``` diff --git a/markdown/bitburner.sleeveskills.sync.md b/markdown/bitburner.sleeveskills.sync.md new file mode 100644 index 000000000..3bf2c07c5 --- /dev/null +++ b/markdown/bitburner.sleeveskills.sync.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveSkills](./bitburner.sleeveskills.md) > [sync](./bitburner.sleeveskills.sync.md) + +## SleeveSkills.sync property + +Current sync of the sleeve \[0-100\] + +Signature: + +```typescript +sync: number; +``` diff --git a/markdown/bitburner.sleevetask.md b/markdown/bitburner.sleevetask.md new file mode 100644 index 000000000..b27a9ff24 --- /dev/null +++ b/markdown/bitburner.sleevetask.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveTask](./bitburner.sleevetask.md) + +## SleeveTask type + +Object representing a sleeve current task. + +Signature: + +```typescript +export type SleeveTask = any; +``` diff --git a/markdown/bitburner.sleeveworkgains.md b/markdown/bitburner.sleeveworkgains.md new file mode 100644 index 000000000..775f32199 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) + +## SleeveWorkGains interface + + +Signature: + +```typescript +export interface SleeveWorkGains +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [workAgiExpGain](./bitburner.sleeveworkgains.workagiexpgain.md) | number | Agility exp gained from work | +| [workChaExpGain](./bitburner.sleeveworkgains.workchaexpgain.md) | number | Charisma exp gained from work | +| [workDefExpGain](./bitburner.sleeveworkgains.workdefexpgain.md) | number | Defense exp gained from work, | +| [workDexExpGain](./bitburner.sleeveworkgains.workdexexpgain.md) | number | Dexterity exp gained from work | +| [workHackExpGain](./bitburner.sleeveworkgains.workhackexpgain.md) | number | Hacking exp gained from work | +| [workMoneyGain](./bitburner.sleeveworkgains.workmoneygain.md) | number | Money gained from work | +| [workStrExpGain](./bitburner.sleeveworkgains.workstrexpgain.md) | number | Strength exp gained from work | + diff --git a/markdown/bitburner.sleeveworkgains.workagiexpgain.md b/markdown/bitburner.sleeveworkgains.workagiexpgain.md new file mode 100644 index 000000000..62e6f54e3 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workagiexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workAgiExpGain](./bitburner.sleeveworkgains.workagiexpgain.md) + +## SleeveWorkGains.workAgiExpGain property + +Agility exp gained from work + +Signature: + +```typescript +workAgiExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workchaexpgain.md b/markdown/bitburner.sleeveworkgains.workchaexpgain.md new file mode 100644 index 000000000..424c1d04c --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workchaexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workChaExpGain](./bitburner.sleeveworkgains.workchaexpgain.md) + +## SleeveWorkGains.workChaExpGain property + +Charisma exp gained from work + +Signature: + +```typescript +workChaExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workdefexpgain.md b/markdown/bitburner.sleeveworkgains.workdefexpgain.md new file mode 100644 index 000000000..1e515d29e --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workdefexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workDefExpGain](./bitburner.sleeveworkgains.workdefexpgain.md) + +## SleeveWorkGains.workDefExpGain property + +Defense exp gained from work, + +Signature: + +```typescript +workDefExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workdexexpgain.md b/markdown/bitburner.sleeveworkgains.workdexexpgain.md new file mode 100644 index 000000000..461c3e7ea --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workdexexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workDexExpGain](./bitburner.sleeveworkgains.workdexexpgain.md) + +## SleeveWorkGains.workDexExpGain property + +Dexterity exp gained from work + +Signature: + +```typescript +workDexExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workhackexpgain.md b/markdown/bitburner.sleeveworkgains.workhackexpgain.md new file mode 100644 index 000000000..4823ea704 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workhackexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workHackExpGain](./bitburner.sleeveworkgains.workhackexpgain.md) + +## SleeveWorkGains.workHackExpGain property + +Hacking exp gained from work + +Signature: + +```typescript +workHackExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workmoneygain.md b/markdown/bitburner.sleeveworkgains.workmoneygain.md new file mode 100644 index 000000000..8b9cc403e --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workmoneygain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workMoneyGain](./bitburner.sleeveworkgains.workmoneygain.md) + +## SleeveWorkGains.workMoneyGain property + +Money gained from work + +Signature: + +```typescript +workMoneyGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workstrexpgain.md b/markdown/bitburner.sleeveworkgains.workstrexpgain.md new file mode 100644 index 000000000..5390c0800 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workstrexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workStrExpGain](./bitburner.sleeveworkgains.workstrexpgain.md) + +## SleeveWorkGains.workStrExpGain property + +Strength exp gained from work + +Signature: + +```typescript +workStrExpGain: number; +``` diff --git a/markdown/bitburner.sourcefilelvl.lvl.md b/markdown/bitburner.sourcefilelvl.lvl.md new file mode 100644 index 000000000..067dd01ce --- /dev/null +++ b/markdown/bitburner.sourcefilelvl.lvl.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SourceFileLvl](./bitburner.sourcefilelvl.md) > [lvl](./bitburner.sourcefilelvl.lvl.md) + +## SourceFileLvl.lvl property + +The level of the source file + +Signature: + +```typescript +lvl: number; +``` diff --git a/markdown/bitburner.sourcefilelvl.md b/markdown/bitburner.sourcefilelvl.md new file mode 100644 index 000000000..2be5ba883 --- /dev/null +++ b/markdown/bitburner.sourcefilelvl.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SourceFileLvl](./bitburner.sourcefilelvl.md) + +## SourceFileLvl interface + + +Signature: + +```typescript +export interface SourceFileLvl +``` + +## Properties + +| Property | 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.sourcefilelvl.n.md b/markdown/bitburner.sourcefilelvl.n.md new file mode 100644 index 000000000..46ffb9ed9 --- /dev/null +++ b/markdown/bitburner.sourcefilelvl.n.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SourceFileLvl](./bitburner.sourcefilelvl.md) > [n](./bitburner.sourcefilelvl.n.md) + +## SourceFileLvl.n property + +The number of the source file + +Signature: + +```typescript +n: number; +``` diff --git a/markdown/bitburner.stanek.acceptgift.md b/markdown/bitburner.stanek.acceptgift.md new file mode 100644 index 000000000..a3bb3dde0 --- /dev/null +++ b/markdown/bitburner.stanek.acceptgift.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [acceptGift](./bitburner.stanek.acceptgift.md) + +## Stanek.acceptGift() method + +Accept Stanek's Gift by joining the Church of the Machine God + +Signature: + +```typescript +acceptGift(): boolean; +``` +Returns: + +boolean + +true if the player is a member of the church and has the gift installed, false otherwise. + +## Remarks + +RAM cost: 2 GB + diff --git a/markdown/bitburner.stanek.activefragments.md b/markdown/bitburner.stanek.activefragments.md new file mode 100644 index 000000000..cbdd74f25 --- /dev/null +++ b/markdown/bitburner.stanek.activefragments.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [activeFragments](./bitburner.stanek.activefragments.md) + +## Stanek.activeFragments() method + +List of fragments in Stanek's Gift. + +Signature: + +```typescript +activeFragments(): ActiveFragment[]; +``` +Returns: + +[ActiveFragment](./bitburner.activefragment.md)\[\] + +List of active fragments placed on Stanek's Gift. + +## Remarks + +RAM cost: 5 GB + diff --git a/markdown/bitburner.stanek.canplacefragment.md b/markdown/bitburner.stanek.canplacefragment.md new file mode 100644 index 000000000..4f06ba218 --- /dev/null +++ b/markdown/bitburner.stanek.canplacefragment.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [canPlaceFragment](./bitburner.stanek.canplacefragment.md) + +## Stanek.canPlaceFragment() method + +Check if fragment can be placed at specified location. + +Signature: + +```typescript +canPlaceFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| rootX | number | rootX Root X against which to align the top left of the fragment. | +| rootY | number | rootY Root Y against which to align the top left of the fragment. | +| rotation | number | rotation A number from 0 to 3, the mount of 90 degree turn to take. | +| fragmentId | number | fragmentId ID of the fragment to place. | + +Returns: + +boolean + +true if the fragment can be placed at that position. false otherwise. + +## Remarks + +RAM cost: 0.5 GB + diff --git a/markdown/bitburner.stanek.chargefragment.md b/markdown/bitburner.stanek.chargefragment.md new file mode 100644 index 000000000..9b3e75a72 --- /dev/null +++ b/markdown/bitburner.stanek.chargefragment.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [chargeFragment](./bitburner.stanek.chargefragment.md) + +## Stanek.chargeFragment() method + +Charge a fragment, increasing its power. + +Signature: + +```typescript +chargeFragment(rootX: number, rootY: number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| rootX | number | rootX Root X against which to align the top left of the fragment. | +| rootY | number | rootY Root Y against which to align the top left of the fragment. | + +Returns: + +Promise<void> + +Promise that lasts until the charge action is over. + +## Remarks + +RAM cost: 0.4 GB + diff --git a/markdown/bitburner.stanek.cleargift.md b/markdown/bitburner.stanek.cleargift.md new file mode 100644 index 000000000..12ece8a3d --- /dev/null +++ b/markdown/bitburner.stanek.cleargift.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [clearGift](./bitburner.stanek.cleargift.md) + +## Stanek.clearGift() method + +Clear the board of all fragments. + +Signature: + +```typescript +clearGift(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.stanek.fragmentdefinitions.md b/markdown/bitburner.stanek.fragmentdefinitions.md new file mode 100644 index 000000000..dbc36f456 --- /dev/null +++ b/markdown/bitburner.stanek.fragmentdefinitions.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [fragmentDefinitions](./bitburner.stanek.fragmentdefinitions.md) + +## Stanek.fragmentDefinitions() method + +List possible fragments. + +Signature: + +```typescript +fragmentDefinitions(): Fragment[]; +``` +Returns: + +[Fragment](./bitburner.fragment.md)\[\] + +List of possible fragments. + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.stanek.getfragment.md b/markdown/bitburner.stanek.getfragment.md new file mode 100644 index 000000000..348c23d37 --- /dev/null +++ b/markdown/bitburner.stanek.getfragment.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [getFragment](./bitburner.stanek.getfragment.md) + +## Stanek.getFragment() method + +Get placed fragment at location. + +Signature: + +```typescript +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. | + +Returns: + +[ActiveFragment](./bitburner.activefragment.md) \| undefined + +The fragment at \[rootX, rootY\], if any. + +## Remarks + +RAM cost: 5 GB + diff --git a/markdown/bitburner.stanek.giftheight.md b/markdown/bitburner.stanek.giftheight.md new file mode 100644 index 000000000..6ce12a20a --- /dev/null +++ b/markdown/bitburner.stanek.giftheight.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [giftHeight](./bitburner.stanek.giftheight.md) + +## Stanek.giftHeight() method + +Stanek's Gift height. + +Signature: + +```typescript +giftHeight(): number; +``` +Returns: + +number + +The height of the gift. + +## Remarks + +RAM cost: 0.4 GB + diff --git a/markdown/bitburner.stanek.giftwidth.md b/markdown/bitburner.stanek.giftwidth.md new file mode 100644 index 000000000..aa85b25c2 --- /dev/null +++ b/markdown/bitburner.stanek.giftwidth.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [giftWidth](./bitburner.stanek.giftwidth.md) + +## Stanek.giftWidth() method + +Stanek's Gift width. + +Signature: + +```typescript +giftWidth(): number; +``` +Returns: + +number + +The width of the gift. + +## Remarks + +RAM cost: 0.4 GB + diff --git a/markdown/bitburner.stanek.md b/markdown/bitburner.stanek.md new file mode 100644 index 000000000..0a518d780 --- /dev/null +++ b/markdown/bitburner.stanek.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) + +## Stanek interface + +Stanek's Gift API. + +Signature: + +```typescript +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. | + diff --git a/markdown/bitburner.stanek.placefragment.md b/markdown/bitburner.stanek.placefragment.md new file mode 100644 index 000000000..4ff6495c4 --- /dev/null +++ b/markdown/bitburner.stanek.placefragment.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [placeFragment](./bitburner.stanek.placefragment.md) + +## Stanek.placeFragment() method + +Place fragment on Stanek's Gift. + +Signature: + +```typescript +placeFragment(rootX: number, rootY: number, rotation: number, fragmentId: 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. | +| 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: + +boolean + +true if the fragment can be placed at that position. false otherwise. + +## Remarks + +RAM cost: 5 GB + diff --git a/markdown/bitburner.stanek.removefragment.md b/markdown/bitburner.stanek.removefragment.md new file mode 100644 index 000000000..63071dd20 --- /dev/null +++ b/markdown/bitburner.stanek.removefragment.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Stanek](./bitburner.stanek.md) > [removeFragment](./bitburner.stanek.removefragment.md) + +## Stanek.removeFragment() method + +Remove fragment at location. + +Signature: + +```typescript +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. | + +Returns: + +boolean + +The fragment at \[rootX, rootY\], if any. + +## Remarks + +RAM cost: 0.15 GB + diff --git a/markdown/bitburner.stockorder.md b/markdown/bitburner.stockorder.md new file mode 100644 index 000000000..98a3ebda9 --- /dev/null +++ b/markdown/bitburner.stockorder.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrder](./bitburner.stockorder.md) + +## StockOrder interface + +Return value of [getOrders](./bitburner.tix.getorders.md) + +Keys are stock symbols, properties are arrays of [StockOrderObject](./bitburner.stockorderobject.md) + +Signature: + +```typescript +export interface StockOrder +``` diff --git a/markdown/bitburner.stockorderobject.md b/markdown/bitburner.stockorderobject.md new file mode 100644 index 000000000..f7d5e6eda --- /dev/null +++ b/markdown/bitburner.stockorderobject.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) + +## StockOrderObject interface + +Value in map of [StockOrder](./bitburner.stockorder.md) + +Signature: + +```typescript +export interface StockOrderObject +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [position](./bitburner.stockorderobject.position.md) | [PositionTypes](./bitburner.positiontypes.md) | Order position | +| [price](./bitburner.stockorderobject.price.md) | number | Price per share | +| [shares](./bitburner.stockorderobject.shares.md) | number | Number of shares | +| [type](./bitburner.stockorderobject.type.md) | [OrderTypes](./bitburner.ordertypes.md) | Order type | + diff --git a/markdown/bitburner.stockorderobject.position.md b/markdown/bitburner.stockorderobject.position.md new file mode 100644 index 000000000..9f6aac1de --- /dev/null +++ b/markdown/bitburner.stockorderobject.position.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) > [position](./bitburner.stockorderobject.position.md) + +## StockOrderObject.position property + +Order position + +Signature: + +```typescript +position: PositionTypes; +``` diff --git a/markdown/bitburner.stockorderobject.price.md b/markdown/bitburner.stockorderobject.price.md new file mode 100644 index 000000000..8c96a4820 --- /dev/null +++ b/markdown/bitburner.stockorderobject.price.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) > [price](./bitburner.stockorderobject.price.md) + +## StockOrderObject.price property + +Price per share + +Signature: + +```typescript +price: number; +``` diff --git a/markdown/bitburner.stockorderobject.shares.md b/markdown/bitburner.stockorderobject.shares.md new file mode 100644 index 000000000..6553ff33c --- /dev/null +++ b/markdown/bitburner.stockorderobject.shares.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) > [shares](./bitburner.stockorderobject.shares.md) + +## StockOrderObject.shares property + +Number of shares + +Signature: + +```typescript +shares: number; +``` diff --git a/markdown/bitburner.stockorderobject.type.md b/markdown/bitburner.stockorderobject.type.md new file mode 100644 index 000000000..59c3258ef --- /dev/null +++ b/markdown/bitburner.stockorderobject.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) > [type](./bitburner.stockorderobject.type.md) + +## StockOrderObject.type property + +Order type + +Signature: + +```typescript +type: OrderTypes; +``` diff --git a/markdown/bitburner.tix.buyshort.md b/markdown/bitburner.tix.buyshort.md new file mode 100644 index 000000000..77e928662 --- /dev/null +++ b/markdown/bitburner.tix.buyshort.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [buyShort](./bitburner.tix.buyshort.md) + +## TIX.buyShort() method + +Short stocks. + +Signature: + +```typescript +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 nearest integer. | + +Returns: + +number + +The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. + +## Remarks + +RAM cost: 2.5 GB Attempts to purchase a short position of a stock using a Market Order. + +The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game. + +If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee. + +If the purchase is successful, this function will return the stock price at which each share was purchased. Otherwise, it will return 0. + diff --git a/markdown/bitburner.tix.buystock.md b/markdown/bitburner.tix.buystock.md new file mode 100644 index 000000000..5a8e8b56c --- /dev/null +++ b/markdown/bitburner.tix.buystock.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [buyStock](./bitburner.tix.buystock.md) + +## TIX.buyStock() method + +Buy stocks. + +Signature: + +```typescript +buyStock(sym: string, shares: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | +| shares | number | Number of shares to purchased. Must be positive. Will be rounded to nearest integer. | + +Returns: + +number + +The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. + +## Remarks + +RAM cost: 2.5 GB Attempts to purchase shares of a stock using a Market Order. + +If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee. + +If this function successfully purchases the shares, it will return the stock price at which each share was purchased. Otherwise, it will return 0. + diff --git a/markdown/bitburner.tix.cancelorder.md b/markdown/bitburner.tix.cancelorder.md new file mode 100644 index 000000000..c5ef90cb8 --- /dev/null +++ b/markdown/bitburner.tix.cancelorder.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [cancelOrder](./bitburner.tix.cancelorder.md) + +## TIX.cancelOrder() method + +Cancel order for stocks. + +Signature: + +```typescript +cancelOrder(sym: string, shares: number, price: number, type: string, pos: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | +| shares | number | Number of shares for order. Must be positive. Will be rounded to nearest integer. | +| price | number | Execution price for the order. | +| type | string | Type of order. | +| pos | string | Specifies whether the order is a “Long” or “Short” position. | + +Returns: + +void + +## Remarks + +RAM cost: 2.5 GB Cancels an outstanding Limit or Stop order on the stock market. + +The ability to use limit and stop orders is \*\*not\*\* immediately available to the player and must be unlocked later on in the game. + diff --git a/markdown/bitburner.tix.getaskprice.md b/markdown/bitburner.tix.getaskprice.md new file mode 100644 index 000000000..1f33c26cd --- /dev/null +++ b/markdown/bitburner.tix.getaskprice.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getAskPrice](./bitburner.tix.getaskprice.md) + +## TIX.getAskPrice() method + +Returns the ask price of that stock. + +Signature: + +```typescript +getAskPrice(sym: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | + +Returns: + +number + +The ask price of a stock. + +## Remarks + +RAM cost: 2 GB + diff --git a/markdown/bitburner.tix.getbidprice.md b/markdown/bitburner.tix.getbidprice.md new file mode 100644 index 000000000..a2d00d8b1 --- /dev/null +++ b/markdown/bitburner.tix.getbidprice.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getBidPrice](./bitburner.tix.getbidprice.md) + +## TIX.getBidPrice() method + +Returns the bid price of that stock. + +Signature: + +```typescript +getBidPrice(sym: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | + +Returns: + +number + +The bid price of a stock. + +## Remarks + +RAM cost: 2 GB + diff --git a/markdown/bitburner.tix.getforecast.md b/markdown/bitburner.tix.getforecast.md new file mode 100644 index 000000000..4fa0c0043 --- /dev/null +++ b/markdown/bitburner.tix.getforecast.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getForecast](./bitburner.tix.getforecast.md) + +## TIX.getForecast() method + +Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. + +Signature: + +```typescript +getForecast(sym: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | + +Returns: + +number + +Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. + +## Remarks + +RAM cost: 2.5 GB The probability is returned as a decimal value, NOT a percentage (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60). + +In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a 30% chance of increasing and a 70% chance of decreasing during the next tick. + +In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. + diff --git a/markdown/bitburner.tix.getmaxshares.md b/markdown/bitburner.tix.getmaxshares.md new file mode 100644 index 000000000..ec152466f --- /dev/null +++ b/markdown/bitburner.tix.getmaxshares.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getMaxShares](./bitburner.tix.getmaxshares.md) + +## TIX.getMaxShares() method + +Returns the maximum number of shares of a stock. + +Signature: + +```typescript +getMaxShares(sym: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | + +Returns: + +number + +Maximum number of shares that the stock has. + +## Remarks + +RAM cost: 2 GB This is the maximum amount of the stock that can be purchased in both the Long and Short positions combined. + diff --git a/markdown/bitburner.tix.getorders.md b/markdown/bitburner.tix.getorders.md new file mode 100644 index 000000000..04184a956 --- /dev/null +++ b/markdown/bitburner.tix.getorders.md @@ -0,0 +1,76 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getOrders](./bitburner.tix.getorders.md) + +## TIX.getOrders() method + +Returns your order book for the stock market. + +Signature: + +```typescript +getOrders(): StockOrder; +``` +Returns: + +[StockOrder](./bitburner.stockorder.md) + +Object containing information for all the Limit and Stop Orders you have in the stock market. + +## Remarks + +RAM cost: 2.5 GB This is an object containing information for all the Limit and Stop Orders you have in the stock market. For each symbol you have a position in, the returned object will have a key with that symbol's name. The object's properties are each an array of [StockOrderObject](./bitburner.stockorderobject.md) The object has the following structure: + +```ts +{ + string1: [ // Array of orders for this stock + { + shares: Order quantity + price: Order price + type: Order type + position: Either "L" or "S" for Long or Short position + }, + { + ... + }, + ... + ], + string2: [ // Array of orders for this stock + ... + ], + ... +} +``` +The “Order type” property can have one of the following four values: "Limit Buy Order", "Limit Sell Order", "Stop Buy Order", "Stop Sell Order". Note that the order book will only contain information for stocks that you actually have orders in. + +## Example + + +```ts +"If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property." +{ + ECP: [ + { + shares: 5, + price: 100,000 + type: "Stop Buy Order", + position: "S", + }, + { + shares: 25, + price: 125,000 + type: "Limit Sell Order", + position: "L", + }, + ], + SYSC: [ + { + shares: 100, + price: 10,000 + type: "Limit Buy Order", + position: "L", + }, + ], +} +``` + diff --git a/markdown/bitburner.tix.getposition.md b/markdown/bitburner.tix.getposition.md new file mode 100644 index 000000000..206fcb2a8 --- /dev/null +++ b/markdown/bitburner.tix.getposition.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getPosition](./bitburner.tix.getposition.md) + +## TIX.getPosition() method + +Returns the player’s position in a stock. + +Signature: + +```typescript +getPosition(sym: string): [number, number, number, number]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | + +Returns: + +\[number, number, number, number\] + +Array of four elements that represents the player’s position in a stock. + +## Remarks + +RAM cost: 2 GB Returns an array of four elements that represents the player’s position in a stock. + +The first element is the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the player’s shares in the Long position. + +The third element in the array is the number of shares the player owns of the stock in the Short position. The fourth element in the array is the average price of the player’s Short position. + +All elements in the returned array are numeric. + +## Example 1 + + +```ts +// NS1 +var pos = stock.getPosition("ECP"); +var shares = pos[0]; +var avgPx = pos[1]; +var sharesShort = pos[2]; +var avgPxShort = pos[3]; +``` + +## Example 2 + + +```ts +// NS2 +const [shares, avgPx, sharesShort, avgPxShort] = ns.stock.getPosition("ECP"); +``` + diff --git a/markdown/bitburner.tix.getprice.md b/markdown/bitburner.tix.getprice.md new file mode 100644 index 000000000..01d1b1b40 --- /dev/null +++ b/markdown/bitburner.tix.getprice.md @@ -0,0 +1,64 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getPrice](./bitburner.tix.getprice.md) + +## TIX.getPrice() method + +Returns the price of a stock. + +Signature: + +```typescript +getPrice(sym: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | + +Returns: + +number + +The price of a stock. + +## Remarks + +RAM cost: 2 GB + +The stock’s price is the average of its bid and ask prices. This function requires that you have the following: + +1. WSE Account + +1. TIX API Access + +## Example 1 + + +```ts +// NS1 +stock.getPrice("FSIG"); + +// Choose the first stock symbol from the array of stock symbols. Get the price +// of the corresponding stock. +var sym = stock.getSymbols()[0]; +tprint("Stock symbol: " + sym); +tprint("Stock price: " + stock.getPrice(sym)); +``` + +## Example 2 + + +```ts +// NS2 +ns.stock.getPrice("FSIG"); + +// Choose the first stock symbol from the array of stock symbols. Get the price +// of the corresponding stock. +const sym = ns.stock.getSymbols()[0]; +ns.tprint("Stock symbol: " + sym); +ns.tprint("Stock price: " + ns.stock.getPrice(sym)); +``` + diff --git a/markdown/bitburner.tix.getpurchasecost.md b/markdown/bitburner.tix.getpurchasecost.md new file mode 100644 index 000000000..7eb12f88c --- /dev/null +++ b/markdown/bitburner.tix.getpurchasecost.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getPurchaseCost](./bitburner.tix.getpurchasecost.md) + +## TIX.getPurchaseCost() method + +Calculates cost of buying stocks. + +Signature: + +```typescript +getPurchaseCost(sym: string, shares: number, posType: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | +| shares | number | Number of shares to purchase. | +| posType | string | Specifies whether the order is a “Long” or “Short” position. | + +Returns: + +number + +Cost to buy a given number of shares of a stock. + +## Remarks + +RAM cost: 2 GB Calculates and returns how much it would cost to buy a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees. + diff --git a/markdown/bitburner.tix.getsalegain.md b/markdown/bitburner.tix.getsalegain.md new file mode 100644 index 000000000..bbc263f28 --- /dev/null +++ b/markdown/bitburner.tix.getsalegain.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getSaleGain](./bitburner.tix.getsalegain.md) + +## TIX.getSaleGain() method + +Calculate profit of selling stocks. + +Signature: + +```typescript +getSaleGain(sym: string, shares: number, posType: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | +| shares | number | Number of shares to sell. | +| posType | string | Specifies whether the order is a “Long” or “Short” position. | + +Returns: + +number + +Gain from selling a given number of shares of a stock. + +## Remarks + +RAM cost: 2 GB Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees. + diff --git a/markdown/bitburner.tix.getsymbols.md b/markdown/bitburner.tix.getsymbols.md new file mode 100644 index 000000000..8ec52e5d9 --- /dev/null +++ b/markdown/bitburner.tix.getsymbols.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getSymbols](./bitburner.tix.getsymbols.md) + +## TIX.getSymbols() method + +Returns an array of the symbols of the tradable stocks + +Signature: + +```typescript +getSymbols(): string[]; +``` +Returns: + +string\[\] + +Array of the symbols of the tradable stocks. + +## Remarks + +RAM cost: 2 GB + diff --git a/markdown/bitburner.tix.getvolatility.md b/markdown/bitburner.tix.getvolatility.md new file mode 100644 index 000000000..b38afb066 --- /dev/null +++ b/markdown/bitburner.tix.getvolatility.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getVolatility](./bitburner.tix.getvolatility.md) + +## TIX.getVolatility() method + +Returns the volatility of the specified stock. + +Signature: + +```typescript +getVolatility(sym: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | + +Returns: + +number + +Volatility of the specified stock. + +## Remarks + +RAM cost: 2.5 GB Volatility represents the maximum percentage by which a stock’s price can change every tick. The volatility is returned as a decimal value, NOT a percentage (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3). + +In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. + diff --git a/markdown/bitburner.tix.has4sdata.md b/markdown/bitburner.tix.has4sdata.md new file mode 100644 index 000000000..65ee2a131 --- /dev/null +++ b/markdown/bitburner.tix.has4sdata.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [has4SData](./bitburner.tix.has4sdata.md) + +## TIX.has4SData() method + +Returns true if the player has access to the 4S Data + +Signature: + +```typescript +has4SData(): boolean; +``` +Returns: + +boolean + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.tix.has4sdatatixapi.md b/markdown/bitburner.tix.has4sdatatixapi.md new file mode 100644 index 000000000..f3d55d9b0 --- /dev/null +++ b/markdown/bitburner.tix.has4sdatatixapi.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [has4SDataTIXAPI](./bitburner.tix.has4sdatatixapi.md) + +## TIX.has4SDataTIXAPI() method + +Returns true if the player has access to the 4SData TIX API + +Signature: + +```typescript +has4SDataTIXAPI(): boolean; +``` +Returns: + +boolean + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.tix.hastixapiaccess.md b/markdown/bitburner.tix.hastixapiaccess.md new file mode 100644 index 000000000..083bbd038 --- /dev/null +++ b/markdown/bitburner.tix.hastixapiaccess.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [hasTIXAPIAccess](./bitburner.tix.hastixapiaccess.md) + +## TIX.hasTIXAPIAccess() method + +Returns true if the player has access to the TIX API + +Signature: + +```typescript +hasTIXAPIAccess(): boolean; +``` +Returns: + +boolean + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.tix.haswseaccount.md b/markdown/bitburner.tix.haswseaccount.md new file mode 100644 index 000000000..d823ab064 --- /dev/null +++ b/markdown/bitburner.tix.haswseaccount.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [hasWSEAccount](./bitburner.tix.haswseaccount.md) + +## TIX.hasWSEAccount() method + +Returns true if the player has access to a WSE Account + +Signature: + +```typescript +hasWSEAccount(): boolean; +``` +Returns: + +boolean + +## Remarks + +RAM cost: 0.05 GB + diff --git a/markdown/bitburner.tix.md b/markdown/bitburner.tix.md new file mode 100644 index 000000000..a40625a09 --- /dev/null +++ b/markdown/bitburner.tix.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) + +## TIX interface + +Stock market API + +Signature: + +```typescript +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, type, pos)](./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. | +| [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. | +| [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, posType)](./bitburner.tix.getpurchasecost.md) | Calculates cost of buying stocks. | +| [getSaleGain(sym, shares, posType)](./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 | +| [placeOrder(sym, shares, price, type, pos)](./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 new file mode 100644 index 000000000..59a9cba98 --- /dev/null +++ b/markdown/bitburner.tix.placeorder.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [placeOrder](./bitburner.tix.placeorder.md) + +## TIX.placeOrder() method + +Place order for stocks. + +Signature: + +```typescript +placeOrder(sym: string, shares: number, price: number, type: string, pos: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | string | Stock symbol. | +| shares | number | Number of shares for order. Must be positive. Will be rounded to nearest integer. | +| price | number | Execution price for the order. | +| type | string | Type of order. | +| pos | string | Specifies whether the order is a “Long” or “Short” position. | + +Returns: + +boolean + +True if the order is successfully placed, and false otherwise. + +## Remarks + +RAM cost: 2.5 GB Places an order on the stock market. This function only works for Limit and Stop Orders. + +The ability to place limit and stop orders is \*\*not\*\* immediately available to the player and must be unlocked later on in the game. + +Returns true if the order is successfully placed, and false otherwise. + diff --git a/markdown/bitburner.tix.purchase4smarketdata.md b/markdown/bitburner.tix.purchase4smarketdata.md new file mode 100644 index 000000000..42b21a322 --- /dev/null +++ b/markdown/bitburner.tix.purchase4smarketdata.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [purchase4SMarketData](./bitburner.tix.purchase4smarketdata.md) + +## TIX.purchase4SMarketData() method + +Purchase 4S Market Data Access. + +Signature: + +```typescript +purchase4SMarketData(): boolean; +``` +Returns: + +boolean + +True if you successfully purchased it or if you already have access, false otherwise. + +## Remarks + +RAM cost: 2.5 GB + diff --git a/markdown/bitburner.tix.purchase4smarketdatatixapi.md b/markdown/bitburner.tix.purchase4smarketdatatixapi.md new file mode 100644 index 000000000..c23ebd346 --- /dev/null +++ b/markdown/bitburner.tix.purchase4smarketdatatixapi.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [purchase4SMarketDataTixApi](./bitburner.tix.purchase4smarketdatatixapi.md) + +## TIX.purchase4SMarketDataTixApi() method + +Purchase 4S Market Data TIX API Access. + +Signature: + +```typescript +purchase4SMarketDataTixApi(): boolean; +``` +Returns: + +boolean + +True if you successfully purchased it or if you already have access, false otherwise. + +## Remarks + +RAM cost: 2.5 GB + diff --git a/markdown/bitburner.tix.purchasetixapi.md b/markdown/bitburner.tix.purchasetixapi.md new file mode 100644 index 000000000..ed42a91be --- /dev/null +++ b/markdown/bitburner.tix.purchasetixapi.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [purchaseTixApi](./bitburner.tix.purchasetixapi.md) + +## TIX.purchaseTixApi() method + +Purchase TIX API Access + +Signature: + +```typescript +purchaseTixApi(): boolean; +``` +Returns: + +boolean + +True if you successfully purchased it or if you already have access, false otherwise. + +## Remarks + +RAM cost: 2.5 GB + diff --git a/markdown/bitburner.tix.purchasewseaccount.md b/markdown/bitburner.tix.purchasewseaccount.md new file mode 100644 index 000000000..ec18792d5 --- /dev/null +++ b/markdown/bitburner.tix.purchasewseaccount.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [purchaseWseAccount](./bitburner.tix.purchasewseaccount.md) + +## TIX.purchaseWseAccount() method + +Purchase WSE Account. + +Signature: + +```typescript +purchaseWseAccount(): boolean; +``` +Returns: + +boolean + +True if you successfully purchased it or if you already have access, false otherwise. + +## Remarks + +RAM cost: 2.5 GB + diff --git a/markdown/bitburner.tix.sellshort.md b/markdown/bitburner.tix.sellshort.md new file mode 100644 index 000000000..f5081991a --- /dev/null +++ b/markdown/bitburner.tix.sellshort.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [sellShort](./bitburner.tix.sellshort.md) + +## TIX.sellShort() method + +Sell short stock. + +Signature: + +```typescript +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 nearest integer. | + +Returns: + +number + +The stock price at which each share was sold, otherwise 0 if the shares weren't sold. + +## Remarks + +RAM cost: 2.5 GB Attempts to sell a short position of a stock using a Market Order. + +The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game. + +If the specified number of shares exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee. + +If the sale is successful, this function will return the stock price at which each share was sold. Otherwise it will return 0. + diff --git a/markdown/bitburner.tix.sellstock.md b/markdown/bitburner.tix.sellstock.md new file mode 100644 index 000000000..7d18b72c7 --- /dev/null +++ b/markdown/bitburner.tix.sellstock.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [sellStock](./bitburner.tix.sellstock.md) + +## TIX.sellStock() method + +Sell stocks. + +Signature: + +```typescript +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 nearest integer. | + +Returns: + +number + +The stock price at which each share was sold, otherwise 0 if the shares weren't sold. + +## Remarks + +RAM cost: 2.5 GB Attempts to sell shares of a stock using a Market Order. + +If the specified number of shares in the function exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee. + +The net profit made from selling stocks with this function is reflected in the script’s statistics. This net profit is calculated as: + +shares \* (sell\_price - average\_price\_of\_purchased\_shares) + +If the sale is successful, this function will return the stock price at which each share was sold. Otherwise, it will return 0. + diff --git a/markdown/bitburner.toastvariant.md b/markdown/bitburner.toastvariant.md new file mode 100644 index 000000000..70d43a5ff --- /dev/null +++ b/markdown/bitburner.toastvariant.md @@ -0,0 +1,14 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ToastVariant](./bitburner.toastvariant.md) + +## ToastVariant type + + +Signature: + +```typescript +type ToastVariant = ValuesFrom; +``` +References: [ValuesFrom](./bitburner.valuesfrom.md) + diff --git a/markdown/bitburner.userinterface.clearterminal.md b/markdown/bitburner.userinterface.clearterminal.md new file mode 100644 index 000000000..d19cd448d --- /dev/null +++ b/markdown/bitburner.userinterface.clearterminal.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [clearTerminal](./bitburner.userinterface.clearterminal.md) + +## UserInterface.clearTerminal() method + +Clear the Terminal window, as if the player ran `clear` in the terminal + +Signature: + +```typescript +clearTerminal(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 0.2 GB + diff --git a/markdown/bitburner.userinterface.getgameinfo.md b/markdown/bitburner.userinterface.getgameinfo.md new file mode 100644 index 000000000..de295a735 --- /dev/null +++ b/markdown/bitburner.userinterface.getgameinfo.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [getGameInfo](./bitburner.userinterface.getgameinfo.md) + +## UserInterface.getGameInfo() method + +Gets the current game information (version, commit, ...) + +Signature: + +```typescript +getGameInfo(): GameInfo; +``` +Returns: + +[GameInfo](./bitburner.gameinfo.md) + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.userinterface.getstyles.md b/markdown/bitburner.userinterface.getstyles.md new file mode 100644 index 000000000..5699ce85b --- /dev/null +++ b/markdown/bitburner.userinterface.getstyles.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [getStyles](./bitburner.userinterface.getstyles.md) + +## UserInterface.getStyles() method + +Get the current styles + +Signature: + +```typescript +getStyles(): IStyleSettings; +``` +Returns: + +[IStyleSettings](./bitburner.istylesettings.md) + +An object containing the player's styles + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.userinterface.gettheme.md b/markdown/bitburner.userinterface.gettheme.md new file mode 100644 index 000000000..c2bce91d2 --- /dev/null +++ b/markdown/bitburner.userinterface.gettheme.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [getTheme](./bitburner.userinterface.gettheme.md) + +## UserInterface.getTheme() method + +Get the current theme + +Signature: + +```typescript +getTheme(): UserInterfaceTheme; +``` +Returns: + +[UserInterfaceTheme](./bitburner.userinterfacetheme.md) + +An object containing the theme's colors + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.userinterface.md b/markdown/bitburner.userinterface.md new file mode 100644 index 000000000..17bba0362 --- /dev/null +++ b/markdown/bitburner.userinterface.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) + +## UserInterface interface + +User Interface API. + +Signature: + +```typescript +interface UserInterface +``` + +## Methods + +| Method | Description | +| --- | --- | +| [clearTerminal()](./bitburner.userinterface.clearterminal.md) | Clear the Terminal window, as if the player ran clear in the terminal | +| [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 | +| [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 | +| [setStyles(newStyles)](./bitburner.userinterface.setstyles.md) | Sets the current styles | +| [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.resetstyles.md b/markdown/bitburner.userinterface.resetstyles.md new file mode 100644 index 000000000..e562b93ff --- /dev/null +++ b/markdown/bitburner.userinterface.resetstyles.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [resetStyles](./bitburner.userinterface.resetstyles.md) + +## UserInterface.resetStyles() method + +Resets the player's styles to the default values + +Signature: + +```typescript +resetStyles(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.userinterface.resettheme.md b/markdown/bitburner.userinterface.resettheme.md new file mode 100644 index 000000000..051b0f5a7 --- /dev/null +++ b/markdown/bitburner.userinterface.resettheme.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [resetTheme](./bitburner.userinterface.resettheme.md) + +## UserInterface.resetTheme() method + +Resets the player's theme to the default values + +Signature: + +```typescript +resetTheme(): void; +``` +Returns: + +void + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.userinterface.setstyles.md b/markdown/bitburner.userinterface.setstyles.md new file mode 100644 index 000000000..fef8ce290 --- /dev/null +++ b/markdown/bitburner.userinterface.setstyles.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [setStyles](./bitburner.userinterface.setstyles.md) + +## UserInterface.setStyles() method + +Sets the current styles + +Signature: + +```typescript +setStyles(newStyles: IStyleSettings): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| newStyles | [IStyleSettings](./bitburner.istylesettings.md) | | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +## Example + +Usage example (NS2) + +```ts +const styles = ns.ui.getStyles(); +styles.fontFamily = 'Comic Sans Ms'; +ns.ui.setStyles(styles); +``` + diff --git a/markdown/bitburner.userinterface.settheme.md b/markdown/bitburner.userinterface.settheme.md new file mode 100644 index 000000000..2d36917aa --- /dev/null +++ b/markdown/bitburner.userinterface.settheme.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [setTheme](./bitburner.userinterface.settheme.md) + +## UserInterface.setTheme() method + +Sets the current theme + +Signature: + +```typescript +setTheme(newTheme: UserInterfaceTheme): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| newTheme | [UserInterfaceTheme](./bitburner.userinterfacetheme.md) | | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +## Example + +Usage example (NS2) + +```ts +const theme = ns.ui.getTheme(); +theme.primary = '#ff5500'; +ns.ui.setTheme(theme); +``` + diff --git a/markdown/bitburner.userinterface.windowsize.md b/markdown/bitburner.userinterface.windowsize.md new file mode 100644 index 000000000..3727787e9 --- /dev/null +++ b/markdown/bitburner.userinterface.windowsize.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterface](./bitburner.userinterface.md) > [windowSize](./bitburner.userinterface.windowsize.md) + +## UserInterface.windowSize() method + +Get the current window size + +Signature: + +```typescript +windowSize(): [number, number]; +``` +Returns: + +\[number, number\] + +An array of 2 value containing the window width and height. + +## Remarks + +RAM cost: 0 GB + diff --git a/markdown/bitburner.userinterfacetheme.backgroundprimary.md b/markdown/bitburner.userinterfacetheme.backgroundprimary.md new file mode 100644 index 000000000..a7b5588b6 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.backgroundprimary.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [backgroundprimary](./bitburner.userinterfacetheme.backgroundprimary.md) + +## UserInterfaceTheme.backgroundprimary property + +Signature: + +```typescript +backgroundprimary: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.backgroundsecondary.md b/markdown/bitburner.userinterfacetheme.backgroundsecondary.md new file mode 100644 index 000000000..9af7a9f32 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.backgroundsecondary.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [backgroundsecondary](./bitburner.userinterfacetheme.backgroundsecondary.md) + +## UserInterfaceTheme.backgroundsecondary property + +Signature: + +```typescript +backgroundsecondary: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.black.md b/markdown/bitburner.userinterfacetheme.black.md new file mode 100644 index 000000000..ed24158fe --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.black.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [black](./bitburner.userinterfacetheme.black.md) + +## UserInterfaceTheme.black property + +Signature: + +```typescript +black: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.button.md b/markdown/bitburner.userinterfacetheme.button.md new file mode 100644 index 000000000..c7ea13560 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.button.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [button](./bitburner.userinterfacetheme.button.md) + +## UserInterfaceTheme.button property + +Signature: + +```typescript +button: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.cha.md b/markdown/bitburner.userinterfacetheme.cha.md new file mode 100644 index 000000000..5cd9a2259 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.cha.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [cha](./bitburner.userinterfacetheme.cha.md) + +## UserInterfaceTheme.cha property + +Signature: + +```typescript +cha: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.combat.md b/markdown/bitburner.userinterfacetheme.combat.md new file mode 100644 index 000000000..bb007288e --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.combat.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [combat](./bitburner.userinterfacetheme.combat.md) + +## UserInterfaceTheme.combat property + +Signature: + +```typescript +combat: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.disabled.md b/markdown/bitburner.userinterfacetheme.disabled.md new file mode 100644 index 000000000..b95cd9b20 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.disabled.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [disabled](./bitburner.userinterfacetheme.disabled.md) + +## UserInterfaceTheme.disabled property + +Signature: + +```typescript +disabled: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.error.md b/markdown/bitburner.userinterfacetheme.error.md new file mode 100644 index 000000000..c5f00a6d6 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.error.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [error](./bitburner.userinterfacetheme.error.md) + +## UserInterfaceTheme.error property + +Signature: + +```typescript +error: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.errordark.md b/markdown/bitburner.userinterfacetheme.errordark.md new file mode 100644 index 000000000..c4ca9b309 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.errordark.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [errordark](./bitburner.userinterfacetheme.errordark.md) + +## UserInterfaceTheme.errordark property + +Signature: + +```typescript +errordark: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.errorlight.md b/markdown/bitburner.userinterfacetheme.errorlight.md new file mode 100644 index 000000000..23101a406 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.errorlight.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [errorlight](./bitburner.userinterfacetheme.errorlight.md) + +## UserInterfaceTheme.errorlight property + +Signature: + +```typescript +errorlight: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.hack.md b/markdown/bitburner.userinterfacetheme.hack.md new file mode 100644 index 000000000..3c850196a --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.hack.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [hack](./bitburner.userinterfacetheme.hack.md) + +## UserInterfaceTheme.hack property + +Signature: + +```typescript +hack: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.hp.md b/markdown/bitburner.userinterfacetheme.hp.md new file mode 100644 index 000000000..ec04df67b --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.hp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [hp](./bitburner.userinterfacetheme.hp.md) + +## UserInterfaceTheme.hp property + +Signature: + +```typescript +hp: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.info.md b/markdown/bitburner.userinterfacetheme.info.md new file mode 100644 index 000000000..4a72fa673 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.info.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [info](./bitburner.userinterfacetheme.info.md) + +## UserInterfaceTheme.info property + +Signature: + +```typescript +info: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.infodark.md b/markdown/bitburner.userinterfacetheme.infodark.md new file mode 100644 index 000000000..68febe2b2 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.infodark.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [infodark](./bitburner.userinterfacetheme.infodark.md) + +## UserInterfaceTheme.infodark property + +Signature: + +```typescript +infodark: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.infolight.md b/markdown/bitburner.userinterfacetheme.infolight.md new file mode 100644 index 000000000..f8f8afd06 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.infolight.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [infolight](./bitburner.userinterfacetheme.infolight.md) + +## UserInterfaceTheme.infolight property + +Signature: + +```typescript +infolight: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.int.md b/markdown/bitburner.userinterfacetheme.int.md new file mode 100644 index 000000000..76d89b75f --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.int.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [int](./bitburner.userinterfacetheme.int.md) + +## UserInterfaceTheme.int property + +Signature: + +```typescript +int: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.md b/markdown/bitburner.userinterfacetheme.md new file mode 100644 index 000000000..984637705 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.md @@ -0,0 +1,52 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) + +## UserInterfaceTheme interface + +Interface Theme + +Signature: + +```typescript +interface UserInterfaceTheme +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [backgroundprimary](./bitburner.userinterfacetheme.backgroundprimary.md) | string | | +| [backgroundsecondary](./bitburner.userinterfacetheme.backgroundsecondary.md) | string | | +| [black](./bitburner.userinterfacetheme.black.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 | | +| [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.userinterfacetheme.money.md b/markdown/bitburner.userinterfacetheme.money.md new file mode 100644 index 000000000..549d8952f --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.money.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [money](./bitburner.userinterfacetheme.money.md) + +## UserInterfaceTheme.money property + +Signature: + +```typescript +money: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.primary.md b/markdown/bitburner.userinterfacetheme.primary.md new file mode 100644 index 000000000..8767ac550 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.primary.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [primary](./bitburner.userinterfacetheme.primary.md) + +## UserInterfaceTheme.primary property + +Signature: + +```typescript +primary: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.primarydark.md b/markdown/bitburner.userinterfacetheme.primarydark.md new file mode 100644 index 000000000..7a50626a2 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.primarydark.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [primarydark](./bitburner.userinterfacetheme.primarydark.md) + +## UserInterfaceTheme.primarydark property + +Signature: + +```typescript +primarydark: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.primarylight.md b/markdown/bitburner.userinterfacetheme.primarylight.md new file mode 100644 index 000000000..8cd07cb5a --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.primarylight.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [primarylight](./bitburner.userinterfacetheme.primarylight.md) + +## UserInterfaceTheme.primarylight property + +Signature: + +```typescript +primarylight: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.rep.md b/markdown/bitburner.userinterfacetheme.rep.md new file mode 100644 index 000000000..4a6c6f955 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.rep.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [rep](./bitburner.userinterfacetheme.rep.md) + +## UserInterfaceTheme.rep property + +Signature: + +```typescript +rep: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.secondary.md b/markdown/bitburner.userinterfacetheme.secondary.md new file mode 100644 index 000000000..2d439e361 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.secondary.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [secondary](./bitburner.userinterfacetheme.secondary.md) + +## UserInterfaceTheme.secondary property + +Signature: + +```typescript +secondary: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.secondarydark.md b/markdown/bitburner.userinterfacetheme.secondarydark.md new file mode 100644 index 000000000..52fa78a9f --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.secondarydark.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [secondarydark](./bitburner.userinterfacetheme.secondarydark.md) + +## UserInterfaceTheme.secondarydark property + +Signature: + +```typescript +secondarydark: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.secondarylight.md b/markdown/bitburner.userinterfacetheme.secondarylight.md new file mode 100644 index 000000000..9572e4af8 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.secondarylight.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [secondarylight](./bitburner.userinterfacetheme.secondarylight.md) + +## UserInterfaceTheme.secondarylight property + +Signature: + +```typescript +secondarylight: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.success.md b/markdown/bitburner.userinterfacetheme.success.md new file mode 100644 index 000000000..3d26d4eeb --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.success.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [success](./bitburner.userinterfacetheme.success.md) + +## UserInterfaceTheme.success property + +Signature: + +```typescript +success: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.successdark.md b/markdown/bitburner.userinterfacetheme.successdark.md new file mode 100644 index 000000000..48501f620 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.successdark.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [successdark](./bitburner.userinterfacetheme.successdark.md) + +## UserInterfaceTheme.successdark property + +Signature: + +```typescript +successdark: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.successlight.md b/markdown/bitburner.userinterfacetheme.successlight.md new file mode 100644 index 000000000..c170e1c36 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.successlight.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [successlight](./bitburner.userinterfacetheme.successlight.md) + +## UserInterfaceTheme.successlight property + +Signature: + +```typescript +successlight: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.warning.md b/markdown/bitburner.userinterfacetheme.warning.md new file mode 100644 index 000000000..40d2c7391 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.warning.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [warning](./bitburner.userinterfacetheme.warning.md) + +## UserInterfaceTheme.warning property + +Signature: + +```typescript +warning: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.warningdark.md b/markdown/bitburner.userinterfacetheme.warningdark.md new file mode 100644 index 000000000..9942c4130 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.warningdark.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [warningdark](./bitburner.userinterfacetheme.warningdark.md) + +## UserInterfaceTheme.warningdark property + +Signature: + +```typescript +warningdark: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.warninglight.md b/markdown/bitburner.userinterfacetheme.warninglight.md new file mode 100644 index 000000000..ac142bd06 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.warninglight.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [warninglight](./bitburner.userinterfacetheme.warninglight.md) + +## UserInterfaceTheme.warninglight property + +Signature: + +```typescript +warninglight: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.well.md b/markdown/bitburner.userinterfacetheme.well.md new file mode 100644 index 000000000..77c4fd8a4 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.well.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [well](./bitburner.userinterfacetheme.well.md) + +## UserInterfaceTheme.well property + +Signature: + +```typescript +well: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.welllight.md b/markdown/bitburner.userinterfacetheme.welllight.md new file mode 100644 index 000000000..3b05a82b1 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.welllight.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [welllight](./bitburner.userinterfacetheme.welllight.md) + +## UserInterfaceTheme.welllight property + +Signature: + +```typescript +welllight: string; +``` diff --git a/markdown/bitburner.userinterfacetheme.white.md b/markdown/bitburner.userinterfacetheme.white.md new file mode 100644 index 000000000..ef7690856 --- /dev/null +++ b/markdown/bitburner.userinterfacetheme.white.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UserInterfaceTheme](./bitburner.userinterfacetheme.md) > [white](./bitburner.userinterfacetheme.white.md) + +## UserInterfaceTheme.white property + +Signature: + +```typescript +white: string; +``` diff --git a/markdown/bitburner.valuesfrom.md b/markdown/bitburner.valuesfrom.md new file mode 100644 index 000000000..6824cf501 --- /dev/null +++ b/markdown/bitburner.valuesfrom.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ValuesFrom](./bitburner.valuesfrom.md) + +## ValuesFrom type + + +Signature: + +```typescript +export type ValuesFrom = T[keyof T]; +``` diff --git a/markdown/bitburner.warehouse.level.md b/markdown/bitburner.warehouse.level.md new file mode 100644 index 000000000..6731abb55 --- /dev/null +++ b/markdown/bitburner.warehouse.level.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Warehouse](./bitburner.warehouse.md) > [level](./bitburner.warehouse.level.md) + +## Warehouse.level property + +Amount of size upgrade bought + +Signature: + +```typescript +level: number; +``` diff --git a/markdown/bitburner.warehouse.loc.md b/markdown/bitburner.warehouse.loc.md new file mode 100644 index 000000000..1985da2f3 --- /dev/null +++ b/markdown/bitburner.warehouse.loc.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Warehouse](./bitburner.warehouse.md) > [loc](./bitburner.warehouse.loc.md) + +## Warehouse.loc property + +City in which the warehouse is located + +Signature: + +```typescript +loc: string; +``` diff --git a/markdown/bitburner.warehouse.md b/markdown/bitburner.warehouse.md new file mode 100644 index 000000000..f2248aa39 --- /dev/null +++ b/markdown/bitburner.warehouse.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Warehouse](./bitburner.warehouse.md) + +## Warehouse interface + +Warehouse for a division in a city + +Signature: + +```typescript +interface Warehouse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [level](./bitburner.warehouse.level.md) | number | Amount of size upgrade bought | +| [loc](./bitburner.warehouse.loc.md) | string | City in which the warehouse is located | +| [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.warehouse.size.md b/markdown/bitburner.warehouse.size.md new file mode 100644 index 000000000..c9c22962b --- /dev/null +++ b/markdown/bitburner.warehouse.size.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Warehouse](./bitburner.warehouse.md) > [size](./bitburner.warehouse.size.md) + +## Warehouse.size property + +Total space in the warehouse + +Signature: + +```typescript +size: number; +``` diff --git a/markdown/bitburner.warehouse.sizeused.md b/markdown/bitburner.warehouse.sizeused.md new file mode 100644 index 000000000..7a540be52 --- /dev/null +++ b/markdown/bitburner.warehouse.sizeused.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Warehouse](./bitburner.warehouse.md) > [sizeUsed](./bitburner.warehouse.sizeused.md) + +## Warehouse.sizeUsed property + +Used space in the warehouse + +Signature: + +```typescript +sizeUsed: number; +``` diff --git a/markdown/bitburner.warehouse.smartsupplyenabled.md b/markdown/bitburner.warehouse.smartsupplyenabled.md new file mode 100644 index 000000000..e95f75388 --- /dev/null +++ b/markdown/bitburner.warehouse.smartsupplyenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Warehouse](./bitburner.warehouse.md) > [smartSupplyEnabled](./bitburner.warehouse.smartsupplyenabled.md) + +## Warehouse.smartSupplyEnabled property + +Smart Supply status in the warehouse + +Signature: + +```typescript +smartSupplyEnabled: boolean; +``` diff --git a/markdown/bitburner.warehouseapi.bulkpurchase.md b/markdown/bitburner.warehouseapi.bulkpurchase.md new file mode 100644 index 000000000..3f55a3cac --- /dev/null +++ b/markdown/bitburner.warehouseapi.bulkpurchase.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [bulkPurchase](./bitburner.warehouseapi.bulkpurchase.md) + +## WarehouseAPI.bulkPurchase() method + +Set material to bulk buy + +Signature: + +```typescript +bulkPurchase(divisionName: string, cityName: string, materialName: string, amt: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| materialName | string | Name of the material | +| amt | number | Amount of material to buy | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.buymaterial.md b/markdown/bitburner.warehouseapi.buymaterial.md new file mode 100644 index 000000000..e11506cae --- /dev/null +++ b/markdown/bitburner.warehouseapi.buymaterial.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [buyMaterial](./bitburner.warehouseapi.buymaterial.md) + +## WarehouseAPI.buyMaterial() method + +Set material buy data + +Signature: + +```typescript +buyMaterial(divisionName: string, cityName: string, materialName: string, amt: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| materialName | string | Name of the material | +| amt | number | Amount of material to buy | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.cancelexportmaterial.md b/markdown/bitburner.warehouseapi.cancelexportmaterial.md new file mode 100644 index 000000000..344740dc9 --- /dev/null +++ b/markdown/bitburner.warehouseapi.cancelexportmaterial.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [cancelExportMaterial](./bitburner.warehouseapi.cancelexportmaterial.md) + +## WarehouseAPI.cancelExportMaterial() method + +Cancel material export + +Signature: + +```typescript +cancelExportMaterial( + sourceDivision: string, + sourceCity: string, + targetDivision: string, + targetCity: string, + materialName: string, + amt: number, + ): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sourceDivision | string | Source division | +| sourceCity | string | Source city | +| targetDivision | string | Target division | +| targetCity | string | Target city | +| materialName | string | Name of the material | +| amt | number | Amount of material to export. | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.discontinueproduct.md b/markdown/bitburner.warehouseapi.discontinueproduct.md new file mode 100644 index 000000000..86c1689cb --- /dev/null +++ b/markdown/bitburner.warehouseapi.discontinueproduct.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [discontinueProduct](./bitburner.warehouseapi.discontinueproduct.md) + +## WarehouseAPI.discontinueProduct() method + +Discontinue a product. + +Signature: + +```typescript +discontinueProduct(divisionName: string, productName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| productName | string | Name of the product | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.exportmaterial.md b/markdown/bitburner.warehouseapi.exportmaterial.md new file mode 100644 index 000000000..7fae1f948 --- /dev/null +++ b/markdown/bitburner.warehouseapi.exportmaterial.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [exportMaterial](./bitburner.warehouseapi.exportmaterial.md) + +## WarehouseAPI.exportMaterial() method + +Set material export data + +Signature: + +```typescript +exportMaterial( + sourceDivision: string, + sourceCity: string, + targetDivision: string, + targetCity: string, + materialName: string, + amt: number, + ): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sourceDivision | string | Source division | +| sourceCity | string | Source city | +| targetDivision | string | Target division | +| targetCity | string | Target city | +| materialName | string | Name of the material | +| amt | number | Amount of material to export. | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.getmaterial.md b/markdown/bitburner.warehouseapi.getmaterial.md new file mode 100644 index 000000000..4aa393c22 --- /dev/null +++ b/markdown/bitburner.warehouseapi.getmaterial.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [getMaterial](./bitburner.warehouseapi.getmaterial.md) + +## WarehouseAPI.getMaterial() method + +Get material data + +Signature: + +```typescript +getMaterial(divisionName: string, cityName: string, materialName: string): Material; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | | +| materialName | string | Name of the material | + +Returns: + +[Material](./bitburner.material.md) + +material data + diff --git a/markdown/bitburner.warehouseapi.getproduct.md b/markdown/bitburner.warehouseapi.getproduct.md new file mode 100644 index 000000000..fbbd68d69 --- /dev/null +++ b/markdown/bitburner.warehouseapi.getproduct.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [getProduct](./bitburner.warehouseapi.getproduct.md) + +## WarehouseAPI.getProduct() method + +Get product data + +Signature: + +```typescript +getProduct(divisionName: string, productName: string): Product; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| productName | string | Name of the product | + +Returns: + +[Product](./bitburner.product.md) + +product data + diff --git a/markdown/bitburner.warehouseapi.getpurchasewarehousecost.md b/markdown/bitburner.warehouseapi.getpurchasewarehousecost.md new file mode 100644 index 000000000..e8fbc61d0 --- /dev/null +++ b/markdown/bitburner.warehouseapi.getpurchasewarehousecost.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [getPurchaseWarehouseCost](./bitburner.warehouseapi.getpurchasewarehousecost.md) + +## WarehouseAPI.getPurchaseWarehouseCost() method + +Gets the cost to purchase a warehouse + +Signature: + +```typescript +getPurchaseWarehouseCost(): number; +``` +Returns: + +number + +cost + diff --git a/markdown/bitburner.warehouseapi.getupgradewarehousecost.md b/markdown/bitburner.warehouseapi.getupgradewarehousecost.md new file mode 100644 index 000000000..131013517 --- /dev/null +++ b/markdown/bitburner.warehouseapi.getupgradewarehousecost.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [getUpgradeWarehouseCost](./bitburner.warehouseapi.getupgradewarehousecost.md) + +## WarehouseAPI.getUpgradeWarehouseCost() method + +Gets the cost to upgrade a warehouse to the next level + +Signature: + +```typescript +getUpgradeWarehouseCost(adivisionName: string, acityName: string, amt?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| adivisionName | string | | +| acityName | string | | +| amt | number | amount of upgrades defaults to 1 | + +Returns: + +number + +cost to upgrade + diff --git a/markdown/bitburner.warehouseapi.getwarehouse.md b/markdown/bitburner.warehouseapi.getwarehouse.md new file mode 100644 index 000000000..de2373f7e --- /dev/null +++ b/markdown/bitburner.warehouseapi.getwarehouse.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [getWarehouse](./bitburner.warehouseapi.getwarehouse.md) + +## WarehouseAPI.getWarehouse() method + +Get warehouse data + +Signature: + +```typescript +getWarehouse(divisionName: string, cityName: string): Warehouse; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | + +Returns: + +[Warehouse](./bitburner.warehouse.md) + +warehouse data + diff --git a/markdown/bitburner.warehouseapi.haswarehouse.md b/markdown/bitburner.warehouseapi.haswarehouse.md new file mode 100644 index 000000000..653d8f61e --- /dev/null +++ b/markdown/bitburner.warehouseapi.haswarehouse.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [hasWarehouse](./bitburner.warehouseapi.haswarehouse.md) + +## WarehouseAPI.hasWarehouse() method + +Check if you have a warehouse in city + +Signature: + +```typescript +hasWarehouse(adivisionName: string, acityName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| adivisionName | string | | +| acityName | string | | + +Returns: + +boolean + +true if warehouse is present, false if not + diff --git a/markdown/bitburner.warehouseapi.limitmaterialproduction.md b/markdown/bitburner.warehouseapi.limitmaterialproduction.md new file mode 100644 index 000000000..5ad98daac --- /dev/null +++ b/markdown/bitburner.warehouseapi.limitmaterialproduction.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [limitMaterialProduction](./bitburner.warehouseapi.limitmaterialproduction.md) + +## WarehouseAPI.limitMaterialProduction() method + +Limit Material Production. + +Signature: + +```typescript +limitMaterialProduction(divisionName: string, cityName: string, materialName: string, qty: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| materialName | string | Name of the material | +| qty | number | Amount to limit to | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.limitproductproduction.md b/markdown/bitburner.warehouseapi.limitproductproduction.md new file mode 100644 index 000000000..517e53eec --- /dev/null +++ b/markdown/bitburner.warehouseapi.limitproductproduction.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [limitProductProduction](./bitburner.warehouseapi.limitproductproduction.md) + +## WarehouseAPI.limitProductProduction() method + +Limit Product Production. + +Signature: + +```typescript +limitProductProduction(divisionName: string, cityName: string, productName: string, qty: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| productName | string | Name of the product | +| qty | number | Amount to limit to | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.makeproduct.md b/markdown/bitburner.warehouseapi.makeproduct.md new file mode 100644 index 000000000..b279ffdce --- /dev/null +++ b/markdown/bitburner.warehouseapi.makeproduct.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [makeProduct](./bitburner.warehouseapi.makeproduct.md) + +## WarehouseAPI.makeProduct() method + +Create a new product + +Signature: + +```typescript +makeProduct( + divisionName: string, + cityName: string, + productName: string, + designInvest: number, + marketingInvest: number, + ): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | 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: + +void + diff --git a/markdown/bitburner.warehouseapi.md b/markdown/bitburner.warehouseapi.md new file mode 100644 index 000000000..47131265b --- /dev/null +++ b/markdown/bitburner.warehouseapi.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) + +## WarehouseAPI interface + +Corporation Warehouse API + +Signature: + +```typescript +export interface WarehouseAPI +``` + +## Remarks + +Requires the Warehouse API upgrade from your corporation. + +## Methods + +| Method | Description | +| --- | --- | +| [bulkPurchase(divisionName, cityName, materialName, amt)](./bitburner.warehouseapi.bulkpurchase.md) | Set material to bulk buy | +| [buyMaterial(divisionName, cityName, materialName, amt)](./bitburner.warehouseapi.buymaterial.md) | Set material buy data | +| [cancelExportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./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, cityName, materialName)](./bitburner.warehouseapi.getmaterial.md) | Get material data | +| [getProduct(divisionName, productName)](./bitburner.warehouseapi.getproduct.md) | Get product data | +| [getPurchaseWarehouseCost()](./bitburner.warehouseapi.getpurchasewarehousecost.md) | Gets the cost to purchase a warehouse | +| [getUpgradeWarehouseCost(adivisionName, acityName, amt)](./bitburner.warehouseapi.getupgradewarehousecost.md) | Gets the cost to upgrade a warehouse to the next level | +| [getWarehouse(divisionName, cityName)](./bitburner.warehouseapi.getwarehouse.md) | Get warehouse data | +| [hasWarehouse(adivisionName, acityName)](./bitburner.warehouseapi.haswarehouse.md) | Check if you have a warehouse in city | +| [limitMaterialProduction(divisionName, cityName, materialName, qty)](./bitburner.warehouseapi.limitmaterialproduction.md) | Limit Material Production. | +| [limitProductProduction(divisionName, cityName, productName, qty)](./bitburner.warehouseapi.limitproductproduction.md) | Limit Product Production. | +| [makeProduct(divisionName, cityName, productName, designInvest, marketingInvest)](./bitburner.warehouseapi.makeproduct.md) | Create a new product | +| [purchaseWarehouse(divisionName, cityName)](./bitburner.warehouseapi.purchasewarehouse.md) | Purchase warehouse for a new city | +| [sellMaterial(divisionName, cityName, materialName, amt, price)](./bitburner.warehouseapi.sellmaterial.md) | Set material sell data. | +| [sellProduct(divisionName, cityName, productName, amt, price, all)](./bitburner.warehouseapi.sellproduct.md) | Set product sell data. | +| [setMaterialMarketTA1(divisionName, cityName, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta1.md) | Set market TA 1 for a material. | +| [setMaterialMarketTA2(divisionName, cityName, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta2.md) | Set market TA 2 for a material. | +| [setProductMarketTA1(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta1.md) | Set market TA 1 for a product. | +| [setProductMarketTA2(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta2.md) | Set market TA 2 for a product. | +| [setSmartSupply(divisionName, cityName, enabled)](./bitburner.warehouseapi.setsmartsupply.md) | Set smart supply | +| [setSmartSupplyUseLeftovers(divisionName, cityName, materialName, enabled)](./bitburner.warehouseapi.setsmartsupplyuseleftovers.md) | Set whether smart supply uses leftovers before buying | +| [upgradeWarehouse(divisionName, cityName, amt)](./bitburner.warehouseapi.upgradewarehouse.md) | Upgrade warehouse | + diff --git a/markdown/bitburner.warehouseapi.purchasewarehouse.md b/markdown/bitburner.warehouseapi.purchasewarehouse.md new file mode 100644 index 000000000..57642376f --- /dev/null +++ b/markdown/bitburner.warehouseapi.purchasewarehouse.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [purchaseWarehouse](./bitburner.warehouseapi.purchasewarehouse.md) + +## WarehouseAPI.purchaseWarehouse() method + +Purchase warehouse for a new city + +Signature: + +```typescript +purchaseWarehouse(divisionName: string, cityName: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.sellmaterial.md b/markdown/bitburner.warehouseapi.sellmaterial.md new file mode 100644 index 000000000..3595cf80d --- /dev/null +++ b/markdown/bitburner.warehouseapi.sellmaterial.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [sellMaterial](./bitburner.warehouseapi.sellmaterial.md) + +## WarehouseAPI.sellMaterial() method + +Set material sell data. + +Signature: + +```typescript +sellMaterial(divisionName: string, cityName: string, materialName: string, amt: string, price: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| materialName | string | Name of the material | +| amt | string | Amount to sell, can be "MAX" | +| price | string | Price to sell, can be "MP" | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.sellproduct.md b/markdown/bitburner.warehouseapi.sellproduct.md new file mode 100644 index 000000000..a5a5e7fff --- /dev/null +++ b/markdown/bitburner.warehouseapi.sellproduct.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [sellProduct](./bitburner.warehouseapi.sellproduct.md) + +## WarehouseAPI.sellProduct() method + +Set product sell data. + +Signature: + +```typescript +sellProduct( + divisionName: string, + cityName: string, + productName: string, + amt: string, + price: string, + all: boolean, + ): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | 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 | Sell in all city | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.setmaterialmarketta1.md b/markdown/bitburner.warehouseapi.setmaterialmarketta1.md new file mode 100644 index 000000000..0016fb239 --- /dev/null +++ b/markdown/bitburner.warehouseapi.setmaterialmarketta1.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [setMaterialMarketTA1](./bitburner.warehouseapi.setmaterialmarketta1.md) + +## WarehouseAPI.setMaterialMarketTA1() method + +Set market TA 1 for a material. + +Signature: + +```typescript +setMaterialMarketTA1(divisionName: string, cityName: string, materialName: string, on: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| materialName | string | Name of the material | +| on | boolean | market ta enabled | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.setmaterialmarketta2.md b/markdown/bitburner.warehouseapi.setmaterialmarketta2.md new file mode 100644 index 000000000..aed035e71 --- /dev/null +++ b/markdown/bitburner.warehouseapi.setmaterialmarketta2.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [setMaterialMarketTA2](./bitburner.warehouseapi.setmaterialmarketta2.md) + +## WarehouseAPI.setMaterialMarketTA2() method + +Set market TA 2 for a material. + +Signature: + +```typescript +setMaterialMarketTA2(divisionName: string, cityName: string, materialName: string, on: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| materialName | string | Name of the material | +| on | boolean | market ta enabled | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.setproductmarketta1.md b/markdown/bitburner.warehouseapi.setproductmarketta1.md new file mode 100644 index 000000000..79be65bf2 --- /dev/null +++ b/markdown/bitburner.warehouseapi.setproductmarketta1.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [setProductMarketTA1](./bitburner.warehouseapi.setproductmarketta1.md) + +## WarehouseAPI.setProductMarketTA1() method + +Set market TA 1 for a product. + +Signature: + +```typescript +setProductMarketTA1(divisionName: string, productName: string, on: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| productName | string | Name of the product | +| on | boolean | market ta enabled | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.setproductmarketta2.md b/markdown/bitburner.warehouseapi.setproductmarketta2.md new file mode 100644 index 000000000..c278671c0 --- /dev/null +++ b/markdown/bitburner.warehouseapi.setproductmarketta2.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [setProductMarketTA2](./bitburner.warehouseapi.setproductmarketta2.md) + +## WarehouseAPI.setProductMarketTA2() method + +Set market TA 2 for a product. + +Signature: + +```typescript +setProductMarketTA2(divisionName: string, productName: string, on: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| productName | string | Name of the product | +| on | boolean | market ta enabled | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.setsmartsupply.md b/markdown/bitburner.warehouseapi.setsmartsupply.md new file mode 100644 index 000000000..3c34c18d1 --- /dev/null +++ b/markdown/bitburner.warehouseapi.setsmartsupply.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [setSmartSupply](./bitburner.warehouseapi.setsmartsupply.md) + +## WarehouseAPI.setSmartSupply() method + +Set smart supply + +Signature: + +```typescript +setSmartSupply(divisionName: string, cityName: string, enabled: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| enabled | boolean | smart supply enabled | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md b/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md new file mode 100644 index 000000000..b1c00312c --- /dev/null +++ b/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [setSmartSupplyUseLeftovers](./bitburner.warehouseapi.setsmartsupplyuseleftovers.md) + +## WarehouseAPI.setSmartSupplyUseLeftovers() method + +Set whether smart supply uses leftovers before buying + +Signature: + +```typescript +setSmartSupplyUseLeftovers(divisionName: string, cityName: string, materialName: string, enabled: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| materialName | string | Name of the material | +| enabled | boolean | smart supply use leftovers enabled | + +Returns: + +void + diff --git a/markdown/bitburner.warehouseapi.upgradewarehouse.md b/markdown/bitburner.warehouseapi.upgradewarehouse.md new file mode 100644 index 000000000..cd6d59c2b --- /dev/null +++ b/markdown/bitburner.warehouseapi.upgradewarehouse.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [upgradeWarehouse](./bitburner.warehouseapi.upgradewarehouse.md) + +## WarehouseAPI.upgradeWarehouse() method + +Upgrade warehouse + +Signature: + +```typescript +upgradeWarehouse(divisionName: string, cityName: string, amt?: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| amt | number | amount of upgrades defaults to 1 | + +Returns: + +void + diff --git a/markdown/bitburner.workformulas.classgains.md b/markdown/bitburner.workformulas.classgains.md new file mode 100644 index 000000000..d75920601 --- /dev/null +++ b/markdown/bitburner.workformulas.classgains.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkFormulas](./bitburner.workformulas.md) > [classGains](./bitburner.workformulas.classgains.md) + +## WorkFormulas.classGains() method + +Signature: + +```typescript +classGains(player: Player, classType: string, locationName: string): WorkStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| player | [Player](./bitburner.player.md) | | +| classType | string | | +| locationName | string | | + +Returns: + +[WorkStats](./bitburner.workstats.md) + diff --git a/markdown/bitburner.workformulas.crimegains.md b/markdown/bitburner.workformulas.crimegains.md new file mode 100644 index 000000000..91487d0a8 --- /dev/null +++ b/markdown/bitburner.workformulas.crimegains.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkFormulas](./bitburner.workformulas.md) > [crimeGains](./bitburner.workformulas.crimegains.md) + +## WorkFormulas.crimeGains() method + +Signature: + +```typescript +crimeGains(crimeType: string): WorkStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| crimeType | string | | + +Returns: + +[WorkStats](./bitburner.workstats.md) + diff --git a/markdown/bitburner.workformulas.factiongains.md b/markdown/bitburner.workformulas.factiongains.md new file mode 100644 index 000000000..e8d6b5703 --- /dev/null +++ b/markdown/bitburner.workformulas.factiongains.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkFormulas](./bitburner.workformulas.md) > [factionGains](./bitburner.workformulas.factiongains.md) + +## WorkFormulas.factionGains() method + +Signature: + +```typescript +factionGains(player: Player, workType: string, favor: number): WorkStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| player | [Player](./bitburner.player.md) | | +| workType | string | | +| favor | number | | + +Returns: + +[WorkStats](./bitburner.workstats.md) + diff --git a/markdown/bitburner.workformulas.md b/markdown/bitburner.workformulas.md new file mode 100644 index 000000000..f1eaa6d07 --- /dev/null +++ b/markdown/bitburner.workformulas.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkFormulas](./bitburner.workformulas.md) + +## WorkFormulas interface + +Work formulas + +Signature: + +```typescript +interface WorkFormulas +``` + +## Methods + +| Method | Description | +| --- | --- | +| [classGains(player, classType, locationName)](./bitburner.workformulas.classgains.md) | | +| [crimeGains(crimeType)](./bitburner.workformulas.crimegains.md) | | +| [factionGains(player, workType, favor)](./bitburner.workformulas.factiongains.md) | | + diff --git a/markdown/bitburner.workstats.agiexp.md b/markdown/bitburner.workstats.agiexp.md new file mode 100644 index 000000000..ba80aa014 --- /dev/null +++ b/markdown/bitburner.workstats.agiexp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [agiExp](./bitburner.workstats.agiexp.md) + +## WorkStats.agiExp property + +Signature: + +```typescript +agiExp: number; +``` diff --git a/markdown/bitburner.workstats.chaexp.md b/markdown/bitburner.workstats.chaexp.md new file mode 100644 index 000000000..4c5a069c0 --- /dev/null +++ b/markdown/bitburner.workstats.chaexp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [chaExp](./bitburner.workstats.chaexp.md) + +## WorkStats.chaExp property + +Signature: + +```typescript +chaExp: number; +``` diff --git a/markdown/bitburner.workstats.defexp.md b/markdown/bitburner.workstats.defexp.md new file mode 100644 index 000000000..7f59581f7 --- /dev/null +++ b/markdown/bitburner.workstats.defexp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [defExp](./bitburner.workstats.defexp.md) + +## WorkStats.defExp property + +Signature: + +```typescript +defExp: number; +``` diff --git a/markdown/bitburner.workstats.dexexp.md b/markdown/bitburner.workstats.dexexp.md new file mode 100644 index 000000000..13e6a05e5 --- /dev/null +++ b/markdown/bitburner.workstats.dexexp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [dexExp](./bitburner.workstats.dexexp.md) + +## WorkStats.dexExp property + +Signature: + +```typescript +dexExp: number; +``` diff --git a/markdown/bitburner.workstats.hackexp.md b/markdown/bitburner.workstats.hackexp.md new file mode 100644 index 000000000..90be2da13 --- /dev/null +++ b/markdown/bitburner.workstats.hackexp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [hackExp](./bitburner.workstats.hackexp.md) + +## WorkStats.hackExp property + +Signature: + +```typescript +hackExp: number; +``` diff --git a/markdown/bitburner.workstats.intexp.md b/markdown/bitburner.workstats.intexp.md new file mode 100644 index 000000000..75cdd9827 --- /dev/null +++ b/markdown/bitburner.workstats.intexp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [intExp](./bitburner.workstats.intexp.md) + +## WorkStats.intExp property + +Signature: + +```typescript +intExp: number; +``` diff --git a/markdown/bitburner.workstats.md b/markdown/bitburner.workstats.md new file mode 100644 index 000000000..40d9f7d56 --- /dev/null +++ b/markdown/bitburner.workstats.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) + +## WorkStats interface + + +Signature: + +```typescript +export interface WorkStats +``` + +## Properties + +| Property | 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/bitburner.workstats.money.md b/markdown/bitburner.workstats.money.md new file mode 100644 index 000000000..8e3a44b42 --- /dev/null +++ b/markdown/bitburner.workstats.money.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [money](./bitburner.workstats.money.md) + +## WorkStats.money property + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.workstats.reputation.md b/markdown/bitburner.workstats.reputation.md new file mode 100644 index 000000000..a39fb3ea9 --- /dev/null +++ b/markdown/bitburner.workstats.reputation.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [reputation](./bitburner.workstats.reputation.md) + +## WorkStats.reputation property + +Signature: + +```typescript +reputation: number; +``` diff --git a/markdown/bitburner.workstats.strexp.md b/markdown/bitburner.workstats.strexp.md new file mode 100644 index 000000000..de3254e40 --- /dev/null +++ b/markdown/bitburner.workstats.strexp.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WorkStats](./bitburner.workstats.md) > [strExp](./bitburner.workstats.strexp.md) + +## WorkStats.strExp property + +Signature: + +```typescript +strExp: number; +``` diff --git a/markdown/index.md b/markdown/index.md new file mode 100644 index 000000000..b6bea5e27 --- /dev/null +++ b/markdown/index.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [bitburner](./bitburner.md) | | +