Regenerate docs

This commit is contained in:
omuretsu 2023-06-20 18:25:27 -04:00
parent d4113e325a
commit 21b04bdec0
12 changed files with 54 additions and 15 deletions

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [employeePositions](./bitburner.corpconstants.employeepositions.md)
## CorpConstants.employeePositions property
Names of all employee positions
**Signature:**
```typescript
employeePositions: CorpEmployeePosition[];
```

@ -20,6 +20,7 @@ interface CorpConstants
| [bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md) | | number | | | [bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md) | | number | |
| [bribeThreshold](./bitburner.corpconstants.bribethreshold.md) | | number | | | [bribeThreshold](./bitburner.corpconstants.bribethreshold.md) | | number | |
| [dividendMaxRate](./bitburner.corpconstants.dividendmaxrate.md) | | number | | | [dividendMaxRate](./bitburner.corpconstants.dividendmaxrate.md) | | number | |
| [employeePositions](./bitburner.corpconstants.employeepositions.md) | | [CorpEmployeePosition](./bitburner.corpemployeeposition.md)<!-- -->\[\] | Names of all employee positions |
| [employeeRaiseAmount](./bitburner.corpconstants.employeeraiseamount.md) | | number | | | [employeeRaiseAmount](./bitburner.corpconstants.employeeraiseamount.md) | | number | |
| [employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md) | | number | Conversion factor for employee stats to initial salary | | [employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md) | | number | Conversion factor for employee stats to initial salary |
| [gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md) | | number | | | [gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md) | | number | |
@ -40,6 +41,7 @@ interface CorpConstants
| [secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md) | | number | | | [secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md) | | number | |
| [sellSharesCooldown](./bitburner.corpconstants.sellsharescooldown.md) | | number | Cooldown for selling shares in game cycles (1 game cycle = 200ms) | | [sellSharesCooldown](./bitburner.corpconstants.sellsharescooldown.md) | | number | Cooldown for selling shares in game cycles (1 game cycle = 200ms) |
| [sharesPerPriceUpdate](./bitburner.corpconstants.sharesperpriceupdate.md) | | number | When selling large number of shares, price is dynamically updated for every batch of this amount | | [sharesPerPriceUpdate](./bitburner.corpconstants.sharesperpriceupdate.md) | | number | When selling large number of shares, price is dynamically updated for every batch of this amount |
| [smartSupplyOptions](./bitburner.corpconstants.smartsupplyoptions.md) | | [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md)<!-- -->\[\] | |
| [stateNames](./bitburner.corpconstants.statenames.md) | | [CorpStateName](./bitburner.corpstatename.md)<!-- -->\[\] | Names of all corporation game states | | [stateNames](./bitburner.corpconstants.statenames.md) | | [CorpStateName](./bitburner.corpstatename.md)<!-- -->\[\] | Names of all corporation game states |
| [teaCostPerEmployee](./bitburner.corpconstants.teacostperemployee.md) | | number | | | [teaCostPerEmployee](./bitburner.corpconstants.teacostperemployee.md) | | number | |
| [unlockNames](./bitburner.corpconstants.unlocknames.md) | | [CorpUnlockName](./bitburner.corpunlockname.md)<!-- -->\[\] | Names of all one-time corporation-wide unlocks | | [unlockNames](./bitburner.corpconstants.unlocknames.md) | | [CorpUnlockName](./bitburner.corpunlockname.md)<!-- -->\[\] | Names of all one-time corporation-wide unlocks |

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpConstants](./bitburner.corpconstants.md) &gt; [smartSupplyOptions](./bitburner.corpconstants.smartsupplyoptions.md)
## CorpConstants.smartSupplyOptions property
**Signature:**
```typescript
smartSupplyOptions: CorpSmartSupplyOption[];
```

@ -0,0 +1,12 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md)
## CorpSmartSupplyOption type
**Signature:**
```typescript
type CorpSmartSupplyOption = "leftovers" | "imports" | "none";
```

@ -14,8 +14,8 @@
| [GymType](./bitburner.gymtype.md) | | | [GymType](./bitburner.gymtype.md) | |
| [JobName](./bitburner.jobname.md) | | | [JobName](./bitburner.jobname.md) | |
| [LocationName](./bitburner.locationname.md) | Names of all locations | | [LocationName](./bitburner.locationname.md) | Names of all locations |
| [OrderTypes](./bitburner.ordertypes.md) | | | [OrderType](./bitburner.ordertype.md) | |
| [PositionTypes](./bitburner.positiontypes.md) | | | [PositionType](./bitburner.positiontype.md) | |
| [ToastVariant](./bitburner.toastvariant.md) | | | [ToastVariant](./bitburner.toastvariant.md) | |
| [UniversityClassType](./bitburner.universityclasstype.md) | | | [UniversityClassType](./bitburner.universityclasstype.md) | |
@ -118,6 +118,7 @@
| [CorpIndustryName](./bitburner.corpindustryname.md) | | | [CorpIndustryName](./bitburner.corpindustryname.md) | |
| [CorpMaterialName](./bitburner.corpmaterialname.md) | | | [CorpMaterialName](./bitburner.corpmaterialname.md) | |
| [CorpResearchName](./bitburner.corpresearchname.md) | | | [CorpResearchName](./bitburner.corpresearchname.md) | |
| [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) | |
| [CorpStateName](./bitburner.corpstatename.md) | | | [CorpStateName](./bitburner.corpstatename.md) | |
| [CorpUnlockName](./bitburner.corpunlockname.md) | | | [CorpUnlockName](./bitburner.corpunlockname.md) | |
| [CorpUpgradeName](./bitburner.corpupgradename.md) | | | [CorpUpgradeName](./bitburner.corpupgradename.md) | |

@ -40,7 +40,7 @@ Copies a script or literature (.lit) file(s) to another server. The files argume
ns.scp("foo.lit", "home", "helios" ); ns.scp("foo.lit", "home", "helios" );
//Tries to copy three files from rothman-uni to home computer: //Tries to copy three files from rothman-uni to home computer:
files = ["foo1.lit", "foo2.txt", "foo3.js"]; const files = ["foo1.lit", "foo2.txt", "foo3.js"];
ns.scp(files, "home", "rothman-uni"); ns.scp(files, "home", "rothman-uni");
``` ```

@ -1,14 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OrderTypes](./bitburner.ordertypes.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [OrderType](./bitburner.ordertype.md)
## OrderTypes enum ## OrderType enum
**Signature:** **Signature:**
```typescript ```typescript
declare enum OrderTypes declare enum OrderType
``` ```
## Enumeration Members ## Enumeration Members

@ -1,14 +1,14 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. --> <!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [PositionTypes](./bitburner.positiontypes.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [PositionType](./bitburner.positiontype.md)
## PositionTypes enum ## PositionType enum
**Signature:** **Signature:**
```typescript ```typescript
declare enum PositionTypes declare enum PositionType
``` ```
## Enumeration Members ## Enumeration Members

@ -16,8 +16,8 @@ interface StockOrderObject
| Property | Modifiers | Type | Description | | Property | Modifiers | Type | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
| [position](./bitburner.stockorderobject.position.md) | | [PositionTypes](./bitburner.positiontypes.md) | Order position | | [position](./bitburner.stockorderobject.position.md) | | [PositionType](./bitburner.positiontype.md) | Order position |
| [price](./bitburner.stockorderobject.price.md) | | number | Price per share | | [price](./bitburner.stockorderobject.price.md) | | number | Price per share |
| [shares](./bitburner.stockorderobject.shares.md) | | number | Number of shares | | [shares](./bitburner.stockorderobject.shares.md) | | number | Number of shares |
| [type](./bitburner.stockorderobject.type.md) | | [OrderTypes](./bitburner.ordertypes.md) | Order type | | [type](./bitburner.stockorderobject.type.md) | | [OrderType](./bitburner.ordertype.md) | Order type |

@ -9,5 +9,5 @@ Order position
**Signature:** **Signature:**
```typescript ```typescript
position: PositionTypes; position: PositionType;
``` ```

@ -9,5 +9,5 @@ Order type
**Signature:** **Signature:**
```typescript ```typescript
type: OrderTypes; type: OrderType;
``` ```

@ -13,7 +13,7 @@ setSmartSupplyOption(
divisionName: string, divisionName: string,
city: CityName | `${CityName}`, city: CityName | `${CityName}`,
materialName: string, materialName: string,
option: string, option: CorpSmartSupplyOption,
): void; ): void;
``` ```
@ -24,7 +24,7 @@ setSmartSupplyOption(
| divisionName | string | Name of the division | | divisionName | string | Name of the division |
| city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)<!-- -->}\` | Name of the city |
| materialName | string | Name of the material | | materialName | string | Name of the material |
| option | string | smart supply option, "leftovers" to use leftovers, "imports" to use only imported materials, "none" to not use materials from store | | option | [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) | smart supply option, "leftovers" to use leftovers, "imports" to use only imported materials, "none" to not use materials from store |
**Returns:** **Returns:**