generated docs

This commit is contained in:
phyzical 2022-01-17 18:24:42 +08:00
parent d50e199171
commit 6f2924dc0d
6 changed files with 279 additions and 11 deletions

18
dist/bitburner.d.ts vendored

@ -958,6 +958,14 @@ export declare interface Corporation extends WarehouseAPI, OfficeAPI {
* @param percent - Percent of profit to issue as dividends. * @param percent - Percent of profit to issue as dividends.
*/ */
issueDividends(percent: number): void; issueDividends(percent: number): void;
/**
* Buyback Shares
*/
buyBackShares(amt: number): void;
/**
* Sell Shares
*/
sellShares(amt: number): void;
} }
/** /**
@ -4730,7 +4738,7 @@ export declare interface Product {
/** Data refers to the production, sale, and quantity of the products /** Data refers to the production, sale, and quantity of the products
* These values are specific to a city * These values are specific to a city
* For each city, the data is [qty, prod, sell] */ * For each city, the data is [qty, prod, sell] */
cityData: {[key: string]:number[]}; cityData: { [key: string]: number[] };
/** Creation progress - A number between 0-100 representing percentage */ /** Creation progress - A number between 0-100 representing percentage */
developmentProgress: number; developmentProgress: number;
} }
@ -6601,6 +6609,14 @@ export declare interface WarehouseAPI {
* @param amt - Amount of material to buy * @param amt - Amount of material to buy
*/ */
buyMaterial(divisionName: string, cityName: string, materialName: string, amt: number): void; buyMaterial(divisionName: string, cityName: string, materialName: string, amt: number): void;
/**
* Set material to bulk buy
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param materialName - Name of the material
* @param amt - Amount of material to buy
*/
bulkPurchase(divisionName: string, cityName: string, materialName: string, amt: number): void;
/** /**
* Get warehouse data * Get warehouse data
* @param divisionName - Name of the division * @param divisionName - Name of the division

@ -5464,6 +5464,50 @@
], ],
"name": "bribe" "name": "bribe"
}, },
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#buyBackShares:member(1)",
"docComment": "/**\n * Buyback Shares\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "buyBackShares(amt: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "amt",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "buyBackShares"
},
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#createCorporation:member(1)", "canonicalReference": "bitburner!Corporation#createCorporation:member(1)",
@ -6124,6 +6168,50 @@
], ],
"name": "levelUpgrade" "name": "levelUpgrade"
}, },
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#sellShares:member(1)",
"docComment": "/**\n * Sell Shares\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "sellShares(amt: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "amt",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
}
],
"name": "sellShares"
},
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!Corporation#unlockUpgrade:member(1)", "canonicalReference": "bitburner!Corporation#unlockUpgrade:member(1)",
@ -25596,7 +25684,7 @@
}, },
{ {
"kind": "Content", "kind": "Content",
"text": "{[key: string]:number[]}" "text": "{ [key: string]: number[] }"
}, },
{ {
"kind": "Content", "kind": "Content",
@ -32831,6 +32919,95 @@
"releaseTag": "Public", "releaseTag": "Public",
"name": "WarehouseAPI", "name": "WarehouseAPI",
"members": [ "members": [
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#bulkPurchase:member(1)",
"docComment": "/**\n * Set material to bulk buy\n *\n * @param divisionName - Name of the division\n *\n * @param cityName - Name of the city\n *\n * @param materialName - Name of the material\n *\n * @param amt - Amount of material to buy\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "bulkPurchase(divisionName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", cityName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", materialName: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", amt: "
},
{
"kind": "Content",
"text": "number"
},
{
"kind": "Content",
"text": "): "
},
{
"kind": "Content",
"text": "void"
},
{
"kind": "Content",
"text": ";"
}
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 9,
"endIndex": 10
},
"releaseTag": "Public",
"overloadIndex": 1,
"parameters": [
{
"parameterName": "divisionName",
"parameterTypeTokenRange": {
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "cityName",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
},
{
"parameterName": "materialName",
"parameterTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
}
},
{
"parameterName": "amt",
"parameterTypeTokenRange": {
"startIndex": 7,
"endIndex": 8
}
}
],
"name": "bulkPurchase"
},
{ {
"kind": "MethodSignature", "kind": "MethodSignature",
"canonicalReference": "bitburner!WarehouseAPI#buyMaterial:member(1)", "canonicalReference": "bitburner!WarehouseAPI#buyMaterial:member(1)",

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [buyBackShares](./bitburner.corporation.buybackshares.md)
## Corporation.buyBackShares() method
Buyback Shares
<b>Signature:</b>
```typescript
buyBackShares(amt: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| amt | number | |
<b>Returns:</b>
void

@ -0,0 +1,24 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Corporation](./bitburner.corporation.md) &gt; [sellShares](./bitburner.corporation.sellshares.md)
## Corporation.sellShares() method
Sell Shares
<b>Signature:</b>
```typescript
sellShares(amt: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| amt | number | |
<b>Returns:</b>
void

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [WarehouseAPI](./bitburner.warehouseapi.md) &gt; [bulkPurchase](./bitburner.warehouseapi.bulkpurchase.md)
## WarehouseAPI.bulkPurchase() method
Set material to bulk buy
<b>Signature:</b>
```typescript
bulkPurchase(divisionName: string, cityName: string, materialName: string, amt: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| materialName | string | Name of the material |
| amt | number | Amount of material to buy |
<b>Returns:</b>
void

@ -6572,7 +6572,7 @@ interface Product {
/** Data refers to the production, sale, and quantity of the products /** Data refers to the production, sale, and quantity of the products
* These values are specific to a city * These values are specific to a city
* For each city, the data is [qty, prod, sell] */ * For each city, the data is [qty, prod, sell] */
cityData: {[key: string]:number[]}; cityData: { [key: string]: number[] };
/** Creation progress - A number between 0-100 representing percentage */ /** Creation progress - A number between 0-100 representing percentage */
developmentProgress: number; developmentProgress: number;
} }