bitburner-src/markdown/bitburner.corporation.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

3.7 KiB

Home > bitburner > Corporation

Corporation interface

Corporation API

Signature:

export interface Corporation extends WarehouseAPI, OfficeAPI 

Extends: WarehouseAPI, OfficeAPI

Properties

Property Type Description
enums { EmployeePositions: typeof EmployeePositions; IndustryType: typeof IndustryType; } Enums specific to the corporation game mechanic.

Methods

Method Description
acceptInvestmentOffer() Accept investment based on you companies current valuation
bribe(factionName, amountCash) Bribe a faction
buyBackShares(amount) Buyback Shares
createCorporation(corporationName, selfFund) Create a Corporation
expandCity(divisionName, cityName) Expand to a new city
expandIndustry(industryType, divisionName) Expand to a new industry
getBonusTime() Get bonus time. “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. “Bonus time” makes the game progress faster.
getCorporation() Get corporation data
getDivision(divisionName) Get division data
getExpandCityCost() Gets the cost to expand into a new city
getExpandIndustryCost(industryName) Gets the cost to expand into a new industry
getInvestmentOffer() Get an offer for investment based on you companies current valuation
getMaterialNames() Get list of materials
getResearchNames() Get list of research names
getUnlockables() Get list of one-time unlockable upgrades
getUnlockUpgradeCost(upgradeName) Gets the cost to unlock a one time unlockable upgrade
getUpgradeLevel(upgradeName) Get the level of a levelable upgrade
getUpgradeLevelCost(upgradeName) Gets the cost to unlock the next level of a levelable upgrade
getUpgradeNames() Get list of upgrade names
goPublic(numShares) Go public
hasCorporation() Returns whether the player has a corporation. Does not require API access.
hasUnlockUpgrade(upgradeName) Check if you have a one time unlockable upgrade
issueDividends(rate) Issue dividends
levelUpgrade(upgradeName) Level an upgrade.
sellShares(amount) Sell Shares
unlockUpgrade(upgradeName) Unlock an upgrade