Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-08 16:53:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

allbuild commit a3c92dd0

Browse Source
This commit is contained in:
Olivier Gagnon 2022-09-23 15:03:38 -04:00
parent a3c92dd04d
commit c6da513eea
52 changed files with 451 additions and 126 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

164
dist/bitburner.d.ts vendored
View File

@ -96,7 +96,7 @@ export declare interface AutocompleteData {
servers: string[];
scripts: string[];
txts: string[];
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg };
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
}
/**
@ -773,7 +773,7 @@ export declare interface CodingContract {
*
* @param answer - Solution for the contract.
* @param filename - Filename of the contract.
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided.
* @param opts - Optional parameters for configuring function behavior.
* @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string.
*/
@ -793,7 +793,7 @@ export declare interface CodingContract {
* (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)
*
* @param filename - Filename of the contract.
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns Name describing the type of problem posed by the Coding Contract.
*/
getContractType(filename: string, host?: string): string;
@ -806,7 +806,7 @@ export declare interface CodingContract {
* Get the full text description for the problem posed by the Coding Contract.
*
* @param filename - Filename of the contract.
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns Contract’s text description.
*/
getDescription(filename: string, host?: string): string;
@ -818,24 +818,24 @@ export declare interface CodingContract {
*
* Get the data associated with the specific Coding Contract.
* Note that this is not the same as the contract’s description.
* This is just the data that the contract wants you to act on in order to solve
* This is just the data that the contract wants you to act on in order to solve the contract.
*
* @param filename - Filename of the contract.
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns The specified contract’s data, data type depends on contract type.;
* @returns The specified contract’s data, data type depends on contract type.
*/
getData(filename: string, host?: string): CodingContractData;
/**
* Get the number of attempt remaining.
* Get the number of attempts remaining.
* @remarks
* RAM cost: 2 GB
*
* Get the number of tries remaining on the contract before it self-destructs.
*
* @param filename - Filename of the contract.
* @param host - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns How many attempts are remaining for the contract;
* @param host - Hostname of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns How many attempts are remaining for the contract.
*/
getNumTriesRemaining(filename: string, host?: string): number;
}
@ -1026,7 +1026,7 @@ export declare interface CorporationInfo {
numShares: number;
/** Cooldown until shares can be sold again */
shareSaleCooldown: number;
/** Amount of shares issued */
/** Amount of aqcuirable shares. */
issuedShares: number;
/** Price of the shares */
sharePrice: number;
@ -1188,6 +1188,19 @@ export declare interface EquipmentStats {
hack?: number;
}
/**
* Export order for a material
* @public
*/
export declare interface Export {
/** Division the material is being exported to */
div: string;
/** City the material is being exported to */
loc: string;
/** Amount of material exported */
amt: string;
}
/**
* @public
*/
@ -1200,6 +1213,8 @@ export declare type FilenameOrPID = number | string;
* @public
*/
export declare interface Formulas {
mockServer(): Server;
mockPlayer(): Player;
/** Reputation formulas */
reputation: ReputationFormulas;
/** Skills formulas */
@ -1441,7 +1456,7 @@ export declare interface Gang {
* Ascend the specified Gang Member.
*
* @param memberName - Name of member to ascend.
* @returns Object with info about the ascension results. undefined if ascension did not occur.
* @returns Object with info about the ascension results. Undefined if ascension did not occur.
*/
ascendMember(memberName: string): GangMemberAscension | undefined;
@ -1453,7 +1468,7 @@ export declare interface Gang {
* Get the result of an ascension without ascending.
*
* @param memberName - Name of member.
* @returns Object with info about the ascension results. undefined if ascension is impossible.
* @returns Object with info about the ascension results. Undefined if ascension is impossible.
*/
getAscensionResult(memberName: string): GangMemberAscension | undefined;
@ -1896,7 +1911,7 @@ export declare interface Hacknet {
*
* Returns the number of Hacknet Nodes you own.
*
* @returns number of hacknet nodes.
* @returns Number of hacknet nodes.
*/
numNodes(): number;
@ -1905,7 +1920,7 @@ export declare interface Hacknet {
* @remarks
* RAM cost: 0 GB
*
* @returns maximum number of hacknet nodes.
* @returns Maximum number of hacknet nodes.
*/
maxNumNodes(): number;
@ -1980,13 +1995,13 @@ export declare interface Hacknet {
* So this is equivalent to multiplying the Node’s RAM by 2 n.
*
* Returns true if the Hacknet Node’s RAM is successfully upgraded n times
* or if it is upgraded some positive number of times and the Node reaches it max RAM.
* or if it is upgraded some positive number of times and the Node reaches its max RAM.
*
* Returns false otherwise.
*
* @param index - Index/Identifier of Hacknet Node.
* @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.
* @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise.
* @returns True if the Hacknet Node’s RAM is successfully upgraded, false otherwise.
*/
upgradeRam(index: number, n: number): boolean;
@ -2024,7 +2039,7 @@ export declare interface Hacknet {
*
* @param index - Index/Identifier of Hacknet Node.
* @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer.
* @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.
* @returns True if the Hacknet Node’s cache level is successfully upgraded, false otherwise.
*/
upgradeCache(index: number, n: number): boolean;
@ -2052,11 +2067,11 @@ export declare interface Hacknet {
* Returns the cost of upgrading the RAM of the specified Hacknet Node n times.
*
* If an invalid value for n is provided, then this function returns 0.
* If the specified Hacknet Node is already at max level, then Infinity is returned.
* If the specified Hacknet Node already has max RAM, then Infinity is returned.
*
* @param index - Index/Identifier of Hacknet Node.
* @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.
* @returns Cost of upgrading the specified Hacknet Node's ram.
* @returns Cost of upgrading the specified Hacknet Node's RAM.
*/
getRamUpgradeCost(index: number, n: number): number;
@ -2181,7 +2196,7 @@ export declare interface Hacknet {
* @param upgTarget - Object to which upgrade applies. Required for certain upgrades.
* @param count - Number of upgrades to buy at once. Defaults to 1 if not specified.
* For compatability reasons, upgTarget must be specified, even if it is not used, in order to specify count.
* @returns True if the upgrade is successfully purchased, and false otherwise..
* @returns True if the upgrade is successfully purchased, and false otherwise.
*/
spendHashes(upgName: string, upgTarget?: string, count?: number): boolean;
@ -2543,10 +2558,12 @@ export declare interface Material {
prod: number;
/** Amount of material sold */
sell: number;
/** cost to buy material */
/** Cost to buy material */
cost: number;
/** Sell cost, can be "MP+5" */
sCost: string | number;
/** Export orders */
exp: Export[];
}
/**
@ -3267,6 +3284,32 @@ export declare interface NS {
*/
tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void;
/**
* Move a tail window
* @remarks
* RAM cost: 0 GB
*
* Moves a tail window. Coordinates are in screenspace pixels (top left is 0,0)
*
* @param x - x coordinate.
* @param y - y coordinate.
* @param pid - Optional. PID of the script having its tail moved. If omitted, the current script is used.
*/
moveTail(x: number, y: number, pid?: number): void;
/**
* Resize a tail window
* @remarks
* RAM cost: 0 GB
*
* Resize a tail window. Size are in pixel
*
* @param width - width of the window.
* @param height - height of the window.
* @param pid - Optional. PID of the script having its tail resized. If omitted, the current script is used.
*/
resizeTail(width: number, height: number, pid?: number): void;
/**
* Close the tail window of a script.
* @remarks
@ -3642,7 +3685,7 @@ export declare interface NS {
* @remarks
* RAM cost: 0 GB
*/
exit(): void;
exit(): never;
/**
* Copy file between servers.
@ -3666,25 +3709,25 @@ export declare interface NS {
* ```ts
* // NS2:
* //Copies foo.lit from the helios server to the home computer:
* await ns.scp("foo.lit", "home", "helios" );
* ns.scp("foo.lit", "home", "helios" );
*
* //Tries to copy three files from rothman-uni to home computer:
* files = ["foo1.lit", "foo2.script", "foo3.script"];
* await ns.scp(files, "home", "rothman-uni");
* ns.scp(files, "home", "rothman-uni");
* ```
* @example
* ```ts
* //ns2, copies files from home to a target server
* const server = ns.args[0];
* const files = ["hack.js","weaken.js","grow.js"];
* await ns.scp(files, server, "home");
* ns.scp(files, server, "home");
* ```
* @param files - Filename or an array of filenames of script/literature files to copy.
* @param source - Host of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.
* @param destination - Host of the destination server, which is the server to which the file will be copied.
* @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.
* @param source - Host of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.
* @returns True if the file is successfully copied over and false otherwise. If the files argument is an array then this function will return false if any of the operations failed.
*/
scp(files: string | string[], destination: string, source?: string): Promise<boolean>;
scp(files: string | string[], destination: string, source?: string): boolean;
/**
* List files on a server.
@ -4224,20 +4267,20 @@ export declare interface NS {
* @remarks
* RAM cost: 0 GB
*
* This function can be used to write data to a text file (.txt).
* This function can be used to write data to a text file (.txt) or a script (.js or .script).
*
* This function will write data to that text file. If the specified text file does not exist,
* This function will write data to that file. If the specified file does not exist,
* then it will be created. The third argument mode, defines how the data will be written to
* the text file. If *mode is set to “w”, then the data is written in “write” mode which means
* that it will overwrite all existing data on the text file. If mode is set to any other value
* the file. If *mode is set to “w”, then the data is written in “write” mode which means
* that it will overwrite all existing data on the file. If mode is set to any other value
* then the data will be written in “append” mode which means that the data will be added at the
* end of the text file.
* end of the file.
*
* @param handle - Filename of the text file that will be written to.
* @param filename - Name of the file to be written to.
* @param data - Data to write.
* @param mode - Defines the write mode. Only valid when writing to text files.
* @param mode - Defines the write mode.
*/
write(handle: string, data?: string[] | number | string, mode?: "w" | "a"): Promise<void>;
write(filename: string, data?: string[] | number | string, mode?: "w" | "a"): void;
/**
* Attempt to write to a port.
@ -4259,15 +4302,15 @@ export declare interface NS {
* @remarks
* RAM cost: 0 GB
*
* This function is used to read data from a text file (.txt).
* This function is used to read data from a text file (.txt) or script (.script, .js).
*
* This function will return the data in the specified text
* file. If the text file does not exist, an empty string will be returned.
* This function will return the data in the specified file.
* If the file does not exist, an empty string will be returned.
*
* @param handle - Filename to read from.
* @param filename - Name of the file to be read.
* @returns Data in the specified text file.
*/
read(handle: string): PortData;
read(filename: string): string;
/**
* Get a copy of the data from a port without popping it.
@ -4784,7 +4827,7 @@ export declare interface NS {
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true}
* ```
*/
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg };
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
/**
* Share your computer with your factions.
@ -5224,6 +5267,28 @@ export declare interface Server {
* @public
*/
export declare interface Singularity {
/**
* Backup game save.
* @remarks
* RAM cost: 1 GB * 16/4/1
*
*
* This function will automatically opens the backup save prompt and claim the free faction favour if available.
*
*/
exportGame(): void;
/**
* Returns Backup save bonus availability.
* @remarks
* RAM cost: 0.5 GB * 16/4/1
*
*
* This function will check if there is a bonus for backing up your save.
*
*/
exportGameBonus(): boolean;
/**
* Take university class.
*
@ -5242,7 +5307,7 @@ export declare interface Singularity {
* @param universityName - Name of university. You must be in the correct city for whatever university you specify.
* @param courseName - Name of course.
* @param focus - Acquire player focus on this class. Optional. Defaults to true.
* @returns True if actions is successfully started, false otherwise.
* @returns True if action is successfully started, false otherwise.
*/
universityCourse(universityName: string, courseName: string, focus?: boolean): boolean;
@ -5278,7 +5343,7 @@ export declare interface Singularity {
* function is the same as the cost for traveling through the Travel Agency.
*
* @param city - City to travel to.
* @returns True if actions is successful, false otherwise.
* @returns True if action is successful, false otherwise.
*/
travelToCity(city: string): boolean;
@ -5718,7 +5783,7 @@ export declare interface Singularity {
* guarantee that your browser will follow that time limit.
*
* @param crime - Name of crime to attempt.
* @param focus - Acquire player focus on this program creation. Optional. Defaults to true.
* @param focus - Acquire player focus on this crime. Optional. Defaults to true.
* @returns The number of milliseconds it takes to attempt the specified crime.
*/
commitCrime(crime: string, focus?: boolean): number;
@ -6982,6 +7047,15 @@ export declare type ToastVariantValues = `${ToastVariant}`;
* @public
*/
export declare interface UserInterface {
/**
* Get the current window size
* @remarks
* RAM cost: 0 GB
*
* @returns An array of 2 value containing the window width and height.
*/
windowSize(): [number, number];
/**
* Get the current theme
* @remarks

6
dist/main.bundle.js vendored
View File

File diff suppressed because one or more lines are too long

2
dist/main.bundle.js.map vendored
View File

File diff suppressed because one or more lines are too long

42
dist/vendor.bundle.js vendored
View File

File diff suppressed because one or more lines are too long

2
dist/vendor.bundle.js.map vendored
View File

File diff suppressed because one or more lines are too long

4
doc/source/conf.py
View File

@ -64,9 +64,9 @@ documentation_title = '{0} Documentation'.format(project)
# built documents.
#
# The short X.Y version.
version = '2.0'
version = '2.1'
# The full version, including alpha/beta/rc tags.
release = '2.0.0'
release = '2.1.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

4
markdown/bitburner.autocompletedata.flags.md
View File

@ -7,7 +7,7 @@
<b>Signature:</b>
```typescript
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg };
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
```
## Parameters
@ -18,5 +18,5 @@ flags(schema: [string, string | number | boolean | string[]][]): { [key: string]
<b>Returns:</b>
{ \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) }
{ \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) \| string\[\] }

2
markdown/bitburner.codingcontract.attempt.md
View File

@ -23,7 +23,7 @@ attempt(
| --- | --- | --- |
| answer | string \| number \| any\[\] | Solution for the contract. |
| filename | string | Filename of the contract. |
| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Hostname 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>

2
markdown/bitburner.codingcontract.getcontracttype.md
View File

@ -17,7 +17,7 @@ getContractType(filename: string, host?: string): string;
| Parameter | Type | Description |
| --- | --- | --- |
| filename | string | Filename of the contract. |
| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>

4
markdown/bitburner.codingcontract.getdata.md
View File

@ -23,11 +23,11 @@ getData(filename: string, host?: string): CodingContractData;
[CodingContractData](./bitburner.codingcontractdata.md)
The specified contract’s data, data type depends on contract type.;
The specified contract’s data, data type depends on contract type.
## Remarks
RAM cost: 5 GB
Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve
Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve the contract.

2
markdown/bitburner.codingcontract.getdescription.md
View File

@ -17,7 +17,7 @@ getDescription(filename: string, host?: string): string;
| Parameter | Type | Description |
| --- | --- | --- |
| filename | string | Filename of the contract. |
| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>

6
markdown/bitburner.codingcontract.getnumtriesremaining.md
View File

@ -4,7 +4,7 @@
## CodingContract.getNumTriesRemaining() method
Get the number of attempt remaining.
Get the number of attempts remaining.
<b>Signature:</b>
@ -17,13 +17,13 @@ getNumTriesRemaining(filename: string, host?: string): number;
| Parameter | Type | Description |
| --- | --- | --- |
| filename | string | Filename of the contract. |
| host | string | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
| host | string | Hostname of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b>
number
How many attempts are remaining for the contract;
How many attempts are remaining for the contract.
## Remarks

2
markdown/bitburner.codingcontract.md
View File

@ -20,5 +20,5 @@ export interface CodingContract
| [getContractType(filename, host)](./bitburner.codingcontract.getcontracttype.md) | Get the type of a coding contract. |
| [getData(filename, host)](./bitburner.codingcontract.getdata.md) | Get the input data. |
| [getDescription(filename, host)](./bitburner.codingcontract.getdescription.md) | Get the description. |
| [getNumTriesRemaining(filename, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of attempt remaining. |
| [getNumTriesRemaining(filename, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of attempts remaining. |

2
markdown/bitburner.corporationinfo.issuedshares.md
View File

@ -4,7 +4,7 @@
## CorporationInfo.issuedShares property
Amount of shares issued
Amount of aqcuirable shares.
<b>Signature:</b>

2
markdown/bitburner.corporationinfo.md
View File

@ -22,7 +22,7 @@ interface CorporationInfo
| [divisions](./bitburner.corporationinfo.divisions.md) | [Division](./bitburner.division.md)<!-- -->\[\] | Array of all divisions |
| [expenses](./bitburner.corporationinfo.expenses.md) | number | Expenses per second this cycle |
| [funds](./bitburner.corporationinfo.funds.md) | number | Funds available |
| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | Amount of shares issued |
| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | Amount of aqcuirable shares. |
| [name](./bitburner.corporationinfo.name.md) | string | Name of the corporation |
| [numShares](./bitburner.corporationinfo.numshares.md) | number | Amount of share owned |
| [public](./bitburner.corporationinfo.public.md) | boolean | Indicating if the company is public |

13
markdown/bitburner.export.amt.md Normal file
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; [Export](./bitburner.export.md) &gt; [amt](./bitburner.export.amt.md)
## Export.amt property
Amount of material exported
<b>Signature:</b>
```typescript
amt: string;
```

13
markdown/bitburner.export.div.md Normal file
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; [Export](./bitburner.export.md) &gt; [div](./bitburner.export.div.md)
## Export.div property
Division the material is being exported to
<b>Signature:</b>
```typescript
div: string;
```

13
markdown/bitburner.export.loc.md Normal file
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; [Export](./bitburner.export.md) &gt; [loc](./bitburner.export.loc.md)
## Export.loc property
City the material is being exported to
<b>Signature:</b>
```typescript
loc: string;
```

22
markdown/bitburner.export.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Export](./bitburner.export.md)
## Export interface
Export order for a material
<b>Signature:</b>
```typescript
interface Export
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [amt](./bitburner.export.amt.md) | string | Amount of material exported |
| [div](./bitburner.export.div.md) | string | Division the material is being exported to |
| [loc](./bitburner.export.loc.md) | string | City the material is being exported to |

7
markdown/bitburner.formulas.md
View File

@ -28,3 +28,10 @@ You need Formulas.exe on your home computer to use this API.
| [skills](./bitburner.formulas.skills.md) | [SkillsFormulas](./bitburner.skillsformulas.md) | Skills formulas |
| [work](./bitburner.formulas.work.md) | [WorkFormulas](./bitburner.workformulas.md) | Work formulas |
## Methods
| Method | Description |
| --- | --- |
| [mockPlayer()](./bitburner.formulas.mockplayer.md) | |
| [mockServer()](./bitburner.formulas.mockserver.md) | |

15
markdown/bitburner.formulas.mockplayer.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Formulas](./bitburner.formulas.md) &gt; [mockPlayer](./bitburner.formulas.mockplayer.md)
## Formulas.mockPlayer() method
<b>Signature:</b>
```typescript
mockPlayer(): Player;
```
<b>Returns:</b>
[Player](./bitburner.player.md)

15
markdown/bitburner.formulas.mockserver.md Normal file
View File

@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Formulas](./bitburner.formulas.md) &gt; [mockServer](./bitburner.formulas.mockserver.md)
## Formulas.mockServer() method
<b>Signature:</b>
```typescript
mockServer(): Server;
```
<b>Returns:</b>
[Server](./bitburner.server.md)

2
markdown/bitburner.gang.ascendmember.md
View File

@ -22,7 +22,7 @@ ascendMember(memberName: string): GangMemberAscension | undefined;
[GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined
Object with info about the ascension results. undefined if ascension did not occur.
Object with info about the ascension results. Undefined if ascension did not occur.
## Remarks

2
markdown/bitburner.gang.getascensionresult.md
View File

@ -22,7 +22,7 @@ getAscensionResult(memberName: string): GangMemberAscension | undefined;
[GangMemberAscension](./bitburner.gangmemberascension.md) \| undefined
Object with info about the ascension results. undefined if ascension is impossible.
Object with info about the ascension results. Undefined if ascension is impossible.
## Remarks

4
markdown/bitburner.hacknet.getramupgradecost.md
View File

@ -23,7 +23,7 @@ getRamUpgradeCost(index: number, n: number): number;
number
Cost of upgrading the specified Hacknet Node's ram.
Cost of upgrading the specified Hacknet Node's RAM.
## Remarks
@ -31,5 +31,5 @@ RAM cost: 0 GB
Returns the cost of upgrading the RAM of the specified Hacknet Node n times.
If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.
If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node already has max RAM, then Infinity is returned.

2
markdown/bitburner.hacknet.maxnumnodes.md
View File

@ -15,7 +15,7 @@ maxNumNodes(): number;
number
maximum number of hacknet nodes.
Maximum number of hacknet nodes.
## Remarks

2
markdown/bitburner.hacknet.numnodes.md
View File

@ -15,7 +15,7 @@ numNodes(): number;
number
number of hacknet nodes.
Number of hacknet nodes.
## Remarks

2
markdown/bitburner.hacknet.spendhashes.md
View File

@ -24,7 +24,7 @@ spendHashes(upgName: string, upgTarget?: string, count?: number): boolean;
boolean
True if the upgrade is successfully purchased, and false otherwise..
True if the upgrade is successfully purchased, and false otherwise.
## Remarks

2
markdown/bitburner.hacknet.upgradecache.md
View File

@ -23,7 +23,7 @@ upgradeCache(index: number, n: number): boolean;
boolean
True if the Hacknet Node’s cores are successfully purchased, false otherwise.
True if the Hacknet Node’s cache level is successfully upgraded, false otherwise.
## Remarks

4
markdown/bitburner.hacknet.upgraderam.md
View File

@ -23,7 +23,7 @@ upgradeRam(index: number, n: number): boolean;
boolean
True if the Hacknet Node’s ram is successfully upgraded, false otherwise.
True if the Hacknet Node’s RAM is successfully upgraded, false otherwise.
## Remarks
@ -31,7 +31,7 @@ RAM cost: 0 GB
Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n.
Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM.
Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches its max RAM.
Returns false otherwise.

2
markdown/bitburner.material.cost.md
View File

@ -4,7 +4,7 @@
## Material.cost property
cost to buy material
Cost to buy material
<b>Signature:</b>

13
markdown/bitburner.material.exp.md Normal file
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; [Material](./bitburner.material.md) &gt; [exp](./bitburner.material.exp.md)
## Material.exp property
Export orders
<b>Signature:</b>
```typescript
exp: Export[];
```

3
markdown/bitburner.material.md
View File

@ -17,8 +17,9 @@ interface Material
| Property | Type | Description |
| --- | --- | --- |
| [cmp](./bitburner.material.cmp.md) | number \| undefined | Competition for the material, only present if "Market Research - Competition" unlocked |
| [cost](./bitburner.material.cost.md) | number | cost to buy material |
| [cost](./bitburner.material.cost.md) | number | Cost to buy material |
| [dmd](./bitburner.material.dmd.md) | number \| undefined | Demand for the material, only present if "Market Research - Demand" unlocked |
| [exp](./bitburner.material.exp.md) | [Export](./bitburner.export.md)<!-- -->\[\] | Export orders |
| [name](./bitburner.material.name.md) | string | Name of the material |
| [prod](./bitburner.material.prod.md) | number | Amount of material produced |
| [qlt](./bitburner.material.qlt.md) | number | Quality of the material |

1
markdown/bitburner.md
View File

@ -34,6 +34,7 @@
| [Employee](./bitburner.employee.md) | Employee in an office |
| [EmployeeJobs](./bitburner.employeejobs.md) | Object representing the number of employee in each job. |
| [EquipmentStats](./bitburner.equipmentstats.md) | Object representing data representing a gang member equipment. |
| [Export](./bitburner.export.md) | Export order for a material |
| [Formulas](./bitburner.formulas.md) | Formulas API |
| [Fragment](./bitburner.fragment.md) | |
| [Gang](./bitburner.gang.md) | Gang API |

4
markdown/bitburner.ns.exit.md
View File

@ -9,11 +9,11 @@ Terminates the current script immediately.
<b>Signature:</b>
```typescript
exit(): void;
exit(): never;
```
<b>Returns:</b>
void
never
## Remarks

4
markdown/bitburner.ns.flags.md
View File

@ -9,7 +9,7 @@ Parse command line flags.
<b>Signature:</b>
```typescript
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg };
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
```
## Parameters
@ -20,7 +20,7 @@ flags(schema: [string, string | number | boolean | string[]][]): { [key: string]
<b>Returns:</b>
{ \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) }
{ \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) \| string\[\] }
## Remarks

6
markdown/bitburner.ns.md
View File

@ -130,6 +130,7 @@ export async function main(ns) {
| [kill(script, host, args)](./bitburner.ns.kill_1.md) | Terminate another script. |
| [killall(host, safetyguard)](./bitburner.ns.killall.md) | Terminate all scripts on a server. |
| [ls(host, grep)](./bitburner.ns.ls.md) | List files on a server. |
| [moveTail(x, y, pid)](./bitburner.ns.movetail.md) | Move a tail window |
| [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. |
| [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number |
| [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. |
@ -139,9 +140,10 @@ export async function main(ns) {
| [prompt(txt, options)](./bitburner.ns.prompt.md) | Prompt the player with an input modal. |
| [ps(host)](./bitburner.ns.ps.md) | List running scripts on a server. |
| [purchaseServer(hostname, ram)](./bitburner.ns.purchaseserver.md) | Purchase a server. |
| [read(handle)](./bitburner.ns.read.md) | Read content of a file. |
| [read(filename)](./bitburner.ns.read.md) | Read content of a file. |
| [readPort(port)](./bitburner.ns.readport.md) | Read data from a port. |
| [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs relaySMTP.exe on a server. |
| [resizeTail(width, height, pid)](./bitburner.ns.resizetail.md) | Resize a tail window |
| [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. |
| [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. |
| [scan(host)](./bitburner.ns.scan.md) | Get the list of servers connected to a server. |
@ -164,6 +166,6 @@ export async function main(ns) {
| [weaken(host, opts)](./bitburner.ns.weaken.md) | Reduce a server security level. |
| [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Predict the effect of weaken. |
| [wget(url, target, host)](./bitburner.ns.wget.md) | Download a file from the internet. |
| [write(handle, data, mode)](./bitburner.ns.write.md) | Write data to a file. |
| [write(filename, data, mode)](./bitburner.ns.write.md) | Write data to a file. |
| [writePort(port, data)](./bitburner.ns.writeport.md) | Write data to a port. |

32
markdown/bitburner.ns.movetail.md Normal file
View File

@ -0,0 +1,32 @@
<!-- 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; [moveTail](./bitburner.ns.movetail.md)
## NS.moveTail() method
Move a tail window
<b>Signature:</b>
```typescript
moveTail(x: number, y: number, pid?: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| x | number | x coordinate. |
| y | number | y coordinate. |
| pid | number | Optional. PID of the script having its tail moved. If omitted, the current script is used. |
<b>Returns:</b>
void
## Remarks
RAM cost: 0 GB
Moves a tail window. Coordinates are in screenspace pixels (top left is 0,0)

10
markdown/bitburner.ns.read.md
View File

@ -9,18 +9,18 @@ Read content of a file.
<b>Signature:</b>
```typescript
read(handle: string): PortData;
read(filename: string): string;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| handle | string | Filename to read from. |
| filename | string | Name of the file to be read. |
<b>Returns:</b>
[PortData](./bitburner.portdata.md)
string
Data in the specified text file.
@ -28,7 +28,7 @@ Data in the specified text file.
RAM cost: 0 GB
This function is used to read data from a text file (.txt).
This function is used to read data from a text file (.txt) or script (.script, .js).
This function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.
This function will return the data in the specified file. If the file does not exist, an empty string will be returned.

32
markdown/bitburner.ns.resizetail.md Normal file
View File

@ -0,0 +1,32 @@
<!-- 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; [resizeTail](./bitburner.ns.resizetail.md)
## NS.resizeTail() method
Resize a tail window
<b>Signature:</b>
```typescript
resizeTail(width: number, height: number, pid?: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| width | number | width of the window. |
| height | number | height of the window. |
| pid | number | Optional. PID of the script having its tail resized. If omitted, the current script is used. |
<b>Returns:</b>
void
## Remarks
RAM cost: 0 GB
Resize a tail window. Size are in pixel

12
markdown/bitburner.ns.scp.md
View File

@ -9,7 +9,7 @@ Copy file between servers.
<b>Signature:</b>
```typescript
scp(files: string | string[], destination: string, source?: string): Promise<boolean>;
scp(files: string | string[], destination: string, source?: string): boolean;
```
## Parameters
@ -22,9 +22,9 @@ scp(files: string | string[], destination: string, source?: string): Promise<boo
<b>Returns:</b>
Promise&lt;boolean&gt;
boolean
True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.
True if the file is successfully copied over and false otherwise. If the files argument is an array then this function will return false if any of the operations failed.
## Remarks
@ -51,11 +51,11 @@ scp(files, "home", "rothman-uni");
```ts
// NS2:
//Copies foo.lit from the helios server to the home computer:
await ns.scp("foo.lit", "home", "helios" );
ns.scp("foo.lit", "home", "helios" );
//Tries to copy three files from rothman-uni to home computer:
files = ["foo1.lit", "foo2.script", "foo3.script"];
await ns.scp(files, "home", "rothman-uni");
ns.scp(files, "home", "rothman-uni");
```
## Example 3
@ -65,6 +65,6 @@ await ns.scp(files, "home", "rothman-uni");
//ns2, copies files from home to a target server
const server = ns.args[0];
const files = ["hack.js","weaken.js","grow.js"];
await ns.scp(files, server, "home");
ns.scp(files, server, "home");
```

12
markdown/bitburner.ns.write.md
View File

@ -9,26 +9,26 @@ Write data to a file.
<b>Signature:</b>
```typescript
write(handle: string, data?: string[] | number | string, mode?: "w" | "a"): Promise<void>;
write(filename: string, data?: string[] | number | string, mode?: "w" | "a"): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| handle | string | Filename of the text file that will be written to. |
| filename | string | Name of the file to be written to. |
| data | string\[\] \| number \| string | Data to write. |
| mode | "w" \| "a" | Defines the write mode. Only valid when writing to text files. |
| mode | "w" \| "a" | Defines the write mode. |
<b>Returns:</b>
Promise&lt;void&gt;
void
## Remarks
RAM cost: 0 GB
This function can be used to write data to a text file (.txt).
This function can be used to write data to a text file (.txt) or a script (.js or .script).
This function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If \*mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file.
This function will write data to that file. If the specified file does not exist, then it will be created. The third argument mode, defines how the data will be written to the file. If \*mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the file.

2
markdown/bitburner.singularity.commitcrime.md
View File

@ -17,7 +17,7 @@ commitCrime(crime: string, focus?: boolean): number;
| Parameter | Type | Description |
| --- | --- | --- |
| crime | string | Name of crime to attempt. |
| focus | boolean | Acquire player focus on this program creation. Optional. Defaults to true. |
| focus | boolean | Acquire player focus on this crime. Optional. Defaults to true. |
<b>Returns:</b>

23
markdown/bitburner.singularity.exportgame.md Normal file
View File

@ -0,0 +1,23 @@
<!-- 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; [exportGame](./bitburner.singularity.exportgame.md)
## Singularity.exportGame() method
Backup game save.
<b>Signature:</b>
```typescript
exportGame(): void;
```
<b>Returns:</b>
void
## Remarks
RAM cost: 1 GB \* 16/4/1
This function will automatically opens the backup save prompt and claim the free faction favour if available.

23
markdown/bitburner.singularity.exportgamebonus.md Normal file
View File

@ -0,0 +1,23 @@
<!-- 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; [exportGameBonus](./bitburner.singularity.exportgamebonus.md)
## Singularity.exportGameBonus() method
Returns Backup save bonus availability.
<b>Signature:</b>
```typescript
exportGameBonus(): boolean;
```
<b>Returns:</b>
boolean
## Remarks
RAM cost: 0.5 GB \* 16/4/1
This function will check if there is a bonus for backing up your save.

2
markdown/bitburner.singularity.md
View File

@ -28,6 +28,8 @@ This API requires Source-File 4 to use. The RAM cost of all these functions is m
| [createProgram(program, focus)](./bitburner.singularity.createprogram.md) | Create a program. |
| [destroyW0r1dD43m0n(nextBN, callbackScript)](./bitburner.singularity.destroyw0r1dd43m0n.md) | Destroy the w0r1d\_d43m0n and move on to the next BN. |
| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | Donate to a faction. |
| [exportGame()](./bitburner.singularity.exportgame.md) | Backup game save. |
| [exportGameBonus()](./bitburner.singularity.exportgamebonus.md) | Returns Backup save bonus availability. |
| [getAugmentationBasePrice(augName)](./bitburner.singularity.getaugmentationbaseprice.md) | Get base price of an augmentation. |
| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | Get the price and reputation of an augmentation. |
| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | Get the pre-requisite of an augmentation. |

2
markdown/bitburner.singularity.traveltocity.md
View File

@ -22,7 +22,7 @@ travelToCity(city: string): boolean;
boolean
True if actions is successful, false otherwise.
True if action is successful, false otherwise.
## Remarks

2
markdown/bitburner.singularity.universitycourse.md
View File

@ -24,7 +24,7 @@ universityCourse(universityName: string, courseName: string, focus?: boolean): b
boolean
True if actions is successfully started, false otherwise.
True if action is successfully started, false otherwise.
## Remarks

2
markdown/bitburner.sleeve.settobladeburneraction.md
View File

@ -16,7 +16,7 @@ setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string):
| Parameter | Type | Description |
| --- | --- | --- |
| sleeveNumber | number | Index of the sleeve which will perform Action. |
| sleeveNumber | number | Index of the sleeve to workout at the gym. |
| action | string | Name of the action to be performed. |
| contract | string | Name of the contract if applicable. |

1
markdown/bitburner.userinterface.md
View File

@ -24,4 +24,5 @@ interface UserInterface
| [resetTheme()](./bitburner.userinterface.resettheme.md) | Resets the player's theme to the default values |
| [setStyles(newStyles)](./bitburner.userinterface.setstyles.md) | Sets the current styles |
| [setTheme(newTheme)](./bitburner.userinterface.settheme.md) | Sets the current theme |
| [windowSize()](./bitburner.userinterface.windowsize.md) | Get the current window size |

23
markdown/bitburner.userinterface.windowsize.md Normal file
View File

@ -0,0 +1,23 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [UserInterface](./bitburner.userinterface.md) &gt; [windowSize](./bitburner.userinterface.windowsize.md)
## UserInterface.windowSize() method
Get the current window size
<b>Signature:</b>
```typescript
windowSize(): [number, number];
```
<b>Returns:</b>
\[number, number\]
An array of 2 value containing the window width and height.
## Remarks
RAM cost: 0 GB

2
package.json
View File

@ -1,7 +1,7 @@
{
"name": "bitburner",
"license": "SEE LICENSE IN license.txt",
"version": "2.0.1",
"version": "2.1.0",
"main": "electron-main.js",
"author": {
"name": "Daniel Xie & Olivier Gagnon"