Update Docs

This commit is contained in:
pigalot 2022-01-13 18:48:54 +00:00
parent 4562102448
commit 3476fc8218
52 changed files with 768 additions and 8 deletions

@ -0,0 +1,23 @@
<!-- 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; [acceptInvestmentOffer](./bitburner.corporation.acceptinvestmentoffer.md)
## Corporation.acceptInvestmentOffer() method
Accept investment based on you companies current valuation
<b>Signature:</b>
```typescript
acceptInvestmentOffer(): boolean;
```
<b>Returns:</b>
boolean
An offer of investment
## Remarks
Is based on current valuation and will not honer a specific Offer

@ -0,0 +1,27 @@
<!-- 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; [createCorporation](./bitburner.corporation.createcorporation.md)
## Corporation.createCorporation() method
Create a Corporation
<b>Signature:</b>
```typescript
createCorporation(corporationName: string, selfFund: boolean): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| corporationName | string | |
| selfFund | boolean | |
<b>Returns:</b>
boolean
true if created and false if not

@ -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; [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

@ -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; [getExpandIndustryCost](./bitburner.corporation.getexpandindustrycost.md)
## Corporation.getExpandIndustryCost() method
Gets the cost to expand into a new industry
<b>Signature:</b>
```typescript
getExpandIndustryCost(industryName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| industryName | string | Name of the industry |
<b>Returns:</b>
number
cost

@ -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; [getInvestmentOffer](./bitburner.corporation.getinvestmentoffer.md)
## Corporation.getInvestmentOffer() method
Get an offer for investment based on you companies current valuation
<b>Signature:</b>
```typescript
getInvestmentOffer(): InvestmentOffer;
```
<b>Returns:</b>
[InvestmentOffer](./bitburner.investmentoffer.md)
An offer of investment

@ -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; [getUnlockUpgradeCost](./bitburner.corporation.getunlockupgradecost.md)
## Corporation.getUnlockUpgradeCost() method
Gets the cost to unlock a one time unlockable upgrade
<b>Signature:</b>
```typescript
getUnlockUpgradeCost(upgradeName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| upgradeName | string | Name of the upgrade |
<b>Returns:</b>
number
cost of the upgrade

@ -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; [getUpgradeLevel](./bitburner.corporation.getupgradelevel.md)
## Corporation.getUpgradeLevel() method
Get the level of a levelable upgrade
<b>Signature:</b>
```typescript
getUpgradeLevel(upgradeName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| upgradeName | string | Name of the upgrade |
<b>Returns:</b>
number
the level of the upgrade

@ -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; [getUpgradeLevelCost](./bitburner.corporation.getupgradelevelcost.md)
## Corporation.getUpgradeLevelCost() method
Gets the cost to unlock the next level of a levelable upgrade
<b>Signature:</b>
```typescript
getUpgradeLevelCost(upgradeName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| upgradeName | string | Name of the upgrade |
<b>Returns:</b>
number
cost of the upgrade

@ -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; [goPublic](./bitburner.corporation.gopublic.md)
## Corporation.goPublic() method
Go public
<b>Signature:</b>
```typescript
goPublic(numShares: number): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| numShares | number | number of shares you would like to issue for your IPO |
<b>Returns:</b>
boolean
true if you successfully go public, false if not

@ -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; [hasUnlockUpgrade](./bitburner.corporation.hasunlockupgrade.md)
## Corporation.hasUnlockUpgrade() method
Check if you have a one time unlockable upgrade
<b>Signature:</b>
```typescript
hasUnlockUpgrade(upgradeName: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| upgradeName | string | Name of the upgrade |
<b>Returns:</b>
boolean
true if unlocked and false if not

@ -17,11 +17,21 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
| Method | Description |
| --- | --- |
| [acceptInvestmentOffer()](./bitburner.corporation.acceptinvestmentoffer.md) | Accept investment based on you companies current valuation |
| [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 |
| [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 |
| [getInvestmentOffer()](./bitburner.corporation.getinvestmentoffer.md) | Get an offer for investment based on you companies current valuation |
| [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 |
| [goPublic(numShares)](./bitburner.corporation.gopublic.md) | Go public |
| [hasUnlockUpgrade(upgradeName)](./bitburner.corporation.hasunlockupgrade.md) | Check if you have a one time unlockable upgrade |
| [issueDividends(percent)](./bitburner.corporation.issuedividends.md) | Issue dividends |
| [levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md) | Level an upgrade. |
| [unlockUpgrade(upgradeName)](./bitburner.corporation.unlockupgrade.md) | Unlock an upgrade. |
| [unlockUpgrade(upgradeName)](./bitburner.corporation.unlockupgrade.md) | Unlock an upgrade.npm run doc |

@ -4,7 +4,7 @@
## Corporation.unlockUpgrade() method
Unlock an upgrade.
Unlock an upgrade.npm run doc
<b>Signature:</b>

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorporationInfo](./bitburner.corporationinfo.md) &gt; [divisions](./bitburner.corporationinfo.divisions.md)
## CorporationInfo.divisions property
Array of all divisions
<b>Signature:</b>
```typescript
divisions: Division[];
```

@ -16,6 +16,7 @@ interface CorporationInfo
| Property | Type | Description |
| --- | --- | --- |
| [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 shares issued |

@ -23,6 +23,7 @@ interface Division
| [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 |

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

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [InvestmentOffer](./bitburner.investmentoffer.md) &gt; [funds](./bitburner.investmentoffer.funds.md)
## InvestmentOffer.funds property
Amount of funds you will get from this investment
<b>Signature:</b>
```typescript
funds: number;
```

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [InvestmentOffer](./bitburner.investmentoffer.md)
## InvestmentOffer interface
Corporation investment offer
<b>Signature:</b>
```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 |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [InvestmentOffer](./bitburner.investmentoffer.md) &gt; [round](./bitburner.investmentoffer.round.md)
## InvestmentOffer.round property
Current round of funding (max 4)
<b>Signature:</b>
```typescript
round: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [InvestmentOffer](./bitburner.investmentoffer.md) &gt; [shares](./bitburner.investmentoffer.shares.md)
## InvestmentOffer.shares property
Amount of share you will give in exchange for this investment
<b>Signature:</b>
```typescript
shares: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IPort](./bitburner.iport.md) &gt; [clear](./bitburner.iport.clear.md)
## IPort.clear property
removes all data from port
<b>Signature:</b>
```typescript
clear: () => void;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IPort](./bitburner.iport.md) &gt; [empty](./bitburner.iport.empty.md)
## IPort.empty property
check if port is empty
<b>Signature:</b>
```typescript
empty: () => boolean;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IPort](./bitburner.iport.md) &gt; [full](./bitburner.iport.full.md)
## IPort.full property
check if port is full
<b>Signature:</b>
```typescript
full: () => boolean;
```

@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IPort](./bitburner.iport.md)
## IPort interface
Interface of a netscript port
<b>Signature:</b>
```typescript
export interface IPort
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [clear](./bitburner.iport.clear.md) | () =&gt; void | removes all data from port |
| [empty](./bitburner.iport.empty.md) | () =&gt; boolean | check if port is empty |
| [full](./bitburner.iport.full.md) | () =&gt; boolean | check if port is full |
| [peek](./bitburner.iport.peek.md) | () =&gt; any | reads first element without removing it from port if no data in port returns "NULL PORT DATA" |
| [read](./bitburner.iport.read.md) | () =&gt; any | reads and removes first element from port if no data in port returns "NULL PORT DATA" |
| [tryWrite](./bitburner.iport.trywrite.md) | (value: any) =&gt; boolean | add data to port if not full. |
| [write](./bitburner.iport.write.md) | (value: any) =&gt; any | write data to the port and removes and returns first element if full |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IPort](./bitburner.iport.md) &gt; [peek](./bitburner.iport.peek.md)
## IPort.peek property
reads first element without removing it from port if no data in port returns "NULL PORT DATA"
<b>Signature:</b>
```typescript
peek: () => any;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IPort](./bitburner.iport.md) &gt; [read](./bitburner.iport.read.md)
## IPort.read property
reads and removes first element from port if no data in port returns "NULL PORT DATA"
<b>Signature:</b>
```typescript
read: () => any;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IPort](./bitburner.iport.md) &gt; [tryWrite](./bitburner.iport.trywrite.md)
## IPort.tryWrite property
add data to port if not full.
<b>Signature:</b>
```typescript
tryWrite: (value: any) => boolean;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [IPort](./bitburner.iport.md) &gt; [write](./bitburner.iport.write.md)
## IPort.write property
write data to the port and removes and returns first element if full
<b>Signature:</b>
```typescript
write: (value: any) => any;
```

@ -17,6 +17,8 @@ interface Material
| Property | Type | Description |
| --- | --- | --- |
| [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 |
| [sell](./bitburner.material.sell.md) | number | Amount of material sold |

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

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

@ -52,6 +52,8 @@
| [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas |
| [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants |
| [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas |
| [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer |
| [IPort](./bitburner.iport.md) | Interface of a netscript port |
| [Material](./bitburner.material.md) | Material in a warehouse |
| [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. |

@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OfficeAPI](./bitburner.officeapi.md) &gt; [getHireAdVertCost](./bitburner.officeapi.gethireadvertcost.md)
## OfficeAPI.getHireAdVertCost() method
Get the cost to Hire AdVert
<b>Signature:</b>
```typescript
getHireAdVertCost(divisionName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
<b>Returns:</b>
number
Cost

@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OfficeAPI](./bitburner.officeapi.md) &gt; [getHireAdVertCount](./bitburner.officeapi.gethireadvertcount.md)
## OfficeAPI.getHireAdVertCount() method
Get the number of times you have Hired AdVert
<b>Signature:</b>
```typescript
getHireAdVertCount(adivisionName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| adivisionName | string | |
<b>Returns:</b>
number
Number of times you have Hired AdVert

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OfficeAPI](./bitburner.officeapi.md) &gt; [getResearchCost](./bitburner.officeapi.getresearchcost.md)
## OfficeAPI.getResearchCost() method
Get the cost to unlock research
<b>Signature:</b>
```typescript
getResearchCost(divisionName: string, researchName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| researchName | string | |
<b>Returns:</b>
number
cost

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OfficeAPI](./bitburner.officeapi.md) &gt; [hasResearched](./bitburner.officeapi.hasresearched.md)
## OfficeAPI.hasResearched() method
Gets if you have unlocked a research
<b>Signature:</b>
```typescript
hasResearched(divisionName: string, researchName: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| researchName | string | |
<b>Returns:</b>
boolean
true is unlocked, false if not

@ -4,7 +4,7 @@
## OfficeAPI.hireEmployee() method
Assign an employee to a job.
Hire an employee.
<b>Signature:</b>

@ -23,10 +23,15 @@ Requires the Office API upgrade from your corporation.
| [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 |
| [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) | Assign an employee to a job. |
| [research(divisionName, researchName)](./bitburner.officeapi.research.md) | Hire AdVert. |
| [throwParty(divisionName, cityName, costPerEmployee)](./bitburner.officeapi.throwparty.md) | Assign an employee to a job. |
| [hireEmployee(divisionName, cityName)](./bitburner.officeapi.hireemployee.md) | Hire an employee. |
| [research(divisionName, researchName)](./bitburner.officeapi.research.md) | purchace 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. |

@ -4,7 +4,7 @@
## OfficeAPI.research() method
Hire AdVert.
purchace a research
<b>Signature:</b>

@ -0,0 +1,29 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OfficeAPI](./bitburner.officeapi.md) &gt; [setAutoJobAssignment](./bitburner.officeapi.setautojobassignment.md)
## OfficeAPI.setAutoJobAssignment() method
Set the auto job assignment for a job
<b>Signature:</b>
```typescript
setAutoJobAssignment(divisionName: string, cityName: string, job: string, amount: number): Promise<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 |
<b>Returns:</b>
Promise&lt;boolean&gt;
A promise that is fulfilled when the assignment is complete.

@ -4,7 +4,7 @@
## OfficeAPI.throwParty() method
Assign an employee to a job.
Throw a party for your employees
<b>Signature:</b>

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

@ -64,6 +64,7 @@ interface Player
| [hacknet\_node\_ram\_cost\_mult](./bitburner.player.hacknet_node_ram_cost_mult.md) | number | |
| [has4SData](./bitburner.player.has4sdata.md) | boolean | |
| [has4SDataTixApi](./bitburner.player.has4sdatatixapi.md) | boolean | |
| [hasCorporation](./bitburner.player.hascorporation.md) | boolean | |
| [hasTixApiAccess](./bitburner.player.hastixapiaccess.md) | boolean | |
| [hasWseAccount](./bitburner.player.haswseaccount.md) | boolean | |
| [hp](./bitburner.player.hp.md) | number | |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Product](./bitburner.product.md) &gt; [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\]
<b>Signature:</b>
```typescript
cityData: {[key: string]:number[]};
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Product](./bitburner.product.md) &gt; [developmentProgress](./bitburner.product.developmentprogress.md)
## Product.developmentProgress property
Creation progress - A number betwee 0-100 representing percentage
<b>Signature:</b>
```typescript
developmentProgress: number;
```

@ -16,7 +16,9 @@ interface Product
| 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 | Competition for the product |
| [developmentProgress](./bitburner.product.developmentprogress.md) | number | Creation progress - A number betwee 0-100 representing percentage |
| [dmd](./bitburner.product.dmd.md) | number | Demand for the product |
| [name](./bitburner.product.name.md) | string | Name of the product |
| [pCost](./bitburner.product.pcost.md) | number | Production cost |

@ -20,4 +20,5 @@ interface Warehouse
| [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 |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Warehouse](./bitburner.warehouse.md) &gt; [smartSupplyEnabled](./bitburner.warehouse.smartsupplyenabled.md)
## Warehouse.smartSupplyEnabled property
Smart Supply status in the warehouse
<b>Signature:</b>
```typescript
smartSupplyEnabled: boolean;
```

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [WarehouseAPI](./bitburner.warehouseapi.md) &gt; [getPurchaseWarehouseCost](./bitburner.warehouseapi.getpurchasewarehousecost.md)
## WarehouseAPI.getPurchaseWarehouseCost() method
Gets the cost to purchase a warehouse
<b>Signature:</b>
```typescript
getPurchaseWarehouseCost(): number;
```
<b>Returns:</b>
number
cost

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [WarehouseAPI](./bitburner.warehouseapi.md) &gt; [getUpgradeWarehouseCost](./bitburner.warehouseapi.getupgradewarehousecost.md)
## WarehouseAPI.getUpgradeWarehouseCost() method
Gets the cost to upgrade a warehouse to the next level
<b>Signature:</b>
```typescript
getUpgradeWarehouseCost(adivisionName: any, acityName: any): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| adivisionName | any | |
| acityName | any | |
<b>Returns:</b>
number
cost to upgrade

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [WarehouseAPI](./bitburner.warehouseapi.md) &gt; [hasWarehouse](./bitburner.warehouseapi.haswarehouse.md)
## WarehouseAPI.hasWarehouse() method
Check if you have a warehouse in city
<b>Signature:</b>
```typescript
hasWarehouse(adivisionName: any, acityName: any): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| adivisionName | any | |
| acityName | any | |
<b>Returns:</b>
boolean
true if warehouse is present, false if not

@ -26,7 +26,10 @@ Requires the Warehouse API upgrade from your corporation.
| [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)](./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 |
| [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. |