mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +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>
287 lines
4.2 KiB
Markdown
287 lines
4.2 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md)
|
|
|
|
## WarehouseAPI interface
|
|
|
|
Corporation Warehouse API
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
export interface WarehouseAPI
|
|
```
|
|
|
|
## Remarks
|
|
|
|
Requires the Warehouse API upgrade from your corporation.
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[bulkPurchase(divisionName, city, materialName, amt)](./bitburner.warehouseapi.bulkpurchase.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set material to bulk-buy.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[buyMaterial(divisionName, city, materialName, amt)](./bitburner.warehouseapi.buymaterial.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set material buy data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[cancelExportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName)](./bitburner.warehouseapi.cancelexportmaterial.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Cancel material export.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[discontinueProduct(divisionName, productName)](./bitburner.warehouseapi.discontinueproduct.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Discontinue a product.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[exportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./bitburner.warehouseapi.exportmaterial.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set material export data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getMaterial(divisionName, city, materialName)](./bitburner.warehouseapi.getmaterial.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get material data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getProduct(divisionName, cityName, productName)](./bitburner.warehouseapi.getproduct.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get product data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getUpgradeWarehouseCost(divisionName, city, amt)](./bitburner.warehouseapi.getupgradewarehousecost.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the cost to upgrade a warehouse to the next level.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getWarehouse(divisionName, city)](./bitburner.warehouseapi.getwarehouse.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get warehouse data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[hasWarehouse(divisionName, city)](./bitburner.warehouseapi.haswarehouse.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Check if you have a warehouse in city.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[limitMaterialProduction(divisionName, city, materialName, qty)](./bitburner.warehouseapi.limitmaterialproduction.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Limit material production.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[limitProductProduction(divisionName, city, productName, qty)](./bitburner.warehouseapi.limitproductproduction.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Limit product production.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[makeProduct(divisionName, city, productName, designInvest, marketingInvest)](./bitburner.warehouseapi.makeproduct.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Create a new product.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[purchaseWarehouse(divisionName, city)](./bitburner.warehouseapi.purchasewarehouse.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Purchase warehouse for a new city.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[sellMaterial(divisionName, city, materialName, amt, price)](./bitburner.warehouseapi.sellmaterial.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set material sell data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[sellProduct(divisionName, city, productName, amt, price, all)](./bitburner.warehouseapi.sellproduct.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set product sell data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setMaterialMarketTA1(divisionName, city, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta1.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set Market-TA1 for a material.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setMaterialMarketTA2(divisionName, city, materialName, on)](./bitburner.warehouseapi.setmaterialmarketta2.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set Market-TA2 for a material.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setProductMarketTA1(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta1.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set Market-TA1 for a product.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setProductMarketTA2(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta2.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set Market-TA2 for a product.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setSmartSupply(divisionName, city, enabled)](./bitburner.warehouseapi.setsmartsupply.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set smart supply.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[setSmartSupplyOption(divisionName, city, materialName, option)](./bitburner.warehouseapi.setsmartsupplyoption.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Set whether smart supply uses leftovers before buying.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[upgradeWarehouse(divisionName, city, amt)](./bitburner.warehouseapi.upgradewarehouse.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Upgrade warehouse.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|