From ceb2a48d9f439c68516dc1d2c1282070695af7df Mon Sep 17 00:00:00 2001 From: Olivier Gagnon Date: Thu, 17 Mar 2022 16:50:46 -0400 Subject: [PATCH] update doc --- dist/bitburner.d.ts | 281 +++++++++++++----- ...rner.augmentationstats.agility_exp_mult.md | 2 +- ...itburner.augmentationstats.agility_mult.md | 2 +- ...entationstats.bladeburner_analysis_mult.md | 2 +- ...ationstats.bladeburner_max_stamina_mult.md | 2 +- ...tionstats.bladeburner_stamina_gain_mult.md | 2 +- ...onstats.bladeburner_success_chance_mult.md | 2 +- ...ner.augmentationstats.charisma_exp_mult.md | 2 +- ...tburner.augmentationstats.charisma_mult.md | 2 +- ...rner.augmentationstats.company_rep_mult.md | 2 +- ...rner.augmentationstats.crime_money_mult.md | 2 +- ...er.augmentationstats.crime_success_mult.md | 2 +- ...rner.augmentationstats.defense_exp_mult.md | 2 +- ...itburner.augmentationstats.defense_mult.md | 2 +- ...er.augmentationstats.dexterity_exp_mult.md | 2 +- ...burner.augmentationstats.dexterity_mult.md | 2 +- ...rner.augmentationstats.faction_rep_mult.md | 2 +- ...r.augmentationstats.hacking_chance_mult.md | 2 +- ...rner.augmentationstats.hacking_exp_mult.md | 2 +- ...ner.augmentationstats.hacking_grow_mult.md | 2 +- ...er.augmentationstats.hacking_money_mult.md | 2 +- ...itburner.augmentationstats.hacking_mult.md | 2 +- ...er.augmentationstats.hacking_speed_mult.md | 2 +- ...tationstats.hacknet_node_core_cost_mult.md | 2 +- ...ationstats.hacknet_node_level_cost_mult.md | 2 +- ...gmentationstats.hacknet_node_money_mult.md | 2 +- ...onstats.hacknet_node_purchase_cost_mult.md | 2 +- ...ntationstats.hacknet_node_ram_cost_mult.md | 2 +- markdown/bitburner.augmentationstats.md | 60 ++-- ...ner.augmentationstats.strength_exp_mult.md | 2 +- ...tburner.augmentationstats.strength_mult.md | 2 +- ...urner.augmentationstats.work_money_mult.md | 2 +- markdown/bitburner.autocompletedata.flags.md | 22 ++ markdown/bitburner.autocompletedata.md | 28 ++ .../bitburner.autocompletedata.scripts.md | 11 + .../bitburner.autocompletedata.servers.md | 11 + markdown/bitburner.autocompletedata.txts.md | 11 + ...r.bitnodemultipliers.corporationsoftcap.md | 13 + markdown/bitburner.bitnodemultipliers.md | 3 +- ...urner.bitnodemultipliers.servermaxmoney.md | 2 +- ...itburner.bladeburner.getactionautolevel.md | 2 +- ...ner.bladeburner.getactioncountremaining.md | 2 +- markdown/bitburner.bladeburner.md | 2 +- markdown/bitburner.codingcontract.attempt.md | 2 +- markdown/bitburner.codingcontract.md | 2 +- markdown/bitburner.crimestats.md | 2 +- markdown/bitburner.crimestats.name.md | 2 +- markdown/bitburner.division.md | 2 +- markdown/bitburner.division.type.md | 2 +- markdown/bitburner.gangmemberinfo.agi.md | 2 + .../bitburner.gangmemberinfo.agi_asc_mult.md | 2 + ...bitburner.gangmemberinfo.agi_asc_points.md | 2 + markdown/bitburner.gangmemberinfo.agi_exp.md | 2 + markdown/bitburner.gangmemberinfo.agi_mult.md | 2 + markdown/bitburner.gangmemberinfo.cha.md | 2 + .../bitburner.gangmemberinfo.cha_asc_mult.md | 2 + ...bitburner.gangmemberinfo.cha_asc_points.md | 2 + markdown/bitburner.gangmemberinfo.cha_exp.md | 2 + markdown/bitburner.gangmemberinfo.cha_mult.md | 2 + markdown/bitburner.gangmemberinfo.def.md | 2 + .../bitburner.gangmemberinfo.def_asc_mult.md | 2 + ...bitburner.gangmemberinfo.def_asc_points.md | 2 + markdown/bitburner.gangmemberinfo.def_exp.md | 2 + markdown/bitburner.gangmemberinfo.def_mult.md | 2 + markdown/bitburner.gangmemberinfo.dex.md | 2 + .../bitburner.gangmemberinfo.dex_asc_mult.md | 2 + ...bitburner.gangmemberinfo.dex_asc_points.md | 2 + markdown/bitburner.gangmemberinfo.dex_exp.md | 2 + markdown/bitburner.gangmemberinfo.dex_mult.md | 2 + markdown/bitburner.gangmemberinfo.hack.md | 2 + .../bitburner.gangmemberinfo.hack_asc_mult.md | 2 + ...itburner.gangmemberinfo.hack_asc_points.md | 2 + markdown/bitburner.gangmemberinfo.hack_exp.md | 2 + .../bitburner.gangmemberinfo.hack_mult.md | 2 + markdown/bitburner.gangmemberinfo.md | 64 ++-- markdown/bitburner.gangmemberinfo.name.md | 2 + markdown/bitburner.gangmemberinfo.str.md | 2 + .../bitburner.gangmemberinfo.str_asc_mult.md | 2 + ...bitburner.gangmemberinfo.str_asc_points.md | 2 + markdown/bitburner.gangmemberinfo.str_exp.md | 2 + markdown/bitburner.gangmemberinfo.str_mult.md | 2 + markdown/bitburner.gangmemberinfo.task.md | 2 + markdown/bitburner.gangtaskstats.md | 2 +- markdown/bitburner.gangtaskstats.strweight.md | 2 +- .../bitburner.hackingformulas.growpercent.md | 2 +- .../bitburner.hackingformulas.hackchance.md | 2 +- .../bitburner.hackingformulas.hackpercent.md | 2 +- markdown/bitburner.hackingformulas.md | 6 +- markdown/bitburner.hacknet.getstudymult.md | 2 +- markdown/bitburner.hacknet.gettrainingmult.md | 2 +- markdown/bitburner.hacknet.md | 4 +- markdown/bitburner.md | 1 + markdown/bitburner.ns.getrunningscript.md | 4 +- markdown/bitburner.ns.getscriptexpgain_1.md | 18 +- markdown/bitburner.ns.getscriptincome_1.md | 18 +- markdown/bitburner.ns.grow.md | 6 +- markdown/bitburner.ns.hack.md | 2 - markdown/bitburner.ns.kill_1.md | 46 ++- markdown/bitburner.ns.md | 13 +- markdown/bitburner.ns.printf.md | 31 ++ markdown/bitburner.ns.prompt.md | 14 +- markdown/bitburner.ns.ps.md | 6 +- markdown/bitburner.ns.scp_1.md | 52 +++- markdown/bitburner.ns.trywriteport.md | 4 +- markdown/bitburner.ns.weaken.md | 2 - .../bitburner.officeapi.getresearchcost.md | 2 +- markdown/bitburner.officeapi.hasresearched.md | 2 +- markdown/bitburner.player.inbladeburner.md | 11 + markdown/bitburner.player.md | 1 + markdown/bitburner.playerskills.charisma.md | 2 +- markdown/bitburner.playerskills.md | 2 +- markdown/bitburner.runningscript.md | 4 +- ...burner.runningscript.offlinerunningtime.md | 2 + ...tburner.runningscript.onlinerunningtime.md | 2 + markdown/bitburner.server.isconnectedto.md | 2 +- markdown/bitburner.server.md | 2 +- markdown/bitburner.singularity.isbusy.md | 2 +- markdown/bitburner.singularity.stopaction.md | 2 +- markdown/bitburner.warehouseapi.md | 2 + ...warehouseapi.setsmartsupplyuseleftovers.md | 27 ++ tsdoc-metadata.json | 2 +- 121 files changed, 722 insertions(+), 234 deletions(-) create mode 100644 markdown/bitburner.autocompletedata.flags.md create mode 100644 markdown/bitburner.autocompletedata.md create mode 100644 markdown/bitburner.autocompletedata.scripts.md create mode 100644 markdown/bitburner.autocompletedata.servers.md create mode 100644 markdown/bitburner.autocompletedata.txts.md create mode 100644 markdown/bitburner.bitnodemultipliers.corporationsoftcap.md create mode 100644 markdown/bitburner.ns.printf.md create mode 100644 markdown/bitburner.player.inbladeburner.md create mode 100644 markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index 24335cadd..384af6aa3 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -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; + + /** + * {@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; /** @@ -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; + prompt( + txt: string, + options?: { type?: "boolean" | "text" | "select" | undefined; choices?: string[] }, + ): Promise; /** * 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 diff --git a/markdown/bitburner.augmentationstats.agility_exp_mult.md b/markdown/bitburner.augmentationstats.agility_exp_mult.md index cd4fdd78b..902029643 100644 --- a/markdown/bitburner.augmentationstats.agility_exp_mult.md +++ b/markdown/bitburner.augmentationstats.agility_exp_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.agility\_exp\_mult property -Multipler to agility experience gain rate +Multiplier to agility experience gain rate Signature: diff --git a/markdown/bitburner.augmentationstats.agility_mult.md b/markdown/bitburner.augmentationstats.agility_mult.md index 295432788..49263e8c7 100644 --- a/markdown/bitburner.augmentationstats.agility_mult.md +++ b/markdown/bitburner.augmentationstats.agility_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.agility\_mult property -Multipler to agility skill +Multiplier to agility skill Signature: diff --git a/markdown/bitburner.augmentationstats.bladeburner_analysis_mult.md b/markdown/bitburner.augmentationstats.bladeburner_analysis_mult.md index 60512677e..02b1ae010 100644 --- a/markdown/bitburner.augmentationstats.bladeburner_analysis_mult.md +++ b/markdown/bitburner.augmentationstats.bladeburner_analysis_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.bladeburner\_analysis\_mult property -Multipler to effectiveness in Bladeburner Field Analysis +Multiplier to effectiveness in Bladeburner Field Analysis Signature: diff --git a/markdown/bitburner.augmentationstats.bladeburner_max_stamina_mult.md b/markdown/bitburner.augmentationstats.bladeburner_max_stamina_mult.md index 4fc39f044..c0944cdbe 100644 --- a/markdown/bitburner.augmentationstats.bladeburner_max_stamina_mult.md +++ b/markdown/bitburner.augmentationstats.bladeburner_max_stamina_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.bladeburner\_max\_stamina\_mult property -Multipler to Bladeburner max stamina +Multiplier to Bladeburner max stamina Signature: diff --git a/markdown/bitburner.augmentationstats.bladeburner_stamina_gain_mult.md b/markdown/bitburner.augmentationstats.bladeburner_stamina_gain_mult.md index 5826b004b..471dd9bdd 100644 --- a/markdown/bitburner.augmentationstats.bladeburner_stamina_gain_mult.md +++ b/markdown/bitburner.augmentationstats.bladeburner_stamina_gain_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.bladeburner\_stamina\_gain\_mult property -Multipler to Bladeburner stamina gain rate +Multiplier to Bladeburner stamina gain rate Signature: diff --git a/markdown/bitburner.augmentationstats.bladeburner_success_chance_mult.md b/markdown/bitburner.augmentationstats.bladeburner_success_chance_mult.md index 854e28643..796b11eae 100644 --- a/markdown/bitburner.augmentationstats.bladeburner_success_chance_mult.md +++ b/markdown/bitburner.augmentationstats.bladeburner_success_chance_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.charisma_exp_mult.md b/markdown/bitburner.augmentationstats.charisma_exp_mult.md index 52b9eb5ab..e8b6371f9 100644 --- a/markdown/bitburner.augmentationstats.charisma_exp_mult.md +++ b/markdown/bitburner.augmentationstats.charisma_exp_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.charisma\_exp\_mult property -Multipler to charisma experience gain rate +Multiplier to charisma experience gain rate Signature: diff --git a/markdown/bitburner.augmentationstats.charisma_mult.md b/markdown/bitburner.augmentationstats.charisma_mult.md index 19194d8b6..9ebf35b28 100644 --- a/markdown/bitburner.augmentationstats.charisma_mult.md +++ b/markdown/bitburner.augmentationstats.charisma_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.charisma\_mult property -Multipler to charisma skill +Multiplier to charisma skill Signature: diff --git a/markdown/bitburner.augmentationstats.company_rep_mult.md b/markdown/bitburner.augmentationstats.company_rep_mult.md index 4c75ae56e..f25c664a6 100644 --- a/markdown/bitburner.augmentationstats.company_rep_mult.md +++ b/markdown/bitburner.augmentationstats.company_rep_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.crime_money_mult.md b/markdown/bitburner.augmentationstats.crime_money_mult.md index 7909912ba..909133840 100644 --- a/markdown/bitburner.augmentationstats.crime_money_mult.md +++ b/markdown/bitburner.augmentationstats.crime_money_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.crime_success_mult.md b/markdown/bitburner.augmentationstats.crime_success_mult.md index d7b3215f6..92f97ac5f 100644 --- a/markdown/bitburner.augmentationstats.crime_success_mult.md +++ b/markdown/bitburner.augmentationstats.crime_success_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.crime\_success\_mult property -Multipler to crime success rate +Multiplier to crime success rate Signature: diff --git a/markdown/bitburner.augmentationstats.defense_exp_mult.md b/markdown/bitburner.augmentationstats.defense_exp_mult.md index ede435e1f..391730866 100644 --- a/markdown/bitburner.augmentationstats.defense_exp_mult.md +++ b/markdown/bitburner.augmentationstats.defense_exp_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.defense\_exp\_mult property -Multipler to defense experience gain rate +Multiplier to defense experience gain rate Signature: diff --git a/markdown/bitburner.augmentationstats.defense_mult.md b/markdown/bitburner.augmentationstats.defense_mult.md index 789554f79..fc9df05d3 100644 --- a/markdown/bitburner.augmentationstats.defense_mult.md +++ b/markdown/bitburner.augmentationstats.defense_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.defense\_mult property -Multipler to defense skill +Multiplier to defense skill Signature: diff --git a/markdown/bitburner.augmentationstats.dexterity_exp_mult.md b/markdown/bitburner.augmentationstats.dexterity_exp_mult.md index f09300982..41b07afe7 100644 --- a/markdown/bitburner.augmentationstats.dexterity_exp_mult.md +++ b/markdown/bitburner.augmentationstats.dexterity_exp_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.dexterity\_exp\_mult property -Multipler to dexterity experience gain rate +Multiplier to dexterity experience gain rate Signature: diff --git a/markdown/bitburner.augmentationstats.dexterity_mult.md b/markdown/bitburner.augmentationstats.dexterity_mult.md index 374310f1c..9cbb030c3 100644 --- a/markdown/bitburner.augmentationstats.dexterity_mult.md +++ b/markdown/bitburner.augmentationstats.dexterity_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.dexterity\_mult property -Multipler to dexterity skill +Multiplier to dexterity skill Signature: diff --git a/markdown/bitburner.augmentationstats.faction_rep_mult.md b/markdown/bitburner.augmentationstats.faction_rep_mult.md index 2bbd1121f..ed453e35f 100644 --- a/markdown/bitburner.augmentationstats.faction_rep_mult.md +++ b/markdown/bitburner.augmentationstats.faction_rep_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.hacking_chance_mult.md b/markdown/bitburner.augmentationstats.hacking_chance_mult.md index 0b3c6df42..d59ab6d47 100644 --- a/markdown/bitburner.augmentationstats.hacking_chance_mult.md +++ b/markdown/bitburner.augmentationstats.hacking_chance_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.hacking_exp_mult.md b/markdown/bitburner.augmentationstats.hacking_exp_mult.md index 4042d76cd..0965c8804 100644 --- a/markdown/bitburner.augmentationstats.hacking_exp_mult.md +++ b/markdown/bitburner.augmentationstats.hacking_exp_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.hacking\_exp\_mult property -Multipler to hacking experience gain rate +Multiplier to hacking experience gain rate Signature: diff --git a/markdown/bitburner.augmentationstats.hacking_grow_mult.md b/markdown/bitburner.augmentationstats.hacking_grow_mult.md index e0af8dbb9..9589acc66 100644 --- a/markdown/bitburner.augmentationstats.hacking_grow_mult.md +++ b/markdown/bitburner.augmentationstats.hacking_grow_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.hacking_money_mult.md b/markdown/bitburner.augmentationstats.hacking_money_mult.md index 06bbf5e49..12e033f9a 100644 --- a/markdown/bitburner.augmentationstats.hacking_money_mult.md +++ b/markdown/bitburner.augmentationstats.hacking_money_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.hacking_mult.md b/markdown/bitburner.augmentationstats.hacking_mult.md index a4e1f479b..55d89d3d4 100644 --- a/markdown/bitburner.augmentationstats.hacking_mult.md +++ b/markdown/bitburner.augmentationstats.hacking_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.hacking\_mult property -Multipler to hacking skill +Multiplier to hacking skill Signature: diff --git a/markdown/bitburner.augmentationstats.hacking_speed_mult.md b/markdown/bitburner.augmentationstats.hacking_speed_mult.md index dff7b4e98..cbf1f0a88 100644 --- a/markdown/bitburner.augmentationstats.hacking_speed_mult.md +++ b/markdown/bitburner.augmentationstats.hacking_speed_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.hacking\_speed\_mult property -Multipler to hacking speed +Multiplier to hacking speed Signature: diff --git a/markdown/bitburner.augmentationstats.hacknet_node_core_cost_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_core_cost_mult.md index f7a1b53e0..356f9110e 100644 --- a/markdown/bitburner.augmentationstats.hacknet_node_core_cost_mult.md +++ b/markdown/bitburner.augmentationstats.hacknet_node_core_cost_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.hacknet_node_level_cost_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_level_cost_mult.md index 6dc473e27..2dde1f36e 100644 --- a/markdown/bitburner.augmentationstats.hacknet_node_level_cost_mult.md +++ b/markdown/bitburner.augmentationstats.hacknet_node_level_cost_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.hacknet_node_money_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_money_mult.md index 17d754ab9..92117988b 100644 --- a/markdown/bitburner.augmentationstats.hacknet_node_money_mult.md +++ b/markdown/bitburner.augmentationstats.hacknet_node_money_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md index a5512e433..ff029e14c 100644 --- a/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md +++ b/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.hacknet_node_ram_cost_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_ram_cost_mult.md index f216ac42d..060901455 100644 --- a/markdown/bitburner.augmentationstats.hacknet_node_ram_cost_mult.md +++ b/markdown/bitburner.augmentationstats.hacknet_node_ram_cost_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.augmentationstats.md b/markdown/bitburner.augmentationstats.md index 73960ae36..62f045f72 100644 --- a/markdown/bitburner.augmentationstats.md +++ b/markdown/bitburner.augmentationstats.md @@ -16,34 +16,34 @@ export interface AugmentationStats | Property | Type | Description | | --- | --- | --- | -| [agility\_exp\_mult?](./bitburner.augmentationstats.agility_exp_mult.md) | number | (Optional) Multipler to agility experience gain rate | -| [agility\_mult?](./bitburner.augmentationstats.agility_mult.md) | number | (Optional) Multipler to agility skill | -| [bladeburner\_analysis\_mult?](./bitburner.augmentationstats.bladeburner_analysis_mult.md) | number | (Optional) Multipler to effectiveness in Bladeburner Field Analysis | -| [bladeburner\_max\_stamina\_mult?](./bitburner.augmentationstats.bladeburner_max_stamina_mult.md) | number | (Optional) Multipler to Bladeburner max stamina | -| [bladeburner\_stamina\_gain\_mult?](./bitburner.augmentationstats.bladeburner_stamina_gain_mult.md) | number | (Optional) Multipler to Bladeburner stamina gain rate | -| [bladeburner\_success\_chance\_mult?](./bitburner.augmentationstats.bladeburner_success_chance_mult.md) | number | (Optional) Multipler to success chance in Bladeburner contracts/operations | -| [charisma\_exp\_mult?](./bitburner.augmentationstats.charisma_exp_mult.md) | number | (Optional) Multipler to charisma experience gain rate | -| [charisma\_mult?](./bitburner.augmentationstats.charisma_mult.md) | number | (Optional) Multipler to charisma skill | -| [company\_rep\_mult?](./bitburner.augmentationstats.company_rep_mult.md) | number | (Optional) Multipler to amount of reputation gained when working | -| [crime\_money\_mult?](./bitburner.augmentationstats.crime_money_mult.md) | number | (Optional) Multipler to amount of money gained from crimes | -| [crime\_success\_mult?](./bitburner.augmentationstats.crime_success_mult.md) | number | (Optional) Multipler to crime success rate | -| [defense\_exp\_mult?](./bitburner.augmentationstats.defense_exp_mult.md) | number | (Optional) Multipler to defense experience gain rate | -| [defense\_mult?](./bitburner.augmentationstats.defense_mult.md) | number | (Optional) Multipler to defense skill | -| [dexterity\_exp\_mult?](./bitburner.augmentationstats.dexterity_exp_mult.md) | number | (Optional) Multipler to dexterity experience gain rate | -| [dexterity\_mult?](./bitburner.augmentationstats.dexterity_mult.md) | number | (Optional) Multipler to dexterity skill | -| [faction\_rep\_mult?](./bitburner.augmentationstats.faction_rep_mult.md) | number | (Optional) Multipler to amount of reputation gained when working | -| [hacking\_chance\_mult?](./bitburner.augmentationstats.hacking_chance_mult.md) | number | (Optional) Multipler to chance of successfully performing a hack | -| [hacking\_exp\_mult?](./bitburner.augmentationstats.hacking_exp_mult.md) | number | (Optional) Multipler to hacking experience gain rate | -| [hacking\_grow\_mult?](./bitburner.augmentationstats.hacking_grow_mult.md) | number | (Optional) Multipler to amount of money injected into servers using grow | -| [hacking\_money\_mult?](./bitburner.augmentationstats.hacking_money_mult.md) | number | (Optional) Multipler to amount of money the player gains from hacking | -| [hacking\_mult?](./bitburner.augmentationstats.hacking_mult.md) | number | (Optional) Multipler to hacking skill | -| [hacking\_speed\_mult?](./bitburner.augmentationstats.hacking_speed_mult.md) | number | (Optional) Multipler to hacking speed | -| [hacknet\_node\_core\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_core_cost_mult.md) | number | (Optional) Multipler to cost of core for a Hacknet Node | -| [hacknet\_node\_level\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_level_cost_mult.md) | number | (Optional) Multipler to cost of leveling up a Hacknet Node | -| [hacknet\_node\_money\_mult?](./bitburner.augmentationstats.hacknet_node_money_mult.md) | number | (Optional) Multipler to amount of money produced by Hacknet Nodes | -| [hacknet\_node\_purchase\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md) | number | (Optional) Multipler to cost of purchasing a Hacknet Node | -| [hacknet\_node\_ram\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_ram_cost_mult.md) | number | (Optional) Multipler to cost of ram for a Hacknet Node | -| [strength\_exp\_mult?](./bitburner.augmentationstats.strength_exp_mult.md) | number | (Optional) Multipler to strength experience gain rate | -| [strength\_mult?](./bitburner.augmentationstats.strength_mult.md) | number | (Optional) Multipler to strength skill | -| [work\_money\_mult?](./bitburner.augmentationstats.work_money_mult.md) | number | (Optional) Multipler to amount of money gained from working | +| [agility\_exp\_mult?](./bitburner.augmentationstats.agility_exp_mult.md) | number | (Optional) Multiplier to agility experience gain rate | +| [agility\_mult?](./bitburner.augmentationstats.agility_mult.md) | number | (Optional) Multiplier to agility skill | +| [bladeburner\_analysis\_mult?](./bitburner.augmentationstats.bladeburner_analysis_mult.md) | number | (Optional) Multiplier to effectiveness in Bladeburner Field Analysis | +| [bladeburner\_max\_stamina\_mult?](./bitburner.augmentationstats.bladeburner_max_stamina_mult.md) | number | (Optional) Multiplier to Bladeburner max stamina | +| [bladeburner\_stamina\_gain\_mult?](./bitburner.augmentationstats.bladeburner_stamina_gain_mult.md) | number | (Optional) Multiplier to Bladeburner stamina gain rate | +| [bladeburner\_success\_chance\_mult?](./bitburner.augmentationstats.bladeburner_success_chance_mult.md) | number | (Optional) Multiplier to success chance in Bladeburner contracts/operations | +| [charisma\_exp\_mult?](./bitburner.augmentationstats.charisma_exp_mult.md) | number | (Optional) Multiplier to charisma experience gain rate | +| [charisma\_mult?](./bitburner.augmentationstats.charisma_mult.md) | number | (Optional) Multiplier to charisma skill | +| [company\_rep\_mult?](./bitburner.augmentationstats.company_rep_mult.md) | number | (Optional) Multiplier to amount of reputation gained when working | +| [crime\_money\_mult?](./bitburner.augmentationstats.crime_money_mult.md) | number | (Optional) Multiplier to amount of money gained from crimes | +| [crime\_success\_mult?](./bitburner.augmentationstats.crime_success_mult.md) | number | (Optional) Multiplier to crime success rate | +| [defense\_exp\_mult?](./bitburner.augmentationstats.defense_exp_mult.md) | number | (Optional) Multiplier to defense experience gain rate | +| [defense\_mult?](./bitburner.augmentationstats.defense_mult.md) | number | (Optional) Multiplier to defense skill | +| [dexterity\_exp\_mult?](./bitburner.augmentationstats.dexterity_exp_mult.md) | number | (Optional) Multiplier to dexterity experience gain rate | +| [dexterity\_mult?](./bitburner.augmentationstats.dexterity_mult.md) | number | (Optional) Multiplier to dexterity skill | +| [faction\_rep\_mult?](./bitburner.augmentationstats.faction_rep_mult.md) | number | (Optional) Multiplier to amount of reputation gained when working | +| [hacking\_chance\_mult?](./bitburner.augmentationstats.hacking_chance_mult.md) | number | (Optional) Multiplier to chance of successfully performing a hack | +| [hacking\_exp\_mult?](./bitburner.augmentationstats.hacking_exp_mult.md) | number | (Optional) Multiplier to hacking experience gain rate | +| [hacking\_grow\_mult?](./bitburner.augmentationstats.hacking_grow_mult.md) | number | (Optional) Multiplier to amount of money injected into servers using grow | +| [hacking\_money\_mult?](./bitburner.augmentationstats.hacking_money_mult.md) | number | (Optional) Multiplier to amount of money the player gains from hacking | +| [hacking\_mult?](./bitburner.augmentationstats.hacking_mult.md) | number | (Optional) Multiplier to hacking skill | +| [hacking\_speed\_mult?](./bitburner.augmentationstats.hacking_speed_mult.md) | number | (Optional) Multiplier to hacking speed | +| [hacknet\_node\_core\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_core_cost_mult.md) | number | (Optional) Multiplier to cost of core for a Hacknet Node | +| [hacknet\_node\_level\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_level_cost_mult.md) | number | (Optional) Multiplier to cost of leveling up a Hacknet Node | +| [hacknet\_node\_money\_mult?](./bitburner.augmentationstats.hacknet_node_money_mult.md) | number | (Optional) Multiplier to amount of money produced by Hacknet Nodes | +| [hacknet\_node\_purchase\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md) | number | (Optional) Multiplier to cost of purchasing a Hacknet Node | +| [hacknet\_node\_ram\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_ram_cost_mult.md) | number | (Optional) Multiplier to cost of ram for a Hacknet Node | +| [strength\_exp\_mult?](./bitburner.augmentationstats.strength_exp_mult.md) | number | (Optional) Multiplier to strength experience gain rate | +| [strength\_mult?](./bitburner.augmentationstats.strength_mult.md) | number | (Optional) Multiplier to strength skill | +| [work\_money\_mult?](./bitburner.augmentationstats.work_money_mult.md) | number | (Optional) Multiplier to amount of money gained from working | diff --git a/markdown/bitburner.augmentationstats.strength_exp_mult.md b/markdown/bitburner.augmentationstats.strength_exp_mult.md index 1a592c8be..c7d2c9aa9 100644 --- a/markdown/bitburner.augmentationstats.strength_exp_mult.md +++ b/markdown/bitburner.augmentationstats.strength_exp_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.strength\_exp\_mult property -Multipler to strength experience gain rate +Multiplier to strength experience gain rate Signature: diff --git a/markdown/bitburner.augmentationstats.strength_mult.md b/markdown/bitburner.augmentationstats.strength_mult.md index 5bcd49885..3883debb1 100644 --- a/markdown/bitburner.augmentationstats.strength_mult.md +++ b/markdown/bitburner.augmentationstats.strength_mult.md @@ -4,7 +4,7 @@ ## AugmentationStats.strength\_mult property -Multipler to strength skill +Multiplier to strength skill Signature: diff --git a/markdown/bitburner.augmentationstats.work_money_mult.md b/markdown/bitburner.augmentationstats.work_money_mult.md index 557f491d8..154a5facc 100644 --- a/markdown/bitburner.augmentationstats.work_money_mult.md +++ b/markdown/bitburner.augmentationstats.work_money_mult.md @@ -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 Signature: diff --git a/markdown/bitburner.autocompletedata.flags.md b/markdown/bitburner.autocompletedata.flags.md new file mode 100644 index 000000000..e7482ceec --- /dev/null +++ b/markdown/bitburner.autocompletedata.flags.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) > [flags](./bitburner.autocompletedata.flags.md) + +## AutocompleteData.flags() method + +Signature: + +```typescript +flags(schema: [string, string | number | boolean | string[]][]): any; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| schema | \[string, string \| number \| boolean \| string\[\]\]\[\] | | + +Returns: + +any + diff --git a/markdown/bitburner.autocompletedata.md b/markdown/bitburner.autocompletedata.md new file mode 100644 index 000000000..459b3c07a --- /dev/null +++ b/markdown/bitburner.autocompletedata.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) + +## AutocompleteData interface + +Used for autocompletion + +Signature: + +```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) | | + diff --git a/markdown/bitburner.autocompletedata.scripts.md b/markdown/bitburner.autocompletedata.scripts.md new file mode 100644 index 000000000..a61e16e63 --- /dev/null +++ b/markdown/bitburner.autocompletedata.scripts.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) > [scripts](./bitburner.autocompletedata.scripts.md) + +## AutocompleteData.scripts property + +Signature: + +```typescript +scripts: string[]; +``` diff --git a/markdown/bitburner.autocompletedata.servers.md b/markdown/bitburner.autocompletedata.servers.md new file mode 100644 index 000000000..c54df9876 --- /dev/null +++ b/markdown/bitburner.autocompletedata.servers.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) > [servers](./bitburner.autocompletedata.servers.md) + +## AutocompleteData.servers property + +Signature: + +```typescript +servers: string[]; +``` diff --git a/markdown/bitburner.autocompletedata.txts.md b/markdown/bitburner.autocompletedata.txts.md new file mode 100644 index 000000000..0b8d0776d --- /dev/null +++ b/markdown/bitburner.autocompletedata.txts.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AutocompleteData](./bitburner.autocompletedata.md) > [txts](./bitburner.autocompletedata.txts.md) + +## AutocompleteData.txts property + +Signature: + +```typescript +txts: string[]; +``` diff --git a/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md b/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md new file mode 100644 index 000000000..930c02c35 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.corporationsoftcap.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CorporationSoftCap](./bitburner.bitnodemultipliers.corporationsoftcap.md) + +## BitNodeMultipliers.CorporationSoftCap property + +Influences the money gain from dividends of corporations created by the player. + +Signature: + +```typescript +CorporationSoftCap: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.md b/markdown/bitburner.bitnodemultipliers.md index a0ca556bf..f5ad7ee9f 100644 --- a/markdown/bitburner.bitnodemultipliers.md +++ b/markdown/bitburner.bitnodemultipliers.md @@ -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. | diff --git a/markdown/bitburner.bitnodemultipliers.servermaxmoney.md b/markdown/bitburner.bitnodemultipliers.servermaxmoney.md index 5a8c3d3eb..103d38bf7 100644 --- a/markdown/bitburner.bitnodemultipliers.servermaxmoney.md +++ b/markdown/bitburner.bitnodemultipliers.servermaxmoney.md @@ -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. Signature: diff --git a/markdown/bitburner.bladeburner.getactionautolevel.md b/markdown/bitburner.bladeburner.getactionautolevel.md index 85993e578..c9e7175e0 100644 --- a/markdown/bitburner.bladeburner.getactionautolevel.md +++ b/markdown/bitburner.bladeburner.getactionautolevel.md @@ -4,7 +4,7 @@ ## Bladeburner.getActionAutolevel() method -Get wether an action is set to autolevel. +Get whether an action is set to autolevel. Signature: diff --git a/markdown/bitburner.bladeburner.getactioncountremaining.md b/markdown/bitburner.bladeburner.getactioncountremaining.md index 500261c12..5ceebf6f8 100644 --- a/markdown/bitburner.bladeburner.getactioncountremaining.md +++ b/markdown/bitburner.bladeburner.getactioncountremaining.md @@ -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. diff --git a/markdown/bitburner.bladeburner.md b/markdown/bitburner.bladeburner.md index ea10612cc..213ffef11 100644 --- a/markdown/bitburner.bladeburner.md +++ b/markdown/bitburner.bladeburner.md @@ -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. | diff --git a/markdown/bitburner.codingcontract.attempt.md b/markdown/bitburner.codingcontract.attempt.md index 3957bc031..789e28b92 100644 --- a/markdown/bitburner.codingcontract.attempt.md +++ b/markdown/bitburner.codingcontract.attempt.md @@ -4,7 +4,7 @@ ## CodingContract.attempt() method -Attemps a coding contract. +Attempts a coding contract. Signature: diff --git a/markdown/bitburner.codingcontract.md b/markdown/bitburner.codingcontract.md index dbfddc66a..620029744 100644 --- a/markdown/bitburner.codingcontract.md +++ b/markdown/bitburner.codingcontract.md @@ -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. | diff --git a/markdown/bitburner.crimestats.md b/markdown/bitburner.crimestats.md index e397c52f2..ea96891d0 100644 --- a/markdown/bitburner.crimestats.md +++ b/markdown/bitburner.crimestats.md @@ -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 | diff --git a/markdown/bitburner.crimestats.name.md b/markdown/bitburner.crimestats.name.md index 927337120..0746c5756 100644 --- a/markdown/bitburner.crimestats.name.md +++ b/markdown/bitburner.crimestats.name.md @@ -9,5 +9,5 @@ Name of crime Signature: ```typescript -name: number; +name: string; ``` diff --git a/markdown/bitburner.division.md b/markdown/bitburner.division.md index dafc74bbe..9893266ed 100644 --- a/markdown/bitburner.division.md +++ b/markdown/bitburner.division.md @@ -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 | diff --git a/markdown/bitburner.division.type.md b/markdown/bitburner.division.type.md index 2b8a4dabc..30b7a7c79 100644 --- a/markdown/bitburner.division.type.md +++ b/markdown/bitburner.division.type.md @@ -4,7 +4,7 @@ ## Division.type property -Type of division, like Aggriculture +Type of division, like Agriculture Signature: diff --git a/markdown/bitburner.gangmemberinfo.agi.md b/markdown/bitburner.gangmemberinfo.agi.md index 262c16e41..90deb5f11 100644 --- a/markdown/bitburner.gangmemberinfo.agi.md +++ b/markdown/bitburner.gangmemberinfo.agi.md @@ -4,6 +4,8 @@ ## GangMemberInfo.agi property +Agility skill level + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.agi_asc_mult.md b/markdown/bitburner.gangmemberinfo.agi_asc_mult.md index 922619716..d3c2b2451 100644 --- a/markdown/bitburner.gangmemberinfo.agi_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.agi_asc_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.agi\_asc\_mult property +Agility multiplier from ascensions + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.agi_asc_points.md b/markdown/bitburner.gangmemberinfo.agi_asc_points.md index bbdfb9e23..d1c3d5d8b 100644 --- a/markdown/bitburner.gangmemberinfo.agi_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.agi_asc_points.md @@ -4,6 +4,8 @@ ## GangMemberInfo.agi\_asc\_points property +Total earned agility experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.agi_exp.md b/markdown/bitburner.gangmemberinfo.agi_exp.md index 6ee69a6ed..c5e9be1e0 100644 --- a/markdown/bitburner.gangmemberinfo.agi_exp.md +++ b/markdown/bitburner.gangmemberinfo.agi_exp.md @@ -4,6 +4,8 @@ ## GangMemberInfo.agi\_exp property +Current agility experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.agi_mult.md b/markdown/bitburner.gangmemberinfo.agi_mult.md index ce9db9a1a..f44c859f0 100644 --- a/markdown/bitburner.gangmemberinfo.agi_mult.md +++ b/markdown/bitburner.gangmemberinfo.agi_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.agi\_mult property +Agility multiplier from equipment + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.cha.md b/markdown/bitburner.gangmemberinfo.cha.md index 899bec1c2..1f1ef5676 100644 --- a/markdown/bitburner.gangmemberinfo.cha.md +++ b/markdown/bitburner.gangmemberinfo.cha.md @@ -4,6 +4,8 @@ ## GangMemberInfo.cha property +Charisma skill level + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.cha_asc_mult.md b/markdown/bitburner.gangmemberinfo.cha_asc_mult.md index 24f21690d..fffb9ccbd 100644 --- a/markdown/bitburner.gangmemberinfo.cha_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.cha_asc_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.cha\_asc\_mult property +Charisma multiplier from ascensions + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.cha_asc_points.md b/markdown/bitburner.gangmemberinfo.cha_asc_points.md index d7a97212b..79a736e04 100644 --- a/markdown/bitburner.gangmemberinfo.cha_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.cha_asc_points.md @@ -4,6 +4,8 @@ ## GangMemberInfo.cha\_asc\_points property +Total earned charisma experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.cha_exp.md b/markdown/bitburner.gangmemberinfo.cha_exp.md index d85aeef65..77f6e0829 100644 --- a/markdown/bitburner.gangmemberinfo.cha_exp.md +++ b/markdown/bitburner.gangmemberinfo.cha_exp.md @@ -4,6 +4,8 @@ ## GangMemberInfo.cha\_exp property +Current charisma experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.cha_mult.md b/markdown/bitburner.gangmemberinfo.cha_mult.md index 3af81cac6..fc68dffbc 100644 --- a/markdown/bitburner.gangmemberinfo.cha_mult.md +++ b/markdown/bitburner.gangmemberinfo.cha_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.cha\_mult property +Charisma multiplier from equipment + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.def.md b/markdown/bitburner.gangmemberinfo.def.md index 86fdfc9ae..e4b278562 100644 --- a/markdown/bitburner.gangmemberinfo.def.md +++ b/markdown/bitburner.gangmemberinfo.def.md @@ -4,6 +4,8 @@ ## GangMemberInfo.def property +Defense skill level + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.def_asc_mult.md b/markdown/bitburner.gangmemberinfo.def_asc_mult.md index 57f933f91..d21d98510 100644 --- a/markdown/bitburner.gangmemberinfo.def_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.def_asc_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.def\_asc\_mult property +Defense multiplier from ascensions + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.def_asc_points.md b/markdown/bitburner.gangmemberinfo.def_asc_points.md index cad1ca3ab..bcd5d4fe2 100644 --- a/markdown/bitburner.gangmemberinfo.def_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.def_asc_points.md @@ -4,6 +4,8 @@ ## GangMemberInfo.def\_asc\_points property +Total earned defense experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.def_exp.md b/markdown/bitburner.gangmemberinfo.def_exp.md index 74baa1c2e..5910078a4 100644 --- a/markdown/bitburner.gangmemberinfo.def_exp.md +++ b/markdown/bitburner.gangmemberinfo.def_exp.md @@ -4,6 +4,8 @@ ## GangMemberInfo.def\_exp property +Current defense experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.def_mult.md b/markdown/bitburner.gangmemberinfo.def_mult.md index 1ae2796b0..82799b327 100644 --- a/markdown/bitburner.gangmemberinfo.def_mult.md +++ b/markdown/bitburner.gangmemberinfo.def_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.def\_mult property +Defense multiplier from equipment + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.dex.md b/markdown/bitburner.gangmemberinfo.dex.md index 8534a9bc1..e610fadab 100644 --- a/markdown/bitburner.gangmemberinfo.dex.md +++ b/markdown/bitburner.gangmemberinfo.dex.md @@ -4,6 +4,8 @@ ## GangMemberInfo.dex property +Dexterity skill level + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.dex_asc_mult.md b/markdown/bitburner.gangmemberinfo.dex_asc_mult.md index 839ba3277..79c2d80e6 100644 --- a/markdown/bitburner.gangmemberinfo.dex_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.dex_asc_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.dex\_asc\_mult property +Dexterity multiplier from ascensions + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.dex_asc_points.md b/markdown/bitburner.gangmemberinfo.dex_asc_points.md index a1b4f4087..d66448989 100644 --- a/markdown/bitburner.gangmemberinfo.dex_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.dex_asc_points.md @@ -4,6 +4,8 @@ ## GangMemberInfo.dex\_asc\_points property +Total earned dexterity experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.dex_exp.md b/markdown/bitburner.gangmemberinfo.dex_exp.md index 2ba0bb191..ee7dafe70 100644 --- a/markdown/bitburner.gangmemberinfo.dex_exp.md +++ b/markdown/bitburner.gangmemberinfo.dex_exp.md @@ -4,6 +4,8 @@ ## GangMemberInfo.dex\_exp property +Current dexterity experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.dex_mult.md b/markdown/bitburner.gangmemberinfo.dex_mult.md index b8ce8318b..4cdf259b0 100644 --- a/markdown/bitburner.gangmemberinfo.dex_mult.md +++ b/markdown/bitburner.gangmemberinfo.dex_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.dex\_mult property +Dexterity multiplier from equipment + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.hack.md b/markdown/bitburner.gangmemberinfo.hack.md index e333d1492..8e133a4dc 100644 --- a/markdown/bitburner.gangmemberinfo.hack.md +++ b/markdown/bitburner.gangmemberinfo.hack.md @@ -4,6 +4,8 @@ ## GangMemberInfo.hack property +Hack skill level + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.hack_asc_mult.md b/markdown/bitburner.gangmemberinfo.hack_asc_mult.md index 13a2fdc43..bc554e6bc 100644 --- a/markdown/bitburner.gangmemberinfo.hack_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.hack_asc_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.hack\_asc\_mult property +Hack multiplier from ascensions + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.hack_asc_points.md b/markdown/bitburner.gangmemberinfo.hack_asc_points.md index d7ab24128..1c825d553 100644 --- a/markdown/bitburner.gangmemberinfo.hack_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.hack_asc_points.md @@ -4,6 +4,8 @@ ## GangMemberInfo.hack\_asc\_points property +Total earned hack experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.hack_exp.md b/markdown/bitburner.gangmemberinfo.hack_exp.md index 2a473c9b8..b8ec2236b 100644 --- a/markdown/bitburner.gangmemberinfo.hack_exp.md +++ b/markdown/bitburner.gangmemberinfo.hack_exp.md @@ -4,6 +4,8 @@ ## GangMemberInfo.hack\_exp property +Current hack experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.hack_mult.md b/markdown/bitburner.gangmemberinfo.hack_mult.md index 90e26a588..f30e70624 100644 --- a/markdown/bitburner.gangmemberinfo.hack_mult.md +++ b/markdown/bitburner.gangmemberinfo.hack_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.hack\_mult property +Hack multiplier from equipment + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.md b/markdown/bitburner.gangmemberinfo.md index 413d679e4..51afe2946 100644 --- a/markdown/bitburner.gangmemberinfo.md +++ b/markdown/bitburner.gangmemberinfo.md @@ -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 | | diff --git a/markdown/bitburner.gangmemberinfo.name.md b/markdown/bitburner.gangmemberinfo.name.md index fcb8cda8b..f98233e8a 100644 --- a/markdown/bitburner.gangmemberinfo.name.md +++ b/markdown/bitburner.gangmemberinfo.name.md @@ -4,6 +4,8 @@ ## GangMemberInfo.name property +Name of the gang member + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.str.md b/markdown/bitburner.gangmemberinfo.str.md index f8b915034..ad8745274 100644 --- a/markdown/bitburner.gangmemberinfo.str.md +++ b/markdown/bitburner.gangmemberinfo.str.md @@ -4,6 +4,8 @@ ## GangMemberInfo.str property +Strength skill level + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.str_asc_mult.md b/markdown/bitburner.gangmemberinfo.str_asc_mult.md index 19f35804a..b0f512cac 100644 --- a/markdown/bitburner.gangmemberinfo.str_asc_mult.md +++ b/markdown/bitburner.gangmemberinfo.str_asc_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.str\_asc\_mult property +Strength multiplier from ascensions + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.str_asc_points.md b/markdown/bitburner.gangmemberinfo.str_asc_points.md index 13ba5414c..9255896bf 100644 --- a/markdown/bitburner.gangmemberinfo.str_asc_points.md +++ b/markdown/bitburner.gangmemberinfo.str_asc_points.md @@ -4,6 +4,8 @@ ## GangMemberInfo.str\_asc\_points property +Total earned strength experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.str_exp.md b/markdown/bitburner.gangmemberinfo.str_exp.md index 973edc4fd..5d2480a94 100644 --- a/markdown/bitburner.gangmemberinfo.str_exp.md +++ b/markdown/bitburner.gangmemberinfo.str_exp.md @@ -4,6 +4,8 @@ ## GangMemberInfo.str\_exp property +Current strength experience + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.str_mult.md b/markdown/bitburner.gangmemberinfo.str_mult.md index 6f250b46a..dffeb8b13 100644 --- a/markdown/bitburner.gangmemberinfo.str_mult.md +++ b/markdown/bitburner.gangmemberinfo.str_mult.md @@ -4,6 +4,8 @@ ## GangMemberInfo.str\_mult property +Strength multiplier from equipment + Signature: ```typescript diff --git a/markdown/bitburner.gangmemberinfo.task.md b/markdown/bitburner.gangmemberinfo.task.md index fe6d8de54..ff967194a 100644 --- a/markdown/bitburner.gangmemberinfo.task.md +++ b/markdown/bitburner.gangmemberinfo.task.md @@ -4,6 +4,8 @@ ## GangMemberInfo.task property +Currently assigned task + Signature: ```typescript diff --git a/markdown/bitburner.gangtaskstats.md b/markdown/bitburner.gangtaskstats.md index 8a2fed1b8..825940c02 100644 --- a/markdown/bitburner.gangtaskstats.md +++ b/markdown/bitburner.gangtaskstats.md @@ -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 | diff --git a/markdown/bitburner.gangtaskstats.strweight.md b/markdown/bitburner.gangtaskstats.strweight.md index d78c6e7f8..5c3b92f7f 100644 --- a/markdown/bitburner.gangtaskstats.strweight.md +++ b/markdown/bitburner.gangtaskstats.strweight.md @@ -4,7 +4,7 @@ ## GangTaskStats.strWeight property -Stength skill impact on task scaling +Strength skill impact on task scaling Signature: diff --git a/markdown/bitburner.hackingformulas.growpercent.md b/markdown/bitburner.hackingformulas.growpercent.md index 066e9fa8e..99c3b71bf 100644 --- a/markdown/bitburner.hackingformulas.growpercent.md +++ b/markdown/bitburner.hackingformulas.growpercent.md @@ -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.) Signature: diff --git a/markdown/bitburner.hackingformulas.hackchance.md b/markdown/bitburner.hackingformulas.hackchance.md index 7a455cf22..92c1a27b1 100644 --- a/markdown/bitburner.hackingformulas.hackchance.md +++ b/markdown/bitburner.hackingformulas.hackchance.md @@ -4,7 +4,7 @@ ## HackingFormulas.hackChance() method -Calculate hack chance. +Calculate hack chance. (Ex: 0.25 would indicate a 25% chance of success.) Signature: diff --git a/markdown/bitburner.hackingformulas.hackpercent.md b/markdown/bitburner.hackingformulas.hackpercent.md index 8c021dc0f..400621104 100644 --- a/markdown/bitburner.hackingformulas.hackpercent.md +++ b/markdown/bitburner.hackingformulas.hackpercent.md @@ -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.) Signature: diff --git a/markdown/bitburner.hackingformulas.md b/markdown/bitburner.hackingformulas.md index 0f3eb2298..5e2c23b7b 100644 --- a/markdown/bitburner.hackingformulas.md +++ b/markdown/bitburner.hackingformulas.md @@ -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. | diff --git a/markdown/bitburner.hacknet.getstudymult.md b/markdown/bitburner.hacknet.getstudymult.md index b436db528..509dfe9a3 100644 --- a/markdown/bitburner.hacknet.getstudymult.md +++ b/markdown/bitburner.hacknet.getstudymult.md @@ -4,7 +4,7 @@ ## Hacknet.getStudyMult() method -Get the multipler to study. +Get the multiplier to study. Signature: diff --git a/markdown/bitburner.hacknet.gettrainingmult.md b/markdown/bitburner.hacknet.gettrainingmult.md index 6d118628c..8f657f402 100644 --- a/markdown/bitburner.hacknet.gettrainingmult.md +++ b/markdown/bitburner.hacknet.gettrainingmult.md @@ -4,7 +4,7 @@ ## Hacknet.getTrainingMult() method -Get the multipler to training. +Get the multiplier to training. Signature: diff --git a/markdown/bitburner.hacknet.md b/markdown/bitburner.hacknet.md index 68e36c9e7..84d2c0e34 100644 --- a/markdown/bitburner.hacknet.md +++ b/markdown/bitburner.hacknet.md @@ -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. | diff --git a/markdown/bitburner.md b/markdown/bitburner.md index 98fb4585d..2f91a79c0 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -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 | diff --git a/markdown/bitburner.ns.getrunningscript.md b/markdown/bitburner.ns.getrunningscript.md index 361c2bae2..64da55ec8 100644 --- a/markdown/bitburner.ns.getrunningscript.md +++ b/markdown/bitburner.ns.getrunningscript.md @@ -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. diff --git a/markdown/bitburner.ns.getscriptexpgain_1.md b/markdown/bitburner.ns.getscriptexpgain_1.md index 3f941900f..4c4895564 100644 --- a/markdown/bitburner.ns.getscriptexpgain_1.md +++ b/markdown/bitburner.ns.getscriptexpgain_1.md @@ -4,6 +4,8 @@ ## NS.getScriptExpGain() method +Get the exp gain of a script. + Signature: ```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. | Returns: 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. + diff --git a/markdown/bitburner.ns.getscriptincome_1.md b/markdown/bitburner.ns.getscriptincome_1.md index 76fc3485f..6d5b0debf 100644 --- a/markdown/bitburner.ns.getscriptincome_1.md +++ b/markdown/bitburner.ns.getscriptincome_1.md @@ -4,6 +4,8 @@ ## NS.getScriptIncome() method +Get the income of a script. + Signature: ```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. | Returns: 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. + diff --git a/markdown/bitburner.ns.grow.md b/markdown/bitburner.ns.grow.md index 14b781d44..7ad16f0cf 100644 --- a/markdown/bitburner.ns.grow.md +++ b/markdown/bitburner.ns.grow.md @@ -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 ``` diff --git a/markdown/bitburner.ns.hack.md b/markdown/bitburner.ns.hack.md index e331e9201..c38aab5c0 100644 --- a/markdown/bitburner.ns.hack.md +++ b/markdown/bitburner.ns.hack.md @@ -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 ``` diff --git a/markdown/bitburner.ns.kill_1.md b/markdown/bitburner.ns.kill_1.md index 2c5995968..c414ec0dd 100644 --- a/markdown/bitburner.ns.kill_1.md +++ b/markdown/bitburner.ns.kill_1.md @@ -4,6 +4,8 @@ ## NS.kill() method +Terminate another script. + Signature: ```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. | Returns: 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"); +``` + diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index 81ad55bf0..5a5ea87d3 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -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. | diff --git a/markdown/bitburner.ns.printf.md b/markdown/bitburner.ns.printf.md new file mode 100644 index 000000000..5b158b194 --- /dev/null +++ b/markdown/bitburner.ns.printf.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [printf](./bitburner.ns.printf.md) + +## NS.printf() method + +Prints a formatted string to the script’s logs. + +Signature: + +```typescript +printf(format: string, ...args: any[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | format of the message | +| args | any\[\] | Value(s) to be printed. | + +Returns: + +void + +## Remarks + +RAM cost: 0 GB + +see: https://github.com/alexei/sprintf.js + diff --git a/markdown/bitburner.ns.prompt.md b/markdown/bitburner.ns.prompt.md index 491069ccd..830ee7f6c 100644 --- a/markdown/bitburner.ns.prompt.md +++ b/markdown/bitburner.ns.prompt.md @@ -4,12 +4,15 @@ ## NS.prompt() method -Prompt the player with a Yes/No modal. +Prompt the player with an input modal. Signature: ```typescript -prompt(txt: string): Promise; +prompt( + txt: string, + options?: { type?: "boolean" | "text" | "select" | undefined; choices?: string[] }, + ): Promise; ``` ## Parameters @@ -17,16 +20,17 @@ prompt(txt: string): Promise; | Parameter | Type | Description | | --- | --- | --- | | txt | string | Text to appear in the prompt dialog box. | +| options | { type?: "boolean" \| "text" \| "select" \| undefined; choices?: string\[\] } | Options to modify the prompt the player is shown. | Returns: -Promise<boolean> +Promise<boolean \| string> -True if the player click “Yes” and false if the player clicks “No”. +True if the player click “Yes”; false if the player clicks “No”; or the value entered by the player. ## 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. diff --git a/markdown/bitburner.ns.ps.md b/markdown/bitburner.ns.ps.md index 6ef602e19..532969c20 100644 --- a/markdown/bitburner.ns.ps.md +++ b/markdown/bitburner.ns.ps.md @@ -35,8 +35,8 @@ Returns an array with general information about all scripts running on the speci ```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); } @@ -49,7 +49,7 @@ for (let i = 0; i < scripts.length; ++i) { // NS2: const ps = ns.ps("home"); for (let script of ps) { - ns.tprint(`${script.filename} ${ps[i].threads}`); + ns.tprint(`${script.filename} ${script.threads}`); ns.tprint(script.args); } ``` diff --git a/markdown/bitburner.ns.scp_1.md b/markdown/bitburner.ns.scp_1.md index 516ed8863..5636d50bf 100644 --- a/markdown/bitburner.ns.scp_1.md +++ b/markdown/bitburner.ns.scp_1.md @@ -4,6 +4,8 @@ ## NS.scp() method +Copy file between servers. + Signature: ```typescript @@ -14,11 +16,55 @@ scp(files: string | string[], source: string, destination: string): PromiseReturns: Promise<boolean> +True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. + +## Remarks + +RAM cost: 0.6 GB + +Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy. + +## Example 1 + + +```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 2 + + +```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 3 + + +```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); +``` + diff --git a/markdown/bitburner.ns.trywriteport.md b/markdown/bitburner.ns.trywriteport.md index c5bdf2a9e..8b2eb2fa7 100644 --- a/markdown/bitburner.ns.trywriteport.md +++ b/markdown/bitburner.ns.trywriteport.md @@ -9,7 +9,7 @@ Attempt to write to a port. Signature: ```typescript -tryWritePort(port: number, data: string[] | number): Promise; +tryWritePort(port: number, data: string | number): Promise; ``` ## Parameters @@ -17,7 +17,7 @@ tryWritePort(port: number, data: string[] | number): Promise; | Parameter | Type | Description | | --- | --- | --- | | port | number | Port or text file that will be written to. | -| data | string\[\] \| number | Data to write. | +| data | string \| number | Data to write. | Returns: diff --git a/markdown/bitburner.ns.weaken.md b/markdown/bitburner.ns.weaken.md index b3ff9518c..3ee0175ff 100644 --- a/markdown/bitburner.ns.weaken.md +++ b/markdown/bitburner.ns.weaken.md @@ -40,7 +40,6 @@ Like hack and grow, `weaken` can be called on any server, regardless of where th // NS1: var currentSecurity = getServerSecurityLevel("foodnstuff"); currentSecurity = currentSecurity - weaken("foodnstuff"); -currentSecurity = currentSecurity - weaken("foodnstuff", { threads: 5 }); // Only use 5 threads to weaken ``` ## Example 2 @@ -50,6 +49,5 @@ currentSecurity = currentSecurity - weaken("foodnstuff", { threads: 5 }); // Onl // NS2: let currentSecurity = ns.getServerSecurityLevel("foodnstuff"); currentSecurity -= await ns.weaken("foodnstuff"); -currentSecurity -= await ns.weaken("foodnstuff", { threads: 5 }); // Only use 5 threads to weaken ``` diff --git a/markdown/bitburner.officeapi.getresearchcost.md b/markdown/bitburner.officeapi.getresearchcost.md index 9d7ff7539..14899201a 100644 --- a/markdown/bitburner.officeapi.getresearchcost.md +++ b/markdown/bitburner.officeapi.getresearchcost.md @@ -17,7 +17,7 @@ getResearchCost(divisionName: string, researchName: string): number; | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| researchName | string | | +| researchName | string | Name of the research | Returns: diff --git a/markdown/bitburner.officeapi.hasresearched.md b/markdown/bitburner.officeapi.hasresearched.md index a996971fc..362af2bd7 100644 --- a/markdown/bitburner.officeapi.hasresearched.md +++ b/markdown/bitburner.officeapi.hasresearched.md @@ -17,7 +17,7 @@ hasResearched(divisionName: string, researchName: string): boolean; | Parameter | Type | Description | | --- | --- | --- | | divisionName | string | Name of the division | -| researchName | string | | +| researchName | string | Name of the research | Returns: diff --git a/markdown/bitburner.player.inbladeburner.md b/markdown/bitburner.player.inbladeburner.md new file mode 100644 index 000000000..1bfe078fd --- /dev/null +++ b/markdown/bitburner.player.inbladeburner.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Player](./bitburner.player.md) > [inBladeburner](./bitburner.player.inbladeburner.md) + +## Player.inBladeburner property + +Signature: + +```typescript +inBladeburner: boolean; +``` diff --git a/markdown/bitburner.player.md b/markdown/bitburner.player.md index 3059f567f..41fd45c04 100644 --- a/markdown/bitburner.player.md +++ b/markdown/bitburner.player.md @@ -68,6 +68,7 @@ interface Player | [hasTixApiAccess](./bitburner.player.hastixapiaccess.md) | boolean | | | [hasWseAccount](./bitburner.player.haswseaccount.md) | boolean | | | [hp](./bitburner.player.hp.md) | number | | +| [inBladeburner](./bitburner.player.inbladeburner.md) | boolean | | | [intelligence](./bitburner.player.intelligence.md) | number | | | [isWorking](./bitburner.player.isworking.md) | boolean | | | [jobs](./bitburner.player.jobs.md) | any | | diff --git a/markdown/bitburner.playerskills.charisma.md b/markdown/bitburner.playerskills.charisma.md index d6ff272e2..50ac946c0 100644 --- a/markdown/bitburner.playerskills.charisma.md +++ b/markdown/bitburner.playerskills.charisma.md @@ -4,7 +4,7 @@ ## PlayerSkills.charisma property -Chraisma level +Charisma level Signature: diff --git a/markdown/bitburner.playerskills.md b/markdown/bitburner.playerskills.md index 8f0c73215..748bf55a8 100644 --- a/markdown/bitburner.playerskills.md +++ b/markdown/bitburner.playerskills.md @@ -17,7 +17,7 @@ export interface PlayerSkills | Property | Type | Description | | --- | --- | --- | | [agility](./bitburner.playerskills.agility.md) | number | Agility level | -| [charisma](./bitburner.playerskills.charisma.md) | number | Chraisma level | +| [charisma](./bitburner.playerskills.charisma.md) | number | Charisma level | | [defense](./bitburner.playerskills.defense.md) | number | Defense level | | [dexterity](./bitburner.playerskills.dexterity.md) | number | Dexterity level | | [hacking](./bitburner.playerskills.hacking.md) | number | Hacking level | diff --git a/markdown/bitburner.runningscript.md b/markdown/bitburner.runningscript.md index 03ee3ed3f..66d32cd3b 100644 --- a/markdown/bitburner.runningscript.md +++ b/markdown/bitburner.runningscript.md @@ -20,10 +20,10 @@ interface RunningScript | [logs](./bitburner.runningscript.logs.md) | string\[\] | | | [offlineExpGained](./bitburner.runningscript.offlineexpgained.md) | number | | | [offlineMoneyMade](./bitburner.runningscript.offlinemoneymade.md) | number | | -| [offlineRunningTime](./bitburner.runningscript.offlinerunningtime.md) | number | | +| [offlineRunningTime](./bitburner.runningscript.offlinerunningtime.md) | number | Offline running time of the script, in seconds \* | | [onlineExpGained](./bitburner.runningscript.onlineexpgained.md) | number | | | [onlineMoneyMade](./bitburner.runningscript.onlinemoneymade.md) | number | | -| [onlineRunningTime](./bitburner.runningscript.onlinerunningtime.md) | number | | +| [onlineRunningTime](./bitburner.runningscript.onlinerunningtime.md) | number | Online running time of the script, in seconds \* | | [pid](./bitburner.runningscript.pid.md) | number | | | [ramUsage](./bitburner.runningscript.ramusage.md) | number | | | [server](./bitburner.runningscript.server.md) | string | | diff --git a/markdown/bitburner.runningscript.offlinerunningtime.md b/markdown/bitburner.runningscript.offlinerunningtime.md index 23e7d4725..583170c8c 100644 --- a/markdown/bitburner.runningscript.offlinerunningtime.md +++ b/markdown/bitburner.runningscript.offlinerunningtime.md @@ -4,6 +4,8 @@ ## RunningScript.offlineRunningTime property +Offline running time of the script, in seconds \* + Signature: ```typescript diff --git a/markdown/bitburner.runningscript.onlinerunningtime.md b/markdown/bitburner.runningscript.onlinerunningtime.md index eeabc593f..dc0074919 100644 --- a/markdown/bitburner.runningscript.onlinerunningtime.md +++ b/markdown/bitburner.runningscript.onlinerunningtime.md @@ -4,6 +4,8 @@ ## RunningScript.onlineRunningTime property +Online running time of the script, in seconds \* + Signature: ```typescript diff --git a/markdown/bitburner.server.isconnectedto.md b/markdown/bitburner.server.isconnectedto.md index 9fe4f83fe..d32099e16 100644 --- a/markdown/bitburner.server.isconnectedto.md +++ b/markdown/bitburner.server.isconnectedto.md @@ -4,7 +4,7 @@ ## Server.isConnectedTo property -Flag indicating whether player is curently connected to this server +Flag indicating whether player is currently connected to this server Signature: diff --git a/markdown/bitburner.server.md b/markdown/bitburner.server.md index 5fcecc439..b47cd3ff9 100644 --- a/markdown/bitburner.server.md +++ b/markdown/bitburner.server.md @@ -25,7 +25,7 @@ export interface Server | [hostname](./bitburner.server.hostname.md) | string | Hostname. Must be unique | | [httpPortOpen](./bitburner.server.httpportopen.md) | boolean | Flag indicating whether HTTP Port is open | | [ip](./bitburner.server.ip.md) | string | IP Address. Must be unique | -| [isConnectedTo](./bitburner.server.isconnectedto.md) | boolean | Flag indicating whether player is curently connected to this server | +| [isConnectedTo](./bitburner.server.isconnectedto.md) | boolean | Flag indicating whether player is currently connected to this server | | [maxRam](./bitburner.server.maxram.md) | number | RAM (GB) available on this server | | [minDifficulty](./bitburner.server.mindifficulty.md) | number | Minimum server security level that this server can be weakened to | | [moneyAvailable](./bitburner.server.moneyavailable.md) | number | How much money currently resides on the server and can be hacked | diff --git a/markdown/bitburner.singularity.isbusy.md b/markdown/bitburner.singularity.isbusy.md index d6b88caf1..5c0e5725b 100644 --- a/markdown/bitburner.singularity.isbusy.md +++ b/markdown/bitburner.singularity.isbusy.md @@ -21,5 +21,5 @@ True if the player is currently performing an ‘action’, false otherwise. RAM cost: 0.5 GB \* 16/4/1 -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, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. +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 university, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. diff --git a/markdown/bitburner.singularity.stopaction.md b/markdown/bitburner.singularity.stopaction.md index c2daafc53..b5331446e 100644 --- a/markdown/bitburner.singularity.stopaction.md +++ b/markdown/bitburner.singularity.stopaction.md @@ -25,7 +25,7 @@ This function is used to end whatever ‘action’ the player is currently perfo The actions that can be stopped with this function are: -\* Studying at a university \* Working for a company/faction \* Creating a program \* Committing a Crime +\* Studying at a university \* Working out at a gym \* Working for a company/faction \* Creating a program \* 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. diff --git a/markdown/bitburner.warehouseapi.md b/markdown/bitburner.warehouseapi.md index 24a132042..ec0567cc6 100644 --- a/markdown/bitburner.warehouseapi.md +++ b/markdown/bitburner.warehouseapi.md @@ -20,6 +20,7 @@ Requires the Warehouse API upgrade from your corporation. | Method | Description | | --- | --- | +| [bulkPurchase(divisionName, cityName, materialName, amt)](./bitburner.warehouseapi.bulkpurchase.md) | Set material to bulk buy | | [buyMaterial(divisionName, cityName, materialName, amt)](./bitburner.warehouseapi.buymaterial.md) | Set material buy data | | [cancelExportMaterial(sourceDivision, sourceCity, targetDivision, targetCity, materialName, amt)](./bitburner.warehouseapi.cancelexportmaterial.md) | Cancel material export | | [discontinueProduct(divisionName, productName)](./bitburner.warehouseapi.discontinueproduct.md) | Discontinue a product. | @@ -39,5 +40,6 @@ Requires the Warehouse API upgrade from your corporation. | [setProductMarketTA1(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta1.md) | Set market TA 1 for a product. | | [setProductMarketTA2(divisionName, productName, on)](./bitburner.warehouseapi.setproductmarketta2.md) | Set market TA 2 for a product. | | [setSmartSupply(divisionName, cityName, enabled)](./bitburner.warehouseapi.setsmartsupply.md) | Set smart supply | +| [setSmartSupplyUseLeftovers(divisionName, cityName, materialName, enabled)](./bitburner.warehouseapi.setsmartsupplyuseleftovers.md) | Set whether smart supply uses leftovers before buying | | [upgradeWarehouse(divisionName, cityName)](./bitburner.warehouseapi.upgradewarehouse.md) | Upgrade warehouse | diff --git a/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md b/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md new file mode 100644 index 000000000..b1c00312c --- /dev/null +++ b/markdown/bitburner.warehouseapi.setsmartsupplyuseleftovers.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [WarehouseAPI](./bitburner.warehouseapi.md) > [setSmartSupplyUseLeftovers](./bitburner.warehouseapi.setsmartsupplyuseleftovers.md) + +## WarehouseAPI.setSmartSupplyUseLeftovers() method + +Set whether smart supply uses leftovers before buying + +Signature: + +```typescript +setSmartSupplyUseLeftovers(divisionName: string, cityName: string, materialName: string, enabled: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| divisionName | string | Name of the division | +| cityName | string | Name of the city | +| materialName | string | Name of the material | +| enabled | boolean | smart supply use leftovers enabled | + +Returns: + +void + diff --git a/tsdoc-metadata.json b/tsdoc-metadata.json index 1946c4e79..11886848c 100644 --- a/tsdoc-metadata.json +++ b/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.18.17" + "packageVersion": "7.19.4" } ] }