mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 14:59:16 +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>
409 lines
3.9 KiB
Markdown
409 lines
3.9 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [CorporationInfo](./bitburner.corporationinfo.md)
|
|
|
|
## CorporationInfo interface
|
|
|
|
General info about a corporation
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
interface CorporationInfo
|
|
```
|
|
|
|
## Properties
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Property
|
|
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[dividendEarnings](./bitburner.corporationinfo.dividendearnings.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Your earnings as a shareholder per second this cycle
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[dividendRate](./bitburner.corporationinfo.dividendrate.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Fraction of profits issued as dividends
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[divisions](./bitburner.corporationinfo.divisions.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
Array of all division names
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[expenses](./bitburner.corporationinfo.expenses.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Expenses per second this cycle
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[funds](./bitburner.corporationinfo.funds.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Funds available
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[investorShares](./bitburner.corporationinfo.investorshares.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Amount of shares owned by private investors. Not available for public sale or CEO buyback.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[issuedShares](./bitburner.corporationinfo.issuedshares.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Amount of shares owned by public traders. Available for CEO buyback.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[issueNewSharesCooldown](./bitburner.corporationinfo.issuenewsharescooldown.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Cooldown until new shares can be issued
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[name](./bitburner.corporationinfo.name.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Name of the corporation
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[nextState](./bitburner.corporationinfo.nextstate.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
[CorpStateName](./bitburner.corpstatename.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
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.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[numShares](./bitburner.corporationinfo.numshares.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Amount of shares owned by the CEO.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[prevState](./bitburner.corporationinfo.prevstate.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
[CorpStateName](./bitburner.corpstatename.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
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.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[public](./bitburner.corporationinfo.public.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
Indicating if the company is public
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[revenue](./bitburner.corporationinfo.revenue.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Revenue per second this cycle
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[sharePrice](./bitburner.corporationinfo.shareprice.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Price of the shares
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[shareSaleCooldown](./bitburner.corporationinfo.sharesalecooldown.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Cooldown until shares can be sold again
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[totalShares](./bitburner.corporationinfo.totalshares.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Total number of shares issued by this corporation.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[tributeModifier](./bitburner.corporationinfo.tributemodifier.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Your income from dividend is negatively affected by this penalty modifier
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[valuation](./bitburner.corporationinfo.valuation.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td><td>
|
|
|
|
number
|
|
|
|
|
|
</td><td>
|
|
|
|
Corporation valuation
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|