From 21b04bdec0600fb14219a85221b2d922d8495681 Mon Sep 17 00:00:00 2001 From: omuretsu <84951833+Snarling@users.noreply.github.com> Date: Tue, 20 Jun 2023 18:25:27 -0400 Subject: [PATCH] Regenerate docs --- .../bitburner.corpconstants.employeepositions.md | 13 +++++++++++++ markdown/bitburner.corpconstants.md | 2 ++ .../bitburner.corpconstants.smartsupplyoptions.md | 11 +++++++++++ markdown/bitburner.corpsmartsupplyoption.md | 12 ++++++++++++ markdown/bitburner.md | 5 +++-- markdown/bitburner.ns.scp.md | 2 +- ...tburner.ordertypes.md => bitburner.ordertype.md} | 6 +++--- ...r.positiontypes.md => bitburner.positiontype.md} | 6 +++--- markdown/bitburner.stockorderobject.md | 4 ++-- markdown/bitburner.stockorderobject.position.md | 2 +- markdown/bitburner.stockorderobject.type.md | 2 +- .../bitburner.warehouseapi.setsmartsupplyoption.md | 4 ++-- 12 files changed, 54 insertions(+), 15 deletions(-) create mode 100644 markdown/bitburner.corpconstants.employeepositions.md create mode 100644 markdown/bitburner.corpconstants.smartsupplyoptions.md create mode 100644 markdown/bitburner.corpsmartsupplyoption.md rename markdown/{bitburner.ordertypes.md => bitburner.ordertype.md} (86%) rename markdown/{bitburner.positiontypes.md => bitburner.positiontype.md} (79%) diff --git a/markdown/bitburner.corpconstants.employeepositions.md b/markdown/bitburner.corpconstants.employeepositions.md new file mode 100644 index 000000000..d724c69d6 --- /dev/null +++ b/markdown/bitburner.corpconstants.employeepositions.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorpConstants](./bitburner.corpconstants.md) > [employeePositions](./bitburner.corpconstants.employeepositions.md) + +## CorpConstants.employeePositions property + +Names of all employee positions + +**Signature:** + +```typescript +employeePositions: CorpEmployeePosition[]; +``` diff --git a/markdown/bitburner.corpconstants.md b/markdown/bitburner.corpconstants.md index ae01bca09..52da97100 100644 --- a/markdown/bitburner.corpconstants.md +++ b/markdown/bitburner.corpconstants.md @@ -20,6 +20,7 @@ interface CorpConstants | [bribeAmountPerReputation](./bitburner.corpconstants.bribeamountperreputation.md) | | number | | | [bribeThreshold](./bitburner.corpconstants.bribethreshold.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 | | | [employeeSalaryMultiplier](./bitburner.corpconstants.employeesalarymultiplier.md) | | number | Conversion factor for employee stats to initial salary | | [gameCyclesPerCorpStateCycle](./bitburner.corpconstants.gamecyclespercorpstatecycle.md) | | number | | @@ -40,6 +41,7 @@ interface CorpConstants | [secondsPerMarketCycle](./bitburner.corpconstants.secondspermarketcycle.md) | | number | | | [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 | +| [smartSupplyOptions](./bitburner.corpconstants.smartsupplyoptions.md) | | [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md)\[\] | | | [stateNames](./bitburner.corpconstants.statenames.md) | | [CorpStateName](./bitburner.corpstatename.md)\[\] | Names of all corporation game states | | [teaCostPerEmployee](./bitburner.corpconstants.teacostperemployee.md) | | number | | | [unlockNames](./bitburner.corpconstants.unlocknames.md) | | [CorpUnlockName](./bitburner.corpunlockname.md)\[\] | Names of all one-time corporation-wide unlocks | diff --git a/markdown/bitburner.corpconstants.smartsupplyoptions.md b/markdown/bitburner.corpconstants.smartsupplyoptions.md new file mode 100644 index 000000000..facb64f38 --- /dev/null +++ b/markdown/bitburner.corpconstants.smartsupplyoptions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorpConstants](./bitburner.corpconstants.md) > [smartSupplyOptions](./bitburner.corpconstants.smartsupplyoptions.md) + +## CorpConstants.smartSupplyOptions property + +**Signature:** + +```typescript +smartSupplyOptions: CorpSmartSupplyOption[]; +``` diff --git a/markdown/bitburner.corpsmartsupplyoption.md b/markdown/bitburner.corpsmartsupplyoption.md new file mode 100644 index 000000000..f970c454f --- /dev/null +++ b/markdown/bitburner.corpsmartsupplyoption.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) + +## CorpSmartSupplyOption type + + +**Signature:** + +```typescript +type CorpSmartSupplyOption = "leftovers" | "imports" | "none"; +``` diff --git a/markdown/bitburner.md b/markdown/bitburner.md index b16f00ad7..5e29657ff 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -14,8 +14,8 @@ | [GymType](./bitburner.gymtype.md) | | | [JobName](./bitburner.jobname.md) | | | [LocationName](./bitburner.locationname.md) | Names of all locations | -| [OrderTypes](./bitburner.ordertypes.md) | | -| [PositionTypes](./bitburner.positiontypes.md) | | +| [OrderType](./bitburner.ordertype.md) | | +| [PositionType](./bitburner.positiontype.md) | | | [ToastVariant](./bitburner.toastvariant.md) | | | [UniversityClassType](./bitburner.universityclasstype.md) | | @@ -118,6 +118,7 @@ | [CorpIndustryName](./bitburner.corpindustryname.md) | | | [CorpMaterialName](./bitburner.corpmaterialname.md) | | | [CorpResearchName](./bitburner.corpresearchname.md) | | +| [CorpSmartSupplyOption](./bitburner.corpsmartsupplyoption.md) | | | [CorpStateName](./bitburner.corpstatename.md) | | | [CorpUnlockName](./bitburner.corpunlockname.md) | | | [CorpUpgradeName](./bitburner.corpupgradename.md) | | diff --git a/markdown/bitburner.ns.scp.md b/markdown/bitburner.ns.scp.md index ae2bfb7df..4cb69b645 100644 --- a/markdown/bitburner.ns.scp.md +++ b/markdown/bitburner.ns.scp.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" ); //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"); ``` diff --git a/markdown/bitburner.ordertypes.md b/markdown/bitburner.ordertype.md similarity index 86% rename from markdown/bitburner.ordertypes.md rename to markdown/bitburner.ordertype.md index dadfcc3e2..d15c4bc41 100644 --- a/markdown/bitburner.ordertypes.md +++ b/markdown/bitburner.ordertype.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [bitburner](./bitburner.md) > [OrderTypes](./bitburner.ordertypes.md) +[Home](./index.md) > [bitburner](./bitburner.md) > [OrderType](./bitburner.ordertype.md) -## OrderTypes enum +## OrderType enum **Signature:** ```typescript -declare enum OrderTypes +declare enum OrderType ``` ## Enumeration Members diff --git a/markdown/bitburner.positiontypes.md b/markdown/bitburner.positiontype.md similarity index 79% rename from markdown/bitburner.positiontypes.md rename to markdown/bitburner.positiontype.md index 1ab4b2e96..33d7c6f5b 100644 --- a/markdown/bitburner.positiontypes.md +++ b/markdown/bitburner.positiontype.md @@ -1,14 +1,14 @@ -[Home](./index.md) > [bitburner](./bitburner.md) > [PositionTypes](./bitburner.positiontypes.md) +[Home](./index.md) > [bitburner](./bitburner.md) > [PositionType](./bitburner.positiontype.md) -## PositionTypes enum +## PositionType enum **Signature:** ```typescript -declare enum PositionTypes +declare enum PositionType ``` ## Enumeration Members diff --git a/markdown/bitburner.stockorderobject.md b/markdown/bitburner.stockorderobject.md index 4e894b1af..00e45833d 100644 --- a/markdown/bitburner.stockorderobject.md +++ b/markdown/bitburner.stockorderobject.md @@ -16,8 +16,8 @@ interface StockOrderObject | 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 | | [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 | diff --git a/markdown/bitburner.stockorderobject.position.md b/markdown/bitburner.stockorderobject.position.md index cdf0c2fce..b53bdcf74 100644 --- a/markdown/bitburner.stockorderobject.position.md +++ b/markdown/bitburner.stockorderobject.position.md @@ -9,5 +9,5 @@ Order position **Signature:** ```typescript -position: PositionTypes; +position: PositionType; ``` diff --git a/markdown/bitburner.stockorderobject.type.md b/markdown/bitburner.stockorderobject.type.md index 00cffde00..10d30d24f 100644 --- a/markdown/bitburner.stockorderobject.type.md +++ b/markdown/bitburner.stockorderobject.type.md @@ -9,5 +9,5 @@ Order type **Signature:** ```typescript -type: OrderTypes; +type: OrderType; ``` diff --git a/markdown/bitburner.warehouseapi.setsmartsupplyoption.md b/markdown/bitburner.warehouseapi.setsmartsupplyoption.md index 5b7a443c9..2cea4555b 100644 --- a/markdown/bitburner.warehouseapi.setsmartsupplyoption.md +++ b/markdown/bitburner.warehouseapi.setsmartsupplyoption.md @@ -13,7 +13,7 @@ setSmartSupplyOption( divisionName: string, city: CityName | `${CityName}`, materialName: string, - option: string, + option: CorpSmartSupplyOption, ): void; ``` @@ -24,7 +24,7 @@ setSmartSupplyOption( | divisionName | string | Name of the division | | city | [CityName](./bitburner.cityname.md) \| \`${[CityName](./bitburner.cityname.md)}\` | Name of the city | | 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:**