work on doc

This commit is contained in:
Olivier Gagnon 2021-10-30 12:34:14 -04:00
parent f99c3fd0cd
commit 43fc5dfd48
589 changed files with 63720 additions and 1168 deletions

364
api-extractor.json Normal file

@ -0,0 +1,364 @@
/**
* Config file for API Extractor. For more info, please visit: https://api-extractor.com
*/
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
/**
* Optionally specifies another JSON config file that this file extends from. This provides a way for
* standard settings to be shared across multiple projects.
*
* If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
* the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be
* resolved using NodeJS require().
*
* SUPPORTED TOKENS: none
* DEFAULT VALUE: ""
*/
// "extends": "./shared/api-extractor-base.json"
// "extends": "my-package/include/api-extractor-base.json"
/**
* Determines the "<projectFolder>" token that can be used with other config file settings. The project folder
* typically contains the tsconfig.json and package.json config files, but the path is user-defined.
*
* The path is resolved relative to the folder of the config file that contains the setting.
*
* The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
* parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
* that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error
* will be reported.
*
* SUPPORTED TOKENS: <lookup>
* DEFAULT VALUE: "<lookup>"
*/
// "projectFolder": "..",
/**
* (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor
* analyzes the symbols exported by this module.
*
* The file extension must be ".d.ts" and not ".ts".
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
*/
"mainEntryPointFilePath": "src/ScriptEditor/NetscriptDefinitions.d.ts",
/**
* A list of NPM package names whose exports should be treated as part of this package.
*
* For example, suppose that Webpack is used to generate a distributed bundle for the project "library1",
* and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part
* of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly
* imports library2. To avoid this, we can specify:
*
* "bundledPackages": [ "library2" ],
*
* This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been
* local files for library1.
*/
"bundledPackages": [],
/**
* Determines how the TypeScript compiler engine will be invoked by API Extractor.
*/
"compiler": {
/**
* Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* Note: This setting will be ignored if "overrideTsconfig" is used.
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<projectFolder>/tsconfig.json"
*/
// "tsconfigFilePath": "<projectFolder>/tsconfig.json",
/**
* Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
* The object must conform to the TypeScript tsconfig schema:
*
* http://json.schemastore.org/tsconfig
*
* If omitted, then the tsconfig.json file will be read from the "projectFolder".
*
* DEFAULT VALUE: no overrideTsconfig section
*/
// "overrideTsconfig": {
// . . .
// }
/**
* This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
* and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
* dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
* for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
*
* DEFAULT VALUE: false
*/
// "skipLibCheck": true,
},
/**
* Configures how the API report file (*.api.md) will be generated.
*/
"apiReport": {
/**
* (REQUIRED) Whether to generate an API report.
*/
"enabled": true
/**
* The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce
* a full file path.
*
* The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
*
* SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<unscopedPackageName>.api.md"
*/
// "reportFileName": "<unscopedPackageName>.api.md",
/**
* Specifies the folder where the API report file is written. The file name portion is determined by
* the "reportFileName" setting.
*
* The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy,
* e.g. for an API review.
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<projectFolder>/etc/"
*/
// "reportFolder": "<projectFolder>/etc/",
/**
* Specifies the folder where the temporary report file is written. The file name portion is determined by
* the "reportFileName" setting.
*
* After the temporary file is written to disk, it is compared with the file in the "reportFolder".
* If they are different, a production build will fail.
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<projectFolder>/temp/"
*/
// "reportTempFolder": "<projectFolder>/temp/"
},
/**
* Configures how the doc model file (*.api.json) will be generated.
*/
"docModel": {
/**
* (REQUIRED) Whether to generate a doc model file.
*/
"enabled": true
/**
* The output path for the doc model file. The file extension should be ".api.json".
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
*/
// "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
},
/**
* Configures how the .d.ts rollup file will be generated.
*/
"dtsRollup": {
/**
* (REQUIRED) Whether to generate the .d.ts rollup file.
*/
"enabled": true
/**
* Specifies the output path for a .d.ts rollup file to be generated without any trimming.
* This file will include all declarations that are exported by the main entry point.
*
* If the path is an empty string, then this file will not be written.
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
*/
// "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
/**
* Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
* This file will include only declarations that are marked as "@public" or "@beta".
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: ""
*/
// "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
/**
* Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
* This file will include only declarations that are marked as "@public".
*
* If the path is an empty string, then this file will not be written.
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: ""
*/
// "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",
/**
* When a declaration is trimmed, by default it will be replaced by a code comment such as
* "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the
* declaration completely.
*
* DEFAULT VALUE: false
*/
// "omitTrimmingComments": true
},
/**
* Configures how the tsdoc-metadata.json file will be generated.
*/
"tsdocMetadata": {
/**
* Whether to generate the tsdoc-metadata.json file.
*
* DEFAULT VALUE: true
*/
// "enabled": true,
/**
* Specifies where the TSDoc metadata file should be written.
*
* The path is resolved relative to the folder of the config file that contains the setting; to change this,
* prepend a folder token such as "<projectFolder>".
*
* The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
* "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup
* falls back to "tsdoc-metadata.json" in the package folder.
*
* SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
* DEFAULT VALUE: "<lookup>"
*/
// "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
},
/**
* Specifies what type of newlines API Extractor should use when writing output files. By default, the output files
* will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead.
* To use the OS's default newline kind, specify "os".
*
* DEFAULT VALUE: "crlf"
*/
// "newlineKind": "crlf",
/**
* Configures how API Extractor reports error and warning messages produced during analysis.
*
* There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages.
*/
"messages": {
/**
* Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
* the input .d.ts files.
*
* TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551"
*
* DEFAULT VALUE: A single "default" entry with logLevel=warning.
*/
"compilerMessageReporting": {
/**
* Configures the default routing for messages that don't match an explicit rule in this table.
*/
"default": {
/**
* Specifies whether the message should be written to the the tool's output log. Note that
* the "addToApiReportFile" property may supersede this option.
*
* Possible values: "error", "warning", "none"
*
* Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail
* and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes
* the "--local" option), the warning is displayed but the build will not fail.
*
* DEFAULT VALUE: "warning"
*/
"logLevel": "warning"
/**
* When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md),
* then the message will be written inside that file; otherwise, the message is instead logged according to
* the "logLevel" option.
*
* DEFAULT VALUE: false
*/
// "addToApiReportFile": false
}
// "TS2551": {
// "logLevel": "warning",
// "addToApiReportFile": true
// },
//
// . . .
},
/**
* Configures handling of messages reported by API Extractor during its analysis.
*
* API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag"
*
* DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
*/
"extractorMessageReporting": {
"default": {
"logLevel": "warning"
// "addToApiReportFile": false
}
// "ae-extra-release-tag": {
// "logLevel": "warning",
// "addToApiReportFile": true
// },
//
// . . .
},
/**
* Configures handling of messages reported by the TSDoc parser when analyzing code comments.
*
* TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text"
*
* DEFAULT VALUE: A single "default" entry with logLevel=warning.
*/
"tsdocMessageReporting": {
"default": {
"logLevel": "warning"
// "addToApiReportFile": false
}
// "tsdoc-link-tag-unescaped-text": {
// "logLevel": "warning",
// "addToApiReportFile": true
// },
//
// . . .
}
}
}

4939
dist/bitburner.d.ts vendored Normal file

File diff suppressed because it is too large Load Diff

20752
input/bitburner.api.json Normal file

File diff suppressed because it is too large Load Diff

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [agility\_exp\_mult](./bitburner.augmentationstats.agility_exp_mult.md)
## AugmentationStats.agility\_exp\_mult property
Multipler to agility experience gain rate
<b>Signature:</b>
```typescript
agility_exp_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [agility\_mult](./bitburner.augmentationstats.agility_mult.md)
## AugmentationStats.agility\_mult property
Multipler to agility skill
<b>Signature:</b>
```typescript
agility_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [bladeburner\_analysis\_mult](./bitburner.augmentationstats.bladeburner_analysis_mult.md)
## AugmentationStats.bladeburner\_analysis\_mult property
Multipler to effectiveness in Bladeburner Field Analysis
<b>Signature:</b>
```typescript
bladeburner_analysis_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [bladeburner\_max\_stamina\_mult](./bitburner.augmentationstats.bladeburner_max_stamina_mult.md)
## AugmentationStats.bladeburner\_max\_stamina\_mult property
Multipler to Bladeburner max stamina
<b>Signature:</b>
```typescript
bladeburner_max_stamina_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [bladeburner\_stamina\_gain\_mult](./bitburner.augmentationstats.bladeburner_stamina_gain_mult.md)
## AugmentationStats.bladeburner\_stamina\_gain\_mult property
Multipler to Bladeburner stamina gain rate
<b>Signature:</b>
```typescript
bladeburner_stamina_gain_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [bladeburner\_success\_chance\_mult](./bitburner.augmentationstats.bladeburner_success_chance_mult.md)
## AugmentationStats.bladeburner\_success\_chance\_mult property
Multipler to success chance in Bladeburner contracts/operations
<b>Signature:</b>
```typescript
bladeburner_success_chance_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [charisma\_exp\_mult](./bitburner.augmentationstats.charisma_exp_mult.md)
## AugmentationStats.charisma\_exp\_mult property
Multipler to charisma experience gain rate
<b>Signature:</b>
```typescript
charisma_exp_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [charisma\_mult](./bitburner.augmentationstats.charisma_mult.md)
## AugmentationStats.charisma\_mult property
Multipler to charisma skill
<b>Signature:</b>
```typescript
charisma_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [company\_rep\_mult](./bitburner.augmentationstats.company_rep_mult.md)
## AugmentationStats.company\_rep\_mult property
Multipler to amount of reputation gained when working
<b>Signature:</b>
```typescript
company_rep_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [crime\_money\_mult](./bitburner.augmentationstats.crime_money_mult.md)
## AugmentationStats.crime\_money\_mult property
Multipler to amount of money gained from crimes
<b>Signature:</b>
```typescript
crime_money_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [crime\_success\_mult](./bitburner.augmentationstats.crime_success_mult.md)
## AugmentationStats.crime\_success\_mult property
Multipler to crime success rate
<b>Signature:</b>
```typescript
crime_success_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [defense\_exp\_mult](./bitburner.augmentationstats.defense_exp_mult.md)
## AugmentationStats.defense\_exp\_mult property
Multipler to defense experience gain rate
<b>Signature:</b>
```typescript
defense_exp_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [defense\_mult](./bitburner.augmentationstats.defense_mult.md)
## AugmentationStats.defense\_mult property
Multipler to defense skill
<b>Signature:</b>
```typescript
defense_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [dexterity\_exp\_mult](./bitburner.augmentationstats.dexterity_exp_mult.md)
## AugmentationStats.dexterity\_exp\_mult property
Multipler to dexterity experience gain rate
<b>Signature:</b>
```typescript
dexterity_exp_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [dexterity\_mult](./bitburner.augmentationstats.dexterity_mult.md)
## AugmentationStats.dexterity\_mult property
Multipler to dexterity skill
<b>Signature:</b>
```typescript
dexterity_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [faction\_rep\_mult](./bitburner.augmentationstats.faction_rep_mult.md)
## AugmentationStats.faction\_rep\_mult property
Multipler to amount of reputation gained when working
<b>Signature:</b>
```typescript
faction_rep_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacking\_chance\_mult](./bitburner.augmentationstats.hacking_chance_mult.md)
## AugmentationStats.hacking\_chance\_mult property
Multipler to chance of successfully performing a hack
<b>Signature:</b>
```typescript
hacking_chance_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacking\_exp\_mult](./bitburner.augmentationstats.hacking_exp_mult.md)
## AugmentationStats.hacking\_exp\_mult property
Multipler to hacking experience gain rate
<b>Signature:</b>
```typescript
hacking_exp_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacking\_grow\_mult](./bitburner.augmentationstats.hacking_grow_mult.md)
## AugmentationStats.hacking\_grow\_mult property
Multipler to amount of money injected into servers using grow)<!-- -->}
<b>Signature:</b>
```typescript
hacking_grow_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacking\_money\_mult](./bitburner.augmentationstats.hacking_money_mult.md)
## AugmentationStats.hacking\_money\_mult property
Multipler to amount of money the player gains from hacking
<b>Signature:</b>
```typescript
hacking_money_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacking\_mult](./bitburner.augmentationstats.hacking_mult.md)
## AugmentationStats.hacking\_mult property
Multipler to hacking skill
<b>Signature:</b>
```typescript
hacking_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacking\_speed\_mult](./bitburner.augmentationstats.hacking_speed_mult.md)
## AugmentationStats.hacking\_speed\_mult property
Multipler to hacking speed
<b>Signature:</b>
```typescript
hacking_speed_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacknet\_node\_core\_cost\_mult](./bitburner.augmentationstats.hacknet_node_core_cost_mult.md)
## AugmentationStats.hacknet\_node\_core\_cost\_mult property
Multipler to cost of core for a Hacknet Node
<b>Signature:</b>
```typescript
hacknet_node_core_cost_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacknet\_node\_level\_cost\_mult](./bitburner.augmentationstats.hacknet_node_level_cost_mult.md)
## AugmentationStats.hacknet\_node\_level\_cost\_mult property
Multipler to cost of leveling up a Hacknet Node
<b>Signature:</b>
```typescript
hacknet_node_level_cost_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacknet\_node\_money\_mult](./bitburner.augmentationstats.hacknet_node_money_mult.md)
## AugmentationStats.hacknet\_node\_money\_mult property
Multipler to amount of money produced by Hacknet Nodes
<b>Signature:</b>
```typescript
hacknet_node_money_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacknet\_node\_purchase\_cost\_mult](./bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md)
## AugmentationStats.hacknet\_node\_purchase\_cost\_mult property
Multipler to cost of purchasing a Hacknet Node
<b>Signature:</b>
```typescript
hacknet_node_purchase_cost_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [hacknet\_node\_ram\_cost\_mult](./bitburner.augmentationstats.hacknet_node_ram_cost_mult.md)
## AugmentationStats.hacknet\_node\_ram\_cost\_mult property
Multipler to cost of ram for a Hacknet Node
<b>Signature:</b>
```typescript
hacknet_node_ram_cost_mult?: number;
```

@ -0,0 +1,48 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md)
## AugmentationStats interface
<b>Signature:</b>
```typescript
interface AugmentationStats
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [agility\_exp\_mult?](./bitburner.augmentationstats.agility_exp_mult.md) | number | <i>(Optional)</i> Multipler to agility experience gain rate |
| [agility\_mult?](./bitburner.augmentationstats.agility_mult.md) | number | <i>(Optional)</i> Multipler to agility skill |
| [bladeburner\_analysis\_mult?](./bitburner.augmentationstats.bladeburner_analysis_mult.md) | number | <i>(Optional)</i> Multipler to effectiveness in Bladeburner Field Analysis |
| [bladeburner\_max\_stamina\_mult?](./bitburner.augmentationstats.bladeburner_max_stamina_mult.md) | number | <i>(Optional)</i> Multipler to Bladeburner max stamina |
| [bladeburner\_stamina\_gain\_mult?](./bitburner.augmentationstats.bladeburner_stamina_gain_mult.md) | number | <i>(Optional)</i> Multipler to Bladeburner stamina gain rate |
| [bladeburner\_success\_chance\_mult?](./bitburner.augmentationstats.bladeburner_success_chance_mult.md) | number | <i>(Optional)</i> Multipler to success chance in Bladeburner contracts/operations |
| [charisma\_exp\_mult?](./bitburner.augmentationstats.charisma_exp_mult.md) | number | <i>(Optional)</i> Multipler to charisma experience gain rate |
| [charisma\_mult?](./bitburner.augmentationstats.charisma_mult.md) | number | <i>(Optional)</i> Multipler to charisma skill |
| [company\_rep\_mult?](./bitburner.augmentationstats.company_rep_mult.md) | number | <i>(Optional)</i> Multipler to amount of reputation gained when working |
| [crime\_money\_mult?](./bitburner.augmentationstats.crime_money_mult.md) | number | <i>(Optional)</i> Multipler to amount of money gained from crimes |
| [crime\_success\_mult?](./bitburner.augmentationstats.crime_success_mult.md) | number | <i>(Optional)</i> Multipler to crime success rate |
| [defense\_exp\_mult?](./bitburner.augmentationstats.defense_exp_mult.md) | number | <i>(Optional)</i> Multipler to defense experience gain rate |
| [defense\_mult?](./bitburner.augmentationstats.defense_mult.md) | number | <i>(Optional)</i> Multipler to defense skill |
| [dexterity\_exp\_mult?](./bitburner.augmentationstats.dexterity_exp_mult.md) | number | <i>(Optional)</i> Multipler to dexterity experience gain rate |
| [dexterity\_mult?](./bitburner.augmentationstats.dexterity_mult.md) | number | <i>(Optional)</i> Multipler to dexterity skill |
| [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\_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 |
| [hacknet\_node\_core\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_core_cost_mult.md) | number | <i>(Optional)</i> Multipler to cost of core for a Hacknet Node |
| [hacknet\_node\_level\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_level_cost_mult.md) | number | <i>(Optional)</i> Multipler to cost of leveling up a Hacknet Node |
| [hacknet\_node\_money\_mult?](./bitburner.augmentationstats.hacknet_node_money_mult.md) | number | <i>(Optional)</i> Multipler to amount of money produced by Hacknet Nodes |
| [hacknet\_node\_purchase\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md) | number | <i>(Optional)</i> Multipler to cost of purchasing a Hacknet Node |
| [hacknet\_node\_ram\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_ram_cost_mult.md) | number | <i>(Optional)</i> Multipler to cost of ram for a Hacknet Node |
| [strength\_exp\_mult?](./bitburner.augmentationstats.strength_exp_mult.md) | number | <i>(Optional)</i> Multipler to strength experience gain rate |
| [strength\_mult?](./bitburner.augmentationstats.strength_mult.md) | number | <i>(Optional)</i> Multipler to strength skill |
| [work\_money\_mult?](./bitburner.augmentationstats.work_money_mult.md) | number | <i>(Optional)</i> Multipler to amount of money gained from working |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [strength\_exp\_mult](./bitburner.augmentationstats.strength_exp_mult.md)
## AugmentationStats.strength\_exp\_mult property
Multipler to strength experience gain rate
<b>Signature:</b>
```typescript
strength_exp_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [strength\_mult](./bitburner.augmentationstats.strength_mult.md)
## AugmentationStats.strength\_mult property
Multipler to strength skill
<b>Signature:</b>
```typescript
strength_mult?: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentationStats](./bitburner.augmentationstats.md) &gt; [work\_money\_mult](./bitburner.augmentationstats.work_money_mult.md)
## AugmentationStats.work\_money\_mult property
Multipler to amount of money gained from working
<b>Signature:</b>
```typescript
work_money_mult?: number;
```

@ -0,0 +1,116 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentName](./bitburner.augmentname.md)
## AugmentName type
<b>Signature:</b>
```typescript
type AugmentName =
| "Augmented Targeting I"
| "Augmented Targeting II"
| "Augmented Targeting III"
| "Synthetic Heart"
| "Synfibril Muscle"
| "Combat Rib I"
| "Combat Rib II"
| "Combat Rib III"
| "Nanofiber Weave"
| "NEMEAN Subdermal Weave"
| "Wired Reflexes"
| "Graphene Bone Lacings"
| "Bionic Spine"
| "Graphene Bionic Spine Upgrade"
| "Bionic Legs"
| "Graphene Bionic Legs Upgrade"
| "Speech Processor Implant"
| "TITN-41 Gene-Modification Injection"
| "Enhanced Social Interaction Implant"
| "BitWire"
| "Artificial Bio-neural Network Implant"
| "Artificial Synaptic Potentiation"
| "Enhanced Myelin Sheathing"
| "Synaptic Enhancement Implant"
| "Neural-Retention Enhancement"
| "DataJack"
| "Embedded Netburner Module"
| "Embedded Netburner Module Core Implant"
| "Embedded Netburner Module Core V2 Upgrade"
| "Embedded Netburner Module Core V3 Upgrade"
| "Embedded Netburner Module Analyze Engine"
| "Embedded Netburner Module Direct Memory Access Upgrade"
| "Neuralstimulator"
| "Neural Accelerator"
| "Cranial Signal Processors - Gen I"
| "Cranial Signal Processors - Gen II"
| "Cranial Signal Processors - Gen III"
| "Cranial Signal Processors - Gen IV"
| "Cranial Signal Processors - Gen V"
| "Neuronal Densification"
| "Nuoptimal Nootropic Injector Implant"
| "Speech Enhancement"
| "FocusWire"
| "PC Direct-Neural Interface"
| "PC Direct-Neural Interface Optimization Submodule"
| "PC Direct-Neural Interface NeuroNet Injector"
| "ADR-V1 Pheromone Gene"
| "ADR-V2 Pheromone Gene"
| "The Shadow's Simulacrum"
| "Hacknet Node CPU Architecture Neural-Upload"
| "Hacknet Node Cache Architecture Neural-Upload"
| "Hacknet Node NIC Architecture Neural-Upload"
| "Hacknet Node Kernel Direct-Neural Interface"
| "Hacknet Node Core Direct-Neural Interface"
| "NeuroFlux Governor"
| "Neurotrainer I"
| "Neurotrainer II"
| "Neurotrainer III"
| "HyperSight Corneal Implant"
| "LuminCloaking-V1 Skin Implant"
| "LuminCloaking-V2 Skin Implant"
| "HemoRecirculator"
| "SmartSonar Implant"
| "Power Recirculation Core"
| "QLink"
| "The Red Pill"
| "SPTN-97 Gene Modification"
| "ECorp HVMind Implant"
| "CordiARC Fusion Reactor"
| "SmartJaw"
| "Neotra"
| "Xanipher"
| "nextSENS Gene Modification"
| "OmniTek InfoLoad"
| "Photosynthetic Cells"
| "BitRunners Neurolink"
| "The Black Hand"
| "CRTX42-AA Gene Modification"
| "Neuregen Gene Modification"
| "CashRoot Starter Kit"
| "NutriGen Implant"
| "INFRARET Enhancement"
| "DermaForce Particle Barrier"
| "Graphene BranchiBlades Upgrade"
| "Graphene Bionic Arms Upgrade"
| "BrachiBlades"
| "Bionic Arms"
| "Social Negotiation Assistant (S.N.A)"
| "EsperTech Bladeburner Eyewear"
| "EMS-4 Recombination"
| "ORION-MKIV Shoulder"
| "Hyperion Plasma Cannon V1"
| "Hyperion Plasma Cannon V2"
| "GOLEM Serum"
| "Vangelis Virus"
| "Vangelis Virus 3.0"
| "I.N.T.E.R.L.I.N.K.E.D"
| "Blade's Runners"
| "BLADE-51b Tesla Armor"
| "BLADE-51b Tesla Armor: Power Cells Upgrade"
| "BLADE-51b Tesla Armor: Energy Shielding Upgrade"
| "BLADE-51b Tesla Armor: Unibeam Upgrade"
| "BLADE-51b Tesla Armor: Omnibeam Upgrade"
| "BLADE-51b Tesla Armor: IPU Upgrade"
| "The Blade's Simulacrum";
```

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

@ -0,0 +1,20 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentPair](./bitburner.augmentpair.md)
## AugmentPair interface
<b>Signature:</b>
```typescript
interface AugmentPair
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [cost](./bitburner.augmentpair.cost.md) | number | augmentation cost |
| [name](./bitburner.augmentpair.name.md) | [AugmentName](./bitburner.augmentname.md) | augmentation name |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AugmentPair](./bitburner.augmentpair.md) &gt; [name](./bitburner.augmentpair.name.md)
## AugmentPair.name property
augmentation name
<b>Signature:</b>
```typescript
name: AugmentName;
```

@ -0,0 +1,19 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BasicHGWOptions](./bitburner.basichgwoptions.md)
## BasicHGWOptions interface
<b>Signature:</b>
```typescript
interface BasicHGWOptions
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [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. |

@ -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; [threads](./bitburner.basichgwoptions.threads.md)
## BasicHGWOptions.threads property
Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with.
<b>Signature:</b>
```typescript
threads: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [AgilityLevelMultiplier](./bitburner.bitnodemultipliers.agilitylevelmultiplier.md)
## BitNodeMultipliers.AgilityLevelMultiplier property
Influences how quickly the player's agility level (not exp) scales
<b>Signature:</b>
```typescript
AgilityLevelMultiplier: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [AugmentationMoneyCost](./bitburner.bitnodemultipliers.augmentationmoneycost.md)
## BitNodeMultipliers.AugmentationMoneyCost property
Influences the base cost to purchase an augmentation.
<b>Signature:</b>
```typescript
AugmentationMoneyCost: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [AugmentationRepCost](./bitburner.bitnodemultipliers.augmentationrepcost.md)
## BitNodeMultipliers.AugmentationRepCost property
Influences the base rep the player must have with a faction to purchase an augmentation.
<b>Signature:</b>
```typescript
AugmentationRepCost: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [BladeburnerRank](./bitburner.bitnodemultipliers.bladeburnerrank.md)
## BitNodeMultipliers.BladeburnerRank property
Influences how quickly the player can gain rank within Bladeburner.
<b>Signature:</b>
```typescript
BladeburnerRank: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [BladeburnerSkillCost](./bitburner.bitnodemultipliers.bladeburnerskillcost.md)
## BitNodeMultipliers.BladeburnerSkillCost property
Influences the cost of skill levels from Bladeburner.
<b>Signature:</b>
```typescript
BladeburnerSkillCost: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CharismaLevelMultiplier](./bitburner.bitnodemultipliers.charismalevelmultiplier.md)
## BitNodeMultipliers.CharismaLevelMultiplier property
Influences how quickly the player's charisma level (not exp) scales
<b>Signature:</b>
```typescript
CharismaLevelMultiplier: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [ClassGymExpGain](./bitburner.bitnodemultipliers.classgymexpgain.md)
## BitNodeMultipliers.ClassGymExpGain property
Influences the experience gained for each ability when a player completes a class.
<b>Signature:</b>
```typescript
ClassGymExpGain: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md)
## BitNodeMultipliers.CodingContractMoney property
Influences the amount of money gained from completing Coding Contracts
<b>Signature:</b>
```typescript
CodingContractMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CompanyWorkExpGain](./bitburner.bitnodemultipliers.companyworkexpgain.md)
## BitNodeMultipliers.CompanyWorkExpGain property
Influences the experience gained for each ability when the player completes working their job.
<b>Signature:</b>
```typescript
CompanyWorkExpGain: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md)
## BitNodeMultipliers.CompanyWorkMoney property
Influences how much money the player earns when completing working their job.
<b>Signature:</b>
```typescript
CompanyWorkMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md)
## BitNodeMultipliers.CorporationValuation property
Influences the valuation of corporations created by the player.
<b>Signature:</b>
```typescript
CorporationValuation: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md)
## BitNodeMultipliers.CrimeExpGain property
Influences the base experience gained for each ability when the player commits a crime.
<b>Signature:</b>
```typescript
CrimeExpGain: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md)
## BitNodeMultipliers.CrimeMoney property
Influences the base money gained when the player commits a crime.
<b>Signature:</b>
```typescript
CrimeMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [DaedalusAugsRequirement](./bitburner.bitnodemultipliers.daedalusaugsrequirement.md)
## BitNodeMultipliers.DaedalusAugsRequirement property
Influences how many Augmentations you need in order to get invited to the Daedalus faction
<b>Signature:</b>
```typescript
DaedalusAugsRequirement: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [DefenseLevelMultiplier](./bitburner.bitnodemultipliers.defenselevelmultiplier.md)
## BitNodeMultipliers.DefenseLevelMultiplier property
Influences how quickly the player's defense level (not exp) scales
<b>Signature:</b>
```typescript
DefenseLevelMultiplier: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [DexterityLevelMultiplier](./bitburner.bitnodemultipliers.dexteritylevelmultiplier.md)
## BitNodeMultipliers.DexterityLevelMultiplier property
Influences how quickly the player's dexterity level (not exp) scales
<b>Signature:</b>
```typescript
DexterityLevelMultiplier: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [FactionPassiveRepGain](./bitburner.bitnodemultipliers.factionpassiverepgain.md)
## BitNodeMultipliers.FactionPassiveRepGain property
Influences how much rep the player gains in each faction simply by being a member.
<b>Signature:</b>
```typescript
FactionPassiveRepGain: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [FactionWorkExpGain](./bitburner.bitnodemultipliers.factionworkexpgain.md)
## BitNodeMultipliers.FactionWorkExpGain property
Influences the experience gained for each ability when the player completes work for a Faction.
<b>Signature:</b>
```typescript
FactionWorkExpGain: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md)
## BitNodeMultipliers.FactionWorkRepGain property
Influences how much rep the player gains when performing work for a faction.
<b>Signature:</b>
```typescript
FactionWorkRepGain: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md)
## BitNodeMultipliers.FourSigmaMarketDataApiCost property
Influences how much it costs to unlock the stock market's 4S Market Data API
<b>Signature:</b>
```typescript
FourSigmaMarketDataApiCost: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md)
## BitNodeMultipliers.FourSigmaMarketDataCost property
Influences how much it costs to unlock the stock market's 4S Market Data (NOT API)
<b>Signature:</b>
```typescript
FourSigmaMarketDataCost: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md)
## BitNodeMultipliers.HackExpGain property
Influences the experienced gained when hacking a server.
<b>Signature:</b>
```typescript
HackExpGain: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md)
## BitNodeMultipliers.HackingLevelMultiplier property
Influences how quickly the player's hacking level (not experience) scales
<b>Signature:</b>
```typescript
HackingLevelMultiplier: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md)
## BitNodeMultipliers.HacknetNodeMoney property
Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9)
<b>Signature:</b>
```typescript
HacknetNodeMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [HomeComputerRamCost](./bitburner.bitnodemultipliers.homecomputerramcost.md)
## BitNodeMultipliers.HomeComputerRamCost property
Influences how much money it costs to upgrade your home computer's RAM
<b>Signature:</b>
```typescript
HomeComputerRamCost: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [InfiltrationMoney](./bitburner.bitnodemultipliers.infiltrationmoney.md)
## BitNodeMultipliers.InfiltrationMoney property
Influences how much money is gained when the player infiltrates a company.
<b>Signature:</b>
```typescript
InfiltrationMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [InfiltrationRep](./bitburner.bitnodemultipliers.infiltrationrep.md)
## BitNodeMultipliers.InfiltrationRep property
Influences how much rep the player can gain from factions when selling stolen documents and secrets
<b>Signature:</b>
```typescript
InfiltrationRep: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md)
## BitNodeMultipliers.ManualHackMoney property
Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal.
<b>Signature:</b>
```typescript
ManualHackMoney: number;
```

@ -0,0 +1,57 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md)
## BitNodeMultipliers interface
<b>Signature:</b>
```typescript
interface BitNodeMultipliers
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [AgilityLevelMultiplier](./bitburner.bitnodemultipliers.agilitylevelmultiplier.md) | number | Influences how quickly the player's agility level (not exp) scales |
| [AugmentationMoneyCost](./bitburner.bitnodemultipliers.augmentationmoneycost.md) | number | Influences the base cost to purchase an augmentation. |
| [AugmentationRepCost](./bitburner.bitnodemultipliers.augmentationrepcost.md) | number | Influences the base rep the player must have with a faction to purchase an augmentation. |
| [BladeburnerRank](./bitburner.bitnodemultipliers.bladeburnerrank.md) | number | Influences how quickly the player can gain rank within Bladeburner. |
| [BladeburnerSkillCost](./bitburner.bitnodemultipliers.bladeburnerskillcost.md) | number | Influences the cost of skill levels from Bladeburner. |
| [CharismaLevelMultiplier](./bitburner.bitnodemultipliers.charismalevelmultiplier.md) | number | Influences how quickly the player's charisma level (not exp) scales |
| [ClassGymExpGain](./bitburner.bitnodemultipliers.classgymexpgain.md) | number | Influences the experience gained for each ability when a player completes a class. |
| [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) | number | Influences the amount of money gained from completing Coding Contracts |
| [CompanyWorkExpGain](./bitburner.bitnodemultipliers.companyworkexpgain.md) | number | Influences the experience gained for each ability when the player completes working their job. |
| [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md) | number | Influences how much money the player earns when completing working their job. |
| [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) | number | Influences the valuation of corporations created by the player. |
| [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md) | number | Influences the base experience gained for each ability when the player commits a crime. |
| [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) | number | Influences the base money gained when the player commits a crime. |
| [DaedalusAugsRequirement](./bitburner.bitnodemultipliers.daedalusaugsrequirement.md) | number | Influences how many Augmentations you need in order to get invited to the Daedalus faction |
| [DefenseLevelMultiplier](./bitburner.bitnodemultipliers.defenselevelmultiplier.md) | number | Influences how quickly the player's defense level (not exp) scales |
| [DexterityLevelMultiplier](./bitburner.bitnodemultipliers.dexteritylevelmultiplier.md) | number | Influences how quickly the player's dexterity level (not exp) scales |
| [FactionPassiveRepGain](./bitburner.bitnodemultipliers.factionpassiverepgain.md) | number | Influences how much rep the player gains in each faction simply by being a member. |
| [FactionWorkExpGain](./bitburner.bitnodemultipliers.factionworkexpgain.md) | number | Influences the experience gained for each ability when the player completes work for a Faction. |
| [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) | number | Influences how much rep the player gains when performing work for a faction. |
| [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md) | number | Influences how much it costs to unlock the stock market's 4S Market Data API |
| [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md) | number | Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) |
| [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) | number | Influences the experienced gained when hacking a server. |
| [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) | number | Influences how quickly the player's hacking level (not experience) scales |
| [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | number | Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) |
| [HomeComputerRamCost](./bitburner.bitnodemultipliers.homecomputerramcost.md) | number | Influences how much money it costs to upgrade your home computer's RAM |
| [InfiltrationMoney](./bitburner.bitnodemultipliers.infiltrationmoney.md) | number | Influences how much money is gained when the player infiltrates a company. |
| [InfiltrationRep](./bitburner.bitnodemultipliers.infiltrationrep.md) | number | Influences how much rep the player can gain from factions when selling stolen documents and secrets |
| [ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md) | number | Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal. |
| [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) | number | Influence how much it costs to purchase a server |
| [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) | number | Influences the maximum number of purchased servers you can have |
| [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) | number | Influences the maximum allowed RAM for a purchased server |
| [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) | number | Influences the minimum favor the player must have with a faction before they can donate to gain rep. |
| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | number | Influences how much money can be stolen from a server when a script performs a hack against it. |
| [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | number | Influences the growth percentage per cycle against a server. |
| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | number | Influences the maxmimum money that a server can grow to. |
| [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | number | Influences the initial money that a server starts with. |
| [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | number | Influences the initial security level (hackDifficulty) of a server. |
| [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | number | Influences the weaken amount per invocation against a server. |
| [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) | number | Influences how quickly the player's strength level (not exp) scales |

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md)
## BitNodeMultipliers.PurchasedServerCost property
Influence how much it costs to purchase a server
<b>Signature:</b>
```typescript
PurchasedServerCost: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md)
## BitNodeMultipliers.PurchasedServerLimit property
Influences the maximum number of purchased servers you can have
<b>Signature:</b>
```typescript
PurchasedServerLimit: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md)
## BitNodeMultipliers.PurchasedServerMaxRam property
Influences the maximum allowed RAM for a purchased server
<b>Signature:</b>
```typescript
PurchasedServerMaxRam: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md)
## BitNodeMultipliers.RepToDonateToFaction property
Influences the minimum favor the player must have with a faction before they can donate to gain rep.
<b>Signature:</b>
```typescript
RepToDonateToFaction: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md)
## BitNodeMultipliers.ScriptHackMoney property
Influences how much money can be stolen from a server when a script performs a hack against it.
<b>Signature:</b>
```typescript
ScriptHackMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md)
## BitNodeMultipliers.ServerGrowthRate property
Influences the growth percentage per cycle against a server.
<b>Signature:</b>
```typescript
ServerGrowthRate: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md)
## BitNodeMultipliers.ServerMaxMoney property
Influences the maxmimum money that a server can grow to.
<b>Signature:</b>
```typescript
ServerMaxMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md)
## BitNodeMultipliers.ServerStartingMoney property
Influences the initial money that a server starts with.
<b>Signature:</b>
```typescript
ServerStartingMoney: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md)
## BitNodeMultipliers.ServerStartingSecurity property
Influences the initial security level (hackDifficulty) of a server.
<b>Signature:</b>
```typescript
ServerStartingSecurity: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md)
## BitNodeMultipliers.ServerWeakenRate property
Influences the weaken amount per invocation against a server.
<b>Signature:</b>
```typescript
ServerWeakenRate: number;
```

@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md)
## BitNodeMultipliers.StrengthLevelMultiplier property
Influences how quickly the player's strength level (not exp) scales
<b>Signature:</b>
```typescript
StrengthLevelMultiplier: number;
```

@ -0,0 +1,38 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getActionAutolevel](./bitburner.bladeburner.getactionautolevel.md)
## Bladeburner.getActionAutolevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Return a boolean indicating whether or not this action is currently set to autolevel.
Returns false if an invalid action is specified.
<b>Signature:</b>
```typescript
getActionAutolevel(
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. |
<b>Returns:</b>
boolean
True if the action is set to autolevel, and false otherwise.
## Remarks
4 GB

@ -0,0 +1,38 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getActionCountRemaining](./bitburner.bladeburner.getactioncountremaining.md)
## Bladeburner.getActionCountRemaining() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the remaining count of the specified action.
Note that this is meant to be used for Contracts and Operations. This function will return Infinity for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.
<b>Signature:</b>
```typescript
getActionCountRemaining(
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. |
<b>Returns:</b>
number
Remaining count of the specified action.
## Remarks
4 GB

@ -0,0 +1,38 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getActionCurrentLevel](./bitburner.bladeburner.getactioncurrentlevel.md)
## Bladeburner.getActionCurrentLevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the current level of this action.
Returns -1 if an invalid action is specified.
<b>Signature:</b>
```typescript
getActionCurrentLevel(
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. |
<b>Returns:</b>
number
Current level of the specified action.
## Remarks
4 GB

@ -0,0 +1,36 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getActionEstimatedSuccessChance](./bitburner.bladeburner.getactionestimatedsuccesschance.md)
## Bladeburner.getActionEstimatedSuccessChance() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).
<b>Signature:</b>
```typescript
getActionEstimatedSuccessChance(
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. |
<b>Returns:</b>
number
Estimated success chance for the specified action.
## Remarks
4 GB

@ -0,0 +1,38 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getActionMaxLevel](./bitburner.bladeburner.getactionmaxlevel.md)
## Bladeburner.getActionMaxLevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the maximum level for this action.
Returns -1 if an invalid action is specified.
<b>Signature:</b>
```typescript
getActionMaxLevel(
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. |
<b>Returns:</b>
number
Maximum level of the specified action.
## Remarks
4 GB

@ -0,0 +1,38 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getActionRepGain](./bitburner.bladeburner.getactionrepgain.md)
## Bladeburner.getActionRepGain() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an average and the real reputation gain may vary slightly from this value.
<b>Signature:</b>
```typescript
getActionRepGain(
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
level: number,
): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. |
| level | number | Optional action level at which to calculate the gain |
<b>Returns:</b>
number
Average Bladeburner reputation gain for successfully completing the specified action.
## Remarks
4 GB

@ -0,0 +1,36 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getActionTime](./bitburner.bladeburner.getactiontime.md)
## Bladeburner.getActionTime() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the number of seconds it takes to complete the specified action
<b>Signature:</b>
```typescript
getActionTime(
type: BladeburnerActTypes,
name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps,
): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. |
| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. |
<b>Returns:</b>
number
Number of seconds it takes to complete the specified action.
## Remarks
4 GB

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getBlackOpNames](./bitburner.bladeburner.getblackopnames.md)
## Bladeburner.getBlackOpNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns an array of strings containing the names of all Bladeburner Black Ops.
<b>Signature:</b>
```typescript
getBlackOpNames(): BladeburnerBlackOps[];
```
<b>Returns:</b>
[BladeburnerBlackOps](./bitburner.bladeburnerblackops.md)<!-- -->\[\]
Array of strings containing the names of all Bladeburner Black Ops.
## Remarks
0.4 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; [Bladeburner](./bitburner.bladeburner.md) &gt; [getBlackOpRank](./bitburner.bladeburner.getblackoprank.md)
## Bladeburner.getBlackOpRank() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the rank required to complete this BlackOp.
Returns -1 if an invalid action is specified.
<b>Signature:</b>
```typescript
getBlackOpRank(name: BladeburnerBlackOps): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of BlackOp. Must be an exact match. |
<b>Returns:</b>
number
Rank required to complete this BlackOp.
## Remarks
2 GB

@ -0,0 +1,29 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getBonusTime](./bitburner.bladeburner.getbonustime.md)
## Bladeburner.getBonusTime() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.
“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, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but youve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.
<b>Signature:</b>
```typescript
getBonusTime(): number;
```
<b>Returns:</b>
number
Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.
## Remarks
0 GB

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getCity](./bitburner.bladeburner.getcity.md)
## Bladeburner.getCity() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the city that the player is currently in (for Bladeburner).
<b>Signature:</b>
```typescript
getCity(): City;
```
<b>Returns:</b>
[City](./bitburner.city.md)
City that the player is currently in (for Bladeburner).
## Remarks
4 GB

@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getCityChaos](./bitburner.bladeburner.getcitychaos.md)
## Bladeburner.getCityChaos() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the chaos in the specified city, or -1 if an invalid city was specified.
<b>Signature:</b>
```typescript
getCityChaos(name: City): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | [City](./bitburner.city.md) | |
<b>Returns:</b>
number
Chaos in the specified city.
## Remarks
4 GB

@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getCityCommunities](./bitburner.bladeburner.getcitycommunities.md)
## Bladeburner.getCityCommunities() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified.
<b>Signature:</b>
```typescript
getCityCommunities(name: City): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | [City](./bitburner.city.md) | |
<b>Returns:</b>
number
Number of Synthoids communities in the specified city.
## Remarks
4 GB

@ -0,0 +1,32 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getCityEstimatedPopulation](./bitburner.bladeburner.getcityestimatedpopulation.md)
## Bladeburner.getCityEstimatedPopulation() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified.
<b>Signature:</b>
```typescript
getCityEstimatedPopulation(name: City): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | [City](./bitburner.city.md) | |
<b>Returns:</b>
number
Estimated number of Synthoids in the specified city.
## Remarks
4 GB

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getContractNames](./bitburner.bladeburner.getcontractnames.md)
## Bladeburner.getContractNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns an array of strings containing the names of all Bladeburner contracts.
<b>Signature:</b>
```typescript
getContractNames(): BladeburnerContracts[];
```
<b>Returns:</b>
[BladeburnerContracts](./bitburner.bladeburnercontracts.md)<!-- -->\[\]
Array of strings containing the names of all Bladeburner contracts.
## Remarks
0.4 GB

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getCurrentAction](./bitburner.bladeburner.getcurrentaction.md)
## Bladeburner.getCurrentAction() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns an object that represents the players current Bladeburner action. If the player is not performing an action, the function will return an object with the type property set to “Idle”.
<b>Signature:</b>
```typescript
getCurrentAction(): BladeburnerCurAction;
```
<b>Returns:</b>
[BladeburnerCurAction](./bitburner.bladeburnercuraction.md)
Object that represents the players current Bladeburner action.
## Remarks
1 GB

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getGeneralActionNames](./bitburner.bladeburner.getgeneralactionnames.md)
## Bladeburner.getGeneralActionNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns an array of strings containing the names of all general Bladeburner actions.
<b>Signature:</b>
```typescript
getGeneralActionNames(): BladeburnerGenActions[];
```
<b>Returns:</b>
[BladeburnerGenActions](./bitburner.bladeburnergenactions.md)<!-- -->\[\]
Array of strings containing the names of all general Bladeburner actions.
## Remarks
0.4 GB

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getOperationNames](./bitburner.bladeburner.getoperationnames.md)
## Bladeburner.getOperationNames() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns an array of strings containing the names of all Bladeburner operations.
<b>Signature:</b>
```typescript
getOperationNames(): BladeburnerOperations[];
```
<b>Returns:</b>
[BladeburnerOperations](./bitburner.bladeburneroperations.md)<!-- -->\[\]
Array of strings containing the names of all Bladeburner operations.
## Remarks
0.4 GB

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Bladeburner](./bitburner.bladeburner.md) &gt; [getRank](./bitburner.bladeburner.getrank.md)
## Bladeburner.getRank() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
Returns the players Bladeburner Rank.
<b>Signature:</b>
```typescript
getRank(): number;
```
<b>Returns:</b>
number
Players Bladeburner Rank.
## Remarks
4 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; [Bladeburner](./bitburner.bladeburner.md) &gt; [getSkillLevel](./bitburner.bladeburner.getskilllevel.md)
## Bladeburner.getSkillLevel() method
You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.
This function returns your level in the specified skill.
The function returns -1 if an invalid skill name is passed in.
<b>Signature:</b>
```typescript
getSkillLevel(name: BladeburnerSkills): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | |
<b>Returns:</b>
number
Level in the specified skill.
## Remarks
4 GB

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