work on doc

This commit is contained in:
Olivier Gagnon
2021-10-30 15:46:34 -04:00
parent 920b7325b4
commit feb0430aff
366 changed files with 3235 additions and 4238 deletions

1206
dist/bitburner.d.ts vendored

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -4,7 +4,7 @@
## AugmentationStats.hacking\_grow\_mult property
Multipler to amount of money injected into servers using grow)<!-- -->}
Multipler to amount of money injected into servers using grow
<b>Signature:</b>

View File

@ -4,6 +4,7 @@
## AugmentationStats interface
Data representing the internal values of an Augmentation.
<b>Signature:</b>
@ -33,7 +34,7 @@ interface AugmentationStats
| [faction\_rep\_mult?](./bitburner.augmentationstats.faction_rep_mult.md) | number | <i>(Optional)</i> Multipler to amount of reputation gained when working |
| [hacking\_chance\_mult?](./bitburner.augmentationstats.hacking_chance_mult.md) | number | <i>(Optional)</i> Multipler to chance of successfully performing a hack |
| [hacking\_exp\_mult?](./bitburner.augmentationstats.hacking_exp_mult.md) | number | <i>(Optional)</i> Multipler to hacking experience gain rate |
| [hacking\_grow\_mult?](./bitburner.augmentationstats.hacking_grow_mult.md) | number | <i>(Optional)</i> Multipler to amount of money injected into servers using grow)<!-- -->} |
| [hacking\_grow\_mult?](./bitburner.augmentationstats.hacking_grow_mult.md) | number | <i>(Optional)</i> Multipler to amount of money injected into servers using grow |
| [hacking\_money\_mult?](./bitburner.augmentationstats.hacking_money_mult.md) | number | <i>(Optional)</i> Multipler to amount of money the player gains from hacking |
| [hacking\_mult?](./bitburner.augmentationstats.hacking_mult.md) | number | <i>(Optional)</i> Multipler to hacking skill |
| [hacking\_speed\_mult?](./bitburner.augmentationstats.hacking_speed_mult.md) | number | <i>(Optional)</i> Multipler to hacking speed |

View File

@ -4,6 +4,8 @@
## AugmentName type
All augmentation names.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,7 @@
## AugmentPair interface
Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md)
<b>Signature:</b>

View File

@ -4,6 +4,7 @@
## BasicHGWOptions interface
Options to affect the behavior of [hack](./bitburner.ns.hack.md)<!-- -->, [grow](./bitburner.ns.grow.md)<!-- -->, and [weaken](./bitburner.ns.weaken.md)<!-- -->.
<b>Signature:</b>
@ -15,5 +16,6 @@ interface BasicHGWOptions
| Property | Type | Description |
| --- | --- | --- |
| [stock?](./bitburner.basichgwoptions.stock.md) | boolean | <i>(Optional)</i> Set to true this action will affect the stock market. |
| [threads](./bitburner.basichgwoptions.threads.md) | number | Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. |

View File

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BasicHGWOptions](./bitburner.basichgwoptions.md) &gt; [stock](./bitburner.basichgwoptions.stock.md)
## BasicHGWOptions.stock property
Set to true this action will affect the stock market.
<b>Signature:</b>
```typescript
stock?: boolean;
```

View File

@ -4,6 +4,7 @@
## BitNodeMultipliers interface
All multipliers affecting the difficulty of the current challenge.
<b>Signature:</b>

View File

@ -34,5 +34,5 @@ True if the action is set to autolevel, and false otherwise.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -34,5 +34,5 @@ Remaining count of the specified action.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -34,5 +34,5 @@ Current level of the specified action.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -32,5 +32,5 @@ Estimated success chance for the specified action.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -34,5 +34,5 @@ Maximum level of the specified action.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -34,5 +34,5 @@ Average Bladeburner reputation gain for successfully completing the specified ac
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -32,5 +32,5 @@ Number of seconds it takes to complete the specified action.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -21,5 +21,5 @@ Array of strings containing the names of all Bladeburner Black Ops.
## Remarks
0.4 GB
RAM cost: 0.4 GB

View File

@ -30,5 +30,5 @@ Rank required to complete this BlackOp.
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -25,5 +25,5 @@ Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.
## Remarks
0 GB
RAM cost: 0 GB

View File

@ -21,5 +21,5 @@ City that the player is currently in (for Bladeburner).
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -28,5 +28,5 @@ Chaos in the specified city.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -28,5 +28,5 @@ Number of Synthoids communities in the specified city.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -28,5 +28,5 @@ Estimated number of Synthoids in the specified city.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -21,5 +21,5 @@ Array of strings containing the names of all Bladeburner contracts.
## Remarks
0.4 GB
RAM cost: 0.4 GB

View File

@ -21,5 +21,5 @@ Object that represents the players current Bladeburner action.
## Remarks
1 GB
RAM cost: 1 GB

View File

@ -21,5 +21,5 @@ Array of strings containing the names of all general Bladeburner actions.
## Remarks
0.4 GB
RAM cost: 0.4 GB

View File

@ -21,5 +21,5 @@ Array of strings containing the names of all Bladeburner operations.
## Remarks
0.4 GB
RAM cost: 0.4 GB

View File

@ -21,5 +21,5 @@ Players Bladeburner Rank.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -30,5 +30,5 @@ Level in the specified skill.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -21,5 +21,5 @@ Array of strings containing the names of all general Bladeburner skills.
## Remarks
0.4 GB
RAM cost: 0.4 GB

View File

@ -21,5 +21,5 @@ Number of Bladeburner skill points you have.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -30,5 +30,5 @@ Number of skill points needed to upgrade the specified skill.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -21,12 +21,12 @@ Array containing current stamina and max stamina.
## Remarks
4 GB
RAM cost: 4 GB
## Example
```js
```ts
function getStaminaPercentage() {
let res = bladeburner.getStamina();
return res[0] / res[1];

View File

@ -34,5 +34,5 @@ Number of Bladeburner team members that were assigned to the specified action.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -25,5 +25,5 @@ True if you successfully join the Bladeburner division, or if you are already a
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -25,5 +25,5 @@ True if you successfully join the Bladeburner faction, or if you are already a m
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -4,6 +4,7 @@
## Bladeburner interface
<b>Signature:</b>
```typescript

View File

@ -32,5 +32,5 @@ void
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -32,5 +32,5 @@ void
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -36,5 +36,5 @@ Number of Bladeburner team members you assigned to the specified action.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -32,5 +32,5 @@ True if the action was started successfully, and false otherwise.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -19,5 +19,5 @@ void
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -30,5 +30,5 @@ true if successful, and false otherwise
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -30,5 +30,5 @@ true if the skill is successfully upgraded, and false otherwise.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -4,6 +4,8 @@
## BladeburnerActTypes type
All Bladeburner action types.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,8 @@
## BladeburnerBlackOps type
All Bladeburner black ops.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,7 @@
## BladeburnerContracts type
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,7 @@
## BladeburnerCurAction interface
Bladeburner current action.
<b>Signature:</b>

View File

@ -4,6 +4,8 @@
## BladeburnerGenActions type
All Bladeburner General Actions.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,8 @@
## BladeburnerOperations type
All Bladeburner Ops.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,8 @@
## BladeburnerSkills type
All Bladeburner Skills.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,7 @@
## CharacterInfo interface
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,8 @@
## City type
All cities.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,7 @@
## CodingAttemptOptions interface
Options to affect the behavior of [CodingContract](./bitburner.codingcontract.md) attempt.
<b>Signature:</b>

View File

@ -9,16 +9,16 @@ Attempts to solve the Coding Contract with the provided solution.
<b>Signature:</b>
```typescript
attempt(answer: string | string[] | number, fn: string, host?: Host): boolean;
attempt(answer: string | string[] | number, fn: string, host?: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| answer | string \| string\[\] \| number | |
| answer | string \| string\[\] \| number | Solution for the contract. |
| fn | string | Filename of the contract. |
| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>
@ -28,5 +28,5 @@ True if the solution was correct, false otherwise.
## Remarks
10 GB - Solution for the contract.
10 GB

View File

@ -9,7 +9,7 @@ Attempts to solve the Coding Contract with the provided solution.
<b>Signature:</b>
```typescript
attempt(answer: string | string[] | number, fn: string, host?: Host, opts?: CodingAttemptOptions): boolean | string;
attempt(answer: string | string[] | number, fn: string, host?: string, opts?: CodingAttemptOptions): boolean | string;
```
## Parameters
@ -18,7 +18,7 @@ attempt(answer: string | string[] | number, fn: string, host?: Host, opts?: Codi
| --- | --- | --- |
| answer | string \| string\[\] \| number | Solution for the contract. |
| fn | string | Filename of the contract. |
| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
| opts | [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Optional parameters for configuring function behavior. |
<b>Returns:</b>

View File

@ -9,7 +9,7 @@ Returns a name describing the type of problem posed by the Coding Contract. (e.g
<b>Signature:</b>
```typescript
getContractType(fn: string, host?: Host): CodingContractTypes;
getContractType(fn: string, host?: string): CodingContractTypes;
```
## Parameters
@ -17,7 +17,7 @@ getContractType(fn: string, host?: Host): CodingContractTypes;
| Parameter | Type | Description |
| --- | --- | --- |
| fn | string | Filename of the contract. |
| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>
@ -27,5 +27,5 @@ Name describing the type of problem posed by the Coding Contract.
## Remarks
5 GB
RAM cost: 5 GB

View File

@ -9,7 +9,7 @@ Get the data associated with the specific Coding Contract. Note that this is not
<b>Signature:</b>
```typescript
getData(fn: string, host?: Host): string;
getData(fn: string, host?: string): string;
```
## Parameters
@ -17,7 +17,7 @@ getData(fn: string, host?: Host): string;
| Parameter | Type | Description |
| --- | --- | --- |
| fn | string | Filename of the contract. |
| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>
@ -27,5 +27,5 @@ The specified contracts data;
## Remarks
5 GB
RAM cost: 5 GB

View File

@ -9,7 +9,7 @@ Get the full text description for the problem posed by the Coding Contract.
<b>Signature:</b>
```typescript
getDescription(fn: string, host?: Host): string;
getDescription(fn: string, host?: string): string;
```
## Parameters
@ -17,7 +17,7 @@ getDescription(fn: string, host?: Host): string;
| Parameter | Type | Description |
| --- | --- | --- |
| fn | string | Filename of the contract. |
| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>
@ -27,5 +27,5 @@ Contracts text description.
## Remarks
5 GB
RAM cost: 5 GB

View File

@ -9,7 +9,7 @@ Get the number of tries remaining on the contract before it self-destructs.
<b>Signature:</b>
```typescript
getNumTriesRemaining(fn: string, host?: Host): number;
getNumTriesRemaining(fn: string, host?: string): number;
```
## Parameters
@ -17,7 +17,7 @@ getNumTriesRemaining(fn: string, host?: Host): number;
| Parameter | Type | Description |
| --- | --- | --- |
| fn | string | Filename of the contract. |
| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>
@ -27,5 +27,5 @@ How many attempts are remaining for the contract;
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -4,6 +4,7 @@
## CodingContract interface
Coding Contact API
<b>Signature:</b>

View File

@ -4,6 +4,8 @@
## CodingContractTypes type
All Coding contract types.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,8 @@
## CompanyField type
All company work fields.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,8 @@
## CompanyName type
All companies.
<b>Signature:</b>
```typescript

View File

@ -1,13 +0,0 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [CreatableProgram](./bitburner.creatableprogram.md)
## CreatableProgram type
<b>Signature:</b>
```typescript
type CreatableProgram = PurchaseableProgram | "serverprofiler.exe";
```
<b>References:</b> [PurchaseableProgram](./bitburner.purchaseableprogram.md)

View File

@ -4,6 +4,8 @@
## Crime type
All crimes.
<b>Signature:</b>
```typescript

View File

@ -4,7 +4,7 @@
## CrimeStats.karma property
Amount of karma lost for SUCCESSFULLY committing this crime
Amount of karma lost for successfully committing this crime
<b>Signature:</b>

View File

@ -4,6 +4,7 @@
## CrimeStats interface
Data representing the internal values of a crime.
<b>Signature:</b>
@ -27,7 +28,7 @@ interface CrimeStats
| [hacking\_exp](./bitburner.crimestats.hacking_exp.md) | number | hacking exp gained from crime |
| [hacking\_success\_weight](./bitburner.crimestats.hacking_success_weight.md) | number | hacking level impact on success change of the crime |
| [intelligence\_exp](./bitburner.crimestats.intelligence_exp.md) | number | intelligence exp gained from crime |
| [karma](./bitburner.crimestats.karma.md) | number | Amount of karma lost for SUCCESSFULLY committing this crime |
| [karma](./bitburner.crimestats.karma.md) | number | Amount of karma lost for successfully committing this crime |
| [kills](./bitburner.crimestats.kills.md) | number | How many people die as a result of this crime |
| [money](./bitburner.crimestats.money.md) | number | How much money is given |
| [name](./bitburner.crimestats.name.md) | number | Name of crime |

View File

@ -4,6 +4,8 @@
## FactionName type
All factions.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,8 @@
## FactionWork type
All faction work types.
<b>Signature:</b>
```typescript

View File

@ -28,5 +28,5 @@ Object with info about the ascension results.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -21,5 +21,5 @@ True if a member can currently be recruited, false otherwise.
## Remarks
1 GB
RAM cost: 1 GB

View File

@ -25,5 +25,5 @@ Bonus time for the Gang mechanic in seconds.
## Remarks
0 GB
RAM cost: 0 GB

View File

@ -28,5 +28,5 @@ Chance you have to win a clash with the specified gang.
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -28,5 +28,5 @@ Cost to purchase the specified Equipment/Augmentation (number). Infinity for inv
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -21,5 +21,5 @@ Names of all Equpiment/Augmentations.
## Remarks
1 GB
RAM cost: 1 GB

View File

@ -28,5 +28,5 @@ A dictionary containing the stats of the equipment.
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -28,5 +28,5 @@ Type of the equipment.
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -21,5 +21,5 @@ Object containing general information about the gang.
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -28,5 +28,5 @@ Object containing stat and equipment-related information about a Gang Member.
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -21,5 +21,5 @@ Names of all Gang members.
## Remarks
1 GB
RAM cost: 1 GB

View File

@ -21,5 +21,5 @@ Object containing territory and power information about all gangs.
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -21,5 +21,5 @@ All valid tasks that Gang members can be assigned to.
## Remarks
1 GB
RAM cost: 1 GB

View File

@ -28,5 +28,5 @@ Detailed stats of a task.
## Remarks
1 GB
RAM cost: 1 GB

View File

@ -4,6 +4,7 @@
## Gang interface
Gang API
<b>Signature:</b>

View File

@ -29,5 +29,5 @@ True if the equipment was successfully purchased. False otherwise
## Remarks
4 GB
RAM cost: 4 GB

View File

@ -30,5 +30,5 @@ True if the member was successfully recruited, false otherwise.
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -29,5 +29,5 @@ True if the Gang Member was successfully assigned to the task, false otherwise.
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -26,5 +26,5 @@ void
## Remarks
2 GB
RAM cost: 2 GB

View File

@ -4,6 +4,8 @@
## GangAugmentations type
All Gang augmentations.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,8 @@
## GangEquipment type
All Gang equipment.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,7 @@
## GangEquipmentStats interface
Object representing data representing a gang member equipment.
<b>Signature:</b>

View File

@ -4,6 +4,8 @@
## GangEquipmentType type
All Gang equipment type.
<b>Signature:</b>
```typescript

View File

@ -4,6 +4,7 @@
## GangGenInfo interface
Gang general info.
<b>Signature:</b>

View File

@ -4,7 +4,7 @@
## GangMemberAscension.agi property
Agility multiplier gained from ascending. Decimal form
Agility multiplier gained from ascending.
<b>Signature:</b>

View File

@ -4,7 +4,7 @@
## GangMemberAscension.cha property
Charisma multiplier gained from ascending. Decimal form
Charisma multiplier gained from ascending.
<b>Signature:</b>

View File

@ -4,7 +4,7 @@
## GangMemberAscension.def property
Defense multiplier gained from ascending. Decimal form
Defense multiplier gained from ascending.
<b>Signature:</b>

View File

@ -4,7 +4,7 @@
## GangMemberAscension.dex property
Dexterity multiplier gained from ascending. Decimal form
Dexterity multiplier gained from ascending.
<b>Signature:</b>

Some files were not shown because too many files have changed in this diff Show More