Files
bitburner-src/markdown/bitburner.corporationinfo.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* 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>
2025-09-26 14:52:39 -07:00

3.9 KiB

Home > bitburner > CorporationInfo

CorporationInfo interface

General info about a corporation

Signature:

interface CorporationInfo 

Properties

Property

Modifiers

Type

Description

dividendEarnings

number

Your earnings as a shareholder per second this cycle

dividendRate

number

Fraction of profits issued as dividends

divisions

string[]

Array of all division names

expenses

number

Expenses per second this cycle

funds

number

Funds available

investorShares

number

Amount of shares owned by private investors. Not available for public sale or CEO buyback.

issuedShares

number

Amount of shares owned by public traders. Available for CEO buyback.

issueNewSharesCooldown

number

Cooldown until new shares can be issued

name

string

Name of the corporation

nextState

CorpStateName

The next state to be processed.

I.e. when the state is PURCHASE, it means purchasing will occur during the next state transition.

Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE.

numShares

number

Amount of shares owned by the CEO.

prevState

CorpStateName

The last state that got processed.

I.e. when that state is PURCHASE, it means purchasing just happened.

Possible states are START, PURCHASE, PRODUCTION, EXPORT, SALE.

public

boolean

Indicating if the company is public

revenue

number

Revenue per second this cycle

sharePrice

number

Price of the shares

shareSaleCooldown

number

Cooldown until shares can be sold again

totalShares

number

Total number of shares issued by this corporation.

tributeModifier

number

Your income from dividend is negatively affected by this penalty modifier

valuation

number

Corporation valuation