From 7a89c0a1bbcae91602f91266e855946c95f0f77c Mon Sep 17 00:00:00 2001 From: Olivier Gagnon Date: Sun, 9 Oct 2022 18:46:13 -0400 Subject: [PATCH] regen doc --- dist/bitburner.d.ts | 586 +++++++++++------- .../bitburner.augmentationstats.agility.md | 13 - ...bitburner.augmentationstats.agility_exp.md | 13 - ....augmentationstats.bladeburner_analysis.md | 13 - ...gmentationstats.bladeburner_max_stamina.md | 13 - ...mentationstats.bladeburner_stamina_gain.md | 13 - ...ntationstats.bladeburner_success_chance.md | 13 - .../bitburner.augmentationstats.charisma.md | 13 - ...itburner.augmentationstats.charisma_exp.md | 13 - ...bitburner.augmentationstats.company_rep.md | 13 - ...bitburner.augmentationstats.crime_money.md | 13 - ...tburner.augmentationstats.crime_success.md | 13 - .../bitburner.augmentationstats.defense.md | 13 - ...bitburner.augmentationstats.defense_exp.md | 13 - .../bitburner.augmentationstats.dexterity.md | 13 - ...tburner.augmentationstats.dexterity_exp.md | 13 - ...bitburner.augmentationstats.faction_rep.md | 13 - .../bitburner.augmentationstats.hacking.md | 13 - ...burner.augmentationstats.hacking_chance.md | 13 - ...bitburner.augmentationstats.hacking_exp.md | 13 - ...itburner.augmentationstats.hacking_grow.md | 13 - ...tburner.augmentationstats.hacking_money.md | 13 - ...tburner.augmentationstats.hacking_speed.md | 13 - ...ugmentationstats.hacknet_node_core_cost.md | 13 - ...gmentationstats.hacknet_node_level_cost.md | 13 - ...er.augmentationstats.hacknet_node_money.md | 13 - ...ntationstats.hacknet_node_purchase_cost.md | 13 - ...augmentationstats.hacknet_node_ram_cost.md | 13 - markdown/bitburner.augmentationstats.md | 49 -- .../bitburner.augmentationstats.strength.md | 13 - ...itburner.augmentationstats.strength_exp.md | 13 - .../bitburner.augmentationstats.work_money.md | 13 - ...rner.codingcontract.createdummycontract.md | 30 + ...tburner.codingcontract.getcontracttypes.md | 21 + markdown/bitburner.codingcontract.md | 2 + .../bitburner.corporationinfo.issuedshares.md | 2 +- markdown/bitburner.corporationinfo.md | 2 +- markdown/bitburner.hacknet.spendhashes.md | 2 +- markdown/bitburner.hacknetnodeconstants.md | 2 +- ...burner.hacknetnodeconstants.rambasecost.md | 2 +- markdown/bitburner.md | 6 +- markdown/bitburner.multipliers.agility.md | 4 +- markdown/bitburner.multipliers.agility_exp.md | 4 +- ...burner.multipliers.bladeburner_analysis.md | 4 +- ...ner.multipliers.bladeburner_max_stamina.md | 4 +- ...er.multipliers.bladeburner_stamina_gain.md | 4 +- ....multipliers.bladeburner_success_chance.md | 4 +- markdown/bitburner.multipliers.charisma.md | 4 +- .../bitburner.multipliers.charisma_exp.md | 4 +- markdown/bitburner.multipliers.company_rep.md | 4 +- markdown/bitburner.multipliers.crime_money.md | 4 +- .../bitburner.multipliers.crime_success.md | 4 +- markdown/bitburner.multipliers.defense.md | 4 +- markdown/bitburner.multipliers.defense_exp.md | 4 +- markdown/bitburner.multipliers.dexterity.md | 4 +- .../bitburner.multipliers.dexterity_exp.md | 4 +- markdown/bitburner.multipliers.faction_rep.md | 4 +- markdown/bitburner.multipliers.hacking.md | 4 +- .../bitburner.multipliers.hacking_chance.md | 4 +- markdown/bitburner.multipliers.hacking_exp.md | 4 +- .../bitburner.multipliers.hacking_grow.md | 4 +- .../bitburner.multipliers.hacking_money.md | 4 +- .../bitburner.multipliers.hacking_speed.md | 4 +- ...rner.multipliers.hacknet_node_core_cost.md | 4 +- ...ner.multipliers.hacknet_node_level_cost.md | 4 +- ...itburner.multipliers.hacknet_node_money.md | 4 +- ....multipliers.hacknet_node_purchase_cost.md | 4 +- ...urner.multipliers.hacknet_node_ram_cost.md | 4 +- markdown/bitburner.multipliers.md | 60 +- markdown/bitburner.multipliers.strength.md | 4 +- .../bitburner.multipliers.strength_exp.md | 4 +- markdown/bitburner.multipliers.work_money.md | 4 +- markdown/bitburner.ns.clearport.md | 2 +- markdown/bitburner.ns.exec.md | 29 +- ...burner.ns.getpurchasedserverupgradecost.md | 31 + markdown/bitburner.ns.md | 3 + markdown/bitburner.ns.nformat.md | 4 +- markdown/bitburner.ns.print.md | 66 ++ markdown/bitburner.ns.printf.md | 38 +- .../bitburner.ns.renamepurchasedserver.md | 31 + markdown/bitburner.ns.sprintf.md | 4 +- markdown/bitburner.ns.toast.md | 4 +- markdown/bitburner.ns.tprint.md | 2 + markdown/bitburner.ns.tprintf.md | 10 +- markdown/bitburner.ns.trywriteport.md | 4 +- .../bitburner.ns.upgradepurchasedserver.md | 31 + markdown/bitburner.ns.vsprintf.md | 4 +- markdown/bitburner.nsenums.md | 11 +- markdown/bitburner.nsenums.toast.md | 11 - markdown/bitburner.officeapi.md | 2 +- ...ner.singularity.checkfactioninvitations.md | 4 +- ...burner.singularity.getaugmentationstats.md | 4 +- .../bitburner.singularity.getcrimechance.md | 4 +- markdown/bitburner.sleeve.settocommitcrime.md | 2 +- markdown/bitburner.tix.cancelorder.md | 2 +- markdown/bitburner.tix.getprice.md | 26 +- markdown/bitburner.tix.md | 2 +- markdown/bitburner.toastvariant.md | 14 +- markdown/bitburner.toastvariantvalues.md | 14 - src/ScriptEditor/NetscriptDefinitions.d.ts | 7 +- 100 files changed, 804 insertions(+), 836 deletions(-) delete mode 100644 markdown/bitburner.augmentationstats.agility.md delete mode 100644 markdown/bitburner.augmentationstats.agility_exp.md delete mode 100644 markdown/bitburner.augmentationstats.bladeburner_analysis.md delete mode 100644 markdown/bitburner.augmentationstats.bladeburner_max_stamina.md delete mode 100644 markdown/bitburner.augmentationstats.bladeburner_stamina_gain.md delete mode 100644 markdown/bitburner.augmentationstats.bladeburner_success_chance.md delete mode 100644 markdown/bitburner.augmentationstats.charisma.md delete mode 100644 markdown/bitburner.augmentationstats.charisma_exp.md delete mode 100644 markdown/bitburner.augmentationstats.company_rep.md delete mode 100644 markdown/bitburner.augmentationstats.crime_money.md delete mode 100644 markdown/bitburner.augmentationstats.crime_success.md delete mode 100644 markdown/bitburner.augmentationstats.defense.md delete mode 100644 markdown/bitburner.augmentationstats.defense_exp.md delete mode 100644 markdown/bitburner.augmentationstats.dexterity.md delete mode 100644 markdown/bitburner.augmentationstats.dexterity_exp.md delete mode 100644 markdown/bitburner.augmentationstats.faction_rep.md delete mode 100644 markdown/bitburner.augmentationstats.hacking.md delete mode 100644 markdown/bitburner.augmentationstats.hacking_chance.md delete mode 100644 markdown/bitburner.augmentationstats.hacking_exp.md delete mode 100644 markdown/bitburner.augmentationstats.hacking_grow.md delete mode 100644 markdown/bitburner.augmentationstats.hacking_money.md delete mode 100644 markdown/bitburner.augmentationstats.hacking_speed.md delete mode 100644 markdown/bitburner.augmentationstats.hacknet_node_core_cost.md delete mode 100644 markdown/bitburner.augmentationstats.hacknet_node_level_cost.md delete mode 100644 markdown/bitburner.augmentationstats.hacknet_node_money.md delete mode 100644 markdown/bitburner.augmentationstats.hacknet_node_purchase_cost.md delete mode 100644 markdown/bitburner.augmentationstats.hacknet_node_ram_cost.md delete mode 100644 markdown/bitburner.augmentationstats.md delete mode 100644 markdown/bitburner.augmentationstats.strength.md delete mode 100644 markdown/bitburner.augmentationstats.strength_exp.md delete mode 100644 markdown/bitburner.augmentationstats.work_money.md create mode 100644 markdown/bitburner.codingcontract.createdummycontract.md create mode 100644 markdown/bitburner.codingcontract.getcontracttypes.md create mode 100644 markdown/bitburner.ns.getpurchasedserverupgradecost.md create mode 100644 markdown/bitburner.ns.renamepurchasedserver.md create mode 100644 markdown/bitburner.ns.upgradepurchasedserver.md delete mode 100644 markdown/bitburner.nsenums.toast.md delete mode 100644 markdown/bitburner.toastvariantvalues.md diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts index 7f7747f1e..4d8eafada 100644 --- a/dist/bitburner.d.ts +++ b/dist/bitburner.d.ts @@ -1,6 +1,4 @@ -/** - * @public - */ +/** @public */ export declare interface ActiveFragment { id: number; highestCharge: number; @@ -10,73 +8,6 @@ export declare interface ActiveFragment { y: number; } -/** - * Data representing the internal values of an Augmentation. - * @public - */ -export declare interface AugmentationStats { - /** Multiplier to hacking skill */ - hacking?: number; - /** Multiplier to strength skill */ - strength?: number; - /** Multiplier to defense skill */ - defense?: number; - /** Multiplier to dexterity skill */ - dexterity?: number; - /** Multiplier to agility skill */ - agility?: number; - /** Multiplier to charisma skill */ - charisma?: number; - /** Multiplier to hacking experience gain rate */ - hacking_exp?: number; - /** Multiplier to strength experience gain rate */ - strength_exp?: number; - /** Multiplier to defense experience gain rate */ - defense_exp?: number; - /** Multiplier to dexterity experience gain rate */ - dexterity_exp?: number; - /** Multiplier to agility experience gain rate */ - agility_exp?: number; - /** Multiplier to charisma experience gain rate */ - charisma_exp?: number; - /** Multiplier to chance of successfully performing a hack */ - hacking_chance?: number; - /** Multiplier to hacking speed */ - hacking_speed?: number; - /** Multiplier to amount of money the player gains from hacking */ - hacking_money?: number; - /** Multiplier to amount of money injected into servers using grow */ - hacking_grow?: number; - /** Multiplier to amount of reputation gained when working */ - company_rep?: number; - /** Multiplier to amount of reputation gained when working */ - faction_rep?: number; - /** Multiplier to amount of money gained from crimes */ - crime_money?: number; - /** Multiplier to crime success rate */ - crime_success?: number; - /** Multiplier to amount of money gained from working */ - work_money?: number; - /** Multiplier to amount of money produced by Hacknet Nodes */ - hacknet_node_money?: number; - /** Multiplier to cost of purchasing a Hacknet Node */ - hacknet_node_purchase_cost?: number; - /** Multiplier to cost of ram for a Hacknet Node */ - hacknet_node_ram_cost?: number; - /** Multiplier to cost of core for a Hacknet Node */ - hacknet_node_core_cost?: number; - /** Multiplier to cost of leveling up a Hacknet Node */ - hacknet_node_level_cost?: number; - /** Multiplier to Bladeburner max stamina */ - bladeburner_max_stamina?: number; - /** Multiplier to Bladeburner stamina gain rate */ - bladeburner_stamina_gain?: number; - /** Multiplier to effectiveness in Bladeburner Field Analysis */ - bladeburner_analysis?: number; - /** Multiplier to success chance in Bladeburner contracts/operations */ - bladeburner_success_chance?: number; -} - /** * Return value of {@link Sleeve.getSleevePurchasableAugs | getSleevePurchasableAugs} * @public @@ -104,7 +35,8 @@ export declare interface AutocompleteData { * @public */ export declare interface BasicHGWOptions { - /** Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. */ + /** Number of threads to use for this function. + * Must be less than or equal to the number of threads the script is running with. */ threads?: number; /** Set to true this action will affect the stock market. */ stock?: boolean; @@ -165,7 +97,8 @@ export declare interface BitNodeMultipliers { HackExpGain: number; /** Influences how quickly the player's hacking level (not experience) scales */ HackingLevelMultiplier: number; - /** Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) */ + /** Influences how much money is produced by Hacknet Nodes + * and the hash rate of Hacknet Servers (unlocked in BitNode-9) */ HacknetNodeMoney: number; /** Influences how much money it costs to upgrade your home computer's RAM */ HomeComputerRamCost: number; @@ -173,7 +106,8 @@ export declare interface BitNodeMultipliers { InfiltrationMoney: number; /** Influences how much rep the player can gain from factions when selling stolen documents and secrets */ InfiltrationRep: number; - /** Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal. */ + /** Influences how much money can be stolen from a server when the player + * performs a hack against it through the Terminal. */ ManualHackMoney: number; /** Influence how much it costs to purchase a server */ PurchasedServerCost: number; @@ -710,9 +644,7 @@ export declare interface BladeburnerCurAction { name: string; } -/** - * @public - */ +/** @public */ export declare interface CharacterMult { /** Agility stat */ agility: number; @@ -838,6 +770,24 @@ export declare interface CodingContract { * @returns How many attempts are remaining for the contract. */ getNumTriesRemaining(filename: string, host?: string): number; + + /** + * Generate a dummy contract. + * @remarks + * RAM cost: 2 GB + * + * Generate a dummy contract on the home computer with no reward. Used to test various algorithms. + * + * @param type - Type of contract to generate + */ + createDummyContract(type: string): void; + + /** + * List all contract types. + * @remarks + * RAM cost: 2 GB + */ + getContractTypes(): string[]; } /** @@ -1026,7 +976,7 @@ export declare interface CorporationInfo { numShares: number; /** Cooldown until shares can be sold again */ shareSaleCooldown: number; - /** Amount of aqcuirable shares. */ + /** Amount of acquirable shares. */ issuedShares: number; /** Price of the shares */ sharePrice: number; @@ -1169,6 +1119,16 @@ export declare interface EmployeeJobs { Unassigned: number; } +/** @internal */ +export declare const enums = { + toast: { + SUCCESS: "success", + WARNING: "warning", + ERROR: "error", + INFO: "info", + }, +}; + /** * Object representing data representing a gang member equipment. * @public @@ -1201,9 +1161,7 @@ export declare interface Export { amt: string; } -/** - * @public - */ +/** @public */ export declare type FilenameOrPID = number | string; /** @@ -1231,9 +1189,7 @@ export declare interface Formulas { work: WorkFormulas; } -/** - * @public - */ +/** @public */ export declare interface Fragment { id: number; shape: boolean[][]; @@ -1593,9 +1549,7 @@ export declare interface GangGenInfo { wantedPenalty: number; } -/** - * @public - */ +/** @public */ export declare interface GangMemberAscension { /** Amount of respect lost from ascending */ respect: number; @@ -1613,9 +1567,7 @@ export declare interface GangMemberAscension { cha: number; } -/** - * @public - */ +/** @public */ export declare interface GangMemberInfo { /** Name of the gang member */ name: string; @@ -1696,16 +1648,12 @@ export declare interface GangMemberInfo { moneyGain: number; } -/** - * @public - */ +/** @public */ export declare interface GangOtherInfo { [key: string]: GangOtherInfoObject; } -/** - * @public - */ +/** @public */ export declare interface GangOtherInfoObject { /** Gang power */ power: number; @@ -1750,9 +1698,7 @@ export declare interface GangTaskStats { territory: GangTerritory; } -/** - * @public - */ +/** @public */ export declare interface GangTerritory { /** Money gain impact on task scaling */ money: number; @@ -2195,7 +2141,7 @@ export declare interface Hacknet { * @param upgName - Name of the upgrade of Hacknet Node. * @param upgTarget - Object to which upgrade applies. Required for certain upgrades. * @param count - Number of upgrades to buy at once. Defaults to 1 if not specified. - * For compatability reasons, upgTarget must be specified, even if it is not used, in order to specify count. + * For compatibility reasons, upgTarget must be specified, even if it is not used, in order to specify count. * @returns True if the upgrade is successfully purchased, and false otherwise. */ spendHashes(upgName: string, upgTarget?: string, count?: number): boolean; @@ -2284,7 +2230,7 @@ export declare interface HacknetNodeConstants { BaseCost: number; /** Base cost per level */ LevelBaseCost: number; - /** Base cost to incrase RAM */ + /** Base cost to increase RAM */ RamBaseCost: number; /** Base cost to increase cores */ CoreBaseCost: number; @@ -2460,17 +2406,13 @@ export declare interface HacknetServersFormulas { constants(): HacknetServerConstants; } -/** - * @public - */ +/** @public */ export declare interface HP { current: number; max: number; } -/** - * @public - */ +/** @public */ export declare interface ILocation { city: string; name: string; @@ -2499,18 +2441,14 @@ export declare interface Infiltration { getInfiltration(location: string): InfiltrationLocation; } -/** - * @public - */ +/** @public */ export declare interface InfiltrationLocation { location: ILocation; reward: InfiltrationReward; difficulty: number; } -/** - * @public - */ +/** @public */ export declare interface InfiltrationReward { tradeRep: number; sellCash: number; @@ -2566,40 +2504,68 @@ export declare interface Material { exp: Export[]; } -/** - * @public - */ +/** @public */ export declare interface Multipliers { - hacking_chance: number; - hacking_speed: number; - hacking_money: number; - hacking_grow: number; - hacking: number; - hacking_exp: number; - strength: number; - strength_exp: number; - defense: number; - defense_exp: number; - dexterity: number; - dexterity_exp: number; - agility: number; - agility_exp: number; - charisma: number; - charisma_exp: number; - hacknet_node_money: number; - hacknet_node_purchase_cost: number; - hacknet_node_ram_cost: number; - hacknet_node_core_cost: number; - hacknet_node_level_cost: number; - company_rep: number; - faction_rep: number; - work_money: number; - crime_success: number; - crime_money: number; - bladeburner_max_stamina: number; - bladeburner_stamina_gain: number; - bladeburner_analysis: number; - bladeburner_success_chance: number; + /** Multiplier to hacking skill */ + hacking?: number; + /** Multiplier to strength skill */ + strength?: number; + /** Multiplier to defense skill */ + defense?: number; + /** Multiplier to dexterity skill */ + dexterity?: number; + /** Multiplier to agility skill */ + agility?: number; + /** Multiplier to charisma skill */ + charisma?: number; + /** Multiplier to hacking experience gain rate */ + hacking_exp?: number; + /** Multiplier to strength experience gain rate */ + strength_exp?: number; + /** Multiplier to defense experience gain rate */ + defense_exp?: number; + /** Multiplier to dexterity experience gain rate */ + dexterity_exp?: number; + /** Multiplier to agility experience gain rate */ + agility_exp?: number; + /** Multiplier to charisma experience gain rate */ + charisma_exp?: number; + /** Multiplier to chance of successfully performing a hack */ + hacking_chance?: number; + /** Multiplier to hacking speed */ + hacking_speed?: number; + /** Multiplier to amount of money the player gains from hacking */ + hacking_money?: number; + /** Multiplier to amount of money injected into servers using grow */ + hacking_grow?: number; + /** Multiplier to amount of reputation gained when working */ + company_rep?: number; + /** Multiplier to amount of reputation gained when working */ + faction_rep?: number; + /** Multiplier to amount of money gained from crimes */ + crime_money?: number; + /** Multiplier to crime success rate */ + crime_success?: number; + /** Multiplier to amount of money gained from working */ + work_money?: number; + /** Multiplier to amount of money produced by Hacknet Nodes */ + hacknet_node_money?: number; + /** Multiplier to cost of purchasing a Hacknet Node */ + hacknet_node_purchase_cost?: number; + /** Multiplier to cost of ram for a Hacknet Node */ + hacknet_node_ram_cost?: number; + /** Multiplier to cost of core for a Hacknet Node */ + hacknet_node_core_cost?: number; + /** Multiplier to cost of leveling up a Hacknet Node */ + hacknet_node_level_cost?: number; + /** Multiplier to Bladeburner max stamina */ + bladeburner_max_stamina?: number; + /** Multiplier to Bladeburner stamina gain rate */ + bladeburner_stamina_gain?: number; + /** Multiplier to effectiveness in Bladeburner Field Analysis */ + bladeburner_analysis?: number; + /** Multiplier to success chance in Bladeburner contracts/operations */ + bladeburner_success_chance?: number; } /** @@ -2734,54 +2700,55 @@ export declare interface NS { * @remarks RAM cost: 4 GB */ readonly hacknet: Hacknet; + /** - * * Namespace for bladeburner functions. * @remarks RAM cost: 0 GB */ readonly bladeburner: Bladeburner; + /** - * * Namespace for codingcontract functions. * @remarks RAM cost: 0 GB */ readonly codingcontract: CodingContract; + /** - * * Namespace for gang functions. * @remarks RAM cost: 0 GB */ readonly gang: Gang; + /** - * * Namespace for sleeve functions. * @remarks RAM cost: 0 GB */ readonly sleeve: Sleeve; + /** - * * Namespace for stock functions. - * @remarks - * RAM cost: 0 GB + * @remarks RAM cost: 0 GB */ readonly stock: TIX; + /** - * * Namespace for formulas functions. - * @remarks - * RAM cost: 0 GB + * @remarks RAM cost: 0 GB */ readonly formulas: Formulas; + /** * Namespace for stanek functions. * RAM cost: 0 GB */ readonly stanek: Stanek; + /** * Namespace for infiltration functions. * RAM cost: 0 GB */ readonly infiltration: Infiltration; + /** * Namespace for corporation functions. * RAM cost: 1022.4 GB @@ -2802,8 +2769,7 @@ export declare interface NS { /** * Namespace for grafting functions. - * @remarks - * RAM cost: 0 GB + * @remarks RAM cost: 0 GB */ readonly grafting: Grafting; @@ -3098,6 +3064,77 @@ export declare interface NS { * @remarks * RAM cost: 0 GB * + * If the argument is a string, you can color code your message by prefixing your + * string with one of these strings: + * + * - `"ERROR"`: The whole string will be printed in red. Use this prefix to indicate + * that an error has occurred. + * + * - `"SUCCESS"`: The whole string will be printed in green, similar to the default + * theme of the Terminal. Use this prefix to indicate that something is correct. + * + * - `"WARN"`: The whole string will be printed in yellow. Use this prefix to + * indicate that you or a user of your script should be careful of something. + * + * - `"INFO"`: The whole string will be printed in purplish blue. Use this prefix to + * remind yourself or a user of your script of something. Think of this prefix as + * indicating an FYI (for your information). + * + * For custom coloring, use ANSI escape sequences. The examples below use the Unicode + * escape code `\u001b`. The color coding also works if `\u001b` is replaced with + * the hexadecimal escape code `\x1b`. The Bash escape code `\e` is not supported. + * The octal escape code `\033` is not allowed because the game runs JavaScript in + * strict mode. + * + * @example + * ```ts + * // NS1 + * // Default color coding. + * print("ERROR means something's wrong."); + * print("SUCCESS means everything's OK."); + * print("WARN Tread with caution!"); + * print("WARNING, warning, danger, danger!"); + * print("WARNing! Here be dragons."); + * print("INFO for your I's only (FYI)."); + * print("INFOrmation overload!"); + * // Custom color coding. + * var cyan = "\u001b[36m"; + * var green = "\u001b[32m"; + * var red = "\u001b[31m"; + * var reset = "\u001b[0m"; + * var msgError = red + "Ugh! What a mess." + reset; + * var msgSuccess = green + "Well done!" + reset; + * var msgMixed = cyan + "ERROR Should this be in red?" + reset; + * print(msgError); + * print(msgSuccess); + * print(msgMixed); + * tail(); + * ``` + * @example + * ```ts + * // NS2 + * // Default color coding. + * ns.print("ERROR means something's wrong."); + * ns.print("SUCCESS means everything's OK."); + * ns.print("WARN Tread with caution!"); + * ns.print("WARNING, warning, danger, danger!"); + * ns.print("WARNing! Here be dragons."); + * ns.print("INFO for your I's only (FYI)."); + * ns.print("INFOrmation overload!"); + * // Custom color coding. + * const cyan = "\u001b[36m"; + * const green = "\u001b[32m"; + * const red = "\u001b[31m"; + * const reset = "\u001b[0m"; + * const msgError = "Ugh! What a mess."; + * const msgSuccess = "Well done!"; + * const msgMixed = "ERROR Should this be in red?"; + * ns.print(`${red + msgError + reset}`); + * ns.print(`${green + msgSuccess + reset}`); + * ns.print(`${cyan + msgMixed + reset}`); + * ns.tail(); + * ``` + * * @param args - Value(s) to be printed. */ print(...args: any[]): void; @@ -3107,8 +3144,38 @@ export declare interface NS { * @remarks * RAM cost: 0 GB * - * see: https://github.com/alexei/sprintf.js - * @param format - format of the message + * - See {@link NS.print | print} for how to add color to your printed strings. + * + * - For more detail, see: https://github.com/alexei/sprintf.js + * + * @example + * ```ts + * // NS1 + * var name = "Bit"; + * var age = 4; + * printf("My name is %s.", name); + * printf("I'm %d seconds old.", age); + * printf("My age in binary is %b.", age); + * printf("My age in scientific notation is %e.", age); + * printf("In %d seconds, I'll be %s.", 6, "Byte"); + * printf("Am I a nibble? %t", (4 == age)); + * tail(); + * ``` + * @example + * ```ts + * // NS2 + * const name = "Bit"; + * const age = 4; + * ns.printf("My name is %s.", name); + * ns.printf("I'm %d seconds old.", age); + * ns.printf("My age in binary is %b.", age); + * ns.printf("My age in scientific notation is %e.", age); + * ns.printf("In %d seconds, I'll be %s.", 6, "Byte"); + * ns.printf("Am I a nibble? %t", (4 == age)); + * ns.tail(); + * ``` + * + * @param format - Format of the message. * @param args - Value(s) to be printed. */ printf(format: string, ...args: any[]): void; @@ -3118,6 +3185,8 @@ export declare interface NS { * @remarks * RAM cost: 0 GB * + * See {@link NS.print | print} for how to add color to your printed strings. + * * @param args - Value(s) to be printed. */ tprint(...args: any[]): void; @@ -3127,9 +3196,14 @@ export declare interface NS { * @remarks * RAM cost: 0 GB * - * see: https://github.com/alexei/sprintf.js - * @param format - format of the message - * @param msg - Value to be printed. + * - See {@link NS.print | print} for how to add color to your printed strings. + * + * - See {@link NS.printf | printf} for examples on formatted strings. + * + * - For more detail, see: https://github.com/alexei/sprintf.js + * + * @param format - Format of the message. + * @param values - Value(s) to be printed. */ tprintf(format: string, ...values: any[]): void; @@ -3519,10 +3593,10 @@ export declare interface NS { * @remarks * RAM cost: 1.3 GB * - * Run a script as a separate process on a specified server. This is similar to the run function + * Run a script as a separate process on a specified server. This is similar to the function {@link NS.run | run} * except that it can be used to run a script on any server, instead of just the current server. * - * If the script was successfully started, then this functions returns the PID of that script. + * If the script was successfully started, then this function returns the PID of that script. * Otherwise, it returns 0. * * PID stands for Process ID. The PID is a unique identifier for each script. @@ -3533,30 +3607,40 @@ export declare interface NS { * @example * ```ts * // NS1: - * //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server: + * // The simplest way to use the exec command is to call it with just the script name + * // and the target server. The following example will try to run generic-hack.script + * // on the foodnstuff server. * exec("generic-hack.script", "foodnstuff"); * - * //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads: + * // The following example will try to run the script generic-hack.script on the + * // joesguns server with 10 threads. * exec("generic-hack.script", "joesguns", 10); * - * //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script: + * // This last example will try to run the script foo.script on the foodnstuff server + * // with 5 threads. It will also pass the number 1 and the string “test” in as + * // arguments to the script. * exec("foo.script", "foodnstuff", 5, 1, "test"); * ``` - * * @example + * @example * ```ts * // NS2: - * //The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server: + * // The simplest way to use the exec command is to call it with just the script name + * // and the target server. The following example will try to run generic-hack.script + * // on the foodnstuff server. * ns.exec("generic-hack.script", "foodnstuff"); * - * //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads: + * // The following example will try to run the script generic-hack.script on the + * // joesguns server with 10 threads. * ns.exec("generic-hack.script", "joesguns", 10); * - * //This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script: + * // This last example will try to run the script foo.script on the foodnstuff server + * // with 5 threads. It will also pass the number 1 and the string “test” in as + * // arguments to the script. * ns.exec("foo.script", "foodnstuff", 5, 1, "test"); * ``` * @param script - Filename of script to execute. * @param host - Hostname of the `target server` on which to execute the script. - * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. + * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded down to the nearest integer. * @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value. * @returns Returns the PID of a successfully started script, and 0 otherwise. */ @@ -4222,6 +4306,39 @@ export declare interface NS { */ purchaseServer(hostname: string, ram: number): string; + /** + * Get cost of upgrading a purchased server to the given ram. + * @remarks + * RAM cost: 0.1 GB + * + * @param hostname - Hostname of the server to upgrade. + * @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + * @returns The price to upgrade. + */ + getPurchasedServerUpgradeCost(hostname: string, ram: number): number; + + /** + * Upgrade a purchased servers ram. + * @remarks + * RAM cost: 0.25 GB + * + * @param hostname - Hostname of the server to upgrade. + * @param ram - Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + * @returns True if the upgrade succeeded. + */ + upgradePurchasedServer(hostname: string, ram: number): boolean; + + /** + * Rename a purchased server. + * @remarks + * RAM cost: 2.00 GB + * + * @param hostname - current server hostname + * @param newName - new server hostname + * @returns True if the upgrade succeeded. + */ + renamePurchasedServer(hostname: string, newName: string): boolean; + /** * Delete a purchased server. * @remarks @@ -4295,7 +4412,7 @@ export declare interface NS { * @param data - Data to write. * @returns True if the data is successfully written to the port, and false otherwise. */ - tryWritePort(port: number, data: string | number): Promise; + tryWritePort(port: number, data: string | number): boolean; /** * Read content of a file. @@ -4342,7 +4459,7 @@ export declare interface NS { * @remarks * RAM cost: 0 GB * - * Deleta all data from the underlying queue. + * Delete all data from the underlying queue. * * @param handle - Port to clear. */ @@ -4584,8 +4701,8 @@ export declare interface NS { * * see: https://github.com/alexei/sprintf.js * @param format - String to format. - * @param args - Formating arguments. - * @returns Formated text. + * @param args - Formatting arguments. + * @returns Formatted text. */ sprintf(format: string, ...args: any[]): string; @@ -4596,8 +4713,8 @@ export declare interface NS { * * see: https://github.com/alexei/sprintf.js * @param format - String to format. - * @param args - Formating arguments. - * @returns Formated text. + * @param args - Formatting arguments. + * @returns Formatted text. */ vsprintf(format: string, args: any[]): string; @@ -4607,13 +4724,13 @@ export declare interface NS { * RAM cost: 0 GB * * Converts a number into a string with the specified formatter. - * This uses the numeraljs library, so the formatters must be compatible with that. + * This uses the numeral.js library, so the formatters must be compatible with that. * This is the same function that the game itself uses to display numbers. * * see: http://numeraljs.com/ * @param n - Number to format. * @param format - Formatter. - * @returns Formated number. + * @returns Formatted number. */ nFormat(n: number, format: string): string; @@ -4661,7 +4778,7 @@ export declare interface NS { * @param variant - Type of toast, must be one of success, info, warning, error. Defaults to success. * @param duration - Duration of toast in ms. Can also be `null` to create a persistent toast. Defaults to 2000 */ - toast(msg: string, variant?: ToastVariantValues, duration?: number | null): void; + toast(msg: string, variant?: ToastVariant, duration?: number | null): void; /** * Download a file from the internet. @@ -4850,9 +4967,7 @@ export declare interface NS { } /** @public */ -export declare interface NSEnums { - toast: typeof ToastVariant; -} +export declare type NSEnums = typeof enums; /** * Office for a division in a city. @@ -4886,7 +5001,7 @@ export declare interface Office { /** * Corporation Office API * @remarks - * Requires the Office API upgrade from your corporation. + * requires the Office API upgrade from your corporation. * @public */ export declare interface OfficeAPI { @@ -4998,9 +5113,7 @@ export declare interface OfficeAPI { getOfficeSizeUpgradeCost(divisionName: string, cityName: string, asize: number): number; } -/** - * @public - */ +/** @public */ export declare enum OrderTypes { LimitBuy = "Limit Buy Order", LimitSell = "Limit Sell Order", @@ -5008,9 +5121,7 @@ export declare enum OrderTypes { StopSell = "Stop Sell Order", } -/** - * @public - */ +/** @public */ export declare interface Player { hp: HP; skills: Skills; @@ -5032,22 +5143,16 @@ export declare interface Player { entropy: number; } -/** - * @public - */ +/** @public */ export declare type PortData = string | number; -/** - * @public - */ +/** @public */ export declare enum PositionTypes { Long = "L", Short = "S", } -/** - * @public - */ +/** @public */ export declare interface PossibleInfiltrationLocation { city: string; name: string; @@ -5095,9 +5200,7 @@ export declare interface Product { developmentProgress: number; } -/** - * @public - */ +/** @public */ export declare interface RecentScript extends RunningScript { /** Timestamp of when the script was killed */ timeOfDeath: Date; @@ -5130,9 +5233,7 @@ export declare interface ReputationFormulas { repFromDonation(amount: number, player: Player): number; } -/** - * @public - */ +/** @public */ export declare interface RunningScript { /** Arguments the script was called with */ args: (string | number | boolean)[]; @@ -5165,9 +5266,7 @@ export declare interface RunningScript { threads: number; } -/** - * @public - */ +/** @public */ export declare type ScriptArg = string | number | boolean; /** @@ -5602,9 +5701,9 @@ export declare interface Singularity { * RAM cost: 3 GB * 16/4/1 * * - * Returns an array with the name of all Factions you currently have oustanding invitations from. + * Returns an array with the name of all Factions you currently have outstanding invitations from. * - * @returns Array with the name of all Factions you currently have oustanding invitations from. + * @returns Array with the name of all Factions you currently have outstanding invitations from. */ checkFactionInvitations(): string[]; @@ -5794,10 +5893,10 @@ export declare interface Singularity { * RAM cost: 5 GB * 16/4/1 * * - * This function returns your chance of success at commiting the specified crime. + * This function returns your chance of success at committing the specified crime. * * @param crime - Name of crime. - * @returns Chance of success at commiting the specified crime. + * @returns Chance of success at committing the specified crime. */ getCrimeChance(crime: string): number; @@ -5946,7 +6045,7 @@ export declare interface Singularity { * @param name - Name of Augmentation. CASE-SENSITIVE. * @returns Augmentation stats. */ - getAugmentationStats(name: string): AugmentationStats; + getAugmentationStats(name: string): Multipliers; /** * Install your purchased augmentations. @@ -6148,9 +6247,7 @@ export declare interface Singularity { getCurrentWork(): any | null; } -/** - * @public - */ +/** @public */ export declare interface Skills { hacking: number; strength: number; @@ -6269,7 +6366,7 @@ export declare interface Sleeve { * * Returns false if an invalid action is specified. * - * @param sleeveNumber - Index of the sleeve to start commiting crime. + * @param sleeveNumber - Index of the sleeve to start committing crime. * @param name - Name of the crime. Must be an exact match. * @returns True if this action was set successfully, false otherwise. */ @@ -6467,9 +6564,7 @@ export declare interface SleeveSkills { */ export declare type SleeveTask = any; -/** - * @public - */ +/** @public */ export declare interface SleeveWorkGains { /** Hacking exp gained from work */ workHackExpGain: number; @@ -6487,9 +6582,7 @@ export declare interface SleeveWorkGains { workMoneyGain: number; } -/** - * @public - */ +/** @public */ export declare interface SourceFileLvl { /** The number of the source file */ n: number; @@ -6668,21 +6761,39 @@ export declare interface TIX { getSymbols(): string[]; /** - * Returns the price of a stock + * Returns the price of a stock. * * @remarks * RAM cost: 2 GB - * The stock’s price is the average of its bid and ask price. + * + * The stock’s price is the average of its bid and ask prices. This function requires + * that you have the following: + * + * 1. WSE Account + * + * 1. TIX API Access * * @example * ```ts * // NS1 - * stock.getPrice("FISG"); + * stock.getPrice("FSIG"); + * + * // Choose the first stock symbol from the array of stock symbols. Get the price + * // of the corresponding stock. + * var sym = stock.getSymbols()[0]; + * tprint("Stock symbol: " + sym); + * tprint("Stock price: " + stock.getPrice(sym)); * ``` * @example * ```ts * // NS2 - * ns.stock.getPrice("FISG"); + * ns.stock.getPrice("FSIG"); + * + * // Choose the first stock symbol from the array of stock symbols. Get the price + * // of the corresponding stock. + * const sym = ns.stock.getSymbols()[0]; + * ns.tprint("Stock symbol: " + sym); + * ns.tprint("Stock price: " + ns.stock.getPrice(sym)); * ``` * @param sym - Stock symbol. * @returns The price of a stock. @@ -6893,7 +7004,7 @@ export declare interface TIX { * Cancel order for stocks. * @remarks * RAM cost: 2.5 GB - * Cancels an oustanding Limit or Stop order on the stock market. + * Cancels an outstanding Limit or Stop order on the stock market. * * The ability to use limit and stop orders is **not** immediately available to the player and * must be unlocked later on in the game. @@ -7032,15 +7143,7 @@ export declare interface TIX { } /** @public */ -export declare enum ToastVariant { - SUCCESS = "success", - WARNING = "warning", - ERROR = "error", - INFO = "info", -} - -/** @public */ -export declare type ToastVariantValues = `${ToastVariant}`; +export declare type ToastVariant = ValuesFrom; /** * User Interface API. @@ -7172,6 +7275,9 @@ export declare interface UserInterfaceTheme { button: string; } +/** @internal */ +export declare type ValuesFrom = T[keyof T]; + /** * Warehouse for a division in a city * @public @@ -7418,9 +7524,7 @@ export declare interface WorkFormulas { factionGains(player: Player, workType: string, favor: number): WorkStats; } -/** - * @public - */ +/** @public */ export declare interface WorkStats { money: number; reputation: number; diff --git a/markdown/bitburner.augmentationstats.agility.md b/markdown/bitburner.augmentationstats.agility.md deleted file mode 100644 index 047ee5268..000000000 --- a/markdown/bitburner.augmentationstats.agility.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [agility](./bitburner.augmentationstats.agility.md) - -## AugmentationStats.agility property - -Multiplier to agility skill - -Signature: - -```typescript -agility?: number; -``` diff --git a/markdown/bitburner.augmentationstats.agility_exp.md b/markdown/bitburner.augmentationstats.agility_exp.md deleted file mode 100644 index fe7b1b766..000000000 --- a/markdown/bitburner.augmentationstats.agility_exp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [agility\_exp](./bitburner.augmentationstats.agility_exp.md) - -## AugmentationStats.agility\_exp property - -Multiplier to agility experience gain rate - -Signature: - -```typescript -agility_exp?: number; -``` diff --git a/markdown/bitburner.augmentationstats.bladeburner_analysis.md b/markdown/bitburner.augmentationstats.bladeburner_analysis.md deleted file mode 100644 index 74a87898f..000000000 --- a/markdown/bitburner.augmentationstats.bladeburner_analysis.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [bladeburner\_analysis](./bitburner.augmentationstats.bladeburner_analysis.md) - -## AugmentationStats.bladeburner\_analysis property - -Multiplier to effectiveness in Bladeburner Field Analysis - -Signature: - -```typescript -bladeburner_analysis?: number; -``` diff --git a/markdown/bitburner.augmentationstats.bladeburner_max_stamina.md b/markdown/bitburner.augmentationstats.bladeburner_max_stamina.md deleted file mode 100644 index 800f64aa3..000000000 --- a/markdown/bitburner.augmentationstats.bladeburner_max_stamina.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [bladeburner\_max\_stamina](./bitburner.augmentationstats.bladeburner_max_stamina.md) - -## AugmentationStats.bladeburner\_max\_stamina property - -Multiplier to Bladeburner max stamina - -Signature: - -```typescript -bladeburner_max_stamina?: number; -``` diff --git a/markdown/bitburner.augmentationstats.bladeburner_stamina_gain.md b/markdown/bitburner.augmentationstats.bladeburner_stamina_gain.md deleted file mode 100644 index b2d7f67a1..000000000 --- a/markdown/bitburner.augmentationstats.bladeburner_stamina_gain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [bladeburner\_stamina\_gain](./bitburner.augmentationstats.bladeburner_stamina_gain.md) - -## AugmentationStats.bladeburner\_stamina\_gain property - -Multiplier to Bladeburner stamina gain rate - -Signature: - -```typescript -bladeburner_stamina_gain?: number; -``` diff --git a/markdown/bitburner.augmentationstats.bladeburner_success_chance.md b/markdown/bitburner.augmentationstats.bladeburner_success_chance.md deleted file mode 100644 index d05cd6d3d..000000000 --- a/markdown/bitburner.augmentationstats.bladeburner_success_chance.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [bladeburner\_success\_chance](./bitburner.augmentationstats.bladeburner_success_chance.md) - -## AugmentationStats.bladeburner\_success\_chance property - -Multiplier to success chance in Bladeburner contracts/operations - -Signature: - -```typescript -bladeburner_success_chance?: number; -``` diff --git a/markdown/bitburner.augmentationstats.charisma.md b/markdown/bitburner.augmentationstats.charisma.md deleted file mode 100644 index 3d8a52745..000000000 --- a/markdown/bitburner.augmentationstats.charisma.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [charisma](./bitburner.augmentationstats.charisma.md) - -## AugmentationStats.charisma property - -Multiplier to charisma skill - -Signature: - -```typescript -charisma?: number; -``` diff --git a/markdown/bitburner.augmentationstats.charisma_exp.md b/markdown/bitburner.augmentationstats.charisma_exp.md deleted file mode 100644 index 26074c5c6..000000000 --- a/markdown/bitburner.augmentationstats.charisma_exp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [charisma\_exp](./bitburner.augmentationstats.charisma_exp.md) - -## AugmentationStats.charisma\_exp property - -Multiplier to charisma experience gain rate - -Signature: - -```typescript -charisma_exp?: number; -``` diff --git a/markdown/bitburner.augmentationstats.company_rep.md b/markdown/bitburner.augmentationstats.company_rep.md deleted file mode 100644 index 665e966ce..000000000 --- a/markdown/bitburner.augmentationstats.company_rep.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [company\_rep](./bitburner.augmentationstats.company_rep.md) - -## AugmentationStats.company\_rep property - -Multiplier to amount of reputation gained when working - -Signature: - -```typescript -company_rep?: number; -``` diff --git a/markdown/bitburner.augmentationstats.crime_money.md b/markdown/bitburner.augmentationstats.crime_money.md deleted file mode 100644 index 71c89ee36..000000000 --- a/markdown/bitburner.augmentationstats.crime_money.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [crime\_money](./bitburner.augmentationstats.crime_money.md) - -## AugmentationStats.crime\_money property - -Multiplier to amount of money gained from crimes - -Signature: - -```typescript -crime_money?: number; -``` diff --git a/markdown/bitburner.augmentationstats.crime_success.md b/markdown/bitburner.augmentationstats.crime_success.md deleted file mode 100644 index 1b828440e..000000000 --- a/markdown/bitburner.augmentationstats.crime_success.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [crime\_success](./bitburner.augmentationstats.crime_success.md) - -## AugmentationStats.crime\_success property - -Multiplier to crime success rate - -Signature: - -```typescript -crime_success?: number; -``` diff --git a/markdown/bitburner.augmentationstats.defense.md b/markdown/bitburner.augmentationstats.defense.md deleted file mode 100644 index 299ac4ae2..000000000 --- a/markdown/bitburner.augmentationstats.defense.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [defense](./bitburner.augmentationstats.defense.md) - -## AugmentationStats.defense property - -Multiplier to defense skill - -Signature: - -```typescript -defense?: number; -``` diff --git a/markdown/bitburner.augmentationstats.defense_exp.md b/markdown/bitburner.augmentationstats.defense_exp.md deleted file mode 100644 index 20a58d517..000000000 --- a/markdown/bitburner.augmentationstats.defense_exp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [defense\_exp](./bitburner.augmentationstats.defense_exp.md) - -## AugmentationStats.defense\_exp property - -Multiplier to defense experience gain rate - -Signature: - -```typescript -defense_exp?: number; -``` diff --git a/markdown/bitburner.augmentationstats.dexterity.md b/markdown/bitburner.augmentationstats.dexterity.md deleted file mode 100644 index 5e73869c2..000000000 --- a/markdown/bitburner.augmentationstats.dexterity.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [dexterity](./bitburner.augmentationstats.dexterity.md) - -## AugmentationStats.dexterity property - -Multiplier to dexterity skill - -Signature: - -```typescript -dexterity?: number; -``` diff --git a/markdown/bitburner.augmentationstats.dexterity_exp.md b/markdown/bitburner.augmentationstats.dexterity_exp.md deleted file mode 100644 index faadfa31e..000000000 --- a/markdown/bitburner.augmentationstats.dexterity_exp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [dexterity\_exp](./bitburner.augmentationstats.dexterity_exp.md) - -## AugmentationStats.dexterity\_exp property - -Multiplier to dexterity experience gain rate - -Signature: - -```typescript -dexterity_exp?: number; -``` diff --git a/markdown/bitburner.augmentationstats.faction_rep.md b/markdown/bitburner.augmentationstats.faction_rep.md deleted file mode 100644 index 5b03232f4..000000000 --- a/markdown/bitburner.augmentationstats.faction_rep.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [faction\_rep](./bitburner.augmentationstats.faction_rep.md) - -## AugmentationStats.faction\_rep property - -Multiplier to amount of reputation gained when working - -Signature: - -```typescript -faction_rep?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacking.md b/markdown/bitburner.augmentationstats.hacking.md deleted file mode 100644 index 65cca2900..000000000 --- a/markdown/bitburner.augmentationstats.hacking.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking](./bitburner.augmentationstats.hacking.md) - -## AugmentationStats.hacking property - -Multiplier to hacking skill - -Signature: - -```typescript -hacking?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacking_chance.md b/markdown/bitburner.augmentationstats.hacking_chance.md deleted file mode 100644 index 210967842..000000000 --- a/markdown/bitburner.augmentationstats.hacking_chance.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_chance](./bitburner.augmentationstats.hacking_chance.md) - -## AugmentationStats.hacking\_chance property - -Multiplier to chance of successfully performing a hack - -Signature: - -```typescript -hacking_chance?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacking_exp.md b/markdown/bitburner.augmentationstats.hacking_exp.md deleted file mode 100644 index efb25e8ee..000000000 --- a/markdown/bitburner.augmentationstats.hacking_exp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_exp](./bitburner.augmentationstats.hacking_exp.md) - -## AugmentationStats.hacking\_exp property - -Multiplier to hacking experience gain rate - -Signature: - -```typescript -hacking_exp?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacking_grow.md b/markdown/bitburner.augmentationstats.hacking_grow.md deleted file mode 100644 index 9ce638ae5..000000000 --- a/markdown/bitburner.augmentationstats.hacking_grow.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_grow](./bitburner.augmentationstats.hacking_grow.md) - -## AugmentationStats.hacking\_grow property - -Multiplier to amount of money injected into servers using grow - -Signature: - -```typescript -hacking_grow?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacking_money.md b/markdown/bitburner.augmentationstats.hacking_money.md deleted file mode 100644 index d54fbbe71..000000000 --- a/markdown/bitburner.augmentationstats.hacking_money.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_money](./bitburner.augmentationstats.hacking_money.md) - -## AugmentationStats.hacking\_money property - -Multiplier to amount of money the player gains from hacking - -Signature: - -```typescript -hacking_money?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacking_speed.md b/markdown/bitburner.augmentationstats.hacking_speed.md deleted file mode 100644 index a2ed8f931..000000000 --- a/markdown/bitburner.augmentationstats.hacking_speed.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_speed](./bitburner.augmentationstats.hacking_speed.md) - -## AugmentationStats.hacking\_speed property - -Multiplier to hacking speed - -Signature: - -```typescript -hacking_speed?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_core_cost.md b/markdown/bitburner.augmentationstats.hacknet_node_core_cost.md deleted file mode 100644 index 9e58c4d8a..000000000 --- a/markdown/bitburner.augmentationstats.hacknet_node_core_cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_core\_cost](./bitburner.augmentationstats.hacknet_node_core_cost.md) - -## AugmentationStats.hacknet\_node\_core\_cost property - -Multiplier to cost of core for a Hacknet Node - -Signature: - -```typescript -hacknet_node_core_cost?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_level_cost.md b/markdown/bitburner.augmentationstats.hacknet_node_level_cost.md deleted file mode 100644 index 1210b1c57..000000000 --- a/markdown/bitburner.augmentationstats.hacknet_node_level_cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_level\_cost](./bitburner.augmentationstats.hacknet_node_level_cost.md) - -## AugmentationStats.hacknet\_node\_level\_cost property - -Multiplier to cost of leveling up a Hacknet Node - -Signature: - -```typescript -hacknet_node_level_cost?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_money.md b/markdown/bitburner.augmentationstats.hacknet_node_money.md deleted file mode 100644 index 7f247a23a..000000000 --- a/markdown/bitburner.augmentationstats.hacknet_node_money.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_money](./bitburner.augmentationstats.hacknet_node_money.md) - -## AugmentationStats.hacknet\_node\_money property - -Multiplier to amount of money produced by Hacknet Nodes - -Signature: - -```typescript -hacknet_node_money?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost.md b/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost.md deleted file mode 100644 index ecc12d16e..000000000 --- a/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_purchase\_cost](./bitburner.augmentationstats.hacknet_node_purchase_cost.md) - -## AugmentationStats.hacknet\_node\_purchase\_cost property - -Multiplier to cost of purchasing a Hacknet Node - -Signature: - -```typescript -hacknet_node_purchase_cost?: number; -``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_ram_cost.md b/markdown/bitburner.augmentationstats.hacknet_node_ram_cost.md deleted file mode 100644 index 74634238e..000000000 --- a/markdown/bitburner.augmentationstats.hacknet_node_ram_cost.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_ram\_cost](./bitburner.augmentationstats.hacknet_node_ram_cost.md) - -## AugmentationStats.hacknet\_node\_ram\_cost property - -Multiplier to cost of ram for a Hacknet Node - -Signature: - -```typescript -hacknet_node_ram_cost?: number; -``` diff --git a/markdown/bitburner.augmentationstats.md b/markdown/bitburner.augmentationstats.md deleted file mode 100644 index 36c16c1d1..000000000 --- a/markdown/bitburner.augmentationstats.md +++ /dev/null @@ -1,49 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) - -## AugmentationStats interface - -Data representing the internal values of an Augmentation. - -Signature: - -```typescript -export interface AugmentationStats -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [agility\_exp?](./bitburner.augmentationstats.agility_exp.md) | number | (Optional) Multiplier to agility experience gain rate | -| [agility?](./bitburner.augmentationstats.agility.md) | number | (Optional) Multiplier to agility skill | -| [bladeburner\_analysis?](./bitburner.augmentationstats.bladeburner_analysis.md) | number | (Optional) Multiplier to effectiveness in Bladeburner Field Analysis | -| [bladeburner\_max\_stamina?](./bitburner.augmentationstats.bladeburner_max_stamina.md) | number | (Optional) Multiplier to Bladeburner max stamina | -| [bladeburner\_stamina\_gain?](./bitburner.augmentationstats.bladeburner_stamina_gain.md) | number | (Optional) Multiplier to Bladeburner stamina gain rate | -| [bladeburner\_success\_chance?](./bitburner.augmentationstats.bladeburner_success_chance.md) | number | (Optional) Multiplier to success chance in Bladeburner contracts/operations | -| [charisma\_exp?](./bitburner.augmentationstats.charisma_exp.md) | number | (Optional) Multiplier to charisma experience gain rate | -| [charisma?](./bitburner.augmentationstats.charisma.md) | number | (Optional) Multiplier to charisma skill | -| [company\_rep?](./bitburner.augmentationstats.company_rep.md) | number | (Optional) Multiplier to amount of reputation gained when working | -| [crime\_money?](./bitburner.augmentationstats.crime_money.md) | number | (Optional) Multiplier to amount of money gained from crimes | -| [crime\_success?](./bitburner.augmentationstats.crime_success.md) | number | (Optional) Multiplier to crime success rate | -| [defense\_exp?](./bitburner.augmentationstats.defense_exp.md) | number | (Optional) Multiplier to defense experience gain rate | -| [defense?](./bitburner.augmentationstats.defense.md) | number | (Optional) Multiplier to defense skill | -| [dexterity\_exp?](./bitburner.augmentationstats.dexterity_exp.md) | number | (Optional) Multiplier to dexterity experience gain rate | -| [dexterity?](./bitburner.augmentationstats.dexterity.md) | number | (Optional) Multiplier to dexterity skill | -| [faction\_rep?](./bitburner.augmentationstats.faction_rep.md) | number | (Optional) Multiplier to amount of reputation gained when working | -| [hacking\_chance?](./bitburner.augmentationstats.hacking_chance.md) | number | (Optional) Multiplier to chance of successfully performing a hack | -| [hacking\_exp?](./bitburner.augmentationstats.hacking_exp.md) | number | (Optional) Multiplier to hacking experience gain rate | -| [hacking\_grow?](./bitburner.augmentationstats.hacking_grow.md) | number | (Optional) Multiplier to amount of money injected into servers using grow | -| [hacking\_money?](./bitburner.augmentationstats.hacking_money.md) | number | (Optional) Multiplier to amount of money the player gains from hacking | -| [hacking\_speed?](./bitburner.augmentationstats.hacking_speed.md) | number | (Optional) Multiplier to hacking speed | -| [hacking?](./bitburner.augmentationstats.hacking.md) | number | (Optional) Multiplier to hacking skill | -| [hacknet\_node\_core\_cost?](./bitburner.augmentationstats.hacknet_node_core_cost.md) | number | (Optional) Multiplier to cost of core for a Hacknet Node | -| [hacknet\_node\_level\_cost?](./bitburner.augmentationstats.hacknet_node_level_cost.md) | number | (Optional) Multiplier to cost of leveling up a Hacknet Node | -| [hacknet\_node\_money?](./bitburner.augmentationstats.hacknet_node_money.md) | number | (Optional) Multiplier to amount of money produced by Hacknet Nodes | -| [hacknet\_node\_purchase\_cost?](./bitburner.augmentationstats.hacknet_node_purchase_cost.md) | number | (Optional) Multiplier to cost of purchasing a Hacknet Node | -| [hacknet\_node\_ram\_cost?](./bitburner.augmentationstats.hacknet_node_ram_cost.md) | number | (Optional) Multiplier to cost of ram for a Hacknet Node | -| [strength\_exp?](./bitburner.augmentationstats.strength_exp.md) | number | (Optional) Multiplier to strength experience gain rate | -| [strength?](./bitburner.augmentationstats.strength.md) | number | (Optional) Multiplier to strength skill | -| [work\_money?](./bitburner.augmentationstats.work_money.md) | number | (Optional) Multiplier to amount of money gained from working | - diff --git a/markdown/bitburner.augmentationstats.strength.md b/markdown/bitburner.augmentationstats.strength.md deleted file mode 100644 index e2b6e3060..000000000 --- a/markdown/bitburner.augmentationstats.strength.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [strength](./bitburner.augmentationstats.strength.md) - -## AugmentationStats.strength property - -Multiplier to strength skill - -Signature: - -```typescript -strength?: number; -``` diff --git a/markdown/bitburner.augmentationstats.strength_exp.md b/markdown/bitburner.augmentationstats.strength_exp.md deleted file mode 100644 index 7669231d6..000000000 --- a/markdown/bitburner.augmentationstats.strength_exp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [strength\_exp](./bitburner.augmentationstats.strength_exp.md) - -## AugmentationStats.strength\_exp property - -Multiplier to strength experience gain rate - -Signature: - -```typescript -strength_exp?: number; -``` diff --git a/markdown/bitburner.augmentationstats.work_money.md b/markdown/bitburner.augmentationstats.work_money.md deleted file mode 100644 index 92a35e08e..000000000 --- a/markdown/bitburner.augmentationstats.work_money.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [work\_money](./bitburner.augmentationstats.work_money.md) - -## AugmentationStats.work\_money property - -Multiplier to amount of money gained from working - -Signature: - -```typescript -work_money?: number; -``` diff --git a/markdown/bitburner.codingcontract.createdummycontract.md b/markdown/bitburner.codingcontract.createdummycontract.md new file mode 100644 index 000000000..3b8520779 --- /dev/null +++ b/markdown/bitburner.codingcontract.createdummycontract.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [createDummyContract](./bitburner.codingcontract.createdummycontract.md) + +## CodingContract.createDummyContract() method + +Generate a dummy contract. + +Signature: + +```typescript +createDummyContract(type: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | string | Type of contract to generate | + +Returns: + +void + +## Remarks + +RAM cost: 2 GB + +Generate a dummy contract on the home computer with no reward. Used to test various algorithms. + diff --git a/markdown/bitburner.codingcontract.getcontracttypes.md b/markdown/bitburner.codingcontract.getcontracttypes.md new file mode 100644 index 000000000..c688b7b96 --- /dev/null +++ b/markdown/bitburner.codingcontract.getcontracttypes.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getContractTypes](./bitburner.codingcontract.getcontracttypes.md) + +## CodingContract.getContractTypes() method + +List all contract types. + +Signature: + +```typescript +getContractTypes(): string[]; +``` +Returns: + +string\[\] + +## Remarks + +RAM cost: 2 GB + diff --git a/markdown/bitburner.codingcontract.md b/markdown/bitburner.codingcontract.md index 163c1da51..1f1bf1ed3 100644 --- a/markdown/bitburner.codingcontract.md +++ b/markdown/bitburner.codingcontract.md @@ -17,7 +17,9 @@ export interface CodingContract | Method | Description | | --- | --- | | [attempt(answer, filename, host, opts)](./bitburner.codingcontract.attempt.md) | Attempts a coding contract. | +| [createDummyContract(type)](./bitburner.codingcontract.createdummycontract.md) | Generate a dummy contract. | | [getContractType(filename, host)](./bitburner.codingcontract.getcontracttype.md) | Get the type of a coding contract. | +| [getContractTypes()](./bitburner.codingcontract.getcontracttypes.md) | List all contract types. | | [getData(filename, host)](./bitburner.codingcontract.getdata.md) | Get the input data. | | [getDescription(filename, host)](./bitburner.codingcontract.getdescription.md) | Get the description. | | [getNumTriesRemaining(filename, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of attempts remaining. | diff --git a/markdown/bitburner.corporationinfo.issuedshares.md b/markdown/bitburner.corporationinfo.issuedshares.md index 4d995773c..2ad061a78 100644 --- a/markdown/bitburner.corporationinfo.issuedshares.md +++ b/markdown/bitburner.corporationinfo.issuedshares.md @@ -4,7 +4,7 @@ ## CorporationInfo.issuedShares property -Amount of aqcuirable shares. +Amount of acquirable shares. Signature: diff --git a/markdown/bitburner.corporationinfo.md b/markdown/bitburner.corporationinfo.md index 90530ff78..5f61a9567 100644 --- a/markdown/bitburner.corporationinfo.md +++ b/markdown/bitburner.corporationinfo.md @@ -22,7 +22,7 @@ interface CorporationInfo | [divisions](./bitburner.corporationinfo.divisions.md) | [Division](./bitburner.division.md)\[\] | Array of all divisions | | [expenses](./bitburner.corporationinfo.expenses.md) | number | Expenses per second this cycle | | [funds](./bitburner.corporationinfo.funds.md) | number | Funds available | -| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | Amount of aqcuirable shares. | +| [issuedShares](./bitburner.corporationinfo.issuedshares.md) | number | Amount of acquirable shares. | | [name](./bitburner.corporationinfo.name.md) | string | Name of the corporation | | [numShares](./bitburner.corporationinfo.numshares.md) | number | Amount of share owned | | [public](./bitburner.corporationinfo.public.md) | boolean | Indicating if the company is public | diff --git a/markdown/bitburner.hacknet.spendhashes.md b/markdown/bitburner.hacknet.spendhashes.md index be554b37c..c71f063a4 100644 --- a/markdown/bitburner.hacknet.spendhashes.md +++ b/markdown/bitburner.hacknet.spendhashes.md @@ -18,7 +18,7 @@ spendHashes(upgName: string, upgTarget?: string, count?: number): boolean; | --- | --- | --- | | upgName | string | Name of the upgrade of Hacknet Node. | | upgTarget | string | Object to which upgrade applies. Required for certain upgrades. | -| count | number | Number of upgrades to buy at once. Defaults to 1 if not specified. For compatability reasons, upgTarget must be specified, even if it is not used, in order to specify count. | +| count | number | Number of upgrades to buy at once. Defaults to 1 if not specified. For compatibility reasons, upgTarget must be specified, even if it is not used, in order to specify count. | Returns: diff --git a/markdown/bitburner.hacknetnodeconstants.md b/markdown/bitburner.hacknetnodeconstants.md index 427c5b089..92febb288 100644 --- a/markdown/bitburner.hacknetnodeconstants.md +++ b/markdown/bitburner.hacknetnodeconstants.md @@ -24,7 +24,7 @@ export interface HacknetNodeConstants | [MaxRam](./bitburner.hacknetnodeconstants.maxram.md) | number | Max amount of RAM in GB | | [MoneyGainPerLevel](./bitburner.hacknetnodeconstants.moneygainperlevel.md) | number | Amount of money gained per level | | [PurchaseNextMult](./bitburner.hacknetnodeconstants.purchasenextmult.md) | number | Multiplier to purchase new node | -| [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) | number | Base cost to incrase RAM | +| [RamBaseCost](./bitburner.hacknetnodeconstants.rambasecost.md) | number | Base cost to increase RAM | | [UpgradeCoreMult](./bitburner.hacknetnodeconstants.upgradecoremult.md) | number | Multiplier to increase cores | | [UpgradeLevelMult](./bitburner.hacknetnodeconstants.upgradelevelmult.md) | number | Multiplier to increase node level | | [UpgradeRamMult](./bitburner.hacknetnodeconstants.upgraderammult.md) | number | Multiplier to increase RAM | diff --git a/markdown/bitburner.hacknetnodeconstants.rambasecost.md b/markdown/bitburner.hacknetnodeconstants.rambasecost.md index 04a5494f1..41e3e4045 100644 --- a/markdown/bitburner.hacknetnodeconstants.rambasecost.md +++ b/markdown/bitburner.hacknetnodeconstants.rambasecost.md @@ -4,7 +4,7 @@ ## HacknetNodeConstants.RamBaseCost property -Base cost to incrase RAM +Base cost to increase RAM Signature: diff --git a/markdown/bitburner.md b/markdown/bitburner.md index dbf2dcbc1..14429b18e 100644 --- a/markdown/bitburner.md +++ b/markdown/bitburner.md @@ -10,14 +10,12 @@ | --- | --- | | [OrderTypes](./bitburner.ordertypes.md) | | | [PositionTypes](./bitburner.positiontypes.md) | | -| [ToastVariant](./bitburner.toastvariant.md) | | ## Interfaces | Interface | Description | | --- | --- | | [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). | @@ -66,7 +64,6 @@ | [NetscriptPort](./bitburner.netscriptport.md) | Object representing a port. A port is a serialized queue. | | [NodeStats](./bitburner.nodestats.md) | Object representing all the values related to a hacknet node. | | [NS](./bitburner.ns.md) | Collection of all functions passed to scripts | -| [NSEnums](./bitburner.nsenums.md) | | | [Office](./bitburner.office.md) | Office for a division in a city. | | [OfficeAPI](./bitburner.officeapi.md) | Corporation Office API | | [Player](./bitburner.player.md) | | @@ -101,8 +98,9 @@ | --- | --- | | [CodingContractData](./bitburner.codingcontractdata.md) | Coding contract data will differ depending on coding contract. | | [FilenameOrPID](./bitburner.filenameorpid.md) | | +| [NSEnums](./bitburner.nsenums.md) | | | [PortData](./bitburner.portdata.md) | | | [ScriptArg](./bitburner.scriptarg.md) | | | [SleeveTask](./bitburner.sleevetask.md) | Object representing a sleeve current task. | -| [ToastVariantValues](./bitburner.toastvariantvalues.md) | | +| [ToastVariant](./bitburner.toastvariant.md) | | diff --git a/markdown/bitburner.multipliers.agility.md b/markdown/bitburner.multipliers.agility.md index 8de4ef688..765b2b389 100644 --- a/markdown/bitburner.multipliers.agility.md +++ b/markdown/bitburner.multipliers.agility.md @@ -4,8 +4,10 @@ ## Multipliers.agility property +Multiplier to agility skill + Signature: ```typescript -agility: number; +agility?: number; ``` diff --git a/markdown/bitburner.multipliers.agility_exp.md b/markdown/bitburner.multipliers.agility_exp.md index 2e33f500f..356a09b92 100644 --- a/markdown/bitburner.multipliers.agility_exp.md +++ b/markdown/bitburner.multipliers.agility_exp.md @@ -4,8 +4,10 @@ ## Multipliers.agility\_exp property +Multiplier to agility experience gain rate + Signature: ```typescript -agility_exp: number; +agility_exp?: number; ``` diff --git a/markdown/bitburner.multipliers.bladeburner_analysis.md b/markdown/bitburner.multipliers.bladeburner_analysis.md index be15c1533..634add122 100644 --- a/markdown/bitburner.multipliers.bladeburner_analysis.md +++ b/markdown/bitburner.multipliers.bladeburner_analysis.md @@ -4,8 +4,10 @@ ## Multipliers.bladeburner\_analysis property +Multiplier to effectiveness in Bladeburner Field Analysis + Signature: ```typescript -bladeburner_analysis: number; +bladeburner_analysis?: number; ``` diff --git a/markdown/bitburner.multipliers.bladeburner_max_stamina.md b/markdown/bitburner.multipliers.bladeburner_max_stamina.md index bfa5ab338..1c1882cd4 100644 --- a/markdown/bitburner.multipliers.bladeburner_max_stamina.md +++ b/markdown/bitburner.multipliers.bladeburner_max_stamina.md @@ -4,8 +4,10 @@ ## Multipliers.bladeburner\_max\_stamina property +Multiplier to Bladeburner max stamina + Signature: ```typescript -bladeburner_max_stamina: number; +bladeburner_max_stamina?: number; ``` diff --git a/markdown/bitburner.multipliers.bladeburner_stamina_gain.md b/markdown/bitburner.multipliers.bladeburner_stamina_gain.md index d857550c9..97f122b64 100644 --- a/markdown/bitburner.multipliers.bladeburner_stamina_gain.md +++ b/markdown/bitburner.multipliers.bladeburner_stamina_gain.md @@ -4,8 +4,10 @@ ## Multipliers.bladeburner\_stamina\_gain property +Multiplier to Bladeburner stamina gain rate + Signature: ```typescript -bladeburner_stamina_gain: number; +bladeburner_stamina_gain?: number; ``` diff --git a/markdown/bitburner.multipliers.bladeburner_success_chance.md b/markdown/bitburner.multipliers.bladeburner_success_chance.md index f51faf926..e53d9a6cd 100644 --- a/markdown/bitburner.multipliers.bladeburner_success_chance.md +++ b/markdown/bitburner.multipliers.bladeburner_success_chance.md @@ -4,8 +4,10 @@ ## Multipliers.bladeburner\_success\_chance property +Multiplier to success chance in Bladeburner contracts/operations + Signature: ```typescript -bladeburner_success_chance: number; +bladeburner_success_chance?: number; ``` diff --git a/markdown/bitburner.multipliers.charisma.md b/markdown/bitburner.multipliers.charisma.md index 001c87402..80b9b90a5 100644 --- a/markdown/bitburner.multipliers.charisma.md +++ b/markdown/bitburner.multipliers.charisma.md @@ -4,8 +4,10 @@ ## Multipliers.charisma property +Multiplier to charisma skill + Signature: ```typescript -charisma: number; +charisma?: number; ``` diff --git a/markdown/bitburner.multipliers.charisma_exp.md b/markdown/bitburner.multipliers.charisma_exp.md index 9e2c9a69a..8e80b5d45 100644 --- a/markdown/bitburner.multipliers.charisma_exp.md +++ b/markdown/bitburner.multipliers.charisma_exp.md @@ -4,8 +4,10 @@ ## Multipliers.charisma\_exp property +Multiplier to charisma experience gain rate + Signature: ```typescript -charisma_exp: number; +charisma_exp?: number; ``` diff --git a/markdown/bitburner.multipliers.company_rep.md b/markdown/bitburner.multipliers.company_rep.md index 432132a82..d49068477 100644 --- a/markdown/bitburner.multipliers.company_rep.md +++ b/markdown/bitburner.multipliers.company_rep.md @@ -4,8 +4,10 @@ ## Multipliers.company\_rep property +Multiplier to amount of reputation gained when working + Signature: ```typescript -company_rep: number; +company_rep?: number; ``` diff --git a/markdown/bitburner.multipliers.crime_money.md b/markdown/bitburner.multipliers.crime_money.md index 38980ddb4..07d5c5145 100644 --- a/markdown/bitburner.multipliers.crime_money.md +++ b/markdown/bitburner.multipliers.crime_money.md @@ -4,8 +4,10 @@ ## Multipliers.crime\_money property +Multiplier to amount of money gained from crimes + Signature: ```typescript -crime_money: number; +crime_money?: number; ``` diff --git a/markdown/bitburner.multipliers.crime_success.md b/markdown/bitburner.multipliers.crime_success.md index 6611590fb..f24feebc1 100644 --- a/markdown/bitburner.multipliers.crime_success.md +++ b/markdown/bitburner.multipliers.crime_success.md @@ -4,8 +4,10 @@ ## Multipliers.crime\_success property +Multiplier to crime success rate + Signature: ```typescript -crime_success: number; +crime_success?: number; ``` diff --git a/markdown/bitburner.multipliers.defense.md b/markdown/bitburner.multipliers.defense.md index d1e2141f3..009d0ff84 100644 --- a/markdown/bitburner.multipliers.defense.md +++ b/markdown/bitburner.multipliers.defense.md @@ -4,8 +4,10 @@ ## Multipliers.defense property +Multiplier to defense skill + Signature: ```typescript -defense: number; +defense?: number; ``` diff --git a/markdown/bitburner.multipliers.defense_exp.md b/markdown/bitburner.multipliers.defense_exp.md index a3db09b5f..b56689287 100644 --- a/markdown/bitburner.multipliers.defense_exp.md +++ b/markdown/bitburner.multipliers.defense_exp.md @@ -4,8 +4,10 @@ ## Multipliers.defense\_exp property +Multiplier to defense experience gain rate + Signature: ```typescript -defense_exp: number; +defense_exp?: number; ``` diff --git a/markdown/bitburner.multipliers.dexterity.md b/markdown/bitburner.multipliers.dexterity.md index ef6b5c9ea..ea6b6eb1d 100644 --- a/markdown/bitburner.multipliers.dexterity.md +++ b/markdown/bitburner.multipliers.dexterity.md @@ -4,8 +4,10 @@ ## Multipliers.dexterity property +Multiplier to dexterity skill + Signature: ```typescript -dexterity: number; +dexterity?: number; ``` diff --git a/markdown/bitburner.multipliers.dexterity_exp.md b/markdown/bitburner.multipliers.dexterity_exp.md index 331adc942..12a60aa4e 100644 --- a/markdown/bitburner.multipliers.dexterity_exp.md +++ b/markdown/bitburner.multipliers.dexterity_exp.md @@ -4,8 +4,10 @@ ## Multipliers.dexterity\_exp property +Multiplier to dexterity experience gain rate + Signature: ```typescript -dexterity_exp: number; +dexterity_exp?: number; ``` diff --git a/markdown/bitburner.multipliers.faction_rep.md b/markdown/bitburner.multipliers.faction_rep.md index 4600f7d30..0d7acb11e 100644 --- a/markdown/bitburner.multipliers.faction_rep.md +++ b/markdown/bitburner.multipliers.faction_rep.md @@ -4,8 +4,10 @@ ## Multipliers.faction\_rep property +Multiplier to amount of reputation gained when working + Signature: ```typescript -faction_rep: number; +faction_rep?: number; ``` diff --git a/markdown/bitburner.multipliers.hacking.md b/markdown/bitburner.multipliers.hacking.md index e0df53fa6..8c7cc3e35 100644 --- a/markdown/bitburner.multipliers.hacking.md +++ b/markdown/bitburner.multipliers.hacking.md @@ -4,8 +4,10 @@ ## Multipliers.hacking property +Multiplier to hacking skill + Signature: ```typescript -hacking: number; +hacking?: number; ``` diff --git a/markdown/bitburner.multipliers.hacking_chance.md b/markdown/bitburner.multipliers.hacking_chance.md index ba23ed946..4fcc91a2b 100644 --- a/markdown/bitburner.multipliers.hacking_chance.md +++ b/markdown/bitburner.multipliers.hacking_chance.md @@ -4,8 +4,10 @@ ## Multipliers.hacking\_chance property +Multiplier to chance of successfully performing a hack + Signature: ```typescript -hacking_chance: number; +hacking_chance?: number; ``` diff --git a/markdown/bitburner.multipliers.hacking_exp.md b/markdown/bitburner.multipliers.hacking_exp.md index 0ec0bac21..98a584335 100644 --- a/markdown/bitburner.multipliers.hacking_exp.md +++ b/markdown/bitburner.multipliers.hacking_exp.md @@ -4,8 +4,10 @@ ## Multipliers.hacking\_exp property +Multiplier to hacking experience gain rate + Signature: ```typescript -hacking_exp: number; +hacking_exp?: number; ``` diff --git a/markdown/bitburner.multipliers.hacking_grow.md b/markdown/bitburner.multipliers.hacking_grow.md index a9f459496..0eaf8a0ee 100644 --- a/markdown/bitburner.multipliers.hacking_grow.md +++ b/markdown/bitburner.multipliers.hacking_grow.md @@ -4,8 +4,10 @@ ## Multipliers.hacking\_grow property +Multiplier to amount of money injected into servers using grow + Signature: ```typescript -hacking_grow: number; +hacking_grow?: number; ``` diff --git a/markdown/bitburner.multipliers.hacking_money.md b/markdown/bitburner.multipliers.hacking_money.md index 8cc8b4ef8..7f232f867 100644 --- a/markdown/bitburner.multipliers.hacking_money.md +++ b/markdown/bitburner.multipliers.hacking_money.md @@ -4,8 +4,10 @@ ## Multipliers.hacking\_money property +Multiplier to amount of money the player gains from hacking + Signature: ```typescript -hacking_money: number; +hacking_money?: number; ``` diff --git a/markdown/bitburner.multipliers.hacking_speed.md b/markdown/bitburner.multipliers.hacking_speed.md index a37567944..51de83858 100644 --- a/markdown/bitburner.multipliers.hacking_speed.md +++ b/markdown/bitburner.multipliers.hacking_speed.md @@ -4,8 +4,10 @@ ## Multipliers.hacking\_speed property +Multiplier to hacking speed + Signature: ```typescript -hacking_speed: number; +hacking_speed?: number; ``` diff --git a/markdown/bitburner.multipliers.hacknet_node_core_cost.md b/markdown/bitburner.multipliers.hacknet_node_core_cost.md index f8e96aa89..b4b74bcb4 100644 --- a/markdown/bitburner.multipliers.hacknet_node_core_cost.md +++ b/markdown/bitburner.multipliers.hacknet_node_core_cost.md @@ -4,8 +4,10 @@ ## Multipliers.hacknet\_node\_core\_cost property +Multiplier to cost of core for a Hacknet Node + Signature: ```typescript -hacknet_node_core_cost: number; +hacknet_node_core_cost?: number; ``` diff --git a/markdown/bitburner.multipliers.hacknet_node_level_cost.md b/markdown/bitburner.multipliers.hacknet_node_level_cost.md index 4fb6bdaf6..c13d39f63 100644 --- a/markdown/bitburner.multipliers.hacknet_node_level_cost.md +++ b/markdown/bitburner.multipliers.hacknet_node_level_cost.md @@ -4,8 +4,10 @@ ## Multipliers.hacknet\_node\_level\_cost property +Multiplier to cost of leveling up a Hacknet Node + Signature: ```typescript -hacknet_node_level_cost: number; +hacknet_node_level_cost?: number; ``` diff --git a/markdown/bitburner.multipliers.hacknet_node_money.md b/markdown/bitburner.multipliers.hacknet_node_money.md index cd209fb5d..cf2821d02 100644 --- a/markdown/bitburner.multipliers.hacknet_node_money.md +++ b/markdown/bitburner.multipliers.hacknet_node_money.md @@ -4,8 +4,10 @@ ## Multipliers.hacknet\_node\_money property +Multiplier to amount of money produced by Hacknet Nodes + Signature: ```typescript -hacknet_node_money: number; +hacknet_node_money?: number; ``` diff --git a/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md b/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md index f8df5d56c..f0be66630 100644 --- a/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md +++ b/markdown/bitburner.multipliers.hacknet_node_purchase_cost.md @@ -4,8 +4,10 @@ ## Multipliers.hacknet\_node\_purchase\_cost property +Multiplier to cost of purchasing a Hacknet Node + Signature: ```typescript -hacknet_node_purchase_cost: number; +hacknet_node_purchase_cost?: number; ``` diff --git a/markdown/bitburner.multipliers.hacknet_node_ram_cost.md b/markdown/bitburner.multipliers.hacknet_node_ram_cost.md index aaccfa4f2..a2927fc51 100644 --- a/markdown/bitburner.multipliers.hacknet_node_ram_cost.md +++ b/markdown/bitburner.multipliers.hacknet_node_ram_cost.md @@ -4,8 +4,10 @@ ## Multipliers.hacknet\_node\_ram\_cost property +Multiplier to cost of ram for a Hacknet Node + Signature: ```typescript -hacknet_node_ram_cost: number; +hacknet_node_ram_cost?: number; ``` diff --git a/markdown/bitburner.multipliers.md b/markdown/bitburner.multipliers.md index 340f3c79f..073de8c05 100644 --- a/markdown/bitburner.multipliers.md +++ b/markdown/bitburner.multipliers.md @@ -15,34 +15,34 @@ export interface Multipliers | Property | Type | Description | | --- | --- | --- | -| [agility\_exp](./bitburner.multipliers.agility_exp.md) | number | | -| [agility](./bitburner.multipliers.agility.md) | number | | -| [bladeburner\_analysis](./bitburner.multipliers.bladeburner_analysis.md) | number | | -| [bladeburner\_max\_stamina](./bitburner.multipliers.bladeburner_max_stamina.md) | number | | -| [bladeburner\_stamina\_gain](./bitburner.multipliers.bladeburner_stamina_gain.md) | number | | -| [bladeburner\_success\_chance](./bitburner.multipliers.bladeburner_success_chance.md) | number | | -| [charisma\_exp](./bitburner.multipliers.charisma_exp.md) | number | | -| [charisma](./bitburner.multipliers.charisma.md) | number | | -| [company\_rep](./bitburner.multipliers.company_rep.md) | number | | -| [crime\_money](./bitburner.multipliers.crime_money.md) | number | | -| [crime\_success](./bitburner.multipliers.crime_success.md) | number | | -| [defense\_exp](./bitburner.multipliers.defense_exp.md) | number | | -| [defense](./bitburner.multipliers.defense.md) | number | | -| [dexterity\_exp](./bitburner.multipliers.dexterity_exp.md) | number | | -| [dexterity](./bitburner.multipliers.dexterity.md) | number | | -| [faction\_rep](./bitburner.multipliers.faction_rep.md) | number | | -| [hacking\_chance](./bitburner.multipliers.hacking_chance.md) | number | | -| [hacking\_exp](./bitburner.multipliers.hacking_exp.md) | number | | -| [hacking\_grow](./bitburner.multipliers.hacking_grow.md) | number | | -| [hacking\_money](./bitburner.multipliers.hacking_money.md) | number | | -| [hacking\_speed](./bitburner.multipliers.hacking_speed.md) | number | | -| [hacking](./bitburner.multipliers.hacking.md) | number | | -| [hacknet\_node\_core\_cost](./bitburner.multipliers.hacknet_node_core_cost.md) | number | | -| [hacknet\_node\_level\_cost](./bitburner.multipliers.hacknet_node_level_cost.md) | number | | -| [hacknet\_node\_money](./bitburner.multipliers.hacknet_node_money.md) | number | | -| [hacknet\_node\_purchase\_cost](./bitburner.multipliers.hacknet_node_purchase_cost.md) | number | | -| [hacknet\_node\_ram\_cost](./bitburner.multipliers.hacknet_node_ram_cost.md) | number | | -| [strength\_exp](./bitburner.multipliers.strength_exp.md) | number | | -| [strength](./bitburner.multipliers.strength.md) | number | | -| [work\_money](./bitburner.multipliers.work_money.md) | number | | +| [agility\_exp?](./bitburner.multipliers.agility_exp.md) | number | (Optional) Multiplier to agility experience gain rate | +| [agility?](./bitburner.multipliers.agility.md) | number | (Optional) Multiplier to agility skill | +| [bladeburner\_analysis?](./bitburner.multipliers.bladeburner_analysis.md) | number | (Optional) Multiplier to effectiveness in Bladeburner Field Analysis | +| [bladeburner\_max\_stamina?](./bitburner.multipliers.bladeburner_max_stamina.md) | number | (Optional) Multiplier to Bladeburner max stamina | +| [bladeburner\_stamina\_gain?](./bitburner.multipliers.bladeburner_stamina_gain.md) | number | (Optional) Multiplier to Bladeburner stamina gain rate | +| [bladeburner\_success\_chance?](./bitburner.multipliers.bladeburner_success_chance.md) | number | (Optional) Multiplier to success chance in Bladeburner contracts/operations | +| [charisma\_exp?](./bitburner.multipliers.charisma_exp.md) | number | (Optional) Multiplier to charisma experience gain rate | +| [charisma?](./bitburner.multipliers.charisma.md) | number | (Optional) Multiplier to charisma skill | +| [company\_rep?](./bitburner.multipliers.company_rep.md) | number | (Optional) Multiplier to amount of reputation gained when working | +| [crime\_money?](./bitburner.multipliers.crime_money.md) | number | (Optional) Multiplier to amount of money gained from crimes | +| [crime\_success?](./bitburner.multipliers.crime_success.md) | number | (Optional) Multiplier to crime success rate | +| [defense\_exp?](./bitburner.multipliers.defense_exp.md) | number | (Optional) Multiplier to defense experience gain rate | +| [defense?](./bitburner.multipliers.defense.md) | number | (Optional) Multiplier to defense skill | +| [dexterity\_exp?](./bitburner.multipliers.dexterity_exp.md) | number | (Optional) Multiplier to dexterity experience gain rate | +| [dexterity?](./bitburner.multipliers.dexterity.md) | number | (Optional) Multiplier to dexterity skill | +| [faction\_rep?](./bitburner.multipliers.faction_rep.md) | number | (Optional) Multiplier to amount of reputation gained when working | +| [hacking\_chance?](./bitburner.multipliers.hacking_chance.md) | number | (Optional) Multiplier to chance of successfully performing a hack | +| [hacking\_exp?](./bitburner.multipliers.hacking_exp.md) | number | (Optional) Multiplier to hacking experience gain rate | +| [hacking\_grow?](./bitburner.multipliers.hacking_grow.md) | number | (Optional) Multiplier to amount of money injected into servers using grow | +| [hacking\_money?](./bitburner.multipliers.hacking_money.md) | number | (Optional) Multiplier to amount of money the player gains from hacking | +| [hacking\_speed?](./bitburner.multipliers.hacking_speed.md) | number | (Optional) Multiplier to hacking speed | +| [hacking?](./bitburner.multipliers.hacking.md) | number | (Optional) Multiplier to hacking skill | +| [hacknet\_node\_core\_cost?](./bitburner.multipliers.hacknet_node_core_cost.md) | number | (Optional) Multiplier to cost of core for a Hacknet Node | +| [hacknet\_node\_level\_cost?](./bitburner.multipliers.hacknet_node_level_cost.md) | number | (Optional) Multiplier to cost of leveling up a Hacknet Node | +| [hacknet\_node\_money?](./bitburner.multipliers.hacknet_node_money.md) | number | (Optional) Multiplier to amount of money produced by Hacknet Nodes | +| [hacknet\_node\_purchase\_cost?](./bitburner.multipliers.hacknet_node_purchase_cost.md) | number | (Optional) Multiplier to cost of purchasing a Hacknet Node | +| [hacknet\_node\_ram\_cost?](./bitburner.multipliers.hacknet_node_ram_cost.md) | number | (Optional) Multiplier to cost of ram for a Hacknet Node | +| [strength\_exp?](./bitburner.multipliers.strength_exp.md) | number | (Optional) Multiplier to strength experience gain rate | +| [strength?](./bitburner.multipliers.strength.md) | number | (Optional) Multiplier to strength skill | +| [work\_money?](./bitburner.multipliers.work_money.md) | number | (Optional) Multiplier to amount of money gained from working | diff --git a/markdown/bitburner.multipliers.strength.md b/markdown/bitburner.multipliers.strength.md index 5baa4950c..408b69020 100644 --- a/markdown/bitburner.multipliers.strength.md +++ b/markdown/bitburner.multipliers.strength.md @@ -4,8 +4,10 @@ ## Multipliers.strength property +Multiplier to strength skill + Signature: ```typescript -strength: number; +strength?: number; ``` diff --git a/markdown/bitburner.multipliers.strength_exp.md b/markdown/bitburner.multipliers.strength_exp.md index 90aec3eb5..351dcc112 100644 --- a/markdown/bitburner.multipliers.strength_exp.md +++ b/markdown/bitburner.multipliers.strength_exp.md @@ -4,8 +4,10 @@ ## Multipliers.strength\_exp property +Multiplier to strength experience gain rate + Signature: ```typescript -strength_exp: number; +strength_exp?: number; ``` diff --git a/markdown/bitburner.multipliers.work_money.md b/markdown/bitburner.multipliers.work_money.md index e5cf0a95f..ffad7e676 100644 --- a/markdown/bitburner.multipliers.work_money.md +++ b/markdown/bitburner.multipliers.work_money.md @@ -4,8 +4,10 @@ ## Multipliers.work\_money property +Multiplier to amount of money gained from working + Signature: ```typescript -work_money: number; +work_money?: number; ``` diff --git a/markdown/bitburner.ns.clearport.md b/markdown/bitburner.ns.clearport.md index df0828ef3..50038926f 100644 --- a/markdown/bitburner.ns.clearport.md +++ b/markdown/bitburner.ns.clearport.md @@ -26,5 +26,5 @@ void RAM cost: 0 GB -Deleta all data from the underlying queue. +Delete all data from the underlying queue. diff --git a/markdown/bitburner.ns.exec.md b/markdown/bitburner.ns.exec.md index 24837f0b9..3aea59eca 100644 --- a/markdown/bitburner.ns.exec.md +++ b/markdown/bitburner.ns.exec.md @@ -18,7 +18,7 @@ exec(script: string, host: string, numThreads?: number, ...args: (string | numbe | --- | --- | --- | | script | string | Filename of script to execute. | | host | string | Hostname of the target server on which to execute the script. | -| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | +| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded down to the nearest integer. | | args | (string \| number \| boolean)\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the third argument numThreads must be filled in with a value. | Returns: @@ -31,9 +31,9 @@ Returns the PID of a successfully started script, and 0 otherwise. RAM cost: 1.3 GB -Run a script as a separate process on a specified server. This is similar to the run function except that it can be used to run a script on any server, instead of just the current server. +Run a script as a separate process on a specified server. This is similar to the function [run](./bitburner.ns.run.md) except that it can be used to run a script on any server, instead of just the current server. -If the script was successfully started, then this functions returns the PID of that script. Otherwise, it returns 0. +If the script was successfully started, then this function returns the PID of that script. Otherwise, it returns 0. PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer. @@ -44,29 +44,38 @@ Running this function with a numThreads argument of 0 or less will cause a runti ```ts // NS1: -//The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server: +// The simplest way to use the exec command is to call it with just the script name +// and the target server. The following example will try to run generic-hack.script +// on the foodnstuff server. exec("generic-hack.script", "foodnstuff"); -//The following example will try to run the script generic-hack.script on the joesguns server with 10 threads: +// The following example will try to run the script generic-hack.script on the +// joesguns server with 10 threads. exec("generic-hack.script", "joesguns", 10); -//This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script: +// This last example will try to run the script foo.script on the foodnstuff server +// with 5 threads. It will also pass the number 1 and the string “test” in as +// arguments to the script. exec("foo.script", "foodnstuff", 5, 1, "test"); ``` -\* ## Example 2 ```ts // NS2: -//The simplest way to use the exec command is to call it with just the script name and the target server. The following example will try to run generic-hack.script on the foodnstuff server: +// The simplest way to use the exec command is to call it with just the script name +// and the target server. The following example will try to run generic-hack.script +// on the foodnstuff server. ns.exec("generic-hack.script", "foodnstuff"); -//The following example will try to run the script generic-hack.script on the joesguns server with 10 threads: +// The following example will try to run the script generic-hack.script on the +// joesguns server with 10 threads. ns.exec("generic-hack.script", "joesguns", 10); -//This last example will try to run the script foo.script on the foodnstuff server with 5 threads. It will also pass the number 1 and the string “test” in as arguments to the script: +// This last example will try to run the script foo.script on the foodnstuff server +// with 5 threads. It will also pass the number 1 and the string “test” in as +// arguments to the script. ns.exec("foo.script", "foodnstuff", 5, 1, "test"); ``` diff --git a/markdown/bitburner.ns.getpurchasedserverupgradecost.md b/markdown/bitburner.ns.getpurchasedserverupgradecost.md new file mode 100644 index 000000000..f00891b60 --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedserverupgradecost.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServerUpgradeCost](./bitburner.ns.getpurchasedserverupgradecost.md) + +## NS.getPurchasedServerUpgradeCost() method + +Get cost of upgrading a purchased server to the given ram. + +Signature: + +```typescript +getPurchasedServerUpgradeCost(hostname: string, ram: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | Hostname of the server to upgrade. | +| ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | + +Returns: + +number + +The price to upgrade. + +## Remarks + +RAM cost: 0.1 GB + diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md index d34ef07a5..7291ba0d1 100644 --- a/markdown/bitburner.ns.md +++ b/markdown/bitburner.ns.md @@ -90,6 +90,7 @@ export async function main(ns) { | [getPurchasedServerLimit()](./bitburner.ns.getpurchasedserverlimit.md) | Returns the maximum number of servers you can purchase. | | [getPurchasedServerMaxRam()](./bitburner.ns.getpurchasedservermaxram.md) | Returns the maximum RAM that a purchased server can have. | | [getPurchasedServers()](./bitburner.ns.getpurchasedservers.md) | Returns an array with the hostnames of all of the servers you have purchased. | +| [getPurchasedServerUpgradeCost(hostname, ram)](./bitburner.ns.getpurchasedserverupgradecost.md) | Get cost of upgrading a purchased server to the given ram. | | [getRecentScripts()](./bitburner.ns.getrecentscripts.md) | Get an array of recently killed scripts across all servers. | | [getRunningScript(filename, hostname, args)](./bitburner.ns.getrunningscript.md) | Get general info about a running script. | | [getScriptExpGain(script, host, args)](./bitburner.ns.getscriptexpgain.md) | Get the exp gain of a script. | @@ -143,6 +144,7 @@ export async function main(ns) { | [read(filename)](./bitburner.ns.read.md) | Read content of a file. | | [readPort(port)](./bitburner.ns.readport.md) | Read data from a port. | | [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs relaySMTP.exe on a server. | +| [renamePurchasedServer(hostname, newName)](./bitburner.ns.renamepurchasedserver.md) | Rename a purchased server. | | [resizeTail(width, height, pid)](./bitburner.ns.resizetail.md) | Resize a tail window | | [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. | | [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. | @@ -162,6 +164,7 @@ export async function main(ns) { | [tprint(args)](./bitburner.ns.tprint.md) | Prints one or more values or variables to the Terminal. | | [tprintf(format, values)](./bitburner.ns.tprintf.md) | Prints a raw value or a variable to the Terminal. | | [tryWritePort(port, data)](./bitburner.ns.trywriteport.md) | Attempt to write to a port. | +| [upgradePurchasedServer(hostname, ram)](./bitburner.ns.upgradepurchasedserver.md) | Upgrade a purchased servers ram. | | [vsprintf(format, args)](./bitburner.ns.vsprintf.md) | Format a string with an array of arguments. | | [weaken(host, opts)](./bitburner.ns.weaken.md) | Reduce a server security level. | | [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Predict the effect of weaken. | diff --git a/markdown/bitburner.ns.nformat.md b/markdown/bitburner.ns.nformat.md index 676e08641..60b4211ce 100644 --- a/markdown/bitburner.ns.nformat.md +++ b/markdown/bitburner.ns.nformat.md @@ -23,13 +23,13 @@ nFormat(n: number, format: string): string; string -Formated number. +Formatted number. ## Remarks RAM cost: 0 GB -Converts a number into a string with the specified formatter. This uses the numeraljs library, so the formatters must be compatible with that. This is the same function that the game itself uses to display numbers. +Converts a number into a string with the specified formatter. This uses the numeral.js library, so the formatters must be compatible with that. This is the same function that the game itself uses to display numbers. see: http://numeraljs.com/ diff --git a/markdown/bitburner.ns.print.md b/markdown/bitburner.ns.print.md index f9befe8ba..75a4b0bfc 100644 --- a/markdown/bitburner.ns.print.md +++ b/markdown/bitburner.ns.print.md @@ -26,3 +26,69 @@ void RAM cost: 0 GB +If the argument is a string, you can color code your message by prefixing your string with one of these strings: + +- `"ERROR"`: The whole string will be printed in red. Use this prefix to indicate that an error has occurred. + +- `"SUCCESS"`: The whole string will be printed in green, similar to the default theme of the Terminal. Use this prefix to indicate that something is correct. + +- `"WARN"`: The whole string will be printed in yellow. Use this prefix to indicate that you or a user of your script should be careful of something. + +- `"INFO"`: The whole string will be printed in purplish blue. Use this prefix to remind yourself or a user of your script of something. Think of this prefix as indicating an FYI (for your information). + +For custom coloring, use ANSI escape sequences. The examples below use the Unicode escape code `\u001b`. The color coding also works if `\u001b` is replaced with the hexadecimal escape code `\x1b`. The Bash escape code `\e` is not supported. The octal escape code `\033` is not allowed because the game runs JavaScript in strict mode. + +## Example 1 + + +```ts +// NS1 +// Default color coding. +print("ERROR means something's wrong."); +print("SUCCESS means everything's OK."); +print("WARN Tread with caution!"); +print("WARNING, warning, danger, danger!"); +print("WARNing! Here be dragons."); +print("INFO for your I's only (FYI)."); +print("INFOrmation overload!"); +// Custom color coding. +var cyan = "\u001b[36m"; +var green = "\u001b[32m"; +var red = "\u001b[31m"; +var reset = "\u001b[0m"; +var msgError = red + "Ugh! What a mess." + reset; +var msgSuccess = green + "Well done!" + reset; +var msgMixed = cyan + "ERROR Should this be in red?" + reset; +print(msgError); +print(msgSuccess); +print(msgMixed); +tail(); +``` + +## Example 2 + + +```ts +// NS2 +// Default color coding. +ns.print("ERROR means something's wrong."); +ns.print("SUCCESS means everything's OK."); +ns.print("WARN Tread with caution!"); +ns.print("WARNING, warning, danger, danger!"); +ns.print("WARNing! Here be dragons."); +ns.print("INFO for your I's only (FYI)."); +ns.print("INFOrmation overload!"); +// Custom color coding. +const cyan = "\u001b[36m"; +const green = "\u001b[32m"; +const red = "\u001b[31m"; +const reset = "\u001b[0m"; +const msgError = "Ugh! What a mess."; +const msgSuccess = "Well done!"; +const msgMixed = "ERROR Should this be in red?"; +ns.print(`${red + msgError + reset}`); +ns.print(`${green + msgSuccess + reset}`); +ns.print(`${cyan + msgMixed + reset}`); +ns.tail(); +``` + diff --git a/markdown/bitburner.ns.printf.md b/markdown/bitburner.ns.printf.md index 5b158b194..2ca1f16c1 100644 --- a/markdown/bitburner.ns.printf.md +++ b/markdown/bitburner.ns.printf.md @@ -16,7 +16,7 @@ printf(format: string, ...args: any[]): void; | Parameter | Type | Description | | --- | --- | --- | -| format | string | format of the message | +| format | string | Format of the message. | | args | any\[\] | Value(s) to be printed. | Returns: @@ -27,5 +27,39 @@ void RAM cost: 0 GB -see: https://github.com/alexei/sprintf.js +- See [print](./bitburner.ns.print.md) for how to add color to your printed strings. + +- For more detail, see: https://github.com/alexei/sprintf.js + +## Example 1 + + +```ts +// NS1 +var name = "Bit"; +var age = 4; +printf("My name is %s.", name); +printf("I'm %d seconds old.", age); +printf("My age in binary is %b.", age); +printf("My age in scientific notation is %e.", age); +printf("In %d seconds, I'll be %s.", 6, "Byte"); +printf("Am I a nibble? %t", (4 == age)); +tail(); +``` + +## Example 2 + + +```ts +// NS2 +const name = "Bit"; +const age = 4; +ns.printf("My name is %s.", name); +ns.printf("I'm %d seconds old.", age); +ns.printf("My age in binary is %b.", age); +ns.printf("My age in scientific notation is %e.", age); +ns.printf("In %d seconds, I'll be %s.", 6, "Byte"); +ns.printf("Am I a nibble? %t", (4 == age)); +ns.tail(); +``` diff --git a/markdown/bitburner.ns.renamepurchasedserver.md b/markdown/bitburner.ns.renamepurchasedserver.md new file mode 100644 index 000000000..3830a78a4 --- /dev/null +++ b/markdown/bitburner.ns.renamepurchasedserver.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [renamePurchasedServer](./bitburner.ns.renamepurchasedserver.md) + +## NS.renamePurchasedServer() method + +Rename a purchased server. + +Signature: + +```typescript +renamePurchasedServer(hostname: string, newName: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | current server hostname | +| newName | string | new server hostname | + +Returns: + +boolean + +True if the upgrade succeeded. + +## Remarks + +RAM cost: 2.00 GB + diff --git a/markdown/bitburner.ns.sprintf.md b/markdown/bitburner.ns.sprintf.md index 5520dc18a..cda063926 100644 --- a/markdown/bitburner.ns.sprintf.md +++ b/markdown/bitburner.ns.sprintf.md @@ -17,13 +17,13 @@ sprintf(format: string, ...args: any[]): string; | Parameter | Type | Description | | --- | --- | --- | | format | string | String to format. | -| args | any\[\] | Formating arguments. | +| args | any\[\] | Formatting arguments. | Returns: string -Formated text. +Formatted text. ## Remarks diff --git a/markdown/bitburner.ns.toast.md b/markdown/bitburner.ns.toast.md index d3e093a10..f58fbbe69 100644 --- a/markdown/bitburner.ns.toast.md +++ b/markdown/bitburner.ns.toast.md @@ -9,7 +9,7 @@ Queue a toast (bottom-right notification). Signature: ```typescript -toast(msg: string, variant?: ToastVariantValues, duration?: number | null): void; +toast(msg: string, variant?: ToastVariant, duration?: number | null): void; ``` ## Parameters @@ -17,7 +17,7 @@ toast(msg: string, variant?: ToastVariantValues, duration?: number | null): void | Parameter | Type | Description | | --- | --- | --- | | msg | string | Message in the toast. | -| variant | [ToastVariantValues](./bitburner.toastvariantvalues.md) | Type of toast, must be one of success, info, warning, error. Defaults to success. | +| variant | [ToastVariant](./bitburner.toastvariant.md) | Type of toast, must be one of success, info, warning, error. Defaults to success. | | duration | number \| null | Duration of toast in ms. Can also be null to create a persistent toast. Defaults to 2000 | Returns: diff --git a/markdown/bitburner.ns.tprint.md b/markdown/bitburner.ns.tprint.md index 30c8b798a..4e8cd8d8a 100644 --- a/markdown/bitburner.ns.tprint.md +++ b/markdown/bitburner.ns.tprint.md @@ -26,3 +26,5 @@ void RAM cost: 0 GB +See [print](./bitburner.ns.print.md) for how to add color to your printed strings. + diff --git a/markdown/bitburner.ns.tprintf.md b/markdown/bitburner.ns.tprintf.md index 5f60cdb77..1005b9be8 100644 --- a/markdown/bitburner.ns.tprintf.md +++ b/markdown/bitburner.ns.tprintf.md @@ -16,8 +16,8 @@ tprintf(format: string, ...values: any[]): void; | Parameter | Type | Description | | --- | --- | --- | -| format | string | format of the message | -| values | any\[\] | | +| format | string | Format of the message. | +| values | any\[\] | Value(s) to be printed. | Returns: @@ -27,5 +27,9 @@ void RAM cost: 0 GB -see: https://github.com/alexei/sprintf.js +- See [print](./bitburner.ns.print.md) for how to add color to your printed strings. + +- See [printf](./bitburner.ns.printf.md) for examples on formatted strings. + +- For more detail, see: https://github.com/alexei/sprintf.js diff --git a/markdown/bitburner.ns.trywriteport.md b/markdown/bitburner.ns.trywriteport.md index 8b2eb2fa7..62aea2493 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): boolean; ``` ## Parameters @@ -21,7 +21,7 @@ tryWritePort(port: number, data: string | number): Promise; Returns: -Promise<boolean> +boolean True if the data is successfully written to the port, and false otherwise. diff --git a/markdown/bitburner.ns.upgradepurchasedserver.md b/markdown/bitburner.ns.upgradepurchasedserver.md new file mode 100644 index 000000000..70c3b31c4 --- /dev/null +++ b/markdown/bitburner.ns.upgradepurchasedserver.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [upgradePurchasedServer](./bitburner.ns.upgradepurchasedserver.md) + +## NS.upgradePurchasedServer() method + +Upgrade a purchased servers ram. + +Signature: + +```typescript +upgradePurchasedServer(hostname: string, ram: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | string | Hostname of the server to upgrade. | +| ram | number | Amount of RAM of the purchased server, in GB. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | + +Returns: + +boolean + +True if the upgrade succeeded. + +## Remarks + +RAM cost: 0.25 GB + diff --git a/markdown/bitburner.ns.vsprintf.md b/markdown/bitburner.ns.vsprintf.md index 06d4d19e0..17b4c4ae7 100644 --- a/markdown/bitburner.ns.vsprintf.md +++ b/markdown/bitburner.ns.vsprintf.md @@ -17,13 +17,13 @@ vsprintf(format: string, args: any[]): string; | Parameter | Type | Description | | --- | --- | --- | | format | string | String to format. | -| args | any\[\] | Formating arguments. | +| args | any\[\] | Formatting arguments. | Returns: string -Formated text. +Formatted text. ## Remarks diff --git a/markdown/bitburner.nsenums.md b/markdown/bitburner.nsenums.md index 241d87407..a99c9d01c 100644 --- a/markdown/bitburner.nsenums.md +++ b/markdown/bitburner.nsenums.md @@ -2,18 +2,11 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [NSEnums](./bitburner.nsenums.md) -## NSEnums interface +## NSEnums type Signature: ```typescript -export interface NSEnums +export type NSEnums = typeof enums; ``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [toast](./bitburner.nsenums.toast.md) | typeof [ToastVariant](./bitburner.toastvariant.md) | | - diff --git a/markdown/bitburner.nsenums.toast.md b/markdown/bitburner.nsenums.toast.md deleted file mode 100644 index 525a79649..000000000 --- a/markdown/bitburner.nsenums.toast.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [NSEnums](./bitburner.nsenums.md) > [toast](./bitburner.nsenums.toast.md) - -## NSEnums.toast property - -Signature: - -```typescript -toast: typeof ToastVariant; -``` diff --git a/markdown/bitburner.officeapi.md b/markdown/bitburner.officeapi.md index a3fcca6d9..ecb622aab 100644 --- a/markdown/bitburner.officeapi.md +++ b/markdown/bitburner.officeapi.md @@ -14,7 +14,7 @@ export interface OfficeAPI ## Remarks -Requires the Office API upgrade from your corporation. +requires the Office API upgrade from your corporation. ## Methods diff --git a/markdown/bitburner.singularity.checkfactioninvitations.md b/markdown/bitburner.singularity.checkfactioninvitations.md index ee1f7f534..6c75e54c7 100644 --- a/markdown/bitburner.singularity.checkfactioninvitations.md +++ b/markdown/bitburner.singularity.checkfactioninvitations.md @@ -15,11 +15,11 @@ checkFactionInvitations(): string[]; string\[\] -Array with the name of all Factions you currently have oustanding invitations from. +Array with the name of all Factions you currently have outstanding invitations from. ## Remarks RAM cost: 3 GB \* 16/4/1 -Returns an array with the name of all Factions you currently have oustanding invitations from. +Returns an array with the name of all Factions you currently have outstanding invitations from. diff --git a/markdown/bitburner.singularity.getaugmentationstats.md b/markdown/bitburner.singularity.getaugmentationstats.md index f4d716200..12056f334 100644 --- a/markdown/bitburner.singularity.getaugmentationstats.md +++ b/markdown/bitburner.singularity.getaugmentationstats.md @@ -9,7 +9,7 @@ Get the stats of an augmentation. Signature: ```typescript -getAugmentationStats(name: string): AugmentationStats; +getAugmentationStats(name: string): Multipliers; ``` ## Parameters @@ -20,7 +20,7 @@ getAugmentationStats(name: string): AugmentationStats; Returns: -[AugmentationStats](./bitburner.augmentationstats.md) +[Multipliers](./bitburner.multipliers.md) Augmentation stats. diff --git a/markdown/bitburner.singularity.getcrimechance.md b/markdown/bitburner.singularity.getcrimechance.md index a332e1e66..22e65a839 100644 --- a/markdown/bitburner.singularity.getcrimechance.md +++ b/markdown/bitburner.singularity.getcrimechance.md @@ -22,11 +22,11 @@ getCrimeChance(crime: string): number; number -Chance of success at commiting the specified crime. +Chance of success at committing the specified crime. ## Remarks RAM cost: 5 GB \* 16/4/1 -This function returns your chance of success at commiting the specified crime. +This function returns your chance of success at committing the specified crime. diff --git a/markdown/bitburner.sleeve.settocommitcrime.md b/markdown/bitburner.sleeve.settocommitcrime.md index 107c111ab..7723392f7 100644 --- a/markdown/bitburner.sleeve.settocommitcrime.md +++ b/markdown/bitburner.sleeve.settocommitcrime.md @@ -16,7 +16,7 @@ setToCommitCrime(sleeveNumber: number, name: string): boolean; | Parameter | Type | Description | | --- | --- | --- | -| sleeveNumber | number | Index of the sleeve to start commiting crime. | +| sleeveNumber | number | Index of the sleeve to start committing crime. | | name | string | Name of the crime. Must be an exact match. | Returns: diff --git a/markdown/bitburner.tix.cancelorder.md b/markdown/bitburner.tix.cancelorder.md index e7d7edd7c..c5ef90cb8 100644 --- a/markdown/bitburner.tix.cancelorder.md +++ b/markdown/bitburner.tix.cancelorder.md @@ -28,7 +28,7 @@ void ## Remarks -RAM cost: 2.5 GB Cancels an oustanding Limit or Stop order on the stock market. +RAM cost: 2.5 GB Cancels an outstanding Limit or Stop order on the stock market. The ability to use limit and stop orders is \*\*not\*\* immediately available to the player and must be unlocked later on in the game. diff --git a/markdown/bitburner.tix.getprice.md b/markdown/bitburner.tix.getprice.md index c6f30ea6a..01d1b1b40 100644 --- a/markdown/bitburner.tix.getprice.md +++ b/markdown/bitburner.tix.getprice.md @@ -4,7 +4,7 @@ ## TIX.getPrice() method -Returns the price of a stock +Returns the price of a stock. Signature: @@ -26,14 +26,26 @@ The price of a stock. ## Remarks -RAM cost: 2 GB The stock’s price is the average of its bid and ask price. +RAM cost: 2 GB + +The stock’s price is the average of its bid and ask prices. This function requires that you have the following: + +1. WSE Account + +1. TIX API Access ## Example 1 ```ts // NS1 -stock.getPrice("FISG"); +stock.getPrice("FSIG"); + +// Choose the first stock symbol from the array of stock symbols. Get the price +// of the corresponding stock. +var sym = stock.getSymbols()[0]; +tprint("Stock symbol: " + sym); +tprint("Stock price: " + stock.getPrice(sym)); ``` ## Example 2 @@ -41,6 +53,12 @@ stock.getPrice("FISG"); ```ts // NS2 -ns.stock.getPrice("FISG"); +ns.stock.getPrice("FSIG"); + +// Choose the first stock symbol from the array of stock symbols. Get the price +// of the corresponding stock. +const sym = ns.stock.getSymbols()[0]; +ns.tprint("Stock symbol: " + sym); +ns.tprint("Stock price: " + ns.stock.getPrice(sym)); ``` diff --git a/markdown/bitburner.tix.md b/markdown/bitburner.tix.md index 43b9c708e..a40625a09 100644 --- a/markdown/bitburner.tix.md +++ b/markdown/bitburner.tix.md @@ -25,7 +25,7 @@ export interface TIX | [getMaxShares(sym)](./bitburner.tix.getmaxshares.md) | Returns the maximum number of shares of a stock. | | [getOrders()](./bitburner.tix.getorders.md) | Returns your order book for the stock market. | | [getPosition(sym)](./bitburner.tix.getposition.md) | Returns the player’s position in a stock. | -| [getPrice(sym)](./bitburner.tix.getprice.md) | Returns the price of a stock | +| [getPrice(sym)](./bitburner.tix.getprice.md) | Returns the price of a stock. | | [getPurchaseCost(sym, shares, posType)](./bitburner.tix.getpurchasecost.md) | Calculates cost of buying stocks. | | [getSaleGain(sym, shares, posType)](./bitburner.tix.getsalegain.md) | Calculate profit of selling stocks. | | [getSymbols()](./bitburner.tix.getsymbols.md) | Returns an array of the symbols of the tradable stocks | diff --git a/markdown/bitburner.toastvariant.md b/markdown/bitburner.toastvariant.md index fdc76db90..969c3e455 100644 --- a/markdown/bitburner.toastvariant.md +++ b/markdown/bitburner.toastvariant.md @@ -2,21 +2,11 @@ [Home](./index.md) > [bitburner](./bitburner.md) > [ToastVariant](./bitburner.toastvariant.md) -## ToastVariant enum +## ToastVariant type Signature: ```typescript -export enum ToastVariant +type ToastVariant = ValuesFrom; ``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ERROR | "error" | | -| INFO | "info" | | -| SUCCESS | "success" | | -| WARNING | "warning" | | - diff --git a/markdown/bitburner.toastvariantvalues.md b/markdown/bitburner.toastvariantvalues.md deleted file mode 100644 index 84f640c50..000000000 --- a/markdown/bitburner.toastvariantvalues.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [bitburner](./bitburner.md) > [ToastVariantValues](./bitburner.toastvariantvalues.md) - -## ToastVariantValues type - - -Signature: - -```typescript -export type ToastVariantValues = `${ToastVariant}`; -``` -References: [ToastVariant](./bitburner.toastvariant.md) - diff --git a/src/ScriptEditor/NetscriptDefinitions.d.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts index f8b4d4cb3..b8ba71370 100644 --- a/src/ScriptEditor/NetscriptDefinitions.d.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -1,3 +1,4 @@ +/** @internal */ export type ValuesFrom = T[keyof T]; /** @public */ @@ -6713,6 +6714,7 @@ export interface NS { enums: NSEnums; } +/** @internal */ declare const enums = { toast: { SUCCESS: "success", @@ -6720,9 +6722,12 @@ declare const enums = { ERROR: "error", INFO: "info", }, -} as const; +}; + +/** @public */ type ToastVariant = ValuesFrom; +/** @public */ export type NSEnums = typeof enums; /** * Corporation Office API