Merge pull request #3270 from danielyxie/dev

Documentation generation
This commit is contained in:
hydroflame 2022-03-29 15:50:20 -04:00 committed by GitHub
commit c3fd002644
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
33 changed files with 520 additions and 50 deletions

154
dist/bitburner.d.ts vendored

@ -983,6 +983,16 @@ export declare interface Corporation extends WarehouseAPI, OfficeAPI {
* *
*/ */
sellShares(amount: number): void; sellShares(amount: number): void;
/**
* Get bonus time.
*
* Bonus time is accumulated when the game is offline or if the game is inactive in the browser.
*
* Bonus time makes the game progress faster.
*
* @returns Bonus time for the Corporation mechanic in milliseconds.
*/
getBonusTime(): number;
} }
/** /**
@ -1716,6 +1726,49 @@ export declare interface GangTerritory {
wanted: number; wanted: number;
} }
/**
* Grafting API
* @remarks
* This API requires Source-File 10 to use.
* @public
*/
export declare interface Grafting {
/**
* Retrieve the grafting cost of an aug.
* @remarks
* RAM cost: 3.75 GB
*
* @param augName - Name of the aug to check the price of. Must be an exact match.
* @returns The cost required to graft the named augmentation.
* @throws Will error if an invalid Augmentation name is provided.
*/
getAugmentationGraftPrice(augName: string): number;
/**
* Retrieves the time required to graft an aug.
* @remarks
* RAM cost: 3.75 GB
*
* @param augName - Name of the aug to check the grafting time of. Must be an exact match.
* @returns The time required, in millis, to graft the named augmentation.
* @throws Will error if an invalid Augmentation name is provided.
*/
getAugmentationGraftTime(augName: string): number;
/**
* Begins grafting the named aug. You must be in New Tokyo to use this.
* @remarks
* RAM cost: 7.5 GB
*
* @param augName - The name of the aug to begin grafting. Must be an exact match.
* @param focus - Acquire player focus on this Augmentation grafting. Optional. Defaults to true.
* @returns True if the aug successfully began grafting, false otherwise (e.g. not enough money, or
* invalid Augmentation name provided).
* @throws Will error if called while you are not in New Tokyo.
*/
graftAugmentation(augName: string, focus?: boolean): boolean;
}
/** /**
* Hacking formulas * Hacking formulas
* @public * @public
@ -2582,6 +2635,13 @@ export declare interface NS extends Singularity {
*/ */
readonly ui: UserInterface; readonly ui: UserInterface;
/**
* Namespace for grafting functions.
* @remarks
* RAM cost: 0 GB
*/
readonly grafting: Grafting;
/** /**
* Arguments passed into the script. * Arguments passed into the script.
* *
@ -4833,6 +4893,7 @@ export declare interface Player {
tor: boolean; tor: boolean;
hasCorporation: boolean; hasCorporation: boolean;
inBladeburner: boolean; inBladeburner: boolean;
entropy: number;
} }
/** /**
@ -5088,7 +5149,7 @@ export declare interface Singularity {
* purchasing a TOR router using this function is the same as if you were to * purchasing a TOR router using this function is the same as if you were to
* manually purchase one. * manually purchase one.
* *
* @returns True if actions is successful, false otherwise. * @returns True if actions is successful or you already own TOR router, false otherwise.
*/ */
purchaseTor(): boolean; purchaseTor(): boolean;
@ -5780,6 +5841,67 @@ export declare interface Singularity {
* @returns True if the focus was changed. * @returns True if the focus was changed.
*/ */
setFocus(focus: boolean): boolean; setFocus(focus: boolean): boolean;
/**
* Get a list of programs offered on the dark web.
* @remarks
* RAM cost: 1 GB * 16/4/1
*
*
* This function allows the player to get a list of programs available for purchase
* on the dark web. Players MUST have purchased Tor to get the list of programs
* available. If Tor has not been purchased yet, this function will return an
* empty list.
*
* @example
* ```ts
* // NS1
* getDarkwebProgramsAvailable();
* // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc]
* ```
* @example
* ```ts
* // NS2
* ns.getDarkwebProgramsAvailable();
* // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc]
* ```
* @returns - a list of programs available for purchase on the dark web, or [] if Tor has not
* been purchased
*/
getDarkwebPrograms(): string[];
/**
* Check the price of an exploit on the dark web
* @remarks
* RAM cost: 0.5 GB * 16/4/1
*
*
* This function allows you to check the price of a darkweb exploit/program.
* You MUST have a TOR router in order to use this function. The price returned
* by this function is the same price you would see with buy -l from the terminal.
* Returns the cost of the program if it has not been purchased yet, 0 if it
* has already been purchased, or -1 if Tor has not been purchased (and thus
* the program/exploit is not available for purchase).
*
* If the program does not exist, an error is thrown.
*
*
* @example
* ```ts
* // NS1
* getDarkwebProgramCost("brutessh.exe");
* ```
* @example
* ```ts
* // NS2
* ns.getDarkwebProgramCost("brutessh.exe");
* ```
* @param programName - Name of program to check the price of
* @returns Price of the specified darkweb program
* (if not yet purchased), 0 if it has already been purchased, or -1 if Tor has not been
* purchased. Throws an error if the specified program/exploit does not exist
*/
getDarkwebProgramCost(programName: string): number;
} }
/** /**
@ -6114,14 +6236,14 @@ export declare interface Stanek {
* RAM cost: 0.4 GB * RAM cost: 0.4 GB
* @returns The width of the gift. * @returns The width of the gift.
*/ */
width(): number; giftWidth(): number;
/** /**
* Stanek's Gift height. * Stanek's Gift height.
* @remarks * @remarks
* RAM cost: 0.4 GB * RAM cost: 0.4 GB
* @returns The height of the gift. * @returns The height of the gift.
*/ */
height(): number; giftHeight(): number;
/** /**
* Charge a fragment, increasing its power. * Charge a fragment, increasing its power.
@ -6131,7 +6253,7 @@ export declare interface Stanek {
* @param rootY - rootY Root Y against which to align the top left of the fragment. * @param rootY - rootY Root Y against which to align the top left of the fragment.
* @returns Promise that lasts until the charge action is over. * @returns Promise that lasts until the charge action is over.
*/ */
charge(rootX: number, rootY: number): Promise<void>; chargeFragment(rootX: number, rootY: number): Promise<void>;
/** /**
* List possible fragments. * List possible fragments.
@ -6156,7 +6278,7 @@ export declare interface Stanek {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
*/ */
clear(): void; clearGift(): void;
/** /**
* Check if fragment can be placed at specified location. * Check if fragment can be placed at specified location.
@ -6169,7 +6291,7 @@ export declare interface Stanek {
* @param fragmentId - fragmentId ID of the fragment to place. * @param fragmentId - fragmentId ID of the fragment to place.
* @returns true if the fragment can be placed at that position. false otherwise. * @returns true if the fragment can be placed at that position. false otherwise.
*/ */
canPlace(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; canPlaceFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
/** /**
* Place fragment on Stanek's Gift. * Place fragment on Stanek's Gift.
* @remarks * @remarks
@ -6181,7 +6303,7 @@ export declare interface Stanek {
* @param fragmentId - ID of the fragment to place. * @param fragmentId - ID of the fragment to place.
* @returns true if the fragment can be placed at that position. false otherwise. * @returns true if the fragment can be placed at that position. false otherwise.
*/ */
place(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; placeFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
/** /**
* Get placed fragment at location. * Get placed fragment at location.
* @remarks * @remarks
@ -6191,7 +6313,7 @@ export declare interface Stanek {
* @param rootY - Y against which to align the top left of the fragment. * @param rootY - Y against which to align the top left of the fragment.
* @returns The fragment at [rootX, rootY], if any. * @returns The fragment at [rootX, rootY], if any.
*/ */
get(rootX: number, rootY: number): ActiveFragment | undefined; getFragment(rootX: number, rootY: number): ActiveFragment | undefined;
/** /**
* Remove fragment at location. * Remove fragment at location.
@ -6202,7 +6324,7 @@ export declare interface Stanek {
* @param rootY - Y against which to align the top left of the fragment. * @param rootY - Y against which to align the top left of the fragment.
* @returns The fragment at [rootX, rootY], if any. * @returns The fragment at [rootX, rootY], if any.
*/ */
remove(rootX: number, rootY: number): boolean; removeFragment(rootX: number, rootY: number): boolean;
} }
/** /**
@ -6591,6 +6713,20 @@ export declare interface TIX {
* @returns True if you successfully purchased it or if you already have access, false otherwise. * @returns True if you successfully purchased it or if you already have access, false otherwise.
*/ */
purchase4SMarketDataTixApi(): boolean; purchase4SMarketDataTixApi(): boolean;
/**
* Purchase WSE Account.
* @remarks RAM cost: 2.5 GB
* @returns True if you successfully purchased it or if you already have access, false otherwise.
*/
purchaseWseAccount(): boolean;
/**
* Purchase TIX API Access
* @remarks RAM cost: 2.5 GB
* @returns True if you successfully purchased it or if you already have access, false otherwise.
*/
purchaseTixApi(): boolean;
} }
/** /**

@ -9,7 +9,7 @@ v1.6.0 - 2022-03-29 Grafting
** Vitalife secret lab ** ** Vitalife secret lab **
* A new mechanic called Augmentation Grafting has been added. Resleeving has been removed. * A new mechanic called Augmentation Grafting has been added. Resleeving has been removed.
* Credit to @nikfolas for his incredible work. * Credit to @nickofolas for his incredible work.
** Stanek ** ** Stanek **
@ -17,7 +17,7 @@ v1.6.0 - 2022-03-29 Grafting
** UI ** ** UI **
* Major update to Sleeve, Gang UI, and Create Program (@nikfolas) * Major update to Sleeve, Gang UI, and Create Program (@nickofolas)
* re-add pre tags to support slash n in prompt (@jacktose) * re-add pre tags to support slash n in prompt (@jacktose)
* Tabelize linked output of 'ls' (@Master-Guy) * Tabelize linked output of 'ls' (@Master-Guy)
* Add the ability to filter open scripts (@phyzical) * Add the ability to filter open scripts (@phyzical)
@ -123,7 +123,7 @@ v1.5.0 - Steam Cloud integration
* Fix display of corporation product equation (@SagePtr) * Fix display of corporation product equation (@SagePtr)
* Make Bitverse more accessible (@ChrissiQ) * Make Bitverse more accessible (@ChrissiQ)
* Make corporation warehouse more accessible (@ChrissiQ) * Make corporation warehouse more accessible (@ChrissiQ)
* Make tab style more consistent (@nikfolas) * Make tab style more consistent (@nickofolas)
** Netscript ** ** Netscript **

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

@ -0,0 +1,23 @@
<!-- 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; [getBonusTime](./bitburner.corporation.getbonustime.md)
## Corporation.getBonusTime() method
Get bonus time.
“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
“Bonus time” makes the game progress faster.
<b>Signature:</b>
```typescript
getBonusTime(): number;
```
<b>Returns:</b>
number
Bonus time for the Corporation mechanic in milliseconds.

@ -23,6 +23,7 @@ export interface Corporation extends WarehouseAPI, OfficeAPI
| [createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md) | Create a Corporation | | [createCorporation(corporationName, selfFund)](./bitburner.corporation.createcorporation.md) | Create a Corporation |
| [expandCity(divisionName, cityName)](./bitburner.corporation.expandcity.md) | Expand to a new city | | [expandCity(divisionName, cityName)](./bitburner.corporation.expandcity.md) | Expand to a new city |
| [expandIndustry(industryType, divisionName)](./bitburner.corporation.expandindustry.md) | Expand to a new industry | | [expandIndustry(industryType, divisionName)](./bitburner.corporation.expandindustry.md) | Expand to a new industry |
| [getBonusTime()](./bitburner.corporation.getbonustime.md) | Get bonus time.<!-- -->“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.<!-- -->“Bonus time” makes the game progress faster. |
| [getCorporation()](./bitburner.corporation.getcorporation.md) | Get corporation data | | [getCorporation()](./bitburner.corporation.getcorporation.md) | Get corporation data |
| [getDivision(divisionName)](./bitburner.corporation.getdivision.md) | Get division data | | [getDivision(divisionName)](./bitburner.corporation.getdivision.md) | Get division data |
| [getExpandCityCost()](./bitburner.corporation.getexpandcitycost.md) | Gets the cost to expand into a new city | | [getExpandCityCost()](./bitburner.corporation.getexpandcitycost.md) | Gets the cost to expand into a new city |

@ -0,0 +1,34 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Grafting](./bitburner.grafting.md) &gt; [getAugmentationGraftPrice](./bitburner.grafting.getaugmentationgraftprice.md)
## Grafting.getAugmentationGraftPrice() method
Retrieve the grafting cost of an aug.
<b>Signature:</b>
```typescript
getAugmentationGraftPrice(augName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| augName | string | Name of the aug to check the price of. Must be an exact match. |
<b>Returns:</b>
number
The cost required to graft the named augmentation.
## Exceptions
Will error if an invalid Augmentation name is provided.
## Remarks
RAM cost: 3.75 GB

@ -0,0 +1,34 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Grafting](./bitburner.grafting.md) &gt; [getAugmentationGraftTime](./bitburner.grafting.getaugmentationgrafttime.md)
## Grafting.getAugmentationGraftTime() method
Retrieves the time required to graft an aug.
<b>Signature:</b>
```typescript
getAugmentationGraftTime(augName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| augName | string | Name of the aug to check the grafting time of. Must be an exact match. |
<b>Returns:</b>
number
The time required, in millis, to graft the named augmentation.
## Exceptions
Will error if an invalid Augmentation name is provided.
## Remarks
RAM cost: 3.75 GB

@ -0,0 +1,35 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Grafting](./bitburner.grafting.md) &gt; [graftAugmentation](./bitburner.grafting.graftaugmentation.md)
## Grafting.graftAugmentation() method
Begins grafting the named aug. You must be in New Tokyo to use this.
<b>Signature:</b>
```typescript
graftAugmentation(augName: string, focus?: boolean): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| augName | string | The name of the aug to begin grafting. Must be an exact match. |
| focus | boolean | Acquire player focus on this Augmentation grafting. Optional. Defaults to true. |
<b>Returns:</b>
boolean
True if the aug successfully began grafting, false otherwise (e.g. not enough money, or invalid Augmentation name provided).
## Exceptions
Will error if called while you are not in New Tokyo.
## Remarks
RAM cost: 7.5 GB

@ -0,0 +1,26 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Grafting](./bitburner.grafting.md)
## Grafting interface
Grafting API
<b>Signature:</b>
```typescript
export interface Grafting
```
## Remarks
This API requires Source-File 10 to use.
## Methods
| Method | Description |
| --- | --- |
| [getAugmentationGraftPrice(augName)](./bitburner.grafting.getaugmentationgraftprice.md) | Retrieve the grafting cost of an aug. |
| [getAugmentationGraftTime(augName)](./bitburner.grafting.getaugmentationgrafttime.md) | Retrieves the time required to graft an aug. |
| [graftAugmentation(augName, focus)](./bitburner.grafting.graftaugmentation.md) | Begins grafting the named aug. You must be in New Tokyo to use this. |

@ -45,6 +45,7 @@
| [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | | | [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | |
| [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. | | [GangTaskStats](./bitburner.gangtaskstats.md) | Object representing data representing a gang member task. |
| [GangTerritory](./bitburner.gangterritory.md) | | | [GangTerritory](./bitburner.gangterritory.md) | |
| [Grafting](./bitburner.grafting.md) | Grafting API |
| [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas | | [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas |
| [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. | | [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
| [Hacknet](./bitburner.hacknet.md) | Hacknet API | | [Hacknet](./bitburner.hacknet.md) | Hacknet API |

@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [grafting](./bitburner.ns.grafting.md)
## NS.grafting property
Namespace for grafting functions.
<b>Signature:</b>
```typescript
readonly grafting: Grafting;
```
## Remarks
RAM cost: 0 GB

@ -47,6 +47,7 @@ export async function main(ns) {
| [corporation](./bitburner.ns.corporation.md) | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 0 GB | | [corporation](./bitburner.ns.corporation.md) | [Corporation](./bitburner.corporation.md) | Namespace for corporation functions. RAM cost: 0 GB |
| [formulas](./bitburner.ns.formulas.md) | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. | | [formulas](./bitburner.ns.formulas.md) | [Formulas](./bitburner.formulas.md) | Namespace for formulas functions. |
| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. | | [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. |
| [grafting](./bitburner.ns.grafting.md) | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. |
| [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. | | [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. |
| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. | | [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. |
| [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB | | [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB |

@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Player](./bitburner.player.md) &gt; [entropy](./bitburner.player.entropy.md)
## Player.entropy property
<b>Signature:</b>
```typescript
entropy: number;
```

@ -47,6 +47,7 @@ interface Player
| [dexterity\_exp](./bitburner.player.dexterity_exp.md) | number | | | [dexterity\_exp](./bitburner.player.dexterity_exp.md) | number | |
| [dexterity\_mult](./bitburner.player.dexterity_mult.md) | number | | | [dexterity\_mult](./bitburner.player.dexterity_mult.md) | number | |
| [dexterity](./bitburner.player.dexterity.md) | number | | | [dexterity](./bitburner.player.dexterity.md) | number | |
| [entropy](./bitburner.player.entropy.md) | number | |
| [faction\_rep\_mult](./bitburner.player.faction_rep_mult.md) | number | | | [faction\_rep\_mult](./bitburner.player.faction_rep_mult.md) | number | |
| [factions](./bitburner.player.factions.md) | string\[\] | | | [factions](./bitburner.player.factions.md) | string\[\] | |
| [hacking\_chance\_mult](./bitburner.player.hacking_chance_mult.md) | number | | | [hacking\_chance\_mult](./bitburner.player.hacking_chance_mult.md) | number | |

@ -0,0 +1,50 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [getDarkwebProgramCost](./bitburner.singularity.getdarkwebprogramcost.md)
## Singularity.getDarkwebProgramCost() method
Check the price of an exploit on the dark web
<b>Signature:</b>
```typescript
getDarkwebProgramCost(programName: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| programName | string | Name of program to check the price of |
<b>Returns:</b>
number
Price of the specified darkweb program (if not yet purchased), 0 if it has already been purchased, or -1 if Tor has not been purchased. Throws an error if the specified program/exploit does not exist
## Remarks
RAM cost: 0.5 GB \* 16/4/1
This function allows you to check the price of a darkweb exploit/program. You MUST have a TOR router in order to use this function. The price returned by this function is the same price you would see with buy -l from the terminal. Returns the cost of the program if it has not been purchased yet, 0 if it has already been purchased, or -1 if Tor has not been purchased (and thus the program/exploit is not available for purchase).
If the program does not exist, an error is thrown.
## Example 1
```ts
// NS1
getDarkwebProgramCost("brutessh.exe");
```
## Example 2
```ts
// NS2
ns.getDarkwebProgramCost("brutessh.exe");
```

@ -0,0 +1,43 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Singularity](./bitburner.singularity.md) &gt; [getDarkwebPrograms](./bitburner.singularity.getdarkwebprograms.md)
## Singularity.getDarkwebPrograms() method
Get a list of programs offered on the dark web.
<b>Signature:</b>
```typescript
getDarkwebPrograms(): string[];
```
<b>Returns:</b>
string\[\]
- a list of programs available for purchase on the dark web, or \[\] if Tor has not been purchased
## Remarks
RAM cost: 1 GB \* 16/4/1
This function allows the player to get a list of programs available for purchase on the dark web. Players MUST have purchased Tor to get the list of programs available. If Tor has not been purchased yet, this function will return an empty list.
## Example 1
```ts
// NS1
getDarkwebProgramsAvailable();
// returns ['BruteSSH.exe', 'FTPCrack.exe'...etc]
```
## Example 2
```ts
// NS2
ns.getDarkwebProgramsAvailable();
// returns ['BruteSSH.exe', 'FTPCrack.exe'...etc]
```

@ -39,6 +39,8 @@ This API requires Source-File 4 to use. The RAM cost of all these functions is m
| [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | Get chance to successfully commit a crime. | | [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | Get chance to successfully commit a crime. |
| [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | Get stats related to a crime. | | [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | Get stats related to a crime. |
| [getCurrentServer()](./bitburner.singularity.getcurrentserver.md) | Get the current server. | | [getCurrentServer()](./bitburner.singularity.getcurrentserver.md) | Get the current server. |
| [getDarkwebProgramCost(programName)](./bitburner.singularity.getdarkwebprogramcost.md) | Check the price of an exploit on the dark web |
| [getDarkwebPrograms()](./bitburner.singularity.getdarkwebprograms.md) | Get a list of programs offered on the dark web. |
| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | Get faction favor. | | [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | Get faction favor. |
| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | Get faction favor gain. | | [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | Get faction favor gain. |
| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | Get faction reputation. | | [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | Get faction reputation. |

@ -15,7 +15,7 @@ purchaseTor(): boolean;
boolean boolean
True if actions is successful, false otherwise. True if actions is successful or you already own TOR router, false otherwise.
## Remarks ## Remarks

@ -1,15 +1,15 @@
<!-- 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; [Stanek](./bitburner.stanek.md) &gt; [canPlace](./bitburner.stanek.canplace.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stanek](./bitburner.stanek.md) &gt; [canPlaceFragment](./bitburner.stanek.canplacefragment.md)
## Stanek.canPlace() method ## Stanek.canPlaceFragment() method
Check if fragment can be placed at specified location. Check if fragment can be placed at specified location.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
canPlace(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; canPlaceFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
``` ```
## Parameters ## Parameters

@ -1,15 +1,15 @@
<!-- 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; [Stanek](./bitburner.stanek.md) &gt; [charge](./bitburner.stanek.charge.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stanek](./bitburner.stanek.md) &gt; [chargeFragment](./bitburner.stanek.chargefragment.md)
## Stanek.charge() method ## Stanek.chargeFragment() method
Charge a fragment, increasing its power. Charge a fragment, increasing its power.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
charge(rootX: number, rootY: number): Promise<void>; chargeFragment(rootX: number, rootY: number): Promise<void>;
``` ```
## Parameters ## Parameters

@ -1,15 +1,15 @@
<!-- 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; [Stanek](./bitburner.stanek.md) &gt; [clear](./bitburner.stanek.clear.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stanek](./bitburner.stanek.md) &gt; [clearGift](./bitburner.stanek.cleargift.md)
## Stanek.clear() method ## Stanek.clearGift() method
Clear the board of all fragments. Clear the board of all fragments.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
clear(): void; clearGift(): void;
``` ```
<b>Returns:</b> <b>Returns:</b>

@ -1,15 +1,15 @@
<!-- 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; [Stanek](./bitburner.stanek.md) &gt; [get](./bitburner.stanek.get.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stanek](./bitburner.stanek.md) &gt; [getFragment](./bitburner.stanek.getfragment.md)
## Stanek.get() method ## Stanek.getFragment() method
Get placed fragment at location. Get placed fragment at location.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
get(rootX: number, rootY: number): ActiveFragment | undefined; getFragment(rootX: number, rootY: number): ActiveFragment | undefined;
``` ```
## Parameters ## Parameters

@ -1,15 +1,15 @@
<!-- 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; [Stanek](./bitburner.stanek.md) &gt; [height](./bitburner.stanek.height.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stanek](./bitburner.stanek.md) &gt; [giftHeight](./bitburner.stanek.giftheight.md)
## Stanek.height() method ## Stanek.giftHeight() method
Stanek's Gift height. Stanek's Gift height.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
height(): number; giftHeight(): number;
``` ```
<b>Returns:</b> <b>Returns:</b>

@ -1,15 +1,15 @@
<!-- 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; [Stanek](./bitburner.stanek.md) &gt; [width](./bitburner.stanek.width.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stanek](./bitburner.stanek.md) &gt; [giftWidth](./bitburner.stanek.giftwidth.md)
## Stanek.width() method ## Stanek.giftWidth() method
Stanek's Gift width. Stanek's Gift width.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
width(): number; giftWidth(): number;
``` ```
<b>Returns:</b> <b>Returns:</b>

@ -17,13 +17,13 @@ interface Stanek
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [activeFragments()](./bitburner.stanek.activefragments.md) | List of fragments in Stanek's Gift. | | [activeFragments()](./bitburner.stanek.activefragments.md) | List of fragments in Stanek's Gift. |
| [canPlace(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.canplace.md) | Check if fragment can be placed at specified location. | | [canPlaceFragment(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.canplacefragment.md) | Check if fragment can be placed at specified location. |
| [charge(rootX, rootY)](./bitburner.stanek.charge.md) | Charge a fragment, increasing its power. | | [chargeFragment(rootX, rootY)](./bitburner.stanek.chargefragment.md) | Charge a fragment, increasing its power. |
| [clear()](./bitburner.stanek.clear.md) | Clear the board of all fragments. | | [clearGift()](./bitburner.stanek.cleargift.md) | Clear the board of all fragments. |
| [fragmentDefinitions()](./bitburner.stanek.fragmentdefinitions.md) | List possible fragments. | | [fragmentDefinitions()](./bitburner.stanek.fragmentdefinitions.md) | List possible fragments. |
| [get(rootX, rootY)](./bitburner.stanek.get.md) | Get placed fragment at location. | | [getFragment(rootX, rootY)](./bitburner.stanek.getfragment.md) | Get placed fragment at location. |
| [height()](./bitburner.stanek.height.md) | Stanek's Gift height. | | [giftHeight()](./bitburner.stanek.giftheight.md) | Stanek's Gift height. |
| [place(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.place.md) | Place fragment on Stanek's Gift. | | [giftWidth()](./bitburner.stanek.giftwidth.md) | Stanek's Gift width. |
| [remove(rootX, rootY)](./bitburner.stanek.remove.md) | Remove fragment at location. | | [placeFragment(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.placefragment.md) | Place fragment on Stanek's Gift. |
| [width()](./bitburner.stanek.width.md) | Stanek's Gift width. | | [removeFragment(rootX, rootY)](./bitburner.stanek.removefragment.md) | Remove fragment at location. |

@ -1,15 +1,15 @@
<!-- 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; [Stanek](./bitburner.stanek.md) &gt; [place](./bitburner.stanek.place.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stanek](./bitburner.stanek.md) &gt; [placeFragment](./bitburner.stanek.placefragment.md)
## Stanek.place() method ## Stanek.placeFragment() method
Place fragment on Stanek's Gift. Place fragment on Stanek's Gift.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
place(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean; placeFragment(rootX: number, rootY: number, rotation: number, fragmentId: number): boolean;
``` ```
## Parameters ## Parameters

@ -1,15 +1,15 @@
<!-- 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; [Stanek](./bitburner.stanek.md) &gt; [remove](./bitburner.stanek.remove.md) [Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Stanek](./bitburner.stanek.md) &gt; [removeFragment](./bitburner.stanek.removefragment.md)
## Stanek.remove() method ## Stanek.removeFragment() method
Remove fragment at location. Remove fragment at location.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
remove(rootX: number, rootY: number): boolean; removeFragment(rootX: number, rootY: number): boolean;
``` ```
## Parameters ## Parameters

@ -32,6 +32,8 @@ export interface TIX
| [placeOrder(sym, shares, price, type, pos)](./bitburner.tix.placeorder.md) | Place order for stocks. | | [placeOrder(sym, shares, price, type, pos)](./bitburner.tix.placeorder.md) | Place order for stocks. |
| [purchase4SMarketData()](./bitburner.tix.purchase4smarketdata.md) | Purchase 4S Market Data Access. | | [purchase4SMarketData()](./bitburner.tix.purchase4smarketdata.md) | Purchase 4S Market Data Access. |
| [purchase4SMarketDataTixApi()](./bitburner.tix.purchase4smarketdatatixapi.md) | Purchase 4S Market Data TIX API Access. | | [purchase4SMarketDataTixApi()](./bitburner.tix.purchase4smarketdatatixapi.md) | Purchase 4S Market Data TIX API Access. |
| [purchaseTixApi()](./bitburner.tix.purchasetixapi.md) | Purchase TIX API Access |
| [purchaseWseAccount()](./bitburner.tix.purchasewseaccount.md) | Purchase WSE Account. |
| [sell(sym, shares)](./bitburner.tix.sell.md) | Sell stocks. | | [sell(sym, shares)](./bitburner.tix.sell.md) | Sell stocks. |
| [sellShort(sym, shares)](./bitburner.tix.sellshort.md) | Sell short stock. | | [sellShort(sym, shares)](./bitburner.tix.sellshort.md) | Sell short stock. |
| [short(sym, shares)](./bitburner.tix.short.md) | Short stocks. | | [short(sym, shares)](./bitburner.tix.short.md) | Short stocks. |

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [purchaseTixApi](./bitburner.tix.purchasetixapi.md)
## TIX.purchaseTixApi() method
Purchase TIX API Access
<b>Signature:</b>
```typescript
purchaseTixApi(): boolean;
```
<b>Returns:</b>
boolean
True if you successfully purchased it or if you already have access, false otherwise.
## Remarks
RAM cost: 2.5 GB

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [TIX](./bitburner.tix.md) &gt; [purchaseWseAccount](./bitburner.tix.purchasewseaccount.md)
## TIX.purchaseWseAccount() method
Purchase WSE Account.
<b>Signature:</b>
```typescript
purchaseWseAccount(): boolean;
```
<b>Returns:</b>
boolean
True if you successfully purchased it or if you already have access, false otherwise.
## Remarks
RAM cost: 2.5 GB

@ -293,7 +293,7 @@ export const CONSTANTS: {
** Vitalife secret lab ** ** Vitalife secret lab **
* A new mechanic called Augmentation Grafting has been added. Resleeving has been removed. * A new mechanic called Augmentation Grafting has been added. Resleeving has been removed.
* Credit to @nikfolas for his incredible work. * Credit to @nickofolas for his incredible work.
** Stanek ** ** Stanek **
@ -301,7 +301,7 @@ export const CONSTANTS: {
** UI ** ** UI **
* Major update to Sleeve, Gang UI, and Create Program (@nikfolas) * Major update to Sleeve, Gang UI, and Create Program (@nickofolas)
* re-add pre tags to support slash n in prompt (@jacktose) * re-add pre tags to support slash n in prompt (@jacktose)
* Tabelize linked output of 'ls' (@Master-Guy) * Tabelize linked output of 'ls' (@Master-Guy)
* Add the ability to filter open scripts (@phyzical) * Add the ability to filter open scripts (@phyzical)

@ -3720,6 +3720,12 @@ export interface Sleeve {
purchaseSleeveAug(sleeveNumber: number, augName: string): boolean; purchaseSleeveAug(sleeveNumber: number, augName: string): boolean;
} }
/**
* Grafting API
* @remarks
* This API requires Source-File 10 to use.
* @public
*/
export interface Grafting { export interface Grafting {
/** /**
* Retrieve the grafting cost of an aug. * Retrieve the grafting cost of an aug.