Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-19 12:45:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'dev' into FIX#3366

Browse Source
This commit is contained in:
hydroflame 2022-07-21 16:17:08 -04:00 committed by GitHub
commit b66d7e7d51
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
365 changed files with 11259 additions and 11460 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

390
.eslintrc.js
View File

@ -4,7 +4,11 @@ module.exports = {
commonjs: true, commonjs: true,
es6: false, es6: false,
}, },
extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"], extends: [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:@typescript-eslint/recommended-requiring-type-checking",
],
parser: "@typescript-eslint/parser", parser: "@typescript-eslint/parser",
parserOptions: { parserOptions: {
ecmaVersion: 8, ecmaVersion: 8,
@ -12,388 +16,12 @@ module.exports = {
ecmaFeatures: { ecmaFeatures: {
experimentalObjectRestSpread: true, experimentalObjectRestSpread: true,
}, },
project: ["./tsconfig.json", "./test/tsconfig.json", "./tools/tsconfig.json", "./test/cypress/tsconfig.json"],
}, },
plugins: ["@typescript-eslint"], plugins: ["@typescript-eslint"],
extends: ["plugin:@typescript-eslint/recommended"],
rules: { rules: {
"accessor-pairs": [ "@typescript-eslint/ban-ts-comment": "off",
"error", "@typescript-eslint/no-explicit-any": "off",
{
setWithoutGet: true,
getWithoutSet: false,
},
],
"array-bracket-newline": ["off"],
"array-bracket-spacing": ["off"],
"array-callback-return": ["off"],
"array-element-newline": ["off"],
"arrow-body-style": ["off"],
"arrow-parens": ["off"],
"arrow-spacing": ["off"],
"block-scoped-var": ["off"],
"block-spacing": ["off"],
"brace-style": ["off"],
"callback-return": ["error"],
camelcase: ["off"],
"capitalized-comments": ["off"],
"class-methods-use-this": ["off"],
complexity: ["off"],
"consistent-return": ["off"],
"consistent-this": ["off"],
"constructor-super": ["error"],
curly: ["off"],
"default-case": ["off"],
"dot-notation": ["off"],
"eol-last": ["error"],
eqeqeq: ["off"],
"for-direction": ["error"],
"func-call-spacing": ["off"],
"func-name-matching": ["error"],
"func-names": ["off", "never"],
"func-style": ["off"],
"function-paren-newline": ["off"],
"getter-return": [
"error",
{
allowImplicit: false,
},
],
"global-require": ["off"],
"guard-for-in": ["off"],
"handle-callback-err": ["error"],
"id-blacklist": ["error"],
"id-length": ["off"],
"id-match": ["error"],
indent: ["off"],
"indent-legacy": ["off"],
"init-declarations": ["off"],
"key-spacing": ["off"],
"keyword-spacing": ["off"],
"line-comment-position": ["off"],
"linebreak-style": [
"off", // Line endings automatically converted to LF on git commit so probably shouldn't care about it here
],
"lines-around-comment": ["off"],
"lines-around-directive": ["error"],
"lines-between-class-members": ["error"],
"max-depth": ["off"],
"max-len": ["off"],
"max-lines": ["off"],
"max-nested-callbacks": ["error"],
"max-params": ["off"],
"max-statements": ["off"],
"max-statements-per-line": ["off"],
"multiline-comment-style": ["off", "starred-block"],
"multiline-ternary": ["off", "never"],
"new-cap": ["off"],
"new-parens": ["off"],
"newline-after-var": ["off"],
"newline-before-return": ["off"],
"newline-per-chained-call": ["off"],
"no-alert": ["error"],
"no-array-constructor": ["error"],
"no-await-in-loop": ["error"],
"no-bitwise": ["off"],
"no-buffer-constructor": ["error"],
"no-caller": ["error"],
"no-case-declarations": ["error"],
"no-catch-shadow": ["error"],
"no-class-assign": ["error"],
"no-compare-neg-zero": ["error"],
"no-confusing-arrow": ["error"],
"no-console": ["off"],
"no-const-assign": ["error"],
"no-constant-condition": [
"error",
{
checkLoops: false,
},
],
"no-continue": ["off"],
"no-control-regex": ["error"],
"no-debugger": ["error"],
"no-delete-var": ["error"],
"no-div-regex": ["error"],
"no-dupe-args": ["error"],
"no-dupe-class-members": ["error"],
"no-dupe-keys": ["error"],
"no-duplicate-case": ["error"],
"no-duplicate-imports": [
"error",
{
includeExports: true,
},
],
"no-else-return": ["off"],
"no-empty": [
"off",
{
allowEmptyCatch: false,
},
],
"no-empty-character-class": ["error"],
"no-empty-function": ["off"],
"no-empty-pattern": ["error"],
"no-eq-null": ["off"],
"no-ex-assign": ["off"],
"no-extra-boolean-cast": ["error"],
"no-extra-parens": ["off"],
"no-extra-semi": ["error"],
"no-eval": ["off"],
"no-extend-native": ["off"],
"no-extra-bind": ["error"],
"no-extra-label": ["error"],
"no-fallthrough": ["off"],
"no-floating-decimal": ["off"],
"no-func-assign": ["error"],
"no-global-assign": ["error"],
"no-implicit-coercion": ["off"],
"no-implicit-globals": ["error"],
"no-implied-eval": ["error"],
"no-inline-comments": ["off"],
"no-inner-declarations": ["off", "both"],
"no-invalid-regexp": ["error"],
"no-invalid-this": ["off"],
"no-irregular-whitespace": [
"error",
{
skipStrings: false,
skipComments: false,
skipRegExps: false,
skipTemplates: false,
},
],
"no-iterator": ["error"],
"no-label-var": ["error"],
"no-labels": ["off"],
"no-lone-blocks": ["error"],
"no-lonely-if": ["error"],
"no-loop-func": ["off"],
"no-magic-numbers": ["off"],
"no-mixed-operators": ["off"],
"no-mixed-requires": ["error"],
"no-mixed-spaces-and-tabs": ["error"],
"no-multi-assign": ["off"],
"no-multi-spaces": ["off"],
"no-multi-str": ["error"],
"no-multiple-empty-lines": [
"off",
{
max: 1,
},
],
"no-native-reassign": ["error"],
"no-negated-condition": ["off"],
"no-negated-in-lhs": ["error"],
"no-nested-ternary": ["off"],
"no-new": ["error"],
"no-new-func": ["error"],
"no-new-object": ["error"],
"no-new-require": ["error"],
"no-new-symbol": ["error"],
"no-new-wrappers": ["error"],
"no-octal": ["error"],
"no-octal-escape": ["error"],
"no-obj-calls": ["error"],
"no-param-reassign": ["off"],
"no-path-concat": ["error"],
"no-plusplus": ["off"],
"no-process-env": ["off"],
"no-process-exit": ["error"],
"no-proto": ["error"],
"no-prototype-builtins": ["off"],
"no-redeclare": ["off"],
"no-regex-spaces": ["error"],
"no-restricted-globals": ["error"],
"no-restricted-imports": ["error"],
"no-restricted-modules": ["error"],
"no-restricted-properties": [
"off",
{
object: "console",
property: "log",
message: "'log' is too general, use an appropriate level when logging.",
},
],
"no-restricted-syntax": ["error"],
"no-return-assign": ["off"],
"no-return-await": ["error"],
"no-script-url": ["error"],
"no-self-assign": [
"error",
{
props: false,
},
],
"no-self-compare": ["error"],
"no-sequences": ["error"],
"no-shadow": ["off"],
"no-shadow-restricted-names": ["error"],
"no-spaced-func": ["off"],
"no-sparse-arrays": ["error"],
"no-sync": ["error"],
"no-tabs": ["off"],
"no-template-curly-in-string": ["error"],
"no-ternary": ["off"],
"no-this-before-super": ["off"],
"no-throw-literal": ["error"],
"no-trailing-spaces": ["error"],
"no-undef": ["off"],
"no-undef-init": ["error"],
"no-undefined": ["off"],
"no-underscore-dangle": ["off"],
"no-unexpected-multiline": ["error"],
"no-unmodified-loop-condition": ["error"],
"no-unneeded-ternary": ["off"],
"no-unreachable": ["off"],
"no-unsafe-finally": ["error"],
"no-unsafe-negation": ["error"],
"no-unused-expressions": ["off"],
"no-unused-labels": ["error"],
"no-unused-vars": ["off"],
"no-use-before-define": ["off"],
"no-useless-call": ["off"],
"no-useless-computed-key": ["error"],
"no-useless-concat": ["error"],
"no-useless-constructor": ["error"],
"no-useless-escape": ["off"],
"no-useless-rename": [
"error",
{
ignoreDestructuring: false,
ignoreExport: false,
ignoreImport: false,
},
],
"no-useless-return": ["off"],
"no-var": ["off"],
"no-void": ["off"],
"no-warning-comments": ["off"],
"no-whitespace-before-property": ["error"],
"no-with": ["error"],
"nonblock-statement-body-position": ["off", "below"],
"object-curly-newline": ["off"],
"object-curly-spacing": ["off"],
"object-property-newline": ["off"],
"object-shorthand": ["off"],
"one-var": ["off"],
"one-var-declaration-per-line": ["off"],
"operator-assignment": ["off"],
"operator-linebreak": ["off", "none"],
"padded-blocks": ["off"],
"padding-line-between-statements": ["error"],
"prefer-arrow-callback": ["off"],
"prefer-const": ["off"],
"prefer-destructuring": ["off"],
"prefer-numeric-literals": ["error"],
"prefer-promise-reject-errors": ["off"],
"prefer-reflect": ["off"],
"prefer-rest-params": ["off"],
"prefer-spread": ["off"],
"prefer-template": ["off"],
"quote-props": ["off"],
quotes: ["off"],
radix: ["off", "as-needed"],
"require-await": ["off"],
"require-jsdoc": ["off"],
"require-yield": ["error"],
"rest-spread-spacing": ["error", "never"],
semi: ["off"],
"semi-spacing": ["off"],
"semi-style": ["error", "last"],
"sort-imports": ["off"],
"sort-keys": ["off"],
"sort-vars": ["off"],
"space-before-blocks": ["off"],
"space-before-function-paren": ["off"],
"space-in-parens": ["off"],
"space-infix-ops": ["off"],
"space-unary-ops": ["off"],
"spaced-comment": ["off"],
strict: ["off"],
"switch-colon-spacing": [
"error",
{
after: true,
before: false,
},
],
"symbol-description": ["error"],
"template-curly-spacing": ["error"],
"template-tag-spacing": ["error"],
"unicode-bom": ["error", "never"],
"use-isnan": ["error"],
"valid-jsdoc": ["off"],
"valid-typeof": ["error"],
"vars-on-top": ["off"],
"wrap-iife": ["error", "any"],
"wrap-regex": ["off"],
"yield-star-spacing": ["error", "before"],
yoda: ["error", "never"],
"@typescript-eslint/explicit-module-boundary-types": "off",
"@typescript-eslint/explicit-function-return-type": "off",
}, },
overrides: [
{
// enable the rule specifically for TypeScript files
files: ["*.ts", "*.tsx"],
rules: {
"@typescript-eslint/explicit-function-return-type": ["error"],
"@typescript-eslint/explicit-module-boundary-types": ["error"],
},
},
{
// TypeScript configuration
files: ["**/*.ts", "**/*.tsx"],
parser: "@typescript-eslint/parser",
plugins: ["@typescript-eslint"],
extends: ["plugin:@typescript-eslint/recommended"],
rules: {
"lines-between-class-members": "off",
"no-empty-pattern": "off",
"no-useless-constructor": [
"off", // Valid for typescript due to property ctor shorthand
],
"@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
"@typescript-eslint/ban-ts-comment": "off",
"@typescript-eslint/ban-ts-ignore": "off",
"@typescript-eslint/camelcase": "off",
"@typescript-eslint/explicit-function-return-type": [
"error",
{
allowExpressions: true,
},
],
"@typescript-eslint/member-delimiter-style": [
"error",
{
multiline: {
delimiter: "semi",
requireLast: true,
},
singleline: {
delimiter: "semi",
requireLast: false,
},
},
],
"@typescript-eslint/member-ordering": [
"error",
{
default: [
"signature",
"static-field",
"instance-field",
"abstract-field",
"constructor",
"instance-method",
"abstract-method",
"static-method",
],
},
],
"@typescript-eslint/no-explicit-any": "off",
"@typescript-eslint/no-use-before-define": "off",
},
},
],
}; };

279
dist/bitburner.d.ts vendored
View File

@ -136,7 +136,7 @@ export declare interface BitNodeMultipliers {
/** Influences how much money the player earns when completing working their job. */ /** Influences how much money the player earns when completing working their job. */
CompanyWorkMoney: number; CompanyWorkMoney: number;
/** Influences the money gain from dividends of corporations created by the player. */ /** Influences the money gain from dividends of corporations created by the player. */
CorporationSoftCap: number; CorporationSoftcap: number;
/** Influences the valuation of corporations created by the player. */ /** Influences the valuation of corporations created by the player. */
CorporationValuation: number; CorporationValuation: number;
/** Influences the base experience gained for each ability when the player commits a crime. */ /** Influences the base experience gained for each ability when the player commits a crime. */
@ -313,7 +313,7 @@ export declare interface Bladeburner {
* @remarks * @remarks
* RAM cost: 4 GB * RAM cost: 4 GB
* *
* Returns the number of seconds it takes to complete the specified action * Returns the number of milliseconds it takes to complete the specified action
* *
* @param type - Type of action. * @param type - Type of action.
* @param name - Name of action. Must be an exact match. * @param name - Name of action. Must be an exact match.
@ -321,6 +321,17 @@ export declare interface Bladeburner {
*/ */
getActionTime(type: string, name: string): number; getActionTime(type: string, name: string): number;
/**
* Get the time elapsed on current action.
* @remarks
* RAM cost: 4 GB
*
* Returns the number of milliseconds already spent on the current action.
*
* @returns Number of milliseconds already spent on the current action.
*/
getActionCurrentTime(): number;
/** /**
* Get estimate success chance of an action. * Get estimate success chance of an action.
* @remarks * @remarks
@ -496,28 +507,30 @@ export declare interface Bladeburner {
* @remarks * @remarks
* RAM cost: 4 GB * RAM cost: 4 GB
* *
* This function returns the number of skill points needed to upgrade the specified skill. * This function returns the number of skill points needed to upgrade the specified skill the specified number of times.
* *
* The function returns -1 if an invalid skill name is passed in. * The function returns -1 if an invalid skill name is passed in.
* *
* @param skillName - Name of skill. Case-sensitive and must be an exact match * @param skillName - Name of skill. Case-sensitive and must be an exact match
* @param count - Number of times to upgrade the skill. Defaults to 1 if not specified.
* @returns Number of skill points needed to upgrade the specified skill. * @returns Number of skill points needed to upgrade the specified skill.
*/ */
getSkillUpgradeCost(name: string): number; getSkillUpgradeCost(name: string, count?: number): number;
/** /**
* Upgrade skill. * Upgrade skill.
* @remarks * @remarks
* RAM cost: 4 GB * RAM cost: 4 GB
* *
* Attempts to upgrade the specified Bladeburner skill. * Attempts to upgrade the specified Bladeburner skill the specified number of times.
* *
* Returns true if the skill is successfully upgraded, and false otherwise. * Returns true if the skill is successfully upgraded, and false otherwise.
* *
* @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match
* @param count - Number of times to upgrade the skill. Defaults to 1 if not specified.
* @returns true if the skill is successfully upgraded, and false otherwise. * @returns true if the skill is successfully upgraded, and false otherwise.
*/ */
upgradeSkill(name: string): boolean; upgradeSkill(name: string, count?: number): boolean;
/** /**
* Get team size. * Get team size.
@ -673,7 +686,7 @@ export declare interface Bladeburner {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. * Returns the amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic.
* *
* “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
* *
@ -813,7 +826,7 @@ export declare interface CodingContract {
* Attempts to solve the Coding Contract with the provided solution. * Attempts to solve the Coding Contract with the provided solution.
* *
* @param answer - Solution for the contract. * @param answer - Solution for the contract.
* @param fn - Filename of 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 - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @param opts - Optional parameters for configuring function behavior. * @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. * @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.
@ -828,7 +841,7 @@ export declare interface CodingContract {
* Returns a name describing the type of problem posed by the Coding Contract. * Returns a name describing the type of problem posed by the Coding Contract.
* (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) * (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)
* *
* @param fn - Filename of 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 - Host 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. * @returns Name describing the type of problem posed by the Coding Contract.
*/ */
@ -841,7 +854,7 @@ export declare interface CodingContract {
* *
* Get the full text description for the problem posed by the Coding Contract. * Get the full text description for the problem posed by the Coding Contract.
* *
* @param fn - Filename of 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 - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns Contract’s text description. * @returns Contract’s text description.
*/ */
@ -869,7 +882,7 @@ export declare interface CodingContract {
* *
* Get the number of tries remaining on the contract before it self-destructs. * Get the number of tries remaining on the contract before it self-destructs.
* *
* @param fn - Filename of 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 - Host of the server containing the contract. Optional. Defaults to current server if not provided.
* @returns How many attempts are remaining for the contract; * @returns How many attempts are remaining for the contract;
*/ */
@ -1120,6 +1133,8 @@ export declare interface Division {
cities: string[]; cities: string[];
/** Products developed by this division */ /** Products developed by this division */
products: string[]; products: string[];
/** Whether the industry this division is in is capable of making products */
makesProducts: boolean;
} }
/** /**
@ -1129,22 +1144,27 @@ export declare interface Division {
export declare interface Employee { export declare interface Employee {
/** Name of the employee */ /** Name of the employee */
name: string; name: string;
/** Morale */ /** Morale of the employee */
mor: number; mor: number;
/** Happiness */ /** Happiness of the employee */
hap: number; hap: number;
/** Energy */ /** Energy of the employee */
ene: number; ene: number;
/** Intelligence of the employee */
int: number; int: number;
/** Charisma of the employee */
cha: number; cha: number;
/** Experience of the employee */
exp: number; exp: number;
/** Creativity of the employee */
cre: number; cre: number;
/** Efficiency of the employee */
eff: number; eff: number;
/** Salary */ /** Salary of the employee */
sal: number; sal: number;
/** City */ /** Current Location (city) */
loc: string; loc: string;
/** Current job */ /** Current job position */
pos: string; pos: string;
} }
@ -1476,7 +1496,7 @@ export declare interface Gang {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. * Returns the amount of accumulated “bonus time” (milliseconds) for the Gang mechanic.
* *
* “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.
* *
@ -2439,6 +2459,47 @@ export declare interface HacknetServersFormulas {
constants(): HacknetServerConstants; constants(): HacknetServerConstants;
} }
/**
* Infiltration API.
* @public
*/
export declare interface Infiltration {
/**
* Get all locations that can be infiltrated.
* @remarks
* RAM cost: 5 GB
*
* @returns all locations that can be infiltrated.
*/
getPossibleLocations(): string[];
/**
* Get all infiltrations with difficulty, location and rewards.
* @remarks
* RAM cost: 15 GB
*
* @returns Infiltration data for given location.
*/
getInfiltration(location: string): InfiltrationLocation;
}
/**
* @public
*/
export declare interface InfiltrationLocation {
location: any;
reward: InfiltrationReward;
difficulty: number;
}
/**
* @public
*/
export declare interface InfiltrationReward {
tradeRep: number;
sellCash: number;
SoARep: number;
}
/** /**
* Corporation investment offer * Corporation investment offer
* @public * @public
@ -2478,8 +2539,12 @@ export declare interface Material {
cmp: number | undefined; cmp: number | undefined;
/** Amount of material produced */ /** Amount of material produced */
prod: number; prod: number;
/** Amount of material sold */ /** Amount of material sold */
sell: number; sell: number;
/** cost to buy material */
cost: number;
/** Sell cost, can be "MP+5" */
sCost: string | number;
} }
/** /**
@ -2657,6 +2722,11 @@ export declare interface NS {
* RAM cost: 0 GB * RAM cost: 0 GB
*/ */
readonly stanek: Stanek; readonly stanek: Stanek;
/**
* Namespace for infiltration functions.
* RAM cost: 0 GB
*/
readonly infiltration: Infiltration;
/** /**
* Namespace for corporation functions. * Namespace for corporation functions.
* RAM cost: 0 GB * RAM cost: 0 GB
@ -2959,6 +3029,7 @@ export declare interface NS {
/** /**
* Suspends the script for n milliseconds. Doesn't block with concurrent calls. * Suspends the script for n milliseconds. Doesn't block with concurrent calls.
* You should prefer 'sleep' over 'asleep' except when doing very complex UI work.
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
@ -3001,6 +3072,7 @@ export declare interface NS {
* @remarks * @remarks
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* see: https://github.com/alexei/sprintf.js
* @param format - format of the message * @param format - format of the message
* @param msg - Value to be printed. * @param msg - Value to be printed.
*/ */
@ -3092,7 +3164,7 @@ export declare interface NS {
* @param args - Arguments to identify which scripts to get logs for. * @param args - Arguments to identify which scripts to get logs for.
* @returns Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array. * @returns Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array.
*/ */
getScriptLogs(fn?: string, host?: string, ...args: any[]): string[]; getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[];
/** /**
* Get an array of recently killed scripts across all servers. * Get an array of recently killed scripts across all servers.
@ -3155,7 +3227,22 @@ export declare interface NS {
* @param host - Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. * @param host - Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional.
* @param args - Arguments for the script being tailed. * @param args - Arguments for the script being tailed.
*/ */
tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void; tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void;
/**
* Close the tail window of a script.
* @remarks
* RAM cost: 0 GB
*
* Closes a script’s logs. This is functionally the same pressing the "Close" button on the tail window.
*
* If the function is called with no arguments, it will close the current script’s logs.
*
* Otherwise, the pid argument can be used to close the logs from another script.
*
* @param pid - Optional. PID of the script having its tail closed. If omitted, the current script is used.
*/
closeTail(pid?: number): void;
/** /**
* Get the list of servers connected to a server. * Get the list of servers connected to a server.
@ -3345,7 +3432,7 @@ export declare interface NS {
* @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value. * @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value.
* @returns Returns the PID of a successfully started script, and 0 otherwise. * @returns Returns the PID of a successfully started script, and 0 otherwise.
*/ */
run(script: string, numThreads?: number, ...args: Array<string | number | boolean>): number; run(script: string, numThreads?: number, ...args: (string | number | boolean)[]): number;
/** /**
* Start another script on any server. * Start another script on any server.
@ -3361,8 +3448,7 @@ export declare interface NS {
* PID stands for Process ID. The PID is a unique identifier for each script. * PID stands for Process ID. The PID is a unique identifier for each script.
* The PID will always be a positive integer. * The PID will always be a positive integer.
* *
* Running this function with a numThreads argument of 0 will return 0 without running the script. * Running this function with 0 or a negative numThreads argument will cause a runtime error.
* However, running this function with a negative numThreads argument will cause a runtime error.
* *
* @example * @example
* ```ts * ```ts
@ -3394,7 +3480,7 @@ export declare interface NS {
* @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value. * @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value.
* @returns Returns the PID of a successfully started script, and 0 otherwise. * @returns Returns the PID of a successfully started script, and 0 otherwise.
*/ */
exec(script: string, host: string, numThreads?: number, ...args: Array<string | number | boolean>): number; exec(script: string, host: string, numThreads?: number, ...args: (string | number | boolean)[]): number;
/** /**
* Terminate current script and start another in 10s. * Terminate current script and start another in 10s.
@ -3424,7 +3510,7 @@ export declare interface NS {
* @param numThreads - Number of threads to spawn new script with. Will be rounded to nearest integer. * @param numThreads - Number of threads to spawn new script with. Will be rounded to nearest integer.
* @param args - Additional arguments to pass into the new script that is being run. * @param args - Additional arguments to pass into the new script that is being run.
*/ */
spawn(script: string, numThreads?: number, ...args: string[]): void; spawn(script: string, numThreads?: number, ...args: (string | number | boolean)[]): void;
/** /**
* Terminate another script. * Terminate another script.
@ -3494,7 +3580,7 @@ export declare interface NS {
* ns.kill("foo.script", getHostname(), 1, "foodnstuff"); * ns.kill("foo.script", getHostname(), 1, "foodnstuff");
* ``` * ```
*/ */
kill(script: string, host: string, ...args: string[]): boolean; kill(script: string, host: string, ...args: (string | number | boolean)[]): boolean;
/** /**
* Terminate all scripts on a server. * Terminate all scripts on a server.
@ -3507,9 +3593,10 @@ export declare interface NS {
* If no host is defined, it will kill all scripts, where the script is running. * If no host is defined, it will kill all scripts, where the script is running.
* *
* @param host - IP or hostname of the server on which to kill all scripts. * @param host - IP or hostname of the server on which to kill all scripts.
* @param safetyguard - Skips the script that calls this function
* @returns True if any scripts were killed, and false otherwise. * @returns True if any scripts were killed, and false otherwise.
*/ */
killall(host?: string): boolean; killall(host?: string, safetyguard?: boolean): boolean;
/** /**
* Terminates the current script immediately. * Terminates the current script immediately.
@ -3990,7 +4077,7 @@ export declare interface NS {
* @param args - Arguments to specify/identify which scripts to search for. * @param args - Arguments to specify/identify which scripts to search for.
* @returns True if specified script is running on the target server, and false otherwise. * @returns True if specified script is running on the target server, and false otherwise.
*/ */
isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean; isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean;
/** /**
* Get general info about a running script. * Get general info about a running script.
@ -4005,7 +4092,11 @@ export declare interface NS {
* @param args - Arguments to identify the script * @param args - Arguments to identify the script
* @returns The info about the running script if found, and null otherwise. * @returns The info about the running script if found, and null otherwise.
*/ */
getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript | null; getRunningScript(
filename?: FilenameOrPID,
hostname?: string,
...args: (string | number | boolean)[]
): RunningScript | null;
/** /**
* Get cost of purchasing a server. * Get cost of purchasing a server.
@ -4322,7 +4413,7 @@ export declare interface NS {
* Returns 0 if the script does not exist. * Returns 0 if the script does not exist.
* *
* @param script - Filename of script. This is case-sensitive. * @param script - Filename of script. This is case-sensitive.
* @param host - Host of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. * @param host - Host of target server the script is located on. This is optional, if it is not specified then the function will use the current server as the target server.
* @returns Amount of RAM (in GB) required to run the specified script on the target server, and 0 if the script does not exist. * @returns Amount of RAM (in GB) required to run the specified script on the target server, and 0 if the script does not exist.
*/ */
getScriptRam(script: string, host?: string): number; getScriptRam(script: string, host?: string): number;
@ -4331,13 +4422,13 @@ export declare interface NS {
* Get the execution time of a hack() call. * Get the execution time of a hack() call.
* @remarks * @remarks
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
*When `hack` completes an amount of money is stolen depending on the player's skills. *
* When `hack` completes an amount of money is stolen depending on the player's skills.
* Returns the amount of time in milliseconds it takes to execute the hack Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the hack Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level. * The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @returns Returns the amount of time in milliseconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the hack Netscript function.
*/ */
getHackTime(host: string): number; getHackTime(host: string): number;
@ -4347,11 +4438,10 @@ export declare interface NS {
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
* *
* Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level. * The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @returns Returns the amount of time in milliseconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the grow Netscript function.
*/ */
getGrowTime(host: string): number; getGrowTime(host: string): number;
@ -4361,11 +4451,10 @@ export declare interface NS {
* RAM cost: 0.05 GB * RAM cost: 0.05 GB
* *
* Returns the amount of time in milliseconds it takes to execute the weaken Netscript function on the target server. * Returns the amount of time in milliseconds it takes to execute the weaken Netscript function on the target server.
* The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels.
* The required time is increased by the security level of the target server and decreased by the player's hacking level. * The required time is increased by the security level of the target server and decreased by the player's hacking level.
* *
* @param host - Host of target server. * @param host - Host of target server.
* @returns Returns the amount of time in milliseconds it takes to execute the weaken Netscript function. Returns Infinity if called on a Hacknet Server. * @returns Returns the amount of time in milliseconds it takes to execute the weaken Netscript function.
*/ */
getWeakenTime(host: string): number; getWeakenTime(host: string): number;
@ -4398,7 +4487,7 @@ export declare interface NS {
/** /**
* {@inheritDoc NS.(getScriptIncome:1)} * {@inheritDoc NS.(getScriptIncome:1)}
*/ */
getScriptIncome(script: string, host: string, ...args: string[]): number; getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number;
/** /**
* Get the exp gain of a script. * Get the exp gain of a script.
@ -4422,7 +4511,7 @@ export declare interface NS {
/** /**
* {@inheritDoc NS.(getScriptExpGain:1)} * {@inheritDoc NS.(getScriptExpGain:1)}
*/ */
getScriptExpGain(script: string, host: string, ...args: string[]): number; getScriptExpGain(script: string, host: string, ...args: (string | number | boolean)[]): number;
/** /**
* Returns the amount of time in milliseconds that have passed since you last installed Augmentations. * Returns the amount of time in milliseconds that have passed since you last installed Augmentations.
@ -4525,7 +4614,7 @@ export declare interface NS {
* RAM cost: 0 GB * RAM cost: 0 GB
* *
* Retrieves data from a URL and downloads it to a file on the specified server. * Retrieves data from a URL and downloads it to a file on the specified server.
* The data can only be downloaded to a script (.script, .ns, .js) or a text file (.txt). * The data can only be downloaded to a script (.script or .js) or a text file (.txt).
* If the file already exists, it will be overwritten by this command. * If the file already exists, it will be overwritten by this command.
* Note that it will not be possible to download data from many websites because they * Note that it will not be possible to download data from many websites because they
* do not allow cross-origin resource sharing (CORS). * do not allow cross-origin resource sharing (CORS).
@ -4669,7 +4758,7 @@ export declare interface NS {
* ]); * ]);
* tprint(data); * tprint(data);
* *
* // example.ns * // example.js
* export async function main(ns) { * export async function main(ns) {
* const data = ns.flags([ * const data = ns.flags([
* ['delay', 0], // a default number means this flag is a number * ['delay', 0], // a default number means this flag is a number
@ -5066,6 +5155,13 @@ export declare interface ReputationFormulas {
* @returns The calculated faction favor. * @returns The calculated faction favor.
*/ */
calculateRepToFavor(rep: number): number; calculateRepToFavor(rep: number): number;
/**
* Calculate how much rep would be gained.
* @param amount - Amount of money donated
* @param player - Player info from {@link NS.getPlayer | getPlayer}
*/
repFromDonation(amount: number, player: Player): number;
} }
/** /**
@ -5432,6 +5528,18 @@ export declare interface Singularity {
*/ */
workForCompany(companyName?: string, focus?: boolean): boolean; workForCompany(companyName?: string, focus?: boolean): boolean;
/**
* Quit jobs by company.
* @remarks
* RAM cost: 3 GB * 16/4/1
*
*
* This function will finish work with the company provided and quit any jobs.
*
* @param companyName - Name of the company.
*/
quitJob(companyName?: string): void;
/** /**
* Apply for a job at a company. * Apply for a job at a company.
* @remarks * @remarks
@ -5830,7 +5938,7 @@ export declare interface Singularity {
* RAM cost: 5 GB * 16/4/1 * RAM cost: 5 GB * 16/4/1
* *
* *
* This function will automatically install your Augmentations, resetting the game as usual. * This function will automatically install your Augmentations, resetting the game as usual. If you do not own uninstalled Augmentations then the game will not reset.
* *
* @param cbScript - This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. * @param cbScript - This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer.
*/ */
@ -5972,13 +6080,13 @@ export declare interface Singularity {
* @example * @example
* ```ts * ```ts
* // NS1 * // NS1
* getDarkwebProgramsAvailable(); * getDarkwebPrograms();
* // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc] * // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc]
* ``` * ```
* @example * @example
* ```ts * ```ts
* // NS2 * // NS2
* ns.getDarkwebProgramsAvailable(); * ns.getDarkwebPrograms();
* // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc] * // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc]
* ``` * ```
* @returns - a list of programs available for purchase on the dark web, or [] if Tor has not * @returns - a list of programs available for purchase on the dark web, or [] if Tor has not
@ -6018,6 +6126,30 @@ export declare interface Singularity {
* purchased. Throws an error if the specified program/exploit does not exist * purchased. Throws an error if the specified program/exploit does not exist
*/ */
getDarkwebProgramCost(programName: string): number; getDarkwebProgramCost(programName: string): number;
/**
* b1t_flum3 into a different BN.
* @remarks
* RAM cost: 16 GB * 16/4/1
*
* @param nextBN - BN number to jump to
* @param callbackScript - Name of the script to launch in the next BN.
*/
b1tflum3(nextBN: number, callbackScript?: string): void;
/**
* Destroy the w0r1d_d43m0n and move on to the next BN.
* @remarks
* RAM cost: 32 GB * 16/4/1
*
* You must have the special augment installed and the required hacking level
* OR
* Completed the final black op.
*
* @param nextBN - BN number to jump to
* @param callbackScript - Name of the script to launch in the next BN.
*/
destroyW0r1dD43m0n(nextBN: number, callbackScript?: string): void;
} }
/** /**
@ -6238,6 +6370,20 @@ export declare interface Sleeve {
* @returns True if the aug was purchased and installed on the sleeve, false otherwise. * @returns True if the aug was purchased and installed on the sleeve, false otherwise.
*/ */
purchaseSleeveAug(sleeveNumber: number, augName: string): boolean; purchaseSleeveAug(sleeveNumber: number, augName: string): boolean;
/**
* Set a sleeve to perform bladeburner actions.
* @remarks
* RAM cost: 4 GB
*
* Return a boolean indicating whether or not the sleeve started working out.
*
* @param sleeveNumber - Index of the sleeve to workout at the gym.
* @param action - Name of the action to be performed.
* @param contract - Name of the contract if applicable.
* @returns True if the sleeve started working out, false otherwise.
*/
setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean;
} }
/** /**
@ -6309,6 +6455,8 @@ export declare interface SleeveTask {
gymStatType: string; gymStatType: string;
/** Faction work type being performed, if any */ /** Faction work type being performed, if any */
factionWorkType: string; factionWorkType: string;
/** Class being taken at university, if any */
className: string;
} }
/** /**
@ -6441,6 +6589,16 @@ export declare interface Stanek {
* @returns The fragment at [rootX, rootY], if any. * @returns The fragment at [rootX, rootY], if any.
*/ */
removeFragment(rootX: number, rootY: number): boolean; removeFragment(rootX: number, rootY: number): boolean;
/**
* Accept Stanek's Gift by joining the Church of the Machine God
* @remarks
* RAM cost: 2 GB
*
* @returns true if the player is a member of the church and has the gift installed,
* false otherwise.
*/
acceptGift(): boolean;
} }
/** /**
@ -6927,6 +7085,13 @@ export declare interface UserInterface {
* RAM cost: 0 GB * RAM cost: 0 GB
*/ */
getGameInfo(): GameInfo; getGameInfo(): GameInfo;
/**
* Clear the Terminal window, as if the player ran `clear` in the terminal
* @remarks
* RAM cost: 0.2 GB
*/
clearTerminal(): void;
} }
/** /**
@ -7152,8 +7317,9 @@ export declare interface WarehouseAPI {
* Upgrade warehouse * Upgrade warehouse
* @param divisionName - Name of the division * @param divisionName - Name of the division
* @param cityName - Name of the city * @param cityName - Name of the city
* @param amt - amount of upgrades defaults to 1
*/ */
upgradeWarehouse(divisionName: string, cityName: string): void; upgradeWarehouse(divisionName: string, cityName: string, amt?: number): void;
/** /**
* Create a new product * Create a new product
* @param divisionName - Name of the division * @param divisionName - Name of the division
@ -7169,6 +7335,22 @@ export declare interface WarehouseAPI {
designInvest: number, designInvest: number,
marketingInvest: number, marketingInvest: number,
): void; ): void;
/**
* Limit Material Production.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param materialName - Name of the material
* @param qty - Amount to limit to
*/
limitMaterialProduction(divisionName: string, cityName: string, materialName: string, qty: number): void;
/**
* Limit Product Production.
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param productName - Name of the product
* @param qty - Amount to limit to
*/
limitProductProduction(divisionName: string, cityName: string, productName: string, qty: number): void;
/** /**
* Gets the cost to purchase a warehouse * Gets the cost to purchase a warehouse
* @returns cost * @returns cost
@ -7176,9 +7358,12 @@ export declare interface WarehouseAPI {
getPurchaseWarehouseCost(): number; getPurchaseWarehouseCost(): number;
/** /**
* Gets the cost to upgrade a warehouse to the next level * Gets the cost to upgrade a warehouse to the next level
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param amt - amount of upgrades defaults to 1
* @returns cost to upgrade * @returns cost to upgrade
*/ */
getUpgradeWarehouseCost(adivisionName: any, acityName: any): number; getUpgradeWarehouseCost(adivisionName: any, acityName: any, amt?: number): number;
/** /**
* Check if you have a warehouse in city * Check if you have a warehouse in city
* @returns true if warehouse is present, false if not * @returns true if warehouse is present, false if not

4
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

64
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

2
doc/source/advancedgameplay/bitnodes.rst
View File

@ -35,6 +35,8 @@ Furthermore, some BitNodes introduce new content and mechanics. For example ther
BitNode that grants access to the `Singularity API <https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.singularity.md>`_. BitNode that grants access to the `Singularity API <https://github.com/danielyxie/bitburner/blob/dev/markdown/bitburner.singularity.md>`_.
There is another BitNode in which you can manage a gang to earn money and reputation. There is another BitNode in which you can manage a gang to earn money and reputation.
.. _gameplay_bitnodes_howtodestroy:
How to destroy a BitNode How to destroy a BitNode
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^
Initially, the only way to destroy a BitNode is to join the Daedalus :ref:`Daedalus <gameplay_factions>`. Initially, the only way to destroy a BitNode is to join the Daedalus :ref:`Daedalus <gameplay_factions>`.

5
doc/source/advancedgameplay/sleeves.rst
View File

@ -39,7 +39,7 @@ There are two methods of obtaining Duplicate Sleeves:
1. Destroy BitNode-10. Each completion give you one additional Duplicate Sleeve 1. Destroy BitNode-10. Each completion give you one additional Duplicate Sleeve
2. Purchase Duplicate Sleeves from :ref:`the faction The Covenant <gameplay_factions>`. 2. Purchase Duplicate Sleeves from :ref:`the faction The Covenant <gameplay_factions>`.
This is only available in BitNodes-10. Sleeves purchased this way are **permanent** (they persist This is only available in BitNode-10. Sleeves purchased this way are **permanent** (they persist
through BitNodes). You can purchase up to 5 Duplicate Sleeves from The Covenant. through BitNodes). You can purchase up to 5 Duplicate Sleeves from The Covenant.
Synchronization Synchronization
@ -86,8 +86,7 @@ switching BitNodes. For example, if a sleeve has a memory of 10, then when you
switch BitNodes its synchronization will initially be set to 10, rather than 1. switch BitNodes its synchronization will initially be set to 10, rather than 1.
Memory can only be increased by purchasing upgrades from The Covenant. Just like Memory can only be increased by purchasing upgrades from The Covenant. Just like
the ability to purchase additional sleeves, this is only available in BitNodes-10 the ability to purchase additional sleeves, this is only available in BitNode-10.
and above, and is only available after defeating BitNode-10 at least once.
Memory is a persistent stat, meaning it never gets reset back to 1. Memory is a persistent stat, meaning it never gets reset back to 1.
The maximum possible value for a sleeve's memory is 100. The maximum possible value for a sleeve's memory is 100.

8
doc/source/advancedgameplay/sourcefiles.rst
View File

@ -5,7 +5,7 @@
Source-Files Source-Files
============ ============
Source-Files are a type of persistent upgrade that is more powerful than Augmentations. Source-Files are a type of persistent upgrade that is more powerful than Augmentations.
Source-Files are received by destroying a BitNode. There are many different BitNodes Source-Files are received by :ref:`destroying a BitNode <gameplay_bitnodes_howtodestroy>`. There are many different BitNodes
in the game and each BitNode will grant a different Source-File when it is destroyed. in the game and each BitNode will grant a different Source-File when it is destroyed.
A Source-File can be upgraded by destroying its corresponding BitNode a second or A Source-File can be upgraded by destroying its corresponding BitNode a second or
@ -63,4 +63,8 @@ List of all Source-Files
|| BitNode-12: The Recursion || * There is no maximum level for this Source-File. | || BitNode-12: The Recursion || * There is no maximum level for this Source-File. |
|| || * Let the player start with Neuroflux Governor equal to the level of this | || || * Let the player start with Neuroflux Governor equal to the level of this |
|| || Source-File. | || || Source-File. |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|| BitNode-13: They're lunatics || * This Source-File lets the Church of the Machine God appear in other BitNodes. |
|| || * Each level of this Source-File increases the size of Stanek's Gift. |
|| || |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

2
doc/source/basicgameplay/augmentations.rst
View File

@ -56,7 +56,7 @@ Here is everything you will KEEP when you install an Augmentation:
* Every Augmentation you have installed * Every Augmentation you have installed
* Scripts on your home computer * Scripts on your home computer
* RAM Upgrades on your home computer * RAM/Core Upgrades on your home computer
* World Stock Exchange account and TIX API Access * World Stock Exchange account and TIX API Access
.. _gameplay_augmentations_purchasingmultiple: .. _gameplay_augmentations_purchasingmultiple:

32
doc/source/basicgameplay/codingcontracts.rst
View File

@ -370,3 +370,35 @@ The list contains the name of (i.e. the value returned by
| | | aaaaaaaaaaaaa -> 1a91031 | | | | aaaaaaaaaaaaa -> 1a91031 |
| | | aaaaaaaaaaaaaa -> 1a91041 | | | | aaaaaaaaaaaaaa -> 1a91041 |
+-----------------------------------------+------------------------------------------------------------------------------------------+ +-----------------------------------------+------------------------------------------------------------------------------------------+
| Encryption I: Caesar Cipher | | Caesar cipher is one of the simplest encryption technique. It is a type of |
| | | substitution cipher in which each letter in the plaintext is replaced by a letter some |
| | | fixed number of positions down the alphabet. For example, with a left shift of 3, D |
| | | would be replaced by A, E would become B, and A would become X (because of rotation). |
| | | You are given an array with two elements.The first element is the plaintext, the |
| | | second element is the left shift value. Return the ciphertext as uppercase string. |
| | | Spaces remains the same. |
+-----------------------------------------+------------------------------------------------------------------------------------------+
| Encryption II: Vigenère Cipher | | Vigenère cipher is a type of polyalphabetic substitution. It uses the Vigenère square |
| | | to encrypt and decrypt plaintext with a keyword. |
| | | Vignenère square: |
| | | A B C D E F G H I J K L M N O P Q R S T U V W X Y Z |
| | | +---------------------------------------------------- |
| | | A | A B C D E F G H I J K L M N O P Q R S T U V W X Y Z |
| | | B | B C D E F G H I J K L M N O P Q R S T U V W X Y Z A |
| | | C | C D E F G H I J K L M N O P Q R S T U V W X Y Z A B |
| | | D | D E F G H I J K L M N O P Q R S T U V W X Y Z A B C |
| | | E | E F G H I J K L M N O P Q R S T U V W X Y Z A B C D |
| | | ... |
| | | Y | Y Z A B C D E F G H I J K L M N O P Q R S T U V W X |
| | | Z | Z A B C D E F G H I J K L M N O P Q R S T U V W X Y |
| | | For encryption each letter of the plaintext is paired with the corresponding letter of |
| | | a repeating keyword. For example, the plaintext DASHBOARD is encrypted with the |
| | | keyword LINUX: |
| | | Plaintext: DASHBOARD |
| | | Keyword: LINUXLINU |
| | | So, the first letter D is paired with the first letter of the key L. Therefore, row D |
| | | and column L of the Vigenère square are used to get the first cipher letter O. This |
| | | must be repeated for the whole ciphertext. |
| | | You are given an array with two elements. The first element is the plaintext, the |
| | | second element is the keyword. Return the ciphertext as uppercase string. |
+-----------------------------------------+------------------------------------------------------------------------------------------+

14
doc/source/basicgameplay/crimes.rst
View File

@ -26,4 +26,16 @@ Harder crimes are typically more profitable, and also give more EXP.
Crime details Crime details
^^^^^^^^^^^^^ ^^^^^^^^^^^^^
TODO Available crimes, and their descriptions, which all begin with "attempt to..."
Shoplift …shoplift from a low-end retailer
Rob store …commit armed robbery on a high-end store
Mug someone …mug a random person on the street
Larceny …rob property from someone's house
Deal Drugs …deal drugs
Bond Forgery …forge corporate bonds
Traffick illegal Arms …smuggle illegal arms into the city
Homicide …murder a random person on the street
Grand theft Auto …commit grand theft auto
Kidnap and Ransom …kidnap and ransom a high-profile-target
Assassinate …assassinate a high-profile target
Heist …pull off the ultimate heist

3
doc/source/basicgameplay/factions.rst
View File

@ -2,6 +2,9 @@
Factions Factions
======== ========
.. warning:: This page contains spoilers regarding the game's story/plot-line.
Throughout the game you may receive invitations from factions. There are Throughout the game you may receive invitations from factions. There are
many different factions, and each faction has different criteria for many different factions, and each faction has different criteria for
determining its potential members. Joining a faction and furthering determining its potential members. Joining a faction and furthering

9
doc/source/basicgameplay/terminal.rst
View File

@ -8,15 +8,6 @@ on the navigation menu on the left-hand side of the game (you may need to expand
the 'Hacking' header in order to see the 'Terminal' tab). Alternatively, the :ref:`keyboard the 'Hacking' header in order to see the 'Terminal' tab). Alternatively, the :ref:`keyboard
shortcut <shortcuts>` Alt + t can be used to open the Terminal. shortcut <shortcuts>` Alt + t can be used to open the Terminal.
Configuration
-------------
The terminal has a configuration file called .fconf. To edit this file, go to
the terminal and enter::
nano .fconf
.. _terminal_filesystem: .. _terminal_filesystem:
Filesystem (Directories) Filesystem (Directories)

2
doc/source/guidesandtips/gettingstartedguideforbeginnerprogrammers.rst
View File

@ -62,7 +62,7 @@ To briefly summarize the information from the links above: Each server has a
security level that affects how difficult it is to hack. Each server also has a security level that affects how difficult it is to hack. Each server also has a
certain amount of money, as well as a maximum amount of money it can hold. Hacking a certain amount of money, as well as a maximum amount of money it can hold. Hacking a
server steals a percentage of that server's money. The :js:func:`hack` Netscript function server steals a percentage of that server's money. The :js:func:`hack` Netscript function
is used to hack server. The :js:func:`grow` Netscript function is used to increase is used to hack a server. The :js:func:`grow` Netscript function is used to increase
the amount of money available on a server. The :js:func:`weaken` Netscript function is the amount of money available on a server. The :js:func:`weaken` Netscript function is
used to decrease a server's security level. used to decrease a server's security level.

4
doc/source/netscript/advancedfunctions/inject_html.rst
View File

@ -21,7 +21,7 @@ To automatically enter commands in the terminal (only works if looking at the te
terminalInput[handler].onChange({target:terminalInput}); terminalInput[handler].onChange({target:terminalInput});
// Simulate an enter press // Simulate an enter press
terminalInput[handler].onKeyDown({keyCode:13,preventDefault:()=>null}); terminalInput[handler].onKeyDown({key:'Enter',preventDefault:()=>null});
To add lines to the terminal (only works if looking at the terminal): To add lines to the terminal (only works if looking at the terminal):
@ -32,4 +32,4 @@ To add lines to the terminal (only works if looking at the terminal):
const list = document.getElementById("generic-react-container").querySelector("ul"); const list = document.getElementById("generic-react-container").querySelector("ul");
// Inject some HTML. // Inject some HTML.
list.insertAdjacentHTML('beforeend',`<li><p color=lime>whatever custom html</p></li>`) list.insertAdjacentHTML('beforeend',`<li><p color=lime>whatever custom html</p></li>`)

2
doc/source/netscript/basicfunctions/scriptKill.rst
View File

@ -15,4 +15,4 @@ scriptKill() Netscript Function
.. code-block:: javascript .. code-block:: javascript
scriptKill("demo.script"); // returns: true scriptKill("demo.script", "home"); // returns: true

2
doc/source/netscript/basicfunctions/spawn.rst
View File

@ -23,4 +23,4 @@ spawn() Netscript Function
.. code-block:: javascript .. code-block:: javascript
spawn('foo.script', 10, 'foodnstuff', 90); // "run foo.script 10 foodnstuff 90" in 10 seconds. spawn('foo.script', 10, 'foodnstuff', 90); // "run foo.script foodnstuff 90 -t 10" in 10 seconds.

11
doc/source/netscript/netscriptscriptarguments.rst
View File

@ -23,3 +23,14 @@ into a script using::
args.length args.length
**WARNING: Do not try to modify the args array. This will break the game.** **WARNING: Do not try to modify the args array. This will break the game.**
example for accessing arguments in ns2 from terminal execution:
terminal command:
run name_of_script.js -t 10 --tail argument1 argument2
ns2 script:
const args_obj = arguments[0]
const argument1 = (args_obj.server.args[0])
const argument2 = (args_obj.server.args[1])

6
markdown/bitburner.bitnodemultipliers.corporationsoftcap.md
View File

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

2
markdown/bitburner.bitnodemultipliers.md
View File

@ -26,7 +26,7 @@ export interface BitNodeMultipliers
| [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) | number | Influences the amount of money gained from completing Coding Contracts | | [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. | | [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. | | [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md) | number | Influences how much money the player earns when completing working their job. |
| [CorporationSoftCap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | number | Influences the money gain from dividends of corporations created by the player. | | [CorporationSoftcap](./bitburner.bitnodemultipliers.corporationsoftcap.md) | number | Influences the money gain from dividends of corporations created by the player. |
| [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) | number | Influences the valuation of corporations created by the player. | | [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. | | [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. | | [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) | number | Influences the base money gained when the player commits a crime. |

25
markdown/bitburner.bladeburner.getactioncurrenttime.md Normal file
View File

@ -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; [getActionCurrentTime](./bitburner.bladeburner.getactioncurrenttime.md)
## Bladeburner.getActionCurrentTime() method
Get the time elapsed on current action.
<b>Signature:</b>
```typescript
getActionCurrentTime(): number;
```
<b>Returns:</b>
number
Number of milliseconds already spent on the current action.
## Remarks
RAM cost: 4 GB
Returns the number of milliseconds already spent on the current action.

2
markdown/bitburner.bladeburner.getactiontime.md
View File

@ -29,5 +29,5 @@ Number of milliseconds it takes to complete the specified action.
RAM cost: 4 GB RAM cost: 4 GB
Returns the number of seconds it takes to complete the specified action Returns the number of milliseconds it takes to complete the specified action

2
markdown/bitburner.bladeburner.getbonustime.md
View File

@ -21,7 +21,7 @@ Amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechan
RAM cost: 0 GB RAM cost: 0 GB
Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. Returns the amount of accumulated “bonus time” (milliseconds) for the Bladeburner mechanic.
“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.

5
markdown/bitburner.bladeburner.getskillupgradecost.md
View File

@ -9,7 +9,7 @@ Get cost to upgrade skill.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getSkillUpgradeCost(name: string): number; getSkillUpgradeCost(name: string, count?: number): number;
``` ```
## Parameters ## Parameters
@ -17,6 +17,7 @@ getSkillUpgradeCost(name: string): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | string | | | name | string | |
| count | number | Number of times to upgrade the skill. Defaults to 1 if not specified. |
<b>Returns:</b> <b>Returns:</b>
@ -28,7 +29,7 @@ Number of skill points needed to upgrade the specified skill.
RAM cost: 4 GB RAM cost: 4 GB
This function returns the number of skill points needed to upgrade the specified skill. This function returns the number of skill points needed to upgrade the specified skill the specified number of times.
The function returns -1 if an invalid skill name is passed in. The function returns -1 if an invalid skill name is passed in.

5
markdown/bitburner.bladeburner.md
View File

@ -23,6 +23,7 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | Get whether an action is set to autolevel. | | [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | Get whether an action is set to autolevel. |
| [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | Get action count remaining. | | [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | Get action count remaining. |
| [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | Get the current level of an action. | | [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | Get the current level of an action. |
| [getActionCurrentTime()](./bitburner.bladeburner.getactioncurrenttime.md) | Get the time elapsed on current action. |
| [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. | | [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. |
| [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | Get the maximum level of an action. | | [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | Get the maximum level of an action. |
| [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | Get the reputation gain of an action. | | [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | Get the reputation gain of an action. |
@ -42,7 +43,7 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | Get skill level. | | [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | Get skill level. |
| [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | List all skills. | | [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | List all skills. |
| [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | Get bladeburner skill points. | | [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | Get bladeburner skill points. |
| [getSkillUpgradeCost(name)](./bitburner.bladeburner.getskillupgradecost.md) | Get cost to upgrade skill. | | [getSkillUpgradeCost(name, count)](./bitburner.bladeburner.getskillupgradecost.md) | Get cost to upgrade skill. |
| [getStamina()](./bitburner.bladeburner.getstamina.md) | Get bladeburner stamina. | | [getStamina()](./bitburner.bladeburner.getstamina.md) | Get bladeburner stamina. |
| [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | Get team size. | | [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | Get team size. |
| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the bladeburner division. | | [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | Join the bladeburner division. |
@ -53,5 +54,5 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| [startAction(type, name)](./bitburner.bladeburner.startaction.md) | Start an action. | | [startAction(type, name)](./bitburner.bladeburner.startaction.md) | Start an action. |
| [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | Stop current action. | | [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | Stop current action. |
| [switchCity(name)](./bitburner.bladeburner.switchcity.md) | Travel to another city in bladeburner. | | [switchCity(name)](./bitburner.bladeburner.switchcity.md) | Travel to another city in bladeburner. |
| [upgradeSkill(name)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. | | [upgradeSkill(name, count)](./bitburner.bladeburner.upgradeskill.md) | Upgrade skill. |

5
markdown/bitburner.bladeburner.upgradeskill.md
View File

@ -9,7 +9,7 @@ Upgrade skill.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
upgradeSkill(name: string): boolean; upgradeSkill(name: string, count?: number): boolean;
``` ```
## Parameters ## Parameters
@ -17,6 +17,7 @@ upgradeSkill(name: string): boolean;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| name | string | | | name | string | |
| count | number | Number of times to upgrade the skill. Defaults to 1 if not specified. |
<b>Returns:</b> <b>Returns:</b>
@ -28,7 +29,7 @@ true if the skill is successfully upgraded, and false otherwise.
RAM cost: 4 GB RAM cost: 4 GB
Attempts to upgrade the specified Bladeburner skill. Attempts to upgrade the specified Bladeburner skill the specified number of times.
Returns true if the skill is successfully upgraded, and false otherwise. Returns true if the skill is successfully upgraded, and false otherwise.

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

@ -17,7 +17,7 @@ attempt(answer: string[] | number, filename: string, host?: string, opts?: Codin
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| answer | string\[\] \| number | Solution for the contract. | | answer | string\[\] \| number | Solution for the contract. |
| filename | string | | | 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 | Host 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. | | opts | [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Optional parameters for configuring function behavior. |

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

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

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

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

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

@ -16,7 +16,7 @@ getNumTriesRemaining(filename: string, host?: string): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| filename | string | | | 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 | Host of the server containing the contract. Optional. Defaults to current server if not provided. |
<b>Returns:</b> <b>Returns:</b>

13
markdown/bitburner.division.makesproducts.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; [Division](./bitburner.division.md) &gt; [makesProducts](./bitburner.division.makesproducts.md)
## Division.makesProducts property
Whether the industry this division is in is capable of making products
<b>Signature:</b>
```typescript
makesProducts: boolean;
```

1
markdown/bitburner.division.md
View File

@ -20,6 +20,7 @@ interface Division
| [cities](./bitburner.division.cities.md) | string\[\] | Cities in which this division has expanded | | [cities](./bitburner.division.cities.md) | string\[\] | Cities in which this division has expanded |
| [lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) | number | Expenses last cycle | | [lastCycleExpenses](./bitburner.division.lastcycleexpenses.md) | number | Expenses last cycle |
| [lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) | number | Revenue last cycle | | [lastCycleRevenue](./bitburner.division.lastcyclerevenue.md) | number | Revenue last cycle |
| [makesProducts](./bitburner.division.makesproducts.md) | boolean | Whether the industry this division is in is capable of making products |
| [name](./bitburner.division.name.md) | string | Name of the division | | [name](./bitburner.division.name.md) | string | Name of the division |
| [popularity](./bitburner.division.popularity.md) | number | Popularity of the division | | [popularity](./bitburner.division.popularity.md) | number | Popularity of the division |
| [prodMult](./bitburner.division.prodmult.md) | number | Production multiplier | | [prodMult](./bitburner.division.prodmult.md) | number | Production multiplier |

2
markdown/bitburner.employee.cha.md
View File

@ -4,6 +4,8 @@
## Employee.cha property ## Employee.cha property
Charisma of the employee
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript

2
markdown/bitburner.employee.cre.md
View File

@ -4,6 +4,8 @@
## Employee.cre property ## Employee.cre property
Creativity of the employee
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript

2
markdown/bitburner.employee.eff.md
View File

@ -4,6 +4,8 @@
## Employee.eff property ## Employee.eff property
Efficiency of the employee
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript

2
markdown/bitburner.employee.ene.md
View File

@ -4,7 +4,7 @@
## Employee.ene property ## Employee.ene property
Energy Energy of the employee
<b>Signature:</b> <b>Signature:</b>

2
markdown/bitburner.employee.exp.md
View File

@ -4,6 +4,8 @@
## Employee.exp property ## Employee.exp property
Experience of the employee
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript

2
markdown/bitburner.employee.hap.md
View File

@ -4,7 +4,7 @@
## Employee.hap property ## Employee.hap property
Happiness Happiness of the employee
<b>Signature:</b> <b>Signature:</b>

2
markdown/bitburner.employee.int.md
View File

@ -4,6 +4,8 @@
## Employee.int property ## Employee.int property
Intelligence of the employee
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript

2
markdown/bitburner.employee.loc.md
View File

@ -4,7 +4,7 @@
## Employee.loc property ## Employee.loc property
City Current Location (city)
<b>Signature:</b> <b>Signature:</b>

22
markdown/bitburner.employee.md
View File

@ -16,16 +16,16 @@ interface Employee
| Property | Type | Description | | Property | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| [cha](./bitburner.employee.cha.md) | number | | | [cha](./bitburner.employee.cha.md) | number | Charisma of the employee |
| [cre](./bitburner.employee.cre.md) | number | | | [cre](./bitburner.employee.cre.md) | number | Creativity of the employee |
| [eff](./bitburner.employee.eff.md) | number | | | [eff](./bitburner.employee.eff.md) | number | Efficiency of the employee |
| [ene](./bitburner.employee.ene.md) | number | Energy | | [ene](./bitburner.employee.ene.md) | number | Energy of the employee |
| [exp](./bitburner.employee.exp.md) | number | | | [exp](./bitburner.employee.exp.md) | number | Experience of the employee |
| [hap](./bitburner.employee.hap.md) | number | Happiness | | [hap](./bitburner.employee.hap.md) | number | Happiness of the employee |
| [int](./bitburner.employee.int.md) | number | | | [int](./bitburner.employee.int.md) | number | Intelligence of the employee |
| [loc](./bitburner.employee.loc.md) | string | City | | [loc](./bitburner.employee.loc.md) | string | Current Location (city) |
| [mor](./bitburner.employee.mor.md) | number | Morale | | [mor](./bitburner.employee.mor.md) | number | Morale of the employee |
| [name](./bitburner.employee.name.md) | string | Name of the employee | | [name](./bitburner.employee.name.md) | string | Name of the employee |
| [pos](./bitburner.employee.pos.md) | string | Current job | | [pos](./bitburner.employee.pos.md) | string | Current job position |
| [sal](./bitburner.employee.sal.md) | number | Salary | | [sal](./bitburner.employee.sal.md) | number | Salary of the employee |

2
markdown/bitburner.employee.mor.md
View File

@ -4,7 +4,7 @@
## Employee.mor property ## Employee.mor property
Morale Morale of the employee
<b>Signature:</b> <b>Signature:</b>

2
markdown/bitburner.employee.pos.md
View File

@ -4,7 +4,7 @@
## Employee.pos property ## Employee.pos property
Current job Current job position
<b>Signature:</b> <b>Signature:</b>

2
markdown/bitburner.employee.sal.md
View File

@ -4,7 +4,7 @@
## Employee.sal property ## Employee.sal property
Salary Salary of the employee
<b>Signature:</b> <b>Signature:</b>

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

@ -21,7 +21,7 @@ Bonus time for the Gang mechanic in milliseconds.
RAM cost: 0 GB RAM cost: 0 GB
Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. Returns the amount of accumulated “bonus time” (milliseconds) for the Gang mechanic.
“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.

30
markdown/bitburner.infiltration.getinfiltration.md Normal file
View File

@ -0,0 +1,30 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Infiltration](./bitburner.infiltration.md) &gt; [getInfiltration](./bitburner.infiltration.getinfiltration.md)
## Infiltration.getInfiltration() method
Get all infiltrations with difficulty, location and rewards.
<b>Signature:</b>
```typescript
getInfiltration(location: string): InfiltrationLocation;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| location | string | |
<b>Returns:</b>
[InfiltrationLocation](./bitburner.infiltrationlocation.md)
Infiltration data for given location.
## Remarks
RAM cost: 15 GB

23
markdown/bitburner.infiltration.getpossiblelocations.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; [Infiltration](./bitburner.infiltration.md) &gt; [getPossibleLocations](./bitburner.infiltration.getpossiblelocations.md)
## Infiltration.getPossibleLocations() method
Get all locations that can be infiltrated.
<b>Signature:</b>
```typescript
getPossibleLocations(): string[];
```
<b>Returns:</b>
string\[\]
all locations that can be infiltrated.
## Remarks
RAM cost: 5 GB

21
markdown/bitburner.infiltration.md Normal file
View File

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Infiltration](./bitburner.infiltration.md)
## Infiltration interface
Infiltration API.
<b>Signature:</b>
```typescript
interface Infiltration
```
## Methods
| Method | Description |
| --- | --- |
| [getInfiltration(location)](./bitburner.infiltration.getinfiltration.md) | Get all infiltrations with difficulty, location and rewards. |
| [getPossibleLocations()](./bitburner.infiltration.getpossiblelocations.md) | Get all locations that can be infiltrated. |

11
markdown/bitburner.infiltrationlocation.difficulty.md Normal file
View File

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

11
markdown/bitburner.infiltrationlocation.location.md Normal file
View File

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

21
markdown/bitburner.infiltrationlocation.md Normal file
View File

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [InfiltrationLocation](./bitburner.infiltrationlocation.md)
## InfiltrationLocation interface
<b>Signature:</b>
```typescript
export interface InfiltrationLocation
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [difficulty](./bitburner.infiltrationlocation.difficulty.md) | number | |
| [location](./bitburner.infiltrationlocation.location.md) | any | |
| [reward](./bitburner.infiltrationlocation.reward.md) | [InfiltrationReward](./bitburner.infiltrationreward.md) | |

11
markdown/bitburner.infiltrationlocation.reward.md Normal file
View File

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

21
markdown/bitburner.infiltrationreward.md Normal file
View File

@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [InfiltrationReward](./bitburner.infiltrationreward.md)
## InfiltrationReward interface
<b>Signature:</b>
```typescript
export interface InfiltrationReward
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [sellCash](./bitburner.infiltrationreward.sellcash.md) | number | |
| [SoARep](./bitburner.infiltrationreward.soarep.md) | number | |
| [tradeRep](./bitburner.infiltrationreward.traderep.md) | number | |

11
markdown/bitburner.infiltrationreward.sellcash.md Normal file
View File

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

11
markdown/bitburner.infiltrationreward.soarep.md Normal file
View File

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

11
markdown/bitburner.infiltrationreward.traderep.md Normal file
View File

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

13
markdown/bitburner.material.cost.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; [cost](./bitburner.material.cost.md)
## Material.cost property
cost to buy material
<b>Signature:</b>
```typescript
cost: number;
```

2
markdown/bitburner.material.md
View File

@ -17,10 +17,12 @@ interface Material
| Property | Type | Description | | Property | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| [cmp](./bitburner.material.cmp.md) | number \| undefined | Competition for the material, only present if "Market Research - Competition" unlocked | | [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 |
| [dmd](./bitburner.material.dmd.md) | number \| undefined | Demand for the material, only present if "Market Research - Demand" unlocked | | [dmd](./bitburner.material.dmd.md) | number \| undefined | Demand for the material, only present if "Market Research - Demand" unlocked |
| [name](./bitburner.material.name.md) | string | Name of the material | | [name](./bitburner.material.name.md) | string | Name of the material |
| [prod](./bitburner.material.prod.md) | number | Amount of material produced | | [prod](./bitburner.material.prod.md) | number | Amount of material produced |
| [qlt](./bitburner.material.qlt.md) | number | Quality of the material | | [qlt](./bitburner.material.qlt.md) | number | Quality of the material |
| [qty](./bitburner.material.qty.md) | number | Amount of material | | [qty](./bitburner.material.qty.md) | number | Amount of material |
| [sCost](./bitburner.material.scost.md) | string \| number | Sell cost, can be "MP+5" |
| [sell](./bitburner.material.sell.md) | number | Amount of material sold | | [sell](./bitburner.material.sell.md) | number | Amount of material sold |

13
markdown/bitburner.material.scost.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; [sCost](./bitburner.material.scost.md)
## Material.sCost property
Sell cost, can be "MP+5"
<b>Signature:</b>
```typescript
sCost: string | number;
```

3
markdown/bitburner.md
View File

@ -55,6 +55,9 @@
| [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas | | [HacknetNodesFormulas](./bitburner.hacknetnodesformulas.md) | Hacknet Node formulas |
| [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants | | [HacknetServerConstants](./bitburner.hacknetserverconstants.md) | Hacknet server related constants |
| [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas | | [HacknetServersFormulas](./bitburner.hacknetserversformulas.md) | Hacknet Server formulas |
| [Infiltration](./bitburner.infiltration.md) | Infiltration API. |
| [InfiltrationLocation](./bitburner.infiltrationlocation.md) | |
| [InfiltrationReward](./bitburner.infiltrationreward.md) | |
| [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer | | [InvestmentOffer](./bitburner.investmentoffer.md) | Corporation investment offer |
| [Material](./bitburner.material.md) | Material in a warehouse | | [Material](./bitburner.material.md) | Material in a warehouse |
| [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. | | [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. |

2
markdown/bitburner.ns.asleep.md
View File

@ -4,7 +4,7 @@
## NS.asleep() method ## NS.asleep() method
Suspends the script for n milliseconds. Doesn't block with concurrent calls. Suspends the script for n milliseconds. Doesn't block with concurrent calls. You should prefer 'sleep' over 'asleep' except when doing very complex UI work.
<b>Signature:</b> <b>Signature:</b>

34
markdown/bitburner.ns.closetail.md Normal file
View File

@ -0,0 +1,34 @@
<!-- 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; [closeTail](./bitburner.ns.closetail.md)
## NS.closeTail() method
Close the tail window of a script.
<b>Signature:</b>
```typescript
closeTail(pid?: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| pid | number | Optional. PID of the script having its tail closed. If omitted, the current script is used. |
<b>Returns:</b>
void
## Remarks
RAM cost: 0 GB
Closes a script’s logs. This is functionally the same pressing the "Close" button on the tail window.
If the function is called with no arguments, it will close the current script’s logs.
Otherwise, the pid argument can be used to close the logs from another script.

6
markdown/bitburner.ns.exec.md
View File

@ -9,7 +9,7 @@ Start another script on any server.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
exec(script: string, host: string, numThreads?: number, ...args: Array<string | number | boolean>): number; exec(script: string, host: string, numThreads?: number, ...args: (string | number | boolean)[]): number;
``` ```
## Parameters ## Parameters
@ -19,7 +19,7 @@ exec(script: string, host: string, numThreads?: number, ...args: Array<string |
| script | string | Filename of script to execute. | | script | string | Filename of script to execute. |
| host | string | Hostname of the <code>target server</code> on which to execute the script. | | host | string | Hostname of the <code>target server</code> on which to execute the script. |
| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | | numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. |
| args | Array&lt;string \| number \| boolean&gt; | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value. | | args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value. |
<b>Returns:</b> <b>Returns:</b>
@ -37,7 +37,7 @@ If the script was successfully started, then this functions returns the PID of t
PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer.
Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error. Running this function with 0 or a negative numThreads argument will cause a runtime error.
## Example 1 ## Example 1

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

@ -22,11 +22,11 @@ getGrowTime(host: string): number;
number number
Returns the amount of time in milliseconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. Returns the amount of time in milliseconds it takes to execute the grow Netscript function.
## Remarks ## Remarks
RAM cost: 0.05 GB RAM cost: 0.05 GB
Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels. The required time is increased by the security level of the target server and decreased by the player's hacking level. Returns the amount of time in milliseconds it takes to execute the grow Netscript function on the target server. The required time is increased by the security level of the target server and decreased by the player's hacking level.

6
markdown/bitburner.ns.gethacktime.md
View File

@ -22,9 +22,11 @@ getHackTime(host: string): number;
number number
Returns the amount of time in milliseconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. Returns the amount of time in milliseconds it takes to execute the hack Netscript function.
## Remarks ## Remarks
RAM cost: 0.05 GB When `hack` completes an amount of money is stolen depending on the player's skills. Returns the amount of time in milliseconds it takes to execute the hack Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels. The required time is increased by the security level of the target server and decreased by the player's hacking level. RAM cost: 0.05 GB
When `hack` completes an amount of money is stolen depending on the player's skills. Returns the amount of time in milliseconds it takes to execute the hack Netscript function on the target server. The required time is increased by the security level of the target server and decreased by the player's hacking level.

8
markdown/bitburner.ns.getrunningscript.md
View File

@ -9,7 +9,11 @@ Get general info about a running script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript | null; getRunningScript(
filename?: FilenameOrPID,
hostname?: string,
...args: (string | number | boolean)[]
): RunningScript | null;
``` ```
## Parameters ## Parameters
@ -18,7 +22,7 @@ getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string |
| --- | --- | --- | | --- | --- | --- |
| filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. | | filename | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script. |
| hostname | string | Optional. Name of host server the script is running on. | | hostname | string | Optional. Name of host server the script is running on. |
| args | (string \| number)\[\] | Arguments to identify the script | | args | (string \| number \| boolean)\[\] | Arguments to identify the script |
<b>Returns:</b> <b>Returns:</b>

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

@ -9,7 +9,7 @@ Get the exp gain of a script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getScriptExpGain(script: string, host: string, ...args: string[]): number; getScriptExpGain(script: string, host: string, ...args: (string | number | boolean)[]): number;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ getScriptExpGain(script: string, host: string, ...args: string[]): number;
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script. | | script | string | Filename of script. |
| host | string | Server on which script is running. | | host | string | Server on which script is running. |
| args | string\[\] | Arguments that the script is running with. | | args | (string \| number \| boolean)\[\] | Arguments that the script is running with. |
<b>Returns:</b> <b>Returns:</b>

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

@ -9,7 +9,7 @@ Get the income of a script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getScriptIncome(script: string, host: string, ...args: string[]): number; getScriptIncome(script: string, host: string, ...args: (string | number | boolean)[]): number;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ getScriptIncome(script: string, host: string, ...args: string[]): number;
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script. | | script | string | Filename of script. |
| host | string | Server on which script is running. | | host | string | Server on which script is running. |
| args | string\[\] | Arguments that the script is running with. | | args | (string \| number \| boolean)\[\] | Arguments that the script is running with. |
<b>Returns:</b> <b>Returns:</b>

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

@ -9,7 +9,7 @@ Get all the logs of a script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getScriptLogs(fn?: string, host?: string, ...args: any[]): string[]; getScriptLogs(fn?: string, host?: string, ...args: (string | number | boolean)[]): string[];
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ getScriptLogs(fn?: string, host?: string, ...args: any[]): string[];
| --- | --- | --- | | --- | --- | --- |
| fn | string | Optional. Filename of script to get logs from. | | fn | string | Optional. Filename of script to get logs from. |
| host | string | Optional. Hostname of the server that the script is on. | | host | string | Optional. Hostname of the server that the script is on. |
| args | any\[\] | Arguments to identify which scripts to get logs for. | | args | (string \| number \| boolean)\[\] | Arguments to identify which scripts to get logs for. |
<b>Returns:</b> <b>Returns:</b>

2
markdown/bitburner.ns.getscriptram.md
View File

@ -17,7 +17,7 @@ getScriptRam(script: string, host?: string): number;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script. This is case-sensitive. | | script | string | Filename of script. This is case-sensitive. |
| host | string | Host of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. | | host | string | Host of target server the script is located on. This is optional, if it is not specified then the function will use the current server as the target server. |
<b>Returns:</b> <b>Returns:</b>

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

@ -22,11 +22,11 @@ getWeakenTime(host: string): number;
number number
Returns the amount of time in milliseconds it takes to execute the weaken Netscript function. Returns Infinity if called on a Hacknet Server. Returns the amount of time in milliseconds it takes to execute the weaken Netscript function.
## Remarks ## Remarks
RAM cost: 0.05 GB RAM cost: 0.05 GB
Returns the amount of time in milliseconds it takes to execute the weaken Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. The required time is increased by the security level of the target server and decreased by the player's hacking level. Returns the amount of time in milliseconds it takes to execute the weaken Netscript function on the target server. The required time is increased by the security level of the target server and decreased by the player's hacking level.

13
markdown/bitburner.ns.infiltration.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; [NS](./bitburner.ns.md) &gt; [infiltration](./bitburner.ns.infiltration.md)
## NS.infiltration property
Namespace for infiltration functions. RAM cost: 0 GB
<b>Signature:</b>
```typescript
readonly infiltration: Infiltration;
```

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

@ -9,7 +9,7 @@ Check if a script is running.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean; isRunning(script: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): boolean;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ isRunning(script: FilenameOrPID, host: string, ...args: string[]): boolean;
| --- | --- | --- | | --- | --- | --- |
| script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. | | script | [FilenameOrPID](./bitburner.filenameorpid.md) | Filename or PID of script to check. This is case-sensitive. |
| host | string | Host of target server. | | host | string | Host of target server. |
| args | string\[\] | Arguments to specify/identify which scripts to search for. | | args | (string \| number \| boolean)\[\] | Arguments to specify/identify which scripts to search for. |
<b>Returns:</b> <b>Returns:</b>

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

@ -9,7 +9,7 @@ Terminate another script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
kill(script: string, host: string, ...args: string[]): boolean; kill(script: string, host: string, ...args: (string | number | boolean)[]): boolean;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ kill(script: string, host: string, ...args: string[]): boolean;
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename or pid of the script to kill | | script | string | Filename or pid of the script to kill |
| host | string | Hostname of the server on which to kill the script. | | host | string | Hostname of the server on which to kill the script. |
| args | string\[\] | Arguments to identify which script to kill. | | args | (string \| number \| boolean)\[\] | Arguments to identify which script to kill. |
<b>Returns:</b> <b>Returns:</b>

3
markdown/bitburner.ns.killall.md
View File

@ -9,7 +9,7 @@ Terminate all scripts on a server.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
killall(host?: string): boolean; killall(host?: string, safetyguard?: boolean): boolean;
``` ```
## Parameters ## Parameters
@ -17,6 +17,7 @@ killall(host?: string): boolean;
| Parameter | Type | Description | | Parameter | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| host | string | IP or hostname of the server on which to kill all scripts. | | host | string | IP or hostname of the server on which to kill all scripts. |
| safetyguard | boolean | Skips the script that calls this function |
<b>Returns:</b> <b>Returns:</b>

6
markdown/bitburner.ns.md
View File

@ -49,6 +49,7 @@ export async function main(ns) {
| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. | | [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | Namespace for gang functions. |
| [grafting](./bitburner.ns.grafting.md) | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. | | [grafting](./bitburner.ns.grafting.md) | [Grafting](./bitburner.grafting.md) | Namespace for grafting functions. |
| [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. | | [hacknet](./bitburner.ns.hacknet.md) | [Hacknet](./bitburner.hacknet.md) | Namespace for hacknet functions. |
| [infiltration](./bitburner.ns.infiltration.md) | [Infiltration](./bitburner.infiltration.md) | Namespace for infiltration functions. RAM cost: 0 GB |
| [singularity](./bitburner.ns.singularity.md) | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB | | [singularity](./bitburner.ns.singularity.md) | [Singularity](./bitburner.singularity.md) | Namespace for singularity functions. RAM cost: 0 GB |
| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. | | [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | Namespace for sleeve functions. |
| [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB | | [stanek](./bitburner.ns.stanek.md) | [Stanek](./bitburner.stanek.md) | Namespace for stanek functions. RAM cost: 0 GB |
@ -60,12 +61,13 @@ export async function main(ns) {
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [alert(msg)](./bitburner.ns.alert.md) | Open up a message box. | | [alert(msg)](./bitburner.ns.alert.md) | Open up a message box. |
| [asleep(millis)](./bitburner.ns.asleep.md) | Suspends the script for n milliseconds. Doesn't block with concurrent calls. | | [asleep(millis)](./bitburner.ns.asleep.md) | Suspends the script for n milliseconds. Doesn't block with concurrent calls. You should prefer 'sleep' over 'asleep' except when doing very complex UI work. |
| [atExit(f)](./bitburner.ns.atexit.md) | Add callback function when the script dies | | [atExit(f)](./bitburner.ns.atexit.md) | Add callback function when the script dies |
| [brutessh(host)](./bitburner.ns.brutessh.md) | Runs BruteSSH.exe on a server. | | [brutessh(host)](./bitburner.ns.brutessh.md) | Runs BruteSSH.exe on a server. |
| [clear(handle)](./bitburner.ns.clear.md) | Clear data from a file. | | [clear(handle)](./bitburner.ns.clear.md) | Clear data from a file. |
| [clearLog()](./bitburner.ns.clearlog.md) | Clears the script’s logs. | | [clearLog()](./bitburner.ns.clearlog.md) | Clears the script’s logs. |
| [clearPort(handle)](./bitburner.ns.clearport.md) | Clear data from a port. | | [clearPort(handle)](./bitburner.ns.clearport.md) | Clear data from a port. |
| [closeTail(pid)](./bitburner.ns.closetail.md) | Close the tail window of a script. |
| [deleteServer(host)](./bitburner.ns.deleteserver.md) | Delete a purchased server. | | [deleteServer(host)](./bitburner.ns.deleteserver.md) | Delete a purchased server. |
| [disableLog(fn)](./bitburner.ns.disablelog.md) | Disables logging for the given function. | | [disableLog(fn)](./bitburner.ns.disablelog.md) | Disables logging for the given function. |
| [enableLog(fn)](./bitburner.ns.enablelog.md) | Enable logging for a certain function. | | [enableLog(fn)](./bitburner.ns.enablelog.md) | Enable logging for a certain function. |
@ -127,7 +129,7 @@ export async function main(ns) {
| [isRunning(script, host, args)](./bitburner.ns.isrunning.md) | Check if a script is running. | | [isRunning(script, host, args)](./bitburner.ns.isrunning.md) | Check if a script is running. |
| [kill(script)](./bitburner.ns.kill.md) | Terminate another script. | | [kill(script)](./bitburner.ns.kill.md) | Terminate another script. |
| [kill(script, host, args)](./bitburner.ns.kill_1.md) | Terminate another script. | | [kill(script, host, args)](./bitburner.ns.kill_1.md) | Terminate another script. |
| [killall(host)](./bitburner.ns.killall.md) | Terminate all scripts on a server. | | [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. | | [ls(host, grep)](./bitburner.ns.ls.md) | List files on a server. |
| [mv(host, source, destination)](./bitburner.ns.mv.md) | Move a file on the target server. | | [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 | | [nFormat(n, format)](./bitburner.ns.nformat.md) | Format a number |

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

@ -9,7 +9,7 @@ Start another script on the current server.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
run(script: string, numThreads?: number, ...args: Array<string | number | boolean>): number; run(script: string, numThreads?: number, ...args: (string | number | boolean)[]): number;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ run(script: string, numThreads?: number, ...args: Array<string | number | boolea
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script to run. | | script | string | Filename of script to run. |
| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | | numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. |
| args | Array&lt;string \| number \| boolean&gt; | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value. | | args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value. |
<b>Returns:</b> <b>Returns:</b>

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

@ -9,7 +9,7 @@ Terminate current script and start another in 10s.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
spawn(script: string, numThreads?: number, ...args: string[]): void; spawn(script: string, numThreads?: number, ...args: (string | number | boolean)[]): void;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ spawn(script: string, numThreads?: number, ...args: string[]): void;
| --- | --- | --- | | --- | --- | --- |
| script | string | Filename of script to execute. | | script | string | Filename of script to execute. |
| numThreads | number | Number of threads to spawn new script with. Will be rounded to nearest integer. | | numThreads | number | Number of threads to spawn new script with. Will be rounded to nearest integer. |
| args | string\[\] | Additional arguments to pass into the new script that is being run. | | args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. |
<b>Returns:</b> <b>Returns:</b>

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

@ -9,7 +9,7 @@ Open the tail window of a script.
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void; tail(fn?: FilenameOrPID, host?: string, ...args: (string | number | boolean)[]): void;
``` ```
## Parameters ## Parameters
@ -18,7 +18,7 @@ tail(fn?: FilenameOrPID, host?: string, ...args: any[]): void;
| --- | --- | --- | | --- | --- | --- |
| fn | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. | | fn | [FilenameOrPID](./bitburner.filenameorpid.md) | Optional. Filename or PID of the script being tailed. If omitted, the current script is tailed. |
| host | string | Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. | | host | string | Optional. Hostname of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. |
| args | any\[\] | Arguments for the script being tailed. | | args | (string \| number \| boolean)\[\] | Arguments for the script being tailed. |
<b>Returns:</b> <b>Returns:</b>

2
markdown/bitburner.ns.tprintf.md
View File

@ -27,3 +27,5 @@ void
RAM cost: 0 GB RAM cost: 0 GB
see: https://github.com/alexei/sprintf.js

1
markdown/bitburner.reputationformulas.md
View File

@ -18,4 +18,5 @@ interface ReputationFormulas
| --- | --- | | --- | --- |
| [calculateFavorToRep(favor)](./bitburner.reputationformulas.calculatefavortorep.md) | Calculate the total required amount of faction reputation to reach a target favor. | | [calculateFavorToRep(favor)](./bitburner.reputationformulas.calculatefavortorep.md) | Calculate the total required amount of faction reputation to reach a target favor. |
| [calculateRepToFavor(rep)](./bitburner.reputationformulas.calculatereptofavor.md) | Calculate the resulting faction favor of a total amount of reputation. (Faction favor is gained whenever you install an Augmentation.) | | [calculateRepToFavor(rep)](./bitburner.reputationformulas.calculatereptofavor.md) | Calculate the resulting faction favor of a total amount of reputation. (Faction favor is gained whenever you install an Augmentation.) |
| [repFromDonation(amount, player)](./bitburner.reputationformulas.repfromdonation.md) | Calculate how much rep would be gained. |

25
markdown/bitburner.reputationformulas.repfromdonation.md Normal file
View File

@ -0,0 +1,25 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ReputationFormulas](./bitburner.reputationformulas.md) &gt; [repFromDonation](./bitburner.reputationformulas.repfromdonation.md)
## ReputationFormulas.repFromDonation() method
Calculate how much rep would be gained.
<b>Signature:</b>
```typescript
repFromDonation(amount: number, player: Player): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| amount | number | Amount of money donated |
| player | [Player](./bitburner.player.md) | Player info from [getPlayer](./bitburner.ns.getplayer.md) |
<b>Returns:</b>
number

29
markdown/bitburner.singularity.b1tflum3.md Normal file
View File

@ -0,0 +1,29 @@
<!-- 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; [b1tflum3](./bitburner.singularity.b1tflum3.md)
## Singularity.b1tflum3() method
b1t\_flum3 into a different BN.
<b>Signature:</b>
```typescript
b1tflum3(nextBN: number, callbackScript?: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| nextBN | number | BN number to jump to |
| callbackScript | string | Name of the script to launch in the next BN. |
<b>Returns:</b>
void
## Remarks
RAM cost: 16 GB \* 16/4/1

31
markdown/bitburner.singularity.destroyw0r1dd43m0n.md Normal file
View File

@ -0,0 +1,31 @@
<!-- 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; [destroyW0r1dD43m0n](./bitburner.singularity.destroyw0r1dd43m0n.md)
## Singularity.destroyW0r1dD43m0n() method
Destroy the w0r1d\_d43m0n and move on to the next BN.
<b>Signature:</b>
```typescript
destroyW0r1dD43m0n(nextBN: number, callbackScript?: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| nextBN | number | BN number to jump to |
| callbackScript | string | Name of the script to launch in the next BN. |
<b>Returns:</b>
void
## Remarks
RAM cost: 32 GB \* 16/4/1
You must have the special augment installed and the required hacking level OR Completed the final black op.

4
markdown/bitburner.singularity.getdarkwebprograms.md
View File

@ -28,7 +28,7 @@ This function allows the player to get a list of programs available for purchase
```ts ```ts
// NS1 // NS1
getDarkwebProgramsAvailable(); getDarkwebPrograms();
// returns ['BruteSSH.exe', 'FTPCrack.exe'...etc] // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc]
``` ```
@ -37,7 +37,7 @@ getDarkwebProgramsAvailable();
```ts ```ts
// NS2 // NS2
ns.getDarkwebProgramsAvailable(); ns.getDarkwebPrograms();
// returns ['BruteSSH.exe', 'FTPCrack.exe'...etc] // returns ['BruteSSH.exe', 'FTPCrack.exe'...etc]
``` ```

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

@ -26,5 +26,5 @@ void
RAM cost: 5 GB \* 16/4/1 RAM cost: 5 GB \* 16/4/1
This function will automatically install your Augmentations, resetting the game as usual. This function will automatically install your Augmentations, resetting the game as usual. If you do not own uninstalled Augmentations then the game will not reset.

3
markdown/bitburner.singularity.md
View File

@ -21,10 +21,12 @@ This API requires Source-File 4 to use. The RAM cost of all these functions is m
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. | | [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | Apply for a job at a company. |
| [b1tflum3(nextBN, callbackScript)](./bitburner.singularity.b1tflum3.md) | b1t\_flum3 into a different BN. |
| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | List all current faction invitations. | | [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | List all current faction invitations. |
| [commitCrime(crime)](./bitburner.singularity.commitcrime.md) | Commit a crime. | | [commitCrime(crime)](./bitburner.singularity.commitcrime.md) | Commit a crime. |
| [connect(hostname)](./bitburner.singularity.connect.md) | Connect to a server. | | [connect(hostname)](./bitburner.singularity.connect.md) | Connect to a server. |
| [createProgram(program, focus)](./bitburner.singularity.createprogram.md) | Create a program. | | [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. | | [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | Donate to a faction. |
| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | Get the price and reputation 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. | | [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | Get the pre-requisite of an augmentation. |
@ -60,6 +62,7 @@ This API requires Source-File 4 to use. The RAM cost of all these functions is m
| [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | Purchase an augmentation | | [purchaseAugmentation(faction, augmentation)](./bitburner.singularity.purchaseaugmentation.md) | Purchase an augmentation |
| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | Purchase a program from the dark web. | | [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | Purchase a program from the dark web. |
| [purchaseTor()](./bitburner.singularity.purchasetor.md) | Purchase the TOR router. | | [purchaseTor()](./bitburner.singularity.purchasetor.md) | Purchase the TOR router. |
| [quitJob(companyName)](./bitburner.singularity.quitjob.md) | Quit jobs by company. |
| [setFocus(focus)](./bitburner.singularity.setfocus.md) | Set the players focus. | | [setFocus(focus)](./bitburner.singularity.setfocus.md) | Set the players focus. |
| [softReset(cbScript)](./bitburner.singularity.softreset.md) | Soft reset the game. | | [softReset(cbScript)](./bitburner.singularity.softreset.md) | Soft reset the game. |
| [stopAction()](./bitburner.singularity.stopaction.md) | Stop the current action. | | [stopAction()](./bitburner.singularity.stopaction.md) | Stop the current action. |

30
markdown/bitburner.singularity.quitjob.md Normal file
View File

@ -0,0 +1,30 @@
<!-- 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; [quitJob](./bitburner.singularity.quitjob.md)
## Singularity.quitJob() method
Quit jobs by company.
<b>Signature:</b>
```typescript
quitJob(companyName?: string): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| companyName | string | Name of the company. |
<b>Returns:</b>
void
## Remarks
RAM cost: 3 GB \* 16/4/1
This function will finish work with the company provided and quit any jobs.

1
markdown/bitburner.sleeve.md
View File

@ -27,6 +27,7 @@ If you are not in BitNode-10, then you must have Source-File 10 in order to use
| [getSleeveStats(sleeveNumber)](./bitburner.sleeve.getsleevestats.md) | Get the stats of a sleeve. | | [getSleeveStats(sleeveNumber)](./bitburner.sleeve.getsleevestats.md) | Get the stats of a sleeve. |
| [getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) | Get task of a sleeve. | | [getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) | Get task of a sleeve. |
| [purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) | Purchase an aug for a sleeve. | | [purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) | Purchase an aug for a sleeve. |
| [setToBladeburnerAction(sleeveNumber, action, contract)](./bitburner.sleeve.settobladeburneraction.md) | Set a sleeve to perform bladeburner actions. |
| [setToCommitCrime(sleeveNumber, name)](./bitburner.sleeve.settocommitcrime.md) | Set a sleeve to commit crime. | | [setToCommitCrime(sleeveNumber, name)](./bitburner.sleeve.settocommitcrime.md) | Set a sleeve to commit crime. |
| [setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) | Set a sleeve to work for a company. | | [setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) | Set a sleeve to work for a company. |
| [setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) | Set a sleeve to work for a faction. | | [setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) | Set a sleeve to work for a faction. |

34
markdown/bitburner.sleeve.settobladeburneraction.md Normal file
View File

@ -0,0 +1,34 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [Sleeve](./bitburner.sleeve.md) &gt; [setToBladeburnerAction](./bitburner.sleeve.settobladeburneraction.md)
## Sleeve.setToBladeburnerAction() method
Set a sleeve to perform bladeburner actions.
<b>Signature:</b>
```typescript
setToBladeburnerAction(sleeveNumber: number, action: string, contract?: string): boolean;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| 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. |
<b>Returns:</b>
boolean
True if the sleeve started working out, false otherwise.
## Remarks
RAM cost: 4 GB
Return a boolean indicating whether or not the sleeve started working out.

13
markdown/bitburner.sleevetask.classname.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; [SleeveTask](./bitburner.sleevetask.md) &gt; [className](./bitburner.sleevetask.classname.md)
## SleeveTask.className property
Class being taken at university, if any
<b>Signature:</b>
```typescript
className: string;
```

1
markdown/bitburner.sleevetask.md
View File

@ -16,6 +16,7 @@ export interface SleeveTask
| Property | Type | Description | | Property | Type | Description |
| --- | --- | --- | | --- | --- | --- |
| [className](./bitburner.sleevetask.classname.md) | string | Class being taken at university, if any |
| [crime](./bitburner.sleevetask.crime.md) | string | Crime currently attempting, if any | | [crime](./bitburner.sleevetask.crime.md) | string | Crime currently attempting, if any |
| [factionWorkType](./bitburner.sleevetask.factionworktype.md) | string | Faction work type being performed, if any | | [factionWorkType](./bitburner.sleevetask.factionworktype.md) | string | Faction work type being performed, if any |
| [gymStatType](./bitburner.sleevetask.gymstattype.md) | string | Stat being trained at the gym, if any | | [gymStatType](./bitburner.sleevetask.gymstattype.md) | string | Stat being trained at the gym, if any |

23
markdown/bitburner.stanek.acceptgift.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; [Stanek](./bitburner.stanek.md) &gt; [acceptGift](./bitburner.stanek.acceptgift.md)
## Stanek.acceptGift() method
Accept Stanek's Gift by joining the Church of the Machine God
<b>Signature:</b>
```typescript
acceptGift(): boolean;
```
<b>Returns:</b>
boolean
true if the player is a member of the church and has the gift installed, false otherwise.
## Remarks
RAM cost: 2 GB

1
markdown/bitburner.stanek.md
View File

@ -16,6 +16,7 @@ interface Stanek
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [acceptGift()](./bitburner.stanek.acceptgift.md) | Accept Stanek's Gift by joining the Church of the Machine God |
| [activeFragments()](./bitburner.stanek.activefragments.md) | List of fragments in Stanek's Gift. | | [activeFragments()](./bitburner.stanek.activefragments.md) | List of fragments in Stanek's Gift. |
| [canPlaceFragment(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.canplacefragment.md) | Check if fragment can be placed at specified location. | | [canPlaceFragment(rootX, rootY, rotation, fragmentId)](./bitburner.stanek.canplacefragment.md) | Check if fragment can be placed at specified location. |
| [chargeFragment(rootX, rootY)](./bitburner.stanek.chargefragment.md) | Charge a fragment, increasing its power. | | [chargeFragment(rootX, rootY)](./bitburner.stanek.chargefragment.md) | Charge a fragment, increasing its power. |

21
markdown/bitburner.userinterface.clearterminal.md Normal file
View File

@ -0,0 +1,21 @@
<!-- 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; [clearTerminal](./bitburner.userinterface.clearterminal.md)
## UserInterface.clearTerminal() method
Clear the Terminal window, as if the player ran `clear` in the terminal
<b>Signature:</b>
```typescript
clearTerminal(): void;
```
<b>Returns:</b>
void
## Remarks
RAM cost: 0.2 GB

1
markdown/bitburner.userinterface.md
View File

@ -16,6 +16,7 @@ interface UserInterface
| Method | Description | | Method | Description |
| --- | --- | | --- | --- |
| [clearTerminal()](./bitburner.userinterface.clearterminal.md) | Clear the Terminal window, as if the player ran <code>clear</code> in the terminal |
| [getGameInfo()](./bitburner.userinterface.getgameinfo.md) | Gets the current game information (version, commit, ...) | | [getGameInfo()](./bitburner.userinterface.getgameinfo.md) | Gets the current game information (version, commit, ...) |
| [getStyles()](./bitburner.userinterface.getstyles.md) | Get the current styles | | [getStyles()](./bitburner.userinterface.getstyles.md) | Get the current styles |
| [getTheme()](./bitburner.userinterface.gettheme.md) | Get the current theme | | [getTheme()](./bitburner.userinterface.gettheme.md) | Get the current theme |

3
markdown/bitburner.warehouseapi.getupgradewarehousecost.md
View File

@ -9,7 +9,7 @@ Gets the cost to upgrade a warehouse to the next level
<b>Signature:</b> <b>Signature:</b>
```typescript ```typescript
getUpgradeWarehouseCost(adivisionName: any, acityName: any): number; getUpgradeWarehouseCost(adivisionName: any, acityName: any, amt?: number): number;
``` ```
## Parameters ## Parameters
@ -18,6 +18,7 @@ getUpgradeWarehouseCost(adivisionName: any, acityName: any): number;
| --- | --- | --- | | --- | --- | --- |
| adivisionName | any | | | adivisionName | any | |
| acityName | any | | | acityName | any | |
| amt | number | amount of upgrades defaults to 1 |
<b>Returns:</b> <b>Returns:</b>

27
markdown/bitburner.warehouseapi.limitmaterialproduction.md Normal file
View File

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

27
markdown/bitburner.warehouseapi.limitproductproduction.md Normal file
View File

@ -0,0 +1,27 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [WarehouseAPI](./bitburner.warehouseapi.md) &gt; [limitProductProduction](./bitburner.warehouseapi.limitproductproduction.md)
## WarehouseAPI.limitProductProduction() method
Limit Product Production.
<b>Signature:</b>
```typescript
limitProductProduction(divisionName: string, cityName: string, productName: string, qty: number): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| divisionName | string | Name of the division |
| cityName | string | Name of the city |
| productName | string | Name of the product |
| qty | number | Amount to limit to |
<b>Returns:</b>
void

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