Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-08 08:43:53 +01:00
Code Issues Packages Projects Releases Wiki Activity

VARIOUS: Various changes prior to release 2.2 (#271)

Browse Source 
See PR #271 description
This commit is contained in:
Snarling 2022-12-29 20:28:53 -05:00 committed by GitHub
parent 24ad342203
commit fb1f95c26e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
310 changed files with 3768 additions and 2583 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.prettierignore
View File

@ -13,3 +13,4 @@ markdown
package.json
package.lock.json
tsdoc-metadata.json

648
dist/bitburner.d.ts vendored
View File

File diff suppressed because it is too large Load Diff

1
jest.config.js
View File

@ -11,5 +11,6 @@ module.exports = {
"\\.(css|less)$": "<rootDir>/test/__mocks__/styleMock.js",
"\\!!raw-loader!.*$": "<rootDir>/test/__mocks__/rawLoader.js",
"@player": "<rootDir>/src/Player",
"@nsdefs": "<rootDir>/src/ScriptEditor/NetscriptDefinitions",
},
};

4
markdown/bitburner.bladeburner.getcity.md
View File

@ -9,11 +9,11 @@ Get current city.
<b>Signature:</b>
```typescript
getCity(): string;
getCity(): CityName;
```
<b>Returns:</b>
string
[CityName](./bitburner.cityname.md)
City that the player is currently in (for Bladeburner).

4
markdown/bitburner.bladeburner.getcitychaos.md
View File

@ -9,14 +9,14 @@ Get chaos of a city.
<b>Signature:</b>
```typescript
getCityChaos(name: string): number;
getCityChaos(city: CityName | `${CityName}`): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of city. Case-sensitive |
<b>Returns:</b>

4
markdown/bitburner.bladeburner.getcitycommunities.md
View File

@ -9,14 +9,14 @@ Get number of communities in a city.
<b>Signature:</b>
```typescript
getCityCommunities(name: string): number;
getCityCommunities(city: CityName | `${CityName}`): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of city. Case-sensitive |
<b>Returns:</b>

4
markdown/bitburner.bladeburner.getcityestimatedpopulation.md
View File

@ -9,14 +9,14 @@ Get estimated population in city.
<b>Signature:</b>
```typescript
getCityEstimatedPopulation(name: string): number;
getCityEstimatedPopulation(city: CityName | `${CityName}`): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of city. Case-sensitive |
<b>Returns:</b>

8
markdown/bitburner.bladeburner.md
View File

@ -32,9 +32,9 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [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. |
| [getCityChaos(city)](./bitburner.bladeburner.getcitychaos.md) | Get chaos of a city. |
| [getCityCommunities(city)](./bitburner.bladeburner.getcitycommunities.md) | Get number of communities in a city. |
| [getCityEstimatedPopulation(city)](./bitburner.bladeburner.getcityestimatedpopulation.md) | Get estimated population in city. |
| [getContractNames()](./bitburner.bladeburner.getcontractnames.md) | List all contracts. |
| [getCurrentAction()](./bitburner.bladeburner.getcurrentaction.md) | Get current action. |
| [getGeneralActionNames()](./bitburner.bladeburner.getgeneralactionnames.md) | List all general actions. |
@ -54,6 +54,6 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [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. |
| [switchCity(city)](./bitburner.bladeburner.switchcity.md) | Travel to another city in bladeburner. |
| [upgradeSkill(name, count)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. |

4
markdown/bitburner.bladeburner.switchcity.md
View File

@ -9,14 +9,14 @@ Travel to another city in bladeburner.
<b>Signature:</b>
```typescript
switchCity(name: string): boolean;
switchCity(city: CityName | `${CityName}`): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | string | |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of city. Case-sensitive |
<b>Returns:</b>

25
markdown/bitburner.cityname.md Normal file
View File

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CityName](./bitburner.cityname.md)
## CityName enum
Names of all cities
<b>Signature:</b>
```typescript
declare enum CityName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Aevum | <code>&quot;Aevum&quot;</code> | |
| Chongqing | <code>&quot;Chongqing&quot;</code> | |
| Ishima | <code>&quot;Ishima&quot;</code> | |
| NewTokyo | <code>&quot;New Tokyo&quot;</code> | |
| Sector12 | <code>&quot;Sector-12&quot;</code> | |
| Volhaven | <code>&quot;Volhaven&quot;</code> | |

56
markdown/bitburner.companyposname.md
View File

@ -1,56 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CompanyPosName](./bitburner.companyposname.md)
## CompanyPosName enum
<b>Signature:</b>
```typescript
declare enum CompanyPosName
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| agent0 | <code>&quot;Field Agent&quot;</code> | |
| agent1 | <code>&quot;Secret Agent&quot;</code> | |
| agent2 | <code>&quot;Special Operative&quot;</code> | |
| bus0 | <code>&quot;Business Intern&quot;</code> | |
| bus1 | <code>&quot;Business Analyst&quot;</code> | |
| bus2 | <code>&quot;Business Manager&quot;</code> | |
| bus3 | <code>&quot;Operations Manager&quot;</code> | |
| bus4 | <code>&quot;Chief Financial Officer&quot;</code> | |
| bus5 | <code>&quot;Chief Executive Officer&quot;</code> | |
| busCons0 | <code>&quot;Business Consultant&quot;</code> | |
| busCons1 | <code>&quot;Senior Business Consultant&quot;</code> | |
| employee | <code>&quot;Employee&quot;</code> | |
| employeePT | <code>&quot;Part-time Employee&quot;</code> | |
| IT0 | <code>&quot;IT Intern&quot;</code> | |
| IT1 | <code>&quot;IT Analyst&quot;</code> | |
| IT2 | <code>&quot;IT Manager&quot;</code> | |
| IT3 | <code>&quot;Systems Administrator&quot;</code> | |
| netEng0 | <code>&quot;Network Engineer&quot;</code> | |
| netEng1 | <code>&quot;Network Administrator&quot;</code> | |
| sec0 | <code>&quot;Police Officer&quot;</code> | |
| sec1 | <code>&quot;Police Chief&quot;</code> | |
| sec2 | <code>&quot;Security Guard&quot;</code> | |
| sec3 | <code>&quot;Security Officer&quot;</code> | |
| sec4 | <code>&quot;Security Supervisor&quot;</code> | |
| sec5 | <code>&quot;Head of Security&quot;</code> | |
| secEng | <code>&quot;Security Engineer&quot;</code> | |
| softCons0 | <code>&quot;Software Consultant&quot;</code> | |
| softCons1 | <code>&quot;Senior Software Consultant&quot;</code> | |
| sw0 | <code>&quot;Software Engineering Intern&quot;</code> | |
| sw1 | <code>&quot;Junior Software Engineer&quot;</code> | |
| sw2 | <code>&quot;Senior Software Engineer&quot;</code> | |
| sw3 | <code>&quot;Lead Software Developer&quot;</code> | |
| sw4 | <code>&quot;Head of Software&quot;</code> | |
| sw5 | <code>&quot;Head of Engineering&quot;</code> | |
| sw6 | <code>&quot;Vice President of Technology&quot;</code> | |
| sw7 | <code>&quot;Chief Technology Officer&quot;</code> | |
| waiter | <code>&quot;Waiter&quot;</code> | |
| waiterPT | <code>&quot;Part-time Waiter&quot;</code> | |

11
markdown/bitburner.corpconstants.baseproductprofitmult.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [baseProductProfitMult](./bitburner.corpconstants.baseproductprofitmult.md)
## CorpConstants.baseProductProfitMult property
<b>Signature:</b>
```typescript
baseProductProfitMult: number;
```

11
markdown/bitburner.corpconstants.bribeamountperreputation.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md)
## CorpConstants.bribeAmountPerReputation property
<b>Signature:</b>
```typescript
bribeAmountPerReputation: number;
```

11
markdown/bitburner.corpconstants.bribethreshold.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [bribeThreshold](./bitburner.corpconstants.bribethreshold.md)
## CorpConstants.bribeThreshold property
<b>Signature:</b>
```typescript
bribeThreshold: number;
```

11
markdown/bitburner.corpconstants.coffeecostperemployee.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [coffeeCostPerEmployee](./bitburner.corpconstants.coffeecostperemployee.md)
## CorpConstants.coffeeCostPerEmployee property
<b>Signature:</b>
```typescript
coffeeCostPerEmployee: number;
```

11
markdown/bitburner.corpconstants.dividendmaxrate.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [dividendMaxRate](./bitburner.corpconstants.dividendmaxrate.md)
## CorpConstants.dividendMaxRate property
<b>Signature:</b>
```typescript
dividendMaxRate: number;
```

11
markdown/bitburner.corpconstants.employeeraiseamount.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [employeeRaiseAmount](./bitburner.corpconstants.employeeraiseamount.md)
## CorpConstants.employeeRaiseAmount property
<b>Signature:</b>
```typescript
employeeRaiseAmount: number;
```

13
markdown/bitburner.corpconstants.employeesalarymultiplier.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md)
## CorpConstants.employeeSalaryMultiplier property
Conversion factor for employee stats to initial salary
<b>Signature:</b>
```typescript
employeeSalaryMultiplier: number;
```

11
markdown/bitburner.corpconstants.gamecyclespercorpstatecycle.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md)
## CorpConstants.gameCyclesPerCorpStateCycle property
<b>Signature:</b>
```typescript
gameCyclesPerCorpStateCycle: number;
```

11
markdown/bitburner.corpconstants.gamecyclespermarketcycle.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [gameCyclesPerMarketCycle](./bitburner.corpconstants.gamecyclespermarketcycle.md)
## CorpConstants.gameCyclesPerMarketCycle property
<b>Signature:</b>
```typescript
gameCyclesPerMarketCycle: number;
```

13
markdown/bitburner.corpconstants.industrynames.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [industryNames](./bitburner.corpconstants.industrynames.md)
## CorpConstants.industryNames property
Names of all industries
<b>Signature:</b>
```typescript
industryNames: CorpIndustryName[];
```

11
markdown/bitburner.corpconstants.initialshares.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [initialShares](./bitburner.corpconstants.initialshares.md)
## CorpConstants.initialShares property
<b>Signature:</b>
```typescript
initialShares: number;
```

13
markdown/bitburner.corpconstants.issuenewsharescooldown.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [issueNewSharesCooldown](./bitburner.corpconstants.issuenewsharescooldown.md)
## CorpConstants.issueNewSharesCooldown property
Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms)
<b>Signature:</b>
```typescript
issueNewSharesCooldown: number;
```

11
markdown/bitburner.corpconstants.marketcyclesperemployeeraise.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [marketCyclesPerEmployeeRaise](./bitburner.corpconstants.marketcyclesperemployeeraise.md)
## CorpConstants.marketCyclesPerEmployeeRaise property
<b>Signature:</b>
```typescript
marketCyclesPerEmployeeRaise: number;
```

13
markdown/bitburner.corpconstants.materialnames.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [materialNames](./bitburner.corpconstants.materialnames.md)
## CorpConstants.materialNames property
Names of all materials
<b>Signature:</b>
```typescript
materialNames: CorpMaterialName[];
```

13
markdown/bitburner.corpconstants.maxproductsbase.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [maxProductsBase](./bitburner.corpconstants.maxproductsbase.md)
## CorpConstants.maxProductsBase property
Max products for a division without upgrades
<b>Signature:</b>
```typescript
maxProductsBase: number;
```

49
markdown/bitburner.corpconstants.md Normal file
View File

@ -0,0 +1,49 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md)
## CorpConstants interface
Corporation related constants
<b>Signature:</b>
```typescript
interface CorpConstants
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [baseProductProfitMult](./bitburner.corpconstants.baseproductprofitmult.md) | number | |
| [bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md) | number | |
| [bribeThreshold](./bitburner.corpconstants.bribethreshold.md) | number | |
| [coffeeCostPerEmployee](./bitburner.corpconstants.coffeecostperemployee.md) | number | |
| [dividendMaxRate](./bitburner.corpconstants.dividendmaxrate.md) | number | |
| [employeeRaiseAmount](./bitburner.corpconstants.employeeraiseamount.md) | number | |
| [employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md) | number | Conversion factor for employee stats to initial salary |
| [gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md) | number | |
| [gameCyclesPerMarketCycle](./bitburner.corpconstants.gamecyclespermarketcycle.md) | number | |
| [industryNames](./bitburner.corpconstants.industrynames.md) | [CorpIndustryName](./bitburner.corpindustryname.md)<!-- -->\[\] | Names of all industries |
| [initialShares](./bitburner.corpconstants.initialshares.md) | number | |
| [issueNewSharesCooldown](./bitburner.corpconstants.issuenewsharescooldown.md) | number | Cooldown for issue new shares cooldown in game cycles (1 game cycle = 200ms) |
| [marketCyclesPerEmployeeRaise](./bitburner.corpconstants.marketcyclesperemployeeraise.md) | number | |
| [materialNames](./bitburner.corpconstants.materialnames.md) | [CorpMaterialName](./bitburner.corpmaterialname.md)<!-- -->\[\] | Names of all materials |
| [maxProductsBase](./bitburner.corpconstants.maxproductsbase.md) | number | Max products for a division without upgrades |
| [officeInitialCost](./bitburner.corpconstants.officeinitialcost.md) | number | |
| [officeInitialSize](./bitburner.corpconstants.officeinitialsize.md) | number | |
| [officeSizeUpgradeCostBase](./bitburner.corpconstants.officesizeupgradecostbase.md) | number | |
| [researchNames](./bitburner.corpconstants.researchnames.md) | [CorpResearchName](./bitburner.corpresearchname.md)<!-- -->\[\] | Names of all researches |
| [researchNamesBase](./bitburner.corpconstants.researchnamesbase.md) | [CorpResearchName](./bitburner.corpresearchname.md)<!-- -->\[\] | Names of all researches common to all industries |
| [researchNamesProductOnly](./bitburner.corpconstants.researchnamesproductonly.md) | [CorpResearchName](./bitburner.corpresearchname.md)<!-- -->\[\] | Names of all researches only available to product industries |
| [secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md) | number | |
| [sellSharesCooldown](./bitburner.corpconstants.sellsharescooldown.md) | number | Cooldown for selling shares in game cycles (1 game cycle = 200ms) |
| [sharesPerPriceUpdate](./bitburner.corpconstants.sharesperpriceupdate.md) | number | When selling large number of shares, price is dynamically updated for every batch of this amount |
| [stateNames](./bitburner.corpconstants.statenames.md) | [CorpStateName](./bitburner.corpstatename.md)<!-- -->\[\] | Names of all corporation game states |
| [unlockNames](./bitburner.corpconstants.unlocknames.md) | [CorpUnlockName](./bitburner.corpunlockname.md)<!-- -->\[\] | Names of all one-time corporation-wide unlocks |
| [upgradeNames](./bitburner.corpconstants.upgradenames.md) | [CorpUpgradeName](./bitburner.corpupgradename.md)<!-- -->\[\] | Names of all corporation-wide upgrades |
| [warehouseInitialCost](./bitburner.corpconstants.warehouseinitialcost.md) | number | |
| [warehouseInitialSize](./bitburner.corpconstants.warehouseinitialsize.md) | number | |
| [warehouseSizeUpgradeCostBase](./bitburner.corpconstants.warehousesizeupgradecostbase.md) | number | |

11
markdown/bitburner.corpconstants.officeinitialcost.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [officeInitialCost](./bitburner.corpconstants.officeinitialcost.md)
## CorpConstants.officeInitialCost property
<b>Signature:</b>
```typescript
officeInitialCost: number;
```

11
markdown/bitburner.corpconstants.officeinitialsize.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [officeInitialSize](./bitburner.corpconstants.officeinitialsize.md)
## CorpConstants.officeInitialSize property
<b>Signature:</b>
```typescript
officeInitialSize: number;
```

11
markdown/bitburner.corpconstants.officesizeupgradecostbase.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [officeSizeUpgradeCostBase](./bitburner.corpconstants.officesizeupgradecostbase.md)
## CorpConstants.officeSizeUpgradeCostBase property
<b>Signature:</b>
```typescript
officeSizeUpgradeCostBase: number;
```

13
markdown/bitburner.corpconstants.researchnames.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [researchNames](./bitburner.corpconstants.researchnames.md)
## CorpConstants.researchNames property
Names of all researches
<b>Signature:</b>
```typescript
researchNames: CorpResearchName[];
```

13
markdown/bitburner.corpconstants.researchnamesbase.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [researchNamesBase](./bitburner.corpconstants.researchnamesbase.md)
## CorpConstants.researchNamesBase property
Names of all researches common to all industries
<b>Signature:</b>
```typescript
researchNamesBase: CorpResearchName[];
```

13
markdown/bitburner.corpconstants.researchnamesproductonly.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [researchNamesProductOnly](./bitburner.corpconstants.researchnamesproductonly.md)
## CorpConstants.researchNamesProductOnly property
Names of all researches only available to product industries
<b>Signature:</b>
```typescript
researchNamesProductOnly: CorpResearchName[];
```

11
markdown/bitburner.corpconstants.secondspermarketcycle.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md)
## CorpConstants.secondsPerMarketCycle property
<b>Signature:</b>
```typescript
secondsPerMarketCycle: number;
```

13
markdown/bitburner.corpconstants.sellsharescooldown.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [sellSharesCooldown](./bitburner.corpconstants.sellsharescooldown.md)
## CorpConstants.sellSharesCooldown property
Cooldown for selling shares in game cycles (1 game cycle = 200ms)
<b>Signature:</b>
```typescript
sellSharesCooldown: number;
```

13
markdown/bitburner.corpconstants.sharesperpriceupdate.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [sharesPerPriceUpdate](./bitburner.corpconstants.sharesperpriceupdate.md)
## CorpConstants.sharesPerPriceUpdate property
When selling large number of shares, price is dynamically updated for every batch of this amount
<b>Signature:</b>
```typescript
sharesPerPriceUpdate: number;
```

13
markdown/bitburner.corpconstants.statenames.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [stateNames](./bitburner.corpconstants.statenames.md)
## CorpConstants.stateNames property
Names of all corporation game states
<b>Signature:</b>
```typescript
stateNames: CorpStateName[];
```

13
markdown/bitburner.corpconstants.unlocknames.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [unlockNames](./bitburner.corpconstants.unlocknames.md)
## CorpConstants.unlockNames property
Names of all one-time corporation-wide unlocks
<b>Signature:</b>
```typescript
unlockNames: CorpUnlockName[];
```

13
markdown/bitburner.corpconstants.upgradenames.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [upgradeNames](./bitburner.corpconstants.upgradenames.md)
## CorpConstants.upgradeNames property
Names of all corporation-wide upgrades
<b>Signature:</b>
```typescript
upgradeNames: CorpUpgradeName[];
```

11
markdown/bitburner.corpconstants.warehouseinitialcost.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [warehouseInitialCost](./bitburner.corpconstants.warehouseinitialcost.md)
## CorpConstants.warehouseInitialCost property
<b>Signature:</b>
```typescript
warehouseInitialCost: number;
```

11
markdown/bitburner.corpconstants.warehouseinitialsize.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [warehouseInitialSize](./bitburner.corpconstants.warehouseinitialsize.md)
## CorpConstants.warehouseInitialSize property
<b>Signature:</b>
```typescript
warehouseInitialSize: number;
```

11
markdown/bitburner.corpconstants.warehousesizeupgradecostbase.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [warehouseSizeUpgradeCostBase](./bitburner.corpconstants.warehousesizeupgradecostbase.md)
## CorpConstants.warehouseSizeUpgradeCostBase property
<b>Signature:</b>
```typescript
warehouseSizeUpgradeCostBase: number;
```

19
markdown/bitburner.corpemployeeposition.md Normal file
View File

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpEmployeePosition](./bitburner.corpemployeeposition.md)
## CorpEmployeePosition type
<b>Signature:</b>
```typescript
type CorpEmployeePosition =
| "Operations"
| "Engineer"
| "Business"
| "Management"
| "Research & Development"
| "Training"
| "Unassigned";
```

13
markdown/bitburner.corpindustrydata.advertisingfactor.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [advertisingFactor](./bitburner.corpindustrydata.advertisingfactor.md)
## CorpIndustryData.advertisingFactor property
Advertising factor (affects sales)
<b>Signature:</b>
```typescript
advertisingFactor?: number;
```

13
markdown/bitburner.corpindustrydata.aicorefactor.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [aiCoreFactor](./bitburner.corpindustrydata.aicorefactor.md)
## CorpIndustryData.aiCoreFactor property
AI Cores factor
<b>Signature:</b>
```typescript
aiCoreFactor?: number;
```

11
markdown/bitburner.corpindustrydata.description.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [description](./bitburner.corpindustrydata.description.md)
## CorpIndustryData.description property
<b>Signature:</b>
```typescript
description: string;
```

13
markdown/bitburner.corpindustrydata.hardwarefactor.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [hardwareFactor](./bitburner.corpindustrydata.hardwarefactor.md)
## CorpIndustryData.hardwareFactor property
Hardware factor
<b>Signature:</b>
```typescript
hardwareFactor?: number;
```

31
markdown/bitburner.corpindustrydata.md Normal file
View File

@ -0,0 +1,31 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md)
## CorpIndustryData interface
Data for an individual industry
<b>Signature:</b>
```typescript
interface CorpIndustryData
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [advertisingFactor?](./bitburner.corpindustrydata.advertisingfactor.md) | number | <i>(Optional)</i> Advertising factor (affects sales) |
| [aiCoreFactor?](./bitburner.corpindustrydata.aicorefactor.md) | number | <i>(Optional)</i> AI Cores factor |
| [description](./bitburner.corpindustrydata.description.md) | string | |
| [hardwareFactor?](./bitburner.corpindustrydata.hardwarefactor.md) | number | <i>(Optional)</i> Hardware factor |
| [producedMaterials?](./bitburner.corpindustrydata.producedmaterials.md) | [CorpMaterialName](./bitburner.corpmaterialname.md)<!-- -->\[\] | <i>(Optional)</i> |
| [product?](./bitburner.corpindustrydata.product.md) | [CorpProductData](./bitburner.corpproductdata.md) | <i>(Optional)</i> |
| [realEstateFactor?](./bitburner.corpindustrydata.realestatefactor.md) | number | <i>(Optional)</i> Real estate factor |
| [recommendStarting](./bitburner.corpindustrydata.recommendstarting.md) | boolean | |
| [requiredMaterials](./bitburner.corpindustrydata.requiredmaterials.md) | Partial&lt;Record&lt;[CorpMaterialName](./bitburner.corpmaterialname.md)<!-- -->, number&gt;&gt; | |
| [robotFactor?](./bitburner.corpindustrydata.robotfactor.md) | number | <i>(Optional)</i> Robots factor |
| [scienceFactor?](./bitburner.corpindustrydata.sciencefactor.md) | number | <i>(Optional)</i> Scientific research factor (affects quality) |
| [startingCost](./bitburner.corpindustrydata.startingcost.md) | number | |

11
markdown/bitburner.corpindustrydata.producedmaterials.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [producedMaterials](./bitburner.corpindustrydata.producedmaterials.md)
## CorpIndustryData.producedMaterials property
<b>Signature:</b>
```typescript
producedMaterials?: CorpMaterialName[];
```

11
markdown/bitburner.corpindustrydata.product.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [product](./bitburner.corpindustrydata.product.md)
## CorpIndustryData.product property
<b>Signature:</b>
```typescript
product?: CorpProductData;
```

13
markdown/bitburner.corpindustrydata.realestatefactor.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [realEstateFactor](./bitburner.corpindustrydata.realestatefactor.md)
## CorpIndustryData.realEstateFactor property
Real estate factor
<b>Signature:</b>
```typescript
realEstateFactor?: number;
```

11
markdown/bitburner.corpindustrydata.recommendstarting.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [recommendStarting](./bitburner.corpindustrydata.recommendstarting.md)
## CorpIndustryData.recommendStarting property
<b>Signature:</b>
```typescript
recommendStarting: boolean;
```

11
markdown/bitburner.corpindustrydata.requiredmaterials.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [requiredMaterials](./bitburner.corpindustrydata.requiredmaterials.md)
## CorpIndustryData.requiredMaterials property
<b>Signature:</b>
```typescript
requiredMaterials: Partial<Record<CorpMaterialName, number>>;
```

13
markdown/bitburner.corpindustrydata.robotfactor.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [robotFactor](./bitburner.corpindustrydata.robotfactor.md)
## CorpIndustryData.robotFactor property
Robots factor
<b>Signature:</b>
```typescript
robotFactor?: number;
```

13
markdown/bitburner.corpindustrydata.sciencefactor.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [scienceFactor](./bitburner.corpindustrydata.sciencefactor.md)
## CorpIndustryData.scienceFactor property
Scientific research factor (affects quality)
<b>Signature:</b>
```typescript
scienceFactor?: number;
```

11
markdown/bitburner.corpindustrydata.startingcost.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryData](./bitburner.corpindustrydata.md) &gt; [startingCost](./bitburner.corpindustrydata.startingcost.md)
## CorpIndustryData.startingCost property
<b>Signature:</b>
```typescript
startingCost: number;
```

26
markdown/bitburner.corpindustryname.md Normal file
View File

@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpIndustryName](./bitburner.corpindustryname.md)
## CorpIndustryName type
<b>Signature:</b>
```typescript
type CorpIndustryName =
| "Energy"
| "Water Utilities"
| "Agriculture"
| "Fishing"
| "Mining"
| "Food"
| "Tobacco"
| "Chemical"
| "Pharmaceutical"
| "Computer Hardware"
| "Robotics"
| "Software"
| "Healthcare"
| "Real Estate";
```

11
markdown/bitburner.corpmaterialconstantdata.basecost.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [baseCost](./bitburner.corpmaterialconstantdata.basecost.md)
## CorpMaterialConstantData.baseCost property
<b>Signature:</b>
```typescript
baseCost: number;
```

11
markdown/bitburner.corpmaterialconstantdata.basemarkup.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [baseMarkup](./bitburner.corpmaterialconstantdata.basemarkup.md)
## CorpMaterialConstantData.baseMarkup property
<b>Signature:</b>
```typescript
baseMarkup: number;
```

11
markdown/bitburner.corpmaterialconstantdata.competitionbase.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [competitionBase](./bitburner.corpmaterialconstantdata.competitionbase.md)
## CorpMaterialConstantData.competitionBase property
<b>Signature:</b>
```typescript
competitionBase: number;
```

11
markdown/bitburner.corpmaterialconstantdata.competitionrange.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [competitionRange](./bitburner.corpmaterialconstantdata.competitionrange.md)
## CorpMaterialConstantData.competitionRange property
<b>Signature:</b>
```typescript
competitionRange: [min: number, max: number];
```

11
markdown/bitburner.corpmaterialconstantdata.demandbase.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [demandBase](./bitburner.corpmaterialconstantdata.demandbase.md)
## CorpMaterialConstantData.demandBase property
<b>Signature:</b>
```typescript
demandBase: number;
```

13
markdown/bitburner.corpmaterialconstantdata.demandrange.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [demandRange](./bitburner.corpmaterialconstantdata.demandrange.md)
## CorpMaterialConstantData.demandRange property
Min and max demand
<b>Signature:</b>
```typescript
demandRange: [min: number, max: number];
```

11
markdown/bitburner.corpmaterialconstantdata.maxvolatility.md Normal file
View File

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [maxVolatility](./bitburner.corpmaterialconstantdata.maxvolatility.md)
## CorpMaterialConstantData.maxVolatility property
<b>Signature:</b>
```typescript
maxVolatility: number;
```

28
markdown/bitburner.corpmaterialconstantdata.md Normal file
View File

@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md)
## CorpMaterialConstantData interface
Corporation material information
<b>Signature:</b>
```typescript
interface CorpMaterialConstantData
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [baseCost](./bitburner.corpmaterialconstantdata.basecost.md) | number | |
| [baseMarkup](./bitburner.corpmaterialconstantdata.basemarkup.md) | number | |
| [competitionBase](./bitburner.corpmaterialconstantdata.competitionbase.md) | number | |
| [competitionRange](./bitburner.corpmaterialconstantdata.competitionrange.md) | \[min: number, max: number\] | |
| [demandBase](./bitburner.corpmaterialconstantdata.demandbase.md) | number | |
| [demandRange](./bitburner.corpmaterialconstantdata.demandrange.md) | \[min: number, max: number\] | Min and max demand |
| [maxVolatility](./bitburner.corpmaterialconstantdata.maxvolatility.md) | number | |
| [name](./bitburner.corpmaterialconstantdata.name.md) | string | Name of the material |
| [size](./bitburner.corpmaterialconstantdata.size.md) | number | Size of the material |

13
markdown/bitburner.corpmaterialconstantdata.name.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [name](./bitburner.corpmaterialconstantdata.name.md)
## CorpMaterialConstantData.name property
Name of the material
<b>Signature:</b>
```typescript
name: string;
```

13
markdown/bitburner.corpmaterialconstantdata.size.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md) &gt; [size](./bitburner.corpmaterialconstantdata.size.md)
## CorpMaterialConstantData.size property
Size of the material
<b>Signature:</b>
```typescript
size: number;
```

23
markdown/bitburner.corpmaterialname.md Normal file
View File

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpMaterialName](./bitburner.corpmaterialname.md)
## CorpMaterialName type
<b>Signature:</b>
```typescript
type CorpMaterialName =
| "Water"
| "Energy"
| "Food"
| "Plants"
| "Metal"
| "Hardware"
| "Chemicals"
| "Drugs"
| "Robots"
| "AI Cores"
| "Real Estate";
```

16
markdown/bitburner.corporation.enums.md
View File

@ -1,16 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [enums](./bitburner.corporation.enums.md)
## Corporation.enums property
Enums specific to the corporation game mechanic.
<b>Signature:</b>
```typescript
enums: {
EmployeePositions: typeof EmployeePositions;
IndustryType: typeof IndustryType;
};
```

4
markdown/bitburner.corporation.expandcity.md
View File

@ -9,7 +9,7 @@ Expand to a new city
<b>Signature:</b>
```typescript
expandCity(divisionName: string, cityName: string): void;
expandCity(divisionName: string, city: CityName | `${CityName}`): void;
```
## Parameters
@ -17,7 +17,7 @@ expandCity(divisionName: string, cityName: string): void;
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
<b>Returns:</b>

4
markdown/bitburner.corporation.expandindustry.md
View File

@ -9,14 +9,14 @@ Expand to a new industry
<b>Signature:</b>
```typescript
expandIndustry(industryType: IndustryType | `${IndustryType}`, divisionName: string): void;
expandIndustry(industryType: CorpIndustryName, divisionName: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| industryType | [IndustryType](./bitburner.industrytype.md) \| \`${[IndustryType](./bitburner.industrytype.md)<!-- -->}\` | Name of the industry |
| industryType | [CorpIndustryName](./bitburner.corpindustryname.md) | Name of the industry |
| divisionName | string | Name of the division |
<b>Returns:</b>

19
markdown/bitburner.corporation.getconstants.md Normal file
View File

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getConstants](./bitburner.corporation.getconstants.md)
## Corporation.getConstants() method
Get corporation related constants
<b>Signature:</b>
```typescript
getConstants(): CorpConstants;
```
<b>Returns:</b>
[CorpConstants](./bitburner.corpconstants.md)
corporation related constants

19
markdown/bitburner.corporation.getexpandcitycost.md
View File

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getExpandCityCost](./bitburner.corporation.getexpandcitycost.md)
## Corporation.getExpandCityCost() method
Gets the cost to expand into a new city
<b>Signature:</b>
```typescript
getExpandCityCost(): number;
```
<b>Returns:</b>
number
cost

26
markdown/bitburner.corporation.getexpandindustrycost.md
View File

@ -1,26 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getExpandIndustryCost](./bitburner.corporation.getexpandindustrycost.md)
## Corporation.getExpandIndustryCost() method
Gets the cost to expand into a new industry
<b>Signature:</b>
```typescript
getExpandIndustryCost(industryName: IndustryType | `${IndustryType}`): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| industryName | [IndustryType](./bitburner.industrytype.md) \| \`${[IndustryType](./bitburner.industrytype.md)<!-- -->}\` | Name of the industry |
<b>Returns:</b>
number
cost

24
markdown/bitburner.corporation.getindustrydata.md Normal file
View File

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getIndustryData](./bitburner.corporation.getindustrydata.md)
## Corporation.getIndustryData() method
Get constant industry definition data for a specific industry
<b>Signature:</b>
```typescript
getIndustryData(industryName: CorpIndustryName): CorpIndustryData;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| industryName | [CorpIndustryName](./bitburner.corpindustryname.md) | |
<b>Returns:</b>
[CorpIndustryData](./bitburner.corpindustrydata.md)

24
markdown/bitburner.corporation.getmaterialdata.md Normal file
View File

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getMaterialData](./bitburner.corporation.getmaterialdata.md)
## Corporation.getMaterialData() method
Get constant data for a specific material
<b>Signature:</b>
```typescript
getMaterialData(materialName: CorpMaterialName): CorpMaterialConstantData;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| materialName | [CorpMaterialName](./bitburner.corpmaterialname.md) | |
<b>Returns:</b>
[CorpMaterialConstantData](./bitburner.corpmaterialconstantdata.md)

19
markdown/bitburner.corporation.getmaterialnames.md
View File

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getMaterialNames](./bitburner.corporation.getmaterialnames.md)
## Corporation.getMaterialNames() method
Get list of materials
<b>Signature:</b>
```typescript
getMaterialNames(): string[];
```
<b>Returns:</b>
string\[\]
material names

19
markdown/bitburner.corporation.getresearchnames.md
View File

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getResearchNames](./bitburner.corporation.getresearchnames.md)
## Corporation.getResearchNames() method
Get list of research names
<b>Signature:</b>
```typescript
getResearchNames(): string[];
```
<b>Returns:</b>
string\[\]
research names

19
markdown/bitburner.corporation.getunlockables.md
View File

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getUnlockables](./bitburner.corporation.getunlockables.md)
## Corporation.getUnlockables() method
Get list of one-time unlockable upgrades
<b>Signature:</b>
```typescript
getUnlockables(): string[];
```
<b>Returns:</b>
string\[\]
unlockable upgrades names

19
markdown/bitburner.corporation.getupgradenames.md
View File

@ -1,19 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [getUpgradeNames](./bitburner.corporation.getupgradenames.md)
## Corporation.getUpgradeNames() method
Get list of upgrade names
<b>Signature:</b>
```typescript
getUpgradeNames(): string[];
```
<b>Returns:</b>
string\[\]
upgrade names

26
markdown/bitburner.corporation.issuenewshares.md Normal file
View File

@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [issueNewShares](./bitburner.corporation.issuenewshares.md)
## Corporation.issueNewShares() method
Issue new shares
<b>Signature:</b>
```typescript
issueNewShares(amount?: number): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| amount | number | Number of new shares to issue, will be rounded to nearest 10m. Defaults to max amount. |
<b>Returns:</b>
number
Amount of funds generated for the corporation.

18
markdown/bitburner.corporation.md
View File

@ -13,12 +13,6 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
```
<b>Extends:</b> [WarehouseAPI](./bitburner.warehouseapi.md)<!-- -->, [OfficeAPI](./bitburner.officeapi.md)
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [enums](./bitburner.corporation.enums.md) | { EmployeePositions: typeof [EmployeePositions](./bitburner.employeepositions.md)<!-- -->; IndustryType: typeof [IndustryType](./bitburner.industrytype.md)<!-- -->; } | Enums specific to the corporation game mechanic. |
## Methods
| Method | Description |
@ -27,25 +21,23 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
| [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 |
| [expandCity(divisionName, city)](./bitburner.corporation.expandcity.md) | Expand to a new city |
| [expandIndustry(industryType, divisionName)](./bitburner.corporation.expandindustry.md) | Expand to a new industry |
| [getBonusTime()](./bitburner.corporation.getbonustime.md) | Get bonus time. “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. “Bonus time” makes the game progress faster. |
| [getConstants()](./bitburner.corporation.getconstants.md) | Get corporation related constants |
| [getCorporation()](./bitburner.corporation.getcorporation.md) | Get corporation data |
| [getDivision(divisionName)](./bitburner.corporation.getdivision.md) | Get division data |
| [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 |
| [getIndustryData(industryName)](./bitburner.corporation.getindustrydata.md) | Get constant industry definition data for a specific industry |
| [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 |
| [getMaterialData(materialName)](./bitburner.corporation.getmaterialdata.md) | Get constant data for a specific material |
| [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 |
| [hasCorporation()](./bitburner.corporation.hascorporation.md) | Returns whether the player has a corporation. Does not require API access. |
| [hasUnlockUpgrade(upgradeName)](./bitburner.corporation.hasunlockupgrade.md) | Check if you have a one time unlockable upgrade |
| [issueDividends(rate)](./bitburner.corporation.issuedividends.md) | Issue dividends |
| [issueNewShares(amount)](./bitburner.corporation.issuenewshares.md) | Issue new shares |
| [levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) | Level an upgrade. |
| [sellShares(amount)](./bitburner.corporation.sellshares.md) | Sell Shares |
| [unlockUpgrade(upgradeName)](./bitburner.corporation.unlockupgrade.md) | Unlock an upgrade |

4
markdown/bitburner.corporationinfo.divisions.md
View File

@ -4,10 +4,10 @@
## CorporationInfo.divisions property
Array of all divisions
Array of all division names
<b>Signature:</b>
```typescript
divisions: Division[];
divisions: string[];
```

2
markdown/bitburner.corporationinfo.md
View File

@ -19,7 +19,7 @@ interface CorporationInfo
| [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 |
| [divisions](./bitburner.corporationinfo.divisions.md) | string\[\] | Array of all division names |
| [expenses](./bitburner.corporationinfo.expenses.md) | number | Expenses per second this cycle |
| [funds](./bitburner.corporationinfo.funds.md) | number | Funds available |
| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | Amount of acquirable shares. |

25
markdown/bitburner.corpproductdata.md Normal file
View File

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpProductData](./bitburner.corpproductdata.md)
## CorpProductData type
Product rating information
<b>Signature:</b>
```typescript
type CorpProductData = {
name: string;
verb: string;
desc: string;
ratingWeights: {
aesthetics?: number;
durability?: number;
features?: number;
quality?: number;
performance?: number;
reliability?: number;
};
};
```

35
markdown/bitburner.corpresearchname.md Normal file
View File

@ -0,0 +1,35 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpResearchName](./bitburner.corpresearchname.md)
## CorpResearchName type
<b>Signature:</b>
```typescript
type CorpResearchName =
| "Hi-Tech R&D Laboratory"
| "AutoBrew"
| "AutoPartyManager"
| "Automatic Drug Administration"
| "Bulk Purchasing"
| "CPH4 Injections"
| "Drones"
| "Drones - Assembly"
| "Drones - Transport"
| "Go-Juice"
| "HRBuddy-Recruitment"
| "HRBuddy-Training"
| "JoyWire"
| "Market-TA.I"
| "Market-TA.II"
| "Overclock"
| "Self-Correcting Assemblers"
| "Sti.mu"
| "uPgrade: Capacity.I"
| "uPgrade: Capacity.II"
| "uPgrade: Dashboard"
| "uPgrade: Fulcrum"
| "sudo.Assist";
```

12
markdown/bitburner.corpstatename.md Normal file
View File

@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpStateName](./bitburner.corpstatename.md)
## CorpStateName type
<b>Signature:</b>
```typescript
type CorpStateName = "START" | "PURCHASE" | "PRODUCTION" | "SALE" | "EXPORT";
```

21
markdown/bitburner.corpunlockname.md Normal file
View File

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpUnlockName](./bitburner.corpunlockname.md)
## CorpUnlockName type
<b>Signature:</b>
```typescript
type CorpUnlockName =
| "Export"
| "Smart Supply"
| "Market Research - Demand"
| "Market Data - Competition"
| "VeChain"
| "Shady Accounting"
| "Government Partnership"
| "Warehouse API"
| "Office API";
```

22
markdown/bitburner.corpupgradename.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpUpgradeName](./bitburner.corpupgradename.md)
## CorpUpgradeName type
<b>Signature:</b>
```typescript
type CorpUpgradeName =
| "Smart Factories"
| "Smart Storage"
| "DreamSense"
| "Wilson Analytics"
| "Nuoptimal Nootropic Injector Implants"
| "Speech Processor Implants"
| "Neural Accelerators"
| "FocusWires"
| "ABC SalesBots"
| "Project Insight";
```

2
markdown/bitburner.division.cities.md
View File

@ -9,5 +9,5 @@ Cities in which this division has expanded
<b>Signature:</b>
```typescript
cities: string[];
cities: CityName[];
```

4
markdown/bitburner.division.md
View File

@ -17,7 +17,7 @@ interface Division
| 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 |
| [cities](./bitburner.division.cities.md) | [CityName](./bitburner.cityname.md)<!-- -->\[\] | 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 |
@ -28,6 +28,6 @@ interface 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 |
| [type](./bitburner.division.type.md) | [CorpIndustryName](./bitburner.corpindustryname.md) | Type of division, like Agriculture |
| [upgrades](./bitburner.division.upgrades.md) | number\[\] | All research bought |

2
markdown/bitburner.division.type.md
View File

@ -9,5 +9,5 @@ Type of division, like Agriculture
<b>Signature:</b>
```typescript
type: string;
type: CorpIndustryName;
```

25
markdown/bitburner.employeepositions.md
View File

@ -1,25 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [EmployeePositions](./bitburner.employeepositions.md)
## EmployeePositions enum
<b>Signature:</b>
```typescript
declare enum EmployeePositions
```
## Enumeration Members
| Member | Value | Description |
| --- | --- | --- |
| Business | <code>&quot;Business&quot;</code> | |
| Engineer | <code>&quot;Engineer&quot;</code> | |
| Management | <code>&quot;Management&quot;</code> | |
| Operations | <code>&quot;Operations&quot;</code> | |
| RandD | <code>&quot;Research &amp; Development&quot;</code> | |
| Training | <code>&quot;Training&quot;</code> | |
| Unassigned | <code>&quot;Unassigned&quot;</code> | |

2
markdown/bitburner.export.loc.md
View File

@ -9,5 +9,5 @@ City the material is being exported to
<b>Signature:</b>
```typescript
loc: string;
loc: CityName;
```

2
markdown/bitburner.export.md
View File

@ -18,5 +18,5 @@ interface Export
| --- | --- | --- |
| [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 |
| [loc](./bitburner.export.loc.md) | [CityName](./bitburner.cityname.md) | City the material is being exported to |

2
markdown/bitburner.ilocation.city.md
View File

@ -7,5 +7,5 @@
<b>Signature:</b>
```typescript
city: string;
city: CityName;
```

4
markdown/bitburner.ilocation.md
View File

@ -15,6 +15,6 @@ interface ILocation
| Property | Type | Description |
| --- | --- | --- |
| [city](./bitburner.ilocation.city.md) | string | |
| [name](./bitburner.ilocation.name.md) | string | |
| [city](./bitburner.ilocation.city.md) | [CityName](./bitburner.cityname.md) | |
| [name](./bitburner.ilocation.name.md) | [LocationName](./bitburner.locationname.md) | |

2
markdown/bitburner.ilocation.name.md
View File

@ -7,5 +7,5 @@
<b>Signature:</b>
```typescript
name: string;
name: LocationName;
```

13
markdown/bitburner.industrydata.cost.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IndustryData](./bitburner.industrydata.md) &gt; [cost](./bitburner.industrydata.cost.md)
## IndustryData.cost property
Cost to expand to the division
<b>Signature:</b>
```typescript
cost: number;
```

13
markdown/bitburner.industrydata.makesmaterials.md Normal file
View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IndustryData](./bitburner.industrydata.md) &gt; [makesMaterials](./bitburner.industrydata.makesmaterials.md)
## IndustryData.makesMaterials property
Whether the division makes materials
<b>Signature:</b>
```typescript
makesMaterials: boolean;
```

Some files were not shown because too many files have changed in this diff Show More