Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-09-18 20:08:32 +02:00
Code Issues Packages Projects Releases Wiki Activity

update doc

Browse Source
This commit is contained in:
Olivier Gagnon 2022-03-17 16:50:46 -04:00
parent ed46ef319c
commit ceb2a48d9f
121 changed files with 722 additions and 234 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

281
dist/bitburner.d.ts vendored
View File

@ -15,65 +15,65 @@ export declare interface ActiveFragment {
* @public
*/
export declare interface AugmentationStats {
/** Multipler to hacking skill */
/** Multiplier to hacking skill */
hacking_mult?: number;
/** Multipler to strength skill */
/** Multiplier to strength skill */
strength_mult?: number;
/** Multipler to defense skill */
/** Multiplier to defense skill */
defense_mult?: number;
/** Multipler to dexterity skill */
/** Multiplier to dexterity skill */
dexterity_mult?: number;
/** Multipler to agility skill */
/** Multiplier to agility skill */
agility_mult?: number;
/** Multipler to charisma skill */
/** Multiplier to charisma skill */
charisma_mult?: number;
/** Multipler to hacking experience gain rate */
/** Multiplier to hacking experience gain rate */
hacking_exp_mult?: number;
/** Multipler to strength experience gain rate */
/** Multiplier to strength experience gain rate */
strength_exp_mult?: number;
/** Multipler to defense experience gain rate */
/** Multiplier to defense experience gain rate */
defense_exp_mult?: number;
/** Multipler to dexterity experience gain rate */
/** Multiplier to dexterity experience gain rate */
dexterity_exp_mult?: number;
/** Multipler to agility experience gain rate */
/** Multiplier to agility experience gain rate */
agility_exp_mult?: number;
/** Multipler to charisma experience gain rate */
/** Multiplier to charisma experience gain rate */
charisma_exp_mult?: number;
/** Multipler to chance of successfully performing a hack */
/** Multiplier to chance of successfully performing a hack */
hacking_chance_mult?: number;
/** Multipler to hacking speed */
/** Multiplier to hacking speed */
hacking_speed_mult?: number;
/** Multipler to amount of money the player gains from hacking */
/** Multiplier to amount of money the player gains from hacking */
hacking_money_mult?: number;
/** Multipler to amount of money injected into servers using grow */
/** Multiplier to amount of money injected into servers using grow */
hacking_grow_mult?: number;
/** Multipler to amount of reputation gained when working */
/** Multiplier to amount of reputation gained when working */
company_rep_mult?: number;
/** Multipler to amount of reputation gained when working */
/** Multiplier to amount of reputation gained when working */
faction_rep_mult?: number;
/** Multipler to amount of money gained from crimes */
/** Multiplier to amount of money gained from crimes */
crime_money_mult?: number;
/** Multipler to crime success rate */
/** Multiplier to crime success rate */
crime_success_mult?: number;
/** Multipler to amount of money gained from working */
/** Multiplier to amount of money gained from working */
work_money_mult?: number;
/** Multipler to amount of money produced by Hacknet Nodes */
/** Multiplier to amount of money produced by Hacknet Nodes */
hacknet_node_money_mult?: number;
/** Multipler to cost of purchasing a Hacknet Node */
/** Multiplier to cost of purchasing a Hacknet Node */
hacknet_node_purchase_cost_mult?: number;
/** Multipler to cost of ram for a Hacknet Node */
/** Multiplier to cost of ram for a Hacknet Node */
hacknet_node_ram_cost_mult?: number;
/** Multipler to cost of core for a Hacknet Node */
/** Multiplier to cost of core for a Hacknet Node */
hacknet_node_core_cost_mult?: number;
/** Multipler to cost of leveling up a Hacknet Node */
/** Multiplier to cost of leveling up a Hacknet Node */
hacknet_node_level_cost_mult?: number;
/** Multipler to Bladeburner max stamina */
/** Multiplier to Bladeburner max stamina */
bladeburner_max_stamina_mult?: number;
/** Multipler to Bladeburner stamina gain rate */
/** Multiplier to Bladeburner stamina gain rate */
bladeburner_stamina_gain_mult?: number;
/** Multipler to effectiveness in Bladeburner Field Analysis */
/** Multiplier to effectiveness in Bladeburner Field Analysis */
bladeburner_analysis_mult?: number;
/** Multipler to success chance in Bladeburner contracts/operations */
/** Multiplier to success chance in Bladeburner contracts/operations */
bladeburner_success_chance_mult?: number;
}
@ -88,6 +88,17 @@ export declare interface AugmentPair {
cost: number;
}
/**
* Used for autocompletion
* @public
*/
export declare interface AutocompleteData {
servers: string[];
scripts: string[];
txts: string[];
flags(schema: [string, string | number | boolean | string[]][]): any;
}
/**
* Options to affect the behavior of {@link NS.hack | hack}, {@link NS.grow | grow}, and {@link NS.weaken | weaken}.
* @public
@ -124,6 +135,8 @@ export declare interface BitNodeMultipliers {
CompanyWorkExpGain: number;
/** Influences how much money the player earns when completing working their job. */
CompanyWorkMoney: number;
/** Influences the money gain from dividends of corporations created by the player. */
CorporationSoftCap: number;
/** Influences the valuation of corporations created by the player. */
CorporationValuation: number;
/** Influences the base experience gained for each ability when the player commits a crime. */
@ -178,7 +191,7 @@ export declare interface BitNodeMultipliers {
ScriptHackMoneyGain: number;
/** Influences the growth percentage per cycle against a server. */
ServerGrowthRate: number;
/** Influences the maxmimum money that a server can grow to. */
/** Influences the maximum money that a server can grow to. */
ServerMaxMoney: number;
/** Influences the initial money that a server starts with. */
ServerStartingMoney: number;
@ -348,7 +361,7 @@ export declare interface Bladeburner {
*
* Note that this is meant to be used for Contracts and Operations.
* This function will return ‘Infinity’ for actions such as Training and Field Analysis.
* This function will return 1 for BlackOps not yet completed regardless of wether
* This function will return 1 for BlackOps not yet completed regardless of whether
* the player has the required rank to attempt the mission or not.
*
* @param type - Type of action.
@ -388,7 +401,7 @@ export declare interface Bladeburner {
getActionCurrentLevel(type: string, name: string): number;
/**
* Get wether an action is set to autolevel.
* Get whether an action is set to autolevel.
* @remarks
* RAM cost: 4 GB
*
@ -777,7 +790,7 @@ export declare interface CodingAttemptOptions {
*/
export declare interface CodingContract {
/**
* Attemps a coding contract.
* Attempts a coding contract.
* @remarks
* RAM cost: 10 GB
*
@ -960,14 +973,16 @@ export declare interface Corporation extends WarehouseAPI, OfficeAPI {
issueDividends(percent: number): void;
/**
* Buyback Shares
* @param amt - Number of shares to attempt to buyback.
* @param amount - Amount of shares to buy back.
*
*/
buyBackShares(amt: number): void;
buyBackShares(amount: number): void;
/**
* Sell Shares
* @param amt - Number of shares to attempt to sell.
* @param amount - Amount of shares to sell.
*
*/
sellShares(amt: number): void;
sellShares(amount: number): void;
}
/**
@ -1015,7 +1030,7 @@ export declare interface CrimeStats {
/** How much money is given */
money: number;
/** Name of crime */
name: number;
name: string;
/** Milliseconds it takes to attempt the crime */
time: number;
/** Description of the crime activity */
@ -1055,7 +1070,7 @@ export declare interface CrimeStats {
export declare interface Division {
/** Name of the division */
name: string;
/** Type of division, like Aggriculture */
/** Type of division, like Agriculture */
type: string;
/** Awareness of the division */
awareness: number;
@ -1550,42 +1565,75 @@ export declare interface GangMemberAscension {
* @public
*/
export declare interface GangMemberInfo {
/** Name of the gang member */
name: string;
/** Currently assigned task */
task: string;
earnedRespect: number;
/** Hack skill level */
hack: number;
/** Strength skill level */
str: number;
/** Defense skill level */
def: number;
/** Dexterity skill level */
dex: number;
/** Agility skill level */
agi: number;
/** Charisma skill level */
cha: number;
/** Current hack experience */
hack_exp: number;
/** Current strength experience */
str_exp: number;
/** Current defense experience */
def_exp: number;
/** Current dexterity experience */
dex_exp: number;
/** Current agility experience */
agi_exp: number;
/** Current charisma experience */
cha_exp: number;
/** Hack multiplier from equipment */
hack_mult: number;
/** Strength multiplier from equipment */
str_mult: number;
/** Defense multiplier from equipment */
def_mult: number;
/** Dexterity multiplier from equipment */
dex_mult: number;
/** Agility multiplier from equipment */
agi_mult: number;
/** Charisma multiplier from equipment */
cha_mult: number;
/** Hack multiplier from ascensions */
hack_asc_mult: number;
/** Strength multiplier from ascensions */
str_asc_mult: number;
/** Defense multiplier from ascensions */
def_asc_mult: number;
/** Dexterity multiplier from ascensions */
dex_asc_mult: number;
/** Agility multiplier from ascensions */
agi_asc_mult: number;
/** Charisma multiplier from ascensions */
cha_asc_mult: number;
/** Total earned hack experience */
hack_asc_points: number;
/** Total earned strength experience */
str_asc_points: number;
/** Total earned defense experience */
def_asc_points: number;
/** Total earned dexterity experience */
dex_asc_points: number;
/** Total earned agility experience */
agi_asc_points: number;
/** Total earned charisma experience */
cha_asc_points: number;
upgrades: string[];
@ -1640,7 +1688,7 @@ export declare interface GangTaskStats {
baseMoney: number;
/** Hacking skill impact on task scaling */
hackWeight: number;
/** Stength skill impact on task scaling */
/** Strength skill impact on task scaling */
strWeight: number;
/** Defense skill impact on task scaling */
defWeight: number;
@ -1675,6 +1723,7 @@ export declare interface GangTerritory {
export declare interface HackingFormulas {
/**
* Calculate hack chance.
* (Ex: 0.25 would indicate a 25% chance of success.)
* @param server - Server info from {@link NS.getServer | getServer}
* @param player - Player info from {@link NS.getPlayer | getPlayer}
* @returns The calculated hack chance.
@ -1691,6 +1740,7 @@ export declare interface HackingFormulas {
hackExp(server: Server, player: Player): number;
/**
* Calculate hack percent for one thread.
* (Ex: 0.25 would steal 25% of the server's current value.)
* @remarks
* Multiply by thread to get total percent hacked.
* @param server - Server info from {@link NS.getServer | getServer}
@ -1699,7 +1749,8 @@ export declare interface HackingFormulas {
*/
hackPercent(server: Server, player: Player): number;
/**
* Calculate the percent a server would grow.
* Calculate the percent a server would grow to.
* (Ex: 3.0 would would grow the server to 300% of its current value.)
* @param server - Server info from {@link NS.getServer | getServer}
* @param threads - Amount of thread.
* @param player - Player info from {@link NS.getPlayer | getPlayer}
@ -2079,7 +2130,7 @@ export declare interface Hacknet {
getHashUpgradeLevel(upgName: string): number;
/**
* Get the multipler to study.
* Get the multiplier to study.
* @remarks
* RAM cost: 0 GB
*
@ -2090,7 +2141,7 @@ export declare interface Hacknet {
getStudyMult(): number;
/**
* Get the multipler to training.
* Get the multiplier to training.
* @remarks
* RAM cost: 0 GB
*
@ -2463,7 +2514,7 @@ export declare interface NodeStats {
* ns.getHostname();
* // Some related functions are gathered under a sub-property of the ns object
* ns.stock.getPrice();
* // Some functions need to be await ed
* // Some functions need to be awaited
* await ns.hack('n00dles');
* }
* ```
@ -2565,13 +2616,11 @@ export declare interface NS extends Singularity {
* ```ts
* // NS1:
* var earnedMoney = hack("foodnstuff");
* earnedMoney = earnedMoney + hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack
* ```
* @example
* ```ts
* // NS2:
* let earnedMoney = await ns.hack("foodnstuff");
* earnedMoney += await ns.hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack
* ```
* @param host - Hostname of the target server to hack.
* @param opts - Optional parameters for configuring function behavior.
@ -2599,16 +2648,14 @@ export declare interface NS extends Singularity {
* @example
* ```ts
* // NS1:
* var availableMoney = getServerMoneyAvailable("foodnstuff");
* var currentMoney = getServerMoneyAvailable("foodnstuff");
* currentMoney = currentMoney * (1 + grow("foodnstuff"));
* currentMoney = currentMoney * (1 + grow("foodnstuff", { threads: 5 })); // Only use 5 threads to grow
* ```
* @example
* ```ts
* // NS2:
* let availableMoney = ns.getServerMoneyAvailable("foodnstuff");
* let currentMoney = ns.getServerMoneyAvailable("foodnstuff");
* currentMoney *= (1 + await ns.grow("foodnstuff"));
* currentMoney *= (1 + await ns.grow("foodnstuff", { threads: 5 })); // Only use 5 threads to grow
* ```
* @param host - Hostname of the target server to grow.
* @param opts - Optional parameters for configuring function behavior.
@ -2634,14 +2681,12 @@ export declare interface NS extends Singularity {
* // NS1:
* var currentSecurity = getServerSecurityLevel("foodnstuff");
* currentSecurity = currentSecurity - weaken("foodnstuff");
* currentSecurity = currentSecurity - weaken("foodnstuff", { threads: 5 }); // Only use 5 threads to weaken
* ```
* @example
* ```ts
* // NS2:
* let currentSecurity = ns.getServerSecurityLevel("foodnstuff");
* currentSecurity -= await ns.weaken("foodnstuff");
* currentSecurity -= await ns.weaken("foodnstuff", { threads: 5 }); // Only use 5 threads to weaken
* ```
* @param host - Hostname of the target server to weaken.
* @param opts - Optional parameters for configuring function behavior.
@ -2828,6 +2873,17 @@ export declare interface NS extends Singularity {
*/
print(...args: any[]): void;
/**
* Prints a formatted string to the script’s logs.
* @remarks
* RAM cost: 0 GB
*
* see: https://github.com/alexei/sprintf.js
* @param format - format of the message
* @param args - Value(s) to be printed.
*/
printf(format: string, ...args: any[]): void;
/**
* Prints one or more values or variables to the Terminal.
* @remarks
@ -3286,6 +3342,34 @@ export declare interface NS extends Singularity {
* @returns True if the script is successfully killed, and false otherwise.
*/
kill(script: number): boolean;
/**
* {@inheritDoc NS.(kill:1)}
* @example
* ```ts
* // NS1:
* //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments:
* kill("foo.script", "foodnstuff");
*
* //The following will try to kill a script named foo.script on the current server that was ran with no arguments:
* kill("foo.script", getHostname());
*
* //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”:
* kill("foo.script", getHostname(), 1, "foodnstuff");
* ```
* @example
* ```ts
* // NS2:
* //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments:
* ns.kill("foo.script", "foodnstuff");
*
* //The following will try to kill a script named foo.script on the current server that was ran with no arguments:
* ns.kill("foo.script", getHostname());
*
* //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”:
* ns.kill("foo.script", getHostname(), 1, "foodnstuff");
* ```
*/
kill(script: string, host: string, ...args: string[]): boolean;
/**
@ -3351,6 +3435,37 @@ export declare interface NS extends Singularity {
* @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.
*/
scp(files: string | string[], destination: string): Promise<boolean>;
/**
* {@inheritDoc NS.(scp:1)}
* @example
* ```ts
* // NS1:
* //Copies foo.lit from the helios server to the home computer:
* scp("foo.lit", "helios", "home");
*
* //Tries to copy three files from rothman-uni to home computer:
* files = ["foo1.lit", "foo2.script", "foo3.script"];
* scp(files, "rothman-uni", "home");
* ```
* @example
* ```ts
* // NS2:
* //Copies foo.lit from the helios server to the home computer:
* await ns.scp("foo.lit", "helios", "home");
*
* //Tries to copy three files from rothman-uni to home computer:
* files = ["foo1.lit", "foo2.script", "foo3.script"];
* await ns.scp(files, "rothman-uni", "home");
* ```
* @example
* ```ts
* //ns2, copies files from home to a target server
* const server = ns.args[0];
* const files = ["hack.js","weaken.js","grow.js"];
* await ns.scp(files, "home", server);
* ```
*/
scp(files: string | string[], source: string, destination: string): Promise<boolean>;
/**
@ -3377,8 +3492,8 @@ export declare interface NS extends Singularity {
* @example
* ```ts
* // NS1:
* const scripts = ps("home");
* for (let i = 0; i < scripts.length; ++i) {
* var scripts = ps("home");
* for (var i = 0; i < scripts.length; ++i) {
* tprint(scripts[i].filename + ' ' + scripts[i].threads);
* tprint(scripts[i].args);
* }
@ -3387,8 +3502,8 @@ export declare interface NS extends Singularity {
* ```ts
* // NS2:
* const ps = ns.ps("home");
* for (script of ps) {
* ns.tprint(`${script.filename} ${ps[i].threads}`);
* for (let script of ps) {
* ns.tprint(`${script.filename} ${script.threads}`);
* ns.tprint(script.args);
* }
* ```
@ -3764,7 +3879,7 @@ export declare interface NS extends Singularity {
* @param filename - Optional. Filename or PID of the script.
* @param hostname - Optional. Name of host server the script is running on.
* @param args - Arguments to identify the script
* @returns info about a running script
* @returns The info about the running script if found, and null otherwise.
*/
getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string | number)[]): RunningScript;
@ -4155,6 +4270,10 @@ export declare interface NS extends Singularity {
* @returns Amount of income the specified script generates while online.
*/
getScriptIncome(): [number, number];
/**
* {@inheritDoc NS.(getScriptIncome:1)}
*/
getScriptIncome(script: string, host: string, ...args: string[]): number;
/**
@ -4175,6 +4294,10 @@ export declare interface NS extends Singularity {
* @returns Amount of hacking experience the specified script generates while online.
*/
getScriptExpGain(): number;
/**
* {@inheritDoc NS.(getScriptExpGain:1)}
*/
getScriptExpGain(script: string, host: string, ...args: string[]): number;
/**
@ -4238,19 +4361,25 @@ export declare interface NS extends Singularity {
tFormat(milliseconds: number, milliPrecision?: boolean): string;
/**
* Prompt the player with a Yes/No modal.
* Prompt the player with an input modal.
* @remarks
* RAM cost: 0 GB
*
* Prompts the player with a dialog box with two options: “Yes” and “No”.
* This function will return true if the player click “Yes” and false if
* the player clicks “No”. The script’s execution is halted until the player
* selects one of the options.
* Prompts the player with a dialog box. If `options.type` is undefined or "boolean",
* the player is shown "Yes" and "No" prompts, which return true and false respectively.
* Passing a type of "text" will give the player a text field and a value of "select"
* will show a drop-down field. Choosing type "select" will require an array or object
* to be passed via the `options.choices` property.
* The script’s execution is halted until the player selects one of the options.
*
* @param txt - Text to appear in the prompt dialog box.
* @returns True if the player click “Yes” and false if the player clicks “No”.
* @param options - Options to modify the prompt the player is shown.
* @returns True if the player click “Yes”; false if the player clicks “No”; or the value entered by the player.
*/
prompt(txt: string): Promise<boolean>;
prompt(
txt: string,
options?: { type?: "boolean" | "text" | "select" | undefined; choices?: string[] },
): Promise<boolean | string>;
/**
* Open up a message box.
@ -4572,14 +4701,14 @@ export declare interface OfficeAPI {
/**
* Get the cost to unlock research
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param researchName - Name of the research
* @returns cost
*/
getResearchCost(divisionName: string, researchName: string): number;
/**
* Gets if you have unlocked a research
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param researchName - Name of the research
* @returns true is unlocked, false if not
*/
hasResearched(divisionName: string, researchName: string): boolean;
@ -4703,6 +4832,7 @@ export declare interface Player {
factions: string[];
tor: boolean;
hasCorporation: boolean;
inBladeburner: boolean;
}
/**
@ -4720,7 +4850,7 @@ export declare interface PlayerSkills {
dexterity: number;
/** Agility level */
agility: number;
/** Chraisma level */
/** Charisma level */
charisma: number;
/** Intelligence level */
intelligence: number;
@ -4781,9 +4911,11 @@ export declare interface RunningScript {
logs: string[];
offlineExpGained: number;
offlineMoneyMade: number;
/** Offline running time of the script, in seconds **/
offlineRunningTime: number;
onlineExpGained: number;
onlineMoneyMade: number;
/** Online running time of the script, in seconds **/
onlineRunningTime: number;
pid: number;
ramUsage: number;
@ -4993,7 +5125,7 @@ export declare interface Singularity {
*
*
* Returns a boolean indicating whether or not the player is currently performing an
* ‘action’. These actions include working for a company/faction, studying at a univeristy,
* ‘action’. These actions include working for a company/faction, studying at a university,
* working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission.
*
* @returns True if the player is currently performing an ‘action’, false otherwise.
@ -5012,9 +5144,10 @@ export declare interface Singularity {
* The actions that can be stopped with this function are:
*
* * Studying at a university
* * Working out at a gym
* * Working for a company/faction
* * Creating a program
* * Committing a Crime
* * Committing a crime
*
* This function will return true if the player’s action was ended.
* It will return false if the player was not performing an action when this function was called.
@ -6637,6 +6770,14 @@ export declare interface WarehouseAPI {
* @param enabled - smart supply enabled
*/
setSmartSupply(divisionName: string, cityName: string, enabled: boolean): void;
/**
* Set whether smart supply uses leftovers before buying
* @param divisionName - Name of the division
* @param cityName - Name of the city
* @param materialName - Name of the material
* @param enabled - smart supply use leftovers enabled
*/
setSmartSupplyUseLeftovers(divisionName: string, cityName: string, materialName: string, enabled: boolean): void;
/**
* Set material buy data
* @param divisionName - Name of the division

2
markdown/bitburner.augmentationstats.agility_exp_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.agility\_exp\_mult property
Multipler to agility experience gain rate
Multiplier to agility experience gain rate
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.agility_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.agility\_mult property
Multipler to agility skill
Multiplier to agility skill
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.bladeburner_analysis_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.bladeburner\_analysis\_mult property
Multipler to effectiveness in Bladeburner Field Analysis
Multiplier to effectiveness in Bladeburner Field Analysis
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.bladeburner_max_stamina_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.bladeburner\_max\_stamina\_mult property
Multipler to Bladeburner max stamina
Multiplier to Bladeburner max stamina
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.bladeburner_stamina_gain_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.bladeburner\_stamina\_gain\_mult property
Multipler to Bladeburner stamina gain rate
Multiplier to Bladeburner stamina gain rate
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.bladeburner_success_chance_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.bladeburner\_success\_chance\_mult property
Multipler to success chance in Bladeburner contracts/operations
Multiplier to success chance in Bladeburner contracts/operations
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.charisma_exp_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.charisma\_exp\_mult property
Multipler to charisma experience gain rate
Multiplier to charisma experience gain rate
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.charisma_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.charisma\_mult property
Multipler to charisma skill
Multiplier to charisma skill
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.company_rep_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.company\_rep\_mult property
Multipler to amount of reputation gained when working
Multiplier to amount of reputation gained when working
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.crime_money_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.crime\_money\_mult property
Multipler to amount of money gained from crimes
Multiplier to amount of money gained from crimes
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.crime_success_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.crime\_success\_mult property
Multipler to crime success rate
Multiplier to crime success rate
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.defense_exp_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.defense\_exp\_mult property
Multipler to defense experience gain rate
Multiplier to defense experience gain rate
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.defense_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.defense\_mult property
Multipler to defense skill
Multiplier to defense skill
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.dexterity_exp_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.dexterity\_exp\_mult property
Multipler to dexterity experience gain rate
Multiplier to dexterity experience gain rate
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.dexterity_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.dexterity\_mult property
Multipler to dexterity skill
Multiplier to dexterity skill
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.faction_rep_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.faction\_rep\_mult property
Multipler to amount of reputation gained when working
Multiplier to amount of reputation gained when working
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacking_chance_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacking\_chance\_mult property
Multipler to chance of successfully performing a hack
Multiplier to chance of successfully performing a hack
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacking_exp_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacking\_exp\_mult property
Multipler to hacking experience gain rate
Multiplier to hacking experience gain rate
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacking_grow_mult.md
View File

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

2
markdown/bitburner.augmentationstats.hacking_money_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacking\_money\_mult property
Multipler to amount of money the player gains from hacking
Multiplier to amount of money the player gains from hacking
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacking_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacking\_mult property
Multipler to hacking skill
Multiplier to hacking skill
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacking_speed_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacking\_speed\_mult property
Multipler to hacking speed
Multiplier to hacking speed
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacknet_node_core_cost_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacknet\_node\_core\_cost\_mult property
Multipler to cost of core for a Hacknet Node
Multiplier to cost of core for a Hacknet Node
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacknet_node_level_cost_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacknet\_node\_level\_cost\_mult property
Multipler to cost of leveling up a Hacknet Node
Multiplier to cost of leveling up a Hacknet Node
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacknet_node_money_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacknet\_node\_money\_mult property
Multipler to amount of money produced by Hacknet Nodes
Multiplier to amount of money produced by Hacknet Nodes
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacknet\_node\_purchase\_cost\_mult property
Multipler to cost of purchasing a Hacknet Node
Multiplier to cost of purchasing a Hacknet Node
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.hacknet_node_ram_cost_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.hacknet\_node\_ram\_cost\_mult property
Multipler to cost of ram for a Hacknet Node
Multiplier to cost of ram for a Hacknet Node
<b>Signature:</b>

60
markdown/bitburner.augmentationstats.md
View File

@ -16,34 +16,34 @@ export interface AugmentationStats
| Property | Type | Description |
| --- | --- | --- |
| [agility\_exp\_mult?](./bitburner.augmentationstats.agility_exp_mult.md) | number | <i>(Optional)</i> Multipler to agility experience gain rate |
| [agility\_mult?](./bitburner.augmentationstats.agility_mult.md) | number | <i>(Optional)</i> Multipler to agility skill |
| [bladeburner\_analysis\_mult?](./bitburner.augmentationstats.bladeburner_analysis_mult.md) | number | <i>(Optional)</i> Multipler to effectiveness in Bladeburner Field Analysis |
| [bladeburner\_max\_stamina\_mult?](./bitburner.augmentationstats.bladeburner_max_stamina_mult.md) | number | <i>(Optional)</i> Multipler to Bladeburner max stamina |
| [bladeburner\_stamina\_gain\_mult?](./bitburner.augmentationstats.bladeburner_stamina_gain_mult.md) | number | <i>(Optional)</i> Multipler to Bladeburner stamina gain rate |
| [bladeburner\_success\_chance\_mult?](./bitburner.augmentationstats.bladeburner_success_chance_mult.md) | number | <i>(Optional)</i> Multipler to success chance in Bladeburner contracts/operations |
| [charisma\_exp\_mult?](./bitburner.augmentationstats.charisma_exp_mult.md) | number | <i>(Optional)</i> Multipler to charisma experience gain rate |
| [charisma\_mult?](./bitburner.augmentationstats.charisma_mult.md) | number | <i>(Optional)</i> Multipler to charisma skill |
| [company\_rep\_mult?](./bitburner.augmentationstats.company_rep_mult.md) | number | <i>(Optional)</i> Multipler to amount of reputation gained when working |
| [crime\_money\_mult?](./bitburner.augmentationstats.crime_money_mult.md) | number | <i>(Optional)</i> Multipler to amount of money gained from crimes |
| [crime\_success\_mult?](./bitburner.augmentationstats.crime_success_mult.md) | number | <i>(Optional)</i> Multipler to crime success rate |
| [defense\_exp\_mult?](./bitburner.augmentationstats.defense_exp_mult.md) | number | <i>(Optional)</i> Multipler to defense experience gain rate |
| [defense\_mult?](./bitburner.augmentationstats.defense_mult.md) | number | <i>(Optional)</i> Multipler to defense skill |
| [dexterity\_exp\_mult?](./bitburner.augmentationstats.dexterity_exp_mult.md) | number | <i>(Optional)</i> Multipler to dexterity experience gain rate |
| [dexterity\_mult?](./bitburner.augmentationstats.dexterity_mult.md) | number | <i>(Optional)</i> Multipler to dexterity skill |
| [faction\_rep\_mult?](./bitburner.augmentationstats.faction_rep_mult.md) | number | <i>(Optional)</i> Multipler to amount of reputation gained when working |
| [hacking\_chance\_mult?](./bitburner.augmentationstats.hacking_chance_mult.md) | number | <i>(Optional)</i> Multipler to chance of successfully performing a hack |
| [hacking\_exp\_mult?](./bitburner.augmentationstats.hacking_exp_mult.md) | number | <i>(Optional)</i> Multipler to hacking experience gain rate |
| [hacking\_grow\_mult?](./bitburner.augmentationstats.hacking_grow_mult.md) | number | <i>(Optional)</i> Multipler to amount of money injected into servers using grow |
| [hacking\_money\_mult?](./bitburner.augmentationstats.hacking_money_mult.md) | number | <i>(Optional)</i> Multipler to amount of money the player gains from hacking |
| [hacking\_mult?](./bitburner.augmentationstats.hacking_mult.md) | number | <i>(Optional)</i> Multipler to hacking skill |
| [hacking\_speed\_mult?](./bitburner.augmentationstats.hacking_speed_mult.md) | number | <i>(Optional)</i> Multipler to hacking speed |
| [hacknet\_node\_core\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_core_cost_mult.md) | number | <i>(Optional)</i> Multipler to cost of core for a Hacknet Node |
| [hacknet\_node\_level\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_level_cost_mult.md) | number | <i>(Optional)</i> Multipler to cost of leveling up a Hacknet Node |
| [hacknet\_node\_money\_mult?](./bitburner.augmentationstats.hacknet_node_money_mult.md) | number | <i>(Optional)</i> Multipler to amount of money produced by Hacknet Nodes |
| [hacknet\_node\_purchase\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md) | number | <i>(Optional)</i> Multipler to cost of purchasing a Hacknet Node |
| [hacknet\_node\_ram\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_ram_cost_mult.md) | number | <i>(Optional)</i> Multipler to cost of ram for a Hacknet Node |
| [strength\_exp\_mult?](./bitburner.augmentationstats.strength_exp_mult.md) | number | <i>(Optional)</i> Multipler to strength experience gain rate |
| [strength\_mult?](./bitburner.augmentationstats.strength_mult.md) | number | <i>(Optional)</i> Multipler to strength skill |
| [work\_money\_mult?](./bitburner.augmentationstats.work_money_mult.md) | number | <i>(Optional)</i> Multipler to amount of money gained from working |
| [agility\_exp\_mult?](./bitburner.augmentationstats.agility_exp_mult.md) | number | <i>(Optional)</i> Multiplier to agility experience gain rate |
| [agility\_mult?](./bitburner.augmentationstats.agility_mult.md) | number | <i>(Optional)</i> Multiplier to agility skill |
| [bladeburner\_analysis\_mult?](./bitburner.augmentationstats.bladeburner_analysis_mult.md) | number | <i>(Optional)</i> Multiplier to effectiveness in Bladeburner Field Analysis |
| [bladeburner\_max\_stamina\_mult?](./bitburner.augmentationstats.bladeburner_max_stamina_mult.md) | number | <i>(Optional)</i> Multiplier to Bladeburner max stamina |
| [bladeburner\_stamina\_gain\_mult?](./bitburner.augmentationstats.bladeburner_stamina_gain_mult.md) | number | <i>(Optional)</i> Multiplier to Bladeburner stamina gain rate |
| [bladeburner\_success\_chance\_mult?](./bitburner.augmentationstats.bladeburner_success_chance_mult.md) | number | <i>(Optional)</i> Multiplier to success chance in Bladeburner contracts/operations |
| [charisma\_exp\_mult?](./bitburner.augmentationstats.charisma_exp_mult.md) | number | <i>(Optional)</i> Multiplier to charisma experience gain rate |
| [charisma\_mult?](./bitburner.augmentationstats.charisma_mult.md) | number | <i>(Optional)</i> Multiplier to charisma skill |
| [company\_rep\_mult?](./bitburner.augmentationstats.company_rep_mult.md) | number | <i>(Optional)</i> Multiplier to amount of reputation gained when working |
| [crime\_money\_mult?](./bitburner.augmentationstats.crime_money_mult.md) | number | <i>(Optional)</i> Multiplier to amount of money gained from crimes |
| [crime\_success\_mult?](./bitburner.augmentationstats.crime_success_mult.md) | number | <i>(Optional)</i> Multiplier to crime success rate |
| [defense\_exp\_mult?](./bitburner.augmentationstats.defense_exp_mult.md) | number | <i>(Optional)</i> Multiplier to defense experience gain rate |
| [defense\_mult?](./bitburner.augmentationstats.defense_mult.md) | number | <i>(Optional)</i> Multiplier to defense skill |
| [dexterity\_exp\_mult?](./bitburner.augmentationstats.dexterity_exp_mult.md) | number | <i>(Optional)</i> Multiplier to dexterity experience gain rate |
| [dexterity\_mult?](./bitburner.augmentationstats.dexterity_mult.md) | number | <i>(Optional)</i> Multiplier to dexterity skill |
| [faction\_rep\_mult?](./bitburner.augmentationstats.faction_rep_mult.md) | number | <i>(Optional)</i> Multiplier to amount of reputation gained when working |
| [hacking\_chance\_mult?](./bitburner.augmentationstats.hacking_chance_mult.md) | number | <i>(Optional)</i> Multiplier to chance of successfully performing a hack |
| [hacking\_exp\_mult?](./bitburner.augmentationstats.hacking_exp_mult.md) | number | <i>(Optional)</i> Multiplier to hacking experience gain rate |
| [hacking\_grow\_mult?](./bitburner.augmentationstats.hacking_grow_mult.md) | number | <i>(Optional)</i> Multiplier to amount of money injected into servers using grow |
| [hacking\_money\_mult?](./bitburner.augmentationstats.hacking_money_mult.md) | number | <i>(Optional)</i> Multiplier to amount of money the player gains from hacking |
| [hacking\_mult?](./bitburner.augmentationstats.hacking_mult.md) | number | <i>(Optional)</i> Multiplier to hacking skill |
| [hacking\_speed\_mult?](./bitburner.augmentationstats.hacking_speed_mult.md) | number | <i>(Optional)</i> Multiplier to hacking speed |
| [hacknet\_node\_core\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_core_cost_mult.md) | number | <i>(Optional)</i> Multiplier to cost of core for a Hacknet Node |
| [hacknet\_node\_level\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_level_cost_mult.md) | number | <i>(Optional)</i> Multiplier to cost of leveling up a Hacknet Node |
| [hacknet\_node\_money\_mult?](./bitburner.augmentationstats.hacknet_node_money_mult.md) | number | <i>(Optional)</i> Multiplier to amount of money produced by Hacknet Nodes |
| [hacknet\_node\_purchase\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md) | number | <i>(Optional)</i> Multiplier to cost of purchasing a Hacknet Node |
| [hacknet\_node\_ram\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_ram_cost_mult.md) | number | <i>(Optional)</i> Multiplier to cost of ram for a Hacknet Node |
| [strength\_exp\_mult?](./bitburner.augmentationstats.strength_exp_mult.md) | number | <i>(Optional)</i> Multiplier to strength experience gain rate |
| [strength\_mult?](./bitburner.augmentationstats.strength_mult.md) | number | <i>(Optional)</i> Multiplier to strength skill |
| [work\_money\_mult?](./bitburner.augmentationstats.work_money_mult.md) | number | <i>(Optional)</i> Multiplier to amount of money gained from working |

2
markdown/bitburner.augmentationstats.strength_exp_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.strength\_exp\_mult property
Multipler to strength experience gain rate
Multiplier to strength experience gain rate
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.strength_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.strength\_mult property
Multipler to strength skill
Multiplier to strength skill
<b>Signature:</b>

2
markdown/bitburner.augmentationstats.work_money_mult.md
View File

@ -4,7 +4,7 @@
## AugmentationStats.work\_money\_mult property
Multipler to amount of money gained from working
Multiplier to amount of money gained from working
<b>Signature:</b>

22
markdown/bitburner.autocompletedata.flags.md Normal file
View File

@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AutocompleteData](./bitburner.autocompletedata.md) &gt; [flags](./bitburner.autocompletedata.flags.md)
## AutocompleteData.flags() method
<b>Signature:</b>
```typescript
flags(schema: [string, string | number | boolean | string[]][]): any;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | |
<b>Returns:</b>
any

28
markdown/bitburner.autocompletedata.md Normal file
View File

@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [AutocompleteData](./bitburner.autocompletedata.md)
## AutocompleteData interface
Used for autocompletion
<b>Signature:</b>
```typescript
interface AutocompleteData
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [scripts](./bitburner.autocompletedata.scripts.md) | string\[\] | |
| [servers](./bitburner.autocompletedata.servers.md) | string\[\] | |
| [txts](./bitburner.autocompletedata.txts.md) | string\[\] | |
## Methods
| Method | Description |
| --- | --- |
| [flags(schema)](./bitburner.autocompletedata.flags.md) | |

11
markdown/bitburner.autocompletedata.scripts.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; [AutocompleteData](./bitburner.autocompletedata.md) &gt; [scripts](./bitburner.autocompletedata.scripts.md)
## AutocompleteData.scripts property
<b>Signature:</b>
```typescript
scripts: string[];
```

11
markdown/bitburner.autocompletedata.servers.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; [AutocompleteData](./bitburner.autocompletedata.md) &gt; [servers](./bitburner.autocompletedata.servers.md)
## AutocompleteData.servers property
<b>Signature:</b>
```typescript
servers: string[];
```

11
markdown/bitburner.autocompletedata.txts.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; [AutocompleteData](./bitburner.autocompletedata.md) &gt; [txts](./bitburner.autocompletedata.txts.md)
## AutocompleteData.txts property
<b>Signature:</b>
```typescript
txts: string[];
```

13
markdown/bitburner.bitnodemultipliers.corporationsoftcap.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; [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) &gt; [CorporationSoftCap](./bitburner.bitnodemultipliers.corporationsoftcap.md)
## BitNodeMultipliers.CorporationSoftCap property
Influences the money gain from dividends of corporations created by the player.
<b>Signature:</b>
```typescript
CorporationSoftCap: number;
```

3
markdown/bitburner.bitnodemultipliers.md
View File

@ -26,6 +26,7 @@ export interface BitNodeMultipliers
| [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) | number | Influences the amount of money gained from completing Coding Contracts |
| [CompanyWorkExpGain](./bitburner.bitnodemultipliers.companyworkexpgain.md) | number | Influences the experience gained for each ability when the player completes working their job. |
| [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md) | number | Influences how much money the player earns when completing working their job. |
| [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. |
| [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. |
@ -53,7 +54,7 @@ export interface BitNodeMultipliers
| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | number | Influences how much the money on a server can be reduced when a script performs a hack against it. |
| [ScriptHackMoneyGain](./bitburner.bitnodemultipliers.scripthackmoneygain.md) | number | Influences how much of the money stolen by a scripted hack will be added to the player's money. |
| [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | number | Influences the growth percentage per cycle against a server. |
| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | number | Influences the maxmimum money that a server can grow to. |
| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | number | Influences the maximum money that a server can grow to. |
| [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | number | Influences the initial money that a server starts with. |
| [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | number | Influences the initial security level (hackDifficulty) of a server. |
| [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | number | Influences the weaken amount per invocation against a server. |

2
markdown/bitburner.bitnodemultipliers.servermaxmoney.md
View File

@ -4,7 +4,7 @@
## BitNodeMultipliers.ServerMaxMoney property
Influences the maxmimum money that a server can grow to.
Influences the maximum money that a server can grow to.
<b>Signature:</b>

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

@ -4,7 +4,7 @@
## Bladeburner.getActionAutolevel() method
Get wether an action is set to autolevel.
Get whether an action is set to autolevel.
<b>Signature:</b>

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

@ -31,5 +31,5 @@ RAM cost: 4 GB
Returns the remaining count of the specified action.
Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.
Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of whether the player has the required rank to attempt the mission or not.

2
markdown/bitburner.bladeburner.md
View File

@ -20,7 +20,7 @@ You have to be employed in the Bladeburner division and be in BitNode-7 or have
| Method | Description |
| --- | --- |
| [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | Get wether 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. |
| [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | Get the current level of an action. |
| [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | Get estimate success chance of an action. |

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

@ -4,7 +4,7 @@
## CodingContract.attempt() method
Attemps a coding contract.
Attempts a coding contract.
<b>Signature:</b>

2
markdown/bitburner.codingcontract.md
View File

@ -16,7 +16,7 @@ export interface CodingContract
| Method | Description |
| --- | --- |
| [attempt(answer, filename, host, opts)](./bitburner.codingcontract.attempt.md) | Attemps a coding contract. |
| [attempt(answer, filename, host, opts)](./bitburner.codingcontract.attempt.md) | Attempts a coding contract. |
| [getContractType(filename, host)](./bitburner.codingcontract.getcontracttype.md) | Get the type of a coding contract. |
| [getData(filename, host)](./bitburner.codingcontract.getdata.md) | Get the input data. |
| [getDescription(filename, host)](./bitburner.codingcontract.getdescription.md) | Get the description. |

2
markdown/bitburner.crimestats.md
View File

@ -31,7 +31,7 @@ export interface CrimeStats
| [karma](./bitburner.crimestats.karma.md) | number | Amount of karma lost for successfully committing this crime |
| [kills](./bitburner.crimestats.kills.md) | number | How many people die as a result of this crime |
| [money](./bitburner.crimestats.money.md) | number | How much money is given |
| [name](./bitburner.crimestats.name.md) | number | Name of crime |
| [name](./bitburner.crimestats.name.md) | string | Name of crime |
| [strength\_exp](./bitburner.crimestats.strength_exp.md) | number | strength exp gained from crime |
| [strength\_success\_weight](./bitburner.crimestats.strength_success_weight.md) | number | strength level impact on success change of the crime |
| [time](./bitburner.crimestats.time.md) | number | Milliseconds it takes to attempt the crime |

2
markdown/bitburner.crimestats.name.md
View File

@ -9,5 +9,5 @@ Name of crime
<b>Signature:</b>
```typescript
name: number;
name: string;
```

2
markdown/bitburner.division.md
View File

@ -27,6 +27,6 @@ interface Division
| [research](./bitburner.division.research.md) | number | Amount of research in that division |
| [thisCycleExpenses](./bitburner.division.thiscycleexpenses.md) | number | Expenses this cycle |
| [thisCycleRevenue](./bitburner.division.thiscyclerevenue.md) | number | Revenue this cycle |
| [type](./bitburner.division.type.md) | string | Type of division, like Aggriculture |
| [type](./bitburner.division.type.md) | string | Type of division, like Agriculture |
| [upgrades](./bitburner.division.upgrades.md) | number\[\] | All research bought |

2
markdown/bitburner.division.type.md
View File

@ -4,7 +4,7 @@
## Division.type property
Type of division, like Aggriculture
Type of division, like Agriculture
<b>Signature:</b>

2
markdown/bitburner.gangmemberinfo.agi.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.agi property
Agility skill level
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.agi_asc_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.agi\_asc\_mult property
Agility multiplier from ascensions
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.agi_asc_points.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.agi\_asc\_points property
Total earned agility experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.agi_exp.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.agi\_exp property
Current agility experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.agi_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.agi\_mult property
Agility multiplier from equipment
<b>Signature:</b>
```typescript

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

@ -4,6 +4,8 @@
## GangMemberInfo.cha property
Charisma skill level
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.cha_asc_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.cha\_asc\_mult property
Charisma multiplier from ascensions
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.cha_asc_points.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.cha\_asc\_points property
Total earned charisma experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.cha_exp.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.cha\_exp property
Current charisma experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.cha_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.cha\_mult property
Charisma multiplier from equipment
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.def.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.def property
Defense skill level
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.def_asc_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.def\_asc\_mult property
Defense multiplier from ascensions
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.def_asc_points.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.def\_asc\_points property
Total earned defense experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.def_exp.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.def\_exp property
Current defense experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.def_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.def\_mult property
Defense multiplier from equipment
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.dex.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.dex property
Dexterity skill level
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.dex_asc_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.dex\_asc\_mult property
Dexterity multiplier from ascensions
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.dex_asc_points.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.dex\_asc\_points property
Total earned dexterity experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.dex_exp.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.dex\_exp property
Current dexterity experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.dex_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.dex\_mult property
Dexterity multiplier from equipment
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.hack.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.hack property
Hack skill level
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.hack_asc_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.hack\_asc\_mult property
Hack multiplier from ascensions
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.hack_asc_points.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.hack\_asc\_points property
Total earned hack experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.hack_exp.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.hack\_exp property
Current hack experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.hack_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.hack\_mult property
Hack multiplier from equipment
<b>Signature:</b>
```typescript

64
markdown/bitburner.gangmemberinfo.md
View File

@ -15,42 +15,42 @@ export interface GangMemberInfo
| Property | Type | Description |
| --- | --- | --- |
| [agi\_asc\_mult](./bitburner.gangmemberinfo.agi_asc_mult.md) | number | |
| [agi\_asc\_points](./bitburner.gangmemberinfo.agi_asc_points.md) | number | |
| [agi\_exp](./bitburner.gangmemberinfo.agi_exp.md) | number | |
| [agi\_mult](./bitburner.gangmemberinfo.agi_mult.md) | number | |
| [agi](./bitburner.gangmemberinfo.agi.md) | number | |
| [agi\_asc\_mult](./bitburner.gangmemberinfo.agi_asc_mult.md) | number | Agility multiplier from ascensions |
| [agi\_asc\_points](./bitburner.gangmemberinfo.agi_asc_points.md) | number | Total earned agility experience |
| [agi\_exp](./bitburner.gangmemberinfo.agi_exp.md) | number | Current agility experience |
| [agi\_mult](./bitburner.gangmemberinfo.agi_mult.md) | number | Agility multiplier from equipment |
| [agi](./bitburner.gangmemberinfo.agi.md) | number | Agility skill level |
| [augmentations](./bitburner.gangmemberinfo.augmentations.md) | string\[\] | |
| [cha\_asc\_mult](./bitburner.gangmemberinfo.cha_asc_mult.md) | number | |
| [cha\_asc\_points](./bitburner.gangmemberinfo.cha_asc_points.md) | number | |
| [cha\_exp](./bitburner.gangmemberinfo.cha_exp.md) | number | |
| [cha\_mult](./bitburner.gangmemberinfo.cha_mult.md) | number | |
| [cha](./bitburner.gangmemberinfo.cha.md) | number | |
| [def\_asc\_mult](./bitburner.gangmemberinfo.def_asc_mult.md) | number | |
| [def\_asc\_points](./bitburner.gangmemberinfo.def_asc_points.md) | number | |
| [def\_exp](./bitburner.gangmemberinfo.def_exp.md) | number | |
| [def\_mult](./bitburner.gangmemberinfo.def_mult.md) | number | |
| [def](./bitburner.gangmemberinfo.def.md) | number | |
| [dex\_asc\_mult](./bitburner.gangmemberinfo.dex_asc_mult.md) | number | |
| [dex\_asc\_points](./bitburner.gangmemberinfo.dex_asc_points.md) | number | |
| [dex\_exp](./bitburner.gangmemberinfo.dex_exp.md) | number | |
| [dex\_mult](./bitburner.gangmemberinfo.dex_mult.md) | number | |
| [dex](./bitburner.gangmemberinfo.dex.md) | number | |
| [cha\_asc\_mult](./bitburner.gangmemberinfo.cha_asc_mult.md) | number | Charisma multiplier from ascensions |
| [cha\_asc\_points](./bitburner.gangmemberinfo.cha_asc_points.md) | number | Total earned charisma experience |
| [cha\_exp](./bitburner.gangmemberinfo.cha_exp.md) | number | Current charisma experience |
| [cha\_mult](./bitburner.gangmemberinfo.cha_mult.md) | number | Charisma multiplier from equipment |
| [cha](./bitburner.gangmemberinfo.cha.md) | number | Charisma skill level |
| [def\_asc\_mult](./bitburner.gangmemberinfo.def_asc_mult.md) | number | Defense multiplier from ascensions |
| [def\_asc\_points](./bitburner.gangmemberinfo.def_asc_points.md) | number | Total earned defense experience |
| [def\_exp](./bitburner.gangmemberinfo.def_exp.md) | number | Current defense experience |
| [def\_mult](./bitburner.gangmemberinfo.def_mult.md) | number | Defense multiplier from equipment |
| [def](./bitburner.gangmemberinfo.def.md) | number | Defense skill level |
| [dex\_asc\_mult](./bitburner.gangmemberinfo.dex_asc_mult.md) | number | Dexterity multiplier from ascensions |
| [dex\_asc\_points](./bitburner.gangmemberinfo.dex_asc_points.md) | number | Total earned dexterity experience |
| [dex\_exp](./bitburner.gangmemberinfo.dex_exp.md) | number | Current dexterity experience |
| [dex\_mult](./bitburner.gangmemberinfo.dex_mult.md) | number | Dexterity multiplier from equipment |
| [dex](./bitburner.gangmemberinfo.dex.md) | number | Dexterity skill level |
| [earnedRespect](./bitburner.gangmemberinfo.earnedrespect.md) | number | |
| [hack\_asc\_mult](./bitburner.gangmemberinfo.hack_asc_mult.md) | number | |
| [hack\_asc\_points](./bitburner.gangmemberinfo.hack_asc_points.md) | number | |
| [hack\_exp](./bitburner.gangmemberinfo.hack_exp.md) | number | |
| [hack\_mult](./bitburner.gangmemberinfo.hack_mult.md) | number | |
| [hack](./bitburner.gangmemberinfo.hack.md) | number | |
| [hack\_asc\_mult](./bitburner.gangmemberinfo.hack_asc_mult.md) | number | Hack multiplier from ascensions |
| [hack\_asc\_points](./bitburner.gangmemberinfo.hack_asc_points.md) | number | Total earned hack experience |
| [hack\_exp](./bitburner.gangmemberinfo.hack_exp.md) | number | Current hack experience |
| [hack\_mult](./bitburner.gangmemberinfo.hack_mult.md) | number | Hack multiplier from equipment |
| [hack](./bitburner.gangmemberinfo.hack.md) | number | Hack skill level |
| [moneyGain](./bitburner.gangmemberinfo.moneygain.md) | number | |
| [name](./bitburner.gangmemberinfo.name.md) | string | |
| [name](./bitburner.gangmemberinfo.name.md) | string | Name of the gang member |
| [respectGain](./bitburner.gangmemberinfo.respectgain.md) | number | |
| [str\_asc\_mult](./bitburner.gangmemberinfo.str_asc_mult.md) | number | |
| [str\_asc\_points](./bitburner.gangmemberinfo.str_asc_points.md) | number | |
| [str\_exp](./bitburner.gangmemberinfo.str_exp.md) | number | |
| [str\_mult](./bitburner.gangmemberinfo.str_mult.md) | number | |
| [str](./bitburner.gangmemberinfo.str.md) | number | |
| [task](./bitburner.gangmemberinfo.task.md) | string | |
| [str\_asc\_mult](./bitburner.gangmemberinfo.str_asc_mult.md) | number | Strength multiplier from ascensions |
| [str\_asc\_points](./bitburner.gangmemberinfo.str_asc_points.md) | number | Total earned strength experience |
| [str\_exp](./bitburner.gangmemberinfo.str_exp.md) | number | Current strength experience |
| [str\_mult](./bitburner.gangmemberinfo.str_mult.md) | number | Strength multiplier from equipment |
| [str](./bitburner.gangmemberinfo.str.md) | number | Strength skill level |
| [task](./bitburner.gangmemberinfo.task.md) | string | Currently assigned task |
| [upgrades](./bitburner.gangmemberinfo.upgrades.md) | string\[\] | |
| [wantedLevelGain](./bitburner.gangmemberinfo.wantedlevelgain.md) | number | |

2
markdown/bitburner.gangmemberinfo.name.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.name property
Name of the gang member
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.str.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.str property
Strength skill level
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.str_asc_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.str\_asc\_mult property
Strength multiplier from ascensions
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.str_asc_points.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.str\_asc\_points property
Total earned strength experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.str_exp.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.str\_exp property
Current strength experience
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.str_mult.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.str\_mult property
Strength multiplier from equipment
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangmemberinfo.task.md
View File

@ -4,6 +4,8 @@
## GangMemberInfo.task property
Currently assigned task
<b>Signature:</b>
```typescript

2
markdown/bitburner.gangtaskstats.md
View File

@ -29,6 +29,6 @@ export interface GangTaskStats
| [isCombat](./bitburner.gangtaskstats.iscombat.md) | boolean | Is a task of a combat gang |
| [isHacking](./bitburner.gangtaskstats.ishacking.md) | boolean | Is a task of a hacking gang |
| [name](./bitburner.gangtaskstats.name.md) | string | Task name |
| [strWeight](./bitburner.gangtaskstats.strweight.md) | number | Stength skill impact on task scaling |
| [strWeight](./bitburner.gangtaskstats.strweight.md) | number | Strength skill impact on task scaling |
| [territory](./bitburner.gangtaskstats.territory.md) | [GangTerritory](./bitburner.gangterritory.md) | Territory impact on task scaling |

2
markdown/bitburner.gangtaskstats.strweight.md
View File

@ -4,7 +4,7 @@
## GangTaskStats.strWeight property
Stength skill impact on task scaling
Strength skill impact on task scaling
<b>Signature:</b>

2
markdown/bitburner.hackingformulas.growpercent.md
View File

@ -4,7 +4,7 @@
## HackingFormulas.growPercent() method
Calculate the percent a server would grow.
Calculate the percent a server would grow to. (Ex: 3.0 would would grow the server to 300% of its current value.)
<b>Signature:</b>

2
markdown/bitburner.hackingformulas.hackchance.md
View File

@ -4,7 +4,7 @@
## HackingFormulas.hackChance() method
Calculate hack chance.
Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.)
<b>Signature:</b>

2
markdown/bitburner.hackingformulas.hackpercent.md
View File

@ -4,7 +4,7 @@
## HackingFormulas.hackPercent() method
Calculate hack percent for one thread.
Calculate hack percent for one thread. (Ex: 0.25 would steal 25% of the server's current value.)
<b>Signature:</b>

6
markdown/bitburner.hackingformulas.md
View File

@ -16,11 +16,11 @@ interface HackingFormulas
| Method | Description |
| --- | --- |
| [growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) | Calculate the percent a server would grow. |
| [growPercent(server, threads, player, cores)](./bitburner.hackingformulas.growpercent.md) | Calculate the percent a server would grow to. (Ex: 3.0 would would grow the server to 300% of its current value.) |
| [growTime(server, player)](./bitburner.hackingformulas.growtime.md) | Calculate grow time. |
| [hackChance(server, player)](./bitburner.hackingformulas.hackchance.md) | Calculate hack chance. |
| [hackChance(server, player)](./bitburner.hackingformulas.hackchance.md) | Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.) |
| [hackExp(server, player)](./bitburner.hackingformulas.hackexp.md) | Calculate hack exp for one thread. |
| [hackPercent(server, player)](./bitburner.hackingformulas.hackpercent.md) | Calculate hack percent for one thread. |
| [hackPercent(server, player)](./bitburner.hackingformulas.hackpercent.md) | Calculate hack percent for one thread. (Ex: 0.25 would steal 25% of the server's current value.) |
| [hackTime(server, player)](./bitburner.hackingformulas.hacktime.md) | Calculate hack time. |
| [weakenTime(server, player)](./bitburner.hackingformulas.weakentime.md) | Calculate weaken time. |

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

@ -4,7 +4,7 @@
## Hacknet.getStudyMult() method
Get the multipler to study.
Get the multiplier to study.
<b>Signature:</b>

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

@ -4,7 +4,7 @@
## Hacknet.getTrainingMult() method
Get the multipler to training.
Get the multiplier to training.
<b>Signature:</b>

4
markdown/bitburner.hacknet.md
View File

@ -28,8 +28,8 @@ Not all these functions are immediately available.
| [getNodeStats(index)](./bitburner.hacknet.getnodestats.md) | Get the stats of a hacknet node. |
| [getPurchaseNodeCost()](./bitburner.hacknet.getpurchasenodecost.md) | Get the price of the next hacknet node. |
| [getRamUpgradeCost(index, n)](./bitburner.hacknet.getramupgradecost.md) | Calculate the cost of upgrading hacknet node RAM. |
| [getStudyMult()](./bitburner.hacknet.getstudymult.md) | Get the multipler to study. |
| [getTrainingMult()](./bitburner.hacknet.gettrainingmult.md) | Get the multipler to training. |
| [getStudyMult()](./bitburner.hacknet.getstudymult.md) | Get the multiplier to study. |
| [getTrainingMult()](./bitburner.hacknet.gettrainingmult.md) | Get the multiplier to training. |
| [hashCapacity()](./bitburner.hacknet.hashcapacity.md) | Get the maximum number of hashes you can store. |
| [hashCost(upgName)](./bitburner.hacknet.hashcost.md) | Get the cost of a hash upgrade. |
| [maxNumNodes()](./bitburner.hacknet.maxnumnodes.md) | Get the maximum number of hacknet nodes. |

1
markdown/bitburner.md
View File

@ -18,6 +18,7 @@
| [ActiveFragment](./bitburner.activefragment.md) | |
| [AugmentationStats](./bitburner.augmentationstats.md) | Data representing the internal values of an Augmentation. |
| [AugmentPair](./bitburner.augmentpair.md) | Return value of [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) |
| [AutocompleteData](./bitburner.autocompletedata.md) | Used for autocompletion |
| [BasicHGWOptions](./bitburner.basichgwoptions.md) | Options to affect the behavior of [hack](./bitburner.ns.hack.md)<!-- -->, [grow](./bitburner.ns.grow.md)<!-- -->, and [weaken](./bitburner.ns.weaken.md)<!-- -->. |
| [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | All multipliers affecting the difficulty of the current challenge. |
| [Bladeburner](./bitburner.bladeburner.md) | Bladeburner API |

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

@ -24,11 +24,11 @@ getRunningScript(filename?: FilenameOrPID, hostname?: string, ...args: (string |
[RunningScript](./bitburner.runningscript.md)
info about a running script
The info about the running script if found, and null otherwise.
## Remarks
RAM cost: 0.3 GB
Running with no args returns curent script. If you use a PID as the first parameter, the hostname and args parameters are unnecessary.
Running with no args returns current script. If you use a PID as the first parameter, the hostname and args parameters are unnecessary.

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

@ -4,6 +4,8 @@
## NS.getScriptExpGain() method
Get the exp gain of a script.
<b>Signature:</b>
```typescript
@ -14,11 +16,21 @@ getScriptExpGain(script: string, host: string, ...args: string[]): number;
| Parameter | Type | Description |
| --- | --- | --- |
| script | string | |
| host | string | |
| args | string\[\] | |
| script | string | Filename of script. |
| host | string | Server on which script is running. |
| args | string\[\] | Arguments that the script is running with. |
<b>Returns:</b>
number
Amount of hacking experience the specified script generates while online.
## Remarks
RAM cost: 0.1 GB
Returns the amount of hacking experience the specified script generates while online (when the game is open, does not apply for offline experience gains). Remember that a script is uniquely identified by both its name and its arguments.
This function can also return the total experience gain rate of all of your active scripts by running the function with no arguments.

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

@ -4,6 +4,8 @@
## NS.getScriptIncome() method
Get the income of a script.
<b>Signature:</b>
```typescript
@ -14,11 +16,21 @@ getScriptIncome(script: string, host: string, ...args: string[]): number;
| Parameter | Type | Description |
| --- | --- | --- |
| script | string | |
| host | string | |
| args | string\[\] | |
| script | string | Filename of script. |
| host | string | Server on which script is running. |
| args | string\[\] | Arguments that the script is running with. |
<b>Returns:</b>
number
Amount of income the specified script generates while online.
## Remarks
RAM cost: 0.1 GB
Returns the amount of income the specified script generates while online (when the game is open, does not apply for offline income). Remember that a script is uniquely identified by both its name and its arguments. So for example if you ran a script with the arguments “foodnstuff” and “5” then in order to use this function to get that script’s income you must specify those same arguments in the same order in this function call.
This function can also be called with no arguments. If called with no arguments, then this function will return an array of two values. The first value is the total income (dollar / second) of all of your active scripts (scripts that are currently running on any server). The second value is the total income (dollar / second) that you’ve earned from scripts since you last installed Augmentations.

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

@ -38,9 +38,8 @@ Like hack, `grow` can be called on any server, regardless of where the script is
```ts
// NS1:
var availableMoney = getServerMoneyAvailable("foodnstuff");
var currentMoney = getServerMoneyAvailable("foodnstuff");
currentMoney = currentMoney * (1 + grow("foodnstuff"));
currentMoney = currentMoney * (1 + grow("foodnstuff", { threads: 5 })); // Only use 5 threads to grow
```
## Example 2
@ -48,8 +47,7 @@ currentMoney = currentMoney * (1 + grow("foodnstuff", { threads: 5 })); // Only
```ts
// NS2:
let availableMoney = ns.getServerMoneyAvailable("foodnstuff");
let currentMoney = ns.getServerMoneyAvailable("foodnstuff");
currentMoney *= (1 + await ns.grow("foodnstuff"));
currentMoney *= (1 + await ns.grow("foodnstuff", { threads: 5 })); // Only use 5 threads to grow
```

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

@ -41,7 +41,6 @@ A successful `hack()` on a server will raise that server’s security level by 0
```ts
// NS1:
var earnedMoney = hack("foodnstuff");
earnedMoney = earnedMoney + hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack
```
## Example 2
@ -50,6 +49,5 @@ earnedMoney = earnedMoney + hack("foodnstuff", { threads: 5 }); // Only use 5 th
```ts
// NS2:
let earnedMoney = await ns.hack("foodnstuff");
earnedMoney += await ns.hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack
```

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

@ -4,6 +4,8 @@
## NS.kill() method
Terminate another script.
<b>Signature:</b>
```typescript
@ -14,11 +16,49 @@ kill(script: string, host: string, ...args: string[]): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| script | string | |
| host | string | |
| args | string\[\] | |
| script | string | Filename or pid of the script to kill |
| host | string | Hostname of the server on which to kill the script. |
| args | string\[\] | Arguments to identify which script to kill. |
<b>Returns:</b>
boolean
True if the script is successfully killed, and false otherwise.
## Remarks
RAM cost: 0.5 GB
Kills the script on the target server specified by the script’s name and arguments. Remember that scripts are uniquely identified by both their name and arguments. For example, if `foo.script` is run with the argument 1, then this is not the same as `foo.script` run with the argument 2, even though they have the same code.
## Example 1
```ts
// NS1:
//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments:
kill("foo.script", "foodnstuff");
//The following will try to kill a script named foo.script on the current server that was ran with no arguments:
kill("foo.script", getHostname());
//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”:
kill("foo.script", getHostname(), 1, "foodnstuff");
```
## Example 2
```ts
// NS2:
//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments:
ns.kill("foo.script", "foodnstuff");
//The following will try to kill a script named foo.script on the current server that was ran with no arguments:
ns.kill("foo.script", getHostname());
//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”:
ns.kill("foo.script", getHostname(), 1, "foodnstuff");
```

13
markdown/bitburner.ns.md
View File

@ -31,7 +31,7 @@ export async function main(ns) {
ns.getHostname();
// Some related functions are gathered under a sub-property of the ns object
ns.stock.getPrice();
// Some functions need to be await ed
// Some functions need to be awaited
await ns.hack('n00dles');
}
```
@ -89,9 +89,9 @@ export async function main(ns) {
| [getPurchasedServers()](./bitburner.ns.getpurchasedservers.md) | Returns an array with the hostnames of all of the servers you have purchased. |
| [getRunningScript(filename, hostname, args)](./bitburner.ns.getrunningscript.md) | Get general info about a running script. |
| [getScriptExpGain()](./bitburner.ns.getscriptexpgain.md) | Get the exp gain of a script. |
| [getScriptExpGain(script, host, args)](./bitburner.ns.getscriptexpgain_1.md) | |
| [getScriptExpGain(script, host, args)](./bitburner.ns.getscriptexpgain_1.md) | Get the exp gain of a script. |
| [getScriptIncome()](./bitburner.ns.getscriptincome.md) | Get the income of a script. |
| [getScriptIncome(script, host, args)](./bitburner.ns.getscriptincome_1.md) | |
| [getScriptIncome(script, host, args)](./bitburner.ns.getscriptincome_1.md) | Get the income of a script. |
| [getScriptLogs(fn, host, args)](./bitburner.ns.getscriptlogs.md) | Get all the logs of a script. |
| [getScriptName()](./bitburner.ns.getscriptname.md) | Returns the current script name. |
| [getScriptRam(script, host)](./bitburner.ns.getscriptram.md) | Get the ram cost of a script. |
@ -123,7 +123,7 @@ export async function main(ns) {
| [isLogEnabled(fn)](./bitburner.ns.islogenabled.md) | Checks the status of the logging for the given function. |
| [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, host, args)](./bitburner.ns.kill_1.md) | |
| [kill(script, host, args)](./bitburner.ns.kill_1.md) | Terminate another script. |
| [killall(host)](./bitburner.ns.killall.md) | Terminate all scripts 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. |
@ -131,7 +131,8 @@ export async function main(ns) {
| [nuke(host)](./bitburner.ns.nuke.md) | Runs NUKE.exe on a server. |
| [peek(port)](./bitburner.ns.peek.md) | Get a copy of the data from a port without popping it. |
| [print(args)](./bitburner.ns.print.md) | Prints one or move values or variables to the script’s logs. |
| [prompt(txt)](./bitburner.ns.prompt.md) | Prompt the player with a Yes/No modal. |
| [printf(format, args)](./bitburner.ns.printf.md) | Prints a formatted string to the script’s logs. |
| [prompt(txt, options)](./bitburner.ns.prompt.md) | Prompt the player with an input modal. |
| [ps(host)](./bitburner.ns.ps.md) | List running scripts on a server. |
| [purchaseServer(hostname, ram)](./bitburner.ns.purchaseserver.md) | Purchase a server. |
| [read(handle)](./bitburner.ns.read.md) | Read content of a file. |
@ -141,7 +142,7 @@ export async function main(ns) {
| [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. |
| [scan(host)](./bitburner.ns.scan.md) | Get the list of servers connected to a server. |
| [scp(files, destination)](./bitburner.ns.scp.md) | Copy file between servers. |
| [scp(files, source, destination)](./bitburner.ns.scp_1.md) | |
| [scp(files, source, destination)](./bitburner.ns.scp_1.md) | Copy file between servers. |
| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. |
| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. |
| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. |

31
markdown/bitburner.ns.printf.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; [NS](./bitburner.ns.md) &gt; [printf](./bitburner.ns.printf.md)
## NS.printf() method
Prints a formatted string to the script’s logs.
<b>Signature:</b>
```typescript
printf(format: string, ...args: any[]): void;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| format | string | format of the message |
| args | any\[\] | Value(s) to be printed. |
<b>Returns:</b>
void
## Remarks
RAM cost: 0 GB
see: https://github.com/alexei/sprintf.js

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