mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
338 lines
5.3 KiB
Markdown
338 lines
5.3 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Corporation](./bitburner.corporation.md)
|
|
|
|
## Corporation interface
|
|
|
|
Corporation API
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
export interface Corporation extends WarehouseAPI, OfficeAPI
|
|
```
|
|
**Extends:** [WarehouseAPI](./bitburner.warehouseapi.md)<!-- -->, [OfficeAPI](./bitburner.officeapi.md)
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[acceptInvestmentOffer()](./bitburner.corporation.acceptinvestmentoffer.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Accept the investment offer. The value of offer is based on current corporation valuation.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[bribe(factionName, amountCash)](./bitburner.corporation.bribe.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Bribe a faction. You must satisfy these conditions:
|
|
|
|
- The corporation valuation must be greater than or equal to a threshold. You can use [getCorporation](./bitburner.corporation.getcorporation.md) and [getConstants](./bitburner.corporation.getconstants.md) to get this information.
|
|
|
|
- You must be a member of the specified faction.
|
|
|
|
- The specified faction must offer at least 1 type of work. You can use [getFactionWorkTypes](./bitburner.singularity.getfactionworktypes.md) to get the list of work types of a faction.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[buyBackShares(amount)](./bitburner.corporation.buybackshares.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Buyback shares. Spend money from the player's wallet to transfer shares from public traders to the CEO.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[canCreateCorporation(selfFund)](./bitburner.corporation.cancreatecorporation.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Return whether the player can create a corporation. Does not require API access.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Create a Corporation. You should use [canCreateCorporation](./bitburner.corporation.cancreatecorporation.md) to check if you are unsure you can do it, because it throws an error in these cases:
|
|
|
|
- Use seed money outside BitNode 3.
|
|
|
|
- Be in a BitNode that has CorporationSoftcap (a BitNode modifier) less than 0.15.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[expandCity(divisionName, city)](./bitburner.corporation.expandcity.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Expand to a new city.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[expandIndustry(industryType, divisionName)](./bitburner.corporation.expandindustry.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Expand to a new industry.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getBonusTime()](./bitburner.corporation.getbonustime.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get bonus time. Bonus time is accumulated when the game is offline or if the game is inactive in the browser. Bonus time makes the corporation progress faster.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getConstants()](./bitburner.corporation.getconstants.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get corporation-related constants.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getCorporation()](./bitburner.corporation.getcorporation.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get corporation data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getDivision(divisionName)](./bitburner.corporation.getdivision.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get division data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getIndustryData(industryName)](./bitburner.corporation.getindustrydata.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get constant data of an industry.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getInvestmentOffer()](./bitburner.corporation.getinvestmentoffer.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get an offer for investment based on current corporation valuation.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getMaterialData(materialName)](./bitburner.corporation.getmaterialdata.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get constant data of a material.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getUnlockCost(upgradeName)](./bitburner.corporation.getunlockcost.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the cost to unlock a one-time unlockable upgrade.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getUpgradeLevel(upgradeName)](./bitburner.corporation.getupgradelevel.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the level of a levelable upgrade.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getUpgradeLevelCost(upgradeName)](./bitburner.corporation.getupgradelevelcost.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the cost to unlock the next level of a levelable upgrade.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[goPublic(numShares)](./bitburner.corporation.gopublic.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Go public.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hasCorporation()](./bitburner.corporation.hascorporation.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Return whether the player has a corporation. Does not require API access.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hasUnlock(upgradeName)](./bitburner.corporation.hasunlock.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Check if you have a one-time unlockable upgrade.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[issueDividends(rate)](./bitburner.corporation.issuedividends.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Issue dividends.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[issueNewShares(amount)](./bitburner.corporation.issuenewshares.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Issue new shares.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[levelUpgrade(upgradeName)](./bitburner.corporation.levelupgrade.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Level up an upgrade.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[nextUpdate()](./bitburner.corporation.nextupdate.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Sleep until the next Corporation update happens.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[purchaseUnlock(upgradeName)](./bitburner.corporation.purchaseunlock.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Unlock an upgrade.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[sellDivision(divisionName)](./bitburner.corporation.selldivision.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Sell a division.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[sellShares(amount)](./bitburner.corporation.sellshares.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Sell shares. Transfer shares from the CEO to public traders to receive money in the player's wallet.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|