diff --git a/api-extractor.json b/api-extractor.json new file mode 100644 index 000000000..1a8222877 --- /dev/null +++ b/api-extractor.json @@ -0,0 +1,364 @@ +/** + * Config file for API Extractor. For more info, please visit: https://api-extractor.com + */ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + + /** + * Optionally specifies another JSON config file that this file extends from. This provides a way for + * standard settings to be shared across multiple projects. + * + * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains + * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be + * resolved using NodeJS require(). + * + * SUPPORTED TOKENS: none + * DEFAULT VALUE: "" + */ + // "extends": "./shared/api-extractor-base.json" + // "extends": "my-package/include/api-extractor-base.json" + + /** + * Determines the "" token that can be used with other config file settings. The project folder + * typically contains the tsconfig.json and package.json config files, but the path is user-defined. + * + * The path is resolved relative to the folder of the config file that contains the setting. + * + * The default value for "projectFolder" is the token "", which means the folder is determined by traversing + * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder + * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error + * will be reported. + * + * SUPPORTED TOKENS: + * DEFAULT VALUE: "" + */ + // "projectFolder": "..", + + /** + * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor + * analyzes the symbols exported by this module. + * + * The file extension must be ".d.ts" and not ".ts". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + */ + "mainEntryPointFilePath": "src/ScriptEditor/NetscriptDefinitions.d.ts", + + /** + * A list of NPM package names whose exports should be treated as part of this package. + * + * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1", + * and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part + * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly + * imports library2. To avoid this, we can specify: + * + * "bundledPackages": [ "library2" ], + * + * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been + * local files for library1. + */ + "bundledPackages": [], + + /** + * Determines how the TypeScript compiler engine will be invoked by API Extractor. + */ + "compiler": { + /** + * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * Note: This setting will be ignored if "overrideTsconfig" is used. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/tsconfig.json" + */ + // "tsconfigFilePath": "/tsconfig.json", + /** + * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. + * The object must conform to the TypeScript tsconfig schema: + * + * http://json.schemastore.org/tsconfig + * + * If omitted, then the tsconfig.json file will be read from the "projectFolder". + * + * DEFAULT VALUE: no overrideTsconfig section + */ + // "overrideTsconfig": { + // . . . + // } + /** + * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended + * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when + * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses + * for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. + * + * DEFAULT VALUE: false + */ + // "skipLibCheck": true, + }, + + /** + * Configures how the API report file (*.api.md) will be generated. + */ + "apiReport": { + /** + * (REQUIRED) Whether to generate an API report. + */ + "enabled": true + + /** + * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce + * a full file path. + * + * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/". + * + * SUPPORTED TOKENS: , + * DEFAULT VALUE: ".api.md" + */ + // "reportFileName": ".api.md", + + /** + * Specifies the folder where the API report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy, + * e.g. for an API review. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/etc/" + */ + // "reportFolder": "/etc/", + + /** + * Specifies the folder where the temporary report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * After the temporary file is written to disk, it is compared with the file in the "reportFolder". + * If they are different, a production build will fail. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/" + */ + // "reportTempFolder": "/temp/" + }, + + /** + * Configures how the doc model file (*.api.json) will be generated. + */ + "docModel": { + /** + * (REQUIRED) Whether to generate a doc model file. + */ + "enabled": true + + /** + * The output path for the doc model file. The file extension should be ".api.json". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/.api.json" + */ + // "apiJsonFilePath": "/temp/.api.json" + }, + + /** + * Configures how the .d.ts rollup file will be generated. + */ + "dtsRollup": { + /** + * (REQUIRED) Whether to generate the .d.ts rollup file. + */ + "enabled": true + + /** + * Specifies the output path for a .d.ts rollup file to be generated without any trimming. + * This file will include all declarations that are exported by the main entry point. + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/dist/.d.ts" + */ + // "untrimmedFilePath": "/dist/.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. + * This file will include only declarations that are marked as "@public" or "@beta". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "betaTrimmedFilePath": "/dist/-beta.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. + * This file will include only declarations that are marked as "@public". + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "publicTrimmedFilePath": "/dist/-public.d.ts", + + /** + * When a declaration is trimmed, by default it will be replaced by a code comment such as + * "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the + * declaration completely. + * + * DEFAULT VALUE: false + */ + // "omitTrimmingComments": true + }, + + /** + * Configures how the tsdoc-metadata.json file will be generated. + */ + "tsdocMetadata": { + /** + * Whether to generate the tsdoc-metadata.json file. + * + * DEFAULT VALUE: true + */ + // "enabled": true, + /** + * Specifies where the TSDoc metadata file should be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * The default value is "", which causes the path to be automatically inferred from the "tsdocMetadata", + * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup + * falls back to "tsdoc-metadata.json" in the package folder. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "tsdocMetadataFilePath": "/dist/tsdoc-metadata.json" + }, + + /** + * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files + * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead. + * To use the OS's default newline kind, specify "os". + * + * DEFAULT VALUE: "crlf" + */ + // "newlineKind": "crlf", + + /** + * Configures how API Extractor reports error and warning messages produced during analysis. + * + * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages. + */ + "messages": { + /** + * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing + * the input .d.ts files. + * + * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "compilerMessageReporting": { + /** + * Configures the default routing for messages that don't match an explicit rule in this table. + */ + "default": { + /** + * Specifies whether the message should be written to the the tool's output log. Note that + * the "addToApiReportFile" property may supersede this option. + * + * Possible values: "error", "warning", "none" + * + * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail + * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes + * the "--local" option), the warning is displayed but the build will not fail. + * + * DEFAULT VALUE: "warning" + */ + "logLevel": "warning" + + /** + * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), + * then the message will be written inside that file; otherwise, the message is instead logged according to + * the "logLevel" option. + * + * DEFAULT VALUE: false + */ + // "addToApiReportFile": false + } + + // "TS2551": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by API Extractor during its analysis. + * + * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag" + * + * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings + */ + "extractorMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "ae-extra-release-tag": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by the TSDoc parser when analyzing code comments. + * + * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "tsdoc-link-tag-unescaped-text": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + } + } +} diff --git a/dist/bitburner.d.ts b/dist/bitburner.d.ts new file mode 100644 index 000000000..e1848cb71 --- /dev/null +++ b/dist/bitburner.d.ts @@ -0,0 +1,4939 @@ +/** + * @public + */ +export declare interface AugmentationStats { + /** Multipler to hacking skill */ + hacking_mult?: number; + /** Multipler to strength skill */ + strength_mult?: number; + /** Multipler to defense skill */ + defense_mult?: number; + /** Multipler to dexterity skill */ + dexterity_mult?: number; + /** Multipler to agility skill */ + agility_mult?: number; + /** Multipler to charisma skill */ + charisma_mult?: number; + /** Multipler to hacking experience gain rate */ + hacking_exp_mult?: number; + /** Multipler to strength experience gain rate */ + strength_exp_mult?: number; + /** Multipler to defense experience gain rate */ + defense_exp_mult?: number; + /** Multipler to dexterity experience gain rate */ + dexterity_exp_mult?: number; + /** Multipler to agility experience gain rate */ + agility_exp_mult?: number; + /** Multipler to charisma experience gain rate */ + charisma_exp_mult?: number; + /** Multipler to chance of successfully performing a hack */ + hacking_chance_mult?: number; + /** Multipler to hacking speed */ + hacking_speed_mult?: number; + /** Multipler to amount of money the player gains from hacking */ + hacking_money_mult?: number; + /** Multipler to amount of money injected into servers using grow */ + hacking_grow_mult?: number; + /** Multipler to amount of reputation gained when working */ + company_rep_mult?: number; + /** Multipler to amount of reputation gained when working */ + faction_rep_mult?: number; + /** Multipler to amount of money gained from crimes */ + crime_money_mult?: number; + /** Multipler to crime success rate */ + crime_success_mult?: number; + /** Multipler to amount of money gained from working */ + work_money_mult?: number; + /** Multipler to amount of money produced by Hacknet Nodes */ + hacknet_node_money_mult?: number; + /** Multipler to cost of purchasing a Hacknet Node */ + hacknet_node_purchase_cost_mult?: number; + /** Multipler to cost of ram for a Hacknet Node */ + hacknet_node_ram_cost_mult?: number; + /** Multipler to cost of core for a Hacknet Node */ + hacknet_node_core_cost_mult?: number; + /** Multipler to cost of leveling up a Hacknet Node */ + hacknet_node_level_cost_mult?: number; + /** Multipler to Bladeburner max stamina */ + bladeburner_max_stamina_mult?: number; + /** Multipler to Bladeburner stamina gain rate */ + bladeburner_stamina_gain_mult?: number; + /** Multipler to effectiveness in Bladeburner Field Analysis */ + bladeburner_analysis_mult?: number; + /** Multipler to success chance in Bladeburner contracts/operations */ + bladeburner_success_chance_mult?: number; +} + +/** + * @public + */ +export declare type AugmentName = +| "Augmented Targeting I" +| "Augmented Targeting II" +| "Augmented Targeting III" +| "Synthetic Heart" +| "Synfibril Muscle" +| "Combat Rib I" +| "Combat Rib II" +| "Combat Rib III" +| "Nanofiber Weave" +| "NEMEAN Subdermal Weave" +| "Wired Reflexes" +| "Graphene Bone Lacings" +| "Bionic Spine" +| "Graphene Bionic Spine Upgrade" +| "Bionic Legs" +| "Graphene Bionic Legs Upgrade" +| "Speech Processor Implant" +| "TITN-41 Gene-Modification Injection" +| "Enhanced Social Interaction Implant" +| "BitWire" +| "Artificial Bio-neural Network Implant" +| "Artificial Synaptic Potentiation" +| "Enhanced Myelin Sheathing" +| "Synaptic Enhancement Implant" +| "Neural-Retention Enhancement" +| "DataJack" +| "Embedded Netburner Module" +| "Embedded Netburner Module Core Implant" +| "Embedded Netburner Module Core V2 Upgrade" +| "Embedded Netburner Module Core V3 Upgrade" +| "Embedded Netburner Module Analyze Engine" +| "Embedded Netburner Module Direct Memory Access Upgrade" +| "Neuralstimulator" +| "Neural Accelerator" +| "Cranial Signal Processors - Gen I" +| "Cranial Signal Processors - Gen II" +| "Cranial Signal Processors - Gen III" +| "Cranial Signal Processors - Gen IV" +| "Cranial Signal Processors - Gen V" +| "Neuronal Densification" +| "Nuoptimal Nootropic Injector Implant" +| "Speech Enhancement" +| "FocusWire" +| "PC Direct-Neural Interface" +| "PC Direct-Neural Interface Optimization Submodule" +| "PC Direct-Neural Interface NeuroNet Injector" +| "ADR-V1 Pheromone Gene" +| "ADR-V2 Pheromone Gene" +| "The Shadow's Simulacrum" +| "Hacknet Node CPU Architecture Neural-Upload" +| "Hacknet Node Cache Architecture Neural-Upload" +| "Hacknet Node NIC Architecture Neural-Upload" +| "Hacknet Node Kernel Direct-Neural Interface" +| "Hacknet Node Core Direct-Neural Interface" +| "NeuroFlux Governor" +| "Neurotrainer I" +| "Neurotrainer II" +| "Neurotrainer III" +| "HyperSight Corneal Implant" +| "LuminCloaking-V1 Skin Implant" +| "LuminCloaking-V2 Skin Implant" +| "HemoRecirculator" +| "SmartSonar Implant" +| "Power Recirculation Core" +| "QLink" +| "The Red Pill" +| "SPTN-97 Gene Modification" +| "ECorp HVMind Implant" +| "CordiARC Fusion Reactor" +| "SmartJaw" +| "Neotra" +| "Xanipher" +| "nextSENS Gene Modification" +| "OmniTek InfoLoad" +| "Photosynthetic Cells" +| "BitRunners Neurolink" +| "The Black Hand" +| "CRTX42-AA Gene Modification" +| "Neuregen Gene Modification" +| "CashRoot Starter Kit" +| "NutriGen Implant" +| "INFRARET Enhancement" +| "DermaForce Particle Barrier" +| "Graphene BranchiBlades Upgrade" +| "Graphene Bionic Arms Upgrade" +| "BrachiBlades" +| "Bionic Arms" +| "Social Negotiation Assistant (S.N.A)" +| "EsperTech Bladeburner Eyewear" +| "EMS-4 Recombination" +| "ORION-MKIV Shoulder" +| "Hyperion Plasma Cannon V1" +| "Hyperion Plasma Cannon V2" +| "GOLEM Serum" +| "Vangelis Virus" +| "Vangelis Virus 3.0" +| "I.N.T.E.R.L.I.N.K.E.D" +| "Blade's Runners" +| "BLADE-51b Tesla Armor" +| "BLADE-51b Tesla Armor: Power Cells Upgrade" +| "BLADE-51b Tesla Armor: Energy Shielding Upgrade" +| "BLADE-51b Tesla Armor: Unibeam Upgrade" +| "BLADE-51b Tesla Armor: Omnibeam Upgrade" +| "BLADE-51b Tesla Armor: IPU Upgrade" +| "The Blade's Simulacrum"; + +/** + * @public + */ +export declare interface AugmentPair { + /** augmentation name */ + name: AugmentName; + /** augmentation cost */ + cost: number; +} + +/** + * @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. */ + threads: number; +} + +/** + * @public + */ +export declare interface BitNodeMultipliers { + /** Influences how quickly the player's agility level (not exp) scales */ + AgilityLevelMultiplier: number; + /** Influences the base cost to purchase an augmentation. */ + AugmentationMoneyCost: number; + /** Influences the base rep the player must have with a faction to purchase an augmentation. */ + AugmentationRepCost: number; + /** Influences how quickly the player can gain rank within Bladeburner. */ + BladeburnerRank: number; + /** Influences the cost of skill levels from Bladeburner. */ + BladeburnerSkillCost: number; + /** Influences how quickly the player's charisma level (not exp) scales */ + CharismaLevelMultiplier: number; + /** Influences the experience gained for each ability when a player completes a class. */ + ClassGymExpGain: number; + /** Influences the amount of money gained from completing Coding Contracts */ + CodingContractMoney: number; + /** Influences the experience gained for each ability when the player completes working their job. */ + CompanyWorkExpGain: number; + /** Influences how much money the player earns when completing working their job. */ + CompanyWorkMoney: number; + /** Influences the valuation of corporations created by the player. */ + CorporationValuation: number; + /** Influences the base experience gained for each ability when the player commits a crime. */ + CrimeExpGain: number; + /** Influences the base money gained when the player commits a crime. */ + CrimeMoney: number; + /** Influences how many Augmentations you need in order to get invited to the Daedalus faction */ + DaedalusAugsRequirement: number; + /** Influences how quickly the player's defense level (not exp) scales */ + DefenseLevelMultiplier: number; + /** Influences how quickly the player's dexterity level (not exp) scales */ + DexterityLevelMultiplier: number; + /** Influences how much rep the player gains in each faction simply by being a member. */ + FactionPassiveRepGain: number; + /** Influences the experience gained for each ability when the player completes work for a Faction. */ + FactionWorkExpGain: number; + /** Influences how much rep the player gains when performing work for a faction. */ + FactionWorkRepGain: number; + /** Influences how much it costs to unlock the stock market's 4S Market Data API */ + FourSigmaMarketDataApiCost: number; + /** Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) */ + FourSigmaMarketDataCost: number; + /** Influences the experienced gained when hacking a server. */ + 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) */ + HacknetNodeMoney: number; + /** Influences how much money it costs to upgrade your home computer's RAM */ + HomeComputerRamCost: number; + /** Influences how much money is gained when the player infiltrates a company. */ + 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. */ + ManualHackMoney: number; + /** Influence how much it costs to purchase a server */ + PurchasedServerCost: number; + /** Influences the maximum number of purchased servers you can have */ + PurchasedServerLimit: number; + /** Influences the maximum allowed RAM for a purchased server */ + PurchasedServerMaxRam: number; + /** Influences the minimum favor the player must have with a faction before they can donate to gain rep. */ + RepToDonateToFaction: number; + /** Influences how much money can be stolen from a server when a script performs a hack against it. */ + ScriptHackMoney: number; + /** Influences the growth percentage per cycle against a server. */ + ServerGrowthRate: number; + /** Influences the maxmimum money that a server can grow to. */ + ServerMaxMoney: number; + /** Influences the initial money that a server starts with. */ + ServerStartingMoney: number; + /** Influences the initial security level (hackDifficulty) of a server. */ + ServerStartingSecurity: number; + /** Influences the weaken amount per invocation against a server. */ + ServerWeakenRate: number; + /** Influences how quickly the player's strength level (not exp) scales */ + StrengthLevelMultiplier: number; +} + +/** + * @public + */ +export declare interface Bladeburner { + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns an array of strings containing the names of all Bladeburner contracts. + * + * @remarks 0.4 GB + * @returns Array of strings containing the names of all Bladeburner contracts. + */ + getContractNames(): BladeburnerContracts[]; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns an array of strings containing the names of all Bladeburner operations. + * + * @remarks 0.4 GB + * @returns Array of strings containing the names of all Bladeburner operations. + */ + getOperationNames(): BladeburnerOperations[]; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns an array of strings containing the names of all Bladeburner Black Ops. + * + * @remarks 0.4 GB + * @returns Array of strings containing the names of all Bladeburner Black Ops. + */ + getBlackOpNames(): BladeburnerBlackOps[]; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns an array of strings containing the names of all general Bladeburner actions. + * + * @remarks 0.4 GB + * @returns Array of strings containing the names of all general Bladeburner actions. + */ + getGeneralActionNames(): BladeburnerGenActions[]; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns an array of strings containing the names of all general Bladeburner skills. + * + * @remarks 0.4 GB + * @returns Array of strings containing the names of all general Bladeburner skills. + */ + getSkillNames(): BladeburnerSkills[]; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Attempts to start the specified Bladeburner action. + * Returns true if the action was started successfully, and false otherwise. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match + * @returns True if the action was started successfully, and false otherwise. + */ + startAction( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): boolean; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Stops the current Bladeburner action. + * + * @remarks 2 GB + */ + stopBladeburnerAction(): void; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns an object that represents the player’s current Bladeburner action. + * If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”. + * + * @remarks 1 GB + * @returns Object that represents the player’s current Bladeburner action. + */ + getCurrentAction(): BladeburnerCurAction; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the number of seconds it takes to complete the specified action + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Number of seconds it takes to complete the specified action. + */ + getActionTime( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the estimated success chance for the specified action. + * This chance is returned as a decimal value, NOT a percentage + * (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Estimated success chance for the specified action. + */ + getActionEstimatedSuccessChance( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the average Bladeburner reputation gain for successfully + * completing the specified action. + * Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @param level - Optional action level at which to calculate the gain + * @returns Average Bladeburner reputation gain for successfully completing the specified action. + */ + getActionRepGain( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + level: number, + ): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the remaining count of the specified action. + * + * Note that this is meant to be used for Contracts and Operations. + * This function will return ‘Infinity’ for actions such as Training and Field Analysis. + * This function will return 1 for BlackOps not yet completed regardless of wether + * the player has the required rank to attempt the mission or not. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Remaining count of the specified action. + */ + getActionCountRemaining( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the maximum level for this action. + * + * Returns -1 if an invalid action is specified. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Maximum level of the specified action. + */ + getActionMaxLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the current level of this action. + * + * Returns -1 if an invalid action is specified. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Current level of the specified action. + */ + getActionCurrentLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Return a boolean indicating whether or not this action is currently set to autolevel. + * + * Returns false if an invalid action is specified. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns True if the action is set to autolevel, and false otherwise. + */ + getActionAutolevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): boolean; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Enable/disable autoleveling for the specified action. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @param autoLevel - Whether or not to autolevel this action + */ + setActionAutolevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + autoLevel: boolean, + ): void; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Set the level for the specified action. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @param level - Level to set this action to. + */ + setActionLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + level: number, + ): void; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the player’s Bladeburner Rank. + * + * @remarks 4 GB + * @returns Player’s Bladeburner Rank. + */ + getRank(): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the rank required to complete this BlackOp. + * + * Returns -1 if an invalid action is specified. + * + * @remarks 2 GB + * @param name - Name of BlackOp. Must be an exact match. + * @returns Rank required to complete this BlackOp. + */ + getBlackOpRank(name: BladeburnerBlackOps): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the number of Bladeburner skill points you have. + * + * @remarks 4 GB + * @returns Number of Bladeburner skill points you have. + */ + getSkillPoints(): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * This function returns your level in the specified skill. + * + * The function returns -1 if an invalid skill name is passed in. + * + * @remarks 4 GB + * @param skillName - Name of skill. Case-sensitive and must be an exact match + * @returns Level in the specified skill. + */ + getSkillLevel(name: BladeburnerSkills): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * This function returns the number of skill points needed to upgrade the specified skill. + * + * The function returns -1 if an invalid skill name is passed in. + * + * @remarks 4 GB + * @param skillName - Name of skill. Case-sensitive and must be an exact match + * @returns Number of skill points needed to upgrade the specified skill. + */ + getSkillUpgradeCost(name: BladeburnerSkills): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Attempts to upgrade the specified Bladeburner skill. + * + * Returns true if the skill is successfully upgraded, and false otherwise. + * + * @remarks 4 GB + * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match + * @returns true if the skill is successfully upgraded, and false otherwise. + */ + upgradeSkill(name: BladeburnerSkills): boolean; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the number of Bladeburner team members you have assigned to the specified action. + * + * Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Number of Bladeburner team members that were assigned to the specified action. + */ + getTeamSize( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Set the team size for the specified Bladeburner action. + * + * Returns the team size that was set, or -1 if the function failed. + * + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @param size - Number of team members to set. Will be converted using Math.round(). + * @returns Number of Bladeburner team members you assigned to the specified action. + */ + setTeamSize( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + size: number, + ): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the estimated number of Synthoids in the specified city, + * or -1 if an invalid city was specified. + * + * @remarks 4 GB + * @param cityName - Name of city. Case-sensitive + * @returns Estimated number of Synthoids in the specified city. + */ + getCityEstimatedPopulation(name: City): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the estimated number of Synthoid communities in the specified city, + * or -1 if an invalid city was specified. + * + * @remarks 4 GB + * @param cityName - Name of city. Case-sensitive + * @returns Number of Synthoids communities in the specified city. + */ + getCityCommunities(name: City): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the chaos in the specified city, + * or -1 if an invalid city was specified. + * + * @remarks 4 GB + * @param cityName - Name of city. Case-sensitive + * @returns Chaos in the specified city. + */ + getCityChaos(name: City): number; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the city that the player is currently in (for Bladeburner). + * + * @remarks 4 GB + * @returns City that the player is currently in (for Bladeburner). + */ + getCity(): City; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Attempts to switch to the specified city (for Bladeburner only). + * + * Returns true if successful, and false otherwise + * + * @remarks 4 GB + * @param cityName - Name of city. Case-sensitive + * @returns true if successful, and false otherwise + */ + switchCity(name: City): boolean; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns an array with two elements: + * * [Current stamina, Max stamina] + * @example + * ```js + * function getStaminaPercentage() { + * let res = bladeburner.getStamina(); + * return res[0] / res[1]; + * } + * ``` + * @remarks 4 GB + * @returns Array containing current stamina and max stamina. + */ + getStamina(): [number, number]; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Attempts to join the Bladeburner faction. + * + * Returns true if you successfully join the Bladeburner faction, or if you are already a member. + * + * Returns false otherwise. + * + * @remarks 4 GB + * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise. + */ + joinBladeburnerFaction(): boolean; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Attempts to join the Bladeburner division. + * + * Returns true if you successfully join the Bladeburner division, or if you are already a member. + * + * Returns false otherwise. + * + * @remarks 4 GB + * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise. + */ + joinBladeburnerDivision(): boolean; + + /** + * You have to be employed in the Bladeburner division and be in BitNode-7 + * or have Source-File 7 in order to use this function. + * + * Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. + * + * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. + * + * “Bonus time” makes the game progress faster, up to 5x the normal speed. + * For example, if an action takes 30 seconds to complete but you’ve accumulated over + * 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. + * + * @remarks 0 GB + * @returns Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. + */ + getBonusTime(): number; +} + +/** + * @public + */ +export declare type BladeburnerActTypes = "contracts" | "operations" | "black ops" | "general"; + +/** + * @public + */ +export declare type BladeburnerBlackOps = +| "Operation Typhoon" +| "Operation Zero" +| "Operation X" +| "Operation Titan" +| "Operation Ares" +| "Operation Archangel" +| "Operation Juggernaut" +| "Operation Red Dragon" +| "Operation K" +| "Operation Deckard" +| "Operation Tyrell" +| "Operation Wallace" +| "Operation Shoulder of Orion" +| "Operation Hyron" +| "Operation Morpheus" +| "Operation Ion Storm" +| "Operation Annihilus" +| "Operation Ultron" +| "Operation Centurion" +| "Operation Vindictus" +| "Operation Daedalus"; + +/** + * @public + */ +export declare type BladeburnerContracts = "Tracking" | "Bounty Hunter" | "Retirement"; + +/** + * @public + */ +export declare interface BladeburnerCurAction { + /** Type of Action */ + type: BladeburnerActTypes | "Idle"; + /** Name of Action */ + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps; +} + +/** + * @public + */ +export declare type BladeburnerGenActions = +| "Training" +| "Field Analysis" +| "Recruitment" +| "Diplomacy" +| "Hyperbolic Regeneration Chamber"; + +/** + * @public + */ +export declare type BladeburnerOperations = +| "Investigation" +| "Undercover Operation" +| "Sting Operation" +| "Raid" +| "Stealth Retirement Operation" +| "Assassination"; + +/** + * @public + */ +export declare type BladeburnerSkills = +| "Blade's Intuition" +| "Cloak" +| "Marksman" +| "Weapon Proficiency" +| "Short-Circuit" +| "Digital Observer" +| "Tracer" +| "Overclock" +| "Reaper" +| "Evasive System" +| "Datamancer" +| "Cyber's Edge" +| "Hands of Midas" +| "Hyperdrive"; + +/** + * @public + */ +export declare interface CharacterInfo { + /** Current BitNode number */ + bitnode: number; + /** Name of city you are currently in */ + city: City; + /** Array of factions you are currently a member of */ + factions: FactionName[]; + /** Current health points */ + hp: number; + /** Array of all companies at which you have jobs */ + company: CompanyName[]; + /** Array of job positions for all companies you are employed at. Same order as 'jobs' */ + jobTitle: CompanyField[]; + /** Maximum health points */ + maxHp: number; + /** Boolean indicating whether or not you have a tor router */ + tor: boolean; + /** Object with many of the player's multipliers from Augmentations/Source Files */ + mult: CharacterMult; + /** Timed worked in ms */ + timeWorked: number; + /** Hacking experience earned so far from work */ + workHackExpGain: number; + /** Str experience earned so far from work */ + workStrExpGain: number; + /** Def experience earned so far from work */ + workDefExpGain: number; + /** Dex experience earned so far from work */ + workDexExpGain: number; + /** Agi experience earned so far from work */ + workAgiExpGain: number; + /** Cha experience earned so far from work */ + workChaExpGain: number; + /** Reputation earned so far from work, if applicable */ + workRepGain: number; + /** Money earned so far from work, if applicable */ + workMoneyGain: number; +} + +/** + * @public + */ +export declare interface CharacterMult { + /** Agility stat */ + agility: number; + /** Agility exp */ + agilityExp: number; + /** Company reputation */ + companyRep: number; + /** Money earned from crimes */ + crimeMoney: number; + /** Crime success chance */ + crimeSuccess: number; + /** Defense stat */ + defense: number; + /** Defense exp */ + defenseExp: number; + /** Dexterity stat */ + dexterity: number; + /** Dexterity exp */ + dexterityExp: number; + /** Faction reputation */ + factionRep: number; + /** Hacking stat */ + hacking: number; + /** Hacking exp */ + hackingExp: number; + /** Strength stat */ + strength: number; + /** Strength exp */ + strengthExp: number; + /** Money earned from jobs */ + workMoney: number; +} + +/** + * @public + */ +export declare type City = "Aevum" | "Chongqing" | "Sector-12" | "New Tokyo" | "Ishima" | "Volhaven"; + +/** + * @public + */ +export declare interface CodingAttemptOptions { + /** If truthy, then the function will return a string that states the contract’s reward when it is successfully solved. */ + returnReward: boolean; +} + +/** + * @public + */ +export declare interface CodingContract { + /** + * Attempts to solve the Coding Contract with the provided solution. + * + * @remarks 10 GB + * @param answer - Solution for the contract. + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns True if the solution was correct, false otherwise. + */ + attempt(answer: string | string[] | number, fn: string, host?: Host): boolean; + + /** + * Attempts to solve the Coding Contract with the provided solution. + * + * @remarks 10 GB + * @param answer - Solution for the contract. + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @param opts - Optional parameters for configuring function behavior. + * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string. + */ + attempt(answer: string | string[] | number, fn: string, host?: Host, opts?: CodingAttemptOptions): boolean | string; + + /** + * Returns a name describing the type of problem posed by the Coding Contract. + * (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) + * + * @remarks 5 GB + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns Name describing the type of problem posed by the Coding Contract. + */ + getContractType(fn: string, host?: Host): CodingContractTypes; + + /** + * Get the full text description for the problem posed by the Coding Contract. + * + * @remarks 5 GB + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns Contract’s text description. + */ + getDescription(fn: string, host?: Host): string; + + /** + * Get the data associated with the specific Coding Contract. + * Note that this is not the same as the contract’s description. + * This is just the data that the contract wants you to act on in order to solve + * + * @remarks 5 GB + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns The specified contract’s data; + */ + getData(fn: string, host?: Host): string; + + /** + * Get the number of tries remaining on the contract before it self-destructs. + * + * @remarks 2 GB + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns How many attempts are remaining for the contract; + */ + getNumTriesRemaining(fn: string, host?: Host): number; +} + +/** + * @public + */ +export declare type CodingContractTypes = +| "Find Largest Prime Factor" +| "Subarray with Maximum Sum" +| "Total Ways to Sum" +| "Spiralize Matrix" +| "Array Jumping Game" +| "Merge Overlapping Intervals" +| "Generate IP Addresses" +| "Algorithmic Stock Trader I" +| "Algorithmic Stock Trader II" +| "Algorithmic Stock Trader III" +| "Algorithmic Stock Trader IV" +| "Minimum Path Sum in a Triangle" +| "Unique Paths in a Grid I" +| "Unique Paths in a Grid II" +| "Sanitize Parentheses in Expression" +| "Find All Valid Math Expressions"; + +/** + * @public + */ +export declare type CompanyField = +| "software" +| "software consultant" +| "it" +| "security engineer" +| "network engineer" +| "business" +| "business consultant" +| "security" +| "agent" +| "employee" +| "part-time employee" +| "waiter" +| "part-time waiter"; + +/** + * @public + */ +export declare type CompanyName = +// Sector-12 +| "MegaCorp" +| "BladeIndustries" +| "FourSigma" +| "IcarusMicrosystems" +| "UniversalEnergy" +| "DeltaOne" +| "CIA" +| "NSA" +| "AlphaEnterprises" +| "CarmichaelSecurity" +| "FoodNStuff" +| "JoesGuns" + +// Aevum +| "ECorp" +| "BachmanAndAssociates" +| "ClarkeIncorporated" +| "OmniTekIncorporated" +| "FulcrumTechnologies" +| "GalacticCybersystems" +| "AeroCorp" +| "WatchdogSecurity" +| "RhoConstruction" +| "AevumPolice" +| "NetLinkTechnologies" + +// Volhaven +| "NWO" +| "HeliosLabs" +| "OmniaCybersystems" +| "LexoCorp" +| "SysCoreSecurities" +| "CompuTek" + +// Chongqing +| "KuaiGongInternational" +| "SolarisSpaceSystems" + +// Ishima +| "StormTechnologies" +| "NovaMedical" +| "OmegaSoftware" + +// New Tokyo +| "DefComm" +| "VitaLife" +| "GlobalPharmaceuticals" +| "NoodleBar"; + +/** + * @public + */ +export declare type CreatableProgram = PurchaseableProgram | "serverprofiler.exe"; + +/** + * @public + */ +export declare type Crime = +| "shoplift" +| "rob store" +| "mug" +| "larceny" +| "deal drugs" +| "bond forgery" +| "traffick arms" +| "homicide" +| "grand theft auto" +| "kidnap" +| "assassinate" +| "heist"; + +/** + * @public + */ +export declare interface CrimeStats { + /** Number representing the difficulty of the crime. Used for success chance calculations */ + difficulty: number; + /** Amount of karma lost for SUCCESSFULLY committing this crime */ + karma: number; + /** How many people die as a result of this crime */ + kills: number; + /** How much money is given */ + money: number; + /** Name of crime */ + name: number; + /** Milliseconds it takes to attempt the crime */ + time: number; + /** Description of the crime activity */ + type: string; + /** hacking level impact on success change of the crime */ + hacking_success_weight: number; + /** strength level impact on success change of the crime */ + strength_success_weight: number; + /** defense level impact on success change of the crime */ + defense_success_weight: number; + /** dexterity level impact on success change of the crime */ + dexterity_success_weight: number; + /** agility level impact on success change of the crime */ + agility_success_weight: number; + /** charisma level impact on success change of the crime */ + charisma_success_weight: number; + /** hacking exp gained from crime */ + hacking_exp: number; + /** strength exp gained from crime */ + strength_exp: number; + /** defense exp gained from crime */ + defense_exp: number; + /** dexterity exp gained from crime */ + dexterity_exp: number; + /** agility exp gained from crime */ + agility_exp: number; + /** charisma exp gained from crime */ + charisma_exp: number; + /** intelligence exp gained from crime */ + intelligence_exp: number; +} + +/** + * @public + */ +export declare type FactionName = +| "Illuminati" +| "Daedalus" +| "The Covenant" +| "ECorp" +| "MegaCorp" +| "Bachman & Associates" +| "Blade Industries" +| "NWO" +| "Clarke Incorporated" +| "OmniTek Incorporated" +| "Four Sigma" +| "KuaiGong International" +| "Fulcrum Secret Technologies" +| "BitRunners" +| "The Black Hand" +| "NiteSec" +| "Aevum" +| "Chongqing" +| "Ishima" +| "New Tokyo" +| "Sector-12" +| "Volhaven" +| "Speakers for the Dead" +| "The Dark Army" +| "The Syndicate" +| "Silhouette" +| "Tetrads" +| "Slum Snakes" +| "Netburners" +| "Tian Di Hui" +| "CyberSec" +| "Bladeburners"; + +/** + * @public + */ +export declare type FactionWork = "hacking" | "field" | "security"; + +/** + * @public + */ +export declare interface Gang { + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get the names of all Gang members + * + * @remarks 1 GB + * @returns Names of all Gang members. + */ + getMemberNames(): string[]; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get general information about the gang. + * + * @remarks 2 GB + * @returns Object containing general information about the gang. + */ + getGangInformation(): GangGenInfo; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get territory and power information about all gangs. + * + * @remarks 2 GB + * @returns Object containing territory and power information about all gangs. + */ + getOtherGangInformation(): GangOtherInfo; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get stat and equipment-related information about a Gang Member + * + * @remarks 2 GB + * @param name - Name of member. + * @returns Object containing stat and equipment-related information about a Gang Member. + */ + getMemberInformation(name: string): GangMemberInfo; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Returns boolean indicating whether a member can currently be recruited + * + * @remarks 1 GB + * @returns True if a member can currently be recruited, false otherwise. + */ + canRecruitMember(): boolean; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Attempt to recruit a new gang member. + * + * Possible reasons for failure: + * * Cannot currently recruit a new member + * * There already exists a member with the specified name + * + * @remarks 2 GB + * @param name - Name of member to recruit. + * @returns True if the member was successfully recruited, false otherwise. + */ + recruitMember(name: string): boolean; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get the name of all valid tasks that Gang members can be assigned to. + * + * @remarks 1 GB + * @returns All valid tasks that Gang members can be assigned to. + */ + getTaskNames(): GangTasks[]; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Attempts to assign the specified Gang Member to the specified task. + * If an invalid task is specified, the Gang member will be set to idle (“Unassigned”). + * + * @remarks 2 GB + * @param memberName - Name of Gang member to assign. + * @param taskName - Task to assign. + * @returns True if the Gang Member was successfully assigned to the task, false otherwise. + */ + setMemberTask(memberName: string, taskName: GangTasks): boolean; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. + * + * @remarks 1 GB + * @param name - Name of the task. + * @returns Detailed stats of a task. + */ + getTaskStats(name: GangTasks): GangTasksStats; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. + * This includes Augmentations. + * + * @remarks 1 GB + * @returns Names of all Equpiment/Augmentations. + */ + getEquipmentNames(): (GangEquipment | GangAugmentations)[]; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. + * If an invalid Equipment/Augmentation is specified, this function will return Infinity. + * + * @remarks 2 GB + * @param equipName - Name of equipment. + * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments + */ + getEquipmentCost(equipName: GangEquipment | GangAugmentations): number; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get the specified equipment type. + * + * @remarks 2 GB + * @param equipName - Name of equipment. + * @returns Type of the equipment. + */ + getEquipmentType(equipName: GangEquipment | GangAugmentations): GangEquipmentType; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Get the specified equipment stats. + * + * @remarks 2 GB + * @param equipName - Name of equipment. + * @returns A dictionary containing the stats of the equipment. + */ + getEquipmentStats(equipName: GangEquipment | GangAugmentations): GangEquipmentStats; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. + * + * @remarks 4 GB + * @param memberName - Name of Gang member to purchase the equipment for. + * @param equipName - Name of Equipment/Augmentation to purchase. + * @returns True if the equipment was successfully purchased. False otherwise + */ + purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentations): boolean; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Ascend the specified Gang Member. + * + * @remarks 4 GB + * @param memberName - Name of member to ascend. + * @returns Object with info about the ascension results. + */ + ascendMember(memberName: string): GangMemberAscension; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Set whether or not the gang should engage in territory warfare + * + * @remarks 2 GB + * @param engage - Whether or not to engage in territory warfare. + */ + setTerritoryWarfare(engage: boolean): void; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage + * + * @remarks 4 GB + * @param gangName - Target gang + * @returns Chance you have to win a clash with the specified gang. + */ + getChanceToWinClash(gangName: GangName): number; + + /** + * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + * + * Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. + * + * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. + * + * “Bonus time” makes the game progress faster, up to 10x the normal speed. + * + * @remarks 0 GB + * @returns Bonus time for the Gang mechanic in seconds. + */ + getBonusTime(): number; +} + +/** + * @public + */ +export declare type GangAugmentations = +| "Bionic Arms" +| "Bionic Legs" +| "Bionic Spine" +| "BrachiBlades" +| "Nanofiber Weave" +| "Synthetic Heart" +| "Synfibril Muscle" +| "BitWire" +| "Neuralstimulator" +| "DataJack" +| "Graphene Bone Lacings"; + +/** + * @public + */ +export declare type GangEquipment = +| "Baseball Bat" +| "Katana" +| "Glock 18C" +| "P90C" +| "Steyr AUG" +| "AK-47" +| "M15A10 Assault Rifle" +| "AWM Sniper Rifle" +| "Bulletproof Vest" +| "Full Body Armor" +| "Liquid Body Armor" +| "Graphene Plating Armor" +| "Ford Flex V20" +| "ATX1070 Superbike" +| "Mercedes-Benz S9001" +| "White Ferrari" +| "NUKE Rootkit" +| "Soulstealer Rootkit" +| "Demon Rootkit" +| "Hmap Node" +| "Jack the Ripper"; + +/** + * @public + */ +export declare interface GangEquipmentStats { + /** Strength multiplier */ + str: number; + /** Defense multiplier */ + def: number; + /** Dexterity multiplier */ + dex: number; + /** Agility multiplier */ + agi: number; + /** Charisma multiplier */ + cha: number; + /** Hacking multiplier */ + hack: number; +} + +/** + * @public + */ +export declare type GangEquipmentType = "Weapon" | "Armor" | "Vehicle" | "Rootkit" | "Augmentation"; + +/** + * @public + */ +export declare interface GangGenInfo { + /** Name of faction that the gang belongs to ("Slum Snakes", etc.) */ + faction: GangName; + /** Boolean indicating whether or not its a hacking gang */ + isHacking: boolean; + /** Money earned per second */ + moneyGainRate: number; + /** Gang's power for territory warfare */ + power: number; + /** Gang's respect */ + respect: number; + /** Respect earned per second */ + respectGainRate: number; + /** Amount of territory held. Returned in decimal form, not percentage */ + territory: number; + /** Clash chance. Returned in decimal form, not percentage */ + territoryClashChance: number; + /** Gang's wanted level */ + wantedLevel: number; + /** Wanted level gained/lost per second (negative for losses) */ + wantedLevelGainRate: number; +} + +/** + * @public + */ +export declare interface GangMemberAscension { + /** Amount of respect lost from ascending */ + respect: number; + /** Hacking multiplier gained from ascending. Decimal form */ + hack: number; + /** Strength multiplier gained from ascending. Decimal form */ + str: number; + /** Defense multiplier gained from ascending. Decimal form */ + def: number; + /** Dexterity multiplier gained from ascending. Decimal form */ + dex: number; + /** Agility multiplier gained from ascending. Decimal form */ + agi: number; + /** Charisma multiplier gained from ascending. Decimal form */ + cha: number; +} + +/** + * @public + */ +export declare interface GangMemberInfo { + /** Agility stat */ + agility: number; + /** Agility multiplier from equipment. Decimal form */ + agilityEquipMult: number; + /** Agility multiplier from ascension. Decimal form */ + agilityAscensionMult: number; + /** Array of names of all owned Augmentations */ + augmentations: GangAugmentations[]; + /** Charisma stat */ + charisma: number; + /** Charisma multiplier from equipment. Decimal form */ + charismaEquipMult: number; + /** Charisma multiplier from ascension. Decimal form */ + charismaAscensionMult: number; + /** Defense stat */ + defense: number; + /** Defense multiplier from equipment. Decimal form */ + defenseEquipMult: number; + /** Defense multiplier from ascension. Decimal form */ + defenseAscensionMult: number; + /** Dexterity stat */ + dexterity: number; + /** Dexterity multiplier from equipment. Decimal form */ + dexterityEquipMult: number; + /** Dexterity multiplier from ascension. Decimal form */ + dexterityAscensionMult: number; + /** Array of names of all owned Non-Augmentation Equipment */ + equipment: GangEquipment[]; + /** Hacking stat */ + hacking: number; + /** Hacking multiplier from equipment. Decimal form */ + hackingEquipMult: number; + /** Hacking multiplier from ascension. Decimal form */ + hackingAscensionMult: number; + /** Strength stat */ + strength: number; + /** Strength multiplier from equipment. Decimal form */ + strengthEquipMult: number; + /** Strength multiplier from ascension. Decimal form */ + strengthAscensionMult: number; + /** Name of currently assigned task */ + task: GangTasks; +} + +/** + * @public + */ +export declare type GangName = +| "Slum Snakes" +| "Tetrads" +| "The Syndicate" +| "The Dark Army" +| "Speakers for the Dead" +| "NiteSec" +| "The Black Hand"; + +/** + * @public + */ +export declare type GangOtherInfo = { + /** Stock Symbol */ + [key in GangName]: GangOtherInfoObject[]; +}; + +/** + * @public + */ +export declare interface GangOtherInfoObject { + /** Gang power */ + power: number; + /** Gang territory, in decimal form */ + territory: number; +} + +/** + * @public + */ +export declare type GangTasks = +| "Unassigned" +| "Ransomware" +| "Phishing" +| "Identity Theft" +| "DDoS Attacks" +| "Plant Virus" +| "Fraud & Counterfeiting" +| "Money Laundering" +| "Cyberterrorism" +| "Ethical Hacking" +| "Mug People" +| "Deal Drugs" +| "Strongarm Civilians" +| "Run a Con" +| "Armed Robbery" +| "Traffick Illegal Arms" +| "Threaten & Blackmail" +| "Human Trafficking" +| "Terrorism" +| "Vigilante Justice" +| "Train Combat" +| "Train Hacking" +| "Train Charisma" +| "Territory Warfare"; + +/** + * @public + */ +export declare interface GangTasksStats { + /** Task name */ + name: GangTasks; + /** Task Description */ + desc: string; + /** Is a task of a hacking gang */ + isHacking: boolean; + /** Is a task of a combat gang */ + isCombat: boolean; + /** Base respect earned */ + baseRespect: number; + /** Base wanted earned */ + baseWanted: number; + /** Base money earned */ + baseMoney: number; + /** Hacking skill impact on task scaling */ + hackWeight: number; + /** Stength skill impact on task scaling */ + strWeight: number; + /** Defense skill impact on task scaling */ + defWeight: number; + /** Dexterity skill impact on task scaling */ + dexWeight: number; + /** Agility skill impact on task scaling */ + agiWeight: number; + /** Charisma skill impact on task scaling */ + chaWeight: number; + /** Number representing the difficulty of the task */ + difficulty: number; + /** Territory impact on task scaling */ + territory: GangTasksTerritory; +} + +/** + * @public + */ +export declare interface GangTasksTerritory { + /** Money gain impact on task scaling */ + money: number; + /** Respect gain impact on task scaling */ + respect: number; + /** Wanted gain impact on task scaling */ + wanted: number; +} + +/** + * @public + */ +export declare type Gym = "Crush Fitness Gym" | "Snap Fitness Gym" | "Iron Gym" | "Powerhouse Gym" | "Millenium Fitness Gym"; + +/** + * @public + */ +export declare type GymStat = "str" | "def" | "dex" | "agi"; + +/** + * @public + */ +export declare interface HackingMultipliers { + /** Player's hacking chance multiplier. */ + chance: number; + /** Player's hacking speed multiplier. */ + speed: number; + /** Player's hacking money stolen multiplier. */ + money: number; + /** Player's hacking growth multiplier */ + growth: number; +} + +/** + * @public + */ +export declare interface HackNet { + /** + * Returns the number of Hacknet Nodes you own. + * + * @remarks 0 GB + * @returns number of hacknet nodes. + */ + numNodes(): number; + + /** + * Purchases a new Hacknet Node. Returns a number with the index of the + * Hacknet Node. This index is equivalent to the number at the end of + * the Hacknet Node’s name (e.g The Hacknet Node named \`hacknet-node-4\` + * will have an index of 4). + * + * If the player cannot afford to purchase a new Hacknet Node then the function will return -1. + * + * @remarks 0 GB + * @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1. + */ + purchaseNode(): number; + + /** + * Returns the cost of purchasing a new Hacknet Node. + * + * @remarks 0 GB + * @returns Cost of purchasing a new Hacknet Node. + */ + getPurchaseNodeCost(): number; + + /** + * Returns an object containing a variety of stats about the specified Hacknet Node. + * + * Note that for Hacknet Nodes, production refers to the amount of money the node generates. + * For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the + * amount of hashes the node generates. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node + * @returns Object containing a variety of stats about the specified Hacknet Node. + */ + getNodeStats(index: number): NodeStats; + + /** + * Tries to upgrade the level of the specified Hacknet Node by n. + * + * Returns true if the Hacknet Node’s level is successfully upgraded by n + * or if it is upgraded by some positive amount and the Node reaches its max level. + * + * Returns false otherwise. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer. + * @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise. + */ + upgradeLevel(index: number, n: number): boolean; + + /** + * Tries to upgrade the specified Hacknet Node’s RAM n times. + * Note that each upgrade doubles the Node’s RAM. + * So this is equivalent to multiplying the Node’s RAM by 2 n. + * + * Returns true if the Hacknet Node’s RAM is successfully upgraded n times + * or if it is upgraded some positive number of times and the Node reaches it max RAM. + * + * Returns false otherwise. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. + * @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise. + */ + upgradeRam(index: number, n: number): boolean; + + /** + * Tries to purchase n cores for the specified Hacknet Node. + * + * Returns true if it successfully purchases n cores for the Hacknet Node + * or if it purchases some positive amount and the Node reaches its max number of cores. + * + * Returns false otherwise. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer. + * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise. + */ + upgradeCore(index: number, n: number): boolean; + + /** + * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + * + * Tries to upgrade the specified Hacknet Server’s cache n times. + * + * Returns true if it successfully upgrades the Server’s cache n times, + * or if it purchases some positive amount and the Server reaches its max cache level. + * + * Returns false otherwise. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer. + * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise. + */ + upgradeCache(index: number, n: number): boolean; + + /** + * Returns the cost of upgrading the specified Hacknet Node by n levels. + * + * If an invalid value for n is provided, then this function returns 0. + * If the specified Hacknet Node is already at max level, then Infinity is returned. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer. + * @returns Cost of upgrading the specified Hacknet Node. + */ + getLevelUpgradeCost(index: number, n: number): number; + + /** + * Returns the cost of upgrading the RAM of the specified Hacknet Node n times. + * + * If an invalid value for n is provided, then this function returns 0. + * If the specified Hacknet Node is already at max level, then Infinity is returned. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. + * @returns Cost of upgrading the specified Hacknet Node's ram. + */ + getRamUpgradeCost(index: number, n: number): number; + + /** + * Returns the cost of upgrading the number of cores of the specified Hacknet Node by n. + * + * If an invalid value for n is provided, then this function returns 0. + * If the specified Hacknet Node is already at max level, then Infinity is returned. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer. + * @returns Cost of upgrading the specified Hacknet Node's number of cores. + */ + getCoreUpgradeCost(index: number, n: number): number; + + /** + * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + * + * Returns the cost of upgrading the cache level of the specified Hacknet Server by n. + * + * If an invalid value for n is provided, then this function returns 0. + * If the specified Hacknet Node is already at max level, then Infinity is returned. + * + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer. + * @returns Cost of upgrading the specified Hacknet Node's cache. + */ + getCacheUpgradeCost(index: number, n: number): number; + + /** + * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + * + * Returns the number of hashes you have. + * + * @remarks 0 GB + * @returns Number of hashes you have. + */ + numHashes(): number; + + /** + * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + * + * Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match. + * + * @example + * ```js + * var upgradeName = "Sell for Corporation Funds"; + * if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) { + * hacknet.spendHashes(upgName); + * } + * ``` + * @remarks 0 GB + * @param upgName - Name of the upgrade of Hacknet Node. + * @returns Number of hashes required for the specified upgrade. + */ + hashCost(upgName: HashUpgrades): number; + + /** + * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + * + * Spend the hashes generated by your Hacknet Servers on an upgrade. + * Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise. + * + * The name of the upgrade must be an exact match. + * The \`upgTarget\` argument is used for upgrades such as \`Reduce Minimum Security\`, which applies to a specific server. + * In this case, the \`upgTarget\` argument must be the hostname of the server. + * + * @example + * ```js + * hacknet.spendHashes("Sell for Corporation Funds"); + * hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); + * ``` + * @remarks 0 GB + * @param upgName - Name of the upgrade of Hacknet Node. + * @param upgTarget - Object to which upgrade applies. Required for certain upgrades. + * @returns True if the upgrade is successfully purchased, and false otherwise.. + */ + spendHashes(upgName: HashUpgrades, upgTarget?: Host): boolean; +} + +/** + * @public + */ +export declare interface HacknetMultipliers { + /** Player's hacknet production multiplier */ + production: number; + /** Player's hacknet purchase cost multiplier */ + purchaseCost: number; + /** Player's hacknet ram cost multiplier */ + ramCost: number; + /** Player's hacknet core cost multiplier */ + coreCost: number; + /** Player's hacknet level cost multiplier */ + levelCost: number; +} + +/** + * @public + */ +export declare type Handle = string | Port; + +/** + * @public + */ +export declare type HashUpgrades = +| "Sell for Money" +| "Sell for Corporation Funds" +| "Reduce Minimum Security" +| "Increase Maximum Money" +| "Improve Studying" +| "Improve Gym Training" +| "Exchange for Corporation Research" +| "Exchange for Bladeburner Rank" +| "Exchange for Bladeburner SP" +| "Generate Coding Contract"; + +/** + * @public + */ +export declare type Host = string; + +/** + * @public + */ +export declare interface NodeStats { + /** Node's name ("hacknet-node-5") */ + name: string; + /** Node's level */ + level: number; + /** Node's RAM */ + ram: number; + /** Node's number of cores */ + cores: number; + /** Cache level. Only applicable for Hacknet Servers */ + cache: number; + /** Hash Capacity provided by this Node. Only applicable for Hacknet Servers */ + hashCapacity: number; + /** Node's production per second */ + production: number; + /** Number of seconds since Node has been purchased */ + timeOnline: number; + /** Total number of money Node has produced */ + totalProduction: number; +} + +/** + * @public + */ +export declare interface NS extends Singularity { + /** + * Not all functions in the Hacknet Node API are immediately available. + * + * Note that none of these functions will write to the script’s logs. + * + * If you want to see what your script is doing you will have to print to the logs yourself. + * + * @remarks 4 GB + */ + readonly hacknet: HackNet; + /** + * @remarks 0 GB + */ + readonly bladeburner: Bladeburner; + /** + * @remarks 0 GB + */ + readonly codingcontract: CodingContract; + /** + * @remarks 0 GB + */ + readonly gang: Gang; + /** + * @remarks 0 GB + */ + readonly sleeve: Sleeve; + /** + * @remarks 0 GB + */ + readonly stock: TIX; + + /** + * Arguments passed into a script can be accessed using a normal + * array using the [] operator (args[0], args[1], etc…). + * + * It is also possible to get the number of arguments that was passed into a script using: + * ```js + * args.length + * ``` + * WARNING: Do not try to modify the args array. This will break the game. + * + * @remarks 0 GB + */ + readonly args: any[]; + + /** + * Function that is used to try and hack servers to steal money and gain hacking experience. + * The runtime for this command depends on your hacking level and the target server’s + * security level. In order to hack a server you must first gain root access to that server + * and also have the required hacking level. + * + * A script can hack a server from anywhere. It does not need to be running on the same + * server to hack that server. For example, you can create a script that hacks the \`foodnstuff\` + * server and run that script on any server in the game. + * + * A successful \`hack()\` on a server will raise that server’s security level by 0.002. + * + * @example + * ```js + * hack("foodnstuff"); + * hack("10.1.2.3"); + * hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack + * ``` + * @remarks 0.1 GB + * @param host - Hostname or IP of the target server to hack. + * @param opts - Optional parameters for configuring function behavior. + * @returns The amount of money stolen if the hack is successful, and zero otherwise. + */ + hack(host: Host, opts?: BasicHGWOptions): Promise; + + /** + * Use your hacking skills to increase the amount of money available on a server. + * The runtime for this command depends on your hacking level and the target server’s + * security level. When \`grow\` completes, the money available on a target server will + * be increased by a certain, fixed percentage. This percentage is determined by the + * target server’s growth rate (which varies between servers) and security level. Generally, + * higher-level servers have higher growth rates. The getServerGrowth() function can be used + * to obtain a server’s growth rate. + * + * Like hack, \`grow\` can be called on any server, regardless of where the script is running. + * The grow() command requires root access to the target server, but there is no required hacking + * level to run the command. It also raises the security level of the target server by 0.004. + * + * @example + * ```js + * grow("foodnstuff"); + * grow("foodnstuff", { threads: 5 }); // Only use 5 threads to grow + * ``` + * @remarks 0.15 GB + * @param host - Hostname or IP of the target server to grow. + * @param opts - Optional parameters for configuring function behavior. + * @returns The number by which the money on the server was multiplied for the growth. + */ + grow(host: Host, opts?: BasicHGWOptions): Promise; + + /** + * Use your hacking skills to attack a server’s security, lowering the server’s security level. + * The runtime for this command depends on your hacking level and the target server’s security + * level. This function lowers the security level of the target server by 0.05. + * + * Like hack and grow, \`weaken\` can be called on any server, regardless of + * where the script is running. This command requires root access to the target server, but + * there is no required hacking level to run the command. + * + * @example + * ```js + * weaken("foodnstuff"); + * weaken("foodnstuff", { threads: 5 }); // Only use 5 threads to weaken + * ``` + * @remarks 0.15 GB + * @param host - Hostname or IP of the target server to weaken. + * @param opts - Optional parameters for configuring function behavior. + * @returns The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads. + */ + weaken(host: Host, opts?: BasicHGWOptions): Promise; + + /** + * Returns the security decrease that would occur if a weaken with this many threads happened. + * + * @remarks 1 GB + * @param threads - Amount of threads that will be used. + * @param cores - Optional. The number of cores of the server that would run weaken. + * @returns The security decrease. + */ + weakenAnalyze(threads: number, cores?: number): number; + + /** + * This function returns the number of script threads you need when running the hack command + * to steal the specified amount of money from the target server. + * If hackAmount is less than zero or greater than the amount of money available on the server, + * then this function returns -1. + * + * Warning: The value returned by this function isn’t necessarily a whole number. + * + * @example + * ```js + * //For example, let’s say the foodnstuff server has $10m and you run: + * hackAnalyzeThreads("foodnstuff", 1e6); + * //If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server. + * ``` + * @remarks 1 GB + * @param host - Hostname or IP of the target server to analyze. + * @param hackAmount - Amount of money you want to hack from the server. + * @returns The number of threads needed to hack the server for hackAmount money. + */ + hackAnalyzeThreads(host: Host, hackAmount: number): number; + + /** + * Returns the percentage of the specified server’s money you will steal with a single hack. + * This value is returned in percentage form, not decimal + * (Netscript functions typically return in decimal form, but not this one). + * + * @example + * ```js + * //For example, assume the following returns 1: + * hackAnalyzePercent("foodnstuff"); + * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N% of its total money. + * ``` + * @remarks 1 GB + * @param host - Hostname or IP of the target server. + * @returns The percentage of money you will steal from the target server with a single hack. + */ + hackAnalyzePercent(host: Host): number; + + /** + * Returns the security increase that would occur if a hack with this many threads happened. + * + * @remarks 1 GB + * @param threads - Amount of threads that will be used. + * @returns The security increase. + */ + hackAnalyzeSecurity(threads: number): number; + + /** + * Returns the chance you have of successfully hacking the specified server. + * + * This returned value is in decimal form, not percentage. + * + * @remarks 1 GB + * @param host - Hostname or IP of the target server. + * @returns The chance you have of successfully hacking the target server. + */ + hackChance(host: Host): number; + + /** + * This function returns the number of “growths” needed in order to increase + * the amount of money available on the specified server by the specified amount. + * The specified amount is multiplicative and is in decimal form, not percentage. + * + * Warning: The value returned by this function isn’t necessarily a whole number. + * + * @example + * ```js + * //For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use: + * growthAnalyze("foodnstuff", 2); + * //If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads). + * ``` + * @remarks 1 GB + * @param host - Hostname or IP of the target server. + * @param growthAmount - Multiplicative factor by which the server is grown. Decimal form.. + * @returns The amount of grow calls needed to grow the specified server by the specified amount + */ + growthAnalyze(host: Host, growthAmount: number): number; + + /** + * Returns the security increase that would occur if a grow with this many threads happened. + * + * @remarks 1 GB + * @param threads - Amount of threads that will be used. + * @returns The security increase. + */ + growthAnalyzeSecurity(threads: number): number; + + /** + * Suspends the script for n milliseconds. + * + * @remarks 0 GB + * @param millis - Number of milliseconds to sleep. + * @returns + */ + sleep(millis: number): Promise; + + /** + * Prints a value or a variable to the script’s logs. + * + * @remarks 0 GB + * @param msg - Value to be printed. + */ + print(msg: string | number | string[] | number[]): void; + + /** + * Prints a value or a variable to the Terminal. + * + * @remarks 0 GB + * @param msg - Value to be printed. + */ + tprint(msg: string | number | string[] | number[]): void; + + /** + * Clears the script’s logs. + * + * @remarks 0 GB + */ + clearLog(): void; + + /** + * Disables logging for the given function. Logging can be disabled + * for all functions by passing \`ALL\` as the argument. + * + * Note that this does not completely remove all logging functionality. + * This only stops a function from logging when the function is successful. + * If the function fails, it will still log the reason for failure. + * + * Notable functions that cannot have their logs disabled: run, + * exec, exit. + * + * @remarks 0 GB + * @param fn - Name of function for which to disable logging. + */ + disableLog(fn: string): void; + + /** + * Re-enables logging for the given function. If \`ALL\` is passed into this + * function as an argument, then it will revert the effects of disableLog(\`ALL\`). + * + * @remarks 0 GB + * @param fn - Name of function for which to enable logging. + */ + enableLog(fn: string): void; + + /** + * Checks the status of the logging for the given function. + * + * @remarks 0 GB + * @param fn - Name of function to check. + * @returns Returns a boolean indicating whether or not logging is enabled for that function (or \`ALL\`) + */ + isLogEnabled(fn: string): boolean; + + /** + * Returns a script’s logs. The logs are returned as an array, where each line is an element in the array. + * The most recently logged line is at the end of the array. + * Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the game’s options. + * If the function is called with no arguments, it will return the current script’s logs. + * + * Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. + * Remember that scripts are uniquely identified by both their names and arguments. + * + * @example + * ```js + * //Get logs from foo.script on the current server that was run with no args + * getScriptLogs("foo.script"); + * ``` + * @example + * ```js + * //Open logs from foo.script on the foodnstuff server that was run with no args + * getScriptLogs("foo.script", "foodnstuff"); + * ``` + * @example + * ```js + * //Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] + * getScriptLogs("foo.script", "foodnstuff", 1, "test"); + * ``` + * @remarks 0 GB + * @param fn - Optional. Filename of script to get logs from. + * @param host - Optional. Hostname or IP of the server that the script is on. + * @param args - Arguments to identify which scripts to get logs for. + * @returns Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array. + */ + getScriptLogs(fn?: Script, host?: Host, ...args: any[]): string[]; + + /** + * Opens a script’s logs. This is functionally the same as the tail Terminal command. + * + * If the function is called with no arguments, it will open the current script’s logs. + * + * Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. + * Remember that scripts are uniquely identified by both their names and arguments. + * + * @example + * ```js + * //Open logs from foo.script on the current server that was run with no args + * tail("foo.script"); + * ``` + * @example + * ```js + * //Get logs from foo.script on the foodnstuff server that was run with no args + * tail("foo.script", "foodnstuff"); + * ``` + * @example + * ```js + * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] + * tail("foo.script", "foodnstuff", 1, "test"); + * ``` + * @remarks 0 GB + * @param fn - Optional. Filename of the script being tailed. If omitted, the current script is tailed. + * @param host - Optional. Hostname or IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. + * @param args - Arguments for the script being tailed. + */ + tail(fn?: Script, host?: Host, ...args: any[]): void; + + /** + * Returns an array containing the hostnames or IPs of all servers that are one + * node way from the specified target server. The hostnames/IPs in the returned + * array are strings. + * + * @remarks 0.2 GB + * @param host - Hostname or IP of the server to scan. + * @param hostnames - Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false). + * @returns Returns an string of hostnames or IP. + */ + scan(host: Host, hostnames?: boolean): Host[]; + + /** + * Runs the NUKE.exe program on the target server. NUKE.exe must exist on your home computer. + * + * @example + * ```js + * nuke("foodnstuff"); + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. + */ + nuke(host: Host): void; + + /** + * Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer. + * + * @example + * ```js + * brutessh("foodnstuff"); + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. + */ + brutessh(host: Host): void; + + /** + * Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer. + * + * @example + * ```js + * ftpcrack("foodnstuff"); + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. + */ + ftpcrack(host: Host): void; + + /** + * Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer. + * + * @example + * ```js + * relaysmtp("foodnstuff"); + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. + */ + relaysmtp(host: Host): void; + + /** + * Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer. + * + * @example + * ```js + * httpworm("foodnstuff"); + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. + */ + httpworm(host: Host): void; + + /** + * Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer. + * + * @example + * ```js + * sqlinject("foodnstuff"); + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. + */ + sqlinject(host: Host): void; + + /** + * Run a script as a separate process. This function can only be used to run scripts located on the + * current server (the server running the script that calls this function). Requires a significant + * amount of RAM to run this command. + * + * If the script was successfully started, then this functions 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. + * + * Running this function with a numThreads argument of 0 will return 0 without running the script. + * However, running this function with a negative numThreads argument will cause a runtime error. + * + * @example + * ```js + * //The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.script’ single-threaded with no arguments: + * run("foo.script"); + * ``` + * @example + * ```js + * //The following example will run ‘foo.script’ but with 5 threads instead of single-threaded: + * run("foo.script", 5); + * ``` + * @example + * ```js + * //This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument: + * run("foo.script", 1, 'foodnstuff'); + * ``` + * @remarks 1 GB + * @param script - Filename of script to run. + * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to 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 second argument numThreads must be filled in with a value. + * @returns Returns the PID of a successfully started script, and 0 otherwise. + */ + run(script: Script, numThreads?: number, ...args: string[]): number; + + /** + * 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. + * + * If the script was successfully started, then this functions 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. + * + * Running this function with a numThreads argument of 0 will return 0 without running the script. + * However, running this function with a negative numThreads argument will cause a runtime error. + * + * @example + * ```js + * //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"); + * ``` + * @example + * ```js + * //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); + * ``` + * @example + * ```js + * //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"); + * ``` + * @remarks 1.3 GB + * @param script - Filename of script to execute. + * @param host - Hostname or IP 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 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. + */ + exec(script: Script, host: Host, numThreads?: number, ...args: string[]): number; + + /** + * Terminates the current script, and then after a delay of about 10 seconds it will execute the + * newly-specified script. The purpose of this function is to execute a new script without being + * constrained by the RAM usage of the current one. This function can only be used to run scripts + * on the local server. + * + * Because this function immediately terminates the script, it does not have a return value. + * + * @example + * ```js + * //The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90: + * spawn('foo.script', 10, 'foodnstuff', 90); + * ``` + * @remarks 2 GB + * @param script - Filename of script to execute. + * @param numThreads - Number of threads to spawn new script with. Will be rounded to nearest integer. + * @param args - Additional arguments to pass into the new script that is being run. + */ + spawn(script: Script, numThreads?: number, ...args: string[]): void; + + /** + * Kills the script on the target server specified by the script’s name and arguments. + * Remember that scripts are uniquely identified by both their name and arguments. + * For example, if \`foo.script\` is run with the argument 1, then this is not the same as + * \`foo.script\` run with the argument 2, even though they have the same code. + * + * @example + * ```js + * //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: + * kill("foo.script", "foodnstuff"); + * ``` + * @example + * ```js + * //The following will try to kill a script named foo.script on the current server that was ran with no arguments: + * kill("foo.script", getHostname()); + * ``` + * @example + * ```js + * //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: + * kill("foo.script", getHostname(), 1, "foodnstuff"); + * ``` + * @remarks 0.5 GB + * @param script - Filename of the script to kill + * @param host - Hostname or IP of the server on which to kill the script. + * @param args - Arguments to identify which script to kill. + * @returns True if the script is successfully killed, and false otherwise. + */ + kill(script: Script, host: Host, ...args: string[]): boolean; + + /** + * Kills the script with the specified PID. + * Killing a script by its PID will typically have better performance, + * especially if you have many scripts running. + * If this function successfully kills the specified script, then it will return true. + * Otherwise, it will return false. + * + * @example + * ```js + * if (kill(10)) { + * print("Killed script with PID 10!"); + * } + * ``` + * @remarks 0.5 GB + * @param scriptPid - PID of the script to kill + * @returns True if the script is successfully killed, and false otherwise. + */ + kill(scriptPid: number): boolean; + + /** + * Kills all running scripts on the specified server. This function returns true + * if any scripts were killed, and false otherwise. In other words, it will return + * true if there are any scripts running on the target server. + * + * @remarks 0.5 GB + * @param host - IP or hostname of the server on which to kill all scripts. + * @returns True if any scripts were killed, and false otherwise. + */ + killall(host: Host): boolean; + + /** + * Terminates the current script immediately. + * + * @remarks 0 GB + */ + exit(): void; + + /** + * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string + * specifying a single file to copy, or an array of strings specifying multiple files to copy. + * + * @example + * ```js + * //Copies hack-template.script from the current server to foodnstuff: + * scp("hack-template.script", "foodnstuff"); + * ``` + * @remarks 0.6 GB + * @param files - Filename or an array of filenames of script/literature files to copy. + * @param destination - Host or IP of the destination server, which is the server to which the file will be copied. + * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. + */ + scp(files: string | ReadonlyArray, destination: Host): boolean; + + /** + * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string + * specifying a single file to copy, or an array of strings specifying multiple files to copy. + * + * @example + * ```js + * //Copies foo.lit from the helios server to the home computer: + * scp("foo.lit", "helios", "home"); + * ``` + * @example + * ```js + * //Tries to copy three files from rothman-uni to home computer: + * files = ["foo1.lit", "foo2.script", "foo3.script"]; + * scp(files, "rothman-uni", "home"); + * ``` + * @remarks 0.6 GB + * @param files - Filename or an array of filenames of script/literature files to copy. + * @param source - Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. + * @param destination - Host or IP of the destination server, which is the server to which the file will be copied. + * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. + */ + scp( + files: string | ReadonlyArray, + source: Host, + // tslint:disable-next-line:unified-signatures + destination: Host, + ): boolean; + + /** + * Returns an array with the filenames of all files on the specified server + * (as strings). The returned array is sorted in alphabetic order. + * + * @remarks 0.2 GB + * @param host - Host or IP of the target server. + * @param grep - A substring to search for in the filename. + * @returns Array with the filenames of all files on the specified server. + */ + ls(host: Host, grep?: string): string[]; + + /** + * Returns an array with general information about all scripts running on the specified target server. + * + * @example + * ```js + * //(using NetscriptJS (Netscript 2.0)) + * export async function main(ns) { + * const ps = ns.ps("home"); + * for (let i = 0; i < ps.length; ++i) { + * ns.tprint(ps[i].filename + ' ' + ps[i].threads); + * ns.tprint(ps[i].args); + * } + * } + * ``` + * @remarks 0.2 GB + * @param host - Host or IP address of the target server. If not specified, it will be the current server’s IP by default. + * @returns Array with general information about all scripts running on the specified target server. + */ + ps(host?: Host): ProcessInfo[]; + + /** + * Returns a boolean indicating whether or not the player has root access to the specified target server. + * + * @example + * ```js + * if (hasRootAccess("foodnstuff") == false) { + * nuke("foodnstuff"); + * } + * ``` + * @remarks 0.05 GB + * @param host - Host or IP of the target server + * @returns True if player has root access to the specified target server, and false otherwise. + */ + hasRootAccess(host: Host): boolean; + + /** + * Returns a string with the hostname of the server that the script is running on. + * + * @remarks 0.05 GB + * @returns Hostname of the server that the script is on. + */ + getHostname(): Host; + + /** + * Returns the player’s current hacking level. + * + * @remarks 0.05 GB + * @returns Player’s current hacking level + */ + getHackingLevel(): number; + + /** + * Returns an object containing the Player’s hacking related multipliers. + * These multipliers are returned in fractional forms, not percentages + * (e.g. 1.5 instead of 150%). + * + * @example + * ```js + * //Example of how this can be used: + * mults = getHackingMultipliers(); + * print(mults.chance); + * print(mults.growth); + * ``` + * @remarks 4 GB + * @returns Object containing the Player’s hacking related multipliers. + */ + getHackingMultipliers(): HackingMultipliers; + + /** + * Returns an object containing the Player’s hacknet related multipliers. + * These multipliers are returned in fractional forms, not percentages + * (e.g. 1.5 instead of 150%). + * + * @example + * ```js + * //Example of how this can be used: + * mults = getHacknetMultipliers(); + * print(mults.production); + * print(mults.purchaseCost); + * ``` + * @remarks 4 GB + * @returns Object containing the Player’s hacknet related multipliers. + */ + getHacknetMultipliers(): HacknetMultipliers; + + /** + * Returns a server object for the given server. Defaults to the running script's server if host is not specified. + * + * @remarks 2 GB + * @param host - Optional. Hostname or IP for the requested server object. + * @returns The requested server object. + */ + getServer(host?: Host): Server; + + /** + * Returns the amount of money available on a server. + * Running this function on the home computer will return the player’s money. + * + * @example + * ```js + * getServerMoneyAvailable("foodnstuff"); + * getServerMoneyAvailable("home"); //Returns player's money + * ``` + * @remarks 0.1 GB + * @param host - Host or IP of target server + * @returns Amount of money available on the server. + */ + getServerMoneyAvailable(host: Host): number; + + /** + * Returns the maximum amount of money that can be available on a server. + * + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Maximum amount of money available on the server. + */ + getServerMaxMoney(host: Host): number; + + /** + * Returns the server’s instrinsic “growth parameter”. This growth + * parameter is a number between 1 and 100 that represents how + * quickly the server’s money grows. This parameter affects the + * percentage by which the server’s money is increased when using the + * grow function. A higher growth parameter will result in a + * higher percentage increase from grow. + * + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Parameter that affects the percentage by which the server’s money is increased when using the grow function. + */ + getServerGrowth(host: Host): number; + + /** + * Returns the security level of the target server. A server’s security + * level is denoted by a number, typically between 1 and 100 + * (but it can go above 100). + * + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Security level of the target server. + */ + getServerSecurityLevel(host: Host): number; + + /** + * Returns the base security level of the target server. This is the security + * level that the server starts out with. This is different than + * getServerSecurityLevel because getServerSecurityLevel returns + * the current security level of a server, which can constantly change due to + * hack, grow, and weaken, calls on that server. + * The base security level will stay the same until you reset by + * installing an Augmentation(s). + * + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Base security level of the target server. + */ + getServerBaseSecurityLevel(host: Host): number; + + /** + * Returns the minimum security level of the target server. + * + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Minimum security level of the target server. + */ + getServerMinSecurityLevel(host: Host): number; + + /** + * Returns the required hacking level of the target server. + * + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns The required hacking level of the target server. + */ + getServerRequiredHackingLevel(host: Host): number; + + /** + * Returns the number of open ports required to successfully run NUKE.exe on the specified server. + * + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns The number of open ports required to successfully run NUKE.exe on the specified server. + */ + getServerNumPortsRequired(host: Host): number; + + /** + * Returns an array with two elements that gives information about a server’s memory (RAM). + * The first element in the array is the amount of RAM that the server has total (in GB). + * The second element in the array is the amount of RAM that is currently being used on + * the server (in GB). + * + * @example + * ```js + * res = getServerRam("helios"); + * totalRam = res[0]; + * ramUsed = res[1]; + * ``` + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Array with total and used memory on the specified server. + */ + getServerRam(host: Host): [number, number]; + + /** + * Returns a boolean denoting whether or not the specified server exists. + * + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns True if specified server exists, and false otherwise. + */ + serverExists(host: Host): boolean; + + /** + * Returns a boolean indicating whether the specified file exists on the target server. + * The filename for scripts is case-sensitive, but for other types of files it is not. + * For example, fileExists(“brutessh.exe”) will work fine, even though the actual program + * is named 'BruteSSH.exe'. + * + * If the hostname/ip argument is omitted, then the function will search through the current + * server (the server running the script that calls this function) for the file. + * + * @example + * ```js + * //The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise. + * fileExists("foo.script", "foodnstuff"); + * ``` + * @example + * ```js + * //The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise. + * fileExists("ftpcrack.exe"); + * ``` + * @remarks 0.1 GB + * @param filename - Filename of file to check. + * @param host - Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server. + * @returns True if specified file exists, and false otherwise. + */ + fileExists(filename: string, host?: Host): boolean; + + /** + * Returns a boolean indicating whether the specified script is running on the target server. + * Remember that a script is uniquely identified by both its name and its arguments. + * + * @example + * ```js + * //The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise: + * isRunning("foo.script", "foodnstuff"); + * ``` + * @example + * ```js + * //The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise: + * isRunning("foo.script", getHostname()); + * ``` + * @example + * ```js + * //The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise: + * isRunning("foo.script", "joesguns", 1, 5, "test"); + * ``` + * @remarks 0.1 GB + * @param script - Filename of script to check. This is case-sensitive. + * @param host - Host or IP of target server. + * @param args - Arguments to specify/identify which scripts to search for. + * @returns True if specified script is running on the target server, and false otherwise. + */ + isRunning(script: Script, host: Host, ...args: string[]): boolean; + + /** + * Returns the cost to purchase a server with the specified amount of ram. + * + * @example + * ```js + * for (i = 1; i <= 20; i++) { + * tprint(i + " -- " + getPurchasedServerCost(Math.pow(2, i))); + * } + * ``` + * @remarks 0.25 GB + * @param ram - Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + * @returns The cost to purchase a server with the specified amount of ram. + */ + getPurchasedServerCost(ram: number): number; + + /** + * Purchased a server with the specified hostname and amount of RAM. + * + * The hostname argument can be any data type, but it will be converted to a string + * and have whitespace removed. Anything that resolves to an empty string will cause + * the function to fail. If there is already a server with the specified hostname, + * then the function will automatically append a number at the end of the hostname + * argument value until it finds a unique hostname. For example, if the script calls + * \`purchaseServer(“foo”, 4)\` but a server named “foo” already exists, the it will + * automatically change the hostname to \`foo-0\`. If there is already a server with the + * hostname \`foo-0\`, then it will change the hostname to \`foo-1\`, and so on. + * + * Note that there is a maximum limit to the amount of servers you can purchase. + * + * Returns the hostname of the newly purchased server as a string. If the function + * fails to purchase a server, then it will return an empty string. The function will + * fail if the arguments passed in are invalid, if the player does not have enough + * money to purchase the specified server, or if the player has exceeded the maximum + * amount of servers. + * + * @example + * ```js + * ram = 64; + * hn = "pserv-"; + * for (i = 0; i < 5; ++i) { + * purchaseServer(hn + i, ram); + * } + * ``` + * @remarks 2.25 GB + * @param hostname - Host of the purchased server. + * @param ram - Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + * @returns The hostname of the newly purchased server. + */ + purchaseServer(hostname: Host, ram: number): Host | ""; + + /** + * Deletes one of your purchased servers, which is specified by its hostname. + * + * The hostname argument can be any data type, but it will be converted to a string. + * Whitespace is automatically removed from the string. This function will not delete a + * server that still has scripts running on it. + * + * @remarks 2.25 GB + * @param host - Host of the server to delete. + * @returns True if successful, and false otherwise. + */ + deleteServer(host: Host): boolean; + + /** + * Returns an array with either the hostnames or IPs of all of the servers you have purchased. + * + * @remarks 2.25 GB + * @param hostnameMode -] Optional. Defaults to true. Returns hostnames if true, and IPs if false. + * @returns Returns an array with either the hostnames or IPs of all of the servers you have purchased. + */ + getPurchasedServers(hostnameMode?: boolean): Host[]; + + /** + * Returns the maximum number of servers you can purchase. + * + * @remarks 0.05 GB + * @returns Returns the maximum number of servers you can purchase. + */ + getPurchasedServerLimit(): number; + + /** + * Returns the maximum RAM that a purchased server can have. + * + * @remarks 0.05 GB + * @returns Returns the maximum RAM that a purchased server can have. + */ + getPurchasedServerMaxRam(): number; + + /** + * This function can be used to either write data to a port or to a text file (.txt). + * + * If the first argument is a number between 1 and 20, then it specifies a port and this + * function will write data to that port. The third argument, mode, is not used when writing + * to a port. + * + * If the first argument is a string, then it specifies the name of a text file (.txt) and + * this function will write data to that text file. If the specified text file does not exist, + * then it will be created. The third argument mode, defines how the data will be written to + * the text file. If *mode is set to “w”, then the data is written in “write” mode which means + * that it will overwrite all existing data on the text file. If mode is set to any other value + * then the data will be written in “append” mode which means that the data will be added at the + * end of the text file. + * + * @remarks 1 GB + * @param handle - Port or text file that will be written to. + * @param data - Data to write. + * @param mode - Defines the write mode. Only valid when writing to text files. + */ + write(handle: Handle, data?: string | string[] | number, mode?: "w" | "a"): void; + + /** + * Attempts to write data to the specified Netscript Port. + * If the port is full, the data will not be written. + * Otherwise, the data will be written normally. + * + * @remarks 1 GB + * @param port - Port or text file that will be written to. + * @param data - Data to write. + * @returns True if the data is successfully written to the port, and false otherwise. + */ + tryWrite(port: Handle, data: string | string[] | number): boolean; + + /** + * This function is used to read data from a port or from a text file (.txt). + * + * If the argument port/fn is a number between 1 and 20, then it specifies a + * port and it will read data from that port. A port is a serialized queue. + * This function will remove the first element from that queue and return it. + * If the queue is empty, then the string “NULL PORT DATA” will be returned. + * + * If the argument port/fn is a string, then it specifies the name of a text + * file (.txt) and this function will return the data in the specified text + * file. If the text file does not exist, an empty string will be returned. + * + * @remarks 1 GB + * @param handle - Port or text file to read from. + * @returns Data in the specified text file or port. + */ + read(handle: Handle): string | number | object; + + /** + * This function is used to peek at the data from a port. It returns the + * first element in the specified port without removing that element. If + * the port is empty, the string “NULL PORT DATA” will be returned. + * + * @remarks 1 GB + * @param port - Port to peek. Must be an integer between 1 and 20. + * @returns Data in the specified port. + */ + peek(port: Port): string | number | object; + + /** + * This function is used to clear data in a Netscript Ports or a text file. + * + * If the port/fn argument is a number between 1 and 20, then it specifies a + * port and will clear it (deleting all data from the underlying queue). + * + * If the port/fn argument is a string, then it specifies the name of a + * text file (.txt) and will delete all data from that text file. + * + * @remarks 1 GB + * @param handle - Port or text file to clear. + */ + clear(handle: Handle): void; + + /** + * Get a handle to a Netscript Port. + * + * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0. + * + * @see https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports + * @remarks 10 GB + * @param port - Port number. Must be an integer between 1 and 20. + * @returns Data in the specified port. + */ + getPortHandle(port: Port): any[]; + + /** + * Removes the specified file from the current server. This function works for every file + * type except message (.msg) files. + * + * @remarks 1 GB + * @param name - Filename of file to remove. Must include the extension. + * @param host - Host or IP Address of the server on which to delete the file. Optional. Defaults to current server. + * @returns True if it successfully deletes the file, and false otherwise. + */ + rm(name: string, host?: Host): boolean; + + /** + * Returns a boolean indicating whether any instance of the specified script is running + * on the target server, regardless of its arguments. + * + * This is different than the isRunning function because it does not try to + * identify a specific instance of a running script by its arguments. + * + * @example + * ```js + * //The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise: + * scriptRunning("foo.script", "foodnstuff"); + * ``` + * @example + * ```js + * //The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise: + * scriptRunning("foo.script", getHostname()); + * ``` + * @remarks 1 GB + * @param script - Filename of script to check. This is case-sensitive. + * @param host - Host or IP of target server. + * @returns True if the specified script is running, and false otherwise. + */ + scriptRunning(script: Script, host: Host): boolean; + + /** + * Kills all scripts with the specified filename on the target server specified by hostname/ip, + * regardless of arguments. + * + * @remarks 1 GB + * @param script - Filename of script to kill. This is case-sensitive. + * @param host - Host or IP of target server. + * @returns true if one or more scripts were successfully killed, and false if none were. + */ + scriptKill(script: Script, host: Host): boolean; + + /** + * Returns the current script name. + * + * @remarks 0 GB + * @returns Current script name. + */ + getScriptName(): string; + + /** + * Returns the amount of RAM required to run the specified script on the target server. + * Returns 0 if the script does not exist. + * + * @remarks 0.1 GB + * @param script - Filename of script. This is case-sensitive. + * @param host - Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. + * @returns Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist. + */ + getScriptRam(script: Script, host?: Host): number; + + /** + * Returns the amount of time in seconds it takes to execute the hack Netscript function on the target server. + * The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels. + * + * @remarks 0.05 GB + * @param host - Host or IP of target server. + * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. + * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). + * @returns Returns the amount of time in seconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. + */ + getHackTime(host: Host, hackLvl?: number, intLvl?: number): number; + + /** + * Returns the amount of time in seconds it takes to execute the grow Netscript function on the target server. + * The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels. + * + * @remarks 0.05 GB + * @param host - Host or IP of target server. + * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. + * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). + * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. + */ + getGrowTime(host: Host, hackLvl?: number, intLvl?: number): number; + + /** + * Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. + * The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. + * + * @remarks 0.05 GB + * @param host - Host or IP of target server. + * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. + * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). + * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. + */ + getWeakenTime(host: Host, hackLvl?: number, intLvl?: number): number; + + /** + * Returns the amount of income the specified script generates while online + * (when the game is open, does not apply for offline income). Remember that + * a script is uniquely identified by both its name and its arguments. So for + * example if you ran a script with the arguments “foodnstuff” and “5” then + * in order to use this function to get that script’s income you must specify + * those same arguments in the same order in this function call. + * + * This function can also be called with no arguments. + * If called with no arguments, then this function will return an array of two values. + * The first value is the total income ($ / second) of all of your active scripts + * (scripts that are currently running on any server). + * The second value is the total income ($ / second) that you’ve earned from scripts + * since you last installed Augmentations. + * + * @remarks 0.1 GB + * @param script - Filename of script. + * @param host - Server on which script is running. + * @param args - Arguments that the script is running with. + * @returns Amount of income the specified script generates while online. + */ + getScriptIncome(script: Script, host: Host, ...args: string[]): number | [number, number]; + + /** + * Returns the amount of hacking experience the specified script generates while online + * (when the game is open, does not apply for offline experience gains). Remember that a + * script is uniquely identified by both its name and its arguments. + * + * This function can also return the total experience gain rate of all of your active + * scripts by running the function with no arguments. + * + * @remarks 0.1 GB + * @param script - Filename of script. + * @param host - Server on which script is running. + * @param args - Arguments that the script is running with. + * @returns Amount of hacking experience the specified script generates while online. + */ + getScriptExpGain(script: Script, host: Host, ...args: string[]): number; + + /** + * Returns the amount of time in milliseconds that have passed since you last installed Augmentations. + * + * @remarks 0.05 GB + * @returns Time in milliseconds that have passed since you last installed Augmentations. + */ + getTimeSinceLastAug(): number; + + /** + * Complete open source JavaScript sprintf implementation + * + * @see https://github.com/alexei/sprintf.js + * @remarks 0 GB + * @param format - String to format. + * @param args - Formating arguments. + * @returns Formated text. + */ + sprintf(format: string, ...args: string[]): string; + + /** + * Complete open source JavaScript sprintf implementation + * + * @see https://github.com/alexei/sprintf.js + * @remarks 0 GB + * @param format - String to format. + * @param args - Formating arguments. + * @returns Formated text. + */ + vsprintf(format: string, args: string[]): string; + + /** + * 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. + * + * @see http://numeraljs.com/ + * @remarks 0 GB + * @param n - Number to format. + * @param format - Formatter. + * @returns Formated number. + */ + nFormat(n: number, format: string): number; + + /** + * Prompts the player with a dialog box with two options: “Yes” and “No”. + * This function will return true if the player click “Yes” and false if + * the player clicks “No”. The script’s execution is halted until the player + * selects one of the options. + * + * @remarks 0 GB + * @param txt - Text to appear in the prompt dialog box. + * @returns True if the player click “Yes” and false if the player clicks “No”. + */ + prompt(txt: string): Promise; + + /** + * Retrieves data from a URL and downloads it to a file on the specified server. + * The data can only be downloaded to a script (.script, .ns, .js) or a text file (.txt). + * If the file already exists, it will be overwritten by this command. + * Note that it will not be possible to download data from many websites because they + * do not allow cross-origin resource sharing (CORS). + * + * IMPORTANT: This is an asynchronous function that returns a Promise. + * The Promise’s resolved value will be a boolean indicating whether or not the data was + * successfully retrieved from the URL. Because the function is async and returns a Promise, + * it is recommended you use wget in NetscriptJS (Netscript 2.0). + * + * In NetscriptJS, you must preface any call to wget with the await keyword (like you would hack or sleep). + * wget will still work in Netscript 1.0, but the functions execution will not be synchronous + * (i.e. it may not execute when you expect/want it to). + * Furthermore, since Promises are not supported in ES5, + * you will not be able to process the returned value of wget in Netscript 1.0. + * + * @example + * ```js + * wget("https://raw.githubusercontent.com/danielyxie/bitburner/master/README.md", "game_readme.txt"); + * ``` + * @remarks 0 GB + * @param url - URL to pull data from. + * @param target - Filename to write data to. Must be script or text file. + * @param host - Optional hostname/ip of server for target file. + * @returns True if the data was successfully retrieved from the URL, false otherwise. + */ + wget(url: string, target: string, host?: string): Promise; + + /** + * Returns the amount of Faction favor required to be able to donate to a faction. + * + * @remarks 0.1 GB + * @returns Amount of Faction favor required to be able to donate to a faction. + */ + getFavorToDonate(): number; + + /** + * Returns an object containing the current BitNode multipliers. + * This function requires Source-File 5 in order to run. + * The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). + * The multipliers represent the difference between the current BitNode and + * the original BitNode (BitNode-1). + * + * For example, if the CrimeMoney multiplier has a value of 0.1, then that means + * that committing crimes in the current BitNode will only give 10% of the money + * you would have received in BitNode-1. + * + * @example + * ```js + * mults = getBitNodeMultipliers(); + * print(mults.ServerMaxMoney); + * print(mults.HackExpGain); + * ``` + * @remarks 4 GB + * @returns Object containing the current BitNode multipliers. + */ + getBitNodeMultipliers(url: string, target: string, host: string): BitNodeMultipliers; +} + +/** + * @public + */ +export declare type OrderPos = "long" | "short"; + +/** + * @public + */ +export declare type OrderType = "limitbuy" | "limitsell" | "stopbuy" | "stopsell"; + +/** + * @public + */ +export declare interface PlayerStats { + /** Hacking level */ + hacking: number; + /** Strength level */ + strength: number; + /** Defense level */ + defense: number; + /** Dexterity level */ + dexterity: number; + /** Agility level */ + agility: number; + /** Chraisma level */ + charisma: number; + /** Intelligence level */ + intelligence: number; +} + +/** + * A port is implemented as a sort of serialized queue, + * where you can only write and read one element at a time from the port. + * When you read data from a port, the element that is read is removed from the port. + * + * IMPORTANT: The data inside ports are not saved! + * This means if you close and re-open the game, or reload the page + * then you will lose all of the data in the ports! + * @public + */ +export declare type Port = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20; + +/** + * @public + */ +export declare interface ProcessInfo { + /** Script name. */ + filename: Script; + /** Number of threads script is running with */ + threads: number; + /** Script's arguments */ + args: string[]; +} + +/** + * @public + */ +export declare type PurchaseableProgram = +| "brutessh.exe" +| "ftpcrack.exe" +| "relaysmtp.exe" +| "httpworm.exe" +| "sqlinject.exe" +| "deepscanv1.exe" +| "deepscanv2.exe" +| "autolink.exe"; + +/** + * @public + */ +export declare type Script = string; + +/** + * @public + */ +export declare interface Server { + // How many CPU cores this server has. Maximum of 8. + // Currently, this only affects hacking missions + cpuCores: number; + + // Flag indicating whether the FTP port is open + ftpPortOpen: boolean; + + // Flag indicating whether player has admin/root access to this server + hasAdminRights: boolean; + + // Hostname. Must be unique + hostname: string; + + // Flag indicating whether HTTP Port is open + httpPortOpen: boolean; + + // IP Address. Must be unique + ip: string; + + // Flag indicating whether player is curently connected to this server + isConnectedTo: boolean; + + // RAM (GB) available on this server + maxRam: number; + + // Name of company/faction/etc. that this server belongs to. + // Optional, not applicable to all Servers + organizationName: string; + + // RAM (GB) used. i.e. unavailable RAM + ramUsed: number; + + // Flag indicating whether SMTP Port is open + smtpPortOpen: boolean; + + // Flag indicating whether SQL Port is open + sqlPortOpen: boolean; + + // Flag indicating whether the SSH Port is open + sshPortOpen: boolean; +} + +/** + * @public + */ +export declare interface Singularity { + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will automatically set you to start taking a course at a university. + * If you are already in the middle of some “working” action (such as working at a + * company, for a faction, or on a program), then running this function will automatically + * cancel that action and give you your earnings. + * + * The cost and experience gains for all of these universities and classes are the same as + * if you were to manually visit and take these classes. + * + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @param universityName - Name of university. You must be in the correct city for whatever university you specify. + * @param courseName - Name of course. + * @returns True if actions is successfully started, false otherwise. + */ + universityCourse(universityName: University, courseName: UniversityCourse): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will automatically set you to start working out at a gym to train + * a particular stat. If you are already in the middle of some “working” action + * (such as working at a company, for a faction, or on a program), then running + * this function will automatically cancel that action and give you your earnings. + * + * The cost and experience gains for all of these gyms are the same as if you were + * to manually visit these gyms and train + * + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify. + * @param stat - The stat you want to train. + * @returns True if actions is successfully started, false otherwise. + */ + gymWorkout(gymName: Gym, stat: GymStat): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function allows the player to travel to any city. The cost for using this + * function is the same as the cost for traveling through the Travel Agency. + * + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @param city - City to travel to. + * @returns True if actions is successful, false otherwise. + */ + travelToCity(city: City): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function allows you to automatically purchase a TOR router. The cost for + * purchasing a TOR router using this function is the same as if you were to + * manually purchase one. + * + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @returns True if actions is successful, false otherwise. + */ + purchaseTor(): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function allows you to automatically purchase programs. You MUST have a + * TOR router in order to use this function. The cost of purchasing programs + * using this function is the same as if you were purchasing them through the Dark + * Web using the Terminal buy command. + * + * @example + * ```js + * purchaseProgram("brutessh.exe"); + * ``` + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @param programName - Name of program to purchase. + * @returns True if the specified program is purchased, and false otherwise. + */ + purchaseProgram(programName: PurchaseableProgram): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Returns an object with the Player’s stats. + * + * @example + * ```js + * res = getStats(); + * print('My charisma level is: ' + res.charisma); + * ``` + * @remarks 0.5 GB + * @remarks Singularity - Level 1 + * @returns Object with the Player’s stats. + */ + getStats(): PlayerStats; + + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Returns an object with various information about your character. + * + * @remarks 0.5 GB + * @remarks Singularity - Level 1 + * @returns Object with various information about your character. + */ + getCharacterInformation(): CharacterInfo; + + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Returns a boolean indicating whether or not the player is currently performing an + * ‘action’. These actions include working for a company/faction, studying at a univeristy, + * working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. + * + * @remarks 0.5 GB + * @remarks Singularity - Level 1 + * @returns True if the player is currently performing an ‘action’, false otherwise. + */ + isBusy(): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function is used to end whatever ‘action’ the player is currently performing. + * The player will receive whatever money/experience/etc. he has earned from that action. + * + * The actions that can be stopped with this function are: + * + * * Studying at a university + * * Working for a company/faction + * * Creating a program + * * Committing a Crime + * + * This function will return true if the player’s action was ended. + * It will return false if the player was not performing an action when this function was called. + * + * @remarks 1 GB + * @remarks Singularity - Level 1 + * @returns True if the player’s action was ended, false if the player was not performing an action. + */ + stopAction(): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will upgrade amount of RAM on the player’s home computer. The cost is + * the same as if you were to do it manually. + * + * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. + * + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise. + */ + upgradeHomeRam(): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Returns the cost of upgrading the player’s home computer RAM. + * + * @remarks 1.5 GB + * @remarks Singularity - Level 2 + * @returns Cost of upgrading the player’s home computer RAM. + */ + getUpgradeHomeRamCost(): number; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will automatically set you to start working at the company + * at which you are employed. If you are already in the middle of some “working” + * action (such as working for a faction, training at a gym, or creating a program), + * then running this function will automatically cancel that action and give you + * your earnings. + * + * This function will return true if the player starts working, and false otherwise. + * + * Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action. + * + * @example + * ```js + * //If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings: + * while (getCompanyRep(COMPANY HERE) < VALUE) { + * workForCompany(); + * sleep(60000); + * } + * //This way, your company reputation will be updated every minute. + * ``` + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked + * @returns True if the player starts working, and false otherwise. + */ + workForCompany(companyName?: CompanyName): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will automatically try to apply to the specified company + * for a position in the specified field. This function can also be used to + * apply for promotions by specifying the company and field you are already + * employed at. + * + * This function will return true if you successfully get a job/promotion, + * and false otherwise. Note that if you are trying to use this function to + * apply for a promotion and you don’t get one, it will return false. + * + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of company to apply to. + * @param field - Field to which you want to apply. + * @returns True if the player successfully get a job/promotion, and false otherwise. + */ + applyToCompany(companyName: CompanyName, field: CompanyField): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will return the amount of reputation you have at the specified company. + * If the company passed in as an argument is invalid, -1 will be returned. + * + * @remarks 1 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of the company. + * @returns Amount of reputation you have at the specified company. + */ + getCompanyRep(companyName: CompanyName): number; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will return the amount of favor you have at the specified company. + * If the company passed in as an argument is invalid, -1 will be returned. + * + * @remarks 1 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of the company. + * @returns Amount of favor you have at the specified company. + */ + getCompanyFavor(companyName: CompanyName): number; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will return the amount of favor you will gain for the specified + * company when you reset by installing Augmentations. + * + * @remarks 0.75 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of the company. + * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations. + */ + getCompanyFavorGain(companyName: CompanyName): number; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Returns an array with the name of all Factions you currently have oustanding invitations from. + * + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @returns Array with the name of all Factions you currently have oustanding invitations from. + */ + checkFactionInvitations(): FactionName[]; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will automatically accept an invitation from a faction and join it. + * + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction to join. + * @returns True if player joined the faction, and false otherwise. + */ + joinFaction(faction: FactionName): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will automatically set you to start working for the specified faction. + * Obviously, you must be a member of the faction or else this function will fail. If + * you are already in the middle of some “working” action (such as working for a company, + * training at a gym, or creating a program), then running this function will automatically + * cancel that action and give you your earnings. + * + * This function will return true if you successfully start working for the specified faction, and false otherwise. + * + * Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action. + * + * @example + * ```js + * //If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings: + * while (getFactionRep(FACTION NAME) < VALUE) { + * workForFaction(FACNAME, WORKTYPE); + * sleep(60000); + * } + * //This way, your faction reputation will be updated every minute. + * ``` + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction to work for. + * @param workType - Type of work to perform for the faction. + * @returns True if the player starts working, and false otherwise. + */ + workForFaction(faction: FactionName, workType: FactionWork): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function returns the amount of reputation you have for the specified faction. + * + * @remarks 1 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction to work for. + * @returns Amount of reputation you have for the specified faction. + */ + getFactionRep(faction: FactionName): number; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function returns the amount of favor you have for the specified faction. + * + * @remarks 1 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction. + * @returns Amount of favor you have for the specified faction. + */ + getFactionFavor(faction: FactionName): number; + + /** + * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function returns the amount of favor you will gain for the specified + * faction when you reset by installing Augmentations. + * + * @remarks 0.75 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction. + * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations. + */ + getFactionFavorGain(faction: FactionName): number; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Attempts to donate money to the specified faction in exchange for reputation. + * Returns true if you successfully donate the money, and false otherwise. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param faction - Name of faction to donate to. + * @param amount - Amount of money to donate. + * @returns True if the money was donated, and false otherwise. + */ + donateToFaction(faction: FactionName, amount: number): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will automatically set you to start working on creating the + * specified program. If you are already in the middle of some “working” action + * (such as working for a company, training at a gym, or taking a course), then + * running this function will automatically cancel that action and give you your + * earnings. + * + * This function returns true if you successfully start working on the specified program, and false otherwise. + * + * Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: + * * BruteSSH.exe: 50 + * * FTPCrack.exe: 100 + * * relaySMTP.exe: 250 + * * HTTPWorm.exe: 500 + * * SQLInject.exe: 750 + * * DeepscanV1.exe: 75 + * * DeepscanV2.exe: 400 + * * ServerProfiler.exe: 75 + * * AutoLink.exe: 25 + * + * @example + * ```js + * createProgram(“relaysmtp.exe”); + * ``` + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param program - Name of program to create. + * @returns True if you successfully start working on the specified program, and false otherwise. + */ + createProgram(program: CreatableProgram): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function is used to automatically attempt to commit crimes. + * If you are already in the middle of some ‘working’ action (such + * as working for a company or training at a gym), then running this + * function will automatically cancel that action and give you your + * earnings. + * + * This function returns the number of seconds it takes to attempt the specified + * crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running + * \`commitCrime('rob store')\` will return 60). + * + * Warning: I do not recommend using the time returned from this function to try + * and schedule your crime attempts. Instead, I would use the isBusy Singularity + * function to check whether you have finished attempting a crime. This is because + * although the game sets a certain crime to be X amount of seconds, there is no + * guarantee that your browser will follow that time limit. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param crime - Name of crime to attempt. + * @returns True if you successfully start working on the specified program, and false otherwise. + */ + commitCrime(crime: Crime): number; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function returns your chance of success at commiting the specified crime. + * The chance is returned as a decimal (i.e. 60% would be returned as 0.6). + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param crime - Name of crime. + * @returns Chance of success at commiting the specified crime as a decimal. + */ + getCrimeChance(crime: Crime): number; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Returns the stats of the crime. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param crime - Name of crime. Not case-sensitive + * @returns The stats of the crime. + */ + getCrimeStats(crime: Crime): CrimeStats; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function returns an array containing the names (as strings) of all Augmentations you have. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations. + * @returns Array containing the names (as strings) of all Augmentations you have. + */ + getOwnedAugmentations(purchased?: boolean): AugmentName[]; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Returns an array of source files + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @returns Array containing an object with number and level of the source file. + */ + getOwnedSourceFiles(): SourceFileLvl[]; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * Returns an array containing the names (as strings) of all Augmentations + * that are available from the specified faction. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param faction - Name of faction. + * @returns Array containing the names of all Augmentations. + */ + getAugmentationsFromFaction(faction: FactionName): AugmentName[]; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. + * If there are no prerequisites, a blank array is returned. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param augName - Name of Augmentation. + * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. + */ + getAugmentationPrereq(augName: AugmentName): AugmentName[]; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function returns an array with two elements that gives the cost for + * the specified Augmentation. The first element in the returned array is the + * reputation requirement of the Augmentation, and the second element is the + * money cost. + * + * If an invalid Augmentation name is passed in for the augName argument, this + * function will return the array [-1, -1]. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param augName - Name of Augmentation. + * @returns Array with first element as a reputation requirement and second element as the money cost. + */ + getAugmentationCost(augName: AugmentName): [number, number]; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will try to purchase the specified Augmentation through the given Faction. + * + * This function will return true if the Augmentation is successfully purchased, and false otherwise. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param faction - Name of faction to purchase Augmentation from. + * @param augmnet - Name of Augmentation to purchase. + * @returns True if the Augmentation is successfully purchased, and false otherwise. + */ + purchaseAugmentation(faction: FactionName, augmnet: AugmentName): boolean; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function returns augmentation stats. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param name - Name of Augmentation. CASE-SENSITIVE. + * @returns Augmentation stats. + */ + getAugmentationStats(name: AugmentName): AugmentationStats; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will automatically install your Augmentations, resetting the game as usual. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param cbScript - Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. + */ + installAugmentations(cbScript?: Script): void; + + /** + * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + * + * This function will perform a reset even if you don’t have any augmentation installed. + * + * @remarks 5 GB + * @remarks Singularity - Level 3 + */ + softReset(): void; +} + +/** + * @public + */ +export declare interface Sleeve { + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return the number of duplicate sleeves the player has. + * + * @remarks 4 GB + * @returns number of duplicate sleeves the player has. + */ + getNumSleeves(): number; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a structure containing the stats of the sleeve. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to get stats of. + * @returns Object containing the stats of the sleeve. + */ + getSleeveStats(sleeveNumber: number): SleeveStats; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a struct containing tons of information about this sleeve + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to retrieve information. + * @returns Object containing tons of information about this sleeve. + */ + getInformation(sleeveNumber: number): SleeveInformation; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to retrieve task from. + * @returns Object containing information the current task that the sleeve is performing. + */ + getTask(sleeveNumber: number): SleeveTask; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a boolean indicating whether or not this action was set successfully. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to start recovery. + * @returns True if this action was set successfully, false otherwise. + */ + setToShockRecovery(sleeveNumber: number): boolean; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a boolean indicating whether or not this action was set successfully. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to start synchronizing. + * @returns True if this action was set successfully, false otherwise. + */ + setToSynchronize(sleeveNumber: number): boolean; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a boolean indicating whether or not this action was set successfully. + * + * Returns false if an invalid action is specified. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to start commiting crime. + * @param name - Name of the crime. Must be an exact match. + * @returns True if this action was set successfully, false otherwise. + */ + setToCommitCrime(sleeveNumber: number, name: Crime): boolean; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a boolean indicating whether or not the sleeve started working or this faction. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to work for the faction. + * @param factionName - Name of the faction to work for. + * @param factionWorkType - Name of the action to perform for this faction. + * @returns True if the sleeve started working on this faction, false otherwise. + */ + setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType: FactionWork): boolean; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a boolean indicating whether or not the sleeve started working or this company. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to work for the company. + * @param companyName - Name of the company to work for. + * @returns True if the sleeve started working on this company, false otherwise. + */ + setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a boolean indicating whether or not this action was set successfully. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to start taking class. + * @param university - Name of the university to attend. + * @param className - Name of the class to follow. + * @returns True if this action was set successfully, false otherwise. + */ + setToUniversityCourse(sleeveNumber: number, university: University, className: UniversityCourse): boolean; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a boolean indicating whether or not the sleeve started working out. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to workout at the gym. + * @param gymName - Name of the gym. + * @param stat - Name of the stat to train. + * @returns True if the sleeve started working out, false otherwise. + */ + setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a boolean indicating whether or not the sleeve reached destination. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to travel. + * @param cityName - Name of the destination city. + * @returns True if the sleeve reached destination, false otherwise. + */ + travel(sleeveNumber: number, cityName: City): boolean; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a list of augmentation names that this sleeve has installed. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to retrieve augmentations from. + * @returns List of augmentation names that this sleeve has installed. + */ + getSleeveAugmentations(sleeveNumber: number): AugmentName[]; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return a list of augmentations that the player can buy for this sleeve. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from. + * @returns List of augmentations that the player can buy for this sleeve. + */ + getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; + + /** + * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + * + * Return true if the aug was purchased and installed on the sleeve. + * + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to buy an aug for. + * @param augName - Name of the aug to buy. Must be an exact match. + * @returns True if the aug was purchased and installed on the sleeve, false otherwise. + */ + purchaseSleeveAug(sleeveNumber: number, augName: AugmentName): boolean; +} + +/** + * @public + */ +export declare interface SleeveInformation { + /** location of the sleeve */ + city: City; + /** current hp of the sleeve */ + hp: number; + /** max hp of the sleeve */ + maxHp: number; + /** jobs available to the sleeve */ + jobs: string[]; + /** job titles available to the sleeve */ + jobTitle: CompanyField[]; + /** does this sleeve have access to the tor router */ + tor: boolean; + /** sleeve multipliers */ + mult: CharacterMult; + /** time spent on the current task in milliseconds */ + timeWorked: number; + /** earnings synchronized to other sleeves */ + earningsForSleeves: SleeveWorkGains; + /** earnings synchronized to the player */ + earningsForPlayer: SleeveWorkGains; + /** earnings for this sleeve */ + earningsForTask: SleeveWorkGains; + /** faction or company reputation gained for the current task */ + workRepGain: number; +} + +/** + * @public + */ +export declare interface SleeveStats { + /** current shock of the sleeve [0-100] */ + shock: + | 0 + | 1 + | 2 + | 3 + | 4 + | 5 + | 6 + | 7 + | 8 + | 9 + | 10 + | 11 + | 12 + | 13 + | 14 + | 15 + | 16 + | 17 + | 18 + | 19 + | 20 + | 21 + | 22 + | 23 + | 24 + | 25 + | 26 + | 27 + | 28 + | 29 + | 30 + | 31 + | 32 + | 33 + | 34 + | 35 + | 36 + | 37 + | 38 + | 39 + | 40 + | 41 + | 42 + | 43 + | 44 + | 45 + | 46 + | 47 + | 48 + | 49 + | 50 + | 51 + | 52 + | 53 + | 54 + | 55 + | 56 + | 57 + | 58 + | 59 + | 60 + | 61 + | 62 + | 63 + | 64 + | 65 + | 66 + | 67 + | 68 + | 69 + | 70 + | 71 + | 72 + | 73 + | 74 + | 75 + | 76 + | 77 + | 78 + | 79 + | 80 + | 81 + | 82 + | 83 + | 84 + | 85 + | 86 + | 87 + | 88 + | 89 + | 90 + | 91 + | 92 + | 93 + | 94 + | 95 + | 96 + | 97 + | 98 + | 99 + | 100; + /** current sync of the sleeve [0-100] */ + sync: + | 0 + | 1 + | 2 + | 3 + | 4 + | 5 + | 6 + | 7 + | 8 + | 9 + | 10 + | 11 + | 12 + | 13 + | 14 + | 15 + | 16 + | 17 + | 18 + | 19 + | 20 + | 21 + | 22 + | 23 + | 24 + | 25 + | 26 + | 27 + | 28 + | 29 + | 30 + | 31 + | 32 + | 33 + | 34 + | 35 + | 36 + | 37 + | 38 + | 39 + | 40 + | 41 + | 42 + | 43 + | 44 + | 45 + | 46 + | 47 + | 48 + | 49 + | 50 + | 51 + | 52 + | 53 + | 54 + | 55 + | 56 + | 57 + | 58 + | 59 + | 60 + | 61 + | 62 + | 63 + | 64 + | 65 + | 66 + | 67 + | 68 + | 69 + | 70 + | 71 + | 72 + | 73 + | 74 + | 75 + | 76 + | 77 + | 78 + | 79 + | 80 + | 81 + | 82 + | 83 + | 84 + | 85 + | 86 + | 87 + | 88 + | 89 + | 90 + | 91 + | 92 + | 93 + | 94 + | 95 + | 96 + | 97 + | 98 + | 99 + | 100; + /** current hacking skill of the sleeve */ + hacking_skill: number; + /** current strength of the sleeve */ + strength: number; + /** current defense of the sleeve */ + defense: number; + /** current dexterity of the sleeve */ + dexterity: number; + /** current agility of the sleeve */ + agility: number; + /** current charisma of the sleeve */ + charisma: number; +} + +/** + * @public + */ +export declare interface SleeveTask { + /** task type */ + task: string; + /** crime currently attempting, if any */ + crime: Crime | ""; + /** location of the task, if any */ + location: City | ""; + /** stat being trained at the gym, if any */ + gymStatType: GymStat | ""; + /** faction work type being performed, if any */ + factionWorkType: FactionWork | ""; +} + +/** + * @public + */ +export declare interface SleeveWorkGains { + /** hacking exp gained from work */ + workHackExpGain: number; + /** strength exp gained from work */ + workStrExpGain: number; + /** defense exp gained from work, */ + workDefExpGain: number; + /** dexterity exp gained from work */ + workDexExpGain: number; + /** agility exp gained from work */ + workAgiExpGain: number; + /** charisma exp gained from work */ + workChaExpGain: number; + /** money gained from work */ + workMoneyGain: number; +} + +/** + * @public + */ +export declare interface SourceFileLvl { + /** The number of the source file */ + n: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12; + /** The level of the source file */ + lvl: number; +} + +/** + * @public + */ +export declare type StockOrder = { + /** Stock Symbol */ + [key in StockSymbol]?: StockOrderObject[]; +}; + +/** + * @public + */ +export declare interface StockOrderObject { + /** Number of shares */ + shares: number; + /** Price per share */ + price: number; + /** Order type */ + type: "Limit Buy Order" | "Limit Sell Order" | "Stop Buy Order" | "Stop Buy Order"; + /** Order position */ + position: "S" | "L"; +} + +/** + * @public + */ +export declare type StockSymbol = +| "ECP" +| "MGCP" +| "BLD" +| "CLRK" +| "OMTK" +| "FSIG" +| "KGI" +| "FLCM" +| "STM" +| "DCOMM" +| "HLS" +| "VITA" +| "ICRS" +| "UNV" +| "AERO" +| "OMN" +| "SLRS" +| "GPH" +| "NVMD" +| "WDS" +| "LXO" +| "RHOC" +| "APHE" +| "SYSC" +| "CTK" +| "NTLK" +| "OMGA" +| "FNS" +| "SGC" +| "JGN" +| "CTYS" +| "MDYN" +| "TITN"; + +/** + * @public + */ +export declare interface TIX { + /** + * Returns an array of the symbols of the tradable stocks + * + * @remarks 2 GB + * @returns Array of the symbols of the tradable stocks. + */ + getSymbols(): StockSymbol[]; + + /** + * Returns the price of a stock, given its symbol (NOT the company name). + * The symbol is a sequence of two to four capital letters. + * + * The stock’s price is the average of its bid and ask price + * + * @example + * ```js + * getPrice("FISG"); + * ``` + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns The price of a stock. + */ + getPrice(sym: StockSymbol): number; + + /** + * Given a stock’s symbol (NOT the company name), returns the ask price of that stock. + * The symbol is a sequence of two to four capital letters. + * + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns The ask price of a stock. + */ + getAskPrice(sym: StockSymbol): number; + + /** + * Given a stock’s symbol (NOT the company name), returns the bid price of that stock. + * The symbol is a sequence of two to four capital letters. + * + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns The bid price of a stock. + */ + getBidPrice(sym: StockSymbol): number; + + /** + * Returns an array of four elements that represents the player’s position in a stock. + * + * The first element is the returned array is the number of shares the player owns of + * the stock in the Long position. The second element in the array is the average price + * of the player’s shares in the Long position. + * + * The third element in the array is the number of shares the player owns of the stock + * in the Short position. The fourth element in the array is the average price of the + * player’s Short position. + * + * All elements in the returned array are numeric. + * + * @example + * ```js + * pos = getPosition("ECP"); + * shares = pos[0]; + * avgPx = pos[1]; + * sharesShort = pos[2]; + * avgPxShort = pos[3]; + * ``` + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns Array of four elements that represents the player’s position in a stock. + */ + getPosition(sym: StockSymbol): [number, number, number, number]; + + /** + * Returns the maximum number of shares that the stock has. + * This is the maximum amount of the stock that can be purchased + * in both the Long and Short positions combined. + * + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns Maximum number of shares that the stock has. + */ + getMaxShares(sym: StockSymbol): number; + + /** + * Calculates and returns how much it would cost to buy a given number of shares of a stock. + * This takes into account spread, large transactions influencing the price of the stock and commission fees. + * + * @remarks 2 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to purchase. + * @param posType - Specifies whether the order is a “Long” or “Short” position. + * @returns Cost to buy a given number of shares of a stock. + */ + getPurchaseCost(sym: StockSymbol, shares: number, posType: OrderPos): number; + + /** + * Calculates and returns how much you would gain from selling a given number of shares of a stock. + * This takes into account spread, large transactions influencing the price of the stock and commission fees. + * + * @remarks 2 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to sell. + * @param posType - Specifies whether the order is a “Long” or “Short” position. + * @returns Gain from selling a given number of shares of a stock. + */ + getSaleGain(sym: StockSymbol, shares: number, posType: OrderPos): number; + + /** + * Attempts to purchase shares of a stock using a Market Order. + * + * If the player does not have enough money to purchase the specified number of shares, + * then no shares will be purchased. Remember that every transaction on the stock exchange + * costs a certain commission fee. + * + * If this function successfully purchases the shares, it will return the stock price at which + * each share was purchased. Otherwise, it will return 0. + * + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to purchased. Must be positive. Will be rounded to nearest integer. + * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. + */ + buy(sym: StockSymbol, shares: number): number; + + /** + * Attempts to sell shares of a stock using a Market Order. + * + * If the specified number of shares in the function exceeds the amount that the player + * actually owns, then this function will sell all owned shares. Remember that every + * transaction on the stock exchange costs a certain commission fee. + * + * The net profit made from selling stocks with this function is reflected in the script’s + * statistics. This net profit is calculated as: + * + * shares * (sell_price - average_price_of_purchased_shares) + * + * If the sale is successful, this function will return the stock price at + * which each share was sold. Otherwise, it will return 0. + * + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer. + * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold. + */ + sell(sym: StockSymbol, shares: number): number; + + /** + * Attempts to purchase a short position of a stock using a Market Order. + * + * The ability to short a stock is **not** immediately available to the player and + * must be unlocked later on in the game. + * + * If the player does not have enough money to purchase the specified number of shares, + * then no shares will be purchased. Remember that every transaction on the stock exchange + * costs a certain commission fee. + * + * If the purchase is successful, this function will return the stock price at which each + * share was purchased. Otherwise, it will return 0. + * + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to short. Must be positive. Will be rounded to nearest integer. + * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. + */ + short(sym: StockSymbol, shares: number): number; + + /** + * Attempts to sell a short position of a stock using a Market Order. + * + * The ability to short a stock is **not** immediately available to the player and + * must be unlocked later on in the game. + * + * If the specified number of shares exceeds the amount that the player actually owns, + * then this function will sell all owned shares. Remember that every transaction on + * the stock exchange costs a certain commission fee. + * + * If the sale is successful, this function will return the stock price at which each + * share was sold. Otherwise it will return 0. + * + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer. + * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold. + */ + sellShort(sym: StockSymbol, shares: number): number; + + /** + * Places an order on the stock market. This function only works for Limit and Stop Orders. + * + * The ability to place limit and stop orders is **not** immediately available to the player and + * must be unlocked later on in the game. + * + * Returns true if the order is successfully placed, and false otherwise. + * + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer. + * @param price - Execution price for the order. + * @param type - Type of order. + * @param pos - Specifies whether the order is a “Long” or “Short” position. + * @returns True if the order is successfully placed, and false otherwise. + */ + placeOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): boolean; + + /** + * Cancels an oustanding 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. + * + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer. + * @param price - Execution price for the order. + * @param type - Type of order. + * @param pos - Specifies whether the order is a “Long” or “Short” position. + */ + cancelOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): void; + + /** + * Returns your order book for the stock market. + * + * This is an object containing information for all the Limit and Stop Orders you have in the stock market. + * The object has the following structure: + * + * ```js + * { + * StockSymbol1: [ // Array of orders for this stock + * { + * shares: Order quantity + * price: Order price + * type: Order type + * position: Either "L" or "S" for Long or Short position + * }, + * { + * ... + * }, + * ... + * ], + * StockSymbol2: [ // Array of orders for this stock + * ... + * ], + * ... + * } + * ``` + * The “Order type” property can have one of the following four values: + * * “Limit Buy Order” + * * “Limit Sell Order” + * * “Stop Buy Order” + * * “Stop Sell Order” + * Note that the order book will only contain information for stocks that you actually have orders in. + * + * @example + * ```js + * "If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property." + * { + * ECP: [ + * { + * shares: 5, + * price: 100,000 + * type: "Stop Buy Order", + * position: "S", + * }, + * { + * shares: 25, + * price: 125,000 + * type: "Limit Sell Order", + * position: "L", + * }, + * ], + * SYSC: [ + * { + * shares: 100, + * price: 10,000 + * type: "Limit Buy Order", + * position: "L", + * }, + * ], + * } + * ``` + * @remarks 2.5 GB + * @returns Object containing information for all the Limit and Stop Orders you have in the stock market. + */ + getOrders(): StockOrder; + + /** + * Returns the volatility of the specified stock. + * + * Volatility represents the maximum percentage by which a stock’s price can change every tick. + * The volatility is returned as a decimal value, NOT a percentage + * (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3). + * + * In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. + * + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @returns Volatility of the specified stock. + */ + getVolatility(sym: StockSymbol): number; + + /** + * Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. + * + * The probability is returned as a decimal value, NOT a percentage + * (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60). + * + * In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a + * 30% chance of increasing and a 70% chance of decreasing during the next tick. + * + * In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. + * + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @returns Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. + */ + getForecast(sym: StockSymbol): number; + + /** + * Purchase 4S Market Data Access. + * + * Returns true if you successfully purchased it or if you already have access. Returns false otherwise. + * + * @remarks 2.5 GB + * @returns True if you successfully purchased it or if you already have access, false otherwise. + */ + purchase4SMarketData(): boolean; + + /** + * Purchase 4S Market Data TIX API Access. + * + * Returns true if you successfully purchased it or if you already have access. Returns false otherwise. + * + * @remarks 2.5 GB + * @returns True if you successfully purchased it or if you already have access, false otherwise. + */ + purchase4SMarketDataTixApi(): boolean; +} + +/** + * @public + */ +export declare type University = "Summit University" | "Rothman University" | "ZB Institute Of Technology"; + +/** + * @public + */ +export declare type UniversityCourse = +| "Study Computer Science" +| "Data Strucures" +| "Networks" +| "Algorithms" +| "Management" +| "Leadership"; + +export { } diff --git a/input/bitburner.api.json b/input/bitburner.api.json new file mode 100644 index 000000000..4e849f832 --- /dev/null +++ b/input/bitburner.api.json @@ -0,0 +1,20752 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.18.17", + "schemaVersion": 1004, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + } + } + }, + "kind": "Package", + "canonicalReference": "bitburner!", + "docComment": "", + "name": "bitburner", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "bitburner!", + "name": "", + "members": [ + { + "kind": "Interface", + "canonicalReference": "bitburner!AugmentationStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface AugmentationStats " + } + ], + "releaseTag": "Public", + "name": "AugmentationStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#agility_exp_mult:member", + "docComment": "/**\n * Multipler to agility experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "agility_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#agility_mult:member", + "docComment": "/**\n * Multipler to agility skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "agility_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#bladeburner_analysis_mult:member", + "docComment": "/**\n * Multipler to effectiveness in Bladeburner Field Analysis\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bladeburner_analysis_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "bladeburner_analysis_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#bladeburner_max_stamina_mult:member", + "docComment": "/**\n * Multipler to Bladeburner max stamina\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bladeburner_max_stamina_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "bladeburner_max_stamina_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#bladeburner_stamina_gain_mult:member", + "docComment": "/**\n * Multipler to Bladeburner stamina gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bladeburner_stamina_gain_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "bladeburner_stamina_gain_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#bladeburner_success_chance_mult:member", + "docComment": "/**\n * Multipler to success chance in Bladeburner contracts/operations\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bladeburner_success_chance_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "bladeburner_success_chance_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#charisma_exp_mult:member", + "docComment": "/**\n * Multipler to charisma experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "charisma_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#charisma_mult:member", + "docComment": "/**\n * Multipler to charisma skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "charisma_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#company_rep_mult:member", + "docComment": "/**\n * Multipler to amount of reputation gained when working\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "company_rep_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "company_rep_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#crime_money_mult:member", + "docComment": "/**\n * Multipler to amount of money gained from crimes\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crime_money_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "crime_money_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#crime_success_mult:member", + "docComment": "/**\n * Multipler to crime success rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crime_success_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "crime_success_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#defense_exp_mult:member", + "docComment": "/**\n * Multipler to defense experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "defense_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#defense_mult:member", + "docComment": "/**\n * Multipler to defense skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "defense_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#dexterity_exp_mult:member", + "docComment": "/**\n * Multipler to dexterity experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "dexterity_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#dexterity_mult:member", + "docComment": "/**\n * Multipler to dexterity skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "dexterity_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#faction_rep_mult:member", + "docComment": "/**\n * Multipler to amount of reputation gained when working\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "faction_rep_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "faction_rep_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_chance_mult:member", + "docComment": "/**\n * Multipler to chance of successfully performing a hack\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_chance_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_chance_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_exp_mult:member", + "docComment": "/**\n * Multipler to hacking experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_grow_mult:member", + "docComment": "/**\n * Multipler to amount of money injected into servers using grow)}\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_grow_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_grow_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_money_mult:member", + "docComment": "/**\n * Multipler to amount of money the player gains from hacking\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_money_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_money_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_mult:member", + "docComment": "/**\n * Multipler to hacking skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_speed_mult:member", + "docComment": "/**\n * Multipler to hacking speed\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_speed_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_speed_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_core_cost_mult:member", + "docComment": "/**\n * Multipler to cost of core for a Hacknet Node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_core_cost_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_core_cost_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_level_cost_mult:member", + "docComment": "/**\n * Multipler to cost of leveling up a Hacknet Node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_level_cost_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_level_cost_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_money_mult:member", + "docComment": "/**\n * Multipler to amount of money produced by Hacknet Nodes\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_money_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_money_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_purchase_cost_mult:member", + "docComment": "/**\n * Multipler to cost of purchasing a Hacknet Node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_purchase_cost_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_purchase_cost_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_ram_cost_mult:member", + "docComment": "/**\n * Multipler to cost of ram for a Hacknet Node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_ram_cost_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_ram_cost_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#strength_exp_mult:member", + "docComment": "/**\n * Multipler to strength experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "strength_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#strength_mult:member", + "docComment": "/**\n * Multipler to strength skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "strength_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#work_money_mult:member", + "docComment": "/**\n * Multipler to amount of money gained from working\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "work_money_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "work_money_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!AugmentName:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type AugmentName =\n " + }, + { + "kind": "Content", + "text": "| \"Augmented Targeting I\"\n | \"Augmented Targeting II\"\n | \"Augmented Targeting III\"\n | \"Synthetic Heart\"\n | \"Synfibril Muscle\"\n | \"Combat Rib I\"\n | \"Combat Rib II\"\n | \"Combat Rib III\"\n | \"Nanofiber Weave\"\n | \"NEMEAN Subdermal Weave\"\n | \"Wired Reflexes\"\n | \"Graphene Bone Lacings\"\n | \"Bionic Spine\"\n | \"Graphene Bionic Spine Upgrade\"\n | \"Bionic Legs\"\n | \"Graphene Bionic Legs Upgrade\"\n | \"Speech Processor Implant\"\n | \"TITN-41 Gene-Modification Injection\"\n | \"Enhanced Social Interaction Implant\"\n | \"BitWire\"\n | \"Artificial Bio-neural Network Implant\"\n | \"Artificial Synaptic Potentiation\"\n | \"Enhanced Myelin Sheathing\"\n | \"Synaptic Enhancement Implant\"\n | \"Neural-Retention Enhancement\"\n | \"DataJack\"\n | \"Embedded Netburner Module\"\n | \"Embedded Netburner Module Core Implant\"\n | \"Embedded Netburner Module Core V2 Upgrade\"\n | \"Embedded Netburner Module Core V3 Upgrade\"\n | \"Embedded Netburner Module Analyze Engine\"\n | \"Embedded Netburner Module Direct Memory Access Upgrade\"\n | \"Neuralstimulator\"\n | \"Neural Accelerator\"\n | \"Cranial Signal Processors - Gen I\"\n | \"Cranial Signal Processors - Gen II\"\n | \"Cranial Signal Processors - Gen III\"\n | \"Cranial Signal Processors - Gen IV\"\n | \"Cranial Signal Processors - Gen V\"\n | \"Neuronal Densification\"\n | \"Nuoptimal Nootropic Injector Implant\"\n | \"Speech Enhancement\"\n | \"FocusWire\"\n | \"PC Direct-Neural Interface\"\n | \"PC Direct-Neural Interface Optimization Submodule\"\n | \"PC Direct-Neural Interface NeuroNet Injector\"\n | \"ADR-V1 Pheromone Gene\"\n | \"ADR-V2 Pheromone Gene\"\n | \"The Shadow's Simulacrum\"\n | \"Hacknet Node CPU Architecture Neural-Upload\"\n | \"Hacknet Node Cache Architecture Neural-Upload\"\n | \"Hacknet Node NIC Architecture Neural-Upload\"\n | \"Hacknet Node Kernel Direct-Neural Interface\"\n | \"Hacknet Node Core Direct-Neural Interface\"\n | \"NeuroFlux Governor\"\n | \"Neurotrainer I\"\n | \"Neurotrainer II\"\n | \"Neurotrainer III\"\n | \"HyperSight Corneal Implant\"\n | \"LuminCloaking-V1 Skin Implant\"\n | \"LuminCloaking-V2 Skin Implant\"\n | \"HemoRecirculator\"\n | \"SmartSonar Implant\"\n | \"Power Recirculation Core\"\n | \"QLink\"\n | \"The Red Pill\"\n | \"SPTN-97 Gene Modification\"\n | \"ECorp HVMind Implant\"\n | \"CordiARC Fusion Reactor\"\n | \"SmartJaw\"\n | \"Neotra\"\n | \"Xanipher\"\n | \"nextSENS Gene Modification\"\n | \"OmniTek InfoLoad\"\n | \"Photosynthetic Cells\"\n | \"BitRunners Neurolink\"\n | \"The Black Hand\"\n | \"CRTX42-AA Gene Modification\"\n | \"Neuregen Gene Modification\"\n | \"CashRoot Starter Kit\"\n | \"NutriGen Implant\"\n | \"INFRARET Enhancement\"\n | \"DermaForce Particle Barrier\"\n | \"Graphene BranchiBlades Upgrade\"\n | \"Graphene Bionic Arms Upgrade\"\n | \"BrachiBlades\"\n | \"Bionic Arms\"\n | \"Social Negotiation Assistant (S.N.A)\"\n | \"EsperTech Bladeburner Eyewear\"\n | \"EMS-4 Recombination\"\n | \"ORION-MKIV Shoulder\"\n | \"Hyperion Plasma Cannon V1\"\n | \"Hyperion Plasma Cannon V2\"\n | \"GOLEM Serum\"\n | \"Vangelis Virus\"\n | \"Vangelis Virus 3.0\"\n | \"I.N.T.E.R.L.I.N.K.E.D\"\n | \"Blade's Runners\"\n | \"BLADE-51b Tesla Armor\"\n | \"BLADE-51b Tesla Armor: Power Cells Upgrade\"\n | \"BLADE-51b Tesla Armor: Energy Shielding Upgrade\"\n | \"BLADE-51b Tesla Armor: Unibeam Upgrade\"\n | \"BLADE-51b Tesla Armor: Omnibeam Upgrade\"\n | \"BLADE-51b Tesla Armor: IPU Upgrade\"\n | \"The Blade's Simulacrum\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "AugmentName", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!AugmentPair:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface AugmentPair " + } + ], + "releaseTag": "Public", + "name": "AugmentPair", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentPair#cost:member", + "docComment": "/**\n * augmentation cost\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentPair#name:member", + "docComment": "/**\n * augmentation name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!BasicHGWOptions:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BasicHGWOptions " + } + ], + "releaseTag": "Public", + "name": "BasicHGWOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BasicHGWOptions#threads:member", + "docComment": "/**\n * Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "threads", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!BitNodeMultipliers:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BitNodeMultipliers " + } + ], + "releaseTag": "Public", + "name": "BitNodeMultipliers", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#AgilityLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's agility level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "AgilityLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "AgilityLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#AugmentationMoneyCost:member", + "docComment": "/**\n * Influences the base cost to purchase an augmentation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "AugmentationMoneyCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "AugmentationMoneyCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#AugmentationRepCost:member", + "docComment": "/**\n * Influences the base rep the player must have with a faction to purchase an augmentation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "AugmentationRepCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "AugmentationRepCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#BladeburnerRank:member", + "docComment": "/**\n * Influences how quickly the player can gain rank within Bladeburner.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BladeburnerRank: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "BladeburnerRank", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#BladeburnerSkillCost:member", + "docComment": "/**\n * Influences the cost of skill levels from Bladeburner.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BladeburnerSkillCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "BladeburnerSkillCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CharismaLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's charisma level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CharismaLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CharismaLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ClassGymExpGain:member", + "docComment": "/**\n * Influences the experience gained for each ability when a player completes a class.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ClassGymExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ClassGymExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CodingContractMoney:member", + "docComment": "/**\n * Influences the amount of money gained from completing Coding Contracts\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CodingContractMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CodingContractMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CompanyWorkExpGain:member", + "docComment": "/**\n * Influences the experience gained for each ability when the player completes working their job.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CompanyWorkExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CompanyWorkExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CompanyWorkMoney:member", + "docComment": "/**\n * Influences how much money the player earns when completing working their job.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CompanyWorkMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CompanyWorkMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CorporationValuation:member", + "docComment": "/**\n * Influences the valuation of corporations created by the player.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CorporationValuation: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CorporationValuation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CrimeExpGain:member", + "docComment": "/**\n * Influences the base experience gained for each ability when the player commits a crime.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CrimeExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CrimeExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CrimeMoney:member", + "docComment": "/**\n * Influences the base money gained when the player commits a crime.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CrimeMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CrimeMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#DaedalusAugsRequirement:member", + "docComment": "/**\n * Influences how many Augmentations you need in order to get invited to the Daedalus faction\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DaedalusAugsRequirement: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "DaedalusAugsRequirement", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#DefenseLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's defense level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DefenseLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "DefenseLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#DexterityLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's dexterity level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DexterityLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "DexterityLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FactionPassiveRepGain:member", + "docComment": "/**\n * Influences how much rep the player gains in each faction simply by being a member.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FactionPassiveRepGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FactionPassiveRepGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FactionWorkExpGain:member", + "docComment": "/**\n * Influences the experience gained for each ability when the player completes work for a Faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FactionWorkExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FactionWorkExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FactionWorkRepGain:member", + "docComment": "/**\n * Influences how much rep the player gains when performing work for a faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FactionWorkRepGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FactionWorkRepGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FourSigmaMarketDataApiCost:member", + "docComment": "/**\n * Influences how much it costs to unlock the stock market's 4S Market Data API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FourSigmaMarketDataApiCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FourSigmaMarketDataApiCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FourSigmaMarketDataCost:member", + "docComment": "/**\n * Influences how much it costs to unlock the stock market's 4S Market Data (NOT API)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FourSigmaMarketDataCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FourSigmaMarketDataCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#HackExpGain:member", + "docComment": "/**\n * Influences the experienced gained when hacking a server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HackExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HackExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#HackingLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's hacking level (not experience) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HackingLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HackingLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#HacknetNodeMoney:member", + "docComment": "/**\n * Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HacknetNodeMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HacknetNodeMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#HomeComputerRamCost:member", + "docComment": "/**\n * Influences how much money it costs to upgrade your home computer's RAM\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HomeComputerRamCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HomeComputerRamCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#InfiltrationMoney:member", + "docComment": "/**\n * Influences how much money is gained when the player infiltrates a company.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "InfiltrationMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "InfiltrationMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#InfiltrationRep:member", + "docComment": "/**\n * Influences how much rep the player can gain from factions when selling stolen documents and secrets\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "InfiltrationRep: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "InfiltrationRep", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ManualHackMoney:member", + "docComment": "/**\n * Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ManualHackMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ManualHackMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#PurchasedServerCost:member", + "docComment": "/**\n * Influence how much it costs to purchase a server\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchasedServerCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchasedServerCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#PurchasedServerLimit:member", + "docComment": "/**\n * Influences the maximum number of purchased servers you can have\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchasedServerLimit: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchasedServerLimit", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#PurchasedServerMaxRam:member", + "docComment": "/**\n * Influences the maximum allowed RAM for a purchased server\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchasedServerMaxRam: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchasedServerMaxRam", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#RepToDonateToFaction:member", + "docComment": "/**\n * Influences the minimum favor the player must have with a faction before they can donate to gain rep.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "RepToDonateToFaction: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "RepToDonateToFaction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ScriptHackMoney:member", + "docComment": "/**\n * Influences how much money can be stolen from a server when a script performs a hack against it.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ScriptHackMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ScriptHackMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerGrowthRate:member", + "docComment": "/**\n * Influences the growth percentage per cycle against a server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerGrowthRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerGrowthRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerMaxMoney:member", + "docComment": "/**\n * Influences the maxmimum money that a server can grow to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerMaxMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerMaxMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerStartingMoney:member", + "docComment": "/**\n * Influences the initial money that a server starts with.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerStartingMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerStartingMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerStartingSecurity:member", + "docComment": "/**\n * Influences the initial security level (hackDifficulty) of a server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerStartingSecurity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerStartingSecurity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerWeakenRate:member", + "docComment": "/**\n * Influences the weaken amount per invocation against a server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerWeakenRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerWeakenRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#StrengthLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's strength level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "StrengthLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "StrengthLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Bladeburner:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Bladeburner " + } + ], + "releaseTag": "Public", + "name": "Bladeburner", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionAutolevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Return a boolean indicating whether or not this action is currently set to autolevel.\n *\n * Returns false if an invalid action is specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns True if the action is set to autolevel, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionAutolevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionAutolevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionCountRemaining:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the remaining count of the specified action.\n *\n * Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Remaining count of the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionCountRemaining(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionCountRemaining" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionCurrentLevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the current level of this action.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Current level of the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionCurrentLevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionCurrentLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionEstimatedSuccessChance:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Estimated success chance for the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionEstimatedSuccessChance(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionEstimatedSuccessChance" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionMaxLevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the maximum level for this action.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Maximum level of the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionMaxLevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionMaxLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionRepGain:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param level - Optional action level at which to calculate the gain\n *\n * @returns Average Bladeburner reputation gain for successfully completing the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionRepGain(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n level: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + }, + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ], + "name": "getActionRepGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionTime:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of seconds it takes to complete the specified action\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Number of seconds it takes to complete the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionTime(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getBlackOpNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner Black Ops.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner Black Ops.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBlackOpNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getBlackOpNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getBlackOpRank:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the rank required to complete this BlackOp.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param name - Name of BlackOp. Must be an exact match.\n *\n * @returns Rank required to complete this BlackOp.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBlackOpRank(name: " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getBlackOpRank" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getBonusTime:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.\n *\n * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.\n *\n * “Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBonusTime(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getBonusTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCity:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the city that the player is currently in (for Bladeburner).\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns City that the player is currently in (for Bladeburner).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCity(): " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getCity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCityChaos:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the chaos in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Chaos in the specified city.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCityChaos(name: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCityChaos" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCityCommunities:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Number of Synthoids communities in the specified city.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCityCommunities(name: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCityCommunities" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCityEstimatedPopulation:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Estimated number of Synthoids in the specified city.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCityEstimatedPopulation(name: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCityEstimatedPopulation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getContractNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner contracts.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner contracts.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getContractNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getContractNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCurrentAction:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”.\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns Object that represents the player’s current Bladeburner action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCurrentAction(): " + }, + { + "kind": "Reference", + "text": "BladeburnerCurAction", + "canonicalReference": "bitburner!BladeburnerCurAction:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getCurrentAction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getGeneralActionNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all general Bladeburner actions.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all general Bladeburner actions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGeneralActionNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getGeneralActionNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getOperationNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner operations.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner operations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOperationNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getOperationNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getRank:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the player’s Bladeburner Rank.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Player’s Bladeburner Rank.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getRank(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getRank" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getSkillLevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * This function returns your level in the specified skill.\n *\n * The function returns -1 if an invalid skill name is passed in.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param skillName - Name of skill. Case-sensitive and must be an exact match\n *\n * @returns Level in the specified skill.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSkillLevel(name: " + }, + { + "kind": "Reference", + "text": "BladeburnerSkills", + "canonicalReference": "bitburner!BladeburnerSkills:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSkillLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getSkillNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all general Bladeburner skills.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all general Bladeburner skills.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSkillNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerSkills", + "canonicalReference": "bitburner!BladeburnerSkills:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getSkillNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getSkillPoints:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of Bladeburner skill points you have.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Number of Bladeburner skill points you have.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSkillPoints(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getSkillPoints" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getSkillUpgradeCost:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * This function returns the number of skill points needed to upgrade the specified skill.\n *\n * The function returns -1 if an invalid skill name is passed in.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param skillName - Name of skill. Case-sensitive and must be an exact match\n *\n * @returns Number of skill points needed to upgrade the specified skill.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSkillUpgradeCost(name: " + }, + { + "kind": "Reference", + "text": "BladeburnerSkills", + "canonicalReference": "bitburner!BladeburnerSkills:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSkillUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getStamina:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array with two elements: * [Current stamina, Max stamina]\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Array containing current stamina and max stamina.\n *\n * @example\n * ```js\n * function getStaminaPercentage() {\n * let res = bladeburner.getStamina();\n * return res[0] / res[1];\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getStamina(): " + }, + { + "kind": "Content", + "text": "[number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getStamina" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getTeamSize:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of Bladeburner team members you have assigned to the specified action.\n *\n * Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Number of Bladeburner team members that were assigned to the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTeamSize(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getTeamSize" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#joinBladeburnerDivision:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to join the Bladeburner division.\n *\n * Returns true if you successfully join the Bladeburner division, or if you are already a member.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "joinBladeburnerDivision(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "joinBladeburnerDivision" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#joinBladeburnerFaction:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to join the Bladeburner faction.\n *\n * Returns true if you successfully join the Bladeburner faction, or if you are already a member.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "joinBladeburnerFaction(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "joinBladeburnerFaction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#setActionAutolevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Enable/disable autoleveling for the specified action.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param autoLevel - Whether or not to autolevel this action\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setActionAutolevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n autoLevel: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + }, + { + "parameterName": "autoLevel", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ], + "name": "setActionAutolevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#setActionLevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Set the level for the specified action.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param level - Level to set this action to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setActionLevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n level: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + }, + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ], + "name": "setActionLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#setTeamSize:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Set the team size for the specified Bladeburner action.\n *\n * Returns the team size that was set, or -1 if the function failed.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param size - Number of team members to set. Will be converted using Math.round().\n *\n * @returns Number of Bladeburner team members you assigned to the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTeamSize(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n size: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + }, + { + "parameterName": "size", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ], + "name": "setTeamSize" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#startAction:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match\n *\n * @returns True if the action was started successfully, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startAction(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "startAction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#stopBladeburnerAction:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Stops the current Bladeburner action.\n *\n * @remarks\n *\n * 2 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopBladeburnerAction(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "stopBladeburnerAction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#switchCity:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to switch to the specified city (for Bladeburner only).\n *\n * Returns true if successful, and false otherwise\n *\n * @remarks\n *\n * 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns true if successful, and false otherwise\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "switchCity(name: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "switchCity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#upgradeSkill:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to upgrade the specified Bladeburner skill.\n *\n * Returns true if the skill is successfully upgraded, and false otherwise.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match\n *\n * @returns true if the skill is successfully upgraded, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeSkill(name: " + }, + { + "kind": "Reference", + "text": "BladeburnerSkills", + "canonicalReference": "bitburner!BladeburnerSkills:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "upgradeSkill" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerActTypes:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerActTypes = " + }, + { + "kind": "Content", + "text": "\"contracts\" | \"operations\" | \"black ops\" | \"general\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerActTypes", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerBlackOps:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerBlackOps =\n " + }, + { + "kind": "Content", + "text": "| \"Operation Typhoon\"\n | \"Operation Zero\"\n | \"Operation X\"\n | \"Operation Titan\"\n | \"Operation Ares\"\n | \"Operation Archangel\"\n | \"Operation Juggernaut\"\n | \"Operation Red Dragon\"\n | \"Operation K\"\n | \"Operation Deckard\"\n | \"Operation Tyrell\"\n | \"Operation Wallace\"\n | \"Operation Shoulder of Orion\"\n | \"Operation Hyron\"\n | \"Operation Morpheus\"\n | \"Operation Ion Storm\"\n | \"Operation Annihilus\"\n | \"Operation Ultron\"\n | \"Operation Centurion\"\n | \"Operation Vindictus\"\n | \"Operation Daedalus\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerBlackOps", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerContracts:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerContracts = " + }, + { + "kind": "Content", + "text": "\"Tracking\" | \"Bounty Hunter\" | \"Retirement\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerContracts", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!BladeburnerCurAction:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BladeburnerCurAction " + } + ], + "releaseTag": "Public", + "name": "BladeburnerCurAction", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BladeburnerCurAction#name:member", + "docComment": "/**\n * Name of Action\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BladeburnerCurAction#type:member", + "docComment": "/**\n * Type of Action\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": " | \"Idle\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerGenActions:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerGenActions =\n " + }, + { + "kind": "Content", + "text": "| \"Training\"\n | \"Field Analysis\"\n | \"Recruitment\"\n | \"Diplomacy\"\n | \"Hyperbolic Regeneration Chamber\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerGenActions", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerOperations:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerOperations =\n " + }, + { + "kind": "Content", + "text": "| \"Investigation\"\n | \"Undercover Operation\"\n | \"Sting Operation\"\n | \"Raid\"\n | \"Stealth Retirement Operation\"\n | \"Assassination\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerOperations", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerSkills:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerSkills =\n " + }, + { + "kind": "Content", + "text": "| \"Blade's Intuition\"\n | \"Cloak\"\n | \"Marksman\"\n | \"Weapon Proficiency\"\n | \"Short-Circuit\"\n | \"Digital Observer\"\n | \"Tracer\"\n | \"Overclock\"\n | \"Reaper\"\n | \"Evasive System\"\n | \"Datamancer\"\n | \"Cyber's Edge\"\n | \"Hands of Midas\"\n | \"Hyperdrive\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerSkills", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CharacterInfo:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CharacterInfo " + } + ], + "releaseTag": "Public", + "name": "CharacterInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#bitnode:member", + "docComment": "/**\n * Current BitNode number\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bitnode: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "bitnode", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#city:member", + "docComment": "/**\n * Name of city you are currently in\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "city: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "city", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#company:member", + "docComment": "/**\n * Array of all companies at which you have jobs\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "company: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "company", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#factions:member", + "docComment": "/**\n * Array of factions you are currently a member of\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "factions: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "factions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#hp:member", + "docComment": "/**\n * Current health points\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#jobTitle:member", + "docComment": "/**\n * Array of job positions for all companies you are employed at. Same order as 'jobs'\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "jobTitle: " + }, + { + "kind": "Reference", + "text": "CompanyField", + "canonicalReference": "bitburner!CompanyField:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "jobTitle", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#maxHp:member", + "docComment": "/**\n * Maximum health points\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxHp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "maxHp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#mult:member", + "docComment": "/**\n * Object with many of the player's multipliers from Augmentations/Source Files\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mult: " + }, + { + "kind": "Reference", + "text": "CharacterMult", + "canonicalReference": "bitburner!CharacterMult:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#timeWorked:member", + "docComment": "/**\n * Timed worked in ms\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeWorked: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "timeWorked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#tor:member", + "docComment": "/**\n * Boolean indicating whether or not you have a tor router\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tor: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "tor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workAgiExpGain:member", + "docComment": "/**\n * Agi experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workAgiExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workAgiExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workChaExpGain:member", + "docComment": "/**\n * Cha experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workChaExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workChaExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workDefExpGain:member", + "docComment": "/**\n * Def experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workDefExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workDefExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workDexExpGain:member", + "docComment": "/**\n * Dex experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workDexExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workDexExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workHackExpGain:member", + "docComment": "/**\n * Hacking experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workHackExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workHackExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workMoneyGain:member", + "docComment": "/**\n * Money earned so far from work, if applicable\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workMoneyGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workMoneyGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workRepGain:member", + "docComment": "/**\n * Reputation earned so far from work, if applicable\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workRepGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workRepGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workStrExpGain:member", + "docComment": "/**\n * Str experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workStrExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workStrExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CharacterMult:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CharacterMult " + } + ], + "releaseTag": "Public", + "name": "CharacterMult", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#agility:member", + "docComment": "/**\n * Agility stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#agilityExp:member", + "docComment": "/**\n * Agility exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agilityExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agilityExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#companyRep:member", + "docComment": "/**\n * Company reputation\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "companyRep: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "companyRep", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#crimeMoney:member", + "docComment": "/**\n * Money earned from crimes\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crimeMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "crimeMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#crimeSuccess:member", + "docComment": "/**\n * Crime success chance\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crimeSuccess: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "crimeSuccess", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#defense:member", + "docComment": "/**\n * Defense stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#defenseExp:member", + "docComment": "/**\n * Defense exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defenseExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defenseExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#dexterity:member", + "docComment": "/**\n * Dexterity stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#dexterityExp:member", + "docComment": "/**\n * Dexterity exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterityExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterityExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#factionRep:member", + "docComment": "/**\n * Faction reputation\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "factionRep: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "factionRep", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#hacking:member", + "docComment": "/**\n * Hacking stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#hackingExp:member", + "docComment": "/**\n * Hacking exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackingExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackingExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#strength:member", + "docComment": "/**\n * Strength stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#strengthExp:member", + "docComment": "/**\n * Strength exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strengthExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strengthExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#workMoney:member", + "docComment": "/**\n * Money earned from jobs\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!City:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type City = " + }, + { + "kind": "Content", + "text": "\"Aevum\" | \"Chongqing\" | \"Sector-12\" | \"New Tokyo\" | \"Ishima\" | \"Volhaven\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "City", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CodingAttemptOptions:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CodingAttemptOptions " + } + ], + "releaseTag": "Public", + "name": "CodingAttemptOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CodingAttemptOptions#returnReward:member", + "docComment": "/**\n * If truthy, then the function will return a string that states the contract’s reward when it is successfully solved.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "returnReward: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "returnReward", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CodingContract:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CodingContract " + } + ], + "releaseTag": "Public", + "name": "CodingContract", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#attempt:member(1)", + "docComment": "/**\n * Attempts to solve the Coding Contract with the provided solution.\n *\n * @remarks\n *\n * 10 GB @paramanswer - Solution for the contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns True if the solution was correct, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "attempt(answer: " + }, + { + "kind": "Content", + "text": "string | string[] | number" + }, + { + "kind": "Content", + "text": ", fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "answer", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "attempt" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#attempt:member(2)", + "docComment": "/**\n * Attempts to solve the Coding Contract with the provided solution.\n *\n * @remarks\n *\n * 10 GB\n *\n * @param answer - Solution for the contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "attempt(answer: " + }, + { + "kind": "Content", + "text": "string | string[] | number" + }, + { + "kind": "Content", + "text": ", fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", opts?: " + }, + { + "kind": "Reference", + "text": "CodingAttemptOptions", + "canonicalReference": "bitburner!CodingAttemptOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean | string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "answer", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ], + "name": "attempt" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#getContractType:member(1)", + "docComment": "/**\n * Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)\n *\n * @remarks\n *\n * 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns Name describing the type of problem posed by the Coding Contract.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getContractType(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CodingContractTypes", + "canonicalReference": "bitburner!CodingContractTypes:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getContractType" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#getData:member(1)", + "docComment": "/**\n * Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve\n *\n * @remarks\n *\n * 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns The specified contract’s data;\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getData(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getData" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#getDescription:member(1)", + "docComment": "/**\n * Get the full text description for the problem posed by the Coding Contract.\n *\n * @remarks\n *\n * 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns Contract’s text description.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getDescription(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getDescription" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#getNumTriesRemaining:member(1)", + "docComment": "/**\n * Get the number of tries remaining on the contract before it self-destructs.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns How many attempts are remaining for the contract;\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getNumTriesRemaining(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getNumTriesRemaining" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!CodingContractTypes:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CodingContractTypes =\n " + }, + { + "kind": "Content", + "text": "| \"Find Largest Prime Factor\"\n | \"Subarray with Maximum Sum\"\n | \"Total Ways to Sum\"\n | \"Spiralize Matrix\"\n | \"Array Jumping Game\"\n | \"Merge Overlapping Intervals\"\n | \"Generate IP Addresses\"\n | \"Algorithmic Stock Trader I\"\n | \"Algorithmic Stock Trader II\"\n | \"Algorithmic Stock Trader III\"\n | \"Algorithmic Stock Trader IV\"\n | \"Minimum Path Sum in a Triangle\"\n | \"Unique Paths in a Grid I\"\n | \"Unique Paths in a Grid II\"\n | \"Sanitize Parentheses in Expression\"\n | \"Find All Valid Math Expressions\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CodingContractTypes", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!CompanyField:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CompanyField =\n " + }, + { + "kind": "Content", + "text": "| \"software\"\n | \"software consultant\"\n | \"it\"\n | \"security engineer\"\n | \"network engineer\"\n | \"business\"\n | \"business consultant\"\n | \"security\"\n | \"agent\"\n | \"employee\"\n | \"part-time employee\"\n | \"waiter\"\n | \"part-time waiter\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CompanyField", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!CompanyName:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CompanyName =\n // Sector-12\n " + }, + { + "kind": "Content", + "text": "| \"MegaCorp\"\n | \"BladeIndustries\"\n | \"FourSigma\"\n | \"IcarusMicrosystems\"\n | \"UniversalEnergy\"\n | \"DeltaOne\"\n | \"CIA\"\n | \"NSA\"\n | \"AlphaEnterprises\"\n | \"CarmichaelSecurity\"\n | \"FoodNStuff\"\n | \"JoesGuns\"\n\n // Aevum\n | \"ECorp\"\n | \"BachmanAndAssociates\"\n | \"ClarkeIncorporated\"\n | \"OmniTekIncorporated\"\n | \"FulcrumTechnologies\"\n | \"GalacticCybersystems\"\n | \"AeroCorp\"\n | \"WatchdogSecurity\"\n | \"RhoConstruction\"\n | \"AevumPolice\"\n | \"NetLinkTechnologies\"\n\n // Volhaven\n | \"NWO\"\n | \"HeliosLabs\"\n | \"OmniaCybersystems\"\n | \"LexoCorp\"\n | \"SysCoreSecurities\"\n | \"CompuTek\"\n\n // Chongqing\n | \"KuaiGongInternational\"\n | \"SolarisSpaceSystems\"\n\n // Ishima\n | \"StormTechnologies\"\n | \"NovaMedical\"\n | \"OmegaSoftware\"\n\n // New Tokyo\n | \"DefComm\"\n | \"VitaLife\"\n | \"GlobalPharmaceuticals\"\n | \"NoodleBar\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CompanyName", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!CreatableProgram:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CreatableProgram = " + }, + { + "kind": "Reference", + "text": "PurchaseableProgram", + "canonicalReference": "bitburner!PurchaseableProgram:type" + }, + { + "kind": "Content", + "text": " | \"serverprofiler.exe\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CreatableProgram", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Crime:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Crime =\n " + }, + { + "kind": "Content", + "text": "| \"shoplift\"\n | \"rob store\"\n | \"mug\"\n | \"larceny\"\n | \"deal drugs\"\n | \"bond forgery\"\n | \"traffick arms\"\n | \"homicide\"\n | \"grand theft auto\"\n | \"kidnap\"\n | \"assassinate\"\n | \"heist\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Crime", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CrimeStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CrimeStats " + } + ], + "releaseTag": "Public", + "name": "CrimeStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#agility_exp:member", + "docComment": "/**\n * agility exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#agility_success_weight:member", + "docComment": "/**\n * agility level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#charisma_exp:member", + "docComment": "/**\n * charisma exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#charisma_success_weight:member", + "docComment": "/**\n * charisma level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#defense_exp:member", + "docComment": "/**\n * defense exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#defense_success_weight:member", + "docComment": "/**\n * defense level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#dexterity_exp:member", + "docComment": "/**\n * dexterity exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#dexterity_success_weight:member", + "docComment": "/**\n * dexterity level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#difficulty:member", + "docComment": "/**\n * Number representing the difficulty of the crime. Used for success chance calculations\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "difficulty: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "difficulty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#hacking_exp:member", + "docComment": "/**\n * hacking exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#hacking_success_weight:member", + "docComment": "/**\n * hacking level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#intelligence_exp:member", + "docComment": "/**\n * intelligence exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "intelligence_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "intelligence_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#karma:member", + "docComment": "/**\n * Amount of karma lost for SUCCESSFULLY committing this crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "karma: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "karma", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#kills:member", + "docComment": "/**\n * How many people die as a result of this crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "kills: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "kills", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#money:member", + "docComment": "/**\n * How much money is given\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "money: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "money", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#name:member", + "docComment": "/**\n * Name of crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#strength_exp:member", + "docComment": "/**\n * strength exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#strength_success_weight:member", + "docComment": "/**\n * strength level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#time:member", + "docComment": "/**\n * Milliseconds it takes to attempt the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "time: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "time", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#type:member", + "docComment": "/**\n * Description of the crime activity\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!FactionName:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type FactionName =\n " + }, + { + "kind": "Content", + "text": "| \"Illuminati\"\n | \"Daedalus\"\n | \"The Covenant\"\n | \"ECorp\"\n | \"MegaCorp\"\n | \"Bachman & Associates\"\n | \"Blade Industries\"\n | \"NWO\"\n | \"Clarke Incorporated\"\n | \"OmniTek Incorporated\"\n | \"Four Sigma\"\n | \"KuaiGong International\"\n | \"Fulcrum Secret Technologies\"\n | \"BitRunners\"\n | \"The Black Hand\"\n | \"NiteSec\"\n | \"Aevum\"\n | \"Chongqing\"\n | \"Ishima\"\n | \"New Tokyo\"\n | \"Sector-12\"\n | \"Volhaven\"\n | \"Speakers for the Dead\"\n | \"The Dark Army\"\n | \"The Syndicate\"\n | \"Silhouette\"\n | \"Tetrads\"\n | \"Slum Snakes\"\n | \"Netburners\"\n | \"Tian Di Hui\"\n | \"CyberSec\"\n | \"Bladeburners\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FactionName", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!FactionWork:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type FactionWork = " + }, + { + "kind": "Content", + "text": "\"hacking\" | \"field\" | \"security\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FactionWork", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Gang:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Gang " + } + ], + "releaseTag": "Public", + "name": "Gang", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#ascendMember:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Ascend the specified Gang Member.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param memberName - Name of member to ascend.\n *\n * @returns Object with info about the ascension results.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ascendMember(memberName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangMemberAscension", + "canonicalReference": "bitburner!GangMemberAscension:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "memberName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "ascendMember" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#canRecruitMember:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns boolean indicating whether a member can currently be recruited\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns True if a member can currently be recruited, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "canRecruitMember(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "canRecruitMember" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getBonusTime:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.\n *\n * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.\n *\n * “Bonus time” makes the game progress faster, up to 10x the normal speed.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Bonus time for the Gang mechanic in seconds.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBonusTime(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getBonusTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getChanceToWinClash:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage\n *\n * @remarks\n *\n * 4 GB\n *\n * @param gangName - Target gang\n *\n * @returns Chance you have to win a clash with the specified gang.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getChanceToWinClash(gangName: " + }, + { + "kind": "Reference", + "text": "GangName", + "canonicalReference": "bitburner!GangName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "gangName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getChanceToWinClash" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getEquipmentCost:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getEquipmentCost(equipName: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "equipName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "name": "getEquipmentCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getEquipmentNames:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns Names of all Equpiment/Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getEquipmentNames(): " + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": ")[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getEquipmentNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getEquipmentStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the specified equipment stats.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns A dictionary containing the stats of the equipment.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getEquipmentStats(equipName: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangEquipmentStats", + "canonicalReference": "bitburner!GangEquipmentStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "equipName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "name": "getEquipmentStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getEquipmentType:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the specified equipment type.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns Type of the equipment.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getEquipmentType(equipName: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangEquipmentType", + "canonicalReference": "bitburner!GangEquipmentType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "equipName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "name": "getEquipmentType" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getGangInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get general information about the gang.\n *\n * @remarks\n *\n * 2 GB\n *\n * @returns Object containing general information about the gang.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGangInformation(): " + }, + { + "kind": "Reference", + "text": "GangGenInfo", + "canonicalReference": "bitburner!GangGenInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getGangInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getMemberInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get stat and equipment-related information about a Gang Member\n *\n * @remarks\n *\n * 2 GB\n *\n * @param name - Name of member.\n *\n * @returns Object containing stat and equipment-related information about a Gang Member.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getMemberInformation(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangMemberInfo", + "canonicalReference": "bitburner!GangMemberInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getMemberInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getMemberNames:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the names of all Gang members\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns Names of all Gang members.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getMemberNames(): " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getMemberNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getOtherGangInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get territory and power information about all gangs.\n *\n * @remarks\n *\n * 2 GB\n *\n * @returns Object containing territory and power information about all gangs.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOtherGangInformation(): " + }, + { + "kind": "Reference", + "text": "GangOtherInfo", + "canonicalReference": "bitburner!GangOtherInfo:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getOtherGangInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getTaskNames:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the name of all valid tasks that Gang members can be assigned to.\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns All valid tasks that Gang members can be assigned to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTaskNames(): " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getTaskNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getTaskStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param name - Name of the task.\n *\n * @returns Detailed stats of a task.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTaskStats(name: " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangTasksStats", + "canonicalReference": "bitburner!GangTasksStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getTaskStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#purchaseEquipment:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param memberName - Name of Gang member to purchase the equipment for.\n *\n * @param equipName - Name of Equipment/Augmentation to purchase.\n *\n * @returns True if the equipment was successfully purchased. False otherwise\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseEquipment(memberName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", equipName: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "memberName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "equipName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + } + } + ], + "name": "purchaseEquipment" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#recruitMember:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempt to recruit a new gang member.\n *\n * Possible reasons for failure: * Cannot currently recruit a new member * There already exists a member with the specified name\n *\n * @remarks\n *\n * 2 GB\n *\n * @param name - Name of member to recruit.\n *\n * @returns True if the member was successfully recruited, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "recruitMember(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "recruitMember" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#setMemberTask:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”).\n *\n * @remarks\n *\n * 2 GB\n *\n * @param memberName - Name of Gang member to assign.\n *\n * @param taskName - Task to assign.\n *\n * @returns True if the Gang Member was successfully assigned to the task, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setMemberTask(memberName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", taskName: " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "memberName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "taskName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "setMemberTask" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#setTerritoryWarfare:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Set whether or not the gang should engage in territory warfare\n *\n * @remarks\n *\n * 2 GB\n *\n * @param engage - Whether or not to engage in territory warfare.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTerritoryWarfare(engage: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "engage", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setTerritoryWarfare" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangAugmentations:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangAugmentations =\n " + }, + { + "kind": "Content", + "text": "| \"Bionic Arms\"\n | \"Bionic Legs\"\n | \"Bionic Spine\"\n | \"BrachiBlades\"\n | \"Nanofiber Weave\"\n | \"Synthetic Heart\"\n | \"Synfibril Muscle\"\n | \"BitWire\"\n | \"Neuralstimulator\"\n | \"DataJack\"\n | \"Graphene Bone Lacings\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangAugmentations", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangEquipment:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangEquipment =\n " + }, + { + "kind": "Content", + "text": "| \"Baseball Bat\"\n | \"Katana\"\n | \"Glock 18C\"\n | \"P90C\"\n | \"Steyr AUG\"\n | \"AK-47\"\n | \"M15A10 Assault Rifle\"\n | \"AWM Sniper Rifle\"\n | \"Bulletproof Vest\"\n | \"Full Body Armor\"\n | \"Liquid Body Armor\"\n | \"Graphene Plating Armor\"\n | \"Ford Flex V20\"\n | \"ATX1070 Superbike\"\n | \"Mercedes-Benz S9001\"\n | \"White Ferrari\"\n | \"NUKE Rootkit\"\n | \"Soulstealer Rootkit\"\n | \"Demon Rootkit\"\n | \"Hmap Node\"\n | \"Jack the Ripper\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangEquipment", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangEquipmentStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangEquipmentStats " + } + ], + "releaseTag": "Public", + "name": "GangEquipmentStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#agi:member", + "docComment": "/**\n * Agility multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agi: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agi", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#cha:member", + "docComment": "/**\n * Charisma multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cha: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cha", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#def:member", + "docComment": "/**\n * Defense multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "def: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "def", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#dex:member", + "docComment": "/**\n * Dexterity multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dex: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dex", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#hack:member", + "docComment": "/**\n * Hacking multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hack: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#str:member", + "docComment": "/**\n * Strength multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "str: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "str", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangEquipmentType:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangEquipmentType = " + }, + { + "kind": "Content", + "text": "\"Weapon\" | \"Armor\" | \"Vehicle\" | \"Rootkit\" | \"Augmentation\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangEquipmentType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangGenInfo:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangGenInfo " + } + ], + "releaseTag": "Public", + "name": "GangGenInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#faction:member", + "docComment": "/**\n * Name of faction that the gang belongs to (\"Slum Snakes\", etc.)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "faction: " + }, + { + "kind": "Reference", + "text": "GangName", + "canonicalReference": "bitburner!GangName:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "faction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#isHacking:member", + "docComment": "/**\n * Boolean indicating whether or not its a hacking gang\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isHacking: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isHacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#moneyGainRate:member", + "docComment": "/**\n * Money earned per second\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "moneyGainRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "moneyGainRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#power:member", + "docComment": "/**\n * Gang's power for territory warfare\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "power: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "power", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#respect:member", + "docComment": "/**\n * Gang's respect\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#respectGainRate:member", + "docComment": "/**\n * Respect earned per second\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respectGainRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respectGainRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#territory:member", + "docComment": "/**\n * Amount of territory held. Returned in decimal form, not percentage\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territory: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#territoryClashChance:member", + "docComment": "/**\n * Clash chance. Returned in decimal form, not percentage\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territoryClashChance: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territoryClashChance", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#wantedLevel:member", + "docComment": "/**\n * Gang's wanted level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wantedLevel: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "wantedLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#wantedLevelGainRate:member", + "docComment": "/**\n * Wanted level gained/lost per second (negative for losses)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wantedLevelGainRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "wantedLevelGainRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangMemberAscension:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangMemberAscension " + } + ], + "releaseTag": "Public", + "name": "GangMemberAscension", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#agi:member", + "docComment": "/**\n * Agility multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agi: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agi", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#cha:member", + "docComment": "/**\n * Charisma multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cha: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cha", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#def:member", + "docComment": "/**\n * Defense multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "def: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "def", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#dex:member", + "docComment": "/**\n * Dexterity multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dex: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dex", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#hack:member", + "docComment": "/**\n * Hacking multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hack: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#respect:member", + "docComment": "/**\n * Amount of respect lost from ascending\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#str:member", + "docComment": "/**\n * Strength multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "str: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "str", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangMemberInfo:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangMemberInfo " + } + ], + "releaseTag": "Public", + "name": "GangMemberInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#agility:member", + "docComment": "/**\n * Agility stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#agilityAscensionMult:member", + "docComment": "/**\n * Agility multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agilityAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agilityAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#agilityEquipMult:member", + "docComment": "/**\n * Agility multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agilityEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agilityEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#augmentations:member", + "docComment": "/**\n * Array of names of all owned Augmentations\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "augmentations: " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "augmentations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#charisma:member", + "docComment": "/**\n * Charisma stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#charismaAscensionMult:member", + "docComment": "/**\n * Charisma multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charismaAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charismaAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#charismaEquipMult:member", + "docComment": "/**\n * Charisma multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charismaEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charismaEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#defense:member", + "docComment": "/**\n * Defense stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#defenseAscensionMult:member", + "docComment": "/**\n * Defense multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defenseAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defenseAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#defenseEquipMult:member", + "docComment": "/**\n * Defense multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defenseEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defenseEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#dexterity:member", + "docComment": "/**\n * Dexterity stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#dexterityAscensionMult:member", + "docComment": "/**\n * Dexterity multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterityAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterityAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#dexterityEquipMult:member", + "docComment": "/**\n * Dexterity multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterityEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterityEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#equipment:member", + "docComment": "/**\n * Array of names of all owned Non-Augmentation Equipment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "equipment: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "equipment", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#hacking:member", + "docComment": "/**\n * Hacking stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#hackingAscensionMult:member", + "docComment": "/**\n * Hacking multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackingAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackingAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#hackingEquipMult:member", + "docComment": "/**\n * Hacking multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackingEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackingEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#strength:member", + "docComment": "/**\n * Strength stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#strengthAscensionMult:member", + "docComment": "/**\n * Strength multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strengthAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strengthAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#strengthEquipMult:member", + "docComment": "/**\n * Strength multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strengthEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strengthEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#task:member", + "docComment": "/**\n * Name of currently assigned task\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "task: " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "task", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangName:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangName =\n " + }, + { + "kind": "Content", + "text": "| \"Slum Snakes\"\n | \"Tetrads\"\n | \"The Syndicate\"\n | \"The Dark Army\"\n | \"Speakers for the Dead\"\n | \"NiteSec\"\n | \"The Black Hand\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangName", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangOtherInfo:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangOtherInfo = " + }, + { + "kind": "Content", + "text": "{\n /** Stock Symbol */\n [key in " + }, + { + "kind": "Reference", + "text": "GangName", + "canonicalReference": "bitburner!GangName:type" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Reference", + "text": "GangOtherInfoObject", + "canonicalReference": "bitburner!GangOtherInfoObject:interface" + }, + { + "kind": "Content", + "text": "[];\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangOtherInfo", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangOtherInfoObject:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangOtherInfoObject " + } + ], + "releaseTag": "Public", + "name": "GangOtherInfoObject", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangOtherInfoObject#power:member", + "docComment": "/**\n * Gang power\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "power: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "power", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangOtherInfoObject#territory:member", + "docComment": "/**\n * Gang territory, in decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territory: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangTasks:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangTasks =\n " + }, + { + "kind": "Content", + "text": "| \"Unassigned\"\n | \"Ransomware\"\n | \"Phishing\"\n | \"Identity Theft\"\n | \"DDoS Attacks\"\n | \"Plant Virus\"\n | \"Fraud & Counterfeiting\"\n | \"Money Laundering\"\n | \"Cyberterrorism\"\n | \"Ethical Hacking\"\n | \"Mug People\"\n | \"Deal Drugs\"\n | \"Strongarm Civilians\"\n | \"Run a Con\"\n | \"Armed Robbery\"\n | \"Traffick Illegal Arms\"\n | \"Threaten & Blackmail\"\n | \"Human Trafficking\"\n | \"Terrorism\"\n | \"Vigilante Justice\"\n | \"Train Combat\"\n | \"Train Hacking\"\n | \"Train Charisma\"\n | \"Territory Warfare\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangTasks", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangTasksStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangTasksStats " + } + ], + "releaseTag": "Public", + "name": "GangTasksStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#agiWeight:member", + "docComment": "/**\n * Agility skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agiWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agiWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#baseMoney:member", + "docComment": "/**\n * Base money earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#baseRespect:member", + "docComment": "/**\n * Base respect earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseRespect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseRespect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#baseWanted:member", + "docComment": "/**\n * Base wanted earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseWanted: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseWanted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#chaWeight:member", + "docComment": "/**\n * Charisma skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "chaWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "chaWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#defWeight:member", + "docComment": "/**\n * Defense skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#desc:member", + "docComment": "/**\n * Task Description\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "desc: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "desc", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#dexWeight:member", + "docComment": "/**\n * Dexterity skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#difficulty:member", + "docComment": "/**\n * Number representing the difficulty of the task\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "difficulty: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "difficulty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#hackWeight:member", + "docComment": "/**\n * Hacking skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#isCombat:member", + "docComment": "/**\n * Is a task of a combat gang\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isCombat: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isCombat", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#isHacking:member", + "docComment": "/**\n * Is a task of a hacking gang\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isHacking: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isHacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#name:member", + "docComment": "/**\n * Task name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#strWeight:member", + "docComment": "/**\n * Stength skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#territory:member", + "docComment": "/**\n * Territory impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territory: " + }, + { + "kind": "Reference", + "text": "GangTasksTerritory", + "canonicalReference": "bitburner!GangTasksTerritory:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangTasksTerritory:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangTasksTerritory " + } + ], + "releaseTag": "Public", + "name": "GangTasksTerritory", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksTerritory#money:member", + "docComment": "/**\n * Money gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "money: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "money", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksTerritory#respect:member", + "docComment": "/**\n * Respect gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksTerritory#wanted:member", + "docComment": "/**\n * Wanted gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wanted: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "wanted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Gym:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Gym = " + }, + { + "kind": "Content", + "text": "\"Crush Fitness Gym\" | \"Snap Fitness Gym\" | \"Iron Gym\" | \"Powerhouse Gym\" | \"Millenium Fitness Gym\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Gym", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GymStat:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GymStat = " + }, + { + "kind": "Content", + "text": "\"str\" | \"def\" | \"dex\" | \"agi\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GymStat", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!HackingMultipliers:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface HackingMultipliers " + } + ], + "releaseTag": "Public", + "name": "HackingMultipliers", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HackingMultipliers#chance:member", + "docComment": "/**\n * Player's hacking chance multiplier.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "chance: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "chance", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HackingMultipliers#growth:member", + "docComment": "/**\n * Player's hacking growth multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "growth: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "growth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HackingMultipliers#money:member", + "docComment": "/**\n * Player's hacking money stolen multiplier.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "money: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "money", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HackingMultipliers#speed:member", + "docComment": "/**\n * Player's hacking speed multiplier.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "speed: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "speed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!HackNet:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface HackNet " + } + ], + "releaseTag": "Public", + "name": "HackNet", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getCacheUpgradeCost:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the cost of upgrading the cache level of the specified Hacknet Server by n.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's cache.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCacheUpgradeCost(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getCacheUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getCoreUpgradeCost:member(1)", + "docComment": "/**\n * Returns the cost of upgrading the number of cores of the specified Hacknet Node by n.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's number of cores.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCoreUpgradeCost(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getCoreUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getLevelUpgradeCost:member(1)", + "docComment": "/**\n * Returns the cost of upgrading the specified Hacknet Node by n levels.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLevelUpgradeCost(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getLevelUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getNodeStats:member(1)", + "docComment": "/**\n * Returns an object containing a variety of stats about the specified Hacknet Node.\n *\n * Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node\n *\n * @returns Object containing a variety of stats about the specified Hacknet Node.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getNodeStats(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "NodeStats", + "canonicalReference": "bitburner!NodeStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getNodeStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getPurchaseNodeCost:member(1)", + "docComment": "/**\n * Returns the cost of purchasing a new Hacknet Node.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Cost of purchasing a new Hacknet Node.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchaseNodeCost(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPurchaseNodeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getRamUpgradeCost:member(1)", + "docComment": "/**\n * Returns the cost of upgrading the RAM of the specified Hacknet Node n times.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's ram.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getRamUpgradeCost(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getRamUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#hashCost:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param upgName - Name of the upgrade of Hacknet Node.\n *\n * @returns Number of hashes required for the specified upgrade.\n *\n * @example\n * ```js\n * var upgradeName = \"Sell for Corporation Funds\";\n * if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) {\n * hacknet.spendHashes(upgName);\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hashCost(upgName: " + }, + { + "kind": "Reference", + "text": "HashUpgrades", + "canonicalReference": "bitburner!HashUpgrades:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "upgName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hashCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#numHashes:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the number of hashes you have.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Number of hashes you have.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "numHashes(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "numHashes" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#numNodes:member(1)", + "docComment": "/**\n * Returns the number of Hacknet Nodes you own.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns number of hacknet nodes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "numNodes(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "numNodes" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#purchaseNode:member(1)", + "docComment": "/**\n * Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named \\`hacknet-node-4\\` will have an index of 4).\n *\n * If the player cannot afford to purchase a new Hacknet Node then the function will return -1.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseNode(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "purchaseNode" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#spendHashes:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.\n *\n * The name of the upgrade must be an exact match. The \\`upgTarget\\` argument is used for upgrades such as \\`Reduce Minimum Security\\`, which applies to a specific server. In this case, the \\`upgTarget\\` argument must be the hostname of the server.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param upgName - Name of the upgrade of Hacknet Node.\n *\n * @param upgTarget - Object to which upgrade applies. Required for certain upgrades.\n *\n * @returns True if the upgrade is successfully purchased, and false otherwise..\n *\n * @example\n * ```js\n * hacknet.spendHashes(\"Sell for Corporation Funds\");\n * hacknet.spendHashes(\"Increase Maximum Money\", \"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "spendHashes(upgName: " + }, + { + "kind": "Reference", + "text": "HashUpgrades", + "canonicalReference": "bitburner!HashUpgrades:type" + }, + { + "kind": "Content", + "text": ", upgTarget?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "upgName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "upgTarget", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "spendHashes" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#upgradeCache:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Tries to upgrade the specified Hacknet Server’s cache n times.\n *\n * Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeCache(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "upgradeCache" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#upgradeCore:member(1)", + "docComment": "/**\n * Tries to purchase n cores for the specified Hacknet Node.\n *\n * Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeCore(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "upgradeCore" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#upgradeLevel:member(1)", + "docComment": "/**\n * Tries to upgrade the level of the specified Hacknet Node by n.\n *\n * Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeLevel(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "upgradeLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#upgradeRam:member(1)", + "docComment": "/**\n * Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n.\n *\n * Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeRam(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "upgradeRam" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!HacknetMultipliers:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface HacknetMultipliers " + } + ], + "releaseTag": "Public", + "name": "HacknetMultipliers", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#coreCost:member", + "docComment": "/**\n * Player's hacknet core cost multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "coreCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "coreCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#levelCost:member", + "docComment": "/**\n * Player's hacknet level cost multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "levelCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "levelCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#production:member", + "docComment": "/**\n * Player's hacknet production multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "production: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "production", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#purchaseCost:member", + "docComment": "/**\n * Player's hacknet purchase cost multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "purchaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#ramCost:member", + "docComment": "/**\n * Player's hacknet ram cost multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ramCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ramCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Handle:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Handle = " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "Port", + "canonicalReference": "bitburner!Port:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Handle", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!HashUpgrades:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type HashUpgrades =\n " + }, + { + "kind": "Content", + "text": "| \"Sell for Money\"\n | \"Sell for Corporation Funds\"\n | \"Reduce Minimum Security\"\n | \"Increase Maximum Money\"\n | \"Improve Studying\"\n | \"Improve Gym Training\"\n | \"Exchange for Corporation Research\"\n | \"Exchange for Bladeburner Rank\"\n | \"Exchange for Bladeburner SP\"\n | \"Generate Coding Contract\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "HashUpgrades", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Host:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Host = " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Host", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!NodeStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface NodeStats " + } + ], + "releaseTag": "Public", + "name": "NodeStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#cache:member", + "docComment": "/**\n * Cache level. Only applicable for Hacknet Servers\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cache: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cache", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#cores:member", + "docComment": "/**\n * Node's number of cores\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cores: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cores", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#hashCapacity:member", + "docComment": "/**\n * Hash Capacity provided by this Node. Only applicable for Hacknet Servers\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hashCapacity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hashCapacity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#level:member", + "docComment": "/**\n * Node's level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "level: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "level", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#name:member", + "docComment": "/**\n * Node's name (\"hacknet-node-5\")\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#production:member", + "docComment": "/**\n * Node's production per second\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "production: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "production", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#ram:member", + "docComment": "/**\n * Node's RAM\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ram: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ram", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#timeOnline:member", + "docComment": "/**\n * Number of seconds since Node has been purchased\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeOnline: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "timeOnline", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#totalProduction:member", + "docComment": "/**\n * Total number of money Node has produced\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "totalProduction: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "totalProduction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!NS:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface NS extends " + }, + { + "kind": "Reference", + "text": "Singularity", + "canonicalReference": "bitburner!Singularity:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "NS", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#args:member", + "docComment": "/**\n * Arguments passed into a script can be accessed using a normal array using the [] operator (args[0], args[1], etc…).\n *\n * It is also possible to get the number of arguments that was passed into a script using:\n * ```js\n * args.length\n * ```\n *\n * WARNING: Do not try to modify the args array. This will break the game.\n *\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "args", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#bladeburner:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly bladeburner: " + }, + { + "kind": "Reference", + "text": "Bladeburner", + "canonicalReference": "bitburner!Bladeburner:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "bladeburner", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#brutessh:member(1)", + "docComment": "/**\n * Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * brutessh(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "brutessh(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "brutessh" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#clear:member(1)", + "docComment": "/**\n * This function is used to clear data in a Netscript Ports or a text file.\n *\n * If the port/fn argument is a number between 1 and 20, then it specifies a port and will clear it (deleting all data from the underlying queue).\n *\n * If the port/fn argument is a string, then it specifies the name of a text file (.txt) and will delete all data from that text file.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param handle - Port or text file to clear.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clear(handle: " + }, + { + "kind": "Reference", + "text": "Handle", + "canonicalReference": "bitburner!Handle:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handle", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "clear" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#clearLog:member(1)", + "docComment": "/**\n * Clears the script’s logs.\n *\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearLog(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "clearLog" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#codingcontract:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly codingcontract: " + }, + { + "kind": "Reference", + "text": "CodingContract", + "canonicalReference": "bitburner!CodingContract:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "codingcontract", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#deleteServer:member(1)", + "docComment": "/**\n * Deletes one of your purchased servers, which is specified by its hostname.\n *\n * The hostname argument can be any data type, but it will be converted to a string. Whitespace is automatically removed from the string. This function will not delete a server that still has scripts running on it.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * @param host - Host of the server to delete.\n *\n * @returns True if successful, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deleteServer(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "deleteServer" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#disableLog:member(1)", + "docComment": "/**\n * Disables logging for the given function. Logging can be disabled for all functions by passing \\`ALL\\` as the argument.\n *\n * Note that this does not completely remove all logging functionality. This only stops a function from logging when the function is successful. If the function fails, it will still log the reason for failure.\n *\n * Notable functions that cannot have their logs disabled: run, exec, exit.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Name of function for which to disable logging.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disableLog(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "disableLog" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#enableLog:member(1)", + "docComment": "/**\n * Re-enables logging for the given function. If \\`ALL\\` is passed into this function as an argument, then it will revert the effects of disableLog(\\`ALL\\`).\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Name of function for which to enable logging.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "enableLog(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "enableLog" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#exec:member(1)", + "docComment": "/**\n * 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.\n *\n * If the script was successfully started, then this functions returns the PID of that script. Otherwise, it returns 0.\n *\n * PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer.\n *\n * Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error.\n *\n * @remarks\n *\n * 1.3 GB\n *\n * @param script - Filename of script to execute.\n *\n * @param host - Hostname or IP of the \\`target server\\` on which to execute the script.\n *\n * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer.\n *\n * @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.\n *\n * @returns Returns the PID of a successfully started script, and 0 otherwise.\n *\n * @example\n * ```js\n * //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:\n * exec(\"generic-hack.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads:\n * exec(\"generic-hack.script\", \"joesguns\", 10);\n * ```\n *\n * @example\n * ```js\n * //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:\n * exec(\"foo.script\", \"foodnstuff\", 5, 1, \"test\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "exec(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", numThreads?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "numThreads", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ], + "name": "exec" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#exit:member(1)", + "docComment": "/**\n * Terminates the current script immediately.\n *\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "exit(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "exit" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#fileExists:member(1)", + "docComment": "/**\n * Returns a boolean indicating whether the specified file exists on the target server. The filename for scripts is case-sensitive, but for other types of files it is not. For example, fileExists(“brutessh.exe”) will work fine, even though the actual program is named 'BruteSSH.exe'.\n *\n * If the hostname/ip argument is omitted, then the function will search through the current server (the server running the script that calls this function) for the file.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param filename - Filename of file to check.\n *\n * @param host - Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server.\n *\n * @returns True if specified file exists, and false otherwise.\n *\n * @example\n * ```js\n * //The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise.\n * fileExists(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise.\n * fileExists(\"ftpcrack.exe\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "fileExists(filename: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "filename", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "fileExists" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#ftpcrack:member(1)", + "docComment": "/**\n * Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * ftpcrack(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ftpcrack(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "ftpcrack" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#gang:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly gang: " + }, + { + "kind": "Reference", + "text": "Gang", + "canonicalReference": "bitburner!Gang:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "gang", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getBitNodeMultipliers:member(1)", + "docComment": "/**\n * Returns an object containing the current BitNode multipliers. This function requires Source-File 5 in order to run. The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). The multipliers represent the difference between the current BitNode and the original BitNode (BitNode-1).\n *\n * For example, if the CrimeMoney multiplier has a value of 0.1, then that means that committing crimes in the current BitNode will only give 10% of the money you would have received in BitNode-1.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Object containing the current BitNode multipliers.\n *\n * @example\n * ```js\n * mults = getBitNodeMultipliers();\n * print(mults.ServerMaxMoney);\n * print(mults.HackExpGain);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBitNodeMultipliers(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", target: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "BitNodeMultipliers", + "canonicalReference": "bitburner!BitNodeMultipliers:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getBitNodeMultipliers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getFavorToDonate:member(1)", + "docComment": "/**\n * Returns the amount of Faction favor required to be able to donate to a faction.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @returns Amount of Faction favor required to be able to donate to a faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getFavorToDonate(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getFavorToDonate" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getGrowTime:member(1)", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the grow Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGrowTime(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hackLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", intLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hackLvl", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "intLvl", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getGrowTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHackingLevel:member(1)", + "docComment": "/**\n * Returns the player’s current hacking level.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Player’s current hacking level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHackingLevel(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getHackingLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHackingMultipliers:member(1)", + "docComment": "/**\n * Returns an object containing the Player’s hacking related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%).\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Object containing the Player’s hacking related multipliers.\n *\n * @example\n * ```js\n * //Example of how this can be used:\n * mults = getHackingMultipliers();\n * print(mults.chance);\n * print(mults.growth);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHackingMultipliers(): " + }, + { + "kind": "Reference", + "text": "HackingMultipliers", + "canonicalReference": "bitburner!HackingMultipliers:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getHackingMultipliers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHacknetMultipliers:member(1)", + "docComment": "/**\n * Returns an object containing the Player’s hacknet related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%).\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Object containing the Player’s hacknet related multipliers.\n *\n * @example\n * ```js\n * //Example of how this can be used:\n * mults = getHacknetMultipliers();\n * print(mults.production);\n * print(mults.purchaseCost);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHacknetMultipliers(): " + }, + { + "kind": "Reference", + "text": "HacknetMultipliers", + "canonicalReference": "bitburner!HacknetMultipliers:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getHacknetMultipliers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHackTime:member(1)", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the hack Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHackTime(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hackLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", intLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hackLvl", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "intLvl", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getHackTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHostname:member(1)", + "docComment": "/**\n * Returns a string with the hostname of the server that the script is running on.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Hostname of the server that the script is on.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHostname(): " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getHostname" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPortHandle:member(1)", + "docComment": "/**\n * Get a handle to a Netscript Port.\n *\n * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0.\n *\n * @remarks\n *\n * 10 GB\n *\n * @param port - Port number. Must be an integer between 1 and 20.\n *\n * @returns Data in the specified port.\n *\n * @see\n *\n * https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPortHandle(port: " + }, + { + "kind": "Reference", + "text": "Port", + "canonicalReference": "bitburner!Port:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "port", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPortHandle" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPurchasedServerCost:member(1)", + "docComment": "/**\n * Returns the cost to purchase a server with the specified amount of ram.\n *\n * @remarks\n *\n * 0.25 GB\n *\n * @param ram - Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).\n *\n * @returns The cost to purchase a server with the specified amount of ram.\n *\n * @example\n * ```js\n * for (i = 1; i <= 20; i++) {\n * tprint(i + \" -- \" + getPurchasedServerCost(Math.pow(2, i)));\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchasedServerCost(ram: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "ram", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPurchasedServerCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPurchasedServerLimit:member(1)", + "docComment": "/**\n * Returns the maximum number of servers you can purchase.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Returns the maximum number of servers you can purchase.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchasedServerLimit(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPurchasedServerLimit" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPurchasedServerMaxRam:member(1)", + "docComment": "/**\n * Returns the maximum RAM that a purchased server can have.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Returns the maximum RAM that a purchased server can have.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchasedServerMaxRam(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPurchasedServerMaxRam" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPurchasedServers:member(1)", + "docComment": "/**\n * Returns an array with either the hostnames or IPs of all of the servers you have purchased.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * @param hostnameMode - ] Optional. Defaults to true. Returns hostnames if true, and IPs if false.\n *\n * @returns Returns an array with either the hostnames or IPs of all of the servers you have purchased.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchasedServers(hostnameMode?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "hostnameMode", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPurchasedServers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptExpGain:member(1)", + "docComment": "/**\n * Returns the amount of hacking experience the specified script generates while online (when the game is open, does not apply for offline experience gains). Remember that a script is uniquely identified by both its name and its arguments.\n *\n * This function can also return the total experience gain rate of all of your active scripts by running the function with no arguments.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param script - Filename of script.\n *\n * @param host - Server on which script is running.\n *\n * @param args - Arguments that the script is running with.\n *\n * @returns Amount of hacking experience the specified script generates while online.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptExpGain(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getScriptExpGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptIncome:member(1)", + "docComment": "/**\n * Returns the amount of income the specified script generates while online (when the game is open, does not apply for offline income). Remember that a script is uniquely identified by both its name and its arguments. So for example if you ran a script with the arguments “foodnstuff” and “5” then in order to use this function to get that script’s income you must specify those same arguments in the same order in this function call.\n *\n * This function can also be called with no arguments. If called with no arguments, then this function will return an array of two values. The first value is the total income ($ / second) of all of your active scripts (scripts that are currently running on any server). The second value is the total income ($ / second) that you’ve earned from scripts since you last installed Augmentations.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param script - Filename of script.\n *\n * @param host - Server on which script is running.\n *\n * @param args - Arguments that the script is running with.\n *\n * @returns Amount of income the specified script generates while online.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptIncome(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number | [number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getScriptIncome" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptLogs:member(1)", + "docComment": "/**\n * Returns a script’s logs. The logs are returned as an array, where each line is an element in the array. The most recently logged line is at the end of the array. Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the game’s options. If the function is called with no arguments, it will return the current script’s logs.\n *\n * Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Optional. Filename of script to get logs from.\n *\n * @param host - Optional. Hostname or IP of the server that the script is on.\n *\n * @param args - Arguments to identify which scripts to get logs for.\n *\n * @returns Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array.\n *\n * @example\n * ```js\n * //Get logs from foo.script on the current server that was run with no args\n * getScriptLogs(\"foo.script\");\n * ```\n *\n * @example\n * ```js\n * //Open logs from foo.script on the foodnstuff server that was run with no args\n * getScriptLogs(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //Open logs from foo.script on the foodnstuff server that was run with the arguments [1, \"test\"]\n * getScriptLogs(\"foo.script\", \"foodnstuff\", 1, \"test\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptLogs(fn?: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getScriptLogs" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptName:member(1)", + "docComment": "/**\n * Returns the current script name.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Current script name.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptName(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getScriptName" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptRam:member(1)", + "docComment": "/**\n * Returns the amount of RAM required to run the specified script on the target server. Returns 0 if the script does not exist.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param script - Filename of script. This is case-sensitive.\n *\n * @param host - Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server.\n *\n * @returns Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptRam(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getScriptRam" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServer:member(1)", + "docComment": "/**\n * Returns a server object for the given server. Defaults to the running script's server if host is not specified.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param host - Optional. Hostname or IP for the requested server object.\n *\n * @returns The requested server object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServer(host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Server", + "canonicalReference": "bitburner!Server:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServer" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerBaseSecurityLevel:member(1)", + "docComment": "/**\n * Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s).\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Base security level of the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerBaseSecurityLevel(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerBaseSecurityLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerGrowth:member(1)", + "docComment": "/**\n * Returns the server’s instrinsic “growth parameter”. This growth parameter is a number between 1 and 100 that represents how quickly the server’s money grows. This parameter affects the percentage by which the server’s money is increased when using the grow function. A higher growth parameter will result in a higher percentage increase from grow.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Parameter that affects the percentage by which the server’s money is increased when using the grow function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerGrowth(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerGrowth" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerMaxMoney:member(1)", + "docComment": "/**\n * Returns the maximum amount of money that can be available on a server.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Maximum amount of money available on the server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerMaxMoney(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerMaxMoney" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerMinSecurityLevel:member(1)", + "docComment": "/**\n * Returns the minimum security level of the target server.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Minimum security level of the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerMinSecurityLevel(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerMinSecurityLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerMoneyAvailable:member(1)", + "docComment": "/**\n * Returns the amount of money available on a server. Running this function on the home computer will return the player’s money.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server\n *\n * @returns Amount of money available on the server.\n *\n * @example\n * ```js\n * getServerMoneyAvailable(\"foodnstuff\");\n * getServerMoneyAvailable(\"home\"); //Returns player's money\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerMoneyAvailable(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerMoneyAvailable" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerNumPortsRequired:member(1)", + "docComment": "/**\n * Returns the number of open ports required to successfully run NUKE.exe on the specified server.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns The number of open ports required to successfully run NUKE.exe on the specified server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerNumPortsRequired(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerNumPortsRequired" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerRam:member(1)", + "docComment": "/**\n * Returns an array with two elements that gives information about a server’s memory (RAM). The first element in the array is the amount of RAM that the server has total (in GB). The second element in the array is the amount of RAM that is currently being used on the server (in GB).\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Array with total and used memory on the specified server.\n *\n * @example\n * ```js\n * res = getServerRam(\"helios\");\n * totalRam = res[0];\n * ramUsed = res[1];\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerRam(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "[number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerRam" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerRequiredHackingLevel:member(1)", + "docComment": "/**\n * Returns the required hacking level of the target server.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns The required hacking level of the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerRequiredHackingLevel(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerRequiredHackingLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerSecurityLevel:member(1)", + "docComment": "/**\n * Returns the security level of the target server. A server’s security level is denoted by a number, typically between 1 and 100 (but it can go above 100).\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Security level of the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerSecurityLevel(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerSecurityLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getTimeSinceLastAug:member(1)", + "docComment": "/**\n * Returns the amount of time in milliseconds that have passed since you last installed Augmentations.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Time in milliseconds that have passed since you last installed Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTimeSinceLastAug(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getTimeSinceLastAug" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getWeakenTime:member(1)", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getWeakenTime(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hackLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", intLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hackLvl", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "intLvl", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getWeakenTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#grow:member(1)", + "docComment": "/**\n * Use your hacking skills to increase the amount of money available on a server. The runtime for this command depends on your hacking level and the target server’s security level. When \\`grow\\` completes, the money available on a target server will be increased by a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate.\n *\n * Like hack, \\`grow\\` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004.\n *\n * @remarks\n *\n * 0.15 GB\n *\n * @param host - Hostname or IP of the target server to grow.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The number by which the money on the server was multiplied for the growth.\n *\n * @example\n * ```js\n * grow(\"foodnstuff\");\n * grow(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to grow\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "grow(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", opts?: " + }, + { + "kind": "Reference", + "text": "BasicHGWOptions", + "canonicalReference": "bitburner!BasicHGWOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "grow" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#growthAnalyze:member(1)", + "docComment": "/**\n * This function returns the number of “growths” needed in order to increase the amount of money available on the specified server by the specified amount. The specified amount is multiplicative and is in decimal form, not percentage.\n *\n * Warning: The value returned by this function isn’t necessarily a whole number.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @param growthAmount - Multiplicative factor by which the server is grown. Decimal form..\n *\n * @returns The amount of grow calls needed to grow the specified server by the specified amount\n *\n * @example\n * ```js\n * //For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use:\n * growthAnalyze(\"foodnstuff\", 2);\n * //If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads).\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "growthAnalyze(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", growthAmount: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "growthAmount", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "growthAnalyze" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#growthAnalyzeSecurity:member(1)", + "docComment": "/**\n * Returns the security increase that would occur if a grow with this many threads happened.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param threads - Amount of threads that will be used.\n *\n * @returns The security increase.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "growthAnalyzeSecurity(threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "threads", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "growthAnalyzeSecurity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hack:member(1)", + "docComment": "/**\n * Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target server’s security level. In order to hack a server you must first gain root access to that server and also have the required hacking level.\n *\n * A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the \\`foodnstuff\\` server and run that script on any server in the game.\n *\n * A successful \\`hack()\\` on a server will raise that server’s security level by 0.002.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Hostname or IP of the target server to hack.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The amount of money stolen if the hack is successful, and zero otherwise.\n *\n * @example\n * ```js\n * hack(\"foodnstuff\");\n * hack(\"10.1.2.3\");\n * hack(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to hack\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hack(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", opts?: " + }, + { + "kind": "Reference", + "text": "BasicHGWOptions", + "canonicalReference": "bitburner!BasicHGWOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "hack" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hackAnalyzePercent:member(1)", + "docComment": "/**\n * Returns the percentage of the specified server’s money you will steal with a single hack. This value is returned in percentage form, not decimal (Netscript functions typically return in decimal form, but not this one).\n *\n * @remarks\n *\n * 1 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @returns The percentage of money you will steal from the target server with a single hack.\n *\n * @example\n * ```js\n * //For example, assume the following returns 1:\n * hackAnalyzePercent(\"foodnstuff\");\n * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N% of its total money.\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackAnalyzePercent(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hackAnalyzePercent" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hackAnalyzeSecurity:member(1)", + "docComment": "/**\n * Returns the security increase that would occur if a hack with this many threads happened.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param threads - Amount of threads that will be used.\n *\n * @returns The security increase.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackAnalyzeSecurity(threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "threads", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hackAnalyzeSecurity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hackAnalyzeThreads:member(1)", + "docComment": "/**\n * This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1.\n *\n * Warning: The value returned by this function isn’t necessarily a whole number.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param host - Hostname or IP of the target server to analyze.\n *\n * @param hackAmount - Amount of money you want to hack from the server.\n *\n * @returns The number of threads needed to hack the server for hackAmount money.\n *\n * @example\n * ```js\n * //For example, let’s say the foodnstuff server has $10m and you run:\n * hackAnalyzeThreads(\"foodnstuff\", 1e6);\n * //If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server.\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackAnalyzeThreads(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hackAmount: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hackAmount", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "hackAnalyzeThreads" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hackChance:member(1)", + "docComment": "/**\n * Returns the chance you have of successfully hacking the specified server.\n *\n * This returned value is in decimal form, not percentage.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @returns The chance you have of successfully hacking the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackChance(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hackChance" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#hacknet:member", + "docComment": "/**\n * Not all functions in the Hacknet Node API are immediately available.\n *\n * Note that none of these functions will write to the script’s logs.\n *\n * If you want to see what your script is doing you will have to print to the logs yourself.\n *\n * @remarks\n *\n * 4 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly hacknet: " + }, + { + "kind": "Reference", + "text": "HackNet", + "canonicalReference": "bitburner!HackNet:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacknet", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hasRootAccess:member(1)", + "docComment": "/**\n * Returns a boolean indicating whether or not the player has root access to the specified target server.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Host or IP of the target server\n *\n * @returns True if player has root access to the specified target server, and false otherwise.\n *\n * @example\n * ```js\n * if (hasRootAccess(\"foodnstuff\") == false) {\n * nuke(\"foodnstuff\");\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasRootAccess(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hasRootAccess" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#httpworm:member(1)", + "docComment": "/**\n * Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * httpworm(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "httpworm(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "httpworm" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#isLogEnabled:member(1)", + "docComment": "/**\n * Checks the status of the logging for the given function.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Name of function to check.\n *\n * @returns Returns a boolean indicating whether or not logging is enabled for that function (or \\`ALL\\`)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isLogEnabled(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "isLogEnabled" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#isRunning:member(1)", + "docComment": "/**\n * Returns a boolean indicating whether the specified script is running on the target server. Remember that a script is uniquely identified by both its name and its arguments.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param script - Filename of script to check. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @param args - Arguments to specify/identify which scripts to search for.\n *\n * @returns True if specified script is running on the target server, and false otherwise.\n *\n * @example\n * ```js\n * //The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise:\n * isRunning(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise:\n * isRunning(\"foo.script\", getHostname());\n * ```\n *\n * @example\n * ```js\n * //The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise:\n * isRunning(\"foo.script\", \"joesguns\", 1, 5, \"test\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isRunning(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "isRunning" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#kill:member(1)", + "docComment": "/**\n * Kills the script on the target server specified by the script’s name and arguments. Remember that scripts are uniquely identified by both their name and arguments. For example, if \\`foo.script\\` is run with the argument 1, then this is not the same as \\`foo.script\\` run with the argument 2, even though they have the same code.\n *\n * @remarks\n *\n * 0.5 GB\n *\n * @param script - Filename of the script to kill\n *\n * @param host - Hostname or IP of the server on which to kill the script.\n *\n * @param args - Arguments to identify which script to kill.\n *\n * @returns True if the script is successfully killed, and false otherwise.\n *\n * @example\n * ```js\n * //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments:\n * kill(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The following will try to kill a script named foo.script on the current server that was ran with no arguments:\n * kill(\"foo.script\", getHostname());\n * ```\n *\n * @example\n * ```js\n * //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”:\n * kill(\"foo.script\", getHostname(), 1, \"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "kill(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "kill" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#kill:member(2)", + "docComment": "/**\n * Kills the script with the specified PID. Killing a script by its PID will typically have better performance, especially if you have many scripts running. If this function successfully kills the specified script, then it will return true. Otherwise, it will return false.\n *\n * @remarks\n *\n * 0.5 GB\n *\n * @param scriptPid - PID of the script to kill\n *\n * @returns True if the script is successfully killed, and false otherwise.\n *\n * @example\n * ```js\n * if (kill(10)) {\n * print(\"Killed script with PID 10!\");\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "kill(scriptPid: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "scriptPid", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "kill" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#killall:member(1)", + "docComment": "/**\n * Kills all running scripts on the specified server. This function returns true if any scripts were killed, and false otherwise. In other words, it will return true if there are any scripts running on the target server.\n *\n * @remarks\n *\n * 0.5 GB\n *\n * @param host - IP or hostname of the server on which to kill all scripts.\n *\n * @returns True if any scripts were killed, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "killall(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "killall" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#ls:member(1)", + "docComment": "/**\n * Returns an array with the filenames of all files on the specified server (as strings). The returned array is sorted in alphabetic order.\n *\n * @remarks\n *\n * 0.2 GB\n *\n * @param host - Host or IP of the target server.\n *\n * @param grep - A substring to search for in the filename.\n *\n * @returns Array with the filenames of all files on the specified server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ls(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", grep?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "grep", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "ls" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#nFormat:member(1)", + "docComment": "/**\n * 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.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param n - Number to format.\n *\n * @param format - Formatter.\n *\n * @returns Formated number.\n *\n * @see\n *\n * http://numeraljs.com/\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "nFormat(n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", format: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "format", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "nFormat" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#nuke:member(1)", + "docComment": "/**\n * Runs the NUKE.exe program on the target server. NUKE.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * nuke(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "nuke(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "nuke" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#peek:member(1)", + "docComment": "/**\n * This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param port - Port to peek. Must be an integer between 1 and 20.\n *\n * @returns Data in the specified port.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "peek(port: " + }, + { + "kind": "Reference", + "text": "Port", + "canonicalReference": "bitburner!Port:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string | number | object" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "port", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "peek" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#print:member(1)", + "docComment": "/**\n * Prints a value or a variable to the script’s logs.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param msg - Value to be printed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "print(msg: " + }, + { + "kind": "Content", + "text": "string | number | string[] | number[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "msg", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "print" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#prompt:member(1)", + "docComment": "/**\n * Prompts the player with a dialog box with two options: “Yes” and “No”. This function will return true if the player click “Yes” and false if the player clicks “No”. The script’s execution is halted until the player selects one of the options.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param txt - Text to appear in the prompt dialog box.\n *\n * @returns True if the player click “Yes” and false if the player clicks “No”.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "prompt(txt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "txt", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "prompt" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#ps:member(1)", + "docComment": "/**\n * Returns an array with general information about all scripts running on the specified target server.\n *\n * @remarks\n *\n * 0.2 GB\n *\n * @param host - Host or IP address of the target server. If not specified, it will be the current server’s IP by default.\n *\n * @returns Array with general information about all scripts running on the specified target server.\n *\n * @example\n * ```js\n * //(using NetscriptJS (Netscript 2.0))\n * export async function main(ns) {\n * const ps = ns.ps(\"home\");\n * for (let i = 0; i < ps.length; ++i) {\n * ns.tprint(ps[i].filename + ' ' + ps[i].threads);\n * ns.tprint(ps[i].args);\n * }\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ps(host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ProcessInfo", + "canonicalReference": "bitburner!ProcessInfo:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "ps" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#purchaseServer:member(1)", + "docComment": "/**\n * Purchased a server with the specified hostname and amount of RAM.\n *\n * The hostname argument can be any data type, but it will be converted to a string and have whitespace removed. Anything that resolves to an empty string will cause the function to fail. If there is already a server with the specified hostname, then the function will automatically append a number at the end of the hostname argument value until it finds a unique hostname. For example, if the script calls \\`purchaseServer(“foo”, 4)\\` but a server named “foo” already exists, the it will automatically change the hostname to \\`foo-0\\`. If there is already a server with the hostname \\`foo-0\\`, then it will change the hostname to \\`foo-1\\`, and so on.\n *\n * Note that there is a maximum limit to the amount of servers you can purchase.\n *\n * Returns the hostname of the newly purchased server as a string. If the function fails to purchase a server, then it will return an empty string. The function will fail if the arguments passed in are invalid, if the player does not have enough money to purchase the specified server, or if the player has exceeded the maximum amount of servers.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * @param hostname - Host of the purchased server.\n *\n * @param ram - Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).\n *\n * @returns The hostname of the newly purchased server.\n *\n * @example\n * ```js\n * ram = 64;\n * hn = \"pserv-\";\n * for (i = 0; i < 5; ++i) {\n * purchaseServer(hn + i, ram);\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseServer(hostname: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ram: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "hostname", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "ram", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "purchaseServer" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#read:member(1)", + "docComment": "/**\n * This function is used to read data from a port or from a text file (.txt).\n *\n * If the argument port/fn is a number between 1 and 20, then it specifies a port and it will read data from that port. A port is a serialized queue. This function will remove the first element from that queue and return it. If the queue is empty, then the string “NULL PORT DATA” will be returned.\n *\n * If the argument port/fn is a string, then it specifies the name of a text file (.txt) and this function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param handle - Port or text file to read from.\n *\n * @returns Data in the specified text file or port.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "read(handle: " + }, + { + "kind": "Reference", + "text": "Handle", + "canonicalReference": "bitburner!Handle:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string | number | object" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handle", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "read" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#relaysmtp:member(1)", + "docComment": "/**\n * Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * relaysmtp(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "relaysmtp(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "relaysmtp" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#rm:member(1)", + "docComment": "/**\n * Removes the specified file from the current server. This function works for every file type except message (.msg) files.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param name - Filename of file to remove. Must include the extension.\n *\n * @param host - Host or IP Address of the server on which to delete the file. Optional. Defaults to current server.\n *\n * @returns True if it successfully deletes the file, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rm(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "rm" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#run:member(1)", + "docComment": "/**\n * Run a script as a separate process. This function can only be used to run scripts located on the current server (the server running the script that calls this function). Requires a significant amount of RAM to run this command.\n *\n * If the script was successfully started, then this functions returns the PID of that script. Otherwise, it returns 0.\n *\n * PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer.\n *\n * Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param script - Filename of script to run.\n *\n * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer.\n *\n * @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value.\n *\n * @returns Returns the PID of a successfully started script, and 0 otherwise.\n *\n * @example\n * ```js\n * //The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.script’ single-threaded with no arguments:\n * run(\"foo.script\");\n * ```\n *\n * @example\n * ```js\n * //The following example will run ‘foo.script’ but with 5 threads instead of single-threaded:\n * run(\"foo.script\", 5);\n * ```\n *\n * @example\n * ```js\n * //This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument:\n * run(\"foo.script\", 1, 'foodnstuff');\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "run(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", numThreads?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "numThreads", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "run" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scan:member(1)", + "docComment": "/**\n * Returns an array containing the hostnames or IPs of all servers that are one node way from the specified target server. The hostnames/IPs in the returned array are strings.\n *\n * @remarks\n *\n * 0.2 GB\n *\n * @param host - Hostname or IP of the server to scan.\n *\n * @param hostnames - Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false).\n *\n * @returns Returns an string of hostnames or IP.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scan(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hostnames?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hostnames", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "scan" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scp:member(1)", + "docComment": "/**\n * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.\n *\n * @remarks\n *\n * 0.6 GB\n *\n * @param files - Filename or an array of filenames of script/literature files to copy.\n *\n * @param destination - Host or IP of the destination server, which is the server to which the file will be copied.\n *\n * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.\n *\n * @example\n * ```js\n * //Copies hack-template.script from the current server to foodnstuff:\n * scp(\"hack-template.script\", \"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scp(files: " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", destination: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "files", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "parameterName": "destination", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "scp" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scp:member(2)", + "docComment": "/**\n * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.\n *\n * @remarks\n *\n * 0.6 GB\n *\n * @param files - Filename or an array of filenames of script/literature files to copy.\n *\n * @param source - Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.\n *\n * @param destination - Host or IP of the destination server, which is the server to which the file will be copied.\n *\n * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.\n *\n * @example\n * ```js\n * //Copies foo.lit from the helios server to the home computer:\n * scp(\"foo.lit\", \"helios\", \"home\");\n * ```\n *\n * @example\n * ```js\n * //Tries to copy three files from rothman-uni to home computer:\n * files = [\"foo1.lit\", \"foo2.script\", \"foo3.script\"];\n * scp(files, \"rothman-uni\", \"home\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scp(\n files: " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ",\n source: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ",\n // tslint:disable-next-line:unified-signatures\n destination: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "files", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "destination", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ], + "name": "scp" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scriptKill:member(1)", + "docComment": "/**\n * Kills all scripts with the specified filename on the target server specified by hostname/ip, regardless of arguments.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param script - Filename of script to kill. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @returns true if one or more scripts were successfully killed, and false if none were.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scriptKill(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "scriptKill" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scriptRunning:member(1)", + "docComment": "/**\n * Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments.\n *\n * This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param script - Filename of script to check. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @returns True if the specified script is running, and false otherwise.\n *\n * @example\n * ```js\n * //The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise:\n * scriptRunning(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise:\n * scriptRunning(\"foo.script\", getHostname());\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scriptRunning(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "scriptRunning" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#serverExists:member(1)", + "docComment": "/**\n * Returns a boolean denoting whether or not the specified server exists.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns True if specified server exists, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "serverExists(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "serverExists" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#sleep:member(1)", + "docComment": "/**\n * Suspends the script for n milliseconds.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param millis - Number of milliseconds to sleep.\n *\n * @returns \n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sleep(millis: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "millis", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "sleep" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#sleeve:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly sleeve: " + }, + { + "kind": "Reference", + "text": "Sleeve", + "canonicalReference": "bitburner!Sleeve:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sleeve", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#spawn:member(1)", + "docComment": "/**\n * Terminates the current script, and then after a delay of about 10 seconds it will execute the newly-specified script. The purpose of this function is to execute a new script without being constrained by the RAM usage of the current one. This function can only be used to run scripts on the local server.\n *\n * Because this function immediately terminates the script, it does not have a return value.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param script - Filename of script to execute.\n *\n * @param numThreads - Number of threads to spawn new script with. Will be rounded to nearest integer.\n *\n * @param args - Additional arguments to pass into the new script that is being run.\n *\n * @example\n * ```js\n * //The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90:\n * spawn('foo.script', 10, 'foodnstuff', 90);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "spawn(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", numThreads?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "numThreads", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "spawn" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#sprintf:member(1)", + "docComment": "/**\n * Complete open source JavaScript sprintf implementation\n *\n * @remarks\n *\n * 0 GB\n *\n * @param format - String to format.\n *\n * @param args - Formating arguments.\n *\n * @returns Formated text.\n *\n * @see\n *\n * https://github.com/alexei/sprintf.js\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sprintf(format: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "format", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "sprintf" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#sqlinject:member(1)", + "docComment": "/**\n * Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * sqlinject(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sqlinject(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "sqlinject" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#stock:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly stock: " + }, + { + "kind": "Reference", + "text": "TIX", + "canonicalReference": "bitburner!TIX:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "stock", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#tail:member(1)", + "docComment": "/**\n * Opens a script’s logs. This is functionally the same as the tail Terminal command.\n *\n * If the function is called with no arguments, it will open the current script’s logs.\n *\n * Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Optional. Filename of the script being tailed. If omitted, the current script is tailed.\n *\n * @param host - Optional. Hostname or IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional.\n *\n * @param args - Arguments for the script being tailed.\n *\n * @example\n * ```js\n * //Open logs from foo.script on the current server that was run with no args\n * tail(\"foo.script\");\n * ```\n *\n * @example\n * ```js\n * //Get logs from foo.script on the foodnstuff server that was run with no args\n * tail(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, \"test\"]\n * tail(\"foo.script\", \"foodnstuff\", 1, \"test\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tail(fn?: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "tail" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#tprint:member(1)", + "docComment": "/**\n * Prints a value or a variable to the Terminal.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param msg - Value to be printed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tprint(msg: " + }, + { + "kind": "Content", + "text": "string | number | string[] | number[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "msg", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tprint" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#tryWrite:member(1)", + "docComment": "/**\n * Attempts to write data to the specified Netscript Port. If the port is full, the data will not be written. Otherwise, the data will be written normally.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param port - Port or text file that will be written to.\n *\n * @param data - Data to write.\n *\n * @returns True if the data is successfully written to the port, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tryWrite(port: " + }, + { + "kind": "Reference", + "text": "Handle", + "canonicalReference": "bitburner!Handle:type" + }, + { + "kind": "Content", + "text": ", data: " + }, + { + "kind": "Content", + "text": "string | string[] | number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "port", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "tryWrite" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#vsprintf:member(1)", + "docComment": "/**\n * Complete open source JavaScript sprintf implementation\n *\n * @remarks\n *\n * 0 GB\n *\n * @param format - String to format.\n *\n * @param args - Formating arguments.\n *\n * @returns Formated text.\n *\n * @see\n *\n * https://github.com/alexei/sprintf.js\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "vsprintf(format: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "format", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "vsprintf" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#weaken:member(1)", + "docComment": "/**\n * Use your hacking skills to attack a server’s security, lowering the server’s security level. The runtime for this command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05.\n *\n * Like hack and grow, \\`weaken\\` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command.\n *\n * @remarks\n *\n * 0.15 GB\n *\n * @param host - Hostname or IP of the target server to weaken.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads.\n *\n * @example\n * ```js\n * weaken(\"foodnstuff\");\n * weaken(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to weaken\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "weaken(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", opts?: " + }, + { + "kind": "Reference", + "text": "BasicHGWOptions", + "canonicalReference": "bitburner!BasicHGWOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "weaken" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#weakenAnalyze:member(1)", + "docComment": "/**\n * Returns the security decrease that would occur if a weaken with this many threads happened.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param threads - Amount of threads that will be used.\n *\n * @param cores - Optional. The number of cores of the server that would run weaken.\n *\n * @returns The security decrease.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "weakenAnalyze(threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", cores?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "threads", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "cores", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "weakenAnalyze" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#wget:member(1)", + "docComment": "/**\n * Retrieves data from a URL and downloads it to a file on the specified server. The data can only be downloaded to a script (.script, .ns, .js) or a text file (.txt). If the file already exists, it will be overwritten by this command. Note that it will not be possible to download data from many websites because they do not allow cross-origin resource sharing (CORS).\n *\n * IMPORTANT: This is an asynchronous function that returns a Promise. The Promise’s resolved value will be a boolean indicating whether or not the data was successfully retrieved from the URL. Because the function is async and returns a Promise, it is recommended you use wget in NetscriptJS (Netscript 2.0).\n *\n * In NetscriptJS, you must preface any call to wget with the await keyword (like you would hack or sleep). wget will still work in Netscript 1.0, but the functions execution will not be synchronous (i.e. it may not execute when you expect/want it to). Furthermore, since Promises are not supported in ES5, you will not be able to process the returned value of wget in Netscript 1.0.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param url - URL to pull data from.\n *\n * @param target - Filename to write data to. Must be script or text file.\n *\n * @param host - Optional hostname/ip of server for target file.\n *\n * @returns True if the data was successfully retrieved from the URL, false otherwise.\n *\n * @example\n * ```js\n * wget(\"https://raw.githubusercontent.com/danielyxie/bitburner/master/README.md\", \"game_readme.txt\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wget(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", target: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "wget" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#write:member(1)", + "docComment": "/**\n * This function can be used to either write data to a port or to a text file (.txt).\n *\n * If the first argument is a number between 1 and 20, then it specifies a port and this function will write data to that port. The third argument, mode, is not used when writing to a port.\n *\n * If the first argument is a string, then it specifies the name of a text file (.txt) and this function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If *mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param handle - Port or text file that will be written to.\n *\n * @param data - Data to write.\n *\n * @param mode - Defines the write mode. Only valid when writing to text files.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "write(handle: " + }, + { + "kind": "Reference", + "text": "Handle", + "canonicalReference": "bitburner!Handle:type" + }, + { + "kind": "Content", + "text": ", data?: " + }, + { + "kind": "Content", + "text": "string | string[] | number" + }, + { + "kind": "Content", + "text": ", mode?: " + }, + { + "kind": "Content", + "text": "\"w\" | \"a\"" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handle", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "mode", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "write" + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!OrderPos:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type OrderPos = " + }, + { + "kind": "Content", + "text": "\"long\" | \"short\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "OrderPos", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!OrderType:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type OrderType = " + }, + { + "kind": "Content", + "text": "\"limitbuy\" | \"limitsell\" | \"stopbuy\" | \"stopsell\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "OrderType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!PlayerStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface PlayerStats " + } + ], + "releaseTag": "Public", + "name": "PlayerStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#agility:member", + "docComment": "/**\n * Agility level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#charisma:member", + "docComment": "/**\n * Chraisma level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#defense:member", + "docComment": "/**\n * Defense level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#dexterity:member", + "docComment": "/**\n * Dexterity level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#hacking:member", + "docComment": "/**\n * Hacking level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#intelligence:member", + "docComment": "/**\n * Intelligence level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "intelligence: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "intelligence", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#strength:member", + "docComment": "/**\n * Strength level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Port:type", + "docComment": "/**\n * A port is implemented as a sort of serialized queue, where you can only write and read one element at a time from the port. When you read data from a port, the element that is read is removed from the port.\n *\n * IMPORTANT: The data inside ports are not saved! This means if you close and re-open the game, or reload the page then you will lose all of the data in the ports!\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Port = " + }, + { + "kind": "Content", + "text": "1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Port", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!ProcessInfo:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface ProcessInfo " + } + ], + "releaseTag": "Public", + "name": "ProcessInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!ProcessInfo#args:member", + "docComment": "/**\n * Script's arguments\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "args", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!ProcessInfo#filename:member", + "docComment": "/**\n * Script name.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "filename: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "filename", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!ProcessInfo#threads:member", + "docComment": "/**\n * Number of threads script is running with\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "threads", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!PurchaseableProgram:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type PurchaseableProgram =\n " + }, + { + "kind": "Content", + "text": "| \"brutessh.exe\"\n | \"ftpcrack.exe\"\n | \"relaysmtp.exe\"\n | \"httpworm.exe\"\n | \"sqlinject.exe\"\n | \"deepscanv1.exe\"\n | \"deepscanv2.exe\"\n | \"autolink.exe\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "PurchaseableProgram", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Script:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Script = " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Script", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Server:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Server " + } + ], + "releaseTag": "Public", + "name": "Server", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#cpuCores:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "cpuCores: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cpuCores", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#ftpPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ftpPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ftpPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#hasAdminRights:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasAdminRights: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hasAdminRights", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#hostname:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hostname: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hostname", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#httpPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "httpPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "httpPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#ip:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ip: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ip", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#isConnectedTo:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isConnectedTo: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isConnectedTo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#maxRam:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxRam: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "maxRam", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#organizationName:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "organizationName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "organizationName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#ramUsed:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ramUsed: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ramUsed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#smtpPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "smtpPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "smtpPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#sqlPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "sqlPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sqlPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#sshPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "sshPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sshPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Singularity:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Singularity " + } + ], + "releaseTag": "Public", + "name": "Singularity", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#applyToCompany:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.\n *\n * This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false.\n *\n * @remarks\n *\n * 3 GB @singularity Level 2\n *\n * @param companyName - Name of company to apply to.\n *\n * @param field - Field to which you want to apply.\n *\n * @returns True if the player successfully get a job/promotion, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "applyToCompany(companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": ", field: " + }, + { + "kind": "Reference", + "text": "CompanyField", + "canonicalReference": "bitburner!CompanyField:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "field", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "applyToCompany" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#checkFactionInvitations:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array with the name of all Factions you currently have oustanding invitations from.\n *\n * @remarks\n *\n * 3 GB @singularity Level 2\n *\n * @returns Array with the name of all Factions you currently have oustanding invitations from.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "checkFactionInvitations(): " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "checkFactionInvitations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#commitCrime:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running \\`commitCrime('rob store')\\` will return 60).\n *\n * Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param crime - Name of crime to attempt.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "commitCrime(crime: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "crime", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "commitCrime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#createProgram:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns true if you successfully start working on the specified program, and false otherwise.\n *\n * Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: * BruteSSH.exe: 50 * FTPCrack.exe: 100 * relaySMTP.exe: 250 * HTTPWorm.exe: 500 * SQLInject.exe: 750 * DeepscanV1.exe: 75 * DeepscanV2.exe: 400 * ServerProfiler.exe: 75 * AutoLink.exe: 25\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param program - Name of program to create.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n *\n * @example\n * ```js\n * createProgram(“relaysmtp.exe”);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createProgram(program: " + }, + { + "kind": "Reference", + "text": "CreatableProgram", + "canonicalReference": "bitburner!CreatableProgram:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "program", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "createProgram" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#donateToFaction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param faction - Name of faction to donate to.\n *\n * @param amount - Amount of money to donate.\n *\n * @returns True if the money was donated, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "donateToFaction(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": ", amount: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "amount", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "donateToFaction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getAugmentationCost:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost.\n *\n * If an invalid Augmentation name is passed in for the augName argument, this function will return the array [-1, -1].\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with first element as a reputation requirement and second element as the money cost.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAugmentationCost(augName: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "[number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "augName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAugmentationCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getAugmentationPrereq:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAugmentationPrereq(augName: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "augName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAugmentationPrereq" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getAugmentationsFromFaction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param faction - Name of faction.\n *\n * @returns Array containing the names of all Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAugmentationsFromFaction(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAugmentationsFromFaction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getAugmentationStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns augmentation stats.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param name - Name of Augmentation. CASE-SENSITIVE.\n *\n * @returns Augmentation stats.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAugmentationStats(name: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentationStats", + "canonicalReference": "bitburner!AugmentationStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAugmentationStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCharacterInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an object with various information about your character.\n *\n * @remarks\n *\n * 0.5 GB @singularity Level 1\n *\n * @returns Object with various information about your character.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCharacterInformation(): " + }, + { + "kind": "Reference", + "text": "CharacterInfo", + "canonicalReference": "bitburner!CharacterInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getCharacterInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCompanyFavor:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @remarks\n *\n * 1 GB @singularity Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you have at the specified company.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCompanyFavor(companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCompanyFavor" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCompanyFavorGain:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations.\n *\n * @remarks\n *\n * 0.75 GB @singularity Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCompanyFavorGain(companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCompanyFavorGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCompanyRep:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @remarks\n *\n * 1 GB @singularity Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of reputation you have at the specified company.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCompanyRep(companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCompanyRep" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCrimeChance:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns your chance of success at commiting the specified crime. The chance is returned as a decimal (i.e. 60% would be returned as 0.6).\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param crime - Name of crime.\n *\n * @returns Chance of success at commiting the specified crime as a decimal.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCrimeChance(crime: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "crime", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCrimeChance" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCrimeStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns the stats of the crime.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param crime - Name of crime. Not case-sensitive\n *\n * @returns The stats of the crime.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCrimeStats(crime: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CrimeStats", + "canonicalReference": "bitburner!CrimeStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "crime", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCrimeStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getFactionFavor:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of favor you have for the specified faction.\n *\n * @remarks\n *\n * 1 GB @singularity Level 2\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you have for the specified faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getFactionFavor(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getFactionFavor" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getFactionFavorGain:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n *\n * @remarks\n *\n * 0.75 GB @singularity Level 2\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getFactionFavorGain(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getFactionFavorGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getFactionRep:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of reputation you have for the specified faction.\n *\n * @remarks\n *\n * 1 GB @singularity Level 2\n *\n * @param faction - Name of faction to work for.\n *\n * @returns Amount of reputation you have for the specified faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getFactionRep(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getFactionRep" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getOwnedAugmentations:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array containing the names (as strings) of all Augmentations you have.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations.\n *\n * @returns Array containing the names (as strings) of all Augmentations you have.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOwnedAugmentations(purchased?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "purchased", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getOwnedAugmentations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getOwnedSourceFiles:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array of source files\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @returns Array containing an object with number and level of the source file.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOwnedSourceFiles(): " + }, + { + "kind": "Reference", + "text": "SourceFileLvl", + "canonicalReference": "bitburner!SourceFileLvl:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getOwnedSourceFiles" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an object with the Player’s stats.\n *\n * @remarks\n *\n * 0.5 GB @singularity Level 1\n *\n * @returns Object with the Player’s stats.\n *\n * @example\n * ```js\n * res = getStats();\n * print('My charisma level is: ' + res.charisma);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getStats(): " + }, + { + "kind": "Reference", + "text": "PlayerStats", + "canonicalReference": "bitburner!PlayerStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getUpgradeHomeRamCost:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns the cost of upgrading the player’s home computer RAM.\n *\n * @remarks\n *\n * 1.5 GB @singularity Level 2\n *\n * @returns Cost of upgrading the player’s home computer RAM.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUpgradeHomeRamCost(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getUpgradeHomeRamCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#gymWorkout:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train\n *\n * @remarks\n *\n * 2 GB @singularity Level 1\n *\n * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify.\n *\n * @param stat - The stat you want to train.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "gymWorkout(gymName: " + }, + { + "kind": "Reference", + "text": "Gym", + "canonicalReference": "bitburner!Gym:type" + }, + { + "kind": "Content", + "text": ", stat: " + }, + { + "kind": "Reference", + "text": "GymStat", + "canonicalReference": "bitburner!GymStat:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "gymName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "stat", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "gymWorkout" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#installAugmentations:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically install your Augmentations, resetting the game as usual.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param cbScript - Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "installAugmentations(cbScript?: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "cbScript", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "installAugmentations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#isBusy:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission.\n *\n * @remarks\n *\n * 0.5 GB @singularity Level 1\n *\n * @returns True if the player is currently performing an ‘action’, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isBusy(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "isBusy" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#joinFaction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically accept an invitation from a faction and join it.\n *\n * @remarks\n *\n * 3 GB @singularity Level 2\n *\n * @param faction - Name of faction to join.\n *\n * @returns True if player joined the faction, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "joinFaction(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "joinFaction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#purchaseAugmentation:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will try to purchase the specified Augmentation through the given Faction.\n *\n * This function will return true if the Augmentation is successfully purchased, and false otherwise.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n *\n * @param faction - Name of faction to purchase Augmentation from.\n *\n * @param augmnet - Name of Augmentation to purchase.\n *\n * @returns True if the Augmentation is successfully purchased, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseAugmentation(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": ", augmnet: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "augmnet", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "purchaseAugmentation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#purchaseProgram:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command.\n *\n * @remarks\n *\n * 2 GB @singularity Level 1\n *\n * @param programName - Name of program to purchase.\n *\n * @returns True if the specified program is purchased, and false otherwise.\n *\n * @example\n * ```js\n * purchaseProgram(\"brutessh.exe\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseProgram(programName: " + }, + { + "kind": "Reference", + "text": "PurchaseableProgram", + "canonicalReference": "bitburner!PurchaseableProgram:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "programName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "purchaseProgram" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#purchaseTor:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one.\n *\n * @remarks\n *\n * 2 GB @singularity Level 1\n *\n * @returns True if actions is successful, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseTor(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "purchaseTor" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#softReset:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will perform a reset even if you don’t have any augmentation installed.\n *\n * @remarks\n *\n * 5 GB @singularity Level 3\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "softReset(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "softReset" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#stopAction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.\n *\n * The actions that can be stopped with this function are:\n *\n * * Studying at a university * Working for a company/faction * Creating a program * Committing a Crime\n *\n * This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called.\n *\n * @remarks\n *\n * 1 GB @singularity Level 1\n *\n * @returns True if the player’s action was ended, false if the player was not performing an action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopAction(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "stopAction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#travelToCity:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency.\n *\n * @remarks\n *\n * 2 GB @singularity Level 1\n *\n * @param city - City to travel to.\n *\n * @returns True if actions is successful, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "travelToCity(city: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "city", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "travelToCity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#universityCourse:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes.\n *\n * @remarks\n *\n * 2 GB @singularity Level 1\n *\n * @param universityName - Name of university. You must be in the correct city for whatever university you specify.\n *\n * @param courseName - Name of course.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "universityCourse(universityName: " + }, + { + "kind": "Reference", + "text": "University", + "canonicalReference": "bitburner!University:type" + }, + { + "kind": "Content", + "text": ", courseName: " + }, + { + "kind": "Reference", + "text": "UniversityCourse", + "canonicalReference": "bitburner!UniversityCourse:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "universityName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "courseName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "universityCourse" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#upgradeHomeRam:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually.\n *\n * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise.\n *\n * @remarks\n *\n * 3 GB @singularity Level 2\n *\n * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeHomeRam(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "upgradeHomeRam" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#workForCompany:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if the player starts working, and false otherwise.\n *\n * Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action.\n *\n * @remarks\n *\n * 3 GB @singularity Level 2\n *\n * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```js\n * //If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getCompanyRep(COMPANY HERE) < VALUE) {\n * workForCompany();\n * sleep(60000);\n * }\n * //This way, your company reputation will be updated every minute.\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workForCompany(companyName?: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "workForCompany" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#workForFaction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if you successfully start working for the specified faction, and false otherwise.\n *\n * Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action.\n *\n * @remarks\n *\n * 3 GB @singularity Level 2\n *\n * @param faction - Name of faction to work for.\n *\n * @param workType - Type of work to perform for the faction.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```js\n * //If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getFactionRep(FACTION NAME) < VALUE) {\n * workForFaction(FACNAME, WORKTYPE);\n * sleep(60000);\n * }\n * //This way, your faction reputation will be updated every minute.\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workForFaction(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": ", workType: " + }, + { + "kind": "Reference", + "text": "FactionWork", + "canonicalReference": "bitburner!FactionWork:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "workType", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "workForFaction" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Sleeve:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Sleeve " + } + ], + "releaseTag": "Public", + "name": "Sleeve", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a struct containing tons of information about this sleeve\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve information.\n *\n * @returns Object containing tons of information about this sleeve.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInformation(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SleeveInformation", + "canonicalReference": "bitburner!SleeveInformation:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getNumSleeves:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return the number of duplicate sleeves the player has.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns number of duplicate sleeves the player has.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getNumSleeves(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getNumSleeves" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getSleeveAugmentations:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a list of augmentation names that this sleeve has installed.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve augmentations from.\n *\n * @returns List of augmentation names that this sleeve has installed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSleeveAugmentations(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSleeveAugmentations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getSleevePurchasableAugs:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a list of augmentations that the player can buy for this sleeve.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from.\n *\n * @returns List of augmentations that the player can buy for this sleeve.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSleevePurchasableAugs(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentPair", + "canonicalReference": "bitburner!AugmentPair:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSleevePurchasableAugs" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getSleeveStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a structure containing the stats of the sleeve.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to get stats of.\n *\n * @returns Object containing the stats of the sleeve.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSleeveStats(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SleeveStats", + "canonicalReference": "bitburner!SleeveStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSleeveStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getTask:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve task from.\n *\n * @returns Object containing information the current task that the sleeve is performing.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTask(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SleeveTask", + "canonicalReference": "bitburner!SleeveTask:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getTask" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#purchaseSleeveAug:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return true if the aug was purchased and installed on the sleeve.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to buy an aug for.\n *\n * @param augName - Name of the aug to buy. Must be an exact match.\n *\n * @returns True if the aug was purchased and installed on the sleeve, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseSleeveAug(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", augName: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "augName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "purchaseSleeveAug" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToCommitCrime:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * Returns false if an invalid action is specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start commiting crime.\n *\n * @param name - Name of the crime. Must be an exact match.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToCommitCrime(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", name: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "setToCommitCrime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToCompanyWork:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working or this company.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to work for the company.\n *\n * @param companyName - Name of the company to work for.\n *\n * @returns True if the sleeve started working on this company, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToCompanyWork(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "setToCompanyWork" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToFactionWork:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working or this faction.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to work for the faction.\n *\n * @param factionName - Name of the faction to work for.\n *\n * @param factionWorkType - Name of the action to perform for this faction.\n *\n * @returns True if the sleeve started working on this faction, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToFactionWork(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", factionName: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": ", factionWorkType: " + }, + { + "kind": "Reference", + "text": "FactionWork", + "canonicalReference": "bitburner!FactionWork:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "factionName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "factionWorkType", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "setToFactionWork" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToGymWorkout:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working out.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to workout at the gym.\n *\n * @param gymName - Name of the gym.\n *\n * @param stat - Name of the stat to train.\n *\n * @returns True if the sleeve started working out, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToGymWorkout(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", gymName: " + }, + { + "kind": "Reference", + "text": "Gym", + "canonicalReference": "bitburner!Gym:type" + }, + { + "kind": "Content", + "text": ", stat: " + }, + { + "kind": "Reference", + "text": "GymStat", + "canonicalReference": "bitburner!GymStat:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "gymName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "stat", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "setToGymWorkout" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToShockRecovery:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start recovery.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToShockRecovery(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setToShockRecovery" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToSynchronize:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start synchronizing.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToSynchronize(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setToSynchronize" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToUniversityCourse:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start taking class.\n *\n * @param university - Name of the university to attend.\n *\n * @param className - Name of the class to follow.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToUniversityCourse(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", university: " + }, + { + "kind": "Reference", + "text": "University", + "canonicalReference": "bitburner!University:type" + }, + { + "kind": "Content", + "text": ", className: " + }, + { + "kind": "Reference", + "text": "UniversityCourse", + "canonicalReference": "bitburner!UniversityCourse:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "university", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "className", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "setToUniversityCourse" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#travel:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve reached destination.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to travel.\n *\n * @param cityName - Name of the destination city.\n *\n * @returns True if the sleeve reached destination, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "travel(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", cityName: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "cityName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "travel" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SleeveInformation:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SleeveInformation " + } + ], + "releaseTag": "Public", + "name": "SleeveInformation", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#city:member", + "docComment": "/**\n * location of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "city: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "city", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#earningsForPlayer:member", + "docComment": "/**\n * earnings synchronized to the player\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "earningsForPlayer: " + }, + { + "kind": "Reference", + "text": "SleeveWorkGains", + "canonicalReference": "bitburner!SleeveWorkGains:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "earningsForPlayer", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#earningsForSleeves:member", + "docComment": "/**\n * earnings synchronized to other sleeves\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "earningsForSleeves: " + }, + { + "kind": "Reference", + "text": "SleeveWorkGains", + "canonicalReference": "bitburner!SleeveWorkGains:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "earningsForSleeves", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#earningsForTask:member", + "docComment": "/**\n * earnings for this sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "earningsForTask: " + }, + { + "kind": "Reference", + "text": "SleeveWorkGains", + "canonicalReference": "bitburner!SleeveWorkGains:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "earningsForTask", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#hp:member", + "docComment": "/**\n * current hp of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#jobs:member", + "docComment": "/**\n * jobs available to the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "jobs: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "jobs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#jobTitle:member", + "docComment": "/**\n * job titles available to the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "jobTitle: " + }, + { + "kind": "Reference", + "text": "CompanyField", + "canonicalReference": "bitburner!CompanyField:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "jobTitle", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#maxHp:member", + "docComment": "/**\n * max hp of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxHp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "maxHp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#mult:member", + "docComment": "/**\n * sleeve multipliers\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mult: " + }, + { + "kind": "Reference", + "text": "CharacterMult", + "canonicalReference": "bitburner!CharacterMult:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#timeWorked:member", + "docComment": "/**\n * time spent on the current task in milliseconds\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeWorked: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "timeWorked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#tor:member", + "docComment": "/**\n * does this sleeve have access to the tor router\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tor: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "tor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#workRepGain:member", + "docComment": "/**\n * faction or company reputation gained for the current task\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workRepGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workRepGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SleeveStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SleeveStats " + } + ], + "releaseTag": "Public", + "name": "SleeveStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#agility:member", + "docComment": "/**\n * current agility of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#charisma:member", + "docComment": "/**\n * current charisma of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#defense:member", + "docComment": "/**\n * current defense of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#dexterity:member", + "docComment": "/**\n * current dexterity of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#hacking_skill:member", + "docComment": "/**\n * current hacking skill of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_skill: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking_skill", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#shock:member", + "docComment": "/**\n * current shock of the sleeve [0-100]\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "shock:\n " + }, + { + "kind": "Content", + "text": "| 0\n | 1\n | 2\n | 3\n | 4\n | 5\n | 6\n | 7\n | 8\n | 9\n | 10\n | 11\n | 12\n | 13\n | 14\n | 15\n | 16\n | 17\n | 18\n | 19\n | 20\n | 21\n | 22\n | 23\n | 24\n | 25\n | 26\n | 27\n | 28\n | 29\n | 30\n | 31\n | 32\n | 33\n | 34\n | 35\n | 36\n | 37\n | 38\n | 39\n | 40\n | 41\n | 42\n | 43\n | 44\n | 45\n | 46\n | 47\n | 48\n | 49\n | 50\n | 51\n | 52\n | 53\n | 54\n | 55\n | 56\n | 57\n | 58\n | 59\n | 60\n | 61\n | 62\n | 63\n | 64\n | 65\n | 66\n | 67\n | 68\n | 69\n | 70\n | 71\n | 72\n | 73\n | 74\n | 75\n | 76\n | 77\n | 78\n | 79\n | 80\n | 81\n | 82\n | 83\n | 84\n | 85\n | 86\n | 87\n | 88\n | 89\n | 90\n | 91\n | 92\n | 93\n | 94\n | 95\n | 96\n | 97\n | 98\n | 99\n | 100" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "shock", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#strength:member", + "docComment": "/**\n * current strength of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#sync:member", + "docComment": "/**\n * current sync of the sleeve [0-100]\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sync:\n " + }, + { + "kind": "Content", + "text": "| 0\n | 1\n | 2\n | 3\n | 4\n | 5\n | 6\n | 7\n | 8\n | 9\n | 10\n | 11\n | 12\n | 13\n | 14\n | 15\n | 16\n | 17\n | 18\n | 19\n | 20\n | 21\n | 22\n | 23\n | 24\n | 25\n | 26\n | 27\n | 28\n | 29\n | 30\n | 31\n | 32\n | 33\n | 34\n | 35\n | 36\n | 37\n | 38\n | 39\n | 40\n | 41\n | 42\n | 43\n | 44\n | 45\n | 46\n | 47\n | 48\n | 49\n | 50\n | 51\n | 52\n | 53\n | 54\n | 55\n | 56\n | 57\n | 58\n | 59\n | 60\n | 61\n | 62\n | 63\n | 64\n | 65\n | 66\n | 67\n | 68\n | 69\n | 70\n | 71\n | 72\n | 73\n | 74\n | 75\n | 76\n | 77\n | 78\n | 79\n | 80\n | 81\n | 82\n | 83\n | 84\n | 85\n | 86\n | 87\n | 88\n | 89\n | 90\n | 91\n | 92\n | 93\n | 94\n | 95\n | 96\n | 97\n | 98\n | 99\n | 100" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sync", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SleeveTask:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SleeveTask " + } + ], + "releaseTag": "Public", + "name": "SleeveTask", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#crime:member", + "docComment": "/**\n * crime currently attempting, if any\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crime: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "crime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#factionWorkType:member", + "docComment": "/**\n * faction work type being performed, if any\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "factionWorkType: " + }, + { + "kind": "Reference", + "text": "FactionWork", + "canonicalReference": "bitburner!FactionWork:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "factionWorkType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#gymStatType:member", + "docComment": "/**\n * stat being trained at the gym, if any\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "gymStatType: " + }, + { + "kind": "Reference", + "text": "GymStat", + "canonicalReference": "bitburner!GymStat:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "gymStatType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#location:member", + "docComment": "/**\n * location of the task, if any\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "location: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "location", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#task:member", + "docComment": "/**\n * task type\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "task: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "task", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SleeveWorkGains:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SleeveWorkGains " + } + ], + "releaseTag": "Public", + "name": "SleeveWorkGains", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workAgiExpGain:member", + "docComment": "/**\n * agility exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workAgiExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workAgiExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workChaExpGain:member", + "docComment": "/**\n * charisma exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workChaExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workChaExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workDefExpGain:member", + "docComment": "/**\n * defense exp gained from work,\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workDefExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workDefExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workDexExpGain:member", + "docComment": "/**\n * dexterity exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workDexExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workDexExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workHackExpGain:member", + "docComment": "/**\n * hacking exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workHackExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workHackExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workMoneyGain:member", + "docComment": "/**\n * money gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workMoneyGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workMoneyGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workStrExpGain:member", + "docComment": "/**\n * strength exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workStrExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workStrExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SourceFileLvl:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SourceFileLvl " + } + ], + "releaseTag": "Public", + "name": "SourceFileLvl", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SourceFileLvl#lvl:member", + "docComment": "/**\n * The level of the source file\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "lvl: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "lvl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SourceFileLvl#n:member", + "docComment": "/**\n * The number of the source file\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "n: " + }, + { + "kind": "Content", + "text": "1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "n", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!StockOrder:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type StockOrder = " + }, + { + "kind": "Content", + "text": "{\n /** Stock Symbol */\n [key in " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "]?: " + }, + { + "kind": "Reference", + "text": "StockOrderObject", + "canonicalReference": "bitburner!StockOrderObject:interface" + }, + { + "kind": "Content", + "text": "[];\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "StockOrder", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!StockOrderObject:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface StockOrderObject " + } + ], + "releaseTag": "Public", + "name": "StockOrderObject", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!StockOrderObject#position:member", + "docComment": "/**\n * Order position\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "position: " + }, + { + "kind": "Content", + "text": "\"S\" | \"L\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "position", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!StockOrderObject#price:member", + "docComment": "/**\n * Price per share\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "price: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "price", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!StockOrderObject#shares:member", + "docComment": "/**\n * Number of shares\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "shares", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!StockOrderObject#type:member", + "docComment": "/**\n * Order type\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "\"Limit Buy Order\" | \"Limit Sell Order\" | \"Stop Buy Order\" | \"Stop Buy Order\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!StockSymbol:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type StockSymbol =\n " + }, + { + "kind": "Content", + "text": "| \"ECP\"\n | \"MGCP\"\n | \"BLD\"\n | \"CLRK\"\n | \"OMTK\"\n | \"FSIG\"\n | \"KGI\"\n | \"FLCM\"\n | \"STM\"\n | \"DCOMM\"\n | \"HLS\"\n | \"VITA\"\n | \"ICRS\"\n | \"UNV\"\n | \"AERO\"\n | \"OMN\"\n | \"SLRS\"\n | \"GPH\"\n | \"NVMD\"\n | \"WDS\"\n | \"LXO\"\n | \"RHOC\"\n | \"APHE\"\n | \"SYSC\"\n | \"CTK\"\n | \"NTLK\"\n | \"OMGA\"\n | \"FNS\"\n | \"SGC\"\n | \"JGN\"\n | \"CTYS\"\n | \"MDYN\"\n | \"TITN\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "StockSymbol", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!TIX:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface TIX " + } + ], + "releaseTag": "Public", + "name": "TIX", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#buy:member(1)", + "docComment": "/**\n * Attempts to purchase shares of a stock using a Market Order.\n *\n * If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.\n *\n * If this function successfully purchases the shares, it will return the stock price at which each share was purchased. Otherwise, it will return 0.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to purchased. Must be positive. Will be rounded to nearest integer.\n *\n * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buy(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "buy" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#cancelOrder:member(1)", + "docComment": "/**\n * Cancels an oustanding Limit or Stop order on the stock market.\n *\n * The ability to use limit and stop orders is **not** immediately available to the player and must be unlocked later on in the game.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer.\n *\n * @param price - Execution price for the order.\n *\n * @param type - Type of order.\n *\n * @param pos - Specifies whether the order is a “Long” or “Short” position.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cancelOrder(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", price: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", type: " + }, + { + "kind": "Reference", + "text": "OrderType", + "canonicalReference": "bitburner!OrderType:type" + }, + { + "kind": "Content", + "text": ", pos: " + }, + { + "kind": "Reference", + "text": "OrderPos", + "canonicalReference": "bitburner!OrderPos:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "price", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "parameterName": "pos", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "cancelOrder" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getAskPrice:member(1)", + "docComment": "/**\n * Given a stock’s symbol (NOT the company name), returns the ask price of that stock. The symbol is a sequence of two to four capital letters.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns The ask price of a stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAskPrice(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAskPrice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getBidPrice:member(1)", + "docComment": "/**\n * Given a stock’s symbol (NOT the company name), returns the bid price of that stock. The symbol is a sequence of two to four capital letters.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns The bid price of a stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBidPrice(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getBidPrice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getForecast:member(1)", + "docComment": "/**\n * Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.\n *\n * The probability is returned as a decimal value, NOT a percentage (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).\n *\n * In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a 30% chance of increasing and a 70% chance of decreasing during the next tick.\n *\n * In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getForecast(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getForecast" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getMaxShares:member(1)", + "docComment": "/**\n * Returns the maximum number of shares that the stock has. This is the maximum amount of the stock that can be purchased in both the Long and Short positions combined.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns Maximum number of shares that the stock has.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getMaxShares(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getMaxShares" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getOrders:member(1)", + "docComment": "/**\n * Returns your order book for the stock market.\n *\n * This is an object containing information for all the Limit and Stop Orders you have in the stock market. The object has the following structure:\n * ```js\n * {\n * StockSymbol1: [ // Array of orders for this stock\n * {\n * shares: Order quantity\n * price: Order price\n * type: Order type\n * position: Either \"L\" or \"S\" for Long or Short position\n * },\n * {\n * ...\n * },\n * ...\n * ],\n * StockSymbol2: [ // Array of orders for this stock\n * ...\n * ],\n * ...\n * }\n * ```\n *\n * The “Order type” property can have one of the following four values: * “Limit Buy Order” * “Limit Sell Order” * “Stop Buy Order” * “Stop Sell Order” Note that the order book will only contain information for stocks that you actually have orders in.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @returns Object containing information for all the Limit and Stop Orders you have in the stock market.\n *\n * @example\n * ```js\n * \"If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property.\"\n * {\n * ECP: [\n * {\n * shares: 5,\n * price: 100,000\n * type: \"Stop Buy Order\",\n * position: \"S\",\n * },\n * {\n * shares: 25,\n * price: 125,000\n * type: \"Limit Sell Order\",\n * position: \"L\",\n * },\n * ],\n * SYSC: [\n * {\n * shares: 100,\n * price: 10,000\n * type: \"Limit Buy Order\",\n * position: \"L\",\n * },\n * ],\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOrders(): " + }, + { + "kind": "Reference", + "text": "StockOrder", + "canonicalReference": "bitburner!StockOrder:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getOrders" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getPosition:member(1)", + "docComment": "/**\n * Returns an array of four elements that represents the player’s position in a stock.\n *\n * The first element is the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the player’s shares in the Long position.\n *\n * The third element in the array is the number of shares the player owns of the stock in the Short position. The fourth element in the array is the average price of the player’s Short position.\n *\n * All elements in the returned array are numeric.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns Array of four elements that represents the player’s position in a stock.\n *\n * @example\n * ```js\n * pos = getPosition(\"ECP\");\n * shares = pos[0];\n * avgPx = pos[1];\n * sharesShort = pos[2];\n * avgPxShort = pos[3];\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPosition(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "[number, number, number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPosition" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getPrice:member(1)", + "docComment": "/**\n * Returns the price of a stock, given its symbol (NOT the company name). The symbol is a sequence of two to four capital letters.\n *\n * The stock’s price is the average of its bid and ask price\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns The price of a stock.\n *\n * @example\n * ```js\n * getPrice(\"FISG\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPrice(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPrice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getPurchaseCost:member(1)", + "docComment": "/**\n * Calculates and returns how much it would cost to buy a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to purchase.\n *\n * @param posType - Specifies whether the order is a “Long” or “Short” position.\n *\n * @returns Cost to buy a given number of shares of a stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchaseCost(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", posType: " + }, + { + "kind": "Reference", + "text": "OrderPos", + "canonicalReference": "bitburner!OrderPos:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "posType", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getPurchaseCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getSaleGain:member(1)", + "docComment": "/**\n * Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to sell.\n *\n * @param posType - Specifies whether the order is a “Long” or “Short” position.\n *\n * @returns Gain from selling a given number of shares of a stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSaleGain(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", posType: " + }, + { + "kind": "Reference", + "text": "OrderPos", + "canonicalReference": "bitburner!OrderPos:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "posType", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getSaleGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getSymbols:member(1)", + "docComment": "/**\n * Returns an array of the symbols of the tradable stocks\n *\n * @remarks\n *\n * 2 GB\n *\n * @returns Array of the symbols of the tradable stocks.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSymbols(): " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getSymbols" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getVolatility:member(1)", + "docComment": "/**\n * Returns the volatility of the specified stock.\n *\n * Volatility represents the maximum percentage by which a stock’s price can change every tick. The volatility is returned as a decimal value, NOT a percentage (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).\n *\n * In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns Volatility of the specified stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getVolatility(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getVolatility" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#placeOrder:member(1)", + "docComment": "/**\n * Places an order on the stock market. This function only works for Limit and Stop Orders.\n *\n * The ability to place limit and stop orders is **not** immediately available to the player and must be unlocked later on in the game.\n *\n * Returns true if the order is successfully placed, and false otherwise.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer.\n *\n * @param price - Execution price for the order.\n *\n * @param type - Type of order.\n *\n * @param pos - Specifies whether the order is a “Long” or “Short” position.\n *\n * @returns True if the order is successfully placed, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "placeOrder(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", price: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", type: " + }, + { + "kind": "Reference", + "text": "OrderType", + "canonicalReference": "bitburner!OrderType:type" + }, + { + "kind": "Content", + "text": ", pos: " + }, + { + "kind": "Reference", + "text": "OrderPos", + "canonicalReference": "bitburner!OrderPos:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "price", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "parameterName": "pos", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "placeOrder" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#purchase4SMarketData:member(1)", + "docComment": "/**\n * Purchase 4S Market Data Access.\n *\n * Returns true if you successfully purchased it or if you already have access. Returns false otherwise.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @returns True if you successfully purchased it or if you already have access, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchase4SMarketData(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "purchase4SMarketData" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#purchase4SMarketDataTixApi:member(1)", + "docComment": "/**\n * Purchase 4S Market Data TIX API Access.\n *\n * Returns true if you successfully purchased it or if you already have access. Returns false otherwise.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @returns True if you successfully purchased it or if you already have access, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchase4SMarketDataTixApi(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "purchase4SMarketDataTixApi" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#sell:member(1)", + "docComment": "/**\n * Attempts to sell shares of a stock using a Market Order.\n *\n * If the specified number of shares in the function exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.\n *\n * The net profit made from selling stocks with this function is reflected in the script’s statistics. This net profit is calculated as:\n *\n * shares * (sell_price - average_price_of_purchased_shares)\n *\n * If the sale is successful, this function will return the stock price at which each share was sold. Otherwise, it will return 0.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer.\n *\n * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sell(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "sell" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#sellShort:member(1)", + "docComment": "/**\n * Attempts to sell a short position of a stock using a Market Order.\n *\n * The ability to short a stock is **not** immediately available to the player and must be unlocked later on in the game.\n *\n * If the specified number of shares exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.\n *\n * If the sale is successful, this function will return the stock price at which each share was sold. Otherwise it will return 0.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer.\n *\n * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sellShort(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "sellShort" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#short:member(1)", + "docComment": "/**\n * Attempts to purchase a short position of a stock using a Market Order.\n *\n * The ability to short a stock is **not** immediately available to the player and must be unlocked later on in the game.\n *\n * If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.\n *\n * If the purchase is successful, this function will return the stock price at which each share was purchased. Otherwise, it will return 0.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to short. Must be positive. Will be rounded to nearest integer.\n *\n * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "short(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "short" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!University:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type University = " + }, + { + "kind": "Content", + "text": "\"Summit University\" | \"Rothman University\" | \"ZB Institute Of Technology\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "University", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!UniversityCourse:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type UniversityCourse =\n " + }, + { + "kind": "Content", + "text": "| \"Study Computer Science\"\n | \"Data Strucures\"\n | \"Networks\"\n | \"Algorithms\"\n | \"Management\"\n | \"Leadership\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UniversityCourse", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/markdown/bitburner.augmentationstats.agility_exp_mult.md b/markdown/bitburner.augmentationstats.agility_exp_mult.md new file mode 100644 index 000000000..cd4fdd78b --- /dev/null +++ b/markdown/bitburner.augmentationstats.agility_exp_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [agility\_exp\_mult](./bitburner.augmentationstats.agility_exp_mult.md) + +## AugmentationStats.agility\_exp\_mult property + +Multipler to agility experience gain rate + +Signature: + +```typescript +agility_exp_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.agility_mult.md b/markdown/bitburner.augmentationstats.agility_mult.md new file mode 100644 index 000000000..295432788 --- /dev/null +++ b/markdown/bitburner.augmentationstats.agility_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [agility\_mult](./bitburner.augmentationstats.agility_mult.md) + +## AugmentationStats.agility\_mult property + +Multipler to agility skill + +Signature: + +```typescript +agility_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.bladeburner_analysis_mult.md b/markdown/bitburner.augmentationstats.bladeburner_analysis_mult.md new file mode 100644 index 000000000..60512677e --- /dev/null +++ b/markdown/bitburner.augmentationstats.bladeburner_analysis_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [bladeburner\_analysis\_mult](./bitburner.augmentationstats.bladeburner_analysis_mult.md) + +## AugmentationStats.bladeburner\_analysis\_mult property + +Multipler to effectiveness in Bladeburner Field Analysis + +Signature: + +```typescript +bladeburner_analysis_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.bladeburner_max_stamina_mult.md b/markdown/bitburner.augmentationstats.bladeburner_max_stamina_mult.md new file mode 100644 index 000000000..4fc39f044 --- /dev/null +++ b/markdown/bitburner.augmentationstats.bladeburner_max_stamina_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [bladeburner\_max\_stamina\_mult](./bitburner.augmentationstats.bladeburner_max_stamina_mult.md) + +## AugmentationStats.bladeburner\_max\_stamina\_mult property + +Multipler to Bladeburner max stamina + +Signature: + +```typescript +bladeburner_max_stamina_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.bladeburner_stamina_gain_mult.md b/markdown/bitburner.augmentationstats.bladeburner_stamina_gain_mult.md new file mode 100644 index 000000000..5826b004b --- /dev/null +++ b/markdown/bitburner.augmentationstats.bladeburner_stamina_gain_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [bladeburner\_stamina\_gain\_mult](./bitburner.augmentationstats.bladeburner_stamina_gain_mult.md) + +## AugmentationStats.bladeburner\_stamina\_gain\_mult property + +Multipler to Bladeburner stamina gain rate + +Signature: + +```typescript +bladeburner_stamina_gain_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.bladeburner_success_chance_mult.md b/markdown/bitburner.augmentationstats.bladeburner_success_chance_mult.md new file mode 100644 index 000000000..854e28643 --- /dev/null +++ b/markdown/bitburner.augmentationstats.bladeburner_success_chance_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [bladeburner\_success\_chance\_mult](./bitburner.augmentationstats.bladeburner_success_chance_mult.md) + +## AugmentationStats.bladeburner\_success\_chance\_mult property + +Multipler to success chance in Bladeburner contracts/operations + +Signature: + +```typescript +bladeburner_success_chance_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.charisma_exp_mult.md b/markdown/bitburner.augmentationstats.charisma_exp_mult.md new file mode 100644 index 000000000..52b9eb5ab --- /dev/null +++ b/markdown/bitburner.augmentationstats.charisma_exp_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [charisma\_exp\_mult](./bitburner.augmentationstats.charisma_exp_mult.md) + +## AugmentationStats.charisma\_exp\_mult property + +Multipler to charisma experience gain rate + +Signature: + +```typescript +charisma_exp_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.charisma_mult.md b/markdown/bitburner.augmentationstats.charisma_mult.md new file mode 100644 index 000000000..19194d8b6 --- /dev/null +++ b/markdown/bitburner.augmentationstats.charisma_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [charisma\_mult](./bitburner.augmentationstats.charisma_mult.md) + +## AugmentationStats.charisma\_mult property + +Multipler to charisma skill + +Signature: + +```typescript +charisma_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.company_rep_mult.md b/markdown/bitburner.augmentationstats.company_rep_mult.md new file mode 100644 index 000000000..4c75ae56e --- /dev/null +++ b/markdown/bitburner.augmentationstats.company_rep_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [company\_rep\_mult](./bitburner.augmentationstats.company_rep_mult.md) + +## AugmentationStats.company\_rep\_mult property + +Multipler to amount of reputation gained when working + +Signature: + +```typescript +company_rep_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.crime_money_mult.md b/markdown/bitburner.augmentationstats.crime_money_mult.md new file mode 100644 index 000000000..7909912ba --- /dev/null +++ b/markdown/bitburner.augmentationstats.crime_money_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [crime\_money\_mult](./bitburner.augmentationstats.crime_money_mult.md) + +## AugmentationStats.crime\_money\_mult property + +Multipler to amount of money gained from crimes + +Signature: + +```typescript +crime_money_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.crime_success_mult.md b/markdown/bitburner.augmentationstats.crime_success_mult.md new file mode 100644 index 000000000..d7b3215f6 --- /dev/null +++ b/markdown/bitburner.augmentationstats.crime_success_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [crime\_success\_mult](./bitburner.augmentationstats.crime_success_mult.md) + +## AugmentationStats.crime\_success\_mult property + +Multipler to crime success rate + +Signature: + +```typescript +crime_success_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.defense_exp_mult.md b/markdown/bitburner.augmentationstats.defense_exp_mult.md new file mode 100644 index 000000000..ede435e1f --- /dev/null +++ b/markdown/bitburner.augmentationstats.defense_exp_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [defense\_exp\_mult](./bitburner.augmentationstats.defense_exp_mult.md) + +## AugmentationStats.defense\_exp\_mult property + +Multipler to defense experience gain rate + +Signature: + +```typescript +defense_exp_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.defense_mult.md b/markdown/bitburner.augmentationstats.defense_mult.md new file mode 100644 index 000000000..789554f79 --- /dev/null +++ b/markdown/bitburner.augmentationstats.defense_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [defense\_mult](./bitburner.augmentationstats.defense_mult.md) + +## AugmentationStats.defense\_mult property + +Multipler to defense skill + +Signature: + +```typescript +defense_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.dexterity_exp_mult.md b/markdown/bitburner.augmentationstats.dexterity_exp_mult.md new file mode 100644 index 000000000..f09300982 --- /dev/null +++ b/markdown/bitburner.augmentationstats.dexterity_exp_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [dexterity\_exp\_mult](./bitburner.augmentationstats.dexterity_exp_mult.md) + +## AugmentationStats.dexterity\_exp\_mult property + +Multipler to dexterity experience gain rate + +Signature: + +```typescript +dexterity_exp_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.dexterity_mult.md b/markdown/bitburner.augmentationstats.dexterity_mult.md new file mode 100644 index 000000000..374310f1c --- /dev/null +++ b/markdown/bitburner.augmentationstats.dexterity_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [dexterity\_mult](./bitburner.augmentationstats.dexterity_mult.md) + +## AugmentationStats.dexterity\_mult property + +Multipler to dexterity skill + +Signature: + +```typescript +dexterity_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.faction_rep_mult.md b/markdown/bitburner.augmentationstats.faction_rep_mult.md new file mode 100644 index 000000000..2bbd1121f --- /dev/null +++ b/markdown/bitburner.augmentationstats.faction_rep_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [faction\_rep\_mult](./bitburner.augmentationstats.faction_rep_mult.md) + +## AugmentationStats.faction\_rep\_mult property + +Multipler to amount of reputation gained when working + +Signature: + +```typescript +faction_rep_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacking_chance_mult.md b/markdown/bitburner.augmentationstats.hacking_chance_mult.md new file mode 100644 index 000000000..0b3c6df42 --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacking_chance_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_chance\_mult](./bitburner.augmentationstats.hacking_chance_mult.md) + +## AugmentationStats.hacking\_chance\_mult property + +Multipler to chance of successfully performing a hack + +Signature: + +```typescript +hacking_chance_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacking_exp_mult.md b/markdown/bitburner.augmentationstats.hacking_exp_mult.md new file mode 100644 index 000000000..4042d76cd --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacking_exp_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_exp\_mult](./bitburner.augmentationstats.hacking_exp_mult.md) + +## AugmentationStats.hacking\_exp\_mult property + +Multipler to hacking experience gain rate + +Signature: + +```typescript +hacking_exp_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacking_grow_mult.md b/markdown/bitburner.augmentationstats.hacking_grow_mult.md new file mode 100644 index 000000000..ebc51a928 --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacking_grow_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_grow\_mult](./bitburner.augmentationstats.hacking_grow_mult.md) + +## AugmentationStats.hacking\_grow\_mult property + +Multipler to amount of money injected into servers using grow)} + +Signature: + +```typescript +hacking_grow_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacking_money_mult.md b/markdown/bitburner.augmentationstats.hacking_money_mult.md new file mode 100644 index 000000000..06bbf5e49 --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacking_money_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_money\_mult](./bitburner.augmentationstats.hacking_money_mult.md) + +## AugmentationStats.hacking\_money\_mult property + +Multipler to amount of money the player gains from hacking + +Signature: + +```typescript +hacking_money_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacking_mult.md b/markdown/bitburner.augmentationstats.hacking_mult.md new file mode 100644 index 000000000..a4e1f479b --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacking_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_mult](./bitburner.augmentationstats.hacking_mult.md) + +## AugmentationStats.hacking\_mult property + +Multipler to hacking skill + +Signature: + +```typescript +hacking_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacking_speed_mult.md b/markdown/bitburner.augmentationstats.hacking_speed_mult.md new file mode 100644 index 000000000..dff7b4e98 --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacking_speed_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacking\_speed\_mult](./bitburner.augmentationstats.hacking_speed_mult.md) + +## AugmentationStats.hacking\_speed\_mult property + +Multipler to hacking speed + +Signature: + +```typescript +hacking_speed_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_core_cost_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_core_cost_mult.md new file mode 100644 index 000000000..f7a1b53e0 --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacknet_node_core_cost_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_core\_cost\_mult](./bitburner.augmentationstats.hacknet_node_core_cost_mult.md) + +## AugmentationStats.hacknet\_node\_core\_cost\_mult property + +Multipler to cost of core for a Hacknet Node + +Signature: + +```typescript +hacknet_node_core_cost_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_level_cost_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_level_cost_mult.md new file mode 100644 index 000000000..6dc473e27 --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacknet_node_level_cost_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_level\_cost\_mult](./bitburner.augmentationstats.hacknet_node_level_cost_mult.md) + +## AugmentationStats.hacknet\_node\_level\_cost\_mult property + +Multipler to cost of leveling up a Hacknet Node + +Signature: + +```typescript +hacknet_node_level_cost_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_money_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_money_mult.md new file mode 100644 index 000000000..17d754ab9 --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacknet_node_money_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_money\_mult](./bitburner.augmentationstats.hacknet_node_money_mult.md) + +## AugmentationStats.hacknet\_node\_money\_mult property + +Multipler to amount of money produced by Hacknet Nodes + +Signature: + +```typescript +hacknet_node_money_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md new file mode 100644 index 000000000..a5512e433 --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_purchase\_cost\_mult](./bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md) + +## AugmentationStats.hacknet\_node\_purchase\_cost\_mult property + +Multipler to cost of purchasing a Hacknet Node + +Signature: + +```typescript +hacknet_node_purchase_cost_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.hacknet_node_ram_cost_mult.md b/markdown/bitburner.augmentationstats.hacknet_node_ram_cost_mult.md new file mode 100644 index 000000000..f216ac42d --- /dev/null +++ b/markdown/bitburner.augmentationstats.hacknet_node_ram_cost_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [hacknet\_node\_ram\_cost\_mult](./bitburner.augmentationstats.hacknet_node_ram_cost_mult.md) + +## AugmentationStats.hacknet\_node\_ram\_cost\_mult property + +Multipler to cost of ram for a Hacknet Node + +Signature: + +```typescript +hacknet_node_ram_cost_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.md b/markdown/bitburner.augmentationstats.md new file mode 100644 index 000000000..765aae957 --- /dev/null +++ b/markdown/bitburner.augmentationstats.md @@ -0,0 +1,48 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) + +## AugmentationStats interface + + +Signature: + +```typescript +interface AugmentationStats +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility\_exp\_mult?](./bitburner.augmentationstats.agility_exp_mult.md) | number | (Optional) Multipler to agility experience gain rate | +| [agility\_mult?](./bitburner.augmentationstats.agility_mult.md) | number | (Optional) Multipler to agility skill | +| [bladeburner\_analysis\_mult?](./bitburner.augmentationstats.bladeburner_analysis_mult.md) | number | (Optional) Multipler to effectiveness in Bladeburner Field Analysis | +| [bladeburner\_max\_stamina\_mult?](./bitburner.augmentationstats.bladeburner_max_stamina_mult.md) | number | (Optional) Multipler to Bladeburner max stamina | +| [bladeburner\_stamina\_gain\_mult?](./bitburner.augmentationstats.bladeburner_stamina_gain_mult.md) | number | (Optional) Multipler to Bladeburner stamina gain rate | +| [bladeburner\_success\_chance\_mult?](./bitburner.augmentationstats.bladeburner_success_chance_mult.md) | number | (Optional) Multipler to success chance in Bladeburner contracts/operations | +| [charisma\_exp\_mult?](./bitburner.augmentationstats.charisma_exp_mult.md) | number | (Optional) Multipler to charisma experience gain rate | +| [charisma\_mult?](./bitburner.augmentationstats.charisma_mult.md) | number | (Optional) Multipler to charisma skill | +| [company\_rep\_mult?](./bitburner.augmentationstats.company_rep_mult.md) | number | (Optional) Multipler to amount of reputation gained when working | +| [crime\_money\_mult?](./bitburner.augmentationstats.crime_money_mult.md) | number | (Optional) Multipler to amount of money gained from crimes | +| [crime\_success\_mult?](./bitburner.augmentationstats.crime_success_mult.md) | number | (Optional) Multipler to crime success rate | +| [defense\_exp\_mult?](./bitburner.augmentationstats.defense_exp_mult.md) | number | (Optional) Multipler to defense experience gain rate | +| [defense\_mult?](./bitburner.augmentationstats.defense_mult.md) | number | (Optional) Multipler to defense skill | +| [dexterity\_exp\_mult?](./bitburner.augmentationstats.dexterity_exp_mult.md) | number | (Optional) Multipler to dexterity experience gain rate | +| [dexterity\_mult?](./bitburner.augmentationstats.dexterity_mult.md) | number | (Optional) Multipler to dexterity skill | +| [faction\_rep\_mult?](./bitburner.augmentationstats.faction_rep_mult.md) | number | (Optional) Multipler to amount of reputation gained when working | +| [hacking\_chance\_mult?](./bitburner.augmentationstats.hacking_chance_mult.md) | number | (Optional) Multipler to chance of successfully performing a hack | +| [hacking\_exp\_mult?](./bitburner.augmentationstats.hacking_exp_mult.md) | number | (Optional) Multipler to hacking experience gain rate | +| [hacking\_grow\_mult?](./bitburner.augmentationstats.hacking_grow_mult.md) | number | (Optional) Multipler to amount of money injected into servers using grow)} | +| [hacking\_money\_mult?](./bitburner.augmentationstats.hacking_money_mult.md) | number | (Optional) Multipler to amount of money the player gains from hacking | +| [hacking\_mult?](./bitburner.augmentationstats.hacking_mult.md) | number | (Optional) Multipler to hacking skill | +| [hacking\_speed\_mult?](./bitburner.augmentationstats.hacking_speed_mult.md) | number | (Optional) Multipler to hacking speed | +| [hacknet\_node\_core\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_core_cost_mult.md) | number | (Optional) Multipler to cost of core for a Hacknet Node | +| [hacknet\_node\_level\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_level_cost_mult.md) | number | (Optional) Multipler to cost of leveling up a Hacknet Node | +| [hacknet\_node\_money\_mult?](./bitburner.augmentationstats.hacknet_node_money_mult.md) | number | (Optional) Multipler to amount of money produced by Hacknet Nodes | +| [hacknet\_node\_purchase\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_purchase_cost_mult.md) | number | (Optional) Multipler to cost of purchasing a Hacknet Node | +| [hacknet\_node\_ram\_cost\_mult?](./bitburner.augmentationstats.hacknet_node_ram_cost_mult.md) | number | (Optional) Multipler to cost of ram for a Hacknet Node | +| [strength\_exp\_mult?](./bitburner.augmentationstats.strength_exp_mult.md) | number | (Optional) Multipler to strength experience gain rate | +| [strength\_mult?](./bitburner.augmentationstats.strength_mult.md) | number | (Optional) Multipler to strength skill | +| [work\_money\_mult?](./bitburner.augmentationstats.work_money_mult.md) | number | (Optional) Multipler to amount of money gained from working | + diff --git a/markdown/bitburner.augmentationstats.strength_exp_mult.md b/markdown/bitburner.augmentationstats.strength_exp_mult.md new file mode 100644 index 000000000..1a592c8be --- /dev/null +++ b/markdown/bitburner.augmentationstats.strength_exp_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [strength\_exp\_mult](./bitburner.augmentationstats.strength_exp_mult.md) + +## AugmentationStats.strength\_exp\_mult property + +Multipler to strength experience gain rate + +Signature: + +```typescript +strength_exp_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.strength_mult.md b/markdown/bitburner.augmentationstats.strength_mult.md new file mode 100644 index 000000000..5bcd49885 --- /dev/null +++ b/markdown/bitburner.augmentationstats.strength_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [strength\_mult](./bitburner.augmentationstats.strength_mult.md) + +## AugmentationStats.strength\_mult property + +Multipler to strength skill + +Signature: + +```typescript +strength_mult?: number; +``` diff --git a/markdown/bitburner.augmentationstats.work_money_mult.md b/markdown/bitburner.augmentationstats.work_money_mult.md new file mode 100644 index 000000000..557f491d8 --- /dev/null +++ b/markdown/bitburner.augmentationstats.work_money_mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentationStats](./bitburner.augmentationstats.md) > [work\_money\_mult](./bitburner.augmentationstats.work_money_mult.md) + +## AugmentationStats.work\_money\_mult property + +Multipler to amount of money gained from working + +Signature: + +```typescript +work_money_mult?: number; +``` diff --git a/markdown/bitburner.augmentname.md b/markdown/bitburner.augmentname.md new file mode 100644 index 000000000..a5ab4d07f --- /dev/null +++ b/markdown/bitburner.augmentname.md @@ -0,0 +1,116 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentName](./bitburner.augmentname.md) + +## AugmentName type + +Signature: + +```typescript +type AugmentName = + | "Augmented Targeting I" + | "Augmented Targeting II" + | "Augmented Targeting III" + | "Synthetic Heart" + | "Synfibril Muscle" + | "Combat Rib I" + | "Combat Rib II" + | "Combat Rib III" + | "Nanofiber Weave" + | "NEMEAN Subdermal Weave" + | "Wired Reflexes" + | "Graphene Bone Lacings" + | "Bionic Spine" + | "Graphene Bionic Spine Upgrade" + | "Bionic Legs" + | "Graphene Bionic Legs Upgrade" + | "Speech Processor Implant" + | "TITN-41 Gene-Modification Injection" + | "Enhanced Social Interaction Implant" + | "BitWire" + | "Artificial Bio-neural Network Implant" + | "Artificial Synaptic Potentiation" + | "Enhanced Myelin Sheathing" + | "Synaptic Enhancement Implant" + | "Neural-Retention Enhancement" + | "DataJack" + | "Embedded Netburner Module" + | "Embedded Netburner Module Core Implant" + | "Embedded Netburner Module Core V2 Upgrade" + | "Embedded Netburner Module Core V3 Upgrade" + | "Embedded Netburner Module Analyze Engine" + | "Embedded Netburner Module Direct Memory Access Upgrade" + | "Neuralstimulator" + | "Neural Accelerator" + | "Cranial Signal Processors - Gen I" + | "Cranial Signal Processors - Gen II" + | "Cranial Signal Processors - Gen III" + | "Cranial Signal Processors - Gen IV" + | "Cranial Signal Processors - Gen V" + | "Neuronal Densification" + | "Nuoptimal Nootropic Injector Implant" + | "Speech Enhancement" + | "FocusWire" + | "PC Direct-Neural Interface" + | "PC Direct-Neural Interface Optimization Submodule" + | "PC Direct-Neural Interface NeuroNet Injector" + | "ADR-V1 Pheromone Gene" + | "ADR-V2 Pheromone Gene" + | "The Shadow's Simulacrum" + | "Hacknet Node CPU Architecture Neural-Upload" + | "Hacknet Node Cache Architecture Neural-Upload" + | "Hacknet Node NIC Architecture Neural-Upload" + | "Hacknet Node Kernel Direct-Neural Interface" + | "Hacknet Node Core Direct-Neural Interface" + | "NeuroFlux Governor" + | "Neurotrainer I" + | "Neurotrainer II" + | "Neurotrainer III" + | "HyperSight Corneal Implant" + | "LuminCloaking-V1 Skin Implant" + | "LuminCloaking-V2 Skin Implant" + | "HemoRecirculator" + | "SmartSonar Implant" + | "Power Recirculation Core" + | "QLink" + | "The Red Pill" + | "SPTN-97 Gene Modification" + | "ECorp HVMind Implant" + | "CordiARC Fusion Reactor" + | "SmartJaw" + | "Neotra" + | "Xanipher" + | "nextSENS Gene Modification" + | "OmniTek InfoLoad" + | "Photosynthetic Cells" + | "BitRunners Neurolink" + | "The Black Hand" + | "CRTX42-AA Gene Modification" + | "Neuregen Gene Modification" + | "CashRoot Starter Kit" + | "NutriGen Implant" + | "INFRARET Enhancement" + | "DermaForce Particle Barrier" + | "Graphene BranchiBlades Upgrade" + | "Graphene Bionic Arms Upgrade" + | "BrachiBlades" + | "Bionic Arms" + | "Social Negotiation Assistant (S.N.A)" + | "EsperTech Bladeburner Eyewear" + | "EMS-4 Recombination" + | "ORION-MKIV Shoulder" + | "Hyperion Plasma Cannon V1" + | "Hyperion Plasma Cannon V2" + | "GOLEM Serum" + | "Vangelis Virus" + | "Vangelis Virus 3.0" + | "I.N.T.E.R.L.I.N.K.E.D" + | "Blade's Runners" + | "BLADE-51b Tesla Armor" + | "BLADE-51b Tesla Armor: Power Cells Upgrade" + | "BLADE-51b Tesla Armor: Energy Shielding Upgrade" + | "BLADE-51b Tesla Armor: Unibeam Upgrade" + | "BLADE-51b Tesla Armor: Omnibeam Upgrade" + | "BLADE-51b Tesla Armor: IPU Upgrade" + | "The Blade's Simulacrum"; +``` diff --git a/markdown/bitburner.augmentpair.cost.md b/markdown/bitburner.augmentpair.cost.md new file mode 100644 index 000000000..f165f095b --- /dev/null +++ b/markdown/bitburner.augmentpair.cost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentPair](./bitburner.augmentpair.md) > [cost](./bitburner.augmentpair.cost.md) + +## AugmentPair.cost property + +augmentation cost + +Signature: + +```typescript +cost: number; +``` diff --git a/markdown/bitburner.augmentpair.md b/markdown/bitburner.augmentpair.md new file mode 100644 index 000000000..9c78fab82 --- /dev/null +++ b/markdown/bitburner.augmentpair.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentPair](./bitburner.augmentpair.md) + +## AugmentPair interface + + +Signature: + +```typescript +interface AugmentPair +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [cost](./bitburner.augmentpair.cost.md) | number | augmentation cost | +| [name](./bitburner.augmentpair.name.md) | [AugmentName](./bitburner.augmentname.md) | augmentation name | + diff --git a/markdown/bitburner.augmentpair.name.md b/markdown/bitburner.augmentpair.name.md new file mode 100644 index 000000000..60513dff8 --- /dev/null +++ b/markdown/bitburner.augmentpair.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [AugmentPair](./bitburner.augmentpair.md) > [name](./bitburner.augmentpair.name.md) + +## AugmentPair.name property + +augmentation name + +Signature: + +```typescript +name: AugmentName; +``` diff --git a/markdown/bitburner.basichgwoptions.md b/markdown/bitburner.basichgwoptions.md new file mode 100644 index 000000000..e80942844 --- /dev/null +++ b/markdown/bitburner.basichgwoptions.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BasicHGWOptions](./bitburner.basichgwoptions.md) + +## BasicHGWOptions interface + + +Signature: + +```typescript +interface BasicHGWOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [threads](./bitburner.basichgwoptions.threads.md) | number | Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. | + diff --git a/markdown/bitburner.basichgwoptions.threads.md b/markdown/bitburner.basichgwoptions.threads.md new file mode 100644 index 000000000..e80785bae --- /dev/null +++ b/markdown/bitburner.basichgwoptions.threads.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BasicHGWOptions](./bitburner.basichgwoptions.md) > [threads](./bitburner.basichgwoptions.threads.md) + +## BasicHGWOptions.threads property + +Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with. + +Signature: + +```typescript +threads: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md new file mode 100644 index 000000000..c142d8512 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.agilitylevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [AgilityLevelMultiplier](./bitburner.bitnodemultipliers.agilitylevelmultiplier.md) + +## BitNodeMultipliers.AgilityLevelMultiplier property + +Influences how quickly the player's agility level (not exp) scales + +Signature: + +```typescript +AgilityLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md b/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md new file mode 100644 index 000000000..ef89b6397 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.augmentationmoneycost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [AugmentationMoneyCost](./bitburner.bitnodemultipliers.augmentationmoneycost.md) + +## BitNodeMultipliers.AugmentationMoneyCost property + +Influences the base cost to purchase an augmentation. + +Signature: + +```typescript +AugmentationMoneyCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md b/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md new file mode 100644 index 000000000..4022dede5 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.augmentationrepcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [AugmentationRepCost](./bitburner.bitnodemultipliers.augmentationrepcost.md) + +## BitNodeMultipliers.AugmentationRepCost property + +Influences the base rep the player must have with a faction to purchase an augmentation. + +Signature: + +```typescript +AugmentationRepCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md b/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md new file mode 100644 index 000000000..32493fb37 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.bladeburnerrank.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [BladeburnerRank](./bitburner.bitnodemultipliers.bladeburnerrank.md) + +## BitNodeMultipliers.BladeburnerRank property + +Influences how quickly the player can gain rank within Bladeburner. + +Signature: + +```typescript +BladeburnerRank: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md b/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md new file mode 100644 index 000000000..cd881ac4b --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.bladeburnerskillcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [BladeburnerSkillCost](./bitburner.bitnodemultipliers.bladeburnerskillcost.md) + +## BitNodeMultipliers.BladeburnerSkillCost property + +Influences the cost of skill levels from Bladeburner. + +Signature: + +```typescript +BladeburnerSkillCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md new file mode 100644 index 000000000..9b1baa72d --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.charismalevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CharismaLevelMultiplier](./bitburner.bitnodemultipliers.charismalevelmultiplier.md) + +## BitNodeMultipliers.CharismaLevelMultiplier property + +Influences how quickly the player's charisma level (not exp) scales + +Signature: + +```typescript +CharismaLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.classgymexpgain.md b/markdown/bitburner.bitnodemultipliers.classgymexpgain.md new file mode 100644 index 000000000..91cfa80cb --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.classgymexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ClassGymExpGain](./bitburner.bitnodemultipliers.classgymexpgain.md) + +## BitNodeMultipliers.ClassGymExpGain property + +Influences the experience gained for each ability when a player completes a class. + +Signature: + +```typescript +ClassGymExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md b/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md new file mode 100644 index 000000000..dab83a4f6 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.codingcontractmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) + +## BitNodeMultipliers.CodingContractMoney property + +Influences the amount of money gained from completing Coding Contracts + +Signature: + +```typescript +CodingContractMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md b/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md new file mode 100644 index 000000000..d24fed4b2 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.companyworkexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CompanyWorkExpGain](./bitburner.bitnodemultipliers.companyworkexpgain.md) + +## BitNodeMultipliers.CompanyWorkExpGain property + +Influences the experience gained for each ability when the player completes working their job. + +Signature: + +```typescript +CompanyWorkExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.companyworkmoney.md b/markdown/bitburner.bitnodemultipliers.companyworkmoney.md new file mode 100644 index 000000000..be534d6c3 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.companyworkmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md) + +## BitNodeMultipliers.CompanyWorkMoney property + +Influences how much money the player earns when completing working their job. + +Signature: + +```typescript +CompanyWorkMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.corporationvaluation.md b/markdown/bitburner.bitnodemultipliers.corporationvaluation.md new file mode 100644 index 000000000..b9be862b8 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.corporationvaluation.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) + +## BitNodeMultipliers.CorporationValuation property + +Influences the valuation of corporations created by the player. + +Signature: + +```typescript +CorporationValuation: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.crimeexpgain.md b/markdown/bitburner.bitnodemultipliers.crimeexpgain.md new file mode 100644 index 000000000..472819f16 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.crimeexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md) + +## BitNodeMultipliers.CrimeExpGain property + +Influences the base experience gained for each ability when the player commits a crime. + +Signature: + +```typescript +CrimeExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.crimemoney.md b/markdown/bitburner.bitnodemultipliers.crimemoney.md new file mode 100644 index 000000000..c3fffbdac --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.crimemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) + +## BitNodeMultipliers.CrimeMoney property + +Influences the base money gained when the player commits a crime. + +Signature: + +```typescript +CrimeMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md b/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md new file mode 100644 index 000000000..b16ad9a81 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.daedalusaugsrequirement.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [DaedalusAugsRequirement](./bitburner.bitnodemultipliers.daedalusaugsrequirement.md) + +## BitNodeMultipliers.DaedalusAugsRequirement property + +Influences how many Augmentations you need in order to get invited to the Daedalus faction + +Signature: + +```typescript +DaedalusAugsRequirement: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md new file mode 100644 index 000000000..6ae574d3c --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.defenselevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [DefenseLevelMultiplier](./bitburner.bitnodemultipliers.defenselevelmultiplier.md) + +## BitNodeMultipliers.DefenseLevelMultiplier property + +Influences how quickly the player's defense level (not exp) scales + +Signature: + +```typescript +DefenseLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md new file mode 100644 index 000000000..2d1c6f2db --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.dexteritylevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [DexterityLevelMultiplier](./bitburner.bitnodemultipliers.dexteritylevelmultiplier.md) + +## BitNodeMultipliers.DexterityLevelMultiplier property + +Influences how quickly the player's dexterity level (not exp) scales + +Signature: + +```typescript +DexterityLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md b/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md new file mode 100644 index 000000000..0ae7112d6 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.factionpassiverepgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FactionPassiveRepGain](./bitburner.bitnodemultipliers.factionpassiverepgain.md) + +## BitNodeMultipliers.FactionPassiveRepGain property + +Influences how much rep the player gains in each faction simply by being a member. + +Signature: + +```typescript +FactionPassiveRepGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md b/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md new file mode 100644 index 000000000..0c248a1b9 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.factionworkexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FactionWorkExpGain](./bitburner.bitnodemultipliers.factionworkexpgain.md) + +## BitNodeMultipliers.FactionWorkExpGain property + +Influences the experience gained for each ability when the player completes work for a Faction. + +Signature: + +```typescript +FactionWorkExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md b/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md new file mode 100644 index 000000000..7de8b0d31 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.factionworkrepgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) + +## BitNodeMultipliers.FactionWorkRepGain property + +Influences how much rep the player gains when performing work for a faction. + +Signature: + +```typescript +FactionWorkRepGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md b/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md new file mode 100644 index 000000000..640bc066a --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.foursigmamarketdataapicost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md) + +## BitNodeMultipliers.FourSigmaMarketDataApiCost property + +Influences how much it costs to unlock the stock market's 4S Market Data API + +Signature: + +```typescript +FourSigmaMarketDataApiCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md b/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md new file mode 100644 index 000000000..781f09ad3 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.foursigmamarketdatacost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md) + +## BitNodeMultipliers.FourSigmaMarketDataCost property + +Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) + +Signature: + +```typescript +FourSigmaMarketDataCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.hackexpgain.md b/markdown/bitburner.bitnodemultipliers.hackexpgain.md new file mode 100644 index 000000000..b31f69168 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.hackexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) + +## BitNodeMultipliers.HackExpGain property + +Influences the experienced gained when hacking a server. + +Signature: + +```typescript +HackExpGain: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md new file mode 100644 index 000000000..ae7779522 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.hackinglevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) + +## BitNodeMultipliers.HackingLevelMultiplier property + +Influences how quickly the player's hacking level (not experience) scales + +Signature: + +```typescript +HackingLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md b/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md new file mode 100644 index 000000000..314143a8f --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.hacknetnodemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) + +## BitNodeMultipliers.HacknetNodeMoney property + +Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) + +Signature: + +```typescript +HacknetNodeMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md b/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md new file mode 100644 index 000000000..b911069be --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.homecomputerramcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [HomeComputerRamCost](./bitburner.bitnodemultipliers.homecomputerramcost.md) + +## BitNodeMultipliers.HomeComputerRamCost property + +Influences how much money it costs to upgrade your home computer's RAM + +Signature: + +```typescript +HomeComputerRamCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md b/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md new file mode 100644 index 000000000..60a00b135 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.infiltrationmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [InfiltrationMoney](./bitburner.bitnodemultipliers.infiltrationmoney.md) + +## BitNodeMultipliers.InfiltrationMoney property + +Influences how much money is gained when the player infiltrates a company. + +Signature: + +```typescript +InfiltrationMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.infiltrationrep.md b/markdown/bitburner.bitnodemultipliers.infiltrationrep.md new file mode 100644 index 000000000..7c357559c --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.infiltrationrep.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [InfiltrationRep](./bitburner.bitnodemultipliers.infiltrationrep.md) + +## BitNodeMultipliers.InfiltrationRep property + +Influences how much rep the player can gain from factions when selling stolen documents and secrets + +Signature: + +```typescript +InfiltrationRep: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.manualhackmoney.md b/markdown/bitburner.bitnodemultipliers.manualhackmoney.md new file mode 100644 index 000000000..ed941abf9 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.manualhackmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md) + +## BitNodeMultipliers.ManualHackMoney property + +Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal. + +Signature: + +```typescript +ManualHackMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.md b/markdown/bitburner.bitnodemultipliers.md new file mode 100644 index 000000000..8a3c63a14 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.md @@ -0,0 +1,57 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) + +## BitNodeMultipliers interface + + +Signature: + +```typescript +interface BitNodeMultipliers +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [AgilityLevelMultiplier](./bitburner.bitnodemultipliers.agilitylevelmultiplier.md) | number | Influences how quickly the player's agility level (not exp) scales | +| [AugmentationMoneyCost](./bitburner.bitnodemultipliers.augmentationmoneycost.md) | number | Influences the base cost to purchase an augmentation. | +| [AugmentationRepCost](./bitburner.bitnodemultipliers.augmentationrepcost.md) | number | Influences the base rep the player must have with a faction to purchase an augmentation. | +| [BladeburnerRank](./bitburner.bitnodemultipliers.bladeburnerrank.md) | number | Influences how quickly the player can gain rank within Bladeburner. | +| [BladeburnerSkillCost](./bitburner.bitnodemultipliers.bladeburnerskillcost.md) | number | Influences the cost of skill levels from Bladeburner. | +| [CharismaLevelMultiplier](./bitburner.bitnodemultipliers.charismalevelmultiplier.md) | number | Influences how quickly the player's charisma level (not exp) scales | +| [ClassGymExpGain](./bitburner.bitnodemultipliers.classgymexpgain.md) | number | Influences the experience gained for each ability when a player completes a class. | +| [CodingContractMoney](./bitburner.bitnodemultipliers.codingcontractmoney.md) | number | Influences the amount of money gained from completing Coding Contracts | +| [CompanyWorkExpGain](./bitburner.bitnodemultipliers.companyworkexpgain.md) | number | Influences the experience gained for each ability when the player completes working their job. | +| [CompanyWorkMoney](./bitburner.bitnodemultipliers.companyworkmoney.md) | number | Influences how much money the player earns when completing working their job. | +| [CorporationValuation](./bitburner.bitnodemultipliers.corporationvaluation.md) | number | Influences the valuation of corporations created by the player. | +| [CrimeExpGain](./bitburner.bitnodemultipliers.crimeexpgain.md) | number | Influences the base experience gained for each ability when the player commits a crime. | +| [CrimeMoney](./bitburner.bitnodemultipliers.crimemoney.md) | number | Influences the base money gained when the player commits a crime. | +| [DaedalusAugsRequirement](./bitburner.bitnodemultipliers.daedalusaugsrequirement.md) | number | Influences how many Augmentations you need in order to get invited to the Daedalus faction | +| [DefenseLevelMultiplier](./bitburner.bitnodemultipliers.defenselevelmultiplier.md) | number | Influences how quickly the player's defense level (not exp) scales | +| [DexterityLevelMultiplier](./bitburner.bitnodemultipliers.dexteritylevelmultiplier.md) | number | Influences how quickly the player's dexterity level (not exp) scales | +| [FactionPassiveRepGain](./bitburner.bitnodemultipliers.factionpassiverepgain.md) | number | Influences how much rep the player gains in each faction simply by being a member. | +| [FactionWorkExpGain](./bitburner.bitnodemultipliers.factionworkexpgain.md) | number | Influences the experience gained for each ability when the player completes work for a Faction. | +| [FactionWorkRepGain](./bitburner.bitnodemultipliers.factionworkrepgain.md) | number | Influences how much rep the player gains when performing work for a faction. | +| [FourSigmaMarketDataApiCost](./bitburner.bitnodemultipliers.foursigmamarketdataapicost.md) | number | Influences how much it costs to unlock the stock market's 4S Market Data API | +| [FourSigmaMarketDataCost](./bitburner.bitnodemultipliers.foursigmamarketdatacost.md) | number | Influences how much it costs to unlock the stock market's 4S Market Data (NOT API) | +| [HackExpGain](./bitburner.bitnodemultipliers.hackexpgain.md) | number | Influences the experienced gained when hacking a server. | +| [HackingLevelMultiplier](./bitburner.bitnodemultipliers.hackinglevelmultiplier.md) | number | Influences how quickly the player's hacking level (not experience) scales | +| [HacknetNodeMoney](./bitburner.bitnodemultipliers.hacknetnodemoney.md) | number | Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9) | +| [HomeComputerRamCost](./bitburner.bitnodemultipliers.homecomputerramcost.md) | number | Influences how much money it costs to upgrade your home computer's RAM | +| [InfiltrationMoney](./bitburner.bitnodemultipliers.infiltrationmoney.md) | number | Influences how much money is gained when the player infiltrates a company. | +| [InfiltrationRep](./bitburner.bitnodemultipliers.infiltrationrep.md) | number | Influences how much rep the player can gain from factions when selling stolen documents and secrets | +| [ManualHackMoney](./bitburner.bitnodemultipliers.manualhackmoney.md) | number | Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal. | +| [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) | number | Influence how much it costs to purchase a server | +| [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) | number | Influences the maximum number of purchased servers you can have | +| [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) | number | Influences the maximum allowed RAM for a purchased server | +| [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) | number | Influences the minimum favor the player must have with a faction before they can donate to gain rep. | +| [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) | number | Influences how much money can be stolen from a server when a script performs a hack against it. | +| [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) | number | Influences the growth percentage per cycle against a server. | +| [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) | number | Influences the maxmimum money that a server can grow to. | +| [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) | number | Influences the initial money that a server starts with. | +| [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) | number | Influences the initial security level (hackDifficulty) of a server. | +| [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) | number | Influences the weaken amount per invocation against a server. | +| [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) | number | Influences how quickly the player's strength level (not exp) scales | + diff --git a/markdown/bitburner.bitnodemultipliers.purchasedservercost.md b/markdown/bitburner.bitnodemultipliers.purchasedservercost.md new file mode 100644 index 000000000..3881f4ba7 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.purchasedservercost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerCost](./bitburner.bitnodemultipliers.purchasedservercost.md) + +## BitNodeMultipliers.PurchasedServerCost property + +Influence how much it costs to purchase a server + +Signature: + +```typescript +PurchasedServerCost: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md b/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md new file mode 100644 index 000000000..fdaf15067 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.purchasedserverlimit.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerLimit](./bitburner.bitnodemultipliers.purchasedserverlimit.md) + +## BitNodeMultipliers.PurchasedServerLimit property + +Influences the maximum number of purchased servers you can have + +Signature: + +```typescript +PurchasedServerLimit: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md b/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md new file mode 100644 index 000000000..91913734c --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.purchasedservermaxram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [PurchasedServerMaxRam](./bitburner.bitnodemultipliers.purchasedservermaxram.md) + +## BitNodeMultipliers.PurchasedServerMaxRam property + +Influences the maximum allowed RAM for a purchased server + +Signature: + +```typescript +PurchasedServerMaxRam: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md b/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md new file mode 100644 index 000000000..35f28e704 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.reptodonatetofaction.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [RepToDonateToFaction](./bitburner.bitnodemultipliers.reptodonatetofaction.md) + +## BitNodeMultipliers.RepToDonateToFaction property + +Influences the minimum favor the player must have with a faction before they can donate to gain rep. + +Signature: + +```typescript +RepToDonateToFaction: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.scripthackmoney.md b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md new file mode 100644 index 000000000..2216e1c60 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.scripthackmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ScriptHackMoney](./bitburner.bitnodemultipliers.scripthackmoney.md) + +## BitNodeMultipliers.ScriptHackMoney property + +Influences how much money can be stolen from a server when a script performs a hack against it. + +Signature: + +```typescript +ScriptHackMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.servergrowthrate.md b/markdown/bitburner.bitnodemultipliers.servergrowthrate.md new file mode 100644 index 000000000..0f27490f1 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.servergrowthrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerGrowthRate](./bitburner.bitnodemultipliers.servergrowthrate.md) + +## BitNodeMultipliers.ServerGrowthRate property + +Influences the growth percentage per cycle against a server. + +Signature: + +```typescript +ServerGrowthRate: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.servermaxmoney.md b/markdown/bitburner.bitnodemultipliers.servermaxmoney.md new file mode 100644 index 000000000..5a8c3d3eb --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.servermaxmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerMaxMoney](./bitburner.bitnodemultipliers.servermaxmoney.md) + +## BitNodeMultipliers.ServerMaxMoney property + +Influences the maxmimum money that a server can grow to. + +Signature: + +```typescript +ServerMaxMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md b/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md new file mode 100644 index 000000000..c7455592e --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.serverstartingmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerStartingMoney](./bitburner.bitnodemultipliers.serverstartingmoney.md) + +## BitNodeMultipliers.ServerStartingMoney property + +Influences the initial money that a server starts with. + +Signature: + +```typescript +ServerStartingMoney: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md b/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md new file mode 100644 index 000000000..85eed7975 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.serverstartingsecurity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerStartingSecurity](./bitburner.bitnodemultipliers.serverstartingsecurity.md) + +## BitNodeMultipliers.ServerStartingSecurity property + +Influences the initial security level (hackDifficulty) of a server. + +Signature: + +```typescript +ServerStartingSecurity: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.serverweakenrate.md b/markdown/bitburner.bitnodemultipliers.serverweakenrate.md new file mode 100644 index 000000000..152821446 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.serverweakenrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [ServerWeakenRate](./bitburner.bitnodemultipliers.serverweakenrate.md) + +## BitNodeMultipliers.ServerWeakenRate property + +Influences the weaken amount per invocation against a server. + +Signature: + +```typescript +ServerWeakenRate: number; +``` diff --git a/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md b/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md new file mode 100644 index 000000000..379d42239 --- /dev/null +++ b/markdown/bitburner.bitnodemultipliers.strengthlevelmultiplier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) > [StrengthLevelMultiplier](./bitburner.bitnodemultipliers.strengthlevelmultiplier.md) + +## BitNodeMultipliers.StrengthLevelMultiplier property + +Influences how quickly the player's strength level (not exp) scales + +Signature: + +```typescript +StrengthLevelMultiplier: number; +``` diff --git a/markdown/bitburner.bladeburner.getactionautolevel.md b/markdown/bitburner.bladeburner.getactionautolevel.md new file mode 100644 index 000000000..34f149737 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionautolevel.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionAutolevel](./bitburner.bladeburner.getactionautolevel.md) + +## Bladeburner.getActionAutolevel() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Return a boolean indicating whether or not this action is currently set to autolevel. + +Returns false if an invalid action is specified. + +Signature: + +```typescript +getActionAutolevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | + +Returns: + +boolean + +True if the action is set to autolevel, and false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getactioncountremaining.md b/markdown/bitburner.bladeburner.getactioncountremaining.md new file mode 100644 index 000000000..18b62d262 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactioncountremaining.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionCountRemaining](./bitburner.bladeburner.getactioncountremaining.md) + +## Bladeburner.getActionCountRemaining() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the remaining count of the specified action. + +Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not. + +Signature: + +```typescript +getActionCountRemaining( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | + +Returns: + +number + +Remaining count of the specified action. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getactioncurrentlevel.md b/markdown/bitburner.bladeburner.getactioncurrentlevel.md new file mode 100644 index 000000000..8927d85e1 --- /dev/null +++ b/markdown/bitburner.bladeburner.getactioncurrentlevel.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionCurrentLevel](./bitburner.bladeburner.getactioncurrentlevel.md) + +## Bladeburner.getActionCurrentLevel() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the current level of this action. + +Returns -1 if an invalid action is specified. + +Signature: + +```typescript +getActionCurrentLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | + +Returns: + +number + +Current level of the specified action. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md new file mode 100644 index 000000000..0db76c3eb --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionestimatedsuccesschance.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionEstimatedSuccessChance](./bitburner.bladeburner.getactionestimatedsuccesschance.md) + +## Bladeburner.getActionEstimatedSuccessChance() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). + +Signature: + +```typescript +getActionEstimatedSuccessChance( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | + +Returns: + +number + +Estimated success chance for the specified action. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getactionmaxlevel.md b/markdown/bitburner.bladeburner.getactionmaxlevel.md new file mode 100644 index 000000000..04950ad2f --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionmaxlevel.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionMaxLevel](./bitburner.bladeburner.getactionmaxlevel.md) + +## Bladeburner.getActionMaxLevel() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the maximum level for this action. + +Returns -1 if an invalid action is specified. + +Signature: + +```typescript +getActionMaxLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | + +Returns: + +number + +Maximum level of the specified action. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getactionrepgain.md b/markdown/bitburner.bladeburner.getactionrepgain.md new file mode 100644 index 000000000..c6d7da2da --- /dev/null +++ b/markdown/bitburner.bladeburner.getactionrepgain.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionRepGain](./bitburner.bladeburner.getactionrepgain.md) + +## Bladeburner.getActionRepGain() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value. + +Signature: + +```typescript +getActionRepGain( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + level: number, + ): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| level | number | Optional action level at which to calculate the gain | + +Returns: + +number + +Average Bladeburner reputation gain for successfully completing the specified action. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getactiontime.md b/markdown/bitburner.bladeburner.getactiontime.md new file mode 100644 index 000000000..38fe1ac5a --- /dev/null +++ b/markdown/bitburner.bladeburner.getactiontime.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getActionTime](./bitburner.bladeburner.getactiontime.md) + +## Bladeburner.getActionTime() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the number of seconds it takes to complete the specified action + +Signature: + +```typescript +getActionTime( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | + +Returns: + +number + +Number of seconds it takes to complete the specified action. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getblackopnames.md b/markdown/bitburner.bladeburner.getblackopnames.md new file mode 100644 index 000000000..6314d6a36 --- /dev/null +++ b/markdown/bitburner.bladeburner.getblackopnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getBlackOpNames](./bitburner.bladeburner.getblackopnames.md) + +## Bladeburner.getBlackOpNames() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns an array of strings containing the names of all Bladeburner Black Ops. + +Signature: + +```typescript +getBlackOpNames(): BladeburnerBlackOps[]; +``` +Returns: + +[BladeburnerBlackOps](./bitburner.bladeburnerblackops.md)\[\] + +Array of strings containing the names of all Bladeburner Black Ops. + +## Remarks + +0.4 GB + diff --git a/markdown/bitburner.bladeburner.getblackoprank.md b/markdown/bitburner.bladeburner.getblackoprank.md new file mode 100644 index 000000000..7f58b403a --- /dev/null +++ b/markdown/bitburner.bladeburner.getblackoprank.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getBlackOpRank](./bitburner.bladeburner.getblackoprank.md) + +## Bladeburner.getBlackOpRank() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the rank required to complete this BlackOp. + +Returns -1 if an invalid action is specified. + +Signature: + +```typescript +getBlackOpRank(name: BladeburnerBlackOps): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of BlackOp. Must be an exact match. | + +Returns: + +number + +Rank required to complete this BlackOp. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.bladeburner.getbonustime.md b/markdown/bitburner.bladeburner.getbonustime.md new file mode 100644 index 000000000..cb16d21e0 --- /dev/null +++ b/markdown/bitburner.bladeburner.getbonustime.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getBonusTime](./bitburner.bladeburner.getbonustime.md) + +## Bladeburner.getBonusTime() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. + +“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. + +“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. + +Signature: + +```typescript +getBonusTime(): number; +``` +Returns: + +number + +Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.bladeburner.getcity.md b/markdown/bitburner.bladeburner.getcity.md new file mode 100644 index 000000000..8fb65121b --- /dev/null +++ b/markdown/bitburner.bladeburner.getcity.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCity](./bitburner.bladeburner.getcity.md) + +## Bladeburner.getCity() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the city that the player is currently in (for Bladeburner). + +Signature: + +```typescript +getCity(): City; +``` +Returns: + +[City](./bitburner.city.md) + +City that the player is currently in (for Bladeburner). + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getcitychaos.md b/markdown/bitburner.bladeburner.getcitychaos.md new file mode 100644 index 000000000..61c2f575e --- /dev/null +++ b/markdown/bitburner.bladeburner.getcitychaos.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCityChaos](./bitburner.bladeburner.getcitychaos.md) + +## Bladeburner.getCityChaos() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the chaos in the specified city, or -1 if an invalid city was specified. + +Signature: + +```typescript +getCityChaos(name: City): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [City](./bitburner.city.md) | | + +Returns: + +number + +Chaos in the specified city. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getcitycommunities.md b/markdown/bitburner.bladeburner.getcitycommunities.md new file mode 100644 index 000000000..88addcc9e --- /dev/null +++ b/markdown/bitburner.bladeburner.getcitycommunities.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCityCommunities](./bitburner.bladeburner.getcitycommunities.md) + +## Bladeburner.getCityCommunities() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified. + +Signature: + +```typescript +getCityCommunities(name: City): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [City](./bitburner.city.md) | | + +Returns: + +number + +Number of Synthoids communities in the specified city. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getcityestimatedpopulation.md b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md new file mode 100644 index 000000000..3305effa3 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcityestimatedpopulation.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCityEstimatedPopulation](./bitburner.bladeburner.getcityestimatedpopulation.md) + +## Bladeburner.getCityEstimatedPopulation() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified. + +Signature: + +```typescript +getCityEstimatedPopulation(name: City): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [City](./bitburner.city.md) | | + +Returns: + +number + +Estimated number of Synthoids in the specified city. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getcontractnames.md b/markdown/bitburner.bladeburner.getcontractnames.md new file mode 100644 index 000000000..b96248f57 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcontractnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getContractNames](./bitburner.bladeburner.getcontractnames.md) + +## Bladeburner.getContractNames() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns an array of strings containing the names of all Bladeburner contracts. + +Signature: + +```typescript +getContractNames(): BladeburnerContracts[]; +``` +Returns: + +[BladeburnerContracts](./bitburner.bladeburnercontracts.md)\[\] + +Array of strings containing the names of all Bladeburner contracts. + +## Remarks + +0.4 GB + diff --git a/markdown/bitburner.bladeburner.getcurrentaction.md b/markdown/bitburner.bladeburner.getcurrentaction.md new file mode 100644 index 000000000..541827683 --- /dev/null +++ b/markdown/bitburner.bladeburner.getcurrentaction.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getCurrentAction](./bitburner.bladeburner.getcurrentaction.md) + +## Bladeburner.getCurrentAction() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”. + +Signature: + +```typescript +getCurrentAction(): BladeburnerCurAction; +``` +Returns: + +[BladeburnerCurAction](./bitburner.bladeburnercuraction.md) + +Object that represents the player’s current Bladeburner action. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.bladeburner.getgeneralactionnames.md b/markdown/bitburner.bladeburner.getgeneralactionnames.md new file mode 100644 index 000000000..80fd46e95 --- /dev/null +++ b/markdown/bitburner.bladeburner.getgeneralactionnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getGeneralActionNames](./bitburner.bladeburner.getgeneralactionnames.md) + +## Bladeburner.getGeneralActionNames() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns an array of strings containing the names of all general Bladeburner actions. + +Signature: + +```typescript +getGeneralActionNames(): BladeburnerGenActions[]; +``` +Returns: + +[BladeburnerGenActions](./bitburner.bladeburnergenactions.md)\[\] + +Array of strings containing the names of all general Bladeburner actions. + +## Remarks + +0.4 GB + diff --git a/markdown/bitburner.bladeburner.getoperationnames.md b/markdown/bitburner.bladeburner.getoperationnames.md new file mode 100644 index 000000000..f6bd166a3 --- /dev/null +++ b/markdown/bitburner.bladeburner.getoperationnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getOperationNames](./bitburner.bladeburner.getoperationnames.md) + +## Bladeburner.getOperationNames() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns an array of strings containing the names of all Bladeburner operations. + +Signature: + +```typescript +getOperationNames(): BladeburnerOperations[]; +``` +Returns: + +[BladeburnerOperations](./bitburner.bladeburneroperations.md)\[\] + +Array of strings containing the names of all Bladeburner operations. + +## Remarks + +0.4 GB + diff --git a/markdown/bitburner.bladeburner.getrank.md b/markdown/bitburner.bladeburner.getrank.md new file mode 100644 index 000000000..4fa764544 --- /dev/null +++ b/markdown/bitburner.bladeburner.getrank.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getRank](./bitburner.bladeburner.getrank.md) + +## Bladeburner.getRank() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the player’s Bladeburner Rank. + +Signature: + +```typescript +getRank(): number; +``` +Returns: + +number + +Player’s Bladeburner Rank. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getskilllevel.md b/markdown/bitburner.bladeburner.getskilllevel.md new file mode 100644 index 000000000..249799df9 --- /dev/null +++ b/markdown/bitburner.bladeburner.getskilllevel.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getSkillLevel](./bitburner.bladeburner.getskilllevel.md) + +## Bladeburner.getSkillLevel() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +This function returns your level in the specified skill. + +The function returns -1 if an invalid skill name is passed in. + +Signature: + +```typescript +getSkillLevel(name: BladeburnerSkills): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | + +Returns: + +number + +Level in the specified skill. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getskillnames.md b/markdown/bitburner.bladeburner.getskillnames.md new file mode 100644 index 000000000..8ca0f6b9e --- /dev/null +++ b/markdown/bitburner.bladeburner.getskillnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getSkillNames](./bitburner.bladeburner.getskillnames.md) + +## Bladeburner.getSkillNames() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns an array of strings containing the names of all general Bladeburner skills. + +Signature: + +```typescript +getSkillNames(): BladeburnerSkills[]; +``` +Returns: + +[BladeburnerSkills](./bitburner.bladeburnerskills.md)\[\] + +Array of strings containing the names of all general Bladeburner skills. + +## Remarks + +0.4 GB + diff --git a/markdown/bitburner.bladeburner.getskillpoints.md b/markdown/bitburner.bladeburner.getskillpoints.md new file mode 100644 index 000000000..145fca00c --- /dev/null +++ b/markdown/bitburner.bladeburner.getskillpoints.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getSkillPoints](./bitburner.bladeburner.getskillpoints.md) + +## Bladeburner.getSkillPoints() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the number of Bladeburner skill points you have. + +Signature: + +```typescript +getSkillPoints(): number; +``` +Returns: + +number + +Number of Bladeburner skill points you have. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getskillupgradecost.md b/markdown/bitburner.bladeburner.getskillupgradecost.md new file mode 100644 index 000000000..c1d11a97b --- /dev/null +++ b/markdown/bitburner.bladeburner.getskillupgradecost.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getSkillUpgradeCost](./bitburner.bladeburner.getskillupgradecost.md) + +## Bladeburner.getSkillUpgradeCost() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +This function returns the number of skill points needed to upgrade the specified skill. + +The function returns -1 if an invalid skill name is passed in. + +Signature: + +```typescript +getSkillUpgradeCost(name: BladeburnerSkills): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | + +Returns: + +number + +Number of skill points needed to upgrade the specified skill. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.getstamina.md b/markdown/bitburner.bladeburner.getstamina.md new file mode 100644 index 000000000..89ce3f828 --- /dev/null +++ b/markdown/bitburner.bladeburner.getstamina.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getStamina](./bitburner.bladeburner.getstamina.md) + +## Bladeburner.getStamina() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns an array with two elements: \* \[Current stamina, Max stamina\] + +Signature: + +```typescript +getStamina(): [number, number]; +``` +Returns: + +\[number, number\] + +Array containing current stamina and max stamina. + +## Remarks + +4 GB + +## Example + + +```js +function getStaminaPercentage() { + let res = bladeburner.getStamina(); + return res[0] / res[1]; +} +``` + diff --git a/markdown/bitburner.bladeburner.getteamsize.md b/markdown/bitburner.bladeburner.getteamsize.md new file mode 100644 index 000000000..309e8b130 --- /dev/null +++ b/markdown/bitburner.bladeburner.getteamsize.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [getTeamSize](./bitburner.bladeburner.getteamsize.md) + +## Bladeburner.getTeamSize() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Returns the number of Bladeburner team members you have assigned to the specified action. + +Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types. + +Signature: + +```typescript +getTeamSize( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | + +Returns: + +number + +Number of Bladeburner team members that were assigned to the specified action. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.joinbladeburnerdivision.md b/markdown/bitburner.bladeburner.joinbladeburnerdivision.md new file mode 100644 index 000000000..2cd16cd8d --- /dev/null +++ b/markdown/bitburner.bladeburner.joinbladeburnerdivision.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [joinBladeburnerDivision](./bitburner.bladeburner.joinbladeburnerdivision.md) + +## Bladeburner.joinBladeburnerDivision() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Attempts to join the Bladeburner division. + +Returns true if you successfully join the Bladeburner division, or if you are already a member. + +Returns false otherwise. + +Signature: + +```typescript +joinBladeburnerDivision(): boolean; +``` +Returns: + +boolean + +True if you successfully join the Bladeburner division, or if you are already a member, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.joinbladeburnerfaction.md b/markdown/bitburner.bladeburner.joinbladeburnerfaction.md new file mode 100644 index 000000000..3565c328a --- /dev/null +++ b/markdown/bitburner.bladeburner.joinbladeburnerfaction.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [joinBladeburnerFaction](./bitburner.bladeburner.joinbladeburnerfaction.md) + +## Bladeburner.joinBladeburnerFaction() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Attempts to join the Bladeburner faction. + +Returns true if you successfully join the Bladeburner faction, or if you are already a member. + +Returns false otherwise. + +Signature: + +```typescript +joinBladeburnerFaction(): boolean; +``` +Returns: + +boolean + +True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.md b/markdown/bitburner.bladeburner.md new file mode 100644 index 000000000..42b969478 --- /dev/null +++ b/markdown/bitburner.bladeburner.md @@ -0,0 +1,51 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) + +## Bladeburner interface + +Signature: + +```typescript +export interface Bladeburner +``` + +## Methods + +| Method | Description | +| --- | --- | +| [getActionAutolevel(type, name)](./bitburner.bladeburner.getactionautolevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Return a boolean indicating whether or not this action is currently set to autolevel.Returns false if an invalid action is specified. | +| [getActionCountRemaining(type, name)](./bitburner.bladeburner.getactioncountremaining.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the remaining count of the specified action.Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not. | +| [getActionCurrentLevel(type, name)](./bitburner.bladeburner.getactioncurrentlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the current level of this action.Returns -1 if an invalid action is specified. | +| [getActionEstimatedSuccessChance(type, name)](./bitburner.bladeburner.getactionestimatedsuccesschance.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). | +| [getActionMaxLevel(type, name)](./bitburner.bladeburner.getactionmaxlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the maximum level for this action.Returns -1 if an invalid action is specified. | +| [getActionRepGain(type, name, level)](./bitburner.bladeburner.getactionrepgain.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value. | +| [getActionTime(type, name)](./bitburner.bladeburner.getactiontime.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of seconds it takes to complete the specified action | +| [getBlackOpNames()](./bitburner.bladeburner.getblackopnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner Black Ops. | +| [getBlackOpRank(name)](./bitburner.bladeburner.getblackoprank.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the rank required to complete this BlackOp.Returns -1 if an invalid action is specified. | +| [getBonusTime()](./bitburner.bladeburner.getbonustime.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.“Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. | +| [getCity()](./bitburner.bladeburner.getcity.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the city that the player is currently in (for Bladeburner). | +| [getCityChaos(name)](./bitburner.bladeburner.getcitychaos.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the chaos in the specified city, or -1 if an invalid city was specified. | +| [getCityCommunities(name)](./bitburner.bladeburner.getcitycommunities.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified. | +| [getCityEstimatedPopulation(name)](./bitburner.bladeburner.getcityestimatedpopulation.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified. | +| [getContractNames()](./bitburner.bladeburner.getcontractnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner contracts. | +| [getCurrentAction()](./bitburner.bladeburner.getcurrentaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”. | +| [getGeneralActionNames()](./bitburner.bladeburner.getgeneralactionnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all general Bladeburner actions. | +| [getOperationNames()](./bitburner.bladeburner.getoperationnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all Bladeburner operations. | +| [getRank()](./bitburner.bladeburner.getrank.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the player’s Bladeburner Rank. | +| [getSkillLevel(name)](./bitburner.bladeburner.getskilllevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.This function returns your level in the specified skill.The function returns -1 if an invalid skill name is passed in. | +| [getSkillNames()](./bitburner.bladeburner.getskillnames.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array of strings containing the names of all general Bladeburner skills. | +| [getSkillPoints()](./bitburner.bladeburner.getskillpoints.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of Bladeburner skill points you have. | +| [getSkillUpgradeCost(name)](./bitburner.bladeburner.getskillupgradecost.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.This function returns the number of skill points needed to upgrade the specified skill.The function returns -1 if an invalid skill name is passed in. | +| [getStamina()](./bitburner.bladeburner.getstamina.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns an array with two elements: \* \[Current stamina, Max stamina\] | +| [getTeamSize(type, name)](./bitburner.bladeburner.getteamsize.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Returns the number of Bladeburner team members you have assigned to the specified action.Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types. | +| [joinBladeburnerDivision()](./bitburner.bladeburner.joinbladeburnerdivision.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to join the Bladeburner division.Returns true if you successfully join the Bladeburner division, or if you are already a member.Returns false otherwise. | +| [joinBladeburnerFaction()](./bitburner.bladeburner.joinbladeburnerfaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to join the Bladeburner faction.Returns true if you successfully join the Bladeburner faction, or if you are already a member.Returns false otherwise. | +| [setActionAutolevel(type, name, autoLevel)](./bitburner.bladeburner.setactionautolevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Enable/disable autoleveling for the specified action. | +| [setActionLevel(type, name, level)](./bitburner.bladeburner.setactionlevel.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Set the level for the specified action. | +| [setTeamSize(type, name, size)](./bitburner.bladeburner.setteamsize.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Set the team size for the specified Bladeburner action.Returns the team size that was set, or -1 if the function failed. | +| [startAction(type, name)](./bitburner.bladeburner.startaction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise. | +| [stopBladeburnerAction()](./bitburner.bladeburner.stopbladeburneraction.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Stops the current Bladeburner action. | +| [switchCity(name)](./bitburner.bladeburner.switchcity.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to switch to the specified city (for Bladeburner only).Returns true if successful, and false otherwise | +| [upgradeSkill(name)](./bitburner.bladeburner.upgradeskill.md) | You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.Attempts to upgrade the specified Bladeburner skill.Returns true if the skill is successfully upgraded, and false otherwise. | + diff --git a/markdown/bitburner.bladeburner.setactionautolevel.md b/markdown/bitburner.bladeburner.setactionautolevel.md new file mode 100644 index 000000000..f61ca5c3e --- /dev/null +++ b/markdown/bitburner.bladeburner.setactionautolevel.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [setActionAutolevel](./bitburner.bladeburner.setactionautolevel.md) + +## Bladeburner.setActionAutolevel() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Enable/disable autoleveling for the specified action. + +Signature: + +```typescript +setActionAutolevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + autoLevel: boolean, + ): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| autoLevel | boolean | Whether or not to autolevel this action | + +Returns: + +void + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.setactionlevel.md b/markdown/bitburner.bladeburner.setactionlevel.md new file mode 100644 index 000000000..17f9e16c8 --- /dev/null +++ b/markdown/bitburner.bladeburner.setactionlevel.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [setActionLevel](./bitburner.bladeburner.setactionlevel.md) + +## Bladeburner.setActionLevel() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Set the level for the specified action. + +Signature: + +```typescript +setActionLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + level: number, + ): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| level | number | Level to set this action to. | + +Returns: + +void + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.setteamsize.md b/markdown/bitburner.bladeburner.setteamsize.md new file mode 100644 index 000000000..c8535df9e --- /dev/null +++ b/markdown/bitburner.bladeburner.setteamsize.md @@ -0,0 +1,40 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [setTeamSize](./bitburner.bladeburner.setteamsize.md) + +## Bladeburner.setTeamSize() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Set the team size for the specified Bladeburner action. + +Returns the team size that was set, or -1 if the function failed. + +Signature: + +```typescript +setTeamSize( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + size: number, + ): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match. | +| size | number | Number of team members to set. Will be converted using Math.round(). | + +Returns: + +number + +Number of Bladeburner team members you assigned to the specified action. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.startaction.md b/markdown/bitburner.bladeburner.startaction.md new file mode 100644 index 000000000..f6e015086 --- /dev/null +++ b/markdown/bitburner.bladeburner.startaction.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [startAction](./bitburner.bladeburner.startaction.md) + +## Bladeburner.startAction() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise. + +Signature: + +```typescript +startAction( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| type | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | Type of action. | +| name | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of action. Must be an exact match | + +Returns: + +boolean + +True if the action was started successfully, and false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.stopbladeburneraction.md b/markdown/bitburner.bladeburner.stopbladeburneraction.md new file mode 100644 index 000000000..6f15aa4de --- /dev/null +++ b/markdown/bitburner.bladeburner.stopbladeburneraction.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [stopBladeburnerAction](./bitburner.bladeburner.stopbladeburneraction.md) + +## Bladeburner.stopBladeburnerAction() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Stops the current Bladeburner action. + +Signature: + +```typescript +stopBladeburnerAction(): void; +``` +Returns: + +void + +## Remarks + +2 GB + diff --git a/markdown/bitburner.bladeburner.switchcity.md b/markdown/bitburner.bladeburner.switchcity.md new file mode 100644 index 000000000..5b68c5708 --- /dev/null +++ b/markdown/bitburner.bladeburner.switchcity.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [switchCity](./bitburner.bladeburner.switchcity.md) + +## Bladeburner.switchCity() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Attempts to switch to the specified city (for Bladeburner only). + +Returns true if successful, and false otherwise + +Signature: + +```typescript +switchCity(name: City): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [City](./bitburner.city.md) | | + +Returns: + +boolean + +true if successful, and false otherwise + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburner.upgradeskill.md b/markdown/bitburner.bladeburner.upgradeskill.md new file mode 100644 index 000000000..fcf11c402 --- /dev/null +++ b/markdown/bitburner.bladeburner.upgradeskill.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Bladeburner](./bitburner.bladeburner.md) > [upgradeSkill](./bitburner.bladeburner.upgradeskill.md) + +## Bladeburner.upgradeSkill() method + +You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function. + +Attempts to upgrade the specified Bladeburner skill. + +Returns true if the skill is successfully upgraded, and false otherwise. + +Signature: + +```typescript +upgradeSkill(name: BladeburnerSkills): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | + +Returns: + +boolean + +true if the skill is successfully upgraded, and false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.bladeburneracttypes.md b/markdown/bitburner.bladeburneracttypes.md new file mode 100644 index 000000000..5156e49f4 --- /dev/null +++ b/markdown/bitburner.bladeburneracttypes.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) + +## BladeburnerActTypes type + +Signature: + +```typescript +type BladeburnerActTypes = "contracts" | "operations" | "black ops" | "general"; +``` diff --git a/markdown/bitburner.bladeburnerblackops.md b/markdown/bitburner.bladeburnerblackops.md new file mode 100644 index 000000000..f60c99235 --- /dev/null +++ b/markdown/bitburner.bladeburnerblackops.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) + +## BladeburnerBlackOps type + +Signature: + +```typescript +type BladeburnerBlackOps = + | "Operation Typhoon" + | "Operation Zero" + | "Operation X" + | "Operation Titan" + | "Operation Ares" + | "Operation Archangel" + | "Operation Juggernaut" + | "Operation Red Dragon" + | "Operation K" + | "Operation Deckard" + | "Operation Tyrell" + | "Operation Wallace" + | "Operation Shoulder of Orion" + | "Operation Hyron" + | "Operation Morpheus" + | "Operation Ion Storm" + | "Operation Annihilus" + | "Operation Ultron" + | "Operation Centurion" + | "Operation Vindictus" + | "Operation Daedalus"; +``` diff --git a/markdown/bitburner.bladeburnercontracts.md b/markdown/bitburner.bladeburnercontracts.md new file mode 100644 index 000000000..ae593a253 --- /dev/null +++ b/markdown/bitburner.bladeburnercontracts.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerContracts](./bitburner.bladeburnercontracts.md) + +## BladeburnerContracts type + +Signature: + +```typescript +type BladeburnerContracts = "Tracking" | "Bounty Hunter" | "Retirement"; +``` diff --git a/markdown/bitburner.bladeburnercuraction.md b/markdown/bitburner.bladeburnercuraction.md new file mode 100644 index 000000000..15356500e --- /dev/null +++ b/markdown/bitburner.bladeburnercuraction.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) + +## BladeburnerCurAction interface + + +Signature: + +```typescript +interface BladeburnerCurAction +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [name](./bitburner.bladeburnercuraction.name.md) | [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) \| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) \| [BladeburnerOperations](./bitburner.bladeburneroperations.md) \| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | Name of Action | +| [type](./bitburner.bladeburnercuraction.type.md) | [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) \| "Idle" | Type of Action | + diff --git a/markdown/bitburner.bladeburnercuraction.name.md b/markdown/bitburner.bladeburnercuraction.name.md new file mode 100644 index 000000000..23a38ff9b --- /dev/null +++ b/markdown/bitburner.bladeburnercuraction.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) > [name](./bitburner.bladeburnercuraction.name.md) + +## BladeburnerCurAction.name property + +Name of Action + +Signature: + +```typescript +name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps; +``` diff --git a/markdown/bitburner.bladeburnercuraction.type.md b/markdown/bitburner.bladeburnercuraction.type.md new file mode 100644 index 000000000..0e5078292 --- /dev/null +++ b/markdown/bitburner.bladeburnercuraction.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) > [type](./bitburner.bladeburnercuraction.type.md) + +## BladeburnerCurAction.type property + +Type of Action + +Signature: + +```typescript +type: BladeburnerActTypes | "Idle"; +``` diff --git a/markdown/bitburner.bladeburnergenactions.md b/markdown/bitburner.bladeburnergenactions.md new file mode 100644 index 000000000..702af3c21 --- /dev/null +++ b/markdown/bitburner.bladeburnergenactions.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) + +## BladeburnerGenActions type + +Signature: + +```typescript +type BladeburnerGenActions = + | "Training" + | "Field Analysis" + | "Recruitment" + | "Diplomacy" + | "Hyperbolic Regeneration Chamber"; +``` diff --git a/markdown/bitburner.bladeburneroperations.md b/markdown/bitburner.bladeburneroperations.md new file mode 100644 index 000000000..6a703e6c6 --- /dev/null +++ b/markdown/bitburner.bladeburneroperations.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerOperations](./bitburner.bladeburneroperations.md) + +## BladeburnerOperations type + +Signature: + +```typescript +type BladeburnerOperations = + | "Investigation" + | "Undercover Operation" + | "Sting Operation" + | "Raid" + | "Stealth Retirement Operation" + | "Assassination"; +``` diff --git a/markdown/bitburner.bladeburnerskills.md b/markdown/bitburner.bladeburnerskills.md new file mode 100644 index 000000000..778cac7df --- /dev/null +++ b/markdown/bitburner.bladeburnerskills.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [BladeburnerSkills](./bitburner.bladeburnerskills.md) + +## BladeburnerSkills type + +Signature: + +```typescript +type BladeburnerSkills = + | "Blade's Intuition" + | "Cloak" + | "Marksman" + | "Weapon Proficiency" + | "Short-Circuit" + | "Digital Observer" + | "Tracer" + | "Overclock" + | "Reaper" + | "Evasive System" + | "Datamancer" + | "Cyber's Edge" + | "Hands of Midas" + | "Hyperdrive"; +``` diff --git a/markdown/bitburner.characterinfo.bitnode.md b/markdown/bitburner.characterinfo.bitnode.md new file mode 100644 index 000000000..846bfaa43 --- /dev/null +++ b/markdown/bitburner.characterinfo.bitnode.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [bitnode](./bitburner.characterinfo.bitnode.md) + +## CharacterInfo.bitnode property + +Current BitNode number + +Signature: + +```typescript +bitnode: number; +``` diff --git a/markdown/bitburner.characterinfo.city.md b/markdown/bitburner.characterinfo.city.md new file mode 100644 index 000000000..1a5e41ed3 --- /dev/null +++ b/markdown/bitburner.characterinfo.city.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [city](./bitburner.characterinfo.city.md) + +## CharacterInfo.city property + +Name of city you are currently in + +Signature: + +```typescript +city: City; +``` diff --git a/markdown/bitburner.characterinfo.company.md b/markdown/bitburner.characterinfo.company.md new file mode 100644 index 000000000..dd9555acb --- /dev/null +++ b/markdown/bitburner.characterinfo.company.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [company](./bitburner.characterinfo.company.md) + +## CharacterInfo.company property + +Array of all companies at which you have jobs + +Signature: + +```typescript +company: CompanyName[]; +``` diff --git a/markdown/bitburner.characterinfo.factions.md b/markdown/bitburner.characterinfo.factions.md new file mode 100644 index 000000000..225b9e789 --- /dev/null +++ b/markdown/bitburner.characterinfo.factions.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [factions](./bitburner.characterinfo.factions.md) + +## CharacterInfo.factions property + +Array of factions you are currently a member of + +Signature: + +```typescript +factions: FactionName[]; +``` diff --git a/markdown/bitburner.characterinfo.hp.md b/markdown/bitburner.characterinfo.hp.md new file mode 100644 index 000000000..5425ec5c2 --- /dev/null +++ b/markdown/bitburner.characterinfo.hp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [hp](./bitburner.characterinfo.hp.md) + +## CharacterInfo.hp property + +Current health points + +Signature: + +```typescript +hp: number; +``` diff --git a/markdown/bitburner.characterinfo.jobtitle.md b/markdown/bitburner.characterinfo.jobtitle.md new file mode 100644 index 000000000..1cd212d12 --- /dev/null +++ b/markdown/bitburner.characterinfo.jobtitle.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [jobTitle](./bitburner.characterinfo.jobtitle.md) + +## CharacterInfo.jobTitle property + +Array of job positions for all companies you are employed at. Same order as 'jobs' + +Signature: + +```typescript +jobTitle: CompanyField[]; +``` diff --git a/markdown/bitburner.characterinfo.maxhp.md b/markdown/bitburner.characterinfo.maxhp.md new file mode 100644 index 000000000..26aa07e2c --- /dev/null +++ b/markdown/bitburner.characterinfo.maxhp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [maxHp](./bitburner.characterinfo.maxhp.md) + +## CharacterInfo.maxHp property + +Maximum health points + +Signature: + +```typescript +maxHp: number; +``` diff --git a/markdown/bitburner.characterinfo.md b/markdown/bitburner.characterinfo.md new file mode 100644 index 000000000..cf32d5412 --- /dev/null +++ b/markdown/bitburner.characterinfo.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) + +## CharacterInfo interface + +Signature: + +```typescript +interface CharacterInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [bitnode](./bitburner.characterinfo.bitnode.md) | number | Current BitNode number | +| [city](./bitburner.characterinfo.city.md) | [City](./bitburner.city.md) | Name of city you are currently in | +| [company](./bitburner.characterinfo.company.md) | [CompanyName](./bitburner.companyname.md)\[\] | Array of all companies at which you have jobs | +| [factions](./bitburner.characterinfo.factions.md) | [FactionName](./bitburner.factionname.md)\[\] | Array of factions you are currently a member of | +| [hp](./bitburner.characterinfo.hp.md) | number | Current health points | +| [jobTitle](./bitburner.characterinfo.jobtitle.md) | [CompanyField](./bitburner.companyfield.md)\[\] | Array of job positions for all companies you are employed at. Same order as 'jobs' | +| [maxHp](./bitburner.characterinfo.maxhp.md) | number | Maximum health points | +| [mult](./bitburner.characterinfo.mult.md) | [CharacterMult](./bitburner.charactermult.md) | Object with many of the player's multipliers from Augmentations/Source Files | +| [timeWorked](./bitburner.characterinfo.timeworked.md) | number | Timed worked in ms | +| [tor](./bitburner.characterinfo.tor.md) | boolean | Boolean indicating whether or not you have a tor router | +| [workAgiExpGain](./bitburner.characterinfo.workagiexpgain.md) | number | Agi experience earned so far from work | +| [workChaExpGain](./bitburner.characterinfo.workchaexpgain.md) | number | Cha experience earned so far from work | +| [workDefExpGain](./bitburner.characterinfo.workdefexpgain.md) | number | Def experience earned so far from work | +| [workDexExpGain](./bitburner.characterinfo.workdexexpgain.md) | number | Dex experience earned so far from work | +| [workHackExpGain](./bitburner.characterinfo.workhackexpgain.md) | number | Hacking experience earned so far from work | +| [workMoneyGain](./bitburner.characterinfo.workmoneygain.md) | number | Money earned so far from work, if applicable | +| [workRepGain](./bitburner.characterinfo.workrepgain.md) | number | Reputation earned so far from work, if applicable | +| [workStrExpGain](./bitburner.characterinfo.workstrexpgain.md) | number | Str experience earned so far from work | + diff --git a/markdown/bitburner.characterinfo.mult.md b/markdown/bitburner.characterinfo.mult.md new file mode 100644 index 000000000..7d5422c3c --- /dev/null +++ b/markdown/bitburner.characterinfo.mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [mult](./bitburner.characterinfo.mult.md) + +## CharacterInfo.mult property + +Object with many of the player's multipliers from Augmentations/Source Files + +Signature: + +```typescript +mult: CharacterMult; +``` diff --git a/markdown/bitburner.characterinfo.timeworked.md b/markdown/bitburner.characterinfo.timeworked.md new file mode 100644 index 000000000..80243c6a5 --- /dev/null +++ b/markdown/bitburner.characterinfo.timeworked.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [timeWorked](./bitburner.characterinfo.timeworked.md) + +## CharacterInfo.timeWorked property + +Timed worked in ms + +Signature: + +```typescript +timeWorked: number; +``` diff --git a/markdown/bitburner.characterinfo.tor.md b/markdown/bitburner.characterinfo.tor.md new file mode 100644 index 000000000..abbfe3c36 --- /dev/null +++ b/markdown/bitburner.characterinfo.tor.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [tor](./bitburner.characterinfo.tor.md) + +## CharacterInfo.tor property + +Boolean indicating whether or not you have a tor router + +Signature: + +```typescript +tor: boolean; +``` diff --git a/markdown/bitburner.characterinfo.workagiexpgain.md b/markdown/bitburner.characterinfo.workagiexpgain.md new file mode 100644 index 000000000..2587c9b86 --- /dev/null +++ b/markdown/bitburner.characterinfo.workagiexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [workAgiExpGain](./bitburner.characterinfo.workagiexpgain.md) + +## CharacterInfo.workAgiExpGain property + +Agi experience earned so far from work + +Signature: + +```typescript +workAgiExpGain: number; +``` diff --git a/markdown/bitburner.characterinfo.workchaexpgain.md b/markdown/bitburner.characterinfo.workchaexpgain.md new file mode 100644 index 000000000..010d098af --- /dev/null +++ b/markdown/bitburner.characterinfo.workchaexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [workChaExpGain](./bitburner.characterinfo.workchaexpgain.md) + +## CharacterInfo.workChaExpGain property + +Cha experience earned so far from work + +Signature: + +```typescript +workChaExpGain: number; +``` diff --git a/markdown/bitburner.characterinfo.workdefexpgain.md b/markdown/bitburner.characterinfo.workdefexpgain.md new file mode 100644 index 000000000..cd2aa5895 --- /dev/null +++ b/markdown/bitburner.characterinfo.workdefexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [workDefExpGain](./bitburner.characterinfo.workdefexpgain.md) + +## CharacterInfo.workDefExpGain property + +Def experience earned so far from work + +Signature: + +```typescript +workDefExpGain: number; +``` diff --git a/markdown/bitburner.characterinfo.workdexexpgain.md b/markdown/bitburner.characterinfo.workdexexpgain.md new file mode 100644 index 000000000..491542572 --- /dev/null +++ b/markdown/bitburner.characterinfo.workdexexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [workDexExpGain](./bitburner.characterinfo.workdexexpgain.md) + +## CharacterInfo.workDexExpGain property + +Dex experience earned so far from work + +Signature: + +```typescript +workDexExpGain: number; +``` diff --git a/markdown/bitburner.characterinfo.workhackexpgain.md b/markdown/bitburner.characterinfo.workhackexpgain.md new file mode 100644 index 000000000..a344589ed --- /dev/null +++ b/markdown/bitburner.characterinfo.workhackexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [workHackExpGain](./bitburner.characterinfo.workhackexpgain.md) + +## CharacterInfo.workHackExpGain property + +Hacking experience earned so far from work + +Signature: + +```typescript +workHackExpGain: number; +``` diff --git a/markdown/bitburner.characterinfo.workmoneygain.md b/markdown/bitburner.characterinfo.workmoneygain.md new file mode 100644 index 000000000..95ac3c5d4 --- /dev/null +++ b/markdown/bitburner.characterinfo.workmoneygain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [workMoneyGain](./bitburner.characterinfo.workmoneygain.md) + +## CharacterInfo.workMoneyGain property + +Money earned so far from work, if applicable + +Signature: + +```typescript +workMoneyGain: number; +``` diff --git a/markdown/bitburner.characterinfo.workrepgain.md b/markdown/bitburner.characterinfo.workrepgain.md new file mode 100644 index 000000000..590391acd --- /dev/null +++ b/markdown/bitburner.characterinfo.workrepgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [workRepGain](./bitburner.characterinfo.workrepgain.md) + +## CharacterInfo.workRepGain property + +Reputation earned so far from work, if applicable + +Signature: + +```typescript +workRepGain: number; +``` diff --git a/markdown/bitburner.characterinfo.workstrexpgain.md b/markdown/bitburner.characterinfo.workstrexpgain.md new file mode 100644 index 000000000..b6601dfa0 --- /dev/null +++ b/markdown/bitburner.characterinfo.workstrexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterInfo](./bitburner.characterinfo.md) > [workStrExpGain](./bitburner.characterinfo.workstrexpgain.md) + +## CharacterInfo.workStrExpGain property + +Str experience earned so far from work + +Signature: + +```typescript +workStrExpGain: number; +``` diff --git a/markdown/bitburner.charactermult.agility.md b/markdown/bitburner.charactermult.agility.md new file mode 100644 index 000000000..cc7c326db --- /dev/null +++ b/markdown/bitburner.charactermult.agility.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [agility](./bitburner.charactermult.agility.md) + +## CharacterMult.agility property + +Agility stat + +Signature: + +```typescript +agility: number; +``` diff --git a/markdown/bitburner.charactermult.agilityexp.md b/markdown/bitburner.charactermult.agilityexp.md new file mode 100644 index 000000000..2221c4f9a --- /dev/null +++ b/markdown/bitburner.charactermult.agilityexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [agilityExp](./bitburner.charactermult.agilityexp.md) + +## CharacterMult.agilityExp property + +Agility exp + +Signature: + +```typescript +agilityExp: number; +``` diff --git a/markdown/bitburner.charactermult.companyrep.md b/markdown/bitburner.charactermult.companyrep.md new file mode 100644 index 000000000..e12e6b4c1 --- /dev/null +++ b/markdown/bitburner.charactermult.companyrep.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [companyRep](./bitburner.charactermult.companyrep.md) + +## CharacterMult.companyRep property + +Company reputation + +Signature: + +```typescript +companyRep: number; +``` diff --git a/markdown/bitburner.charactermult.crimemoney.md b/markdown/bitburner.charactermult.crimemoney.md new file mode 100644 index 000000000..4e3608874 --- /dev/null +++ b/markdown/bitburner.charactermult.crimemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [crimeMoney](./bitburner.charactermult.crimemoney.md) + +## CharacterMult.crimeMoney property + +Money earned from crimes + +Signature: + +```typescript +crimeMoney: number; +``` diff --git a/markdown/bitburner.charactermult.crimesuccess.md b/markdown/bitburner.charactermult.crimesuccess.md new file mode 100644 index 000000000..2660f01cc --- /dev/null +++ b/markdown/bitburner.charactermult.crimesuccess.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [crimeSuccess](./bitburner.charactermult.crimesuccess.md) + +## CharacterMult.crimeSuccess property + +Crime success chance + +Signature: + +```typescript +crimeSuccess: number; +``` diff --git a/markdown/bitburner.charactermult.defense.md b/markdown/bitburner.charactermult.defense.md new file mode 100644 index 000000000..1165811f2 --- /dev/null +++ b/markdown/bitburner.charactermult.defense.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [defense](./bitburner.charactermult.defense.md) + +## CharacterMult.defense property + +Defense stat + +Signature: + +```typescript +defense: number; +``` diff --git a/markdown/bitburner.charactermult.defenseexp.md b/markdown/bitburner.charactermult.defenseexp.md new file mode 100644 index 000000000..9b1b55e5e --- /dev/null +++ b/markdown/bitburner.charactermult.defenseexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [defenseExp](./bitburner.charactermult.defenseexp.md) + +## CharacterMult.defenseExp property + +Defense exp + +Signature: + +```typescript +defenseExp: number; +``` diff --git a/markdown/bitburner.charactermult.dexterity.md b/markdown/bitburner.charactermult.dexterity.md new file mode 100644 index 000000000..56a6fb1e5 --- /dev/null +++ b/markdown/bitburner.charactermult.dexterity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [dexterity](./bitburner.charactermult.dexterity.md) + +## CharacterMult.dexterity property + +Dexterity stat + +Signature: + +```typescript +dexterity: number; +``` diff --git a/markdown/bitburner.charactermult.dexterityexp.md b/markdown/bitburner.charactermult.dexterityexp.md new file mode 100644 index 000000000..8adadcad4 --- /dev/null +++ b/markdown/bitburner.charactermult.dexterityexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [dexterityExp](./bitburner.charactermult.dexterityexp.md) + +## CharacterMult.dexterityExp property + +Dexterity exp + +Signature: + +```typescript +dexterityExp: number; +``` diff --git a/markdown/bitburner.charactermult.factionrep.md b/markdown/bitburner.charactermult.factionrep.md new file mode 100644 index 000000000..ee97e45f4 --- /dev/null +++ b/markdown/bitburner.charactermult.factionrep.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [factionRep](./bitburner.charactermult.factionrep.md) + +## CharacterMult.factionRep property + +Faction reputation + +Signature: + +```typescript +factionRep: number; +``` diff --git a/markdown/bitburner.charactermult.hacking.md b/markdown/bitburner.charactermult.hacking.md new file mode 100644 index 000000000..b1a9d4c8f --- /dev/null +++ b/markdown/bitburner.charactermult.hacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [hacking](./bitburner.charactermult.hacking.md) + +## CharacterMult.hacking property + +Hacking stat + +Signature: + +```typescript +hacking: number; +``` diff --git a/markdown/bitburner.charactermult.hackingexp.md b/markdown/bitburner.charactermult.hackingexp.md new file mode 100644 index 000000000..3d715cdeb --- /dev/null +++ b/markdown/bitburner.charactermult.hackingexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [hackingExp](./bitburner.charactermult.hackingexp.md) + +## CharacterMult.hackingExp property + +Hacking exp + +Signature: + +```typescript +hackingExp: number; +``` diff --git a/markdown/bitburner.charactermult.md b/markdown/bitburner.charactermult.md new file mode 100644 index 000000000..05071b5ac --- /dev/null +++ b/markdown/bitburner.charactermult.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) + +## CharacterMult interface + + +Signature: + +```typescript +interface CharacterMult +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility](./bitburner.charactermult.agility.md) | number | Agility stat | +| [agilityExp](./bitburner.charactermult.agilityexp.md) | number | Agility exp | +| [companyRep](./bitburner.charactermult.companyrep.md) | number | Company reputation | +| [crimeMoney](./bitburner.charactermult.crimemoney.md) | number | Money earned from crimes | +| [crimeSuccess](./bitburner.charactermult.crimesuccess.md) | number | Crime success chance | +| [defense](./bitburner.charactermult.defense.md) | number | Defense stat | +| [defenseExp](./bitburner.charactermult.defenseexp.md) | number | Defense exp | +| [dexterity](./bitburner.charactermult.dexterity.md) | number | Dexterity stat | +| [dexterityExp](./bitburner.charactermult.dexterityexp.md) | number | Dexterity exp | +| [factionRep](./bitburner.charactermult.factionrep.md) | number | Faction reputation | +| [hacking](./bitburner.charactermult.hacking.md) | number | Hacking stat | +| [hackingExp](./bitburner.charactermult.hackingexp.md) | number | Hacking exp | +| [strength](./bitburner.charactermult.strength.md) | number | Strength stat | +| [strengthExp](./bitburner.charactermult.strengthexp.md) | number | Strength exp | +| [workMoney](./bitburner.charactermult.workmoney.md) | number | Money earned from jobs | + diff --git a/markdown/bitburner.charactermult.strength.md b/markdown/bitburner.charactermult.strength.md new file mode 100644 index 000000000..57369507e --- /dev/null +++ b/markdown/bitburner.charactermult.strength.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [strength](./bitburner.charactermult.strength.md) + +## CharacterMult.strength property + +Strength stat + +Signature: + +```typescript +strength: number; +``` diff --git a/markdown/bitburner.charactermult.strengthexp.md b/markdown/bitburner.charactermult.strengthexp.md new file mode 100644 index 000000000..760e17669 --- /dev/null +++ b/markdown/bitburner.charactermult.strengthexp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [strengthExp](./bitburner.charactermult.strengthexp.md) + +## CharacterMult.strengthExp property + +Strength exp + +Signature: + +```typescript +strengthExp: number; +``` diff --git a/markdown/bitburner.charactermult.workmoney.md b/markdown/bitburner.charactermult.workmoney.md new file mode 100644 index 000000000..0232e0f19 --- /dev/null +++ b/markdown/bitburner.charactermult.workmoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CharacterMult](./bitburner.charactermult.md) > [workMoney](./bitburner.charactermult.workmoney.md) + +## CharacterMult.workMoney property + +Money earned from jobs + +Signature: + +```typescript +workMoney: number; +``` diff --git a/markdown/bitburner.city.md b/markdown/bitburner.city.md new file mode 100644 index 000000000..e0e326909 --- /dev/null +++ b/markdown/bitburner.city.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [City](./bitburner.city.md) + +## City type + +Signature: + +```typescript +type City = "Aevum" | "Chongqing" | "Sector-12" | "New Tokyo" | "Ishima" | "Volhaven"; +``` diff --git a/markdown/bitburner.codingattemptoptions.md b/markdown/bitburner.codingattemptoptions.md new file mode 100644 index 000000000..cc715c167 --- /dev/null +++ b/markdown/bitburner.codingattemptoptions.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingAttemptOptions](./bitburner.codingattemptoptions.md) + +## CodingAttemptOptions interface + + +Signature: + +```typescript +interface CodingAttemptOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [returnReward](./bitburner.codingattemptoptions.returnreward.md) | boolean | If truthy, then the function will return a string that states the contract’s reward when it is successfully solved. | + diff --git a/markdown/bitburner.codingattemptoptions.returnreward.md b/markdown/bitburner.codingattemptoptions.returnreward.md new file mode 100644 index 000000000..f97ed6959 --- /dev/null +++ b/markdown/bitburner.codingattemptoptions.returnreward.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingAttemptOptions](./bitburner.codingattemptoptions.md) > [returnReward](./bitburner.codingattemptoptions.returnreward.md) + +## CodingAttemptOptions.returnReward property + +If truthy, then the function will return a string that states the contract’s reward when it is successfully solved. + +Signature: + +```typescript +returnReward: boolean; +``` diff --git a/markdown/bitburner.codingcontract.attempt.md b/markdown/bitburner.codingcontract.attempt.md new file mode 100644 index 000000000..fa1dfc956 --- /dev/null +++ b/markdown/bitburner.codingcontract.attempt.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [attempt](./bitburner.codingcontract.attempt.md) + +## CodingContract.attempt() method + +Attempts to solve the Coding Contract with the provided solution. + +Signature: + +```typescript +attempt(answer: string | string[] | number, fn: string, host?: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| answer | string \| string\[\] \| number | | +| fn | string | Filename of the contract. | +| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +boolean + +True if the solution was correct, false otherwise. + +## Remarks + +10 GB - Solution for the contract. + diff --git a/markdown/bitburner.codingcontract.attempt_1.md b/markdown/bitburner.codingcontract.attempt_1.md new file mode 100644 index 000000000..d0f0008b5 --- /dev/null +++ b/markdown/bitburner.codingcontract.attempt_1.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [attempt](./bitburner.codingcontract.attempt_1.md) + +## CodingContract.attempt() method + +Attempts to solve the Coding Contract with the provided solution. + +Signature: + +```typescript +attempt(answer: string | string[] | number, fn: string, host?: Host, opts?: CodingAttemptOptions): boolean | string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| answer | string \| string\[\] \| number | Solution for the contract. | +| fn | string | Filename of the contract. | +| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | +| opts | [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | Optional parameters for configuring function behavior. | + +Returns: + +boolean \| string + +True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string. + +## Remarks + +10 GB + diff --git a/markdown/bitburner.codingcontract.getcontracttype.md b/markdown/bitburner.codingcontract.getcontracttype.md new file mode 100644 index 000000000..4faf0bd1e --- /dev/null +++ b/markdown/bitburner.codingcontract.getcontracttype.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getContractType](./bitburner.codingcontract.getcontracttype.md) + +## CodingContract.getContractType() method + +Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) + +Signature: + +```typescript +getContractType(fn: string, host?: Host): CodingContractTypes; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Filename of the contract. | +| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +[CodingContractTypes](./bitburner.codingcontracttypes.md) + +Name describing the type of problem posed by the Coding Contract. + +## Remarks + +5 GB + diff --git a/markdown/bitburner.codingcontract.getdata.md b/markdown/bitburner.codingcontract.getdata.md new file mode 100644 index 000000000..d0cc4011d --- /dev/null +++ b/markdown/bitburner.codingcontract.getdata.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getData](./bitburner.codingcontract.getdata.md) + +## CodingContract.getData() method + +Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve + +Signature: + +```typescript +getData(fn: string, host?: Host): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Filename of the contract. | +| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +string + +The specified contract’s data; + +## Remarks + +5 GB + diff --git a/markdown/bitburner.codingcontract.getdescription.md b/markdown/bitburner.codingcontract.getdescription.md new file mode 100644 index 000000000..2226eb59b --- /dev/null +++ b/markdown/bitburner.codingcontract.getdescription.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getDescription](./bitburner.codingcontract.getdescription.md) + +## CodingContract.getDescription() method + +Get the full text description for the problem posed by the Coding Contract. + +Signature: + +```typescript +getDescription(fn: string, host?: Host): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Filename of the contract. | +| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +string + +Contract’s text description. + +## Remarks + +5 GB + diff --git a/markdown/bitburner.codingcontract.getnumtriesremaining.md b/markdown/bitburner.codingcontract.getnumtriesremaining.md new file mode 100644 index 000000000..61849e053 --- /dev/null +++ b/markdown/bitburner.codingcontract.getnumtriesremaining.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getNumTriesRemaining](./bitburner.codingcontract.getnumtriesremaining.md) + +## CodingContract.getNumTriesRemaining() method + +Get the number of tries remaining on the contract before it self-destructs. + +Signature: + +```typescript +getNumTriesRemaining(fn: string, host?: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Filename of the contract. | +| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. | + +Returns: + +number + +How many attempts are remaining for the contract; + +## Remarks + +2 GB + diff --git a/markdown/bitburner.codingcontract.md b/markdown/bitburner.codingcontract.md new file mode 100644 index 000000000..06266a9e7 --- /dev/null +++ b/markdown/bitburner.codingcontract.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) + +## CodingContract interface + + +Signature: + +```typescript +interface CodingContract +``` + +## Methods + +| Method | Description | +| --- | --- | +| [attempt(answer, fn, host)](./bitburner.codingcontract.attempt.md) | Attempts to solve the Coding Contract with the provided solution. | +| [attempt(answer, fn, host, opts)](./bitburner.codingcontract.attempt_1.md) | Attempts to solve the Coding Contract with the provided solution. | +| [getContractType(fn, host)](./bitburner.codingcontract.getcontracttype.md) | Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) | +| [getData(fn, host)](./bitburner.codingcontract.getdata.md) | Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve | +| [getDescription(fn, host)](./bitburner.codingcontract.getdescription.md) | Get the full text description for the problem posed by the Coding Contract. | +| [getNumTriesRemaining(fn, host)](./bitburner.codingcontract.getnumtriesremaining.md) | Get the number of tries remaining on the contract before it self-destructs. | + diff --git a/markdown/bitburner.codingcontracttypes.md b/markdown/bitburner.codingcontracttypes.md new file mode 100644 index 000000000..10833bf04 --- /dev/null +++ b/markdown/bitburner.codingcontracttypes.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContractTypes](./bitburner.codingcontracttypes.md) + +## CodingContractTypes type + +Signature: + +```typescript +type CodingContractTypes = + | "Find Largest Prime Factor" + | "Subarray with Maximum Sum" + | "Total Ways to Sum" + | "Spiralize Matrix" + | "Array Jumping Game" + | "Merge Overlapping Intervals" + | "Generate IP Addresses" + | "Algorithmic Stock Trader I" + | "Algorithmic Stock Trader II" + | "Algorithmic Stock Trader III" + | "Algorithmic Stock Trader IV" + | "Minimum Path Sum in a Triangle" + | "Unique Paths in a Grid I" + | "Unique Paths in a Grid II" + | "Sanitize Parentheses in Expression" + | "Find All Valid Math Expressions"; +``` diff --git a/markdown/bitburner.companyfield.md b/markdown/bitburner.companyfield.md new file mode 100644 index 000000000..058ff925a --- /dev/null +++ b/markdown/bitburner.companyfield.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyField](./bitburner.companyfield.md) + +## CompanyField type + +Signature: + +```typescript +type CompanyField = + | "software" + | "software consultant" + | "it" + | "security engineer" + | "network engineer" + | "business" + | "business consultant" + | "security" + | "agent" + | "employee" + | "part-time employee" + | "waiter" + | "part-time waiter"; +``` diff --git a/markdown/bitburner.companyname.md b/markdown/bitburner.companyname.md new file mode 100644 index 000000000..0c3b95517 --- /dev/null +++ b/markdown/bitburner.companyname.md @@ -0,0 +1,60 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CompanyName](./bitburner.companyname.md) + +## CompanyName type + +Signature: + +```typescript +type CompanyName = + // Sector-12 + | "MegaCorp" + | "BladeIndustries" + | "FourSigma" + | "IcarusMicrosystems" + | "UniversalEnergy" + | "DeltaOne" + | "CIA" + | "NSA" + | "AlphaEnterprises" + | "CarmichaelSecurity" + | "FoodNStuff" + | "JoesGuns" + + // Aevum + | "ECorp" + | "BachmanAndAssociates" + | "ClarkeIncorporated" + | "OmniTekIncorporated" + | "FulcrumTechnologies" + | "GalacticCybersystems" + | "AeroCorp" + | "WatchdogSecurity" + | "RhoConstruction" + | "AevumPolice" + | "NetLinkTechnologies" + + // Volhaven + | "NWO" + | "HeliosLabs" + | "OmniaCybersystems" + | "LexoCorp" + | "SysCoreSecurities" + | "CompuTek" + + // Chongqing + | "KuaiGongInternational" + | "SolarisSpaceSystems" + + // Ishima + | "StormTechnologies" + | "NovaMedical" + | "OmegaSoftware" + + // New Tokyo + | "DefComm" + | "VitaLife" + | "GlobalPharmaceuticals" + | "NoodleBar"; +``` diff --git a/markdown/bitburner.creatableprogram.md b/markdown/bitburner.creatableprogram.md new file mode 100644 index 000000000..5ad5d60ca --- /dev/null +++ b/markdown/bitburner.creatableprogram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CreatableProgram](./bitburner.creatableprogram.md) + +## CreatableProgram type + +Signature: + +```typescript +type CreatableProgram = PurchaseableProgram | "serverprofiler.exe"; +``` +References: [PurchaseableProgram](./bitburner.purchaseableprogram.md) + diff --git a/markdown/bitburner.crime.md b/markdown/bitburner.crime.md new file mode 100644 index 000000000..7f00f076e --- /dev/null +++ b/markdown/bitburner.crime.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Crime](./bitburner.crime.md) + +## Crime type + +Signature: + +```typescript +type Crime = + | "shoplift" + | "rob store" + | "mug" + | "larceny" + | "deal drugs" + | "bond forgery" + | "traffick arms" + | "homicide" + | "grand theft auto" + | "kidnap" + | "assassinate" + | "heist"; +``` diff --git a/markdown/bitburner.crimestats.agility_exp.md b/markdown/bitburner.crimestats.agility_exp.md new file mode 100644 index 000000000..0ed46e84f --- /dev/null +++ b/markdown/bitburner.crimestats.agility_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [agility\_exp](./bitburner.crimestats.agility_exp.md) + +## CrimeStats.agility\_exp property + +agility exp gained from crime + +Signature: + +```typescript +agility_exp: number; +``` diff --git a/markdown/bitburner.crimestats.agility_success_weight.md b/markdown/bitburner.crimestats.agility_success_weight.md new file mode 100644 index 000000000..6f803dd53 --- /dev/null +++ b/markdown/bitburner.crimestats.agility_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [agility\_success\_weight](./bitburner.crimestats.agility_success_weight.md) + +## CrimeStats.agility\_success\_weight property + +agility level impact on success change of the crime + +Signature: + +```typescript +agility_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.charisma_exp.md b/markdown/bitburner.crimestats.charisma_exp.md new file mode 100644 index 000000000..c4e10072c --- /dev/null +++ b/markdown/bitburner.crimestats.charisma_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [charisma\_exp](./bitburner.crimestats.charisma_exp.md) + +## CrimeStats.charisma\_exp property + +charisma exp gained from crime + +Signature: + +```typescript +charisma_exp: number; +``` diff --git a/markdown/bitburner.crimestats.charisma_success_weight.md b/markdown/bitburner.crimestats.charisma_success_weight.md new file mode 100644 index 000000000..37e0d18d0 --- /dev/null +++ b/markdown/bitburner.crimestats.charisma_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [charisma\_success\_weight](./bitburner.crimestats.charisma_success_weight.md) + +## CrimeStats.charisma\_success\_weight property + +charisma level impact on success change of the crime + +Signature: + +```typescript +charisma_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.defense_exp.md b/markdown/bitburner.crimestats.defense_exp.md new file mode 100644 index 000000000..e9f24d83c --- /dev/null +++ b/markdown/bitburner.crimestats.defense_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [defense\_exp](./bitburner.crimestats.defense_exp.md) + +## CrimeStats.defense\_exp property + +defense exp gained from crime + +Signature: + +```typescript +defense_exp: number; +``` diff --git a/markdown/bitburner.crimestats.defense_success_weight.md b/markdown/bitburner.crimestats.defense_success_weight.md new file mode 100644 index 000000000..1afef799a --- /dev/null +++ b/markdown/bitburner.crimestats.defense_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [defense\_success\_weight](./bitburner.crimestats.defense_success_weight.md) + +## CrimeStats.defense\_success\_weight property + +defense level impact on success change of the crime + +Signature: + +```typescript +defense_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.dexterity_exp.md b/markdown/bitburner.crimestats.dexterity_exp.md new file mode 100644 index 000000000..960176994 --- /dev/null +++ b/markdown/bitburner.crimestats.dexterity_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [dexterity\_exp](./bitburner.crimestats.dexterity_exp.md) + +## CrimeStats.dexterity\_exp property + +dexterity exp gained from crime + +Signature: + +```typescript +dexterity_exp: number; +``` diff --git a/markdown/bitburner.crimestats.dexterity_success_weight.md b/markdown/bitburner.crimestats.dexterity_success_weight.md new file mode 100644 index 000000000..26b846f7a --- /dev/null +++ b/markdown/bitburner.crimestats.dexterity_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [dexterity\_success\_weight](./bitburner.crimestats.dexterity_success_weight.md) + +## CrimeStats.dexterity\_success\_weight property + +dexterity level impact on success change of the crime + +Signature: + +```typescript +dexterity_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.difficulty.md b/markdown/bitburner.crimestats.difficulty.md new file mode 100644 index 000000000..36bfa92ea --- /dev/null +++ b/markdown/bitburner.crimestats.difficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [difficulty](./bitburner.crimestats.difficulty.md) + +## CrimeStats.difficulty property + +Number representing the difficulty of the crime. Used for success chance calculations + +Signature: + +```typescript +difficulty: number; +``` diff --git a/markdown/bitburner.crimestats.hacking_exp.md b/markdown/bitburner.crimestats.hacking_exp.md new file mode 100644 index 000000000..56a96c971 --- /dev/null +++ b/markdown/bitburner.crimestats.hacking_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [hacking\_exp](./bitburner.crimestats.hacking_exp.md) + +## CrimeStats.hacking\_exp property + +hacking exp gained from crime + +Signature: + +```typescript +hacking_exp: number; +``` diff --git a/markdown/bitburner.crimestats.hacking_success_weight.md b/markdown/bitburner.crimestats.hacking_success_weight.md new file mode 100644 index 000000000..f57d9fbb8 --- /dev/null +++ b/markdown/bitburner.crimestats.hacking_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [hacking\_success\_weight](./bitburner.crimestats.hacking_success_weight.md) + +## CrimeStats.hacking\_success\_weight property + +hacking level impact on success change of the crime + +Signature: + +```typescript +hacking_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.intelligence_exp.md b/markdown/bitburner.crimestats.intelligence_exp.md new file mode 100644 index 000000000..b2fb67f2a --- /dev/null +++ b/markdown/bitburner.crimestats.intelligence_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [intelligence\_exp](./bitburner.crimestats.intelligence_exp.md) + +## CrimeStats.intelligence\_exp property + +intelligence exp gained from crime + +Signature: + +```typescript +intelligence_exp: number; +``` diff --git a/markdown/bitburner.crimestats.karma.md b/markdown/bitburner.crimestats.karma.md new file mode 100644 index 000000000..22323833a --- /dev/null +++ b/markdown/bitburner.crimestats.karma.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [karma](./bitburner.crimestats.karma.md) + +## CrimeStats.karma property + +Amount of karma lost for SUCCESSFULLY committing this crime + +Signature: + +```typescript +karma: number; +``` diff --git a/markdown/bitburner.crimestats.kills.md b/markdown/bitburner.crimestats.kills.md new file mode 100644 index 000000000..963b8edc4 --- /dev/null +++ b/markdown/bitburner.crimestats.kills.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [kills](./bitburner.crimestats.kills.md) + +## CrimeStats.kills property + +How many people die as a result of this crime + +Signature: + +```typescript +kills: number; +``` diff --git a/markdown/bitburner.crimestats.md b/markdown/bitburner.crimestats.md new file mode 100644 index 000000000..3855265ee --- /dev/null +++ b/markdown/bitburner.crimestats.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) + +## CrimeStats interface + + +Signature: + +```typescript +interface CrimeStats +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility\_exp](./bitburner.crimestats.agility_exp.md) | number | agility exp gained from crime | +| [agility\_success\_weight](./bitburner.crimestats.agility_success_weight.md) | number | agility level impact on success change of the crime | +| [charisma\_exp](./bitburner.crimestats.charisma_exp.md) | number | charisma exp gained from crime | +| [charisma\_success\_weight](./bitburner.crimestats.charisma_success_weight.md) | number | charisma level impact on success change of the crime | +| [defense\_exp](./bitburner.crimestats.defense_exp.md) | number | defense exp gained from crime | +| [defense\_success\_weight](./bitburner.crimestats.defense_success_weight.md) | number | defense level impact on success change of the crime | +| [dexterity\_exp](./bitburner.crimestats.dexterity_exp.md) | number | dexterity exp gained from crime | +| [dexterity\_success\_weight](./bitburner.crimestats.dexterity_success_weight.md) | number | dexterity level impact on success change of the crime | +| [difficulty](./bitburner.crimestats.difficulty.md) | number | Number representing the difficulty of the crime. Used for success chance calculations | +| [hacking\_exp](./bitburner.crimestats.hacking_exp.md) | number | hacking exp gained from crime | +| [hacking\_success\_weight](./bitburner.crimestats.hacking_success_weight.md) | number | hacking level impact on success change of the crime | +| [intelligence\_exp](./bitburner.crimestats.intelligence_exp.md) | number | intelligence exp gained from crime | +| [karma](./bitburner.crimestats.karma.md) | number | Amount of karma lost for SUCCESSFULLY committing this crime | +| [kills](./bitburner.crimestats.kills.md) | number | How many people die as a result of this crime | +| [money](./bitburner.crimestats.money.md) | number | How much money is given | +| [name](./bitburner.crimestats.name.md) | number | Name of crime | +| [strength\_exp](./bitburner.crimestats.strength_exp.md) | number | strength exp gained from crime | +| [strength\_success\_weight](./bitburner.crimestats.strength_success_weight.md) | number | strength level impact on success change of the crime | +| [time](./bitburner.crimestats.time.md) | number | Milliseconds it takes to attempt the crime | +| [type](./bitburner.crimestats.type.md) | string | Description of the crime activity | + diff --git a/markdown/bitburner.crimestats.money.md b/markdown/bitburner.crimestats.money.md new file mode 100644 index 000000000..6260a2059 --- /dev/null +++ b/markdown/bitburner.crimestats.money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [money](./bitburner.crimestats.money.md) + +## CrimeStats.money property + +How much money is given + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.crimestats.name.md b/markdown/bitburner.crimestats.name.md new file mode 100644 index 000000000..927337120 --- /dev/null +++ b/markdown/bitburner.crimestats.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [name](./bitburner.crimestats.name.md) + +## CrimeStats.name property + +Name of crime + +Signature: + +```typescript +name: number; +``` diff --git a/markdown/bitburner.crimestats.strength_exp.md b/markdown/bitburner.crimestats.strength_exp.md new file mode 100644 index 000000000..e30f029b7 --- /dev/null +++ b/markdown/bitburner.crimestats.strength_exp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [strength\_exp](./bitburner.crimestats.strength_exp.md) + +## CrimeStats.strength\_exp property + +strength exp gained from crime + +Signature: + +```typescript +strength_exp: number; +``` diff --git a/markdown/bitburner.crimestats.strength_success_weight.md b/markdown/bitburner.crimestats.strength_success_weight.md new file mode 100644 index 000000000..e8806edeb --- /dev/null +++ b/markdown/bitburner.crimestats.strength_success_weight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [strength\_success\_weight](./bitburner.crimestats.strength_success_weight.md) + +## CrimeStats.strength\_success\_weight property + +strength level impact on success change of the crime + +Signature: + +```typescript +strength_success_weight: number; +``` diff --git a/markdown/bitburner.crimestats.time.md b/markdown/bitburner.crimestats.time.md new file mode 100644 index 000000000..60218a10f --- /dev/null +++ b/markdown/bitburner.crimestats.time.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [time](./bitburner.crimestats.time.md) + +## CrimeStats.time property + +Milliseconds it takes to attempt the crime + +Signature: + +```typescript +time: number; +``` diff --git a/markdown/bitburner.crimestats.type.md b/markdown/bitburner.crimestats.type.md new file mode 100644 index 000000000..d6fba340b --- /dev/null +++ b/markdown/bitburner.crimestats.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [CrimeStats](./bitburner.crimestats.md) > [type](./bitburner.crimestats.type.md) + +## CrimeStats.type property + +Description of the crime activity + +Signature: + +```typescript +type: string; +``` diff --git a/markdown/bitburner.factionname.md b/markdown/bitburner.factionname.md new file mode 100644 index 000000000..a7557390e --- /dev/null +++ b/markdown/bitburner.factionname.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [FactionName](./bitburner.factionname.md) + +## FactionName type + +Signature: + +```typescript +type FactionName = + | "Illuminati" + | "Daedalus" + | "The Covenant" + | "ECorp" + | "MegaCorp" + | "Bachman & Associates" + | "Blade Industries" + | "NWO" + | "Clarke Incorporated" + | "OmniTek Incorporated" + | "Four Sigma" + | "KuaiGong International" + | "Fulcrum Secret Technologies" + | "BitRunners" + | "The Black Hand" + | "NiteSec" + | "Aevum" + | "Chongqing" + | "Ishima" + | "New Tokyo" + | "Sector-12" + | "Volhaven" + | "Speakers for the Dead" + | "The Dark Army" + | "The Syndicate" + | "Silhouette" + | "Tetrads" + | "Slum Snakes" + | "Netburners" + | "Tian Di Hui" + | "CyberSec" + | "Bladeburners"; +``` diff --git a/markdown/bitburner.factionwork.md b/markdown/bitburner.factionwork.md new file mode 100644 index 000000000..5daa57496 --- /dev/null +++ b/markdown/bitburner.factionwork.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [FactionWork](./bitburner.factionwork.md) + +## FactionWork type + +Signature: + +```typescript +type FactionWork = "hacking" | "field" | "security"; +``` diff --git a/markdown/bitburner.gang.ascendmember.md b/markdown/bitburner.gang.ascendmember.md new file mode 100644 index 000000000..bdfeef567 --- /dev/null +++ b/markdown/bitburner.gang.ascendmember.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [ascendMember](./bitburner.gang.ascendmember.md) + +## Gang.ascendMember() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Ascend the specified Gang Member. + +Signature: + +```typescript +ascendMember(memberName: string): GangMemberAscension; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| memberName | string | Name of member to ascend. | + +Returns: + +[GangMemberAscension](./bitburner.gangmemberascension.md) + +Object with info about the ascension results. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.gang.canrecruitmember.md b/markdown/bitburner.gang.canrecruitmember.md new file mode 100644 index 000000000..e61a61aac --- /dev/null +++ b/markdown/bitburner.gang.canrecruitmember.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [canRecruitMember](./bitburner.gang.canrecruitmember.md) + +## Gang.canRecruitMember() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Returns boolean indicating whether a member can currently be recruited + +Signature: + +```typescript +canRecruitMember(): boolean; +``` +Returns: + +boolean + +True if a member can currently be recruited, false otherwise. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.gang.getbonustime.md b/markdown/bitburner.gang.getbonustime.md new file mode 100644 index 000000000..239cd1f0f --- /dev/null +++ b/markdown/bitburner.gang.getbonustime.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getBonusTime](./bitburner.gang.getbonustime.md) + +## Gang.getBonusTime() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic. + +“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser. + +“Bonus time” makes the game progress faster, up to 10x the normal speed. + +Signature: + +```typescript +getBonusTime(): number; +``` +Returns: + +number + +Bonus time for the Gang mechanic in seconds. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.gang.getchancetowinclash.md b/markdown/bitburner.gang.getchancetowinclash.md new file mode 100644 index 000000000..c86f33240 --- /dev/null +++ b/markdown/bitburner.gang.getchancetowinclash.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getChanceToWinClash](./bitburner.gang.getchancetowinclash.md) + +## Gang.getChanceToWinClash() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage + +Signature: + +```typescript +getChanceToWinClash(gangName: GangName): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| gangName | [GangName](./bitburner.gangname.md) | Target gang | + +Returns: + +number + +Chance you have to win a clash with the specified gang. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.gang.getequipmentcost.md b/markdown/bitburner.gang.getequipmentcost.md new file mode 100644 index 000000000..898288453 --- /dev/null +++ b/markdown/bitburner.gang.getequipmentcost.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getEquipmentCost](./bitburner.gang.getequipmentcost.md) + +## Gang.getEquipmentCost() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity. + +Signature: + +```typescript +getEquipmentCost(equipName: GangEquipment | GangAugmentations): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | + +Returns: + +number + +Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gang.getequipmentnames.md b/markdown/bitburner.gang.getequipmentnames.md new file mode 100644 index 000000000..e5f6bf262 --- /dev/null +++ b/markdown/bitburner.gang.getequipmentnames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getEquipmentNames](./bitburner.gang.getequipmentnames.md) + +## Gang.getEquipmentNames() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations. + +Signature: + +```typescript +getEquipmentNames(): (GangEquipment | GangAugmentations)[]; +``` +Returns: + +([GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md))\[\] + +Names of all Equpiment/Augmentations. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.gang.getequipmentstats.md b/markdown/bitburner.gang.getequipmentstats.md new file mode 100644 index 000000000..c01e4bd73 --- /dev/null +++ b/markdown/bitburner.gang.getequipmentstats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getEquipmentStats](./bitburner.gang.getequipmentstats.md) + +## Gang.getEquipmentStats() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get the specified equipment stats. + +Signature: + +```typescript +getEquipmentStats(equipName: GangEquipment | GangAugmentations): GangEquipmentStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | + +Returns: + +[GangEquipmentStats](./bitburner.gangequipmentstats.md) + +A dictionary containing the stats of the equipment. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gang.getequipmenttype.md b/markdown/bitburner.gang.getequipmenttype.md new file mode 100644 index 000000000..380cd875e --- /dev/null +++ b/markdown/bitburner.gang.getequipmenttype.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getEquipmentType](./bitburner.gang.getequipmenttype.md) + +## Gang.getEquipmentType() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get the specified equipment type. + +Signature: + +```typescript +getEquipmentType(equipName: GangEquipment | GangAugmentations): GangEquipmentType; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of equipment. | + +Returns: + +[GangEquipmentType](./bitburner.gangequipmenttype.md) + +Type of the equipment. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gang.getganginformation.md b/markdown/bitburner.gang.getganginformation.md new file mode 100644 index 000000000..45e0a91a8 --- /dev/null +++ b/markdown/bitburner.gang.getganginformation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getGangInformation](./bitburner.gang.getganginformation.md) + +## Gang.getGangInformation() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get general information about the gang. + +Signature: + +```typescript +getGangInformation(): GangGenInfo; +``` +Returns: + +[GangGenInfo](./bitburner.ganggeninfo.md) + +Object containing general information about the gang. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gang.getmemberinformation.md b/markdown/bitburner.gang.getmemberinformation.md new file mode 100644 index 000000000..9fa53eafd --- /dev/null +++ b/markdown/bitburner.gang.getmemberinformation.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getMemberInformation](./bitburner.gang.getmemberinformation.md) + +## Gang.getMemberInformation() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get stat and equipment-related information about a Gang Member + +Signature: + +```typescript +getMemberInformation(name: string): GangMemberInfo; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Name of member. | + +Returns: + +[GangMemberInfo](./bitburner.gangmemberinfo.md) + +Object containing stat and equipment-related information about a Gang Member. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gang.getmembernames.md b/markdown/bitburner.gang.getmembernames.md new file mode 100644 index 000000000..d25c10354 --- /dev/null +++ b/markdown/bitburner.gang.getmembernames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getMemberNames](./bitburner.gang.getmembernames.md) + +## Gang.getMemberNames() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get the names of all Gang members + +Signature: + +```typescript +getMemberNames(): string[]; +``` +Returns: + +string\[\] + +Names of all Gang members. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.gang.getotherganginformation.md b/markdown/bitburner.gang.getotherganginformation.md new file mode 100644 index 000000000..7508e1096 --- /dev/null +++ b/markdown/bitburner.gang.getotherganginformation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getOtherGangInformation](./bitburner.gang.getotherganginformation.md) + +## Gang.getOtherGangInformation() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get territory and power information about all gangs. + +Signature: + +```typescript +getOtherGangInformation(): GangOtherInfo; +``` +Returns: + +[GangOtherInfo](./bitburner.gangotherinfo.md) + +Object containing territory and power information about all gangs. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gang.gettasknames.md b/markdown/bitburner.gang.gettasknames.md new file mode 100644 index 000000000..a31e1d9e9 --- /dev/null +++ b/markdown/bitburner.gang.gettasknames.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getTaskNames](./bitburner.gang.gettasknames.md) + +## Gang.getTaskNames() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get the name of all valid tasks that Gang members can be assigned to. + +Signature: + +```typescript +getTaskNames(): GangTasks[]; +``` +Returns: + +[GangTasks](./bitburner.gangtasks.md)\[\] + +All valid tasks that Gang members can be assigned to. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.gang.gettaskstats.md b/markdown/bitburner.gang.gettaskstats.md new file mode 100644 index 000000000..83e0defc9 --- /dev/null +++ b/markdown/bitburner.gang.gettaskstats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [getTaskStats](./bitburner.gang.gettaskstats.md) + +## Gang.getTaskStats() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. + +Signature: + +```typescript +getTaskStats(name: GangTasks): GangTasksStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [GangTasks](./bitburner.gangtasks.md) | Name of the task. | + +Returns: + +[GangTasksStats](./bitburner.gangtasksstats.md) + +Detailed stats of a task. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.gang.md b/markdown/bitburner.gang.md new file mode 100644 index 000000000..e23ceae6a --- /dev/null +++ b/markdown/bitburner.gang.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) + +## Gang interface + + +Signature: + +```typescript +interface Gang +``` + +## Methods + +| Method | Description | +| --- | --- | +| [ascendMember(memberName)](./bitburner.gang.ascendmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Ascend the specified Gang Member. | +| [canRecruitMember()](./bitburner.gang.canrecruitmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Returns boolean indicating whether a member can currently be recruited | +| [getBonusTime()](./bitburner.gang.getbonustime.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.“Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.“Bonus time” makes the game progress faster, up to 10x the normal speed. | +| [getChanceToWinClash(gangName)](./bitburner.gang.getchancetowinclash.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage | +| [getEquipmentCost(equipName)](./bitburner.gang.getequipmentcost.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity. | +| [getEquipmentNames()](./bitburner.gang.getequipmentnames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations. | +| [getEquipmentStats(equipName)](./bitburner.gang.getequipmentstats.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the specified equipment stats. | +| [getEquipmentType(equipName)](./bitburner.gang.getequipmenttype.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the specified equipment type. | +| [getGangInformation()](./bitburner.gang.getganginformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get general information about the gang. | +| [getMemberInformation(name)](./bitburner.gang.getmemberinformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get stat and equipment-related information about a Gang Member | +| [getMemberNames()](./bitburner.gang.getmembernames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the names of all Gang members | +| [getOtherGangInformation()](./bitburner.gang.getotherganginformation.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get territory and power information about all gangs. | +| [getTaskNames()](./bitburner.gang.gettasknames.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the name of all valid tasks that Gang members can be assigned to. | +| [getTaskStats(name)](./bitburner.gang.gettaskstats.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. | +| [purchaseEquipment(memberName, equipName)](./bitburner.gang.purchaseequipment.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. | +| [recruitMember(name)](./bitburner.gang.recruitmember.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Attempt to recruit a new gang member.Possible reasons for failure: \* Cannot currently recruit a new member \* There already exists a member with the specified name | +| [setMemberTask(memberName, taskName)](./bitburner.gang.setmembertask.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”). | +| [setTerritoryWarfare(engage)](./bitburner.gang.setterritorywarfare.md) | If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.Set whether or not the gang should engage in territory warfare | + diff --git a/markdown/bitburner.gang.purchaseequipment.md b/markdown/bitburner.gang.purchaseequipment.md new file mode 100644 index 000000000..04e947f84 --- /dev/null +++ b/markdown/bitburner.gang.purchaseequipment.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [purchaseEquipment](./bitburner.gang.purchaseequipment.md) + +## Gang.purchaseEquipment() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. + +Signature: + +```typescript +purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentations): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| memberName | string | Name of Gang member to purchase the equipment for. | +| equipName | [GangEquipment](./bitburner.gangequipment.md) \| [GangAugmentations](./bitburner.gangaugmentations.md) | Name of Equipment/Augmentation to purchase. | + +Returns: + +boolean + +True if the equipment was successfully purchased. False otherwise + +## Remarks + +4 GB + diff --git a/markdown/bitburner.gang.recruitmember.md b/markdown/bitburner.gang.recruitmember.md new file mode 100644 index 000000000..06e3053d1 --- /dev/null +++ b/markdown/bitburner.gang.recruitmember.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [recruitMember](./bitburner.gang.recruitmember.md) + +## Gang.recruitMember() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Attempt to recruit a new gang member. + +Possible reasons for failure: \* Cannot currently recruit a new member \* There already exists a member with the specified name + +Signature: + +```typescript +recruitMember(name: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Name of member to recruit. | + +Returns: + +boolean + +True if the member was successfully recruited, false otherwise. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gang.setmembertask.md b/markdown/bitburner.gang.setmembertask.md new file mode 100644 index 000000000..03ee458d6 --- /dev/null +++ b/markdown/bitburner.gang.setmembertask.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [setMemberTask](./bitburner.gang.setmembertask.md) + +## Gang.setMemberTask() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”). + +Signature: + +```typescript +setMemberTask(memberName: string, taskName: GangTasks): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| memberName | string | Name of Gang member to assign. | +| taskName | [GangTasks](./bitburner.gangtasks.md) | Task to assign. | + +Returns: + +boolean + +True if the Gang Member was successfully assigned to the task, false otherwise. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gang.setterritorywarfare.md b/markdown/bitburner.gang.setterritorywarfare.md new file mode 100644 index 000000000..3e53202fc --- /dev/null +++ b/markdown/bitburner.gang.setterritorywarfare.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gang](./bitburner.gang.md) > [setTerritoryWarfare](./bitburner.gang.setterritorywarfare.md) + +## Gang.setTerritoryWarfare() method + +If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. + +Set whether or not the gang should engage in territory warfare + +Signature: + +```typescript +setTerritoryWarfare(engage: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| engage | boolean | Whether or not to engage in territory warfare. | + +Returns: + +void + +## Remarks + +2 GB + diff --git a/markdown/bitburner.gangaugmentations.md b/markdown/bitburner.gangaugmentations.md new file mode 100644 index 000000000..3b5d36d08 --- /dev/null +++ b/markdown/bitburner.gangaugmentations.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangAugmentations](./bitburner.gangaugmentations.md) + +## GangAugmentations type + +Signature: + +```typescript +type GangAugmentations = + | "Bionic Arms" + | "Bionic Legs" + | "Bionic Spine" + | "BrachiBlades" + | "Nanofiber Weave" + | "Synthetic Heart" + | "Synfibril Muscle" + | "BitWire" + | "Neuralstimulator" + | "DataJack" + | "Graphene Bone Lacings"; +``` diff --git a/markdown/bitburner.gangequipment.md b/markdown/bitburner.gangequipment.md new file mode 100644 index 000000000..8e068dac7 --- /dev/null +++ b/markdown/bitburner.gangequipment.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipment](./bitburner.gangequipment.md) + +## GangEquipment type + +Signature: + +```typescript +type GangEquipment = + | "Baseball Bat" + | "Katana" + | "Glock 18C" + | "P90C" + | "Steyr AUG" + | "AK-47" + | "M15A10 Assault Rifle" + | "AWM Sniper Rifle" + | "Bulletproof Vest" + | "Full Body Armor" + | "Liquid Body Armor" + | "Graphene Plating Armor" + | "Ford Flex V20" + | "ATX1070 Superbike" + | "Mercedes-Benz S9001" + | "White Ferrari" + | "NUKE Rootkit" + | "Soulstealer Rootkit" + | "Demon Rootkit" + | "Hmap Node" + | "Jack the Ripper"; +``` diff --git a/markdown/bitburner.gangequipmentstats.agi.md b/markdown/bitburner.gangequipmentstats.agi.md new file mode 100644 index 000000000..392c3b24d --- /dev/null +++ b/markdown/bitburner.gangequipmentstats.agi.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [agi](./bitburner.gangequipmentstats.agi.md) + +## GangEquipmentStats.agi property + +Agility multiplier + +Signature: + +```typescript +agi: number; +``` diff --git a/markdown/bitburner.gangequipmentstats.cha.md b/markdown/bitburner.gangequipmentstats.cha.md new file mode 100644 index 000000000..198f8bea6 --- /dev/null +++ b/markdown/bitburner.gangequipmentstats.cha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [cha](./bitburner.gangequipmentstats.cha.md) + +## GangEquipmentStats.cha property + +Charisma multiplier + +Signature: + +```typescript +cha: number; +``` diff --git a/markdown/bitburner.gangequipmentstats.def.md b/markdown/bitburner.gangequipmentstats.def.md new file mode 100644 index 000000000..0f6b028f0 --- /dev/null +++ b/markdown/bitburner.gangequipmentstats.def.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [def](./bitburner.gangequipmentstats.def.md) + +## GangEquipmentStats.def property + +Defense multiplier + +Signature: + +```typescript +def: number; +``` diff --git a/markdown/bitburner.gangequipmentstats.dex.md b/markdown/bitburner.gangequipmentstats.dex.md new file mode 100644 index 000000000..ebdcb5d27 --- /dev/null +++ b/markdown/bitburner.gangequipmentstats.dex.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [dex](./bitburner.gangequipmentstats.dex.md) + +## GangEquipmentStats.dex property + +Dexterity multiplier + +Signature: + +```typescript +dex: number; +``` diff --git a/markdown/bitburner.gangequipmentstats.hack.md b/markdown/bitburner.gangequipmentstats.hack.md new file mode 100644 index 000000000..25f4f1ea3 --- /dev/null +++ b/markdown/bitburner.gangequipmentstats.hack.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [hack](./bitburner.gangequipmentstats.hack.md) + +## GangEquipmentStats.hack property + +Hacking multiplier + +Signature: + +```typescript +hack: number; +``` diff --git a/markdown/bitburner.gangequipmentstats.md b/markdown/bitburner.gangequipmentstats.md new file mode 100644 index 000000000..344671b8f --- /dev/null +++ b/markdown/bitburner.gangequipmentstats.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) + +## GangEquipmentStats interface + + +Signature: + +```typescript +interface GangEquipmentStats +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agi](./bitburner.gangequipmentstats.agi.md) | number | Agility multiplier | +| [cha](./bitburner.gangequipmentstats.cha.md) | number | Charisma multiplier | +| [def](./bitburner.gangequipmentstats.def.md) | number | Defense multiplier | +| [dex](./bitburner.gangequipmentstats.dex.md) | number | Dexterity multiplier | +| [hack](./bitburner.gangequipmentstats.hack.md) | number | Hacking multiplier | +| [str](./bitburner.gangequipmentstats.str.md) | number | Strength multiplier | + diff --git a/markdown/bitburner.gangequipmentstats.str.md b/markdown/bitburner.gangequipmentstats.str.md new file mode 100644 index 000000000..945af13f8 --- /dev/null +++ b/markdown/bitburner.gangequipmentstats.str.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentStats](./bitburner.gangequipmentstats.md) > [str](./bitburner.gangequipmentstats.str.md) + +## GangEquipmentStats.str property + +Strength multiplier + +Signature: + +```typescript +str: number; +``` diff --git a/markdown/bitburner.gangequipmenttype.md b/markdown/bitburner.gangequipmenttype.md new file mode 100644 index 000000000..215818f57 --- /dev/null +++ b/markdown/bitburner.gangequipmenttype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangEquipmentType](./bitburner.gangequipmenttype.md) + +## GangEquipmentType type + +Signature: + +```typescript +type GangEquipmentType = "Weapon" | "Armor" | "Vehicle" | "Rootkit" | "Augmentation"; +``` diff --git a/markdown/bitburner.ganggeninfo.faction.md b/markdown/bitburner.ganggeninfo.faction.md new file mode 100644 index 000000000..a8242a2fe --- /dev/null +++ b/markdown/bitburner.ganggeninfo.faction.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [faction](./bitburner.ganggeninfo.faction.md) + +## GangGenInfo.faction property + +Name of faction that the gang belongs to ("Slum Snakes", etc.) + +Signature: + +```typescript +faction: GangName; +``` diff --git a/markdown/bitburner.ganggeninfo.ishacking.md b/markdown/bitburner.ganggeninfo.ishacking.md new file mode 100644 index 000000000..a63c3aa83 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.ishacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [isHacking](./bitburner.ganggeninfo.ishacking.md) + +## GangGenInfo.isHacking property + +Boolean indicating whether or not its a hacking gang + +Signature: + +```typescript +isHacking: boolean; +``` diff --git a/markdown/bitburner.ganggeninfo.md b/markdown/bitburner.ganggeninfo.md new file mode 100644 index 000000000..d2758d885 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) + +## GangGenInfo interface + + +Signature: + +```typescript +interface GangGenInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [faction](./bitburner.ganggeninfo.faction.md) | [GangName](./bitburner.gangname.md) | Name of faction that the gang belongs to ("Slum Snakes", etc.) | +| [isHacking](./bitburner.ganggeninfo.ishacking.md) | boolean | Boolean indicating whether or not its a hacking gang | +| [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) | number | Money earned per second | +| [power](./bitburner.ganggeninfo.power.md) | number | Gang's power for territory warfare | +| [respect](./bitburner.ganggeninfo.respect.md) | number | Gang's respect | +| [respectGainRate](./bitburner.ganggeninfo.respectgainrate.md) | number | Respect earned per second | +| [territory](./bitburner.ganggeninfo.territory.md) | number | Amount of territory held. Returned in decimal form, not percentage | +| [territoryClashChance](./bitburner.ganggeninfo.territoryclashchance.md) | number | Clash chance. Returned in decimal form, not percentage | +| [wantedLevel](./bitburner.ganggeninfo.wantedlevel.md) | number | Gang's wanted level | +| [wantedLevelGainRate](./bitburner.ganggeninfo.wantedlevelgainrate.md) | number | Wanted level gained/lost per second (negative for losses) | + diff --git a/markdown/bitburner.ganggeninfo.moneygainrate.md b/markdown/bitburner.ganggeninfo.moneygainrate.md new file mode 100644 index 000000000..509f1b987 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.moneygainrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [moneyGainRate](./bitburner.ganggeninfo.moneygainrate.md) + +## GangGenInfo.moneyGainRate property + +Money earned per second + +Signature: + +```typescript +moneyGainRate: number; +``` diff --git a/markdown/bitburner.ganggeninfo.power.md b/markdown/bitburner.ganggeninfo.power.md new file mode 100644 index 000000000..013893ba8 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.power.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [power](./bitburner.ganggeninfo.power.md) + +## GangGenInfo.power property + +Gang's power for territory warfare + +Signature: + +```typescript +power: number; +``` diff --git a/markdown/bitburner.ganggeninfo.respect.md b/markdown/bitburner.ganggeninfo.respect.md new file mode 100644 index 000000000..981fd3014 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.respect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [respect](./bitburner.ganggeninfo.respect.md) + +## GangGenInfo.respect property + +Gang's respect + +Signature: + +```typescript +respect: number; +``` diff --git a/markdown/bitburner.ganggeninfo.respectgainrate.md b/markdown/bitburner.ganggeninfo.respectgainrate.md new file mode 100644 index 000000000..90c3415bf --- /dev/null +++ b/markdown/bitburner.ganggeninfo.respectgainrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [respectGainRate](./bitburner.ganggeninfo.respectgainrate.md) + +## GangGenInfo.respectGainRate property + +Respect earned per second + +Signature: + +```typescript +respectGainRate: number; +``` diff --git a/markdown/bitburner.ganggeninfo.territory.md b/markdown/bitburner.ganggeninfo.territory.md new file mode 100644 index 000000000..d9d02e6b3 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.territory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [territory](./bitburner.ganggeninfo.territory.md) + +## GangGenInfo.territory property + +Amount of territory held. Returned in decimal form, not percentage + +Signature: + +```typescript +territory: number; +``` diff --git a/markdown/bitburner.ganggeninfo.territoryclashchance.md b/markdown/bitburner.ganggeninfo.territoryclashchance.md new file mode 100644 index 000000000..51737c095 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.territoryclashchance.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [territoryClashChance](./bitburner.ganggeninfo.territoryclashchance.md) + +## GangGenInfo.territoryClashChance property + +Clash chance. Returned in decimal form, not percentage + +Signature: + +```typescript +territoryClashChance: number; +``` diff --git a/markdown/bitburner.ganggeninfo.wantedlevel.md b/markdown/bitburner.ganggeninfo.wantedlevel.md new file mode 100644 index 000000000..62e803bd4 --- /dev/null +++ b/markdown/bitburner.ganggeninfo.wantedlevel.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [wantedLevel](./bitburner.ganggeninfo.wantedlevel.md) + +## GangGenInfo.wantedLevel property + +Gang's wanted level + +Signature: + +```typescript +wantedLevel: number; +``` diff --git a/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md b/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md new file mode 100644 index 000000000..f0cb3c85f --- /dev/null +++ b/markdown/bitburner.ganggeninfo.wantedlevelgainrate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangGenInfo](./bitburner.ganggeninfo.md) > [wantedLevelGainRate](./bitburner.ganggeninfo.wantedlevelgainrate.md) + +## GangGenInfo.wantedLevelGainRate property + +Wanted level gained/lost per second (negative for losses) + +Signature: + +```typescript +wantedLevelGainRate: number; +``` diff --git a/markdown/bitburner.gangmemberascension.agi.md b/markdown/bitburner.gangmemberascension.agi.md new file mode 100644 index 000000000..e71a93d18 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.agi.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [agi](./bitburner.gangmemberascension.agi.md) + +## GangMemberAscension.agi property + +Agility multiplier gained from ascending. Decimal form + +Signature: + +```typescript +agi: number; +``` diff --git a/markdown/bitburner.gangmemberascension.cha.md b/markdown/bitburner.gangmemberascension.cha.md new file mode 100644 index 000000000..4d063a046 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.cha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [cha](./bitburner.gangmemberascension.cha.md) + +## GangMemberAscension.cha property + +Charisma multiplier gained from ascending. Decimal form + +Signature: + +```typescript +cha: number; +``` diff --git a/markdown/bitburner.gangmemberascension.def.md b/markdown/bitburner.gangmemberascension.def.md new file mode 100644 index 000000000..e2fa14cbf --- /dev/null +++ b/markdown/bitburner.gangmemberascension.def.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [def](./bitburner.gangmemberascension.def.md) + +## GangMemberAscension.def property + +Defense multiplier gained from ascending. Decimal form + +Signature: + +```typescript +def: number; +``` diff --git a/markdown/bitburner.gangmemberascension.dex.md b/markdown/bitburner.gangmemberascension.dex.md new file mode 100644 index 000000000..aa5bcefdd --- /dev/null +++ b/markdown/bitburner.gangmemberascension.dex.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [dex](./bitburner.gangmemberascension.dex.md) + +## GangMemberAscension.dex property + +Dexterity multiplier gained from ascending. Decimal form + +Signature: + +```typescript +dex: number; +``` diff --git a/markdown/bitburner.gangmemberascension.hack.md b/markdown/bitburner.gangmemberascension.hack.md new file mode 100644 index 000000000..a39992c1a --- /dev/null +++ b/markdown/bitburner.gangmemberascension.hack.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [hack](./bitburner.gangmemberascension.hack.md) + +## GangMemberAscension.hack property + +Hacking multiplier gained from ascending. Decimal form + +Signature: + +```typescript +hack: number; +``` diff --git a/markdown/bitburner.gangmemberascension.md b/markdown/bitburner.gangmemberascension.md new file mode 100644 index 000000000..359bf0bc7 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) + +## GangMemberAscension interface + + +Signature: + +```typescript +interface GangMemberAscension +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agi](./bitburner.gangmemberascension.agi.md) | number | Agility multiplier gained from ascending. Decimal form | +| [cha](./bitburner.gangmemberascension.cha.md) | number | Charisma multiplier gained from ascending. Decimal form | +| [def](./bitburner.gangmemberascension.def.md) | number | Defense multiplier gained from ascending. Decimal form | +| [dex](./bitburner.gangmemberascension.dex.md) | number | Dexterity multiplier gained from ascending. Decimal form | +| [hack](./bitburner.gangmemberascension.hack.md) | number | Hacking multiplier gained from ascending. Decimal form | +| [respect](./bitburner.gangmemberascension.respect.md) | number | Amount of respect lost from ascending | +| [str](./bitburner.gangmemberascension.str.md) | number | Strength multiplier gained from ascending. Decimal form | + diff --git a/markdown/bitburner.gangmemberascension.respect.md b/markdown/bitburner.gangmemberascension.respect.md new file mode 100644 index 000000000..45b3bd042 --- /dev/null +++ b/markdown/bitburner.gangmemberascension.respect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [respect](./bitburner.gangmemberascension.respect.md) + +## GangMemberAscension.respect property + +Amount of respect lost from ascending + +Signature: + +```typescript +respect: number; +``` diff --git a/markdown/bitburner.gangmemberascension.str.md b/markdown/bitburner.gangmemberascension.str.md new file mode 100644 index 000000000..884e79dea --- /dev/null +++ b/markdown/bitburner.gangmemberascension.str.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberAscension](./bitburner.gangmemberascension.md) > [str](./bitburner.gangmemberascension.str.md) + +## GangMemberAscension.str property + +Strength multiplier gained from ascending. Decimal form + +Signature: + +```typescript +str: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.agility.md b/markdown/bitburner.gangmemberinfo.agility.md new file mode 100644 index 000000000..33c24d603 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.agility.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [agility](./bitburner.gangmemberinfo.agility.md) + +## GangMemberInfo.agility property + +Agility stat + +Signature: + +```typescript +agility: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.agilityascensionmult.md b/markdown/bitburner.gangmemberinfo.agilityascensionmult.md new file mode 100644 index 000000000..944b4667b --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.agilityascensionmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [agilityAscensionMult](./bitburner.gangmemberinfo.agilityascensionmult.md) + +## GangMemberInfo.agilityAscensionMult property + +Agility multiplier from ascension. Decimal form + +Signature: + +```typescript +agilityAscensionMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.agilityequipmult.md b/markdown/bitburner.gangmemberinfo.agilityequipmult.md new file mode 100644 index 000000000..d785bcafa --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.agilityequipmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [agilityEquipMult](./bitburner.gangmemberinfo.agilityequipmult.md) + +## GangMemberInfo.agilityEquipMult property + +Agility multiplier from equipment. Decimal form + +Signature: + +```typescript +agilityEquipMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.augmentations.md b/markdown/bitburner.gangmemberinfo.augmentations.md new file mode 100644 index 000000000..de464b6e1 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.augmentations.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [augmentations](./bitburner.gangmemberinfo.augmentations.md) + +## GangMemberInfo.augmentations property + +Array of names of all owned Augmentations + +Signature: + +```typescript +augmentations: GangAugmentations[]; +``` diff --git a/markdown/bitburner.gangmemberinfo.charisma.md b/markdown/bitburner.gangmemberinfo.charisma.md new file mode 100644 index 000000000..a54e293ee --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.charisma.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [charisma](./bitburner.gangmemberinfo.charisma.md) + +## GangMemberInfo.charisma property + +Charisma stat + +Signature: + +```typescript +charisma: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.charismaascensionmult.md b/markdown/bitburner.gangmemberinfo.charismaascensionmult.md new file mode 100644 index 000000000..2456cf45b --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.charismaascensionmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [charismaAscensionMult](./bitburner.gangmemberinfo.charismaascensionmult.md) + +## GangMemberInfo.charismaAscensionMult property + +Charisma multiplier from ascension. Decimal form + +Signature: + +```typescript +charismaAscensionMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.charismaequipmult.md b/markdown/bitburner.gangmemberinfo.charismaequipmult.md new file mode 100644 index 000000000..cc2665e05 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.charismaequipmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [charismaEquipMult](./bitburner.gangmemberinfo.charismaequipmult.md) + +## GangMemberInfo.charismaEquipMult property + +Charisma multiplier from equipment. Decimal form + +Signature: + +```typescript +charismaEquipMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.defense.md b/markdown/bitburner.gangmemberinfo.defense.md new file mode 100644 index 000000000..596640f4f --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.defense.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [defense](./bitburner.gangmemberinfo.defense.md) + +## GangMemberInfo.defense property + +Defense stat + +Signature: + +```typescript +defense: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.defenseascensionmult.md b/markdown/bitburner.gangmemberinfo.defenseascensionmult.md new file mode 100644 index 000000000..59089da48 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.defenseascensionmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [defenseAscensionMult](./bitburner.gangmemberinfo.defenseascensionmult.md) + +## GangMemberInfo.defenseAscensionMult property + +Defense multiplier from ascension. Decimal form + +Signature: + +```typescript +defenseAscensionMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.defenseequipmult.md b/markdown/bitburner.gangmemberinfo.defenseequipmult.md new file mode 100644 index 000000000..69d6af006 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.defenseequipmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [defenseEquipMult](./bitburner.gangmemberinfo.defenseequipmult.md) + +## GangMemberInfo.defenseEquipMult property + +Defense multiplier from equipment. Decimal form + +Signature: + +```typescript +defenseEquipMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.dexterity.md b/markdown/bitburner.gangmemberinfo.dexterity.md new file mode 100644 index 000000000..ca2ab1b5c --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.dexterity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [dexterity](./bitburner.gangmemberinfo.dexterity.md) + +## GangMemberInfo.dexterity property + +Dexterity stat + +Signature: + +```typescript +dexterity: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.dexterityascensionmult.md b/markdown/bitburner.gangmemberinfo.dexterityascensionmult.md new file mode 100644 index 000000000..db2ecbd94 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.dexterityascensionmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [dexterityAscensionMult](./bitburner.gangmemberinfo.dexterityascensionmult.md) + +## GangMemberInfo.dexterityAscensionMult property + +Dexterity multiplier from ascension. Decimal form + +Signature: + +```typescript +dexterityAscensionMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.dexterityequipmult.md b/markdown/bitburner.gangmemberinfo.dexterityequipmult.md new file mode 100644 index 000000000..461b442d8 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.dexterityequipmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [dexterityEquipMult](./bitburner.gangmemberinfo.dexterityequipmult.md) + +## GangMemberInfo.dexterityEquipMult property + +Dexterity multiplier from equipment. Decimal form + +Signature: + +```typescript +dexterityEquipMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.equipment.md b/markdown/bitburner.gangmemberinfo.equipment.md new file mode 100644 index 000000000..513416db3 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.equipment.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [equipment](./bitburner.gangmemberinfo.equipment.md) + +## GangMemberInfo.equipment property + +Array of names of all owned Non-Augmentation Equipment + +Signature: + +```typescript +equipment: GangEquipment[]; +``` diff --git a/markdown/bitburner.gangmemberinfo.hacking.md b/markdown/bitburner.gangmemberinfo.hacking.md new file mode 100644 index 000000000..81fb64d49 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.hacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [hacking](./bitburner.gangmemberinfo.hacking.md) + +## GangMemberInfo.hacking property + +Hacking stat + +Signature: + +```typescript +hacking: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.hackingascensionmult.md b/markdown/bitburner.gangmemberinfo.hackingascensionmult.md new file mode 100644 index 000000000..384cd30ee --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.hackingascensionmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [hackingAscensionMult](./bitburner.gangmemberinfo.hackingascensionmult.md) + +## GangMemberInfo.hackingAscensionMult property + +Hacking multiplier from ascension. Decimal form + +Signature: + +```typescript +hackingAscensionMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.hackingequipmult.md b/markdown/bitburner.gangmemberinfo.hackingequipmult.md new file mode 100644 index 000000000..50c5ca60f --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.hackingequipmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [hackingEquipMult](./bitburner.gangmemberinfo.hackingequipmult.md) + +## GangMemberInfo.hackingEquipMult property + +Hacking multiplier from equipment. Decimal form + +Signature: + +```typescript +hackingEquipMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.md b/markdown/bitburner.gangmemberinfo.md new file mode 100644 index 000000000..5d23e8245 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) + +## GangMemberInfo interface + + +Signature: + +```typescript +interface GangMemberInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility](./bitburner.gangmemberinfo.agility.md) | number | Agility stat | +| [agilityAscensionMult](./bitburner.gangmemberinfo.agilityascensionmult.md) | number | Agility multiplier from ascension. Decimal form | +| [agilityEquipMult](./bitburner.gangmemberinfo.agilityequipmult.md) | number | Agility multiplier from equipment. Decimal form | +| [augmentations](./bitburner.gangmemberinfo.augmentations.md) | [GangAugmentations](./bitburner.gangaugmentations.md)\[\] | Array of names of all owned Augmentations | +| [charisma](./bitburner.gangmemberinfo.charisma.md) | number | Charisma stat | +| [charismaAscensionMult](./bitburner.gangmemberinfo.charismaascensionmult.md) | number | Charisma multiplier from ascension. Decimal form | +| [charismaEquipMult](./bitburner.gangmemberinfo.charismaequipmult.md) | number | Charisma multiplier from equipment. Decimal form | +| [defense](./bitburner.gangmemberinfo.defense.md) | number | Defense stat | +| [defenseAscensionMult](./bitburner.gangmemberinfo.defenseascensionmult.md) | number | Defense multiplier from ascension. Decimal form | +| [defenseEquipMult](./bitburner.gangmemberinfo.defenseequipmult.md) | number | Defense multiplier from equipment. Decimal form | +| [dexterity](./bitburner.gangmemberinfo.dexterity.md) | number | Dexterity stat | +| [dexterityAscensionMult](./bitburner.gangmemberinfo.dexterityascensionmult.md) | number | Dexterity multiplier from ascension. Decimal form | +| [dexterityEquipMult](./bitburner.gangmemberinfo.dexterityequipmult.md) | number | Dexterity multiplier from equipment. Decimal form | +| [equipment](./bitburner.gangmemberinfo.equipment.md) | [GangEquipment](./bitburner.gangequipment.md)\[\] | Array of names of all owned Non-Augmentation Equipment | +| [hacking](./bitburner.gangmemberinfo.hacking.md) | number | Hacking stat | +| [hackingAscensionMult](./bitburner.gangmemberinfo.hackingascensionmult.md) | number | Hacking multiplier from ascension. Decimal form | +| [hackingEquipMult](./bitburner.gangmemberinfo.hackingequipmult.md) | number | Hacking multiplier from equipment. Decimal form | +| [strength](./bitburner.gangmemberinfo.strength.md) | number | Strength stat | +| [strengthAscensionMult](./bitburner.gangmemberinfo.strengthascensionmult.md) | number | Strength multiplier from ascension. Decimal form | +| [strengthEquipMult](./bitburner.gangmemberinfo.strengthequipmult.md) | number | Strength multiplier from equipment. Decimal form | +| [task](./bitburner.gangmemberinfo.task.md) | [GangTasks](./bitburner.gangtasks.md) | Name of currently assigned task | + diff --git a/markdown/bitburner.gangmemberinfo.strength.md b/markdown/bitburner.gangmemberinfo.strength.md new file mode 100644 index 000000000..0e12ed3f2 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.strength.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [strength](./bitburner.gangmemberinfo.strength.md) + +## GangMemberInfo.strength property + +Strength stat + +Signature: + +```typescript +strength: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.strengthascensionmult.md b/markdown/bitburner.gangmemberinfo.strengthascensionmult.md new file mode 100644 index 000000000..26aee7b8e --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.strengthascensionmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [strengthAscensionMult](./bitburner.gangmemberinfo.strengthascensionmult.md) + +## GangMemberInfo.strengthAscensionMult property + +Strength multiplier from ascension. Decimal form + +Signature: + +```typescript +strengthAscensionMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.strengthequipmult.md b/markdown/bitburner.gangmemberinfo.strengthequipmult.md new file mode 100644 index 000000000..3cfbac037 --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.strengthequipmult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [strengthEquipMult](./bitburner.gangmemberinfo.strengthequipmult.md) + +## GangMemberInfo.strengthEquipMult property + +Strength multiplier from equipment. Decimal form + +Signature: + +```typescript +strengthEquipMult: number; +``` diff --git a/markdown/bitburner.gangmemberinfo.task.md b/markdown/bitburner.gangmemberinfo.task.md new file mode 100644 index 000000000..240642ebb --- /dev/null +++ b/markdown/bitburner.gangmemberinfo.task.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangMemberInfo](./bitburner.gangmemberinfo.md) > [task](./bitburner.gangmemberinfo.task.md) + +## GangMemberInfo.task property + +Name of currently assigned task + +Signature: + +```typescript +task: GangTasks; +``` diff --git a/markdown/bitburner.gangname.md b/markdown/bitburner.gangname.md new file mode 100644 index 000000000..6b65be140 --- /dev/null +++ b/markdown/bitburner.gangname.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangName](./bitburner.gangname.md) + +## GangName type + +Signature: + +```typescript +type GangName = + | "Slum Snakes" + | "Tetrads" + | "The Syndicate" + | "The Dark Army" + | "Speakers for the Dead" + | "NiteSec" + | "The Black Hand"; +``` diff --git a/markdown/bitburner.gangotherinfo.md b/markdown/bitburner.gangotherinfo.md new file mode 100644 index 000000000..def8ff124 --- /dev/null +++ b/markdown/bitburner.gangotherinfo.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangOtherInfo](./bitburner.gangotherinfo.md) + +## GangOtherInfo type + +Signature: + +```typescript +type GangOtherInfo = { + /** Stock Symbol */ + [key in GangName]: GangOtherInfoObject[]; +}; +``` +References: [GangName](./bitburner.gangname.md), [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) + diff --git a/markdown/bitburner.gangotherinfoobject.md b/markdown/bitburner.gangotherinfoobject.md new file mode 100644 index 000000000..32c870ca1 --- /dev/null +++ b/markdown/bitburner.gangotherinfoobject.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) + +## GangOtherInfoObject interface + + +Signature: + +```typescript +interface GangOtherInfoObject +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [power](./bitburner.gangotherinfoobject.power.md) | number | Gang power | +| [territory](./bitburner.gangotherinfoobject.territory.md) | number | Gang territory, in decimal form | + diff --git a/markdown/bitburner.gangotherinfoobject.power.md b/markdown/bitburner.gangotherinfoobject.power.md new file mode 100644 index 000000000..58986c561 --- /dev/null +++ b/markdown/bitburner.gangotherinfoobject.power.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) > [power](./bitburner.gangotherinfoobject.power.md) + +## GangOtherInfoObject.power property + +Gang power + +Signature: + +```typescript +power: number; +``` diff --git a/markdown/bitburner.gangotherinfoobject.territory.md b/markdown/bitburner.gangotherinfoobject.territory.md new file mode 100644 index 000000000..9314c4fc4 --- /dev/null +++ b/markdown/bitburner.gangotherinfoobject.territory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) > [territory](./bitburner.gangotherinfoobject.territory.md) + +## GangOtherInfoObject.territory property + +Gang territory, in decimal form + +Signature: + +```typescript +territory: number; +``` diff --git a/markdown/bitburner.gangtasks.md b/markdown/bitburner.gangtasks.md new file mode 100644 index 000000000..af6323826 --- /dev/null +++ b/markdown/bitburner.gangtasks.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasks](./bitburner.gangtasks.md) + +## GangTasks type + +Signature: + +```typescript +type GangTasks = + | "Unassigned" + | "Ransomware" + | "Phishing" + | "Identity Theft" + | "DDoS Attacks" + | "Plant Virus" + | "Fraud & Counterfeiting" + | "Money Laundering" + | "Cyberterrorism" + | "Ethical Hacking" + | "Mug People" + | "Deal Drugs" + | "Strongarm Civilians" + | "Run a Con" + | "Armed Robbery" + | "Traffick Illegal Arms" + | "Threaten & Blackmail" + | "Human Trafficking" + | "Terrorism" + | "Vigilante Justice" + | "Train Combat" + | "Train Hacking" + | "Train Charisma" + | "Territory Warfare"; +``` diff --git a/markdown/bitburner.gangtasksstats.agiweight.md b/markdown/bitburner.gangtasksstats.agiweight.md new file mode 100644 index 000000000..78d3d9372 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.agiweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [agiWeight](./bitburner.gangtasksstats.agiweight.md) + +## GangTasksStats.agiWeight property + +Agility skill impact on task scaling + +Signature: + +```typescript +agiWeight: number; +``` diff --git a/markdown/bitburner.gangtasksstats.basemoney.md b/markdown/bitburner.gangtasksstats.basemoney.md new file mode 100644 index 000000000..ddec18ff4 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.basemoney.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [baseMoney](./bitburner.gangtasksstats.basemoney.md) + +## GangTasksStats.baseMoney property + +Base money earned + +Signature: + +```typescript +baseMoney: number; +``` diff --git a/markdown/bitburner.gangtasksstats.baserespect.md b/markdown/bitburner.gangtasksstats.baserespect.md new file mode 100644 index 000000000..2cebf8a23 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.baserespect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [baseRespect](./bitburner.gangtasksstats.baserespect.md) + +## GangTasksStats.baseRespect property + +Base respect earned + +Signature: + +```typescript +baseRespect: number; +``` diff --git a/markdown/bitburner.gangtasksstats.basewanted.md b/markdown/bitburner.gangtasksstats.basewanted.md new file mode 100644 index 000000000..635ff5755 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.basewanted.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [baseWanted](./bitburner.gangtasksstats.basewanted.md) + +## GangTasksStats.baseWanted property + +Base wanted earned + +Signature: + +```typescript +baseWanted: number; +``` diff --git a/markdown/bitburner.gangtasksstats.chaweight.md b/markdown/bitburner.gangtasksstats.chaweight.md new file mode 100644 index 000000000..c2ac795ff --- /dev/null +++ b/markdown/bitburner.gangtasksstats.chaweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [chaWeight](./bitburner.gangtasksstats.chaweight.md) + +## GangTasksStats.chaWeight property + +Charisma skill impact on task scaling + +Signature: + +```typescript +chaWeight: number; +``` diff --git a/markdown/bitburner.gangtasksstats.defweight.md b/markdown/bitburner.gangtasksstats.defweight.md new file mode 100644 index 000000000..67299a579 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.defweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [defWeight](./bitburner.gangtasksstats.defweight.md) + +## GangTasksStats.defWeight property + +Defense skill impact on task scaling + +Signature: + +```typescript +defWeight: number; +``` diff --git a/markdown/bitburner.gangtasksstats.desc.md b/markdown/bitburner.gangtasksstats.desc.md new file mode 100644 index 000000000..eff5d3490 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.desc.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [desc](./bitburner.gangtasksstats.desc.md) + +## GangTasksStats.desc property + +Task Description + +Signature: + +```typescript +desc: string; +``` diff --git a/markdown/bitburner.gangtasksstats.dexweight.md b/markdown/bitburner.gangtasksstats.dexweight.md new file mode 100644 index 000000000..d3a5d8cdf --- /dev/null +++ b/markdown/bitburner.gangtasksstats.dexweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [dexWeight](./bitburner.gangtasksstats.dexweight.md) + +## GangTasksStats.dexWeight property + +Dexterity skill impact on task scaling + +Signature: + +```typescript +dexWeight: number; +``` diff --git a/markdown/bitburner.gangtasksstats.difficulty.md b/markdown/bitburner.gangtasksstats.difficulty.md new file mode 100644 index 000000000..ad17933b1 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.difficulty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [difficulty](./bitburner.gangtasksstats.difficulty.md) + +## GangTasksStats.difficulty property + +Number representing the difficulty of the task + +Signature: + +```typescript +difficulty: number; +``` diff --git a/markdown/bitburner.gangtasksstats.hackweight.md b/markdown/bitburner.gangtasksstats.hackweight.md new file mode 100644 index 000000000..fec445565 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.hackweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [hackWeight](./bitburner.gangtasksstats.hackweight.md) + +## GangTasksStats.hackWeight property + +Hacking skill impact on task scaling + +Signature: + +```typescript +hackWeight: number; +``` diff --git a/markdown/bitburner.gangtasksstats.iscombat.md b/markdown/bitburner.gangtasksstats.iscombat.md new file mode 100644 index 000000000..f1c4d610b --- /dev/null +++ b/markdown/bitburner.gangtasksstats.iscombat.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [isCombat](./bitburner.gangtasksstats.iscombat.md) + +## GangTasksStats.isCombat property + +Is a task of a combat gang + +Signature: + +```typescript +isCombat: boolean; +``` diff --git a/markdown/bitburner.gangtasksstats.ishacking.md b/markdown/bitburner.gangtasksstats.ishacking.md new file mode 100644 index 000000000..1f0f615c8 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.ishacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [isHacking](./bitburner.gangtasksstats.ishacking.md) + +## GangTasksStats.isHacking property + +Is a task of a hacking gang + +Signature: + +```typescript +isHacking: boolean; +``` diff --git a/markdown/bitburner.gangtasksstats.md b/markdown/bitburner.gangtasksstats.md new file mode 100644 index 000000000..e2125e8f4 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) + +## GangTasksStats interface + + +Signature: + +```typescript +interface GangTasksStats +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agiWeight](./bitburner.gangtasksstats.agiweight.md) | number | Agility skill impact on task scaling | +| [baseMoney](./bitburner.gangtasksstats.basemoney.md) | number | Base money earned | +| [baseRespect](./bitburner.gangtasksstats.baserespect.md) | number | Base respect earned | +| [baseWanted](./bitburner.gangtasksstats.basewanted.md) | number | Base wanted earned | +| [chaWeight](./bitburner.gangtasksstats.chaweight.md) | number | Charisma skill impact on task scaling | +| [defWeight](./bitburner.gangtasksstats.defweight.md) | number | Defense skill impact on task scaling | +| [desc](./bitburner.gangtasksstats.desc.md) | string | Task Description | +| [dexWeight](./bitburner.gangtasksstats.dexweight.md) | number | Dexterity skill impact on task scaling | +| [difficulty](./bitburner.gangtasksstats.difficulty.md) | number | Number representing the difficulty of the task | +| [hackWeight](./bitburner.gangtasksstats.hackweight.md) | number | Hacking skill impact on task scaling | +| [isCombat](./bitburner.gangtasksstats.iscombat.md) | boolean | Is a task of a combat gang | +| [isHacking](./bitburner.gangtasksstats.ishacking.md) | boolean | Is a task of a hacking gang | +| [name](./bitburner.gangtasksstats.name.md) | [GangTasks](./bitburner.gangtasks.md) | Task name | +| [strWeight](./bitburner.gangtasksstats.strweight.md) | number | Stength skill impact on task scaling | +| [territory](./bitburner.gangtasksstats.territory.md) | [GangTasksTerritory](./bitburner.gangtasksterritory.md) | Territory impact on task scaling | + diff --git a/markdown/bitburner.gangtasksstats.name.md b/markdown/bitburner.gangtasksstats.name.md new file mode 100644 index 000000000..bb6287ba2 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [name](./bitburner.gangtasksstats.name.md) + +## GangTasksStats.name property + +Task name + +Signature: + +```typescript +name: GangTasks; +``` diff --git a/markdown/bitburner.gangtasksstats.strweight.md b/markdown/bitburner.gangtasksstats.strweight.md new file mode 100644 index 000000000..49be07da6 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.strweight.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [strWeight](./bitburner.gangtasksstats.strweight.md) + +## GangTasksStats.strWeight property + +Stength skill impact on task scaling + +Signature: + +```typescript +strWeight: number; +``` diff --git a/markdown/bitburner.gangtasksstats.territory.md b/markdown/bitburner.gangtasksstats.territory.md new file mode 100644 index 000000000..0d4ec5ae3 --- /dev/null +++ b/markdown/bitburner.gangtasksstats.territory.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksStats](./bitburner.gangtasksstats.md) > [territory](./bitburner.gangtasksstats.territory.md) + +## GangTasksStats.territory property + +Territory impact on task scaling + +Signature: + +```typescript +territory: GangTasksTerritory; +``` diff --git a/markdown/bitburner.gangtasksterritory.md b/markdown/bitburner.gangtasksterritory.md new file mode 100644 index 000000000..042c68d35 --- /dev/null +++ b/markdown/bitburner.gangtasksterritory.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksTerritory](./bitburner.gangtasksterritory.md) + +## GangTasksTerritory interface + + +Signature: + +```typescript +interface GangTasksTerritory +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [money](./bitburner.gangtasksterritory.money.md) | number | Money gain impact on task scaling | +| [respect](./bitburner.gangtasksterritory.respect.md) | number | Respect gain impact on task scaling | +| [wanted](./bitburner.gangtasksterritory.wanted.md) | number | Wanted gain impact on task scaling | + diff --git a/markdown/bitburner.gangtasksterritory.money.md b/markdown/bitburner.gangtasksterritory.money.md new file mode 100644 index 000000000..8fe1175e7 --- /dev/null +++ b/markdown/bitburner.gangtasksterritory.money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksTerritory](./bitburner.gangtasksterritory.md) > [money](./bitburner.gangtasksterritory.money.md) + +## GangTasksTerritory.money property + +Money gain impact on task scaling + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.gangtasksterritory.respect.md b/markdown/bitburner.gangtasksterritory.respect.md new file mode 100644 index 000000000..8d5c77e47 --- /dev/null +++ b/markdown/bitburner.gangtasksterritory.respect.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksTerritory](./bitburner.gangtasksterritory.md) > [respect](./bitburner.gangtasksterritory.respect.md) + +## GangTasksTerritory.respect property + +Respect gain impact on task scaling + +Signature: + +```typescript +respect: number; +``` diff --git a/markdown/bitburner.gangtasksterritory.wanted.md b/markdown/bitburner.gangtasksterritory.wanted.md new file mode 100644 index 000000000..05f776eeb --- /dev/null +++ b/markdown/bitburner.gangtasksterritory.wanted.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GangTasksTerritory](./bitburner.gangtasksterritory.md) > [wanted](./bitburner.gangtasksterritory.wanted.md) + +## GangTasksTerritory.wanted property + +Wanted gain impact on task scaling + +Signature: + +```typescript +wanted: number; +``` diff --git a/markdown/bitburner.gym.md b/markdown/bitburner.gym.md new file mode 100644 index 000000000..aa9d0fef5 --- /dev/null +++ b/markdown/bitburner.gym.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Gym](./bitburner.gym.md) + +## Gym type + +Signature: + +```typescript +type Gym = "Crush Fitness Gym" | "Snap Fitness Gym" | "Iron Gym" | "Powerhouse Gym" | "Millenium Fitness Gym"; +``` diff --git a/markdown/bitburner.gymstat.md b/markdown/bitburner.gymstat.md new file mode 100644 index 000000000..665f77e47 --- /dev/null +++ b/markdown/bitburner.gymstat.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [GymStat](./bitburner.gymstat.md) + +## GymStat type + +Signature: + +```typescript +type GymStat = "str" | "def" | "dex" | "agi"; +``` diff --git a/markdown/bitburner.hackingmultipliers.chance.md b/markdown/bitburner.hackingmultipliers.chance.md new file mode 100644 index 000000000..9f7b5c2b5 --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.chance.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) > [chance](./bitburner.hackingmultipliers.chance.md) + +## HackingMultipliers.chance property + +Player's hacking chance multiplier. + +Signature: + +```typescript +chance: number; +``` diff --git a/markdown/bitburner.hackingmultipliers.growth.md b/markdown/bitburner.hackingmultipliers.growth.md new file mode 100644 index 000000000..43ad29e2d --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.growth.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) > [growth](./bitburner.hackingmultipliers.growth.md) + +## HackingMultipliers.growth property + +Player's hacking growth multiplier + +Signature: + +```typescript +growth: number; +``` diff --git a/markdown/bitburner.hackingmultipliers.md b/markdown/bitburner.hackingmultipliers.md new file mode 100644 index 000000000..78f4fab06 --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) + +## HackingMultipliers interface + + +Signature: + +```typescript +interface HackingMultipliers +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [chance](./bitburner.hackingmultipliers.chance.md) | number | Player's hacking chance multiplier. | +| [growth](./bitburner.hackingmultipliers.growth.md) | number | Player's hacking growth multiplier | +| [money](./bitburner.hackingmultipliers.money.md) | number | Player's hacking money stolen multiplier. | +| [speed](./bitburner.hackingmultipliers.speed.md) | number | Player's hacking speed multiplier. | + diff --git a/markdown/bitburner.hackingmultipliers.money.md b/markdown/bitburner.hackingmultipliers.money.md new file mode 100644 index 000000000..e578aaa14 --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.money.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) > [money](./bitburner.hackingmultipliers.money.md) + +## HackingMultipliers.money property + +Player's hacking money stolen multiplier. + +Signature: + +```typescript +money: number; +``` diff --git a/markdown/bitburner.hackingmultipliers.speed.md b/markdown/bitburner.hackingmultipliers.speed.md new file mode 100644 index 000000000..646bec789 --- /dev/null +++ b/markdown/bitburner.hackingmultipliers.speed.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackingMultipliers](./bitburner.hackingmultipliers.md) > [speed](./bitburner.hackingmultipliers.speed.md) + +## HackingMultipliers.speed property + +Player's hacking speed multiplier. + +Signature: + +```typescript +speed: number; +``` diff --git a/markdown/bitburner.hacknet.getcacheupgradecost.md b/markdown/bitburner.hacknet.getcacheupgradecost.md new file mode 100644 index 000000000..d7feb4bee --- /dev/null +++ b/markdown/bitburner.hacknet.getcacheupgradecost.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [getCacheUpgradeCost](./bitburner.hacknet.getcacheupgradecost.md) + +## HackNet.getCacheUpgradeCost() method + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Returns the cost of upgrading the cache level of the specified Hacknet Server by n. + +If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. + +Signature: + +```typescript +getCacheUpgradeCost(index: number, n: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of times to upgrade cache. Must be positive. Rounded to nearest integer. | + +Returns: + +number + +Cost of upgrading the specified Hacknet Node's cache. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.getcoreupgradecost.md b/markdown/bitburner.hacknet.getcoreupgradecost.md new file mode 100644 index 000000000..6d773bf0e --- /dev/null +++ b/markdown/bitburner.hacknet.getcoreupgradecost.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [getCoreUpgradeCost](./bitburner.hacknet.getcoreupgradecost.md) + +## HackNet.getCoreUpgradeCost() method + +Returns the cost of upgrading the number of cores of the specified Hacknet Node by n. + +If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. + +Signature: + +```typescript +getCoreUpgradeCost(index: number, n: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of times to upgrade cores. Must be positive. Rounded to nearest integer. | + +Returns: + +number + +Cost of upgrading the specified Hacknet Node's number of cores. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.getlevelupgradecost.md b/markdown/bitburner.hacknet.getlevelupgradecost.md new file mode 100644 index 000000000..adda51ea7 --- /dev/null +++ b/markdown/bitburner.hacknet.getlevelupgradecost.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [getLevelUpgradeCost](./bitburner.hacknet.getlevelupgradecost.md) + +## HackNet.getLevelUpgradeCost() method + +Returns the cost of upgrading the specified Hacknet Node by n levels. + +If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. + +Signature: + +```typescript +getLevelUpgradeCost(index: number, n: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of levels to upgrade. Must be positive. Rounded to nearest integer. | + +Returns: + +number + +Cost of upgrading the specified Hacknet Node. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.getnodestats.md b/markdown/bitburner.hacknet.getnodestats.md new file mode 100644 index 000000000..9129252ac --- /dev/null +++ b/markdown/bitburner.hacknet.getnodestats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [getNodeStats](./bitburner.hacknet.getnodestats.md) + +## HackNet.getNodeStats() method + +Returns an object containing a variety of stats about the specified Hacknet Node. + +Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates. + +Signature: + +```typescript +getNodeStats(index: number): NodeStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node | + +Returns: + +[NodeStats](./bitburner.nodestats.md) + +Object containing a variety of stats about the specified Hacknet Node. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.getpurchasenodecost.md b/markdown/bitburner.hacknet.getpurchasenodecost.md new file mode 100644 index 000000000..105af5ea8 --- /dev/null +++ b/markdown/bitburner.hacknet.getpurchasenodecost.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [getPurchaseNodeCost](./bitburner.hacknet.getpurchasenodecost.md) + +## HackNet.getPurchaseNodeCost() method + +Returns the cost of purchasing a new Hacknet Node. + +Signature: + +```typescript +getPurchaseNodeCost(): number; +``` +Returns: + +number + +Cost of purchasing a new Hacknet Node. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.getramupgradecost.md b/markdown/bitburner.hacknet.getramupgradecost.md new file mode 100644 index 000000000..4bf38cf34 --- /dev/null +++ b/markdown/bitburner.hacknet.getramupgradecost.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [getRamUpgradeCost](./bitburner.hacknet.getramupgradecost.md) + +## HackNet.getRamUpgradeCost() method + +Returns the cost of upgrading the RAM of the specified Hacknet Node n times. + +If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. + +Signature: + +```typescript +getRamUpgradeCost(index: number, n: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. | + +Returns: + +number + +Cost of upgrading the specified Hacknet Node's ram. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.hashcost.md b/markdown/bitburner.hacknet.hashcost.md new file mode 100644 index 000000000..52e4055d1 --- /dev/null +++ b/markdown/bitburner.hacknet.hashcost.md @@ -0,0 +1,42 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [hashCost](./bitburner.hacknet.hashcost.md) + +## HackNet.hashCost() method + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match. + +Signature: + +```typescript +hashCost(upgName: HashUpgrades): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgName | [HashUpgrades](./bitburner.hashupgrades.md) | Name of the upgrade of Hacknet Node. | + +Returns: + +number + +Number of hashes required for the specified upgrade. + +## Remarks + +0 GB + +## Example + + +```js +var upgradeName = "Sell for Corporation Funds"; +if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) { + hacknet.spendHashes(upgName); +} +``` + diff --git a/markdown/bitburner.hacknet.md b/markdown/bitburner.hacknet.md new file mode 100644 index 000000000..29eb4069f --- /dev/null +++ b/markdown/bitburner.hacknet.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) + +## HackNet interface + + +Signature: + +```typescript +interface HackNet +``` + +## Methods + +| Method | Description | +| --- | --- | +| [getCacheUpgradeCost(index, n)](./bitburner.hacknet.getcacheupgradecost.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Returns the cost of upgrading the cache level of the specified Hacknet Server by n.If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. | +| [getCoreUpgradeCost(index, n)](./bitburner.hacknet.getcoreupgradecost.md) | Returns the cost of upgrading the number of cores of the specified Hacknet Node by n.If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. | +| [getLevelUpgradeCost(index, n)](./bitburner.hacknet.getlevelupgradecost.md) | Returns the cost of upgrading the specified Hacknet Node by n levels.If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. | +| [getNodeStats(index)](./bitburner.hacknet.getnodestats.md) | Returns an object containing a variety of stats about the specified Hacknet Node.Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates. | +| [getPurchaseNodeCost()](./bitburner.hacknet.getpurchasenodecost.md) | Returns the cost of purchasing a new Hacknet Node. | +| [getRamUpgradeCost(index, n)](./bitburner.hacknet.getramupgradecost.md) | Returns the cost of upgrading the RAM of the specified Hacknet Node n times.If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned. | +| [hashCost(upgName)](./bitburner.hacknet.hashcost.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match. | +| [numHashes()](./bitburner.hacknet.numhashes.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Returns the number of hashes you have. | +| [numNodes()](./bitburner.hacknet.numnodes.md) | Returns the number of Hacknet Nodes you own. | +| [purchaseNode()](./bitburner.hacknet.purchasenode.md) | Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named \`hacknet-node-4\` will have an index of 4).If the player cannot afford to purchase a new Hacknet Node then the function will return -1. | +| [spendHashes(upgName, upgTarget)](./bitburner.hacknet.spendhashes.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.The name of the upgrade must be an exact match. The \`upgTarget\` argument is used for upgrades such as \`Reduce Minimum Security\`, which applies to a specific server. In this case, the \`upgTarget\` argument must be the hostname of the server. | +| [upgradeCache(index, n)](./bitburner.hacknet.upgradecache.md) | This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).Tries to upgrade the specified Hacknet Server’s cache n times.Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level.Returns false otherwise. | +| [upgradeCore(index, n)](./bitburner.hacknet.upgradecore.md) | Tries to purchase n cores for the specified Hacknet Node.Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores.Returns false otherwise. | +| [upgradeLevel(index, n)](./bitburner.hacknet.upgradelevel.md) | Tries to upgrade the level of the specified Hacknet Node by n.Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level.Returns false otherwise. | +| [upgradeRam(index, n)](./bitburner.hacknet.upgraderam.md) | Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n.Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM.Returns false otherwise. | + diff --git a/markdown/bitburner.hacknet.numhashes.md b/markdown/bitburner.hacknet.numhashes.md new file mode 100644 index 000000000..42d84c97f --- /dev/null +++ b/markdown/bitburner.hacknet.numhashes.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [numHashes](./bitburner.hacknet.numhashes.md) + +## HackNet.numHashes() method + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Returns the number of hashes you have. + +Signature: + +```typescript +numHashes(): number; +``` +Returns: + +number + +Number of hashes you have. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.numnodes.md b/markdown/bitburner.hacknet.numnodes.md new file mode 100644 index 000000000..5e96a545a --- /dev/null +++ b/markdown/bitburner.hacknet.numnodes.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [numNodes](./bitburner.hacknet.numnodes.md) + +## HackNet.numNodes() method + +Returns the number of Hacknet Nodes you own. + +Signature: + +```typescript +numNodes(): number; +``` +Returns: + +number + +number of hacknet nodes. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.purchasenode.md b/markdown/bitburner.hacknet.purchasenode.md new file mode 100644 index 000000000..d4b8bc580 --- /dev/null +++ b/markdown/bitburner.hacknet.purchasenode.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [purchaseNode](./bitburner.hacknet.purchasenode.md) + +## HackNet.purchaseNode() method + +Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named \`hacknet-node-4\` will have an index of 4). + +If the player cannot afford to purchase a new Hacknet Node then the function will return -1. + +Signature: + +```typescript +purchaseNode(): number; +``` +Returns: + +number + +The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.spendhashes.md b/markdown/bitburner.hacknet.spendhashes.md new file mode 100644 index 000000000..168389e76 --- /dev/null +++ b/markdown/bitburner.hacknet.spendhashes.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [spendHashes](./bitburner.hacknet.spendhashes.md) + +## HackNet.spendHashes() method + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise. + +The name of the upgrade must be an exact match. The \`upgTarget\` argument is used for upgrades such as \`Reduce Minimum Security\`, which applies to a specific server. In this case, the \`upgTarget\` argument must be the hostname of the server. + +Signature: + +```typescript +spendHashes(upgName: HashUpgrades, upgTarget?: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| upgName | [HashUpgrades](./bitburner.hashupgrades.md) | Name of the upgrade of Hacknet Node. | +| upgTarget | [Host](./bitburner.host.md) | Object to which upgrade applies. Required for certain upgrades. | + +Returns: + +boolean + +True if the upgrade is successfully purchased, and false otherwise.. + +## Remarks + +0 GB + +## Example + + +```js +hacknet.spendHashes("Sell for Corporation Funds"); +hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); +``` + diff --git a/markdown/bitburner.hacknet.upgradecache.md b/markdown/bitburner.hacknet.upgradecache.md new file mode 100644 index 000000000..86f9260c1 --- /dev/null +++ b/markdown/bitburner.hacknet.upgradecache.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [upgradeCache](./bitburner.hacknet.upgradecache.md) + +## HackNet.upgradeCache() method + +This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node). + +Tries to upgrade the specified Hacknet Server’s cache n times. + +Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level. + +Returns false otherwise. + +Signature: + +```typescript +upgradeCache(index: number, n: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of cache levels to purchase. Must be positive. Rounded to nearest integer. | + +Returns: + +boolean + +True if the Hacknet Node’s cores are successfully purchased, false otherwise. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.upgradecore.md b/markdown/bitburner.hacknet.upgradecore.md new file mode 100644 index 000000000..8bc1fe761 --- /dev/null +++ b/markdown/bitburner.hacknet.upgradecore.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [upgradeCore](./bitburner.hacknet.upgradecore.md) + +## HackNet.upgradeCore() method + +Tries to purchase n cores for the specified Hacknet Node. + +Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores. + +Returns false otherwise. + +Signature: + +```typescript +upgradeCore(index: number, n: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of cores to purchase. Must be positive. Rounded to nearest integer. | + +Returns: + +boolean + +True if the Hacknet Node’s cores are successfully purchased, false otherwise. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.upgradelevel.md b/markdown/bitburner.hacknet.upgradelevel.md new file mode 100644 index 000000000..0a674e093 --- /dev/null +++ b/markdown/bitburner.hacknet.upgradelevel.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [upgradeLevel](./bitburner.hacknet.upgradelevel.md) + +## HackNet.upgradeLevel() method + +Tries to upgrade the level of the specified Hacknet Node by n. + +Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level. + +Returns false otherwise. + +Signature: + +```typescript +upgradeLevel(index: number, n: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of levels to purchase. Must be positive. Rounded to nearest integer. | + +Returns: + +boolean + +True if the Hacknet Node’s level is successfully upgraded, false otherwise. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknet.upgraderam.md b/markdown/bitburner.hacknet.upgraderam.md new file mode 100644 index 000000000..daa0fc6b5 --- /dev/null +++ b/markdown/bitburner.hacknet.upgraderam.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HackNet](./bitburner.hacknet.md) > [upgradeRam](./bitburner.hacknet.upgraderam.md) + +## HackNet.upgradeRam() method + +Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n. + +Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM. + +Returns false otherwise. + +Signature: + +```typescript +upgradeRam(index: number, n: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| index | number | Index/Identifier of Hacknet Node. | +| n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. | + +Returns: + +boolean + +True if the Hacknet Node’s ram is successfully upgraded, false otherwise. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.hacknetmultipliers.corecost.md b/markdown/bitburner.hacknetmultipliers.corecost.md new file mode 100644 index 000000000..2e9abb0dc --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.corecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [coreCost](./bitburner.hacknetmultipliers.corecost.md) + +## HacknetMultipliers.coreCost property + +Player's hacknet core cost multiplier + +Signature: + +```typescript +coreCost: number; +``` diff --git a/markdown/bitburner.hacknetmultipliers.levelcost.md b/markdown/bitburner.hacknetmultipliers.levelcost.md new file mode 100644 index 000000000..a09526c7e --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.levelcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [levelCost](./bitburner.hacknetmultipliers.levelcost.md) + +## HacknetMultipliers.levelCost property + +Player's hacknet level cost multiplier + +Signature: + +```typescript +levelCost: number; +``` diff --git a/markdown/bitburner.hacknetmultipliers.md b/markdown/bitburner.hacknetmultipliers.md new file mode 100644 index 000000000..f2b7c1eeb --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) + +## HacknetMultipliers interface + + +Signature: + +```typescript +interface HacknetMultipliers +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [coreCost](./bitburner.hacknetmultipliers.corecost.md) | number | Player's hacknet core cost multiplier | +| [levelCost](./bitburner.hacknetmultipliers.levelcost.md) | number | Player's hacknet level cost multiplier | +| [production](./bitburner.hacknetmultipliers.production.md) | number | Player's hacknet production multiplier | +| [purchaseCost](./bitburner.hacknetmultipliers.purchasecost.md) | number | Player's hacknet purchase cost multiplier | +| [ramCost](./bitburner.hacknetmultipliers.ramcost.md) | number | Player's hacknet ram cost multiplier | + diff --git a/markdown/bitburner.hacknetmultipliers.production.md b/markdown/bitburner.hacknetmultipliers.production.md new file mode 100644 index 000000000..5b60f1d4a --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.production.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [production](./bitburner.hacknetmultipliers.production.md) + +## HacknetMultipliers.production property + +Player's hacknet production multiplier + +Signature: + +```typescript +production: number; +``` diff --git a/markdown/bitburner.hacknetmultipliers.purchasecost.md b/markdown/bitburner.hacknetmultipliers.purchasecost.md new file mode 100644 index 000000000..04a481172 --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.purchasecost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [purchaseCost](./bitburner.hacknetmultipliers.purchasecost.md) + +## HacknetMultipliers.purchaseCost property + +Player's hacknet purchase cost multiplier + +Signature: + +```typescript +purchaseCost: number; +``` diff --git a/markdown/bitburner.hacknetmultipliers.ramcost.md b/markdown/bitburner.hacknetmultipliers.ramcost.md new file mode 100644 index 000000000..94ac4a3c8 --- /dev/null +++ b/markdown/bitburner.hacknetmultipliers.ramcost.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HacknetMultipliers](./bitburner.hacknetmultipliers.md) > [ramCost](./bitburner.hacknetmultipliers.ramcost.md) + +## HacknetMultipliers.ramCost property + +Player's hacknet ram cost multiplier + +Signature: + +```typescript +ramCost: number; +``` diff --git a/markdown/bitburner.handle.md b/markdown/bitburner.handle.md new file mode 100644 index 000000000..3ed082733 --- /dev/null +++ b/markdown/bitburner.handle.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Handle](./bitburner.handle.md) + +## Handle type + +Signature: + +```typescript +type Handle = string | Port; +``` +References: [Port](./bitburner.port.md) + diff --git a/markdown/bitburner.hashupgrades.md b/markdown/bitburner.hashupgrades.md new file mode 100644 index 000000000..ed7def030 --- /dev/null +++ b/markdown/bitburner.hashupgrades.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [HashUpgrades](./bitburner.hashupgrades.md) + +## HashUpgrades type + +Signature: + +```typescript +type HashUpgrades = + | "Sell for Money" + | "Sell for Corporation Funds" + | "Reduce Minimum Security" + | "Increase Maximum Money" + | "Improve Studying" + | "Improve Gym Training" + | "Exchange for Corporation Research" + | "Exchange for Bladeburner Rank" + | "Exchange for Bladeburner SP" + | "Generate Coding Contract"; +``` diff --git a/markdown/bitburner.host.md b/markdown/bitburner.host.md new file mode 100644 index 000000000..cf5b83f4e --- /dev/null +++ b/markdown/bitburner.host.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Host](./bitburner.host.md) + +## Host type + +Signature: + +```typescript +type Host = string; +``` diff --git a/markdown/bitburner.md b/markdown/bitburner.md new file mode 100644 index 000000000..bce5f6a48 --- /dev/null +++ b/markdown/bitburner.md @@ -0,0 +1,87 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) + +## bitburner package + +## Interfaces + +| Interface | Description | +| --- | --- | +| [AugmentationStats](./bitburner.augmentationstats.md) | | +| [AugmentPair](./bitburner.augmentpair.md) | | +| [BasicHGWOptions](./bitburner.basichgwoptions.md) | | +| [BitNodeMultipliers](./bitburner.bitnodemultipliers.md) | | +| [Bladeburner](./bitburner.bladeburner.md) | | +| [BladeburnerCurAction](./bitburner.bladeburnercuraction.md) | | +| [CharacterInfo](./bitburner.characterinfo.md) | | +| [CharacterMult](./bitburner.charactermult.md) | | +| [CodingAttemptOptions](./bitburner.codingattemptoptions.md) | | +| [CodingContract](./bitburner.codingcontract.md) | | +| [CrimeStats](./bitburner.crimestats.md) | | +| [Gang](./bitburner.gang.md) | | +| [GangEquipmentStats](./bitburner.gangequipmentstats.md) | | +| [GangGenInfo](./bitburner.ganggeninfo.md) | | +| [GangMemberAscension](./bitburner.gangmemberascension.md) | | +| [GangMemberInfo](./bitburner.gangmemberinfo.md) | | +| [GangOtherInfoObject](./bitburner.gangotherinfoobject.md) | | +| [GangTasksStats](./bitburner.gangtasksstats.md) | | +| [GangTasksTerritory](./bitburner.gangtasksterritory.md) | | +| [HackingMultipliers](./bitburner.hackingmultipliers.md) | | +| [HackNet](./bitburner.hacknet.md) | | +| [HacknetMultipliers](./bitburner.hacknetmultipliers.md) | | +| [NodeStats](./bitburner.nodestats.md) | | +| [NS](./bitburner.ns.md) | | +| [PlayerStats](./bitburner.playerstats.md) | | +| [ProcessInfo](./bitburner.processinfo.md) | | +| [Server](./bitburner.server.md) | | +| [Singularity](./bitburner.singularity.md) | | +| [Sleeve](./bitburner.sleeve.md) | | +| [SleeveInformation](./bitburner.sleeveinformation.md) | | +| [SleeveStats](./bitburner.sleevestats.md) | | +| [SleeveTask](./bitburner.sleevetask.md) | | +| [SleeveWorkGains](./bitburner.sleeveworkgains.md) | | +| [SourceFileLvl](./bitburner.sourcefilelvl.md) | | +| [StockOrderObject](./bitburner.stockorderobject.md) | | +| [TIX](./bitburner.tix.md) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [AugmentName](./bitburner.augmentname.md) | | +| [BladeburnerActTypes](./bitburner.bladeburneracttypes.md) | | +| [BladeburnerBlackOps](./bitburner.bladeburnerblackops.md) | | +| [BladeburnerContracts](./bitburner.bladeburnercontracts.md) | | +| [BladeburnerGenActions](./bitburner.bladeburnergenactions.md) | | +| [BladeburnerOperations](./bitburner.bladeburneroperations.md) | | +| [BladeburnerSkills](./bitburner.bladeburnerskills.md) | | +| [City](./bitburner.city.md) | | +| [CodingContractTypes](./bitburner.codingcontracttypes.md) | | +| [CompanyField](./bitburner.companyfield.md) | | +| [CompanyName](./bitburner.companyname.md) | | +| [CreatableProgram](./bitburner.creatableprogram.md) | | +| [Crime](./bitburner.crime.md) | | +| [FactionName](./bitburner.factionname.md) | | +| [FactionWork](./bitburner.factionwork.md) | | +| [GangAugmentations](./bitburner.gangaugmentations.md) | | +| [GangEquipment](./bitburner.gangequipment.md) | | +| [GangEquipmentType](./bitburner.gangequipmenttype.md) | | +| [GangName](./bitburner.gangname.md) | | +| [GangOtherInfo](./bitburner.gangotherinfo.md) | | +| [GangTasks](./bitburner.gangtasks.md) | | +| [Gym](./bitburner.gym.md) | | +| [GymStat](./bitburner.gymstat.md) | | +| [Handle](./bitburner.handle.md) | | +| [HashUpgrades](./bitburner.hashupgrades.md) | | +| [Host](./bitburner.host.md) | | +| [OrderPos](./bitburner.orderpos.md) | | +| [OrderType](./bitburner.ordertype.md) | | +| [Port](./bitburner.port.md) | A port is implemented as a sort of serialized queue, where you can only write and read one element at a time from the port. When you read data from a port, the element that is read is removed from the port.IMPORTANT: The data inside ports are not saved! This means if you close and re-open the game, or reload the page then you will lose all of the data in the ports! | +| [PurchaseableProgram](./bitburner.purchaseableprogram.md) | | +| [Script](./bitburner.script.md) | | +| [StockOrder](./bitburner.stockorder.md) | | +| [StockSymbol](./bitburner.stocksymbol.md) | | +| [University](./bitburner.university.md) | | +| [UniversityCourse](./bitburner.universitycourse.md) | | + diff --git a/markdown/bitburner.nodestats.cache.md b/markdown/bitburner.nodestats.cache.md new file mode 100644 index 000000000..ddd45db91 --- /dev/null +++ b/markdown/bitburner.nodestats.cache.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [cache](./bitburner.nodestats.cache.md) + +## NodeStats.cache property + +Cache level. Only applicable for Hacknet Servers + +Signature: + +```typescript +cache: number; +``` diff --git a/markdown/bitburner.nodestats.cores.md b/markdown/bitburner.nodestats.cores.md new file mode 100644 index 000000000..1f172625d --- /dev/null +++ b/markdown/bitburner.nodestats.cores.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [cores](./bitburner.nodestats.cores.md) + +## NodeStats.cores property + +Node's number of cores + +Signature: + +```typescript +cores: number; +``` diff --git a/markdown/bitburner.nodestats.hashcapacity.md b/markdown/bitburner.nodestats.hashcapacity.md new file mode 100644 index 000000000..dda77dcb0 --- /dev/null +++ b/markdown/bitburner.nodestats.hashcapacity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [hashCapacity](./bitburner.nodestats.hashcapacity.md) + +## NodeStats.hashCapacity property + +Hash Capacity provided by this Node. Only applicable for Hacknet Servers + +Signature: + +```typescript +hashCapacity: number; +``` diff --git a/markdown/bitburner.nodestats.level.md b/markdown/bitburner.nodestats.level.md new file mode 100644 index 000000000..f4831524c --- /dev/null +++ b/markdown/bitburner.nodestats.level.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [level](./bitburner.nodestats.level.md) + +## NodeStats.level property + +Node's level + +Signature: + +```typescript +level: number; +``` diff --git a/markdown/bitburner.nodestats.md b/markdown/bitburner.nodestats.md new file mode 100644 index 000000000..cb99a4cb7 --- /dev/null +++ b/markdown/bitburner.nodestats.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) + +## NodeStats interface + + +Signature: + +```typescript +interface NodeStats +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [cache](./bitburner.nodestats.cache.md) | number | Cache level. Only applicable for Hacknet Servers | +| [cores](./bitburner.nodestats.cores.md) | number | Node's number of cores | +| [hashCapacity](./bitburner.nodestats.hashcapacity.md) | number | Hash Capacity provided by this Node. Only applicable for Hacknet Servers | +| [level](./bitburner.nodestats.level.md) | number | Node's level | +| [name](./bitburner.nodestats.name.md) | string | Node's name ("hacknet-node-5") | +| [production](./bitburner.nodestats.production.md) | number | Node's production per second | +| [ram](./bitburner.nodestats.ram.md) | number | Node's RAM | +| [timeOnline](./bitburner.nodestats.timeonline.md) | number | Number of seconds since Node has been purchased | +| [totalProduction](./bitburner.nodestats.totalproduction.md) | number | Total number of money Node has produced | + diff --git a/markdown/bitburner.nodestats.name.md b/markdown/bitburner.nodestats.name.md new file mode 100644 index 000000000..e74e9c5dc --- /dev/null +++ b/markdown/bitburner.nodestats.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [name](./bitburner.nodestats.name.md) + +## NodeStats.name property + +Node's name ("hacknet-node-5") + +Signature: + +```typescript +name: string; +``` diff --git a/markdown/bitburner.nodestats.production.md b/markdown/bitburner.nodestats.production.md new file mode 100644 index 000000000..efa0eecb0 --- /dev/null +++ b/markdown/bitburner.nodestats.production.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [production](./bitburner.nodestats.production.md) + +## NodeStats.production property + +Node's production per second + +Signature: + +```typescript +production: number; +``` diff --git a/markdown/bitburner.nodestats.ram.md b/markdown/bitburner.nodestats.ram.md new file mode 100644 index 000000000..48acd6ccc --- /dev/null +++ b/markdown/bitburner.nodestats.ram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [ram](./bitburner.nodestats.ram.md) + +## NodeStats.ram property + +Node's RAM + +Signature: + +```typescript +ram: number; +``` diff --git a/markdown/bitburner.nodestats.timeonline.md b/markdown/bitburner.nodestats.timeonline.md new file mode 100644 index 000000000..0ce7e92e9 --- /dev/null +++ b/markdown/bitburner.nodestats.timeonline.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [timeOnline](./bitburner.nodestats.timeonline.md) + +## NodeStats.timeOnline property + +Number of seconds since Node has been purchased + +Signature: + +```typescript +timeOnline: number; +``` diff --git a/markdown/bitburner.nodestats.totalproduction.md b/markdown/bitburner.nodestats.totalproduction.md new file mode 100644 index 000000000..d5e3c7b7e --- /dev/null +++ b/markdown/bitburner.nodestats.totalproduction.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NodeStats](./bitburner.nodestats.md) > [totalProduction](./bitburner.nodestats.totalproduction.md) + +## NodeStats.totalProduction property + +Total number of money Node has produced + +Signature: + +```typescript +totalProduction: number; +``` diff --git a/markdown/bitburner.ns.args.md b/markdown/bitburner.ns.args.md new file mode 100644 index 000000000..2b0ddbfb9 --- /dev/null +++ b/markdown/bitburner.ns.args.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [args](./bitburner.ns.args.md) + +## NS.args property + +Arguments passed into a script can be accessed using a normal array using the \[\] operator (args\[0\], args\[1\], etc…). + +It is also possible to get the number of arguments that was passed into a script using: + +```js +args.length +``` +WARNING: Do not try to modify the args array. This will break the game. + +Signature: + +```typescript +readonly args: any[]; +``` + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.bladeburner.md b/markdown/bitburner.ns.bladeburner.md new file mode 100644 index 000000000..fe82f244a --- /dev/null +++ b/markdown/bitburner.ns.bladeburner.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [bladeburner](./bitburner.ns.bladeburner.md) + +## NS.bladeburner property + +Signature: + +```typescript +readonly bladeburner: Bladeburner; +``` + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.brutessh.md b/markdown/bitburner.ns.brutessh.md new file mode 100644 index 000000000..7e75b62c8 --- /dev/null +++ b/markdown/bitburner.ns.brutessh.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [brutessh](./bitburner.ns.brutessh.md) + +## NS.brutessh() method + +Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer. + +Signature: + +```typescript +brutessh(host: Host): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | + +Returns: + +void + +## Remarks + +0.05 GB + +## Example + + +```js +brutessh("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.clear.md b/markdown/bitburner.ns.clear.md new file mode 100644 index 000000000..54e1e7b52 --- /dev/null +++ b/markdown/bitburner.ns.clear.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [clear](./bitburner.ns.clear.md) + +## NS.clear() method + +This function is used to clear data in a Netscript Ports or a text file. + +If the port/fn argument is a number between 1 and 20, then it specifies a port and will clear it (deleting all data from the underlying queue). + +If the port/fn argument is a string, then it specifies the name of a text file (.txt) and will delete all data from that text file. + +Signature: + +```typescript +clear(handle: Handle): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| handle | [Handle](./bitburner.handle.md) | Port or text file to clear. | + +Returns: + +void + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.clearlog.md b/markdown/bitburner.ns.clearlog.md new file mode 100644 index 000000000..66d5daba3 --- /dev/null +++ b/markdown/bitburner.ns.clearlog.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [clearLog](./bitburner.ns.clearlog.md) + +## NS.clearLog() method + +Clears the script’s logs. + +Signature: + +```typescript +clearLog(): void; +``` +Returns: + +void + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.codingcontract.md b/markdown/bitburner.ns.codingcontract.md new file mode 100644 index 000000000..67c54cd58 --- /dev/null +++ b/markdown/bitburner.ns.codingcontract.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [codingcontract](./bitburner.ns.codingcontract.md) + +## NS.codingcontract property + +Signature: + +```typescript +readonly codingcontract: CodingContract; +``` + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.deleteserver.md b/markdown/bitburner.ns.deleteserver.md new file mode 100644 index 000000000..67eede3e2 --- /dev/null +++ b/markdown/bitburner.ns.deleteserver.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [deleteServer](./bitburner.ns.deleteserver.md) + +## NS.deleteServer() method + +Deletes one of your purchased servers, which is specified by its hostname. + +The hostname argument can be any data type, but it will be converted to a string. Whitespace is automatically removed from the string. This function will not delete a server that still has scripts running on it. + +Signature: + +```typescript +deleteServer(host: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host of the server to delete. | + +Returns: + +boolean + +True if successful, and false otherwise. + +## Remarks + +2.25 GB + diff --git a/markdown/bitburner.ns.disablelog.md b/markdown/bitburner.ns.disablelog.md new file mode 100644 index 000000000..14605f2bd --- /dev/null +++ b/markdown/bitburner.ns.disablelog.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [disableLog](./bitburner.ns.disablelog.md) + +## NS.disableLog() method + +Disables logging for the given function. Logging can be disabled for all functions by passing \`ALL\` as the argument. + +Note that this does not completely remove all logging functionality. This only stops a function from logging when the function is successful. If the function fails, it will still log the reason for failure. + +Notable functions that cannot have their logs disabled: run, exec, exit. + +Signature: + +```typescript +disableLog(fn: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Name of function for which to disable logging. | + +Returns: + +void + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.enablelog.md b/markdown/bitburner.ns.enablelog.md new file mode 100644 index 000000000..637109a20 --- /dev/null +++ b/markdown/bitburner.ns.enablelog.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [enableLog](./bitburner.ns.enablelog.md) + +## NS.enableLog() method + +Re-enables logging for the given function. If \`ALL\` is passed into this function as an argument, then it will revert the effects of disableLog(\`ALL\`). + +Signature: + +```typescript +enableLog(fn: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Name of function for which to enable logging. | + +Returns: + +void + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.exec.md b/markdown/bitburner.ns.exec.md new file mode 100644 index 000000000..2bcbc235f --- /dev/null +++ b/markdown/bitburner.ns.exec.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [exec](./bitburner.ns.exec.md) + +## NS.exec() method + +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. + +If the script was successfully started, then this functions 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. + +Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error. + +Signature: + +```typescript +exec(script: Script, host: Host, numThreads?: number, ...args: string[]): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script to execute. | +| host | [Host](./bitburner.host.md) | Hostname or IP 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. | +| args | string\[\] | 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: + +number + +Returns the PID of a successfully started script, and 0 otherwise. + +## Remarks + +1.3 GB + +## Example 1 + + +```js +//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"); +``` + +## Example 2 + + +```js +//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); +``` + +## Example 3 + + +```js +//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"); +``` + diff --git a/markdown/bitburner.ns.exit.md b/markdown/bitburner.ns.exit.md new file mode 100644 index 000000000..986d11e89 --- /dev/null +++ b/markdown/bitburner.ns.exit.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [exit](./bitburner.ns.exit.md) + +## NS.exit() method + +Terminates the current script immediately. + +Signature: + +```typescript +exit(): void; +``` +Returns: + +void + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.fileexists.md b/markdown/bitburner.ns.fileexists.md new file mode 100644 index 000000000..8972e19cb --- /dev/null +++ b/markdown/bitburner.ns.fileexists.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [fileExists](./bitburner.ns.fileexists.md) + +## NS.fileExists() method + +Returns a boolean indicating whether the specified file exists on the target server. The filename for scripts is case-sensitive, but for other types of files it is not. For example, fileExists(“brutessh.exe”) will work fine, even though the actual program is named 'BruteSSH.exe'. + +If the hostname/ip argument is omitted, then the function will search through the current server (the server running the script that calls this function) for the file. + +Signature: + +```typescript +fileExists(filename: string, host?: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filename | string | Filename of file to check. | +| host | [Host](./bitburner.host.md) | Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server. | + +Returns: + +boolean + +True if specified file exists, and false otherwise. + +## Remarks + +0.1 GB + +## Example 1 + + +```js +//The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise. +fileExists("foo.script", "foodnstuff"); +``` + +## Example 2 + + +```js +//The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise. +fileExists("ftpcrack.exe"); +``` + diff --git a/markdown/bitburner.ns.ftpcrack.md b/markdown/bitburner.ns.ftpcrack.md new file mode 100644 index 000000000..b9d47d7d7 --- /dev/null +++ b/markdown/bitburner.ns.ftpcrack.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [ftpcrack](./bitburner.ns.ftpcrack.md) + +## NS.ftpcrack() method + +Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer. + +Signature: + +```typescript +ftpcrack(host: Host): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | + +Returns: + +void + +## Remarks + +0.05 GB + +## Example + + +```js +ftpcrack("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.gang.md b/markdown/bitburner.ns.gang.md new file mode 100644 index 000000000..7302145c5 --- /dev/null +++ b/markdown/bitburner.ns.gang.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [gang](./bitburner.ns.gang.md) + +## NS.gang property + +Signature: + +```typescript +readonly gang: Gang; +``` + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.getbitnodemultipliers.md b/markdown/bitburner.ns.getbitnodemultipliers.md new file mode 100644 index 000000000..2c8244949 --- /dev/null +++ b/markdown/bitburner.ns.getbitnodemultipliers.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getBitNodeMultipliers](./bitburner.ns.getbitnodemultipliers.md) + +## NS.getBitNodeMultipliers() method + +Returns an object containing the current BitNode multipliers. This function requires Source-File 5 in order to run. The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). The multipliers represent the difference between the current BitNode and the original BitNode (BitNode-1). + +For example, if the CrimeMoney multiplier has a value of 0.1, then that means that committing crimes in the current BitNode will only give 10% of the money you would have received in BitNode-1. + +Signature: + +```typescript +getBitNodeMultipliers(url: string, target: string, host: string): BitNodeMultipliers; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| url | string | | +| target | string | | +| host | string | | + +Returns: + +[BitNodeMultipliers](./bitburner.bitnodemultipliers.md) + +Object containing the current BitNode multipliers. + +## Remarks + +4 GB + +## Example + + +```js +mults = getBitNodeMultipliers(); +print(mults.ServerMaxMoney); +print(mults.HackExpGain); +``` + diff --git a/markdown/bitburner.ns.getfavortodonate.md b/markdown/bitburner.ns.getfavortodonate.md new file mode 100644 index 000000000..6f4520ec6 --- /dev/null +++ b/markdown/bitburner.ns.getfavortodonate.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getFavorToDonate](./bitburner.ns.getfavortodonate.md) + +## NS.getFavorToDonate() method + +Returns the amount of Faction favor required to be able to donate to a faction. + +Signature: + +```typescript +getFavorToDonate(): number; +``` +Returns: + +number + +Amount of Faction favor required to be able to donate to a faction. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getgrowtime.md b/markdown/bitburner.ns.getgrowtime.md new file mode 100644 index 000000000..e27a24a40 --- /dev/null +++ b/markdown/bitburner.ns.getgrowtime.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getGrowTime](./bitburner.ns.getgrowtime.md) + +## NS.getGrowTime() method + +Returns the amount of time in seconds it takes to execute the grow Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels. + +Signature: + +```typescript +getGrowTime(host: Host, hackLvl?: number, intLvl?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | +| hackLvl | number | Optional hacking level for the calculation. Defaults to player’s current hacking level. | +| intLvl | number | Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). | + +Returns: + +number + +Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. + +## Remarks + +0.05 GB + diff --git a/markdown/bitburner.ns.gethackinglevel.md b/markdown/bitburner.ns.gethackinglevel.md new file mode 100644 index 000000000..2a513b34e --- /dev/null +++ b/markdown/bitburner.ns.gethackinglevel.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHackingLevel](./bitburner.ns.gethackinglevel.md) + +## NS.getHackingLevel() method + +Returns the player’s current hacking level. + +Signature: + +```typescript +getHackingLevel(): number; +``` +Returns: + +number + +Player’s current hacking level + +## Remarks + +0.05 GB + diff --git a/markdown/bitburner.ns.gethackingmultipliers.md b/markdown/bitburner.ns.gethackingmultipliers.md new file mode 100644 index 000000000..cb6a700e2 --- /dev/null +++ b/markdown/bitburner.ns.gethackingmultipliers.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHackingMultipliers](./bitburner.ns.gethackingmultipliers.md) + +## NS.getHackingMultipliers() method + +Returns an object containing the Player’s hacking related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%). + +Signature: + +```typescript +getHackingMultipliers(): HackingMultipliers; +``` +Returns: + +[HackingMultipliers](./bitburner.hackingmultipliers.md) + +Object containing the Player’s hacking related multipliers. + +## Remarks + +4 GB + +## Example + + +```js +//Example of how this can be used: +mults = getHackingMultipliers(); +print(mults.chance); +print(mults.growth); +``` + diff --git a/markdown/bitburner.ns.gethacknetmultipliers.md b/markdown/bitburner.ns.gethacknetmultipliers.md new file mode 100644 index 000000000..4498c06c4 --- /dev/null +++ b/markdown/bitburner.ns.gethacknetmultipliers.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHacknetMultipliers](./bitburner.ns.gethacknetmultipliers.md) + +## NS.getHacknetMultipliers() method + +Returns an object containing the Player’s hacknet related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%). + +Signature: + +```typescript +getHacknetMultipliers(): HacknetMultipliers; +``` +Returns: + +[HacknetMultipliers](./bitburner.hacknetmultipliers.md) + +Object containing the Player’s hacknet related multipliers. + +## Remarks + +4 GB + +## Example + + +```js +//Example of how this can be used: +mults = getHacknetMultipliers(); +print(mults.production); +print(mults.purchaseCost); +``` + diff --git a/markdown/bitburner.ns.gethacktime.md b/markdown/bitburner.ns.gethacktime.md new file mode 100644 index 000000000..f11156e15 --- /dev/null +++ b/markdown/bitburner.ns.gethacktime.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHackTime](./bitburner.ns.gethacktime.md) + +## NS.getHackTime() method + +Returns the amount of time in seconds it takes to execute the hack Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels. + +Signature: + +```typescript +getHackTime(host: Host, hackLvl?: number, intLvl?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | +| hackLvl | number | Optional hacking level for the calculation. Defaults to player’s current hacking level. | +| intLvl | number | Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). | + +Returns: + +number + +Returns the amount of time in seconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. + +## Remarks + +0.05 GB + diff --git a/markdown/bitburner.ns.gethostname.md b/markdown/bitburner.ns.gethostname.md new file mode 100644 index 000000000..9ed50761b --- /dev/null +++ b/markdown/bitburner.ns.gethostname.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getHostname](./bitburner.ns.gethostname.md) + +## NS.getHostname() method + +Returns a string with the hostname of the server that the script is running on. + +Signature: + +```typescript +getHostname(): Host; +``` +Returns: + +[Host](./bitburner.host.md) + +Hostname of the server that the script is on. + +## Remarks + +0.05 GB + diff --git a/markdown/bitburner.ns.getporthandle.md b/markdown/bitburner.ns.getporthandle.md new file mode 100644 index 000000000..432683bd0 --- /dev/null +++ b/markdown/bitburner.ns.getporthandle.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPortHandle](./bitburner.ns.getporthandle.md) + +## NS.getPortHandle() method + +Get a handle to a Netscript Port. + +WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0. + +Signature: + +```typescript +getPortHandle(port: Port): any[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| port | [Port](./bitburner.port.md) | Port number. Must be an integer between 1 and 20. | + +Returns: + +any\[\] + +Data in the specified port. + +## Remarks + +10 GB + diff --git a/markdown/bitburner.ns.getpurchasedservercost.md b/markdown/bitburner.ns.getpurchasedservercost.md new file mode 100644 index 000000000..9a7bd9c44 --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedservercost.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServerCost](./bitburner.ns.getpurchasedservercost.md) + +## NS.getPurchasedServerCost() method + +Returns the cost to purchase a server with the specified amount of ram. + +Signature: + +```typescript +getPurchasedServerCost(ram: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| ram | number | Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | + +Returns: + +number + +The cost to purchase a server with the specified amount of ram. + +## Remarks + +0.25 GB + +## Example + + +```js +for (i = 1; i <= 20; i++) { + tprint(i + " -- " + getPurchasedServerCost(Math.pow(2, i))); +} +``` + diff --git a/markdown/bitburner.ns.getpurchasedserverlimit.md b/markdown/bitburner.ns.getpurchasedserverlimit.md new file mode 100644 index 000000000..329e1d945 --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedserverlimit.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServerLimit](./bitburner.ns.getpurchasedserverlimit.md) + +## NS.getPurchasedServerLimit() method + +Returns the maximum number of servers you can purchase. + +Signature: + +```typescript +getPurchasedServerLimit(): number; +``` +Returns: + +number + +Returns the maximum number of servers you can purchase. + +## Remarks + +0.05 GB + diff --git a/markdown/bitburner.ns.getpurchasedservermaxram.md b/markdown/bitburner.ns.getpurchasedservermaxram.md new file mode 100644 index 000000000..ab44a3542 --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedservermaxram.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServerMaxRam](./bitburner.ns.getpurchasedservermaxram.md) + +## NS.getPurchasedServerMaxRam() method + +Returns the maximum RAM that a purchased server can have. + +Signature: + +```typescript +getPurchasedServerMaxRam(): number; +``` +Returns: + +number + +Returns the maximum RAM that a purchased server can have. + +## Remarks + +0.05 GB + diff --git a/markdown/bitburner.ns.getpurchasedservers.md b/markdown/bitburner.ns.getpurchasedservers.md new file mode 100644 index 000000000..58efbc407 --- /dev/null +++ b/markdown/bitburner.ns.getpurchasedservers.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getPurchasedServers](./bitburner.ns.getpurchasedservers.md) + +## NS.getPurchasedServers() method + +Returns an array with either the hostnames or IPs of all of the servers you have purchased. + +Signature: + +```typescript +getPurchasedServers(hostnameMode?: boolean): Host[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostnameMode | boolean | \] Optional. Defaults to true. Returns hostnames if true, and IPs if false. | + +Returns: + +[Host](./bitburner.host.md)\[\] + +Returns an array with either the hostnames or IPs of all of the servers you have purchased. + +## Remarks + +2.25 GB + diff --git a/markdown/bitburner.ns.getscriptexpgain.md b/markdown/bitburner.ns.getscriptexpgain.md new file mode 100644 index 000000000..ad79a4683 --- /dev/null +++ b/markdown/bitburner.ns.getscriptexpgain.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptExpGain](./bitburner.ns.getscriptexpgain.md) + +## NS.getScriptExpGain() method + +Returns the amount of hacking experience the specified script generates while online (when the game is open, does not apply for offline experience gains). Remember that a script is uniquely identified by both its name and its arguments. + +This function can also return the total experience gain rate of all of your active scripts by running the function with no arguments. + +Signature: + +```typescript +getScriptExpGain(script: Script, host: Host, ...args: string[]): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script. | +| host | [Host](./bitburner.host.md) | Server on which script is running. | +| args | string\[\] | Arguments that the script is running with. | + +Returns: + +number + +Amount of hacking experience the specified script generates while online. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getscriptincome.md b/markdown/bitburner.ns.getscriptincome.md new file mode 100644 index 000000000..ae85dfb4e --- /dev/null +++ b/markdown/bitburner.ns.getscriptincome.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptIncome](./bitburner.ns.getscriptincome.md) + +## NS.getScriptIncome() method + +Returns the amount of income the specified script generates while online (when the game is open, does not apply for offline income). Remember that a script is uniquely identified by both its name and its arguments. So for example if you ran a script with the arguments “foodnstuff” and “5” then in order to use this function to get that script’s income you must specify those same arguments in the same order in this function call. + +This function can also be called with no arguments. If called with no arguments, then this function will return an array of two values. The first value is the total income ($ / second) of all of your active scripts (scripts that are currently running on any server). The second value is the total income ($ / second) that you’ve earned from scripts since you last installed Augmentations. + +Signature: + +```typescript +getScriptIncome(script: Script, host: Host, ...args: string[]): number | [number, number]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script. | +| host | [Host](./bitburner.host.md) | Server on which script is running. | +| args | string\[\] | Arguments that the script is running with. | + +Returns: + +number \| \[number, number\] + +Amount of income the specified script generates while online. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getscriptlogs.md b/markdown/bitburner.ns.getscriptlogs.md new file mode 100644 index 000000000..d3c4f581c --- /dev/null +++ b/markdown/bitburner.ns.getscriptlogs.md @@ -0,0 +1,58 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptLogs](./bitburner.ns.getscriptlogs.md) + +## NS.getScriptLogs() method + +Returns a script’s logs. The logs are returned as an array, where each line is an element in the array. The most recently logged line is at the end of the array. Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the game’s options. If the function is called with no arguments, it will return the current script’s logs. + +Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments. + +Signature: + +```typescript +getScriptLogs(fn?: Script, host?: Host, ...args: any[]): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | [Script](./bitburner.script.md) | Optional. Filename of script to get logs from. | +| host | [Host](./bitburner.host.md) | Optional. Hostname or IP of the server that the script is on. | +| args | any\[\] | Arguments to identify which scripts to get logs for. | + +Returns: + +string\[\] + +Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array. + +## Remarks + +0 GB + +## Example 1 + + +```js +//Get logs from foo.script on the current server that was run with no args +getScriptLogs("foo.script"); +``` + +## Example 2 + + +```js +//Open logs from foo.script on the foodnstuff server that was run with no args +getScriptLogs("foo.script", "foodnstuff"); +``` + +## Example 3 + + +```js +//Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] +getScriptLogs("foo.script", "foodnstuff", 1, "test"); +``` + diff --git a/markdown/bitburner.ns.getscriptname.md b/markdown/bitburner.ns.getscriptname.md new file mode 100644 index 000000000..5f6d479d9 --- /dev/null +++ b/markdown/bitburner.ns.getscriptname.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptName](./bitburner.ns.getscriptname.md) + +## NS.getScriptName() method + +Returns the current script name. + +Signature: + +```typescript +getScriptName(): string; +``` +Returns: + +string + +Current script name. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.getscriptram.md b/markdown/bitburner.ns.getscriptram.md new file mode 100644 index 000000000..7c7eded33 --- /dev/null +++ b/markdown/bitburner.ns.getscriptram.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getScriptRam](./bitburner.ns.getscriptram.md) + +## NS.getScriptRam() method + +Returns the amount of RAM required to run the specified script on the target server. Returns 0 if the script does not exist. + +Signature: + +```typescript +getScriptRam(script: Script, host?: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script. This is case-sensitive. | +| host | [Host](./bitburner.host.md) | Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. | + +Returns: + +number + +Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getserver.md b/markdown/bitburner.ns.getserver.md new file mode 100644 index 000000000..3693511f1 --- /dev/null +++ b/markdown/bitburner.ns.getserver.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServer](./bitburner.ns.getserver.md) + +## NS.getServer() method + +Returns a server object for the given server. Defaults to the running script's server if host is not specified. + +Signature: + +```typescript +getServer(host?: Host): Server; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Optional. Hostname or IP for the requested server object. | + +Returns: + +[Server](./bitburner.server.md) + +The requested server object. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.ns.getserverbasesecuritylevel.md b/markdown/bitburner.ns.getserverbasesecuritylevel.md new file mode 100644 index 000000000..bcf7e92f1 --- /dev/null +++ b/markdown/bitburner.ns.getserverbasesecuritylevel.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerBaseSecurityLevel](./bitburner.ns.getserverbasesecuritylevel.md) + +## NS.getServerBaseSecurityLevel() method + +Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s). + +Signature: + +```typescript +getServerBaseSecurityLevel(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +number + +Base security level of the target server. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getservergrowth.md b/markdown/bitburner.ns.getservergrowth.md new file mode 100644 index 000000000..0de3c460e --- /dev/null +++ b/markdown/bitburner.ns.getservergrowth.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerGrowth](./bitburner.ns.getservergrowth.md) + +## NS.getServerGrowth() method + +Returns the server’s instrinsic “growth parameter”. This growth parameter is a number between 1 and 100 that represents how quickly the server’s money grows. This parameter affects the percentage by which the server’s money is increased when using the grow function. A higher growth parameter will result in a higher percentage increase from grow. + +Signature: + +```typescript +getServerGrowth(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +number + +Parameter that affects the percentage by which the server’s money is increased when using the grow function. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getservermaxmoney.md b/markdown/bitburner.ns.getservermaxmoney.md new file mode 100644 index 000000000..827daf4aa --- /dev/null +++ b/markdown/bitburner.ns.getservermaxmoney.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerMaxMoney](./bitburner.ns.getservermaxmoney.md) + +## NS.getServerMaxMoney() method + +Returns the maximum amount of money that can be available on a server. + +Signature: + +```typescript +getServerMaxMoney(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +number + +Maximum amount of money available on the server. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getserverminsecuritylevel.md b/markdown/bitburner.ns.getserverminsecuritylevel.md new file mode 100644 index 000000000..ae5d4c774 --- /dev/null +++ b/markdown/bitburner.ns.getserverminsecuritylevel.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerMinSecurityLevel](./bitburner.ns.getserverminsecuritylevel.md) + +## NS.getServerMinSecurityLevel() method + +Returns the minimum security level of the target server. + +Signature: + +```typescript +getServerMinSecurityLevel(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +number + +Minimum security level of the target server. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getservermoneyavailable.md b/markdown/bitburner.ns.getservermoneyavailable.md new file mode 100644 index 000000000..f76a37baa --- /dev/null +++ b/markdown/bitburner.ns.getservermoneyavailable.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerMoneyAvailable](./bitburner.ns.getservermoneyavailable.md) + +## NS.getServerMoneyAvailable() method + +Returns the amount of money available on a server. Running this function on the home computer will return the player’s money. + +Signature: + +```typescript +getServerMoneyAvailable(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server | + +Returns: + +number + +Amount of money available on the server. + +## Remarks + +0.1 GB + +## Example + + +```js +getServerMoneyAvailable("foodnstuff"); +getServerMoneyAvailable("home"); //Returns player's money +``` + diff --git a/markdown/bitburner.ns.getservernumportsrequired.md b/markdown/bitburner.ns.getservernumportsrequired.md new file mode 100644 index 000000000..aa57acd23 --- /dev/null +++ b/markdown/bitburner.ns.getservernumportsrequired.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerNumPortsRequired](./bitburner.ns.getservernumportsrequired.md) + +## NS.getServerNumPortsRequired() method + +Returns the number of open ports required to successfully run NUKE.exe on the specified server. + +Signature: + +```typescript +getServerNumPortsRequired(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +number + +The number of open ports required to successfully run NUKE.exe on the specified server. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getserverram.md b/markdown/bitburner.ns.getserverram.md new file mode 100644 index 000000000..22b34ca40 --- /dev/null +++ b/markdown/bitburner.ns.getserverram.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerRam](./bitburner.ns.getserverram.md) + +## NS.getServerRam() method + +Returns an array with two elements that gives information about a server’s memory (RAM). The first element in the array is the amount of RAM that the server has total (in GB). The second element in the array is the amount of RAM that is currently being used on the server (in GB). + +Signature: + +```typescript +getServerRam(host: Host): [number, number]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +\[number, number\] + +Array with total and used memory on the specified server. + +## Remarks + +0.1 GB + +## Example + + +```js +res = getServerRam("helios"); +totalRam = res[0]; +ramUsed = res[1]; +``` + diff --git a/markdown/bitburner.ns.getserverrequiredhackinglevel.md b/markdown/bitburner.ns.getserverrequiredhackinglevel.md new file mode 100644 index 000000000..3085f17d5 --- /dev/null +++ b/markdown/bitburner.ns.getserverrequiredhackinglevel.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerRequiredHackingLevel](./bitburner.ns.getserverrequiredhackinglevel.md) + +## NS.getServerRequiredHackingLevel() method + +Returns the required hacking level of the target server. + +Signature: + +```typescript +getServerRequiredHackingLevel(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +number + +The required hacking level of the target server. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.getserversecuritylevel.md b/markdown/bitburner.ns.getserversecuritylevel.md new file mode 100644 index 000000000..1f300a15d --- /dev/null +++ b/markdown/bitburner.ns.getserversecuritylevel.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getServerSecurityLevel](./bitburner.ns.getserversecuritylevel.md) + +## NS.getServerSecurityLevel() method + +Returns the security level of the target server. A server’s security level is denoted by a number, typically between 1 and 100 (but it can go above 100). + +Signature: + +```typescript +getServerSecurityLevel(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +number + +Security level of the target server. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.gettimesincelastaug.md b/markdown/bitburner.ns.gettimesincelastaug.md new file mode 100644 index 000000000..3d8790263 --- /dev/null +++ b/markdown/bitburner.ns.gettimesincelastaug.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getTimeSinceLastAug](./bitburner.ns.gettimesincelastaug.md) + +## NS.getTimeSinceLastAug() method + +Returns the amount of time in milliseconds that have passed since you last installed Augmentations. + +Signature: + +```typescript +getTimeSinceLastAug(): number; +``` +Returns: + +number + +Time in milliseconds that have passed since you last installed Augmentations. + +## Remarks + +0.05 GB + diff --git a/markdown/bitburner.ns.getweakentime.md b/markdown/bitburner.ns.getweakentime.md new file mode 100644 index 000000000..409e0b80c --- /dev/null +++ b/markdown/bitburner.ns.getweakentime.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [getWeakenTime](./bitburner.ns.getweakentime.md) + +## NS.getWeakenTime() method + +Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. + +Signature: + +```typescript +getWeakenTime(host: Host, hackLvl?: number, intLvl?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | +| hackLvl | number | Optional hacking level for the calculation. Defaults to player’s current hacking level. | +| intLvl | number | Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). | + +Returns: + +number + +Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. + +## Remarks + +0.05 GB + diff --git a/markdown/bitburner.ns.grow.md b/markdown/bitburner.ns.grow.md new file mode 100644 index 000000000..2c8e8d6cc --- /dev/null +++ b/markdown/bitburner.ns.grow.md @@ -0,0 +1,41 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [grow](./bitburner.ns.grow.md) + +## NS.grow() method + +Use your hacking skills to increase the amount of money available on a server. The runtime for this command depends on your hacking level and the target server’s security level. When \`grow\` completes, the money available on a target server will be increased by a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate. + +Like hack, \`grow\` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004. + +Signature: + +```typescript +grow(host: Host, opts?: BasicHGWOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server to grow. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | + +Returns: + +Promise<number> + +The number by which the money on the server was multiplied for the growth. + +## Remarks + +0.15 GB + +## Example + + +```js +grow("foodnstuff"); +grow("foodnstuff", { threads: 5 }); // Only use 5 threads to grow +``` + diff --git a/markdown/bitburner.ns.growthanalyze.md b/markdown/bitburner.ns.growthanalyze.md new file mode 100644 index 000000000..f7c2a929d --- /dev/null +++ b/markdown/bitburner.ns.growthanalyze.md @@ -0,0 +1,42 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [growthAnalyze](./bitburner.ns.growthanalyze.md) + +## NS.growthAnalyze() method + +This function returns the number of “growths” needed in order to increase the amount of money available on the specified server by the specified amount. The specified amount is multiplicative and is in decimal form, not percentage. + +Warning: The value returned by this function isn’t necessarily a whole number. + +Signature: + +```typescript +growthAnalyze(host: Host, growthAmount: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | +| growthAmount | number | Multiplicative factor by which the server is grown. Decimal form.. | + +Returns: + +number + +The amount of grow calls needed to grow the specified server by the specified amount + +## Remarks + +1 GB + +## Example + + +```js +//For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use: +growthAnalyze("foodnstuff", 2); +//If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads). +``` + diff --git a/markdown/bitburner.ns.growthanalyzesecurity.md b/markdown/bitburner.ns.growthanalyzesecurity.md new file mode 100644 index 000000000..9f749e9d5 --- /dev/null +++ b/markdown/bitburner.ns.growthanalyzesecurity.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [growthAnalyzeSecurity](./bitburner.ns.growthanalyzesecurity.md) + +## NS.growthAnalyzeSecurity() method + +Returns the security increase that would occur if a grow with this many threads happened. + +Signature: + +```typescript +growthAnalyzeSecurity(threads: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| threads | number | Amount of threads that will be used. | + +Returns: + +number + +The security increase. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.hack.md b/markdown/bitburner.ns.hack.md new file mode 100644 index 000000000..7c13ad23a --- /dev/null +++ b/markdown/bitburner.ns.hack.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hack](./bitburner.ns.hack.md) + +## NS.hack() method + +Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target server’s security level. In order to hack a server you must first gain root access to that server and also have the required hacking level. + +A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the \`foodnstuff\` server and run that script on any server in the game. + +A successful \`hack()\` on a server will raise that server’s security level by 0.002. + +Signature: + +```typescript +hack(host: Host, opts?: BasicHGWOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server to hack. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | + +Returns: + +Promise<number> + +The amount of money stolen if the hack is successful, and zero otherwise. + +## Remarks + +0.1 GB + +## Example + + +```js +hack("foodnstuff"); +hack("10.1.2.3"); +hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack +``` + diff --git a/markdown/bitburner.ns.hackanalyzepercent.md b/markdown/bitburner.ns.hackanalyzepercent.md new file mode 100644 index 000000000..1810d3deb --- /dev/null +++ b/markdown/bitburner.ns.hackanalyzepercent.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hackAnalyzePercent](./bitburner.ns.hackanalyzepercent.md) + +## NS.hackAnalyzePercent() method + +Returns the percentage of the specified server’s money you will steal with a single hack. This value is returned in percentage form, not decimal (Netscript functions typically return in decimal form, but not this one). + +Signature: + +```typescript +hackAnalyzePercent(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | + +Returns: + +number + +The percentage of money you will steal from the target server with a single hack. + +## Remarks + +1 GB + +## Example + + +```js +//For example, assume the following returns 1: +hackAnalyzePercent("foodnstuff"); +//This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N% of its total money. +``` + diff --git a/markdown/bitburner.ns.hackanalyzesecurity.md b/markdown/bitburner.ns.hackanalyzesecurity.md new file mode 100644 index 000000000..34e819ccb --- /dev/null +++ b/markdown/bitburner.ns.hackanalyzesecurity.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hackAnalyzeSecurity](./bitburner.ns.hackanalyzesecurity.md) + +## NS.hackAnalyzeSecurity() method + +Returns the security increase that would occur if a hack with this many threads happened. + +Signature: + +```typescript +hackAnalyzeSecurity(threads: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| threads | number | Amount of threads that will be used. | + +Returns: + +number + +The security increase. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.hackanalyzethreads.md b/markdown/bitburner.ns.hackanalyzethreads.md new file mode 100644 index 000000000..3955d1f7e --- /dev/null +++ b/markdown/bitburner.ns.hackanalyzethreads.md @@ -0,0 +1,42 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hackAnalyzeThreads](./bitburner.ns.hackanalyzethreads.md) + +## NS.hackAnalyzeThreads() method + +This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1. + +Warning: The value returned by this function isn’t necessarily a whole number. + +Signature: + +```typescript +hackAnalyzeThreads(host: Host, hackAmount: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server to analyze. | +| hackAmount | number | Amount of money you want to hack from the server. | + +Returns: + +number + +The number of threads needed to hack the server for hackAmount money. + +## Remarks + +1 GB + +## Example + + +```js +//For example, let’s say the foodnstuff server has $10m and you run: +hackAnalyzeThreads("foodnstuff", 1e6); +//If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server. +``` + diff --git a/markdown/bitburner.ns.hackchance.md b/markdown/bitburner.ns.hackchance.md new file mode 100644 index 000000000..4c78c4540 --- /dev/null +++ b/markdown/bitburner.ns.hackchance.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hackChance](./bitburner.ns.hackchance.md) + +## NS.hackChance() method + +Returns the chance you have of successfully hacking the specified server. + +This returned value is in decimal form, not percentage. + +Signature: + +```typescript +hackChance(host: Host): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | + +Returns: + +number + +The chance you have of successfully hacking the target server. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.hacknet.md b/markdown/bitburner.ns.hacknet.md new file mode 100644 index 000000000..2042b8dbd --- /dev/null +++ b/markdown/bitburner.ns.hacknet.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hacknet](./bitburner.ns.hacknet.md) + +## NS.hacknet property + +Not all functions in the Hacknet Node API are immediately available. + +Note that none of these functions will write to the script’s logs. + +If you want to see what your script is doing you will have to print to the logs yourself. + +Signature: + +```typescript +readonly hacknet: HackNet; +``` + +## Remarks + +4 GB + diff --git a/markdown/bitburner.ns.hasrootaccess.md b/markdown/bitburner.ns.hasrootaccess.md new file mode 100644 index 000000000..e46329295 --- /dev/null +++ b/markdown/bitburner.ns.hasrootaccess.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [hasRootAccess](./bitburner.ns.hasrootaccess.md) + +## NS.hasRootAccess() method + +Returns a boolean indicating whether or not the player has root access to the specified target server. + +Signature: + +```typescript +hasRootAccess(host: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of the target server | + +Returns: + +boolean + +True if player has root access to the specified target server, and false otherwise. + +## Remarks + +0.05 GB + +## Example + + +```js +if (hasRootAccess("foodnstuff") == false) { + nuke("foodnstuff"); +} +``` + diff --git a/markdown/bitburner.ns.httpworm.md b/markdown/bitburner.ns.httpworm.md new file mode 100644 index 000000000..1d427ca34 --- /dev/null +++ b/markdown/bitburner.ns.httpworm.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [httpworm](./bitburner.ns.httpworm.md) + +## NS.httpworm() method + +Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer. + +Signature: + +```typescript +httpworm(host: Host): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | + +Returns: + +void + +## Remarks + +0.05 GB + +## Example + + +```js +httpworm("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.islogenabled.md b/markdown/bitburner.ns.islogenabled.md new file mode 100644 index 000000000..567be2000 --- /dev/null +++ b/markdown/bitburner.ns.islogenabled.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [isLogEnabled](./bitburner.ns.islogenabled.md) + +## NS.isLogEnabled() method + +Checks the status of the logging for the given function. + +Signature: + +```typescript +isLogEnabled(fn: string): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | string | Name of function to check. | + +Returns: + +boolean + +Returns a boolean indicating whether or not logging is enabled for that function (or \`ALL\`) + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.isrunning.md b/markdown/bitburner.ns.isrunning.md new file mode 100644 index 000000000..999900ca7 --- /dev/null +++ b/markdown/bitburner.ns.isrunning.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [isRunning](./bitburner.ns.isrunning.md) + +## NS.isRunning() method + +Returns a boolean indicating whether the specified script is running on the target server. Remember that a script is uniquely identified by both its name and its arguments. + +Signature: + +```typescript +isRunning(script: Script, host: Host, ...args: string[]): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script to check. This is case-sensitive. | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | +| args | string\[\] | Arguments to specify/identify which scripts to search for. | + +Returns: + +boolean + +True if specified script is running on the target server, and false otherwise. + +## Remarks + +0.1 GB + +## Example 1 + + +```js +//The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise: +isRunning("foo.script", "foodnstuff"); +``` + +## Example 2 + + +```js +//The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise: +isRunning("foo.script", getHostname()); +``` + +## Example 3 + + +```js +//The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise: +isRunning("foo.script", "joesguns", 1, 5, "test"); +``` + diff --git a/markdown/bitburner.ns.kill.md b/markdown/bitburner.ns.kill.md new file mode 100644 index 000000000..51bb4e629 --- /dev/null +++ b/markdown/bitburner.ns.kill.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [kill](./bitburner.ns.kill.md) + +## NS.kill() method + +Kills the script on the target server specified by the script’s name and arguments. Remember that scripts are uniquely identified by both their name and arguments. For example, if \`foo.script\` is run with the argument 1, then this is not the same as \`foo.script\` run with the argument 2, even though they have the same code. + +Signature: + +```typescript +kill(script: Script, host: Host, ...args: string[]): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of the script to kill | +| host | [Host](./bitburner.host.md) | Hostname or IP of the server on which to kill the script. | +| args | string\[\] | Arguments to identify which script to kill. | + +Returns: + +boolean + +True if the script is successfully killed, and false otherwise. + +## Remarks + +0.5 GB + +## Example 1 + + +```js +//The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: +kill("foo.script", "foodnstuff"); +``` + +## Example 2 + + +```js +//The following will try to kill a script named foo.script on the current server that was ran with no arguments: +kill("foo.script", getHostname()); +``` + +## Example 3 + + +```js +//The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: +kill("foo.script", getHostname(), 1, "foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.kill_1.md b/markdown/bitburner.ns.kill_1.md new file mode 100644 index 000000000..b1d74b4ae --- /dev/null +++ b/markdown/bitburner.ns.kill_1.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [kill](./bitburner.ns.kill_1.md) + +## NS.kill() method + +Kills the script with the specified PID. Killing a script by its PID will typically have better performance, especially if you have many scripts running. If this function successfully kills the specified script, then it will return true. Otherwise, it will return false. + +Signature: + +```typescript +kill(scriptPid: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| scriptPid | number | PID of the script to kill | + +Returns: + +boolean + +True if the script is successfully killed, and false otherwise. + +## Remarks + +0.5 GB + +## Example + + +```js +if (kill(10)) { + print("Killed script with PID 10!"); +} +``` + diff --git a/markdown/bitburner.ns.killall.md b/markdown/bitburner.ns.killall.md new file mode 100644 index 000000000..ebb82381b --- /dev/null +++ b/markdown/bitburner.ns.killall.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [killall](./bitburner.ns.killall.md) + +## NS.killall() method + +Kills all running scripts on the specified server. This function returns true if any scripts were killed, and false otherwise. In other words, it will return true if there are any scripts running on the target server. + +Signature: + +```typescript +killall(host: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | IP or hostname of the server on which to kill all scripts. | + +Returns: + +boolean + +True if any scripts were killed, and false otherwise. + +## Remarks + +0.5 GB + diff --git a/markdown/bitburner.ns.ls.md b/markdown/bitburner.ns.ls.md new file mode 100644 index 000000000..3d8b0a01e --- /dev/null +++ b/markdown/bitburner.ns.ls.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [ls](./bitburner.ns.ls.md) + +## NS.ls() method + +Returns an array with the filenames of all files on the specified server (as strings). The returned array is sorted in alphabetic order. + +Signature: + +```typescript +ls(host: Host, grep?: string): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of the target server. | +| grep | string | A substring to search for in the filename. | + +Returns: + +string\[\] + +Array with the filenames of all files on the specified server. + +## Remarks + +0.2 GB + diff --git a/markdown/bitburner.ns.md b/markdown/bitburner.ns.md new file mode 100644 index 000000000..ad0faf2c6 --- /dev/null +++ b/markdown/bitburner.ns.md @@ -0,0 +1,120 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) + +## NS interface + + +Signature: + +```typescript +export interface NS extends Singularity +``` +Extends: [Singularity](./bitburner.singularity.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [args](./bitburner.ns.args.md) | any\[\] | Arguments passed into a script can be accessed using a normal array using the \[\] operator (args\[0\], args\[1\], etc…).It is also possible to get the number of arguments that was passed into a script using: +```js +args.length +``` +WARNING: Do not try to modify the args array. This will break the game. | +| [bladeburner](./bitburner.ns.bladeburner.md) | [Bladeburner](./bitburner.bladeburner.md) | | +| [codingcontract](./bitburner.ns.codingcontract.md) | [CodingContract](./bitburner.codingcontract.md) | | +| [gang](./bitburner.ns.gang.md) | [Gang](./bitburner.gang.md) | | +| [hacknet](./bitburner.ns.hacknet.md) | [HackNet](./bitburner.hacknet.md) | Not all functions in the Hacknet Node API are immediately available.Note that none of these functions will write to the script’s logs.If you want to see what your script is doing you will have to print to the logs yourself. | +| [sleeve](./bitburner.ns.sleeve.md) | [Sleeve](./bitburner.sleeve.md) | | +| [stock](./bitburner.ns.stock.md) | [TIX](./bitburner.tix.md) | | + +## Methods + +| Method | Description | +| --- | --- | +| [brutessh(host)](./bitburner.ns.brutessh.md) | Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer. | +| [clear(handle)](./bitburner.ns.clear.md) | This function is used to clear data in a Netscript Ports or a text file.If the port/fn argument is a number between 1 and 20, then it specifies a port and will clear it (deleting all data from the underlying queue).If the port/fn argument is a string, then it specifies the name of a text file (.txt) and will delete all data from that text file. | +| [clearLog()](./bitburner.ns.clearlog.md) | Clears the script’s logs. | +| [deleteServer(host)](./bitburner.ns.deleteserver.md) | Deletes one of your purchased servers, which is specified by its hostname.The hostname argument can be any data type, but it will be converted to a string. Whitespace is automatically removed from the string. This function will not delete a server that still has scripts running on it. | +| [disableLog(fn)](./bitburner.ns.disablelog.md) | Disables logging for the given function. Logging can be disabled for all functions by passing \`ALL\` as the argument.Note that this does not completely remove all logging functionality. This only stops a function from logging when the function is successful. If the function fails, it will still log the reason for failure.Notable functions that cannot have their logs disabled: run, exec, exit. | +| [enableLog(fn)](./bitburner.ns.enablelog.md) | Re-enables logging for the given function. If \`ALL\` is passed into this function as an argument, then it will revert the effects of disableLog(\`ALL\`). | +| [exec(script, host, numThreads, args)](./bitburner.ns.exec.md) | 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.If the script was successfully started, then this functions 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.Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error. | +| [exit()](./bitburner.ns.exit.md) | Terminates the current script immediately. | +| [fileExists(filename, host)](./bitburner.ns.fileexists.md) | Returns a boolean indicating whether the specified file exists on the target server. The filename for scripts is case-sensitive, but for other types of files it is not. For example, fileExists(“brutessh.exe”) will work fine, even though the actual program is named 'BruteSSH.exe'.If the hostname/ip argument is omitted, then the function will search through the current server (the server running the script that calls this function) for the file. | +| [ftpcrack(host)](./bitburner.ns.ftpcrack.md) | Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer. | +| [getBitNodeMultipliers(url, target, host)](./bitburner.ns.getbitnodemultipliers.md) | Returns an object containing the current BitNode multipliers. This function requires Source-File 5 in order to run. The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). The multipliers represent the difference between the current BitNode and the original BitNode (BitNode-1).For example, if the CrimeMoney multiplier has a value of 0.1, then that means that committing crimes in the current BitNode will only give 10% of the money you would have received in BitNode-1. | +| [getFavorToDonate()](./bitburner.ns.getfavortodonate.md) | Returns the amount of Faction favor required to be able to donate to a faction. | +| [getGrowTime(host, hackLvl, intLvl)](./bitburner.ns.getgrowtime.md) | Returns the amount of time in seconds it takes to execute the grow Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels. | +| [getHackingLevel()](./bitburner.ns.gethackinglevel.md) | Returns the player’s current hacking level. | +| [getHackingMultipliers()](./bitburner.ns.gethackingmultipliers.md) | Returns an object containing the Player’s hacking related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%). | +| [getHacknetMultipliers()](./bitburner.ns.gethacknetmultipliers.md) | Returns an object containing the Player’s hacknet related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%). | +| [getHackTime(host, hackLvl, intLvl)](./bitburner.ns.gethacktime.md) | Returns the amount of time in seconds it takes to execute the hack Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels. | +| [getHostname()](./bitburner.ns.gethostname.md) | Returns a string with the hostname of the server that the script is running on. | +| [getPortHandle(port)](./bitburner.ns.getporthandle.md) | Get a handle to a Netscript Port.WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0. | +| [getPurchasedServerCost(ram)](./bitburner.ns.getpurchasedservercost.md) | Returns the cost to purchase a server with the specified amount of ram. | +| [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(hostnameMode)](./bitburner.ns.getpurchasedservers.md) | Returns an array with either the hostnames or IPs of all of the servers you have purchased. | +| [getScriptExpGain(script, host, args)](./bitburner.ns.getscriptexpgain.md) | Returns the amount of hacking experience the specified script generates while online (when the game is open, does not apply for offline experience gains). Remember that a script is uniquely identified by both its name and its arguments.This function can also return the total experience gain rate of all of your active scripts by running the function with no arguments. | +| [getScriptIncome(script, host, args)](./bitburner.ns.getscriptincome.md) | Returns the amount of income the specified script generates while online (when the game is open, does not apply for offline income). Remember that a script is uniquely identified by both its name and its arguments. So for example if you ran a script with the arguments “foodnstuff” and “5” then in order to use this function to get that script’s income you must specify those same arguments in the same order in this function call.This function can also be called with no arguments. If called with no arguments, then this function will return an array of two values. The first value is the total income ($ / second) of all of your active scripts (scripts that are currently running on any server). The second value is the total income ($ / second) that you’ve earned from scripts since you last installed Augmentations. | +| [getScriptLogs(fn, host, args)](./bitburner.ns.getscriptlogs.md) | Returns a script’s logs. The logs are returned as an array, where each line is an element in the array. The most recently logged line is at the end of the array. Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the game’s options. If the function is called with no arguments, it will return the current script’s logs.Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments. | +| [getScriptName()](./bitburner.ns.getscriptname.md) | Returns the current script name. | +| [getScriptRam(script, host)](./bitburner.ns.getscriptram.md) | Returns the amount of RAM required to run the specified script on the target server. Returns 0 if the script does not exist. | +| [getServer(host)](./bitburner.ns.getserver.md) | Returns a server object for the given server. Defaults to the running script's server if host is not specified. | +| [getServerBaseSecurityLevel(host)](./bitburner.ns.getserverbasesecuritylevel.md) | Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s). | +| [getServerGrowth(host)](./bitburner.ns.getservergrowth.md) | Returns the server’s instrinsic “growth parameter”. This growth parameter is a number between 1 and 100 that represents how quickly the server’s money grows. This parameter affects the percentage by which the server’s money is increased when using the grow function. A higher growth parameter will result in a higher percentage increase from grow. | +| [getServerMaxMoney(host)](./bitburner.ns.getservermaxmoney.md) | Returns the maximum amount of money that can be available on a server. | +| [getServerMinSecurityLevel(host)](./bitburner.ns.getserverminsecuritylevel.md) | Returns the minimum security level of the target server. | +| [getServerMoneyAvailable(host)](./bitburner.ns.getservermoneyavailable.md) | Returns the amount of money available on a server. Running this function on the home computer will return the player’s money. | +| [getServerNumPortsRequired(host)](./bitburner.ns.getservernumportsrequired.md) | Returns the number of open ports required to successfully run NUKE.exe on the specified server. | +| [getServerRam(host)](./bitburner.ns.getserverram.md) | Returns an array with two elements that gives information about a server’s memory (RAM). The first element in the array is the amount of RAM that the server has total (in GB). The second element in the array is the amount of RAM that is currently being used on the server (in GB). | +| [getServerRequiredHackingLevel(host)](./bitburner.ns.getserverrequiredhackinglevel.md) | Returns the required hacking level of the target server. | +| [getServerSecurityLevel(host)](./bitburner.ns.getserversecuritylevel.md) | Returns the security level of the target server. A server’s security level is denoted by a number, typically between 1 and 100 (but it can go above 100). | +| [getTimeSinceLastAug()](./bitburner.ns.gettimesincelastaug.md) | Returns the amount of time in milliseconds that have passed since you last installed Augmentations. | +| [getWeakenTime(host, hackLvl, intLvl)](./bitburner.ns.getweakentime.md) | Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. | +| [grow(host, opts)](./bitburner.ns.grow.md) | Use your hacking skills to increase the amount of money available on a server. The runtime for this command depends on your hacking level and the target server’s security level. When \`grow\` completes, the money available on a target server will be increased by a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate.Like hack, \`grow\` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004. | +| [growthAnalyze(host, growthAmount)](./bitburner.ns.growthanalyze.md) | This function returns the number of “growths” needed in order to increase the amount of money available on the specified server by the specified amount. The specified amount is multiplicative and is in decimal form, not percentage.Warning: The value returned by this function isn’t necessarily a whole number. | +| [growthAnalyzeSecurity(threads)](./bitburner.ns.growthanalyzesecurity.md) | Returns the security increase that would occur if a grow with this many threads happened. | +| [hack(host, opts)](./bitburner.ns.hack.md) | Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target server’s security level. In order to hack a server you must first gain root access to that server and also have the required hacking level.A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the \`foodnstuff\` server and run that script on any server in the game.A successful \`hack()\` on a server will raise that server’s security level by 0.002. | +| [hackAnalyzePercent(host)](./bitburner.ns.hackanalyzepercent.md) | Returns the percentage of the specified server’s money you will steal with a single hack. This value is returned in percentage form, not decimal (Netscript functions typically return in decimal form, but not this one). | +| [hackAnalyzeSecurity(threads)](./bitburner.ns.hackanalyzesecurity.md) | Returns the security increase that would occur if a hack with this many threads happened. | +| [hackAnalyzeThreads(host, hackAmount)](./bitburner.ns.hackanalyzethreads.md) | This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1.Warning: The value returned by this function isn’t necessarily a whole number. | +| [hackChance(host)](./bitburner.ns.hackchance.md) | Returns the chance you have of successfully hacking the specified server.This returned value is in decimal form, not percentage. | +| [hasRootAccess(host)](./bitburner.ns.hasrootaccess.md) | Returns a boolean indicating whether or not the player has root access to the specified target server. | +| [httpworm(host)](./bitburner.ns.httpworm.md) | Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer. | +| [isLogEnabled(fn)](./bitburner.ns.islogenabled.md) | Checks the status of the logging for the given function. | +| [isRunning(script, host, args)](./bitburner.ns.isrunning.md) | Returns a boolean indicating whether the specified script is running on the target server. Remember that a script is uniquely identified by both its name and its arguments. | +| [kill(script, host, args)](./bitburner.ns.kill.md) | Kills the script on the target server specified by the script’s name and arguments. Remember that scripts are uniquely identified by both their name and arguments. For example, if \`foo.script\` is run with the argument 1, then this is not the same as \`foo.script\` run with the argument 2, even though they have the same code. | +| [kill(scriptPid)](./bitburner.ns.kill_1.md) | Kills the script with the specified PID. Killing a script by its PID will typically have better performance, especially if you have many scripts running. If this function successfully kills the specified script, then it will return true. Otherwise, it will return false. | +| [killall(host)](./bitburner.ns.killall.md) | Kills all running scripts on the specified server. This function returns true if any scripts were killed, and false otherwise. In other words, it will return true if there are any scripts running on the target server. | +| [ls(host, grep)](./bitburner.ns.ls.md) | Returns an array with the filenames of all files on the specified server (as strings). The returned array is sorted in alphabetic order. | +| [nFormat(n, format)](./bitburner.ns.nformat.md) | 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. | +| [nuke(host)](./bitburner.ns.nuke.md) | Runs the NUKE.exe program on the target server. NUKE.exe must exist on your home computer. | +| [peek(port)](./bitburner.ns.peek.md) | This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned. | +| [print(msg)](./bitburner.ns.print.md) | Prints a value or a variable to the script’s logs. | +| [prompt(txt)](./bitburner.ns.prompt.md) | Prompts the player with a dialog box with two options: “Yes” and “No”. This function will return true if the player click “Yes” and false if the player clicks “No”. The script’s execution is halted until the player selects one of the options. | +| [ps(host)](./bitburner.ns.ps.md) | Returns an array with general information about all scripts running on the specified target server. | +| [purchaseServer(hostname, ram)](./bitburner.ns.purchaseserver.md) | Purchased a server with the specified hostname and amount of RAM.The hostname argument can be any data type, but it will be converted to a string and have whitespace removed. Anything that resolves to an empty string will cause the function to fail. If there is already a server with the specified hostname, then the function will automatically append a number at the end of the hostname argument value until it finds a unique hostname. For example, if the script calls \`purchaseServer(“foo”, 4)\` but a server named “foo” already exists, the it will automatically change the hostname to \`foo-0\`. If there is already a server with the hostname \`foo-0\`, then it will change the hostname to \`foo-1\`, and so on.Note that there is a maximum limit to the amount of servers you can purchase.Returns the hostname of the newly purchased server as a string. If the function fails to purchase a server, then it will return an empty string. The function will fail if the arguments passed in are invalid, if the player does not have enough money to purchase the specified server, or if the player has exceeded the maximum amount of servers. | +| [read(handle)](./bitburner.ns.read.md) | This function is used to read data from a port or from a text file (.txt).If the argument port/fn is a number between 1 and 20, then it specifies a port and it will read data from that port. A port is a serialized queue. This function will remove the first element from that queue and return it. If the queue is empty, then the string “NULL PORT DATA” will be returned.If the argument port/fn is a string, then it specifies the name of a text file (.txt) and this function will return the data in the specified text file. If the text file does not exist, an empty string will be returned. | +| [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer. | +| [rm(name, host)](./bitburner.ns.rm.md) | Removes the specified file from the current server. This function works for every file type except message (.msg) files. | +| [run(script, numThreads, args)](./bitburner.ns.run.md) | Run a script as a separate process. This function can only be used to run scripts located on the current server (the server running the script that calls this function). Requires a significant amount of RAM to run this command.If the script was successfully started, then this functions 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.Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error. | +| [scan(host, hostnames)](./bitburner.ns.scan.md) | Returns an array containing the hostnames or IPs of all servers that are one node way from the specified target server. The hostnames/IPs in the returned array are strings. | +| [scp(files, destination)](./bitburner.ns.scp.md) | Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy. | +| [scp(files, source, destination)](./bitburner.ns.scp_1.md) | Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy. | +| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kills all scripts with the specified filename on the target server specified by hostname/ip, regardless of arguments. | +| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments.This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments. | +| [serverExists(host)](./bitburner.ns.serverexists.md) | Returns a boolean denoting whether or not the specified server exists. | +| [sleep(millis)](./bitburner.ns.sleep.md) | Suspends the script for n milliseconds. | +| [spawn(script, numThreads, args)](./bitburner.ns.spawn.md) | Terminates the current script, and then after a delay of about 10 seconds it will execute the newly-specified script. The purpose of this function is to execute a new script without being constrained by the RAM usage of the current one. This function can only be used to run scripts on the local server.Because this function immediately terminates the script, it does not have a return value. | +| [sprintf(format, args)](./bitburner.ns.sprintf.md) | Complete open source JavaScript sprintf implementation | +| [sqlinject(host)](./bitburner.ns.sqlinject.md) | Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer. | +| [tail(fn, host, args)](./bitburner.ns.tail.md) | Opens a script’s logs. This is functionally the same as the tail Terminal command.If the function is called with no arguments, it will open the current script’s logs.Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments. | +| [tprint(msg)](./bitburner.ns.tprint.md) | Prints a value or a variable to the Terminal. | +| [tryWrite(port, data)](./bitburner.ns.trywrite.md) | Attempts to write data to the specified Netscript Port. If the port is full, the data will not be written. Otherwise, the data will be written normally. | +| [vsprintf(format, args)](./bitburner.ns.vsprintf.md) | Complete open source JavaScript sprintf implementation | +| [weaken(host, opts)](./bitburner.ns.weaken.md) | Use your hacking skills to attack a server’s security, lowering the server’s security level. The runtime for this command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05.Like hack and grow, \`weaken\` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command. | +| [weakenAnalyze(threads, cores)](./bitburner.ns.weakenanalyze.md) | Returns the security decrease that would occur if a weaken with this many threads happened. | +| [wget(url, target, host)](./bitburner.ns.wget.md) | Retrieves data from a URL and downloads it to a file on the specified server. The data can only be downloaded to a script (.script, .ns, .js) or a text file (.txt). If the file already exists, it will be overwritten by this command. Note that it will not be possible to download data from many websites because they do not allow cross-origin resource sharing (CORS).IMPORTANT: This is an asynchronous function that returns a Promise. The Promise’s resolved value will be a boolean indicating whether or not the data was successfully retrieved from the URL. Because the function is async and returns a Promise, it is recommended you use wget in NetscriptJS (Netscript 2.0).In NetscriptJS, you must preface any call to wget with the await keyword (like you would hack or sleep). wget will still work in Netscript 1.0, but the functions execution will not be synchronous (i.e. it may not execute when you expect/want it to). Furthermore, since Promises are not supported in ES5, you will not be able to process the returned value of wget in Netscript 1.0. | +| [write(handle, data, mode)](./bitburner.ns.write.md) | This function can be used to either write data to a port or to a text file (.txt).If the first argument is a number between 1 and 20, then it specifies a port and this function will write data to that port. The third argument, mode, is not used when writing to a port.If the first argument is a string, then it specifies the name of a text file (.txt) and this function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If \*mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file. | + diff --git a/markdown/bitburner.ns.nformat.md b/markdown/bitburner.ns.nformat.md new file mode 100644 index 000000000..9477c5352 --- /dev/null +++ b/markdown/bitburner.ns.nformat.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [nFormat](./bitburner.ns.nformat.md) + +## NS.nFormat() method + +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. + +Signature: + +```typescript +nFormat(n: number, format: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| n | number | Number to format. | +| format | string | Formatter. | + +Returns: + +number + +Formated number. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.nuke.md b/markdown/bitburner.ns.nuke.md new file mode 100644 index 000000000..a5032e886 --- /dev/null +++ b/markdown/bitburner.ns.nuke.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [nuke](./bitburner.ns.nuke.md) + +## NS.nuke() method + +Runs the NUKE.exe program on the target server. NUKE.exe must exist on your home computer. + +Signature: + +```typescript +nuke(host: Host): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | + +Returns: + +void + +## Remarks + +0.05 GB + +## Example + + +```js +nuke("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.peek.md b/markdown/bitburner.ns.peek.md new file mode 100644 index 000000000..40c1931b6 --- /dev/null +++ b/markdown/bitburner.ns.peek.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [peek](./bitburner.ns.peek.md) + +## NS.peek() method + +This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned. + +Signature: + +```typescript +peek(port: Port): string | number | object; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| port | [Port](./bitburner.port.md) | Port to peek. Must be an integer between 1 and 20. | + +Returns: + +string \| number \| object + +Data in the specified port. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.print.md b/markdown/bitburner.ns.print.md new file mode 100644 index 000000000..a12625ae7 --- /dev/null +++ b/markdown/bitburner.ns.print.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [print](./bitburner.ns.print.md) + +## NS.print() method + +Prints a value or a variable to the script’s logs. + +Signature: + +```typescript +print(msg: string | number | string[] | number[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| msg | string \| number \| string\[\] \| number\[\] | Value to be printed. | + +Returns: + +void + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.prompt.md b/markdown/bitburner.ns.prompt.md new file mode 100644 index 000000000..98530c40a --- /dev/null +++ b/markdown/bitburner.ns.prompt.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [prompt](./bitburner.ns.prompt.md) + +## NS.prompt() method + +Prompts the player with a dialog box with two options: “Yes” and “No”. This function will return true if the player click “Yes” and false if the player clicks “No”. The script’s execution is halted until the player selects one of the options. + +Signature: + +```typescript +prompt(txt: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| txt | string | Text to appear in the prompt dialog box. | + +Returns: + +Promise<boolean> + +True if the player click “Yes” and false if the player clicks “No”. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.ps.md b/markdown/bitburner.ns.ps.md new file mode 100644 index 000000000..33f1381e1 --- /dev/null +++ b/markdown/bitburner.ns.ps.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [ps](./bitburner.ns.ps.md) + +## NS.ps() method + +Returns an array with general information about all scripts running on the specified target server. + +Signature: + +```typescript +ps(host?: Host): ProcessInfo[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP address of the target server. If not specified, it will be the current server’s IP by default. | + +Returns: + +[ProcessInfo](./bitburner.processinfo.md)\[\] + +Array with general information about all scripts running on the specified target server. + +## Remarks + +0.2 GB + +## Example + + +```js +//(using NetscriptJS (Netscript 2.0)) +export async function main(ns) { + const ps = ns.ps("home"); + for (let i = 0; i < ps.length; ++i) { + ns.tprint(ps[i].filename + ' ' + ps[i].threads); + ns.tprint(ps[i].args); + } +} +``` + diff --git a/markdown/bitburner.ns.purchaseserver.md b/markdown/bitburner.ns.purchaseserver.md new file mode 100644 index 000000000..95174df35 --- /dev/null +++ b/markdown/bitburner.ns.purchaseserver.md @@ -0,0 +1,48 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [purchaseServer](./bitburner.ns.purchaseserver.md) + +## NS.purchaseServer() method + +Purchased a server with the specified hostname and amount of RAM. + +The hostname argument can be any data type, but it will be converted to a string and have whitespace removed. Anything that resolves to an empty string will cause the function to fail. If there is already a server with the specified hostname, then the function will automatically append a number at the end of the hostname argument value until it finds a unique hostname. For example, if the script calls \`purchaseServer(“foo”, 4)\` but a server named “foo” already exists, the it will automatically change the hostname to \`foo-0\`. If there is already a server with the hostname \`foo-0\`, then it will change the hostname to \`foo-1\`, and so on. + +Note that there is a maximum limit to the amount of servers you can purchase. + +Returns the hostname of the newly purchased server as a string. If the function fails to purchase a server, then it will return an empty string. The function will fail if the arguments passed in are invalid, if the player does not have enough money to purchase the specified server, or if the player has exceeded the maximum amount of servers. + +Signature: + +```typescript +purchaseServer(hostname: Host, ram: number): Host | ""; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| hostname | [Host](./bitburner.host.md) | Host of the purchased server. | +| ram | number | Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). | + +Returns: + +[Host](./bitburner.host.md) \| "" + +The hostname of the newly purchased server. + +## Remarks + +2.25 GB + +## Example + + +```js +ram = 64; +hn = "pserv-"; +for (i = 0; i < 5; ++i) { + purchaseServer(hn + i, ram); +} +``` + diff --git a/markdown/bitburner.ns.read.md b/markdown/bitburner.ns.read.md new file mode 100644 index 000000000..7d740379c --- /dev/null +++ b/markdown/bitburner.ns.read.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [read](./bitburner.ns.read.md) + +## NS.read() method + +This function is used to read data from a port or from a text file (.txt). + +If the argument port/fn is a number between 1 and 20, then it specifies a port and it will read data from that port. A port is a serialized queue. This function will remove the first element from that queue and return it. If the queue is empty, then the string “NULL PORT DATA” will be returned. + +If the argument port/fn is a string, then it specifies the name of a text file (.txt) and this function will return the data in the specified text file. If the text file does not exist, an empty string will be returned. + +Signature: + +```typescript +read(handle: Handle): string | number | object; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| handle | [Handle](./bitburner.handle.md) | Port or text file to read from. | + +Returns: + +string \| number \| object + +Data in the specified text file or port. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.relaysmtp.md b/markdown/bitburner.ns.relaysmtp.md new file mode 100644 index 000000000..6ad90724d --- /dev/null +++ b/markdown/bitburner.ns.relaysmtp.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [relaysmtp](./bitburner.ns.relaysmtp.md) + +## NS.relaysmtp() method + +Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer. + +Signature: + +```typescript +relaysmtp(host: Host): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | + +Returns: + +void + +## Remarks + +0.05 GB + +## Example + + +```js +relaysmtp("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.rm.md b/markdown/bitburner.ns.rm.md new file mode 100644 index 000000000..18c84e5b0 --- /dev/null +++ b/markdown/bitburner.ns.rm.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [rm](./bitburner.ns.rm.md) + +## NS.rm() method + +Removes the specified file from the current server. This function works for every file type except message (.msg) files. + +Signature: + +```typescript +rm(name: string, host?: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | string | Filename of file to remove. Must include the extension. | +| host | [Host](./bitburner.host.md) | Host or IP Address of the server on which to delete the file. Optional. Defaults to current server. | + +Returns: + +boolean + +True if it successfully deletes the file, and false otherwise. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.run.md b/markdown/bitburner.ns.run.md new file mode 100644 index 000000000..fce12ef76 --- /dev/null +++ b/markdown/bitburner.ns.run.md @@ -0,0 +1,62 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [run](./bitburner.ns.run.md) + +## NS.run() method + +Run a script as a separate process. This function can only be used to run scripts located on the current server (the server running the script that calls this function). Requires a significant amount of RAM to run this command. + +If the script was successfully started, then this functions 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. + +Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error. + +Signature: + +```typescript +run(script: Script, numThreads?: number, ...args: string[]): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script to run. | +| numThreads | number | Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. | +| args | string\[\] | Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value. | + +Returns: + +number + +Returns the PID of a successfully started script, and 0 otherwise. + +## Remarks + +1 GB + +## Example 1 + + +```js +//The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.script’ single-threaded with no arguments: +run("foo.script"); +``` + +## Example 2 + + +```js +//The following example will run ‘foo.script’ but with 5 threads instead of single-threaded: +run("foo.script", 5); +``` + +## Example 3 + + +```js +//This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument: +run("foo.script", 1, 'foodnstuff'); +``` + diff --git a/markdown/bitburner.ns.scan.md b/markdown/bitburner.ns.scan.md new file mode 100644 index 000000000..b287f8ac9 --- /dev/null +++ b/markdown/bitburner.ns.scan.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scan](./bitburner.ns.scan.md) + +## NS.scan() method + +Returns an array containing the hostnames or IPs of all servers that are one node way from the specified target server. The hostnames/IPs in the returned array are strings. + +Signature: + +```typescript +scan(host: Host, hostnames?: boolean): Host[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the server to scan. | +| hostnames | boolean | Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false). | + +Returns: + +[Host](./bitburner.host.md)\[\] + +Returns an string of hostnames or IP. + +## Remarks + +0.2 GB + diff --git a/markdown/bitburner.ns.scp.md b/markdown/bitburner.ns.scp.md new file mode 100644 index 000000000..554cf7db1 --- /dev/null +++ b/markdown/bitburner.ns.scp.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scp](./bitburner.ns.scp.md) + +## NS.scp() method + +Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy. + +Signature: + +```typescript +scp(files: string | ReadonlyArray, destination: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| files | string \| ReadonlyArray<string> | Filename or an array of filenames of script/literature files to copy. | +| destination | [Host](./bitburner.host.md) | Host or IP of the destination server, which is the server to which the file will be copied. | + +Returns: + +boolean + +True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. + +## Remarks + +0.6 GB + +## Example + + +```js +//Copies hack-template.script from the current server to foodnstuff: +scp("hack-template.script", "foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.scp_1.md b/markdown/bitburner.ns.scp_1.md new file mode 100644 index 000000000..829083ed0 --- /dev/null +++ b/markdown/bitburner.ns.scp_1.md @@ -0,0 +1,54 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scp](./bitburner.ns.scp_1.md) + +## NS.scp() method + +Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy. + +Signature: + +```typescript +scp( + files: string | ReadonlyArray, + source: Host, + // tslint:disable-next-line:unified-signatures + destination: Host, + ): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| files | string \| ReadonlyArray<string> | Filename or an array of filenames of script/literature files to copy. | +| source | [Host](./bitburner.host.md) | Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. | +| destination | [Host](./bitburner.host.md) | Host or IP of the destination server, which is the server to which the file will be copied. | + +Returns: + +boolean + +True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. + +## Remarks + +0.6 GB + +## Example 1 + + +```js +//Copies foo.lit from the helios server to the home computer: +scp("foo.lit", "helios", "home"); +``` + +## Example 2 + + +```js +//Tries to copy three files from rothman-uni to home computer: +files = ["foo1.lit", "foo2.script", "foo3.script"]; +scp(files, "rothman-uni", "home"); +``` + diff --git a/markdown/bitburner.ns.scriptkill.md b/markdown/bitburner.ns.scriptkill.md new file mode 100644 index 000000000..79623fdb2 --- /dev/null +++ b/markdown/bitburner.ns.scriptkill.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scriptKill](./bitburner.ns.scriptkill.md) + +## NS.scriptKill() method + +Kills all scripts with the specified filename on the target server specified by hostname/ip, regardless of arguments. + +Signature: + +```typescript +scriptKill(script: Script, host: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script to kill. This is case-sensitive. | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +boolean + +true if one or more scripts were successfully killed, and false if none were. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.scriptrunning.md b/markdown/bitburner.ns.scriptrunning.md new file mode 100644 index 000000000..7949d81c1 --- /dev/null +++ b/markdown/bitburner.ns.scriptrunning.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scriptRunning](./bitburner.ns.scriptrunning.md) + +## NS.scriptRunning() method + +Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments. + +This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments. + +Signature: + +```typescript +scriptRunning(script: Script, host: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script to check. This is case-sensitive. | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +boolean + +True if the specified script is running, and false otherwise. + +## Remarks + +1 GB + +## Example 1 + + +```js +//The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise: +scriptRunning("foo.script", "foodnstuff"); +``` + +## Example 2 + + +```js +//The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise: +scriptRunning("foo.script", getHostname()); +``` + diff --git a/markdown/bitburner.ns.serverexists.md b/markdown/bitburner.ns.serverexists.md new file mode 100644 index 000000000..31f1bbcf5 --- /dev/null +++ b/markdown/bitburner.ns.serverexists.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [serverExists](./bitburner.ns.serverexists.md) + +## NS.serverExists() method + +Returns a boolean denoting whether or not the specified server exists. + +Signature: + +```typescript +serverExists(host: Host): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Host or IP of target server. | + +Returns: + +boolean + +True if specified server exists, and false otherwise. + +## Remarks + +0.1 GB + diff --git a/markdown/bitburner.ns.sleep.md b/markdown/bitburner.ns.sleep.md new file mode 100644 index 000000000..4ae000f63 --- /dev/null +++ b/markdown/bitburner.ns.sleep.md @@ -0,0 +1,29 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [sleep](./bitburner.ns.sleep.md) + +## NS.sleep() method + +Suspends the script for n milliseconds. + +Signature: + +```typescript +sleep(millis: number): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| millis | number | Number of milliseconds to sleep. | + +Returns: + +Promise<void> + + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.sleeve.md b/markdown/bitburner.ns.sleeve.md new file mode 100644 index 000000000..41da5cdfc --- /dev/null +++ b/markdown/bitburner.ns.sleeve.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [sleeve](./bitburner.ns.sleeve.md) + +## NS.sleeve property + +Signature: + +```typescript +readonly sleeve: Sleeve; +``` + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.spawn.md b/markdown/bitburner.ns.spawn.md new file mode 100644 index 000000000..0db57bba1 --- /dev/null +++ b/markdown/bitburner.ns.spawn.md @@ -0,0 +1,40 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [spawn](./bitburner.ns.spawn.md) + +## NS.spawn() method + +Terminates the current script, and then after a delay of about 10 seconds it will execute the newly-specified script. The purpose of this function is to execute a new script without being constrained by the RAM usage of the current one. This function can only be used to run scripts on the local server. + +Because this function immediately terminates the script, it does not have a return value. + +Signature: + +```typescript +spawn(script: Script, numThreads?: number, ...args: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| script | [Script](./bitburner.script.md) | Filename of script to execute. | +| numThreads | number | Number of threads to spawn new script with. Will be rounded to nearest integer. | +| args | string\[\] | Additional arguments to pass into the new script that is being run. | + +Returns: + +void + +## Remarks + +2 GB + +## Example + + +```js +//The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90: +spawn('foo.script', 10, 'foodnstuff', 90); +``` + diff --git a/markdown/bitburner.ns.sprintf.md b/markdown/bitburner.ns.sprintf.md new file mode 100644 index 000000000..1ebede9a1 --- /dev/null +++ b/markdown/bitburner.ns.sprintf.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [sprintf](./bitburner.ns.sprintf.md) + +## NS.sprintf() method + +Complete open source JavaScript sprintf implementation + +Signature: + +```typescript +sprintf(format: string, ...args: string[]): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | String to format. | +| args | string\[\] | Formating arguments. | + +Returns: + +string + +Formated text. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.sqlinject.md b/markdown/bitburner.ns.sqlinject.md new file mode 100644 index 000000000..d36d4462f --- /dev/null +++ b/markdown/bitburner.ns.sqlinject.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [sqlinject](./bitburner.ns.sqlinject.md) + +## NS.sqlinject() method + +Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer. + +Signature: + +```typescript +sqlinject(host: Host): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server. | + +Returns: + +void + +## Remarks + +0.05 GB + +## Example + + +```js +sqlinject("foodnstuff"); +``` + diff --git a/markdown/bitburner.ns.stock.md b/markdown/bitburner.ns.stock.md new file mode 100644 index 000000000..970b78f52 --- /dev/null +++ b/markdown/bitburner.ns.stock.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [stock](./bitburner.ns.stock.md) + +## NS.stock property + +Signature: + +```typescript +readonly stock: TIX; +``` + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.tail.md b/markdown/bitburner.ns.tail.md new file mode 100644 index 000000000..81b233bf6 --- /dev/null +++ b/markdown/bitburner.ns.tail.md @@ -0,0 +1,58 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [tail](./bitburner.ns.tail.md) + +## NS.tail() method + +Opens a script’s logs. This is functionally the same as the tail Terminal command. + +If the function is called with no arguments, it will open the current script’s logs. + +Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments. + +Signature: + +```typescript +tail(fn?: Script, host?: Host, ...args: any[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | [Script](./bitburner.script.md) | Optional. Filename of the script being tailed. If omitted, the current script is tailed. | +| host | [Host](./bitburner.host.md) | Optional. Hostname or IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. | +| args | any\[\] | Arguments for the script being tailed. | + +Returns: + +void + +## Remarks + +0 GB + +## Example 1 + + +```js +//Open logs from foo.script on the current server that was run with no args +tail("foo.script"); +``` + +## Example 2 + + +```js +//Get logs from foo.script on the foodnstuff server that was run with no args +tail("foo.script", "foodnstuff"); +``` + +## Example 3 + + +```js +//Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] +tail("foo.script", "foodnstuff", 1, "test"); +``` + diff --git a/markdown/bitburner.ns.tprint.md b/markdown/bitburner.ns.tprint.md new file mode 100644 index 000000000..7c60ad2d1 --- /dev/null +++ b/markdown/bitburner.ns.tprint.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [tprint](./bitburner.ns.tprint.md) + +## NS.tprint() method + +Prints a value or a variable to the Terminal. + +Signature: + +```typescript +tprint(msg: string | number | string[] | number[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| msg | string \| number \| string\[\] \| number\[\] | Value to be printed. | + +Returns: + +void + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.trywrite.md b/markdown/bitburner.ns.trywrite.md new file mode 100644 index 000000000..bf76f1ff2 --- /dev/null +++ b/markdown/bitburner.ns.trywrite.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [tryWrite](./bitburner.ns.trywrite.md) + +## NS.tryWrite() method + +Attempts to write data to the specified Netscript Port. If the port is full, the data will not be written. Otherwise, the data will be written normally. + +Signature: + +```typescript +tryWrite(port: Handle, data: string | string[] | number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| port | [Handle](./bitburner.handle.md) | Port or text file that will be written to. | +| data | string \| string\[\] \| number | Data to write. | + +Returns: + +boolean + +True if the data is successfully written to the port, and false otherwise. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.vsprintf.md b/markdown/bitburner.ns.vsprintf.md new file mode 100644 index 000000000..8604f0891 --- /dev/null +++ b/markdown/bitburner.ns.vsprintf.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [vsprintf](./bitburner.ns.vsprintf.md) + +## NS.vsprintf() method + +Complete open source JavaScript sprintf implementation + +Signature: + +```typescript +vsprintf(format: string, args: string[]): string; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| format | string | String to format. | +| args | string\[\] | Formating arguments. | + +Returns: + +string + +Formated text. + +## Remarks + +0 GB + diff --git a/markdown/bitburner.ns.weaken.md b/markdown/bitburner.ns.weaken.md new file mode 100644 index 000000000..a9fcf6683 --- /dev/null +++ b/markdown/bitburner.ns.weaken.md @@ -0,0 +1,41 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [weaken](./bitburner.ns.weaken.md) + +## NS.weaken() method + +Use your hacking skills to attack a server’s security, lowering the server’s security level. The runtime for this command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05. + +Like hack and grow, \`weaken\` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command. + +Signature: + +```typescript +weaken(host: Host, opts?: BasicHGWOptions): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| host | [Host](./bitburner.host.md) | Hostname or IP of the target server to weaken. | +| opts | [BasicHGWOptions](./bitburner.basichgwoptions.md) | Optional parameters for configuring function behavior. | + +Returns: + +Promise<number> + +The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads. + +## Remarks + +0.15 GB + +## Example + + +```js +weaken("foodnstuff"); +weaken("foodnstuff", { threads: 5 }); // Only use 5 threads to weaken +``` + diff --git a/markdown/bitburner.ns.weakenanalyze.md b/markdown/bitburner.ns.weakenanalyze.md new file mode 100644 index 000000000..8e9fe8f34 --- /dev/null +++ b/markdown/bitburner.ns.weakenanalyze.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [weakenAnalyze](./bitburner.ns.weakenanalyze.md) + +## NS.weakenAnalyze() method + +Returns the security decrease that would occur if a weaken with this many threads happened. + +Signature: + +```typescript +weakenAnalyze(threads: number, cores?: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| threads | number | Amount of threads that will be used. | +| cores | number | Optional. The number of cores of the server that would run weaken. | + +Returns: + +number + +The security decrease. + +## Remarks + +1 GB + diff --git a/markdown/bitburner.ns.wget.md b/markdown/bitburner.ns.wget.md new file mode 100644 index 000000000..8789f26e0 --- /dev/null +++ b/markdown/bitburner.ns.wget.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [wget](./bitburner.ns.wget.md) + +## NS.wget() method + +Retrieves data from a URL and downloads it to a file on the specified server. The data can only be downloaded to a script (.script, .ns, .js) or a text file (.txt). If the file already exists, it will be overwritten by this command. Note that it will not be possible to download data from many websites because they do not allow cross-origin resource sharing (CORS). + +IMPORTANT: This is an asynchronous function that returns a Promise. The Promise’s resolved value will be a boolean indicating whether or not the data was successfully retrieved from the URL. Because the function is async and returns a Promise, it is recommended you use wget in NetscriptJS (Netscript 2.0). + +In NetscriptJS, you must preface any call to wget with the await keyword (like you would hack or sleep). wget will still work in Netscript 1.0, but the functions execution will not be synchronous (i.e. it may not execute when you expect/want it to). Furthermore, since Promises are not supported in ES5, you will not be able to process the returned value of wget in Netscript 1.0. + +Signature: + +```typescript +wget(url: string, target: string, host?: string): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| url | string | URL to pull data from. | +| target | string | Filename to write data to. Must be script or text file. | +| host | string | Optional hostname/ip of server for target file. | + +Returns: + +Promise<boolean> + +True if the data was successfully retrieved from the URL, false otherwise. + +## Remarks + +0 GB + +## Example + + +```js +wget("https://raw.githubusercontent.com/danielyxie/bitburner/master/README.md", "game_readme.txt"); +``` + diff --git a/markdown/bitburner.ns.write.md b/markdown/bitburner.ns.write.md new file mode 100644 index 000000000..780f67257 --- /dev/null +++ b/markdown/bitburner.ns.write.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [write](./bitburner.ns.write.md) + +## NS.write() method + +This function can be used to either write data to a port or to a text file (.txt). + +If the first argument is a number between 1 and 20, then it specifies a port and this function will write data to that port. The third argument, mode, is not used when writing to a port. + +If the first argument is a string, then it specifies the name of a text file (.txt) and this function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If \*mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file. + +Signature: + +```typescript +write(handle: Handle, data?: string | string[] | number, mode?: "w" | "a"): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| handle | [Handle](./bitburner.handle.md) | Port or text file that will be written to. | +| data | string \| string\[\] \| number | Data to write. | +| mode | "w" \| "a" | Defines the write mode. Only valid when writing to text files. | + +Returns: + +void + +## Remarks + +1 GB + diff --git a/markdown/bitburner.orderpos.md b/markdown/bitburner.orderpos.md new file mode 100644 index 000000000..f86aec943 --- /dev/null +++ b/markdown/bitburner.orderpos.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OrderPos](./bitburner.orderpos.md) + +## OrderPos type + +Signature: + +```typescript +type OrderPos = "long" | "short"; +``` diff --git a/markdown/bitburner.ordertype.md b/markdown/bitburner.ordertype.md new file mode 100644 index 000000000..ed2fd3c88 --- /dev/null +++ b/markdown/bitburner.ordertype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [OrderType](./bitburner.ordertype.md) + +## OrderType type + +Signature: + +```typescript +type OrderType = "limitbuy" | "limitsell" | "stopbuy" | "stopsell"; +``` diff --git a/markdown/bitburner.playerstats.agility.md b/markdown/bitburner.playerstats.agility.md new file mode 100644 index 000000000..440d589f7 --- /dev/null +++ b/markdown/bitburner.playerstats.agility.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PlayerStats](./bitburner.playerstats.md) > [agility](./bitburner.playerstats.agility.md) + +## PlayerStats.agility property + +Agility level + +Signature: + +```typescript +agility: number; +``` diff --git a/markdown/bitburner.playerstats.charisma.md b/markdown/bitburner.playerstats.charisma.md new file mode 100644 index 000000000..f16654c5e --- /dev/null +++ b/markdown/bitburner.playerstats.charisma.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PlayerStats](./bitburner.playerstats.md) > [charisma](./bitburner.playerstats.charisma.md) + +## PlayerStats.charisma property + +Chraisma level + +Signature: + +```typescript +charisma: number; +``` diff --git a/markdown/bitburner.playerstats.defense.md b/markdown/bitburner.playerstats.defense.md new file mode 100644 index 000000000..fbebeb7f3 --- /dev/null +++ b/markdown/bitburner.playerstats.defense.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PlayerStats](./bitburner.playerstats.md) > [defense](./bitburner.playerstats.defense.md) + +## PlayerStats.defense property + +Defense level + +Signature: + +```typescript +defense: number; +``` diff --git a/markdown/bitburner.playerstats.dexterity.md b/markdown/bitburner.playerstats.dexterity.md new file mode 100644 index 000000000..5068d65db --- /dev/null +++ b/markdown/bitburner.playerstats.dexterity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PlayerStats](./bitburner.playerstats.md) > [dexterity](./bitburner.playerstats.dexterity.md) + +## PlayerStats.dexterity property + +Dexterity level + +Signature: + +```typescript +dexterity: number; +``` diff --git a/markdown/bitburner.playerstats.hacking.md b/markdown/bitburner.playerstats.hacking.md new file mode 100644 index 000000000..d1ff032b7 --- /dev/null +++ b/markdown/bitburner.playerstats.hacking.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PlayerStats](./bitburner.playerstats.md) > [hacking](./bitburner.playerstats.hacking.md) + +## PlayerStats.hacking property + +Hacking level + +Signature: + +```typescript +hacking: number; +``` diff --git a/markdown/bitburner.playerstats.intelligence.md b/markdown/bitburner.playerstats.intelligence.md new file mode 100644 index 000000000..16a8ca804 --- /dev/null +++ b/markdown/bitburner.playerstats.intelligence.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PlayerStats](./bitburner.playerstats.md) > [intelligence](./bitburner.playerstats.intelligence.md) + +## PlayerStats.intelligence property + +Intelligence level + +Signature: + +```typescript +intelligence: number; +``` diff --git a/markdown/bitburner.playerstats.md b/markdown/bitburner.playerstats.md new file mode 100644 index 000000000..d634116c9 --- /dev/null +++ b/markdown/bitburner.playerstats.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PlayerStats](./bitburner.playerstats.md) + +## PlayerStats interface + + +Signature: + +```typescript +interface PlayerStats +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility](./bitburner.playerstats.agility.md) | number | Agility level | +| [charisma](./bitburner.playerstats.charisma.md) | number | Chraisma level | +| [defense](./bitburner.playerstats.defense.md) | number | Defense level | +| [dexterity](./bitburner.playerstats.dexterity.md) | number | Dexterity level | +| [hacking](./bitburner.playerstats.hacking.md) | number | Hacking level | +| [intelligence](./bitburner.playerstats.intelligence.md) | number | Intelligence level | +| [strength](./bitburner.playerstats.strength.md) | number | Strength level | + diff --git a/markdown/bitburner.playerstats.strength.md b/markdown/bitburner.playerstats.strength.md new file mode 100644 index 000000000..6e11eda13 --- /dev/null +++ b/markdown/bitburner.playerstats.strength.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PlayerStats](./bitburner.playerstats.md) > [strength](./bitburner.playerstats.strength.md) + +## PlayerStats.strength property + +Strength level + +Signature: + +```typescript +strength: number; +``` diff --git a/markdown/bitburner.port.md b/markdown/bitburner.port.md new file mode 100644 index 000000000..b5e18af07 --- /dev/null +++ b/markdown/bitburner.port.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Port](./bitburner.port.md) + +## Port type + +A port is implemented as a sort of serialized queue, where you can only write and read one element at a time from the port. When you read data from a port, the element that is read is removed from the port. + +IMPORTANT: The data inside ports are not saved! This means if you close and re-open the game, or reload the page then you will lose all of the data in the ports! + +Signature: + +```typescript +type Port = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20; +``` diff --git a/markdown/bitburner.processinfo.args.md b/markdown/bitburner.processinfo.args.md new file mode 100644 index 000000000..cf9e6318e --- /dev/null +++ b/markdown/bitburner.processinfo.args.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) > [args](./bitburner.processinfo.args.md) + +## ProcessInfo.args property + +Script's arguments + +Signature: + +```typescript +args: string[]; +``` diff --git a/markdown/bitburner.processinfo.filename.md b/markdown/bitburner.processinfo.filename.md new file mode 100644 index 000000000..e4654dec6 --- /dev/null +++ b/markdown/bitburner.processinfo.filename.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) > [filename](./bitburner.processinfo.filename.md) + +## ProcessInfo.filename property + +Script name. + +Signature: + +```typescript +filename: Script; +``` diff --git a/markdown/bitburner.processinfo.md b/markdown/bitburner.processinfo.md new file mode 100644 index 000000000..f0ab544f1 --- /dev/null +++ b/markdown/bitburner.processinfo.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) + +## ProcessInfo interface + + +Signature: + +```typescript +interface ProcessInfo +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [args](./bitburner.processinfo.args.md) | string\[\] | Script's arguments | +| [filename](./bitburner.processinfo.filename.md) | [Script](./bitburner.script.md) | Script name. | +| [threads](./bitburner.processinfo.threads.md) | number | Number of threads script is running with | + diff --git a/markdown/bitburner.processinfo.threads.md b/markdown/bitburner.processinfo.threads.md new file mode 100644 index 000000000..8ba00b6ce --- /dev/null +++ b/markdown/bitburner.processinfo.threads.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [ProcessInfo](./bitburner.processinfo.md) > [threads](./bitburner.processinfo.threads.md) + +## ProcessInfo.threads property + +Number of threads script is running with + +Signature: + +```typescript +threads: number; +``` diff --git a/markdown/bitburner.purchaseableprogram.md b/markdown/bitburner.purchaseableprogram.md new file mode 100644 index 000000000..e5f7e2641 --- /dev/null +++ b/markdown/bitburner.purchaseableprogram.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [PurchaseableProgram](./bitburner.purchaseableprogram.md) + +## PurchaseableProgram type + +Signature: + +```typescript +type PurchaseableProgram = + | "brutessh.exe" + | "ftpcrack.exe" + | "relaysmtp.exe" + | "httpworm.exe" + | "sqlinject.exe" + | "deepscanv1.exe" + | "deepscanv2.exe" + | "autolink.exe"; +``` diff --git a/markdown/bitburner.script.md b/markdown/bitburner.script.md new file mode 100644 index 000000000..390781ac1 --- /dev/null +++ b/markdown/bitburner.script.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Script](./bitburner.script.md) + +## Script type + +Signature: + +```typescript +type Script = string; +``` diff --git a/markdown/bitburner.server.cpucores.md b/markdown/bitburner.server.cpucores.md new file mode 100644 index 000000000..931108397 --- /dev/null +++ b/markdown/bitburner.server.cpucores.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [cpuCores](./bitburner.server.cpucores.md) + +## Server.cpuCores property + +Signature: + +```typescript +cpuCores: number; +``` diff --git a/markdown/bitburner.server.ftpportopen.md b/markdown/bitburner.server.ftpportopen.md new file mode 100644 index 000000000..fc78fcf4d --- /dev/null +++ b/markdown/bitburner.server.ftpportopen.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [ftpPortOpen](./bitburner.server.ftpportopen.md) + +## Server.ftpPortOpen property + +Signature: + +```typescript +ftpPortOpen: boolean; +``` diff --git a/markdown/bitburner.server.hasadminrights.md b/markdown/bitburner.server.hasadminrights.md new file mode 100644 index 000000000..a2909c408 --- /dev/null +++ b/markdown/bitburner.server.hasadminrights.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [hasAdminRights](./bitburner.server.hasadminrights.md) + +## Server.hasAdminRights property + +Signature: + +```typescript +hasAdminRights: boolean; +``` diff --git a/markdown/bitburner.server.hostname.md b/markdown/bitburner.server.hostname.md new file mode 100644 index 000000000..658bb0b2b --- /dev/null +++ b/markdown/bitburner.server.hostname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [hostname](./bitburner.server.hostname.md) + +## Server.hostname property + +Signature: + +```typescript +hostname: string; +``` diff --git a/markdown/bitburner.server.httpportopen.md b/markdown/bitburner.server.httpportopen.md new file mode 100644 index 000000000..1c86308a4 --- /dev/null +++ b/markdown/bitburner.server.httpportopen.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [httpPortOpen](./bitburner.server.httpportopen.md) + +## Server.httpPortOpen property + +Signature: + +```typescript +httpPortOpen: boolean; +``` diff --git a/markdown/bitburner.server.ip.md b/markdown/bitburner.server.ip.md new file mode 100644 index 000000000..75a3667ef --- /dev/null +++ b/markdown/bitburner.server.ip.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [ip](./bitburner.server.ip.md) + +## Server.ip property + +Signature: + +```typescript +ip: string; +``` diff --git a/markdown/bitburner.server.isconnectedto.md b/markdown/bitburner.server.isconnectedto.md new file mode 100644 index 000000000..32730c9eb --- /dev/null +++ b/markdown/bitburner.server.isconnectedto.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [isConnectedTo](./bitburner.server.isconnectedto.md) + +## Server.isConnectedTo property + +Signature: + +```typescript +isConnectedTo: boolean; +``` diff --git a/markdown/bitburner.server.maxram.md b/markdown/bitburner.server.maxram.md new file mode 100644 index 000000000..20127a31b --- /dev/null +++ b/markdown/bitburner.server.maxram.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [maxRam](./bitburner.server.maxram.md) + +## Server.maxRam property + +Signature: + +```typescript +maxRam: number; +``` diff --git a/markdown/bitburner.server.md b/markdown/bitburner.server.md new file mode 100644 index 000000000..21c855799 --- /dev/null +++ b/markdown/bitburner.server.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) + +## Server interface + + +Signature: + +```typescript +interface Server +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [cpuCores](./bitburner.server.cpucores.md) | number | | +| [ftpPortOpen](./bitburner.server.ftpportopen.md) | boolean | | +| [hasAdminRights](./bitburner.server.hasadminrights.md) | boolean | | +| [hostname](./bitburner.server.hostname.md) | string | | +| [httpPortOpen](./bitburner.server.httpportopen.md) | boolean | | +| [ip](./bitburner.server.ip.md) | string | | +| [isConnectedTo](./bitburner.server.isconnectedto.md) | boolean | | +| [maxRam](./bitburner.server.maxram.md) | number | | +| [organizationName](./bitburner.server.organizationname.md) | string | | +| [ramUsed](./bitburner.server.ramused.md) | number | | +| [smtpPortOpen](./bitburner.server.smtpportopen.md) | boolean | | +| [sqlPortOpen](./bitburner.server.sqlportopen.md) | boolean | | +| [sshPortOpen](./bitburner.server.sshportopen.md) | boolean | | + diff --git a/markdown/bitburner.server.organizationname.md b/markdown/bitburner.server.organizationname.md new file mode 100644 index 000000000..ec269f993 --- /dev/null +++ b/markdown/bitburner.server.organizationname.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [organizationName](./bitburner.server.organizationname.md) + +## Server.organizationName property + +Signature: + +```typescript +organizationName: string; +``` diff --git a/markdown/bitburner.server.ramused.md b/markdown/bitburner.server.ramused.md new file mode 100644 index 000000000..5591e8bf2 --- /dev/null +++ b/markdown/bitburner.server.ramused.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [ramUsed](./bitburner.server.ramused.md) + +## Server.ramUsed property + +Signature: + +```typescript +ramUsed: number; +``` diff --git a/markdown/bitburner.server.smtpportopen.md b/markdown/bitburner.server.smtpportopen.md new file mode 100644 index 000000000..97ffd1a73 --- /dev/null +++ b/markdown/bitburner.server.smtpportopen.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [smtpPortOpen](./bitburner.server.smtpportopen.md) + +## Server.smtpPortOpen property + +Signature: + +```typescript +smtpPortOpen: boolean; +``` diff --git a/markdown/bitburner.server.sqlportopen.md b/markdown/bitburner.server.sqlportopen.md new file mode 100644 index 000000000..ed01542e2 --- /dev/null +++ b/markdown/bitburner.server.sqlportopen.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [sqlPortOpen](./bitburner.server.sqlportopen.md) + +## Server.sqlPortOpen property + +Signature: + +```typescript +sqlPortOpen: boolean; +``` diff --git a/markdown/bitburner.server.sshportopen.md b/markdown/bitburner.server.sshportopen.md new file mode 100644 index 000000000..5d5bdc4bc --- /dev/null +++ b/markdown/bitburner.server.sshportopen.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Server](./bitburner.server.md) > [sshPortOpen](./bitburner.server.sshportopen.md) + +## Server.sshPortOpen property + +Signature: + +```typescript +sshPortOpen: boolean; +``` diff --git a/markdown/bitburner.singularity.applytocompany.md b/markdown/bitburner.singularity.applytocompany.md new file mode 100644 index 000000000..e76dfcdfe --- /dev/null +++ b/markdown/bitburner.singularity.applytocompany.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [applyToCompany](./bitburner.singularity.applytocompany.md) + +## Singularity.applyToCompany() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at. + +This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false. + +Signature: + +```typescript +applyToCompany(companyName: CompanyName, field: CompanyField): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to apply to. | +| field | [CompanyField](./bitburner.companyfield.md) | Field to which you want to apply. | + +Returns: + +boolean + +True if the player successfully get a job/promotion, and false otherwise. + +## Remarks + +3 GB Level 2 + diff --git a/markdown/bitburner.singularity.checkfactioninvitations.md b/markdown/bitburner.singularity.checkfactioninvitations.md new file mode 100644 index 000000000..4ad4cf4c9 --- /dev/null +++ b/markdown/bitburner.singularity.checkfactioninvitations.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [checkFactionInvitations](./bitburner.singularity.checkfactioninvitations.md) + +## Singularity.checkFactionInvitations() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Returns an array with the name of all Factions you currently have oustanding invitations from. + +Signature: + +```typescript +checkFactionInvitations(): FactionName[]; +``` +Returns: + +[FactionName](./bitburner.factionname.md)\[\] + +Array with the name of all Factions you currently have oustanding invitations from. + +## Remarks + +3 GB Level 2 + diff --git a/markdown/bitburner.singularity.commitcrime.md b/markdown/bitburner.singularity.commitcrime.md new file mode 100644 index 000000000..baef61386 --- /dev/null +++ b/markdown/bitburner.singularity.commitcrime.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [commitCrime](./bitburner.singularity.commitcrime.md) + +## Singularity.commitCrime() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings. + +This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running \`commitCrime('rob store')\` will return 60). + +Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit. + +Signature: + +```typescript +commitCrime(crime: Crime): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| crime | [Crime](./bitburner.crime.md) | Name of crime to attempt. | + +Returns: + +number + +True if you successfully start working on the specified program, and false otherwise. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.createprogram.md b/markdown/bitburner.singularity.createprogram.md new file mode 100644 index 000000000..2128c9789 --- /dev/null +++ b/markdown/bitburner.singularity.createprogram.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [createProgram](./bitburner.singularity.createprogram.md) + +## Singularity.createProgram() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings. + +This function returns true if you successfully start working on the specified program, and false otherwise. + +Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: \* BruteSSH.exe: 50 \* FTPCrack.exe: 100 \* relaySMTP.exe: 250 \* HTTPWorm.exe: 500 \* SQLInject.exe: 750 \* DeepscanV1.exe: 75 \* DeepscanV2.exe: 400 \* ServerProfiler.exe: 75 \* AutoLink.exe: 25 + +Signature: + +```typescript +createProgram(program: CreatableProgram): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| program | [CreatableProgram](./bitburner.creatableprogram.md) | Name of program to create. | + +Returns: + +boolean + +True if you successfully start working on the specified program, and false otherwise. + +## Remarks + +5 GB Level 3 + +## Example + + +```js +createProgram(“relaysmtp.exe”); +``` + diff --git a/markdown/bitburner.singularity.donatetofaction.md b/markdown/bitburner.singularity.donatetofaction.md new file mode 100644 index 000000000..339ef2d21 --- /dev/null +++ b/markdown/bitburner.singularity.donatetofaction.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [donateToFaction](./bitburner.singularity.donatetofaction.md) + +## Singularity.donateToFaction() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise. + +Signature: + +```typescript +donateToFaction(faction: FactionName, amount: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | [FactionName](./bitburner.factionname.md) | Name of faction to donate to. | +| amount | number | Amount of money to donate. | + +Returns: + +boolean + +True if the money was donated, and false otherwise. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getaugmentationcost.md b/markdown/bitburner.singularity.getaugmentationcost.md new file mode 100644 index 000000000..d6d914cc0 --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationcost.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationCost](./bitburner.singularity.getaugmentationcost.md) + +## Singularity.getAugmentationCost() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost. + +If an invalid Augmentation name is passed in for the augName argument, this function will return the array \[-1, -1\]. + +Signature: + +```typescript +getAugmentationCost(augName: AugmentName): [number, number]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation. | + +Returns: + +\[number, number\] + +Array with first element as a reputation requirement and second element as the money cost. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getaugmentationprereq.md b/markdown/bitburner.singularity.getaugmentationprereq.md new file mode 100644 index 000000000..c75dbcf6e --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationprereq.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationPrereq](./bitburner.singularity.getaugmentationprereq.md) + +## Singularity.getAugmentationPrereq() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned. + +Signature: + +```typescript +getAugmentationPrereq(augName: AugmentName): AugmentName[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| augName | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation. | + +Returns: + +[AugmentName](./bitburner.augmentname.md)\[\] + +Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getaugmentationsfromfaction.md b/markdown/bitburner.singularity.getaugmentationsfromfaction.md new file mode 100644 index 000000000..4f663b554 --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationsfromfaction.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationsFromFaction](./bitburner.singularity.getaugmentationsfromfaction.md) + +## Singularity.getAugmentationsFromFaction() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction. + +Signature: + +```typescript +getAugmentationsFromFaction(faction: FactionName): AugmentName[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | + +Returns: + +[AugmentName](./bitburner.augmentname.md)\[\] + +Array containing the names of all Augmentations. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getaugmentationstats.md b/markdown/bitburner.singularity.getaugmentationstats.md new file mode 100644 index 000000000..d67d6774d --- /dev/null +++ b/markdown/bitburner.singularity.getaugmentationstats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getAugmentationStats](./bitburner.singularity.getaugmentationstats.md) + +## Singularity.getAugmentationStats() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function returns augmentation stats. + +Signature: + +```typescript +getAugmentationStats(name: AugmentName): AugmentationStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| name | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation. CASE-SENSITIVE. | + +Returns: + +[AugmentationStats](./bitburner.augmentationstats.md) + +Augmentation stats. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getcharacterinformation.md b/markdown/bitburner.singularity.getcharacterinformation.md new file mode 100644 index 000000000..320b58c76 --- /dev/null +++ b/markdown/bitburner.singularity.getcharacterinformation.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCharacterInformation](./bitburner.singularity.getcharacterinformation.md) + +## Singularity.getCharacterInformation() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Returns an object with various information about your character. + +Signature: + +```typescript +getCharacterInformation(): CharacterInfo; +``` +Returns: + +[CharacterInfo](./bitburner.characterinfo.md) + +Object with various information about your character. + +## Remarks + +0.5 GB Level 1 + diff --git a/markdown/bitburner.singularity.getcompanyfavor.md b/markdown/bitburner.singularity.getcompanyfavor.md new file mode 100644 index 000000000..255d54df6 --- /dev/null +++ b/markdown/bitburner.singularity.getcompanyfavor.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCompanyFavor](./bitburner.singularity.getcompanyfavor.md) + +## Singularity.getCompanyFavor() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. + +Signature: + +```typescript +getCompanyFavor(companyName: CompanyName): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | + +Returns: + +number + +Amount of favor you have at the specified company. + +## Remarks + +1 GB Level 2 + diff --git a/markdown/bitburner.singularity.getcompanyfavorgain.md b/markdown/bitburner.singularity.getcompanyfavorgain.md new file mode 100644 index 000000000..9d7b57b10 --- /dev/null +++ b/markdown/bitburner.singularity.getcompanyfavorgain.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCompanyFavorGain](./bitburner.singularity.getcompanyfavorgain.md) + +## Singularity.getCompanyFavorGain() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations. + +Signature: + +```typescript +getCompanyFavorGain(companyName: CompanyName): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | + +Returns: + +number + +Amount of favor you gain at the specified company when you reset by installing Augmentations. + +## Remarks + +0.75 GB Level 2 + diff --git a/markdown/bitburner.singularity.getcompanyrep.md b/markdown/bitburner.singularity.getcompanyrep.md new file mode 100644 index 000000000..875d0151b --- /dev/null +++ b/markdown/bitburner.singularity.getcompanyrep.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCompanyRep](./bitburner.singularity.getcompanyrep.md) + +## Singularity.getCompanyRep() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. + +Signature: + +```typescript +getCompanyRep(companyName: CompanyName): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company. | + +Returns: + +number + +Amount of reputation you have at the specified company. + +## Remarks + +1 GB Level 2 + diff --git a/markdown/bitburner.singularity.getcrimechance.md b/markdown/bitburner.singularity.getcrimechance.md new file mode 100644 index 000000000..ff5962732 --- /dev/null +++ b/markdown/bitburner.singularity.getcrimechance.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCrimeChance](./bitburner.singularity.getcrimechance.md) + +## Singularity.getCrimeChance() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function returns your chance of success at commiting the specified crime. The chance is returned as a decimal (i.e. 60% would be returned as 0.6). + +Signature: + +```typescript +getCrimeChance(crime: Crime): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| crime | [Crime](./bitburner.crime.md) | Name of crime. | + +Returns: + +number + +Chance of success at commiting the specified crime as a decimal. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getcrimestats.md b/markdown/bitburner.singularity.getcrimestats.md new file mode 100644 index 000000000..a3d59f77f --- /dev/null +++ b/markdown/bitburner.singularity.getcrimestats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getCrimeStats](./bitburner.singularity.getcrimestats.md) + +## Singularity.getCrimeStats() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Returns the stats of the crime. + +Signature: + +```typescript +getCrimeStats(crime: Crime): CrimeStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| crime | [Crime](./bitburner.crime.md) | Name of crime. Not case-sensitive | + +Returns: + +[CrimeStats](./bitburner.crimestats.md) + +The stats of the crime. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getfactionfavor.md b/markdown/bitburner.singularity.getfactionfavor.md new file mode 100644 index 000000000..16e7a70b3 --- /dev/null +++ b/markdown/bitburner.singularity.getfactionfavor.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getFactionFavor](./bitburner.singularity.getfactionfavor.md) + +## Singularity.getFactionFavor() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function returns the amount of favor you have for the specified faction. + +Signature: + +```typescript +getFactionFavor(faction: FactionName): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | + +Returns: + +number + +Amount of favor you have for the specified faction. + +## Remarks + +1 GB Level 2 + diff --git a/markdown/bitburner.singularity.getfactionfavorgain.md b/markdown/bitburner.singularity.getfactionfavorgain.md new file mode 100644 index 000000000..1ab1f2bc4 --- /dev/null +++ b/markdown/bitburner.singularity.getfactionfavorgain.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getFactionFavorGain](./bitburner.singularity.getfactionfavorgain.md) + +## Singularity.getFactionFavorGain() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations. + +Signature: + +```typescript +getFactionFavorGain(faction: FactionName): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | [FactionName](./bitburner.factionname.md) | Name of faction. | + +Returns: + +number + +Amount of favor you will gain for the specified faction when you reset by installing Augmentations. + +## Remarks + +0.75 GB Level 2 + diff --git a/markdown/bitburner.singularity.getfactionrep.md b/markdown/bitburner.singularity.getfactionrep.md new file mode 100644 index 000000000..3243de8fc --- /dev/null +++ b/markdown/bitburner.singularity.getfactionrep.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getFactionRep](./bitburner.singularity.getfactionrep.md) + +## Singularity.getFactionRep() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function returns the amount of reputation you have for the specified faction. + +Signature: + +```typescript +getFactionRep(faction: FactionName): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | [FactionName](./bitburner.factionname.md) | Name of faction to work for. | + +Returns: + +number + +Amount of reputation you have for the specified faction. + +## Remarks + +1 GB Level 2 + diff --git a/markdown/bitburner.singularity.getownedaugmentations.md b/markdown/bitburner.singularity.getownedaugmentations.md new file mode 100644 index 000000000..386955550 --- /dev/null +++ b/markdown/bitburner.singularity.getownedaugmentations.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getOwnedAugmentations](./bitburner.singularity.getownedaugmentations.md) + +## Singularity.getOwnedAugmentations() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function returns an array containing the names (as strings) of all Augmentations you have. + +Signature: + +```typescript +getOwnedAugmentations(purchased?: boolean): AugmentName[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| purchased | boolean | Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations. | + +Returns: + +[AugmentName](./bitburner.augmentname.md)\[\] + +Array containing the names (as strings) of all Augmentations you have. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getownedsourcefiles.md b/markdown/bitburner.singularity.getownedsourcefiles.md new file mode 100644 index 000000000..4268c73d7 --- /dev/null +++ b/markdown/bitburner.singularity.getownedsourcefiles.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getOwnedSourceFiles](./bitburner.singularity.getownedsourcefiles.md) + +## Singularity.getOwnedSourceFiles() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Returns an array of source files + +Signature: + +```typescript +getOwnedSourceFiles(): SourceFileLvl[]; +``` +Returns: + +[SourceFileLvl](./bitburner.sourcefilelvl.md)\[\] + +Array containing an object with number and level of the source file. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.getstats.md b/markdown/bitburner.singularity.getstats.md new file mode 100644 index 000000000..a2f07f979 --- /dev/null +++ b/markdown/bitburner.singularity.getstats.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getStats](./bitburner.singularity.getstats.md) + +## Singularity.getStats() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Returns an object with the Player’s stats. + +Signature: + +```typescript +getStats(): PlayerStats; +``` +Returns: + +[PlayerStats](./bitburner.playerstats.md) + +Object with the Player’s stats. + +## Remarks + +0.5 GB Level 1 + +## Example + + +```js +res = getStats(); +print('My charisma level is: ' + res.charisma); +``` + diff --git a/markdown/bitburner.singularity.getupgradehomeramcost.md b/markdown/bitburner.singularity.getupgradehomeramcost.md new file mode 100644 index 000000000..1ee8d3028 --- /dev/null +++ b/markdown/bitburner.singularity.getupgradehomeramcost.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [getUpgradeHomeRamCost](./bitburner.singularity.getupgradehomeramcost.md) + +## Singularity.getUpgradeHomeRamCost() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Returns the cost of upgrading the player’s home computer RAM. + +Signature: + +```typescript +getUpgradeHomeRamCost(): number; +``` +Returns: + +number + +Cost of upgrading the player’s home computer RAM. + +## Remarks + +1.5 GB Level 2 + diff --git a/markdown/bitburner.singularity.gymworkout.md b/markdown/bitburner.singularity.gymworkout.md new file mode 100644 index 000000000..880204deb --- /dev/null +++ b/markdown/bitburner.singularity.gymworkout.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [gymWorkout](./bitburner.singularity.gymworkout.md) + +## Singularity.gymWorkout() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings. + +The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train + +Signature: + +```typescript +gymWorkout(gymName: Gym, stat: GymStat): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| gymName | [Gym](./bitburner.gym.md) | Name of gym. You must be in the correct city for whatever gym you specify. | +| stat | [GymStat](./bitburner.gymstat.md) | The stat you want to train. | + +Returns: + +boolean + +True if actions is successfully started, false otherwise. + +## Remarks + +2 GB Level 1 + diff --git a/markdown/bitburner.singularity.installaugmentations.md b/markdown/bitburner.singularity.installaugmentations.md new file mode 100644 index 000000000..61fe8184d --- /dev/null +++ b/markdown/bitburner.singularity.installaugmentations.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [installAugmentations](./bitburner.singularity.installaugmentations.md) + +## Singularity.installAugmentations() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will automatically install your Augmentations, resetting the game as usual. + +Signature: + +```typescript +installAugmentations(cbScript?: Script): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| cbScript | [Script](./bitburner.script.md) | Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. | + +Returns: + +void + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.isbusy.md b/markdown/bitburner.singularity.isbusy.md new file mode 100644 index 000000000..655174e5b --- /dev/null +++ b/markdown/bitburner.singularity.isbusy.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [isBusy](./bitburner.singularity.isbusy.md) + +## Singularity.isBusy() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. + +Signature: + +```typescript +isBusy(): boolean; +``` +Returns: + +boolean + +True if the player is currently performing an ‘action’, false otherwise. + +## Remarks + +0.5 GB Level 1 + diff --git a/markdown/bitburner.singularity.joinfaction.md b/markdown/bitburner.singularity.joinfaction.md new file mode 100644 index 000000000..847d28859 --- /dev/null +++ b/markdown/bitburner.singularity.joinfaction.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [joinFaction](./bitburner.singularity.joinfaction.md) + +## Singularity.joinFaction() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will automatically accept an invitation from a faction and join it. + +Signature: + +```typescript +joinFaction(faction: FactionName): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | [FactionName](./bitburner.factionname.md) | Name of faction to join. | + +Returns: + +boolean + +True if player joined the faction, and false otherwise. + +## Remarks + +3 GB Level 2 + diff --git a/markdown/bitburner.singularity.md b/markdown/bitburner.singularity.md new file mode 100644 index 000000000..a6c4a17b4 --- /dev/null +++ b/markdown/bitburner.singularity.md @@ -0,0 +1,54 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) + +## Singularity interface + + +Signature: + +```typescript +interface Singularity +``` + +## Methods + +| Method | Description | +| --- | --- | +| [applyToCompany(companyName, field)](./bitburner.singularity.applytocompany.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false. | +| [checkFactionInvitations()](./bitburner.singularity.checkfactioninvitations.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an array with the name of all Factions you currently have oustanding invitations from. | +| [commitCrime(crime)](./bitburner.singularity.commitcrime.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running \`commitCrime('rob store')\` will return 60).Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit. | +| [createProgram(program)](./bitburner.singularity.createprogram.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.This function returns true if you successfully start working on the specified program, and false otherwise.Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: \* BruteSSH.exe: 50 \* FTPCrack.exe: 100 \* relaySMTP.exe: 250 \* HTTPWorm.exe: 500 \* SQLInject.exe: 750 \* DeepscanV1.exe: 75 \* DeepscanV2.exe: 400 \* ServerProfiler.exe: 75 \* AutoLink.exe: 25 | +| [donateToFaction(faction, amount)](./bitburner.singularity.donatetofaction.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise. | +| [getAugmentationCost(augName)](./bitburner.singularity.getaugmentationcost.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost.If an invalid Augmentation name is passed in for the augName argument, this function will return the array \[-1, -1\]. | +| [getAugmentationPrereq(augName)](./bitburner.singularity.getaugmentationprereq.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned. | +| [getAugmentationsFromFaction(faction)](./bitburner.singularity.getaugmentationsfromfaction.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction. | +| [getAugmentationStats(name)](./bitburner.singularity.getaugmentationstats.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns augmentation stats. | +| [getCharacterInformation()](./bitburner.singularity.getcharacterinformation.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an object with various information about your character. | +| [getCompanyFavor(companyName)](./bitburner.singularity.getcompanyfavor.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. | +| [getCompanyFavorGain(companyName)](./bitburner.singularity.getcompanyfavorgain.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations. | +| [getCompanyRep(companyName)](./bitburner.singularity.getcompanyrep.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned. | +| [getCrimeChance(crime)](./bitburner.singularity.getcrimechance.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns your chance of success at commiting the specified crime. The chance is returned as a decimal (i.e. 60% would be returned as 0.6). | +| [getCrimeStats(crime)](./bitburner.singularity.getcrimestats.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns the stats of the crime. | +| [getFactionFavor(faction)](./bitburner.singularity.getfactionfavor.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns the amount of favor you have for the specified faction. | +| [getFactionFavorGain(faction)](./bitburner.singularity.getfactionfavorgain.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations. | +| [getFactionRep(faction)](./bitburner.singularity.getfactionrep.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns the amount of reputation you have for the specified faction. | +| [getOwnedAugmentations(purchased)](./bitburner.singularity.getownedaugmentations.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function returns an array containing the names (as strings) of all Augmentations you have. | +| [getOwnedSourceFiles()](./bitburner.singularity.getownedsourcefiles.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an array of source files | +| [getStats()](./bitburner.singularity.getstats.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns an object with the Player’s stats. | +| [getUpgradeHomeRamCost()](./bitburner.singularity.getupgradehomeramcost.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns the cost of upgrading the player’s home computer RAM. | +| [gymWorkout(gymName, stat)](./bitburner.singularity.gymworkout.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train | +| [installAugmentations(cbScript)](./bitburner.singularity.installaugmentations.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically install your Augmentations, resetting the game as usual. | +| [isBusy()](./bitburner.singularity.isbusy.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. | +| [joinFaction(faction)](./bitburner.singularity.joinfaction.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically accept an invitation from a faction and join it. | +| [purchaseAugmentation(faction, augmnet)](./bitburner.singularity.purchaseaugmentation.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will try to purchase the specified Augmentation through the given Faction.This function will return true if the Augmentation is successfully purchased, and false otherwise. | +| [purchaseProgram(programName)](./bitburner.singularity.purchaseprogram.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command. | +| [purchaseTor()](./bitburner.singularity.purchasetor.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one. | +| [softReset()](./bitburner.singularity.softreset.md) | If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will perform a reset even if you don’t have any augmentation installed. | +| [stopAction()](./bitburner.singularity.stopaction.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.The actions that can be stopped with this function are:\* Studying at a university \* Working for a company/faction \* Creating a program \* Committing a CrimeThis function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called. | +| [travelToCity(city)](./bitburner.singularity.traveltocity.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency. | +| [universityCourse(universityName, courseName)](./bitburner.singularity.universitycourse.md) | If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes. | +| [upgradeHomeRam()](./bitburner.singularity.upgradehomeram.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually.This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. | +| [workForCompany(companyName)](./bitburner.singularity.workforcompany.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.This function will return true if the player starts working, and false otherwise.Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action. | +| [workForFaction(faction, workType)](./bitburner.singularity.workforfaction.md) | If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.This function will return true if you successfully start working for the specified faction, and false otherwise.Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action. | + diff --git a/markdown/bitburner.singularity.purchaseaugmentation.md b/markdown/bitburner.singularity.purchaseaugmentation.md new file mode 100644 index 000000000..adc4fc308 --- /dev/null +++ b/markdown/bitburner.singularity.purchaseaugmentation.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [purchaseAugmentation](./bitburner.singularity.purchaseaugmentation.md) + +## Singularity.purchaseAugmentation() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will try to purchase the specified Augmentation through the given Faction. + +This function will return true if the Augmentation is successfully purchased, and false otherwise. + +Signature: + +```typescript +purchaseAugmentation(faction: FactionName, augmnet: AugmentName): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | [FactionName](./bitburner.factionname.md) | Name of faction to purchase Augmentation from. | +| augmnet | [AugmentName](./bitburner.augmentname.md) | Name of Augmentation to purchase. | + +Returns: + +boolean + +True if the Augmentation is successfully purchased, and false otherwise. + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.purchaseprogram.md b/markdown/bitburner.singularity.purchaseprogram.md new file mode 100644 index 000000000..799d7e206 --- /dev/null +++ b/markdown/bitburner.singularity.purchaseprogram.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [purchaseProgram](./bitburner.singularity.purchaseprogram.md) + +## Singularity.purchaseProgram() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command. + +Signature: + +```typescript +purchaseProgram(programName: PurchaseableProgram): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| programName | [PurchaseableProgram](./bitburner.purchaseableprogram.md) | Name of program to purchase. | + +Returns: + +boolean + +True if the specified program is purchased, and false otherwise. + +## Remarks + +2 GB Level 1 + +## Example + + +```js +purchaseProgram("brutessh.exe"); +``` + diff --git a/markdown/bitburner.singularity.purchasetor.md b/markdown/bitburner.singularity.purchasetor.md new file mode 100644 index 000000000..e221fead9 --- /dev/null +++ b/markdown/bitburner.singularity.purchasetor.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [purchaseTor](./bitburner.singularity.purchasetor.md) + +## Singularity.purchaseTor() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one. + +Signature: + +```typescript +purchaseTor(): boolean; +``` +Returns: + +boolean + +True if actions is successful, false otherwise. + +## Remarks + +2 GB Level 1 + diff --git a/markdown/bitburner.singularity.softreset.md b/markdown/bitburner.singularity.softreset.md new file mode 100644 index 000000000..b1d0a0f84 --- /dev/null +++ b/markdown/bitburner.singularity.softreset.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [softReset](./bitburner.singularity.softreset.md) + +## Singularity.softReset() method + +If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will perform a reset even if you don’t have any augmentation installed. + +Signature: + +```typescript +softReset(): void; +``` +Returns: + +void + +## Remarks + +5 GB Level 3 + diff --git a/markdown/bitburner.singularity.stopaction.md b/markdown/bitburner.singularity.stopaction.md new file mode 100644 index 000000000..a5e24d583 --- /dev/null +++ b/markdown/bitburner.singularity.stopaction.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [stopAction](./bitburner.singularity.stopaction.md) + +## Singularity.stopAction() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action. + +The actions that can be stopped with this function are: + +\* Studying at a university \* Working for a company/faction \* Creating a program \* Committing a Crime + +This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called. + +Signature: + +```typescript +stopAction(): boolean; +``` +Returns: + +boolean + +True if the player’s action was ended, false if the player was not performing an action. + +## Remarks + +1 GB Level 1 + diff --git a/markdown/bitburner.singularity.traveltocity.md b/markdown/bitburner.singularity.traveltocity.md new file mode 100644 index 000000000..93aff0792 --- /dev/null +++ b/markdown/bitburner.singularity.traveltocity.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [travelToCity](./bitburner.singularity.traveltocity.md) + +## Singularity.travelToCity() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency. + +Signature: + +```typescript +travelToCity(city: City): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| city | [City](./bitburner.city.md) | City to travel to. | + +Returns: + +boolean + +True if actions is successful, false otherwise. + +## Remarks + +2 GB Level 1 + diff --git a/markdown/bitburner.singularity.universitycourse.md b/markdown/bitburner.singularity.universitycourse.md new file mode 100644 index 000000000..000cf88c9 --- /dev/null +++ b/markdown/bitburner.singularity.universitycourse.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [universityCourse](./bitburner.singularity.universitycourse.md) + +## Singularity.universityCourse() method + +If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings. + +The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes. + +Signature: + +```typescript +universityCourse(universityName: University, courseName: UniversityCourse): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| universityName | [University](./bitburner.university.md) | Name of university. You must be in the correct city for whatever university you specify. | +| courseName | [UniversityCourse](./bitburner.universitycourse.md) | Name of course. | + +Returns: + +boolean + +True if actions is successfully started, false otherwise. + +## Remarks + +2 GB Level 1 + diff --git a/markdown/bitburner.singularity.upgradehomeram.md b/markdown/bitburner.singularity.upgradehomeram.md new file mode 100644 index 000000000..e30cfd83a --- /dev/null +++ b/markdown/bitburner.singularity.upgradehomeram.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [upgradeHomeRam](./bitburner.singularity.upgradehomeram.md) + +## Singularity.upgradeHomeRam() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually. + +This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. + +Signature: + +```typescript +upgradeHomeRam(): boolean; +``` +Returns: + +boolean + +True if the player’s home computer RAM is successfully upgraded, and false otherwise. + +## Remarks + +3 GB Level 2 + diff --git a/markdown/bitburner.singularity.workforcompany.md b/markdown/bitburner.singularity.workforcompany.md new file mode 100644 index 000000000..9c0eaf3c7 --- /dev/null +++ b/markdown/bitburner.singularity.workforcompany.md @@ -0,0 +1,48 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [workForCompany](./bitburner.singularity.workforcompany.md) + +## Singularity.workForCompany() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings. + +This function will return true if the player starts working, and false otherwise. + +Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action. + +Signature: + +```typescript +workForCompany(companyName?: CompanyName): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked | + +Returns: + +boolean + +True if the player starts working, and false otherwise. + +## Remarks + +3 GB Level 2 + +## Example + + +```js +//If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings: +while (getCompanyRep(COMPANY HERE) < VALUE) { + workForCompany(); + sleep(60000); +} +//This way, your company reputation will be updated every minute. +``` + diff --git a/markdown/bitburner.singularity.workforfaction.md b/markdown/bitburner.singularity.workforfaction.md new file mode 100644 index 000000000..095db2ae6 --- /dev/null +++ b/markdown/bitburner.singularity.workforfaction.md @@ -0,0 +1,49 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [workForFaction](./bitburner.singularity.workforfaction.md) + +## Singularity.workForFaction() method + +If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled. + +This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings. + +This function will return true if you successfully start working for the specified faction, and false otherwise. + +Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action. + +Signature: + +```typescript +workForFaction(faction: FactionName, workType: FactionWork): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| faction | [FactionName](./bitburner.factionname.md) | Name of faction to work for. | +| workType | [FactionWork](./bitburner.factionwork.md) | Type of work to perform for the faction. | + +Returns: + +boolean + +True if the player starts working, and false otherwise. + +## Remarks + +3 GB Level 2 + +## Example + + +```js +//If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings: +while (getFactionRep(FACTION NAME) < VALUE) { + workForFaction(FACNAME, WORKTYPE); + sleep(60000); +} +//This way, your faction reputation will be updated every minute. +``` + diff --git a/markdown/bitburner.sleeve.getinformation.md b/markdown/bitburner.sleeve.getinformation.md new file mode 100644 index 000000000..a227b279d --- /dev/null +++ b/markdown/bitburner.sleeve.getinformation.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getInformation](./bitburner.sleeve.getinformation.md) + +## Sleeve.getInformation() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a struct containing tons of information about this sleeve + +Signature: + +```typescript +getInformation(sleeveNumber: number): SleeveInformation; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to retrieve information. | + +Returns: + +[SleeveInformation](./bitburner.sleeveinformation.md) + +Object containing tons of information about this sleeve. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.getnumsleeves.md b/markdown/bitburner.sleeve.getnumsleeves.md new file mode 100644 index 000000000..7f202d5d9 --- /dev/null +++ b/markdown/bitburner.sleeve.getnumsleeves.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getNumSleeves](./bitburner.sleeve.getnumsleeves.md) + +## Sleeve.getNumSleeves() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return the number of duplicate sleeves the player has. + +Signature: + +```typescript +getNumSleeves(): number; +``` +Returns: + +number + +number of duplicate sleeves the player has. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.getsleeveaugmentations.md b/markdown/bitburner.sleeve.getsleeveaugmentations.md new file mode 100644 index 000000000..0c9d768db --- /dev/null +++ b/markdown/bitburner.sleeve.getsleeveaugmentations.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveAugmentations](./bitburner.sleeve.getsleeveaugmentations.md) + +## Sleeve.getSleeveAugmentations() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a list of augmentation names that this sleeve has installed. + +Signature: + +```typescript +getSleeveAugmentations(sleeveNumber: number): AugmentName[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to retrieve augmentations from. | + +Returns: + +[AugmentName](./bitburner.augmentname.md)\[\] + +List of augmentation names that this sleeve has installed. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.getsleevepurchasableaugs.md b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md new file mode 100644 index 000000000..fb4cabe9c --- /dev/null +++ b/markdown/bitburner.sleeve.getsleevepurchasableaugs.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleevePurchasableAugs](./bitburner.sleeve.getsleevepurchasableaugs.md) + +## Sleeve.getSleevePurchasableAugs() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a list of augmentations that the player can buy for this sleeve. + +Signature: + +```typescript +getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to retrieve purchasable augmentations from. | + +Returns: + +[AugmentPair](./bitburner.augmentpair.md)\[\] + +List of augmentations that the player can buy for this sleeve. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.getsleevestats.md b/markdown/bitburner.sleeve.getsleevestats.md new file mode 100644 index 000000000..3958ed8be --- /dev/null +++ b/markdown/bitburner.sleeve.getsleevestats.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getSleeveStats](./bitburner.sleeve.getsleevestats.md) + +## Sleeve.getSleeveStats() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a structure containing the stats of the sleeve. + +Signature: + +```typescript +getSleeveStats(sleeveNumber: number): SleeveStats; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to get stats of. | + +Returns: + +[SleeveStats](./bitburner.sleevestats.md) + +Object containing the stats of the sleeve. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.gettask.md b/markdown/bitburner.sleeve.gettask.md new file mode 100644 index 000000000..c7f0dc545 --- /dev/null +++ b/markdown/bitburner.sleeve.gettask.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [getTask](./bitburner.sleeve.gettask.md) + +## Sleeve.getTask() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. + +Signature: + +```typescript +getTask(sleeveNumber: number): SleeveTask; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to retrieve task from. | + +Returns: + +[SleeveTask](./bitburner.sleevetask.md) + +Object containing information the current task that the sleeve is performing. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.md b/markdown/bitburner.sleeve.md new file mode 100644 index 000000000..4189c591e --- /dev/null +++ b/markdown/bitburner.sleeve.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) + +## Sleeve interface + + +Signature: + +```typescript +interface Sleeve +``` + +## Methods + +| Method | Description | +| --- | --- | +| [getInformation(sleeveNumber)](./bitburner.sleeve.getinformation.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a struct containing tons of information about this sleeve | +| [getNumSleeves()](./bitburner.sleeve.getnumsleeves.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return the number of duplicate sleeves the player has. | +| [getSleeveAugmentations(sleeveNumber)](./bitburner.sleeve.getsleeveaugmentations.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a list of augmentation names that this sleeve has installed. | +| [getSleevePurchasableAugs(sleeveNumber)](./bitburner.sleeve.getsleevepurchasableaugs.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a list of augmentations that the player can buy for this sleeve. | +| [getSleeveStats(sleeveNumber)](./bitburner.sleeve.getsleevestats.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a structure containing the stats of the sleeve. | +| [getTask(sleeveNumber)](./bitburner.sleeve.gettask.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. | +| [purchaseSleeveAug(sleeveNumber, augName)](./bitburner.sleeve.purchasesleeveaug.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return true if the aug was purchased and installed on the sleeve. | +| [setToCommitCrime(sleeveNumber, name)](./bitburner.sleeve.settocommitcrime.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully.Returns false if an invalid action is specified. | +| [setToCompanyWork(sleeveNumber, companyName)](./bitburner.sleeve.settocompanywork.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working or this company. | +| [setToFactionWork(sleeveNumber, factionName, factionWorkType)](./bitburner.sleeve.settofactionwork.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working or this faction. | +| [setToGymWorkout(sleeveNumber, gymName, stat)](./bitburner.sleeve.settogymworkout.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve started working out. | +| [setToShockRecovery(sleeveNumber)](./bitburner.sleeve.settoshockrecovery.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully. | +| [setToSynchronize(sleeveNumber)](./bitburner.sleeve.settosynchronize.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully. | +| [setToUniversityCourse(sleeveNumber, university, className)](./bitburner.sleeve.settouniversitycourse.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not this action was set successfully. | +| [travel(sleeveNumber, cityName)](./bitburner.sleeve.travel.md) | If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.Return a boolean indicating whether or not the sleeve reached destination. | + diff --git a/markdown/bitburner.sleeve.purchasesleeveaug.md b/markdown/bitburner.sleeve.purchasesleeveaug.md new file mode 100644 index 000000000..57e17f630 --- /dev/null +++ b/markdown/bitburner.sleeve.purchasesleeveaug.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [purchaseSleeveAug](./bitburner.sleeve.purchasesleeveaug.md) + +## Sleeve.purchaseSleeveAug() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return true if the aug was purchased and installed on the sleeve. + +Signature: + +```typescript +purchaseSleeveAug(sleeveNumber: number, augName: AugmentName): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to buy an aug for. | +| augName | [AugmentName](./bitburner.augmentname.md) | Name of the aug to buy. Must be an exact match. | + +Returns: + +boolean + +True if the aug was purchased and installed on the sleeve, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.settocommitcrime.md b/markdown/bitburner.sleeve.settocommitcrime.md new file mode 100644 index 000000000..849c1455a --- /dev/null +++ b/markdown/bitburner.sleeve.settocommitcrime.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToCommitCrime](./bitburner.sleeve.settocommitcrime.md) + +## Sleeve.setToCommitCrime() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a boolean indicating whether or not this action was set successfully. + +Returns false if an invalid action is specified. + +Signature: + +```typescript +setToCommitCrime(sleeveNumber: number, name: Crime): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to start commiting crime. | +| name | [Crime](./bitburner.crime.md) | Name of the crime. Must be an exact match. | + +Returns: + +boolean + +True if this action was set successfully, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.settocompanywork.md b/markdown/bitburner.sleeve.settocompanywork.md new file mode 100644 index 000000000..6a3057a68 --- /dev/null +++ b/markdown/bitburner.sleeve.settocompanywork.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToCompanyWork](./bitburner.sleeve.settocompanywork.md) + +## Sleeve.setToCompanyWork() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a boolean indicating whether or not the sleeve started working or this company. + +Signature: + +```typescript +setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to work for the company. | +| companyName | [CompanyName](./bitburner.companyname.md) | Name of the company to work for. | + +Returns: + +boolean + +True if the sleeve started working on this company, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.settofactionwork.md b/markdown/bitburner.sleeve.settofactionwork.md new file mode 100644 index 000000000..cd5e45314 --- /dev/null +++ b/markdown/bitburner.sleeve.settofactionwork.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToFactionWork](./bitburner.sleeve.settofactionwork.md) + +## Sleeve.setToFactionWork() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a boolean indicating whether or not the sleeve started working or this faction. + +Signature: + +```typescript +setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType: FactionWork): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to work for the faction. | +| factionName | [FactionName](./bitburner.factionname.md) | Name of the faction to work for. | +| factionWorkType | [FactionWork](./bitburner.factionwork.md) | Name of the action to perform for this faction. | + +Returns: + +boolean + +True if the sleeve started working on this faction, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.settogymworkout.md b/markdown/bitburner.sleeve.settogymworkout.md new file mode 100644 index 000000000..11f45058d --- /dev/null +++ b/markdown/bitburner.sleeve.settogymworkout.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToGymWorkout](./bitburner.sleeve.settogymworkout.md) + +## Sleeve.setToGymWorkout() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a boolean indicating whether or not the sleeve started working out. + +Signature: + +```typescript +setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to workout at the gym. | +| gymName | [Gym](./bitburner.gym.md) | Name of the gym. | +| stat | [GymStat](./bitburner.gymstat.md) | Name of the stat to train. | + +Returns: + +boolean + +True if the sleeve started working out, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.settoshockrecovery.md b/markdown/bitburner.sleeve.settoshockrecovery.md new file mode 100644 index 000000000..fdb5b0b99 --- /dev/null +++ b/markdown/bitburner.sleeve.settoshockrecovery.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToShockRecovery](./bitburner.sleeve.settoshockrecovery.md) + +## Sleeve.setToShockRecovery() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a boolean indicating whether or not this action was set successfully. + +Signature: + +```typescript +setToShockRecovery(sleeveNumber: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to start recovery. | + +Returns: + +boolean + +True if this action was set successfully, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.settosynchronize.md b/markdown/bitburner.sleeve.settosynchronize.md new file mode 100644 index 000000000..1e325a196 --- /dev/null +++ b/markdown/bitburner.sleeve.settosynchronize.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToSynchronize](./bitburner.sleeve.settosynchronize.md) + +## Sleeve.setToSynchronize() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a boolean indicating whether or not this action was set successfully. + +Signature: + +```typescript +setToSynchronize(sleeveNumber: number): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to start synchronizing. | + +Returns: + +boolean + +True if this action was set successfully, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.settouniversitycourse.md b/markdown/bitburner.sleeve.settouniversitycourse.md new file mode 100644 index 000000000..dfbb39786 --- /dev/null +++ b/markdown/bitburner.sleeve.settouniversitycourse.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [setToUniversityCourse](./bitburner.sleeve.settouniversitycourse.md) + +## Sleeve.setToUniversityCourse() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a boolean indicating whether or not this action was set successfully. + +Signature: + +```typescript +setToUniversityCourse(sleeveNumber: number, university: University, className: UniversityCourse): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to start taking class. | +| university | [University](./bitburner.university.md) | Name of the university to attend. | +| className | [UniversityCourse](./bitburner.universitycourse.md) | Name of the class to follow. | + +Returns: + +boolean + +True if this action was set successfully, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeve.travel.md b/markdown/bitburner.sleeve.travel.md new file mode 100644 index 000000000..4b7ecbb8a --- /dev/null +++ b/markdown/bitburner.sleeve.travel.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [Sleeve](./bitburner.sleeve.md) > [travel](./bitburner.sleeve.travel.md) + +## Sleeve.travel() method + +If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. + +Return a boolean indicating whether or not the sleeve reached destination. + +Signature: + +```typescript +travel(sleeveNumber: number, cityName: City): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sleeveNumber | number | Index of the sleeve to travel. | +| cityName | [City](./bitburner.city.md) | Name of the destination city. | + +Returns: + +boolean + +True if the sleeve reached destination, false otherwise. + +## Remarks + +4 GB + diff --git a/markdown/bitburner.sleeveinformation.city.md b/markdown/bitburner.sleeveinformation.city.md new file mode 100644 index 000000000..4fecd52db --- /dev/null +++ b/markdown/bitburner.sleeveinformation.city.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [city](./bitburner.sleeveinformation.city.md) + +## SleeveInformation.city property + +location of the sleeve + +Signature: + +```typescript +city: City; +``` diff --git a/markdown/bitburner.sleeveinformation.earningsforplayer.md b/markdown/bitburner.sleeveinformation.earningsforplayer.md new file mode 100644 index 000000000..c21471c17 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.earningsforplayer.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [earningsForPlayer](./bitburner.sleeveinformation.earningsforplayer.md) + +## SleeveInformation.earningsForPlayer property + +earnings synchronized to the player + +Signature: + +```typescript +earningsForPlayer: SleeveWorkGains; +``` diff --git a/markdown/bitburner.sleeveinformation.earningsforsleeves.md b/markdown/bitburner.sleeveinformation.earningsforsleeves.md new file mode 100644 index 000000000..5fbb35ae1 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.earningsforsleeves.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [earningsForSleeves](./bitburner.sleeveinformation.earningsforsleeves.md) + +## SleeveInformation.earningsForSleeves property + +earnings synchronized to other sleeves + +Signature: + +```typescript +earningsForSleeves: SleeveWorkGains; +``` diff --git a/markdown/bitburner.sleeveinformation.earningsfortask.md b/markdown/bitburner.sleeveinformation.earningsfortask.md new file mode 100644 index 000000000..cf35cd51f --- /dev/null +++ b/markdown/bitburner.sleeveinformation.earningsfortask.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [earningsForTask](./bitburner.sleeveinformation.earningsfortask.md) + +## SleeveInformation.earningsForTask property + +earnings for this sleeve + +Signature: + +```typescript +earningsForTask: SleeveWorkGains; +``` diff --git a/markdown/bitburner.sleeveinformation.hp.md b/markdown/bitburner.sleeveinformation.hp.md new file mode 100644 index 000000000..7e6703964 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.hp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [hp](./bitburner.sleeveinformation.hp.md) + +## SleeveInformation.hp property + +current hp of the sleeve + +Signature: + +```typescript +hp: number; +``` diff --git a/markdown/bitburner.sleeveinformation.jobs.md b/markdown/bitburner.sleeveinformation.jobs.md new file mode 100644 index 000000000..3619099e6 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.jobs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [jobs](./bitburner.sleeveinformation.jobs.md) + +## SleeveInformation.jobs property + +jobs available to the sleeve + +Signature: + +```typescript +jobs: string[]; +``` diff --git a/markdown/bitburner.sleeveinformation.jobtitle.md b/markdown/bitburner.sleeveinformation.jobtitle.md new file mode 100644 index 000000000..d97fdfc77 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.jobtitle.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [jobTitle](./bitburner.sleeveinformation.jobtitle.md) + +## SleeveInformation.jobTitle property + +job titles available to the sleeve + +Signature: + +```typescript +jobTitle: CompanyField[]; +``` diff --git a/markdown/bitburner.sleeveinformation.maxhp.md b/markdown/bitburner.sleeveinformation.maxhp.md new file mode 100644 index 000000000..66fee3209 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.maxhp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [maxHp](./bitburner.sleeveinformation.maxhp.md) + +## SleeveInformation.maxHp property + +max hp of the sleeve + +Signature: + +```typescript +maxHp: number; +``` diff --git a/markdown/bitburner.sleeveinformation.md b/markdown/bitburner.sleeveinformation.md new file mode 100644 index 000000000..b08294068 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) + +## SleeveInformation interface + + +Signature: + +```typescript +interface SleeveInformation +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [city](./bitburner.sleeveinformation.city.md) | [City](./bitburner.city.md) | location of the sleeve | +| [earningsForPlayer](./bitburner.sleeveinformation.earningsforplayer.md) | [SleeveWorkGains](./bitburner.sleeveworkgains.md) | earnings synchronized to the player | +| [earningsForSleeves](./bitburner.sleeveinformation.earningsforsleeves.md) | [SleeveWorkGains](./bitburner.sleeveworkgains.md) | earnings synchronized to other sleeves | +| [earningsForTask](./bitburner.sleeveinformation.earningsfortask.md) | [SleeveWorkGains](./bitburner.sleeveworkgains.md) | earnings for this sleeve | +| [hp](./bitburner.sleeveinformation.hp.md) | number | current hp of the sleeve | +| [jobs](./bitburner.sleeveinformation.jobs.md) | string\[\] | jobs available to the sleeve | +| [jobTitle](./bitburner.sleeveinformation.jobtitle.md) | [CompanyField](./bitburner.companyfield.md)\[\] | job titles available to the sleeve | +| [maxHp](./bitburner.sleeveinformation.maxhp.md) | number | max hp of the sleeve | +| [mult](./bitburner.sleeveinformation.mult.md) | [CharacterMult](./bitburner.charactermult.md) | sleeve multipliers | +| [timeWorked](./bitburner.sleeveinformation.timeworked.md) | number | time spent on the current task in milliseconds | +| [tor](./bitburner.sleeveinformation.tor.md) | boolean | does this sleeve have access to the tor router | +| [workRepGain](./bitburner.sleeveinformation.workrepgain.md) | number | faction or company reputation gained for the current task | + diff --git a/markdown/bitburner.sleeveinformation.mult.md b/markdown/bitburner.sleeveinformation.mult.md new file mode 100644 index 000000000..1f8fa2c68 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.mult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [mult](./bitburner.sleeveinformation.mult.md) + +## SleeveInformation.mult property + +sleeve multipliers + +Signature: + +```typescript +mult: CharacterMult; +``` diff --git a/markdown/bitburner.sleeveinformation.timeworked.md b/markdown/bitburner.sleeveinformation.timeworked.md new file mode 100644 index 000000000..0d723af85 --- /dev/null +++ b/markdown/bitburner.sleeveinformation.timeworked.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [timeWorked](./bitburner.sleeveinformation.timeworked.md) + +## SleeveInformation.timeWorked property + +time spent on the current task in milliseconds + +Signature: + +```typescript +timeWorked: number; +``` diff --git a/markdown/bitburner.sleeveinformation.tor.md b/markdown/bitburner.sleeveinformation.tor.md new file mode 100644 index 000000000..56fcb54ef --- /dev/null +++ b/markdown/bitburner.sleeveinformation.tor.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [tor](./bitburner.sleeveinformation.tor.md) + +## SleeveInformation.tor property + +does this sleeve have access to the tor router + +Signature: + +```typescript +tor: boolean; +``` diff --git a/markdown/bitburner.sleeveinformation.workrepgain.md b/markdown/bitburner.sleeveinformation.workrepgain.md new file mode 100644 index 000000000..c3bc973dd --- /dev/null +++ b/markdown/bitburner.sleeveinformation.workrepgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveInformation](./bitburner.sleeveinformation.md) > [workRepGain](./bitburner.sleeveinformation.workrepgain.md) + +## SleeveInformation.workRepGain property + +faction or company reputation gained for the current task + +Signature: + +```typescript +workRepGain: number; +``` diff --git a/markdown/bitburner.sleevestats.agility.md b/markdown/bitburner.sleevestats.agility.md new file mode 100644 index 000000000..787cb8bad --- /dev/null +++ b/markdown/bitburner.sleevestats.agility.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) > [agility](./bitburner.sleevestats.agility.md) + +## SleeveStats.agility property + +current agility of the sleeve + +Signature: + +```typescript +agility: number; +``` diff --git a/markdown/bitburner.sleevestats.charisma.md b/markdown/bitburner.sleevestats.charisma.md new file mode 100644 index 000000000..19f681d6f --- /dev/null +++ b/markdown/bitburner.sleevestats.charisma.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) > [charisma](./bitburner.sleevestats.charisma.md) + +## SleeveStats.charisma property + +current charisma of the sleeve + +Signature: + +```typescript +charisma: number; +``` diff --git a/markdown/bitburner.sleevestats.defense.md b/markdown/bitburner.sleevestats.defense.md new file mode 100644 index 000000000..ad09b5191 --- /dev/null +++ b/markdown/bitburner.sleevestats.defense.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) > [defense](./bitburner.sleevestats.defense.md) + +## SleeveStats.defense property + +current defense of the sleeve + +Signature: + +```typescript +defense: number; +``` diff --git a/markdown/bitburner.sleevestats.dexterity.md b/markdown/bitburner.sleevestats.dexterity.md new file mode 100644 index 000000000..9aec90821 --- /dev/null +++ b/markdown/bitburner.sleevestats.dexterity.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) > [dexterity](./bitburner.sleevestats.dexterity.md) + +## SleeveStats.dexterity property + +current dexterity of the sleeve + +Signature: + +```typescript +dexterity: number; +``` diff --git a/markdown/bitburner.sleevestats.hacking_skill.md b/markdown/bitburner.sleevestats.hacking_skill.md new file mode 100644 index 000000000..50238cf43 --- /dev/null +++ b/markdown/bitburner.sleevestats.hacking_skill.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) > [hacking\_skill](./bitburner.sleevestats.hacking_skill.md) + +## SleeveStats.hacking\_skill property + +current hacking skill of the sleeve + +Signature: + +```typescript +hacking_skill: number; +``` diff --git a/markdown/bitburner.sleevestats.md b/markdown/bitburner.sleevestats.md new file mode 100644 index 000000000..a7bd6ec7b --- /dev/null +++ b/markdown/bitburner.sleevestats.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) + +## SleeveStats interface + + +Signature: + +```typescript +interface SleeveStats +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [agility](./bitburner.sleevestats.agility.md) | number | current agility of the sleeve | +| [charisma](./bitburner.sleevestats.charisma.md) | number | current charisma of the sleeve | +| [defense](./bitburner.sleevestats.defense.md) | number | current defense of the sleeve | +| [dexterity](./bitburner.sleevestats.dexterity.md) | number | current dexterity of the sleeve | +| [hacking\_skill](./bitburner.sleevestats.hacking_skill.md) | number | current hacking skill of the sleeve | +| [shock](./bitburner.sleevestats.shock.md) | \| 0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 \| 13 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 20 \| 21 \| 22 \| 23 \| 24 \| 25 \| 26 \| 27 \| 28 \| 29 \| 30 \| 31 \| 32 \| 33 \| 34 \| 35 \| 36 \| 37 \| 38 \| 39 \| 40 \| 41 \| 42 \| 43 \| 44 \| 45 \| 46 \| 47 \| 48 \| 49 \| 50 \| 51 \| 52 \| 53 \| 54 \| 55 \| 56 \| 57 \| 58 \| 59 \| 60 \| 61 \| 62 \| 63 \| 64 \| 65 \| 66 \| 67 \| 68 \| 69 \| 70 \| 71 \| 72 \| 73 \| 74 \| 75 \| 76 \| 77 \| 78 \| 79 \| 80 \| 81 \| 82 \| 83 \| 84 \| 85 \| 86 \| 87 \| 88 \| 89 \| 90 \| 91 \| 92 \| 93 \| 94 \| 95 \| 96 \| 97 \| 98 \| 99 \| 100 | current shock of the sleeve \[0-100\] | +| [strength](./bitburner.sleevestats.strength.md) | number | current strength of the sleeve | +| [sync](./bitburner.sleevestats.sync.md) | \| 0 \| 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 \| 13 \| 14 \| 15 \| 16 \| 17 \| 18 \| 19 \| 20 \| 21 \| 22 \| 23 \| 24 \| 25 \| 26 \| 27 \| 28 \| 29 \| 30 \| 31 \| 32 \| 33 \| 34 \| 35 \| 36 \| 37 \| 38 \| 39 \| 40 \| 41 \| 42 \| 43 \| 44 \| 45 \| 46 \| 47 \| 48 \| 49 \| 50 \| 51 \| 52 \| 53 \| 54 \| 55 \| 56 \| 57 \| 58 \| 59 \| 60 \| 61 \| 62 \| 63 \| 64 \| 65 \| 66 \| 67 \| 68 \| 69 \| 70 \| 71 \| 72 \| 73 \| 74 \| 75 \| 76 \| 77 \| 78 \| 79 \| 80 \| 81 \| 82 \| 83 \| 84 \| 85 \| 86 \| 87 \| 88 \| 89 \| 90 \| 91 \| 92 \| 93 \| 94 \| 95 \| 96 \| 97 \| 98 \| 99 \| 100 | current sync of the sleeve \[0-100\] | + diff --git a/markdown/bitburner.sleevestats.shock.md b/markdown/bitburner.sleevestats.shock.md new file mode 100644 index 000000000..da035fd69 --- /dev/null +++ b/markdown/bitburner.sleevestats.shock.md @@ -0,0 +1,114 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) > [shock](./bitburner.sleevestats.shock.md) + +## SleeveStats.shock property + +current shock of the sleeve \[0-100\] + +Signature: + +```typescript +shock: + | 0 + | 1 + | 2 + | 3 + | 4 + | 5 + | 6 + | 7 + | 8 + | 9 + | 10 + | 11 + | 12 + | 13 + | 14 + | 15 + | 16 + | 17 + | 18 + | 19 + | 20 + | 21 + | 22 + | 23 + | 24 + | 25 + | 26 + | 27 + | 28 + | 29 + | 30 + | 31 + | 32 + | 33 + | 34 + | 35 + | 36 + | 37 + | 38 + | 39 + | 40 + | 41 + | 42 + | 43 + | 44 + | 45 + | 46 + | 47 + | 48 + | 49 + | 50 + | 51 + | 52 + | 53 + | 54 + | 55 + | 56 + | 57 + | 58 + | 59 + | 60 + | 61 + | 62 + | 63 + | 64 + | 65 + | 66 + | 67 + | 68 + | 69 + | 70 + | 71 + | 72 + | 73 + | 74 + | 75 + | 76 + | 77 + | 78 + | 79 + | 80 + | 81 + | 82 + | 83 + | 84 + | 85 + | 86 + | 87 + | 88 + | 89 + | 90 + | 91 + | 92 + | 93 + | 94 + | 95 + | 96 + | 97 + | 98 + | 99 + | 100; +``` diff --git a/markdown/bitburner.sleevestats.strength.md b/markdown/bitburner.sleevestats.strength.md new file mode 100644 index 000000000..4d5ce6fe1 --- /dev/null +++ b/markdown/bitburner.sleevestats.strength.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) > [strength](./bitburner.sleevestats.strength.md) + +## SleeveStats.strength property + +current strength of the sleeve + +Signature: + +```typescript +strength: number; +``` diff --git a/markdown/bitburner.sleevestats.sync.md b/markdown/bitburner.sleevestats.sync.md new file mode 100644 index 000000000..d536419e5 --- /dev/null +++ b/markdown/bitburner.sleevestats.sync.md @@ -0,0 +1,114 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveStats](./bitburner.sleevestats.md) > [sync](./bitburner.sleevestats.sync.md) + +## SleeveStats.sync property + +current sync of the sleeve \[0-100\] + +Signature: + +```typescript +sync: + | 0 + | 1 + | 2 + | 3 + | 4 + | 5 + | 6 + | 7 + | 8 + | 9 + | 10 + | 11 + | 12 + | 13 + | 14 + | 15 + | 16 + | 17 + | 18 + | 19 + | 20 + | 21 + | 22 + | 23 + | 24 + | 25 + | 26 + | 27 + | 28 + | 29 + | 30 + | 31 + | 32 + | 33 + | 34 + | 35 + | 36 + | 37 + | 38 + | 39 + | 40 + | 41 + | 42 + | 43 + | 44 + | 45 + | 46 + | 47 + | 48 + | 49 + | 50 + | 51 + | 52 + | 53 + | 54 + | 55 + | 56 + | 57 + | 58 + | 59 + | 60 + | 61 + | 62 + | 63 + | 64 + | 65 + | 66 + | 67 + | 68 + | 69 + | 70 + | 71 + | 72 + | 73 + | 74 + | 75 + | 76 + | 77 + | 78 + | 79 + | 80 + | 81 + | 82 + | 83 + | 84 + | 85 + | 86 + | 87 + | 88 + | 89 + | 90 + | 91 + | 92 + | 93 + | 94 + | 95 + | 96 + | 97 + | 98 + | 99 + | 100; +``` diff --git a/markdown/bitburner.sleevetask.crime.md b/markdown/bitburner.sleevetask.crime.md new file mode 100644 index 000000000..e5ed9ce17 --- /dev/null +++ b/markdown/bitburner.sleevetask.crime.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveTask](./bitburner.sleevetask.md) > [crime](./bitburner.sleevetask.crime.md) + +## SleeveTask.crime property + +crime currently attempting, if any + +Signature: + +```typescript +crime: Crime | ""; +``` diff --git a/markdown/bitburner.sleevetask.factionworktype.md b/markdown/bitburner.sleevetask.factionworktype.md new file mode 100644 index 000000000..e643e96a3 --- /dev/null +++ b/markdown/bitburner.sleevetask.factionworktype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveTask](./bitburner.sleevetask.md) > [factionWorkType](./bitburner.sleevetask.factionworktype.md) + +## SleeveTask.factionWorkType property + +faction work type being performed, if any + +Signature: + +```typescript +factionWorkType: FactionWork | ""; +``` diff --git a/markdown/bitburner.sleevetask.gymstattype.md b/markdown/bitburner.sleevetask.gymstattype.md new file mode 100644 index 000000000..c7fb7612f --- /dev/null +++ b/markdown/bitburner.sleevetask.gymstattype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveTask](./bitburner.sleevetask.md) > [gymStatType](./bitburner.sleevetask.gymstattype.md) + +## SleeveTask.gymStatType property + +stat being trained at the gym, if any + +Signature: + +```typescript +gymStatType: GymStat | ""; +``` diff --git a/markdown/bitburner.sleevetask.location.md b/markdown/bitburner.sleevetask.location.md new file mode 100644 index 000000000..6aa91a33a --- /dev/null +++ b/markdown/bitburner.sleevetask.location.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveTask](./bitburner.sleevetask.md) > [location](./bitburner.sleevetask.location.md) + +## SleeveTask.location property + +location of the task, if any + +Signature: + +```typescript +location: City | ""; +``` diff --git a/markdown/bitburner.sleevetask.md b/markdown/bitburner.sleevetask.md new file mode 100644 index 000000000..1ada3a188 --- /dev/null +++ b/markdown/bitburner.sleevetask.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveTask](./bitburner.sleevetask.md) + +## SleeveTask interface + + +Signature: + +```typescript +interface SleeveTask +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [crime](./bitburner.sleevetask.crime.md) | [Crime](./bitburner.crime.md) \| "" | crime currently attempting, if any | +| [factionWorkType](./bitburner.sleevetask.factionworktype.md) | [FactionWork](./bitburner.factionwork.md) \| "" | faction work type being performed, if any | +| [gymStatType](./bitburner.sleevetask.gymstattype.md) | [GymStat](./bitburner.gymstat.md) \| "" | stat being trained at the gym, if any | +| [location](./bitburner.sleevetask.location.md) | [City](./bitburner.city.md) \| "" | location of the task, if any | +| [task](./bitburner.sleevetask.task.md) | string | task type | + diff --git a/markdown/bitburner.sleevetask.task.md b/markdown/bitburner.sleevetask.task.md new file mode 100644 index 000000000..25570a5d5 --- /dev/null +++ b/markdown/bitburner.sleevetask.task.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveTask](./bitburner.sleevetask.md) > [task](./bitburner.sleevetask.task.md) + +## SleeveTask.task property + +task type + +Signature: + +```typescript +task: string; +``` diff --git a/markdown/bitburner.sleeveworkgains.md b/markdown/bitburner.sleeveworkgains.md new file mode 100644 index 000000000..80df4a1b9 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) + +## SleeveWorkGains interface + + +Signature: + +```typescript +interface SleeveWorkGains +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [workAgiExpGain](./bitburner.sleeveworkgains.workagiexpgain.md) | number | agility exp gained from work | +| [workChaExpGain](./bitburner.sleeveworkgains.workchaexpgain.md) | number | charisma exp gained from work | +| [workDefExpGain](./bitburner.sleeveworkgains.workdefexpgain.md) | number | defense exp gained from work, | +| [workDexExpGain](./bitburner.sleeveworkgains.workdexexpgain.md) | number | dexterity exp gained from work | +| [workHackExpGain](./bitburner.sleeveworkgains.workhackexpgain.md) | number | hacking exp gained from work | +| [workMoneyGain](./bitburner.sleeveworkgains.workmoneygain.md) | number | money gained from work | +| [workStrExpGain](./bitburner.sleeveworkgains.workstrexpgain.md) | number | strength exp gained from work | + diff --git a/markdown/bitburner.sleeveworkgains.workagiexpgain.md b/markdown/bitburner.sleeveworkgains.workagiexpgain.md new file mode 100644 index 000000000..94ef15e1f --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workagiexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workAgiExpGain](./bitburner.sleeveworkgains.workagiexpgain.md) + +## SleeveWorkGains.workAgiExpGain property + +agility exp gained from work + +Signature: + +```typescript +workAgiExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workchaexpgain.md b/markdown/bitburner.sleeveworkgains.workchaexpgain.md new file mode 100644 index 000000000..8a973c5b7 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workchaexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workChaExpGain](./bitburner.sleeveworkgains.workchaexpgain.md) + +## SleeveWorkGains.workChaExpGain property + +charisma exp gained from work + +Signature: + +```typescript +workChaExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workdefexpgain.md b/markdown/bitburner.sleeveworkgains.workdefexpgain.md new file mode 100644 index 000000000..c116a88f6 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workdefexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workDefExpGain](./bitburner.sleeveworkgains.workdefexpgain.md) + +## SleeveWorkGains.workDefExpGain property + +defense exp gained from work, + +Signature: + +```typescript +workDefExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workdexexpgain.md b/markdown/bitburner.sleeveworkgains.workdexexpgain.md new file mode 100644 index 000000000..2f61c9c4e --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workdexexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workDexExpGain](./bitburner.sleeveworkgains.workdexexpgain.md) + +## SleeveWorkGains.workDexExpGain property + +dexterity exp gained from work + +Signature: + +```typescript +workDexExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workhackexpgain.md b/markdown/bitburner.sleeveworkgains.workhackexpgain.md new file mode 100644 index 000000000..92a88a4f1 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workhackexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workHackExpGain](./bitburner.sleeveworkgains.workhackexpgain.md) + +## SleeveWorkGains.workHackExpGain property + +hacking exp gained from work + +Signature: + +```typescript +workHackExpGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workmoneygain.md b/markdown/bitburner.sleeveworkgains.workmoneygain.md new file mode 100644 index 000000000..265560067 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workmoneygain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workMoneyGain](./bitburner.sleeveworkgains.workmoneygain.md) + +## SleeveWorkGains.workMoneyGain property + +money gained from work + +Signature: + +```typescript +workMoneyGain: number; +``` diff --git a/markdown/bitburner.sleeveworkgains.workstrexpgain.md b/markdown/bitburner.sleeveworkgains.workstrexpgain.md new file mode 100644 index 000000000..760528cc4 --- /dev/null +++ b/markdown/bitburner.sleeveworkgains.workstrexpgain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SleeveWorkGains](./bitburner.sleeveworkgains.md) > [workStrExpGain](./bitburner.sleeveworkgains.workstrexpgain.md) + +## SleeveWorkGains.workStrExpGain property + +strength exp gained from work + +Signature: + +```typescript +workStrExpGain: number; +``` diff --git a/markdown/bitburner.sourcefilelvl.lvl.md b/markdown/bitburner.sourcefilelvl.lvl.md new file mode 100644 index 000000000..067dd01ce --- /dev/null +++ b/markdown/bitburner.sourcefilelvl.lvl.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SourceFileLvl](./bitburner.sourcefilelvl.md) > [lvl](./bitburner.sourcefilelvl.lvl.md) + +## SourceFileLvl.lvl property + +The level of the source file + +Signature: + +```typescript +lvl: number; +``` diff --git a/markdown/bitburner.sourcefilelvl.md b/markdown/bitburner.sourcefilelvl.md new file mode 100644 index 000000000..df0a1b51d --- /dev/null +++ b/markdown/bitburner.sourcefilelvl.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SourceFileLvl](./bitburner.sourcefilelvl.md) + +## SourceFileLvl interface + + +Signature: + +```typescript +interface SourceFileLvl +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [lvl](./bitburner.sourcefilelvl.lvl.md) | number | The level of the source file | +| [n](./bitburner.sourcefilelvl.n.md) | 1 \| 2 \| 3 \| 4 \| 5 \| 6 \| 7 \| 8 \| 9 \| 10 \| 11 \| 12 | The number of the source file | + diff --git a/markdown/bitburner.sourcefilelvl.n.md b/markdown/bitburner.sourcefilelvl.n.md new file mode 100644 index 000000000..c42971a0b --- /dev/null +++ b/markdown/bitburner.sourcefilelvl.n.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [SourceFileLvl](./bitburner.sourcefilelvl.md) > [n](./bitburner.sourcefilelvl.n.md) + +## SourceFileLvl.n property + +The number of the source file + +Signature: + +```typescript +n: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12; +``` diff --git a/markdown/bitburner.stockorder.md b/markdown/bitburner.stockorder.md new file mode 100644 index 000000000..9d2e087d6 --- /dev/null +++ b/markdown/bitburner.stockorder.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrder](./bitburner.stockorder.md) + +## StockOrder type + +Signature: + +```typescript +type StockOrder = { + /** Stock Symbol */ + [key in StockSymbol]?: StockOrderObject[]; +}; +``` +References: [StockSymbol](./bitburner.stocksymbol.md), [StockOrderObject](./bitburner.stockorderobject.md) + diff --git a/markdown/bitburner.stockorderobject.md b/markdown/bitburner.stockorderobject.md new file mode 100644 index 000000000..2ce6dd021 --- /dev/null +++ b/markdown/bitburner.stockorderobject.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) + +## StockOrderObject interface + + +Signature: + +```typescript +interface StockOrderObject +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [position](./bitburner.stockorderobject.position.md) | "S" \| "L" | Order position | +| [price](./bitburner.stockorderobject.price.md) | number | Price per share | +| [shares](./bitburner.stockorderobject.shares.md) | number | Number of shares | +| [type](./bitburner.stockorderobject.type.md) | "Limit Buy Order" \| "Limit Sell Order" \| "Stop Buy Order" \| "Stop Buy Order" | Order type | + diff --git a/markdown/bitburner.stockorderobject.position.md b/markdown/bitburner.stockorderobject.position.md new file mode 100644 index 000000000..0f10d9d39 --- /dev/null +++ b/markdown/bitburner.stockorderobject.position.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) > [position](./bitburner.stockorderobject.position.md) + +## StockOrderObject.position property + +Order position + +Signature: + +```typescript +position: "S" | "L"; +``` diff --git a/markdown/bitburner.stockorderobject.price.md b/markdown/bitburner.stockorderobject.price.md new file mode 100644 index 000000000..8c96a4820 --- /dev/null +++ b/markdown/bitburner.stockorderobject.price.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) > [price](./bitburner.stockorderobject.price.md) + +## StockOrderObject.price property + +Price per share + +Signature: + +```typescript +price: number; +``` diff --git a/markdown/bitburner.stockorderobject.shares.md b/markdown/bitburner.stockorderobject.shares.md new file mode 100644 index 000000000..6553ff33c --- /dev/null +++ b/markdown/bitburner.stockorderobject.shares.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) > [shares](./bitburner.stockorderobject.shares.md) + +## StockOrderObject.shares property + +Number of shares + +Signature: + +```typescript +shares: number; +``` diff --git a/markdown/bitburner.stockorderobject.type.md b/markdown/bitburner.stockorderobject.type.md new file mode 100644 index 000000000..e7acd7490 --- /dev/null +++ b/markdown/bitburner.stockorderobject.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockOrderObject](./bitburner.stockorderobject.md) > [type](./bitburner.stockorderobject.type.md) + +## StockOrderObject.type property + +Order type + +Signature: + +```typescript +type: "Limit Buy Order" | "Limit Sell Order" | "Stop Buy Order" | "Stop Buy Order"; +``` diff --git a/markdown/bitburner.stocksymbol.md b/markdown/bitburner.stocksymbol.md new file mode 100644 index 000000000..a4d48662e --- /dev/null +++ b/markdown/bitburner.stocksymbol.md @@ -0,0 +1,44 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [StockSymbol](./bitburner.stocksymbol.md) + +## StockSymbol type + +Signature: + +```typescript +type StockSymbol = + | "ECP" + | "MGCP" + | "BLD" + | "CLRK" + | "OMTK" + | "FSIG" + | "KGI" + | "FLCM" + | "STM" + | "DCOMM" + | "HLS" + | "VITA" + | "ICRS" + | "UNV" + | "AERO" + | "OMN" + | "SLRS" + | "GPH" + | "NVMD" + | "WDS" + | "LXO" + | "RHOC" + | "APHE" + | "SYSC" + | "CTK" + | "NTLK" + | "OMGA" + | "FNS" + | "SGC" + | "JGN" + | "CTYS" + | "MDYN" + | "TITN"; +``` diff --git a/markdown/bitburner.tix.buy.md b/markdown/bitburner.tix.buy.md new file mode 100644 index 000000000..e94536a22 --- /dev/null +++ b/markdown/bitburner.tix.buy.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [buy](./bitburner.tix.buy.md) + +## TIX.buy() method + +Attempts to purchase shares of a stock using a Market Order. + +If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee. + +If this function successfully purchases the shares, it will return the stock price at which each share was purchased. Otherwise, it will return 0. + +Signature: + +```typescript +buy(sym: StockSymbol, shares: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| shares | number | Number of shares to purchased. Must be positive. Will be rounded to nearest integer. | + +Returns: + +number + +The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.cancelorder.md b/markdown/bitburner.tix.cancelorder.md new file mode 100644 index 000000000..98325a2ee --- /dev/null +++ b/markdown/bitburner.tix.cancelorder.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [cancelOrder](./bitburner.tix.cancelorder.md) + +## TIX.cancelOrder() method + +Cancels an oustanding 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. + +Signature: + +```typescript +cancelOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| shares | number | Number of shares for order. Must be positive. Will be rounded to nearest integer. | +| price | number | Execution price for the order. | +| type | [OrderType](./bitburner.ordertype.md) | Type of order. | +| pos | [OrderPos](./bitburner.orderpos.md) | Specifies whether the order is a “Long” or “Short” position. | + +Returns: + +void + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.getaskprice.md b/markdown/bitburner.tix.getaskprice.md new file mode 100644 index 000000000..edd070542 --- /dev/null +++ b/markdown/bitburner.tix.getaskprice.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getAskPrice](./bitburner.tix.getaskprice.md) + +## TIX.getAskPrice() method + +Given a stock’s symbol (NOT the company name), returns the ask price of that stock. The symbol is a sequence of two to four capital letters. + +Signature: + +```typescript +getAskPrice(sym: StockSymbol): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | + +Returns: + +number + +The ask price of a stock. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.tix.getbidprice.md b/markdown/bitburner.tix.getbidprice.md new file mode 100644 index 000000000..0328a33ce --- /dev/null +++ b/markdown/bitburner.tix.getbidprice.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getBidPrice](./bitburner.tix.getbidprice.md) + +## TIX.getBidPrice() method + +Given a stock’s symbol (NOT the company name), returns the bid price of that stock. The symbol is a sequence of two to four capital letters. + +Signature: + +```typescript +getBidPrice(sym: StockSymbol): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | + +Returns: + +number + +The bid price of a stock. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.tix.getforecast.md b/markdown/bitburner.tix.getforecast.md new file mode 100644 index 000000000..f912d2988 --- /dev/null +++ b/markdown/bitburner.tix.getforecast.md @@ -0,0 +1,36 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getForecast](./bitburner.tix.getforecast.md) + +## TIX.getForecast() method + +Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. + +The probability is returned as a decimal value, NOT a percentage (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60). + +In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a 30% chance of increasing and a 70% chance of decreasing during the next tick. + +In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. + +Signature: + +```typescript +getForecast(sym: StockSymbol): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | + +Returns: + +number + +Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.getmaxshares.md b/markdown/bitburner.tix.getmaxshares.md new file mode 100644 index 000000000..f1bc6c1d6 --- /dev/null +++ b/markdown/bitburner.tix.getmaxshares.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getMaxShares](./bitburner.tix.getmaxshares.md) + +## TIX.getMaxShares() method + +Returns the maximum number of shares that the stock has. This is the maximum amount of the stock that can be purchased in both the Long and Short positions combined. + +Signature: + +```typescript +getMaxShares(sym: StockSymbol): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | + +Returns: + +number + +Maximum number of shares that the stock has. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.tix.getorders.md b/markdown/bitburner.tix.getorders.md new file mode 100644 index 000000000..49d305188 --- /dev/null +++ b/markdown/bitburner.tix.getorders.md @@ -0,0 +1,78 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getOrders](./bitburner.tix.getorders.md) + +## TIX.getOrders() method + +Returns your order book for the stock market. + +This is an object containing information for all the Limit and Stop Orders you have in the stock market. The object has the following structure: + +```js +{ + StockSymbol1: [ // Array of orders for this stock + { + shares: Order quantity + price: Order price + type: Order type + position: Either "L" or "S" for Long or Short position + }, + { + ... + }, + ... + ], + StockSymbol2: [ // Array of orders for this stock + ... + ], + ... +} +``` +The “Order type” property can have one of the following four values: \* “Limit Buy Order” \* “Limit Sell Order” \* “Stop Buy Order” \* “Stop Sell Order” Note that the order book will only contain information for stocks that you actually have orders in. + +Signature: + +```typescript +getOrders(): StockOrder; +``` +Returns: + +[StockOrder](./bitburner.stockorder.md) + +Object containing information for all the Limit and Stop Orders you have in the stock market. + +## Remarks + +2.5 GB + +## Example + + +```js +"If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property." +{ + ECP: [ + { + shares: 5, + price: 100,000 + type: "Stop Buy Order", + position: "S", + }, + { + shares: 25, + price: 125,000 + type: "Limit Sell Order", + position: "L", + }, + ], + SYSC: [ + { + shares: 100, + price: 10,000 + type: "Limit Buy Order", + position: "L", + }, + ], +} +``` + diff --git a/markdown/bitburner.tix.getposition.md b/markdown/bitburner.tix.getposition.md new file mode 100644 index 000000000..2901311eb --- /dev/null +++ b/markdown/bitburner.tix.getposition.md @@ -0,0 +1,47 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getPosition](./bitburner.tix.getposition.md) + +## TIX.getPosition() method + +Returns an array of four elements that represents the player’s position in a stock. + +The first element is the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the player’s shares in the Long position. + +The third element in the array is the number of shares the player owns of the stock in the Short position. The fourth element in the array is the average price of the player’s Short position. + +All elements in the returned array are numeric. + +Signature: + +```typescript +getPosition(sym: StockSymbol): [number, number, number, number]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | + +Returns: + +\[number, number, number, number\] + +Array of four elements that represents the player’s position in a stock. + +## Remarks + +2 GB + +## Example + + +```js +pos = getPosition("ECP"); +shares = pos[0]; +avgPx = pos[1]; +sharesShort = pos[2]; +avgPxShort = pos[3]; +``` + diff --git a/markdown/bitburner.tix.getprice.md b/markdown/bitburner.tix.getprice.md new file mode 100644 index 000000000..5c538f5ce --- /dev/null +++ b/markdown/bitburner.tix.getprice.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getPrice](./bitburner.tix.getprice.md) + +## TIX.getPrice() method + +Returns the price of a stock, given its symbol (NOT the company name). The symbol is a sequence of two to four capital letters. + +The stock’s price is the average of its bid and ask price + +Signature: + +```typescript +getPrice(sym: StockSymbol): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | + +Returns: + +number + +The price of a stock. + +## Remarks + +2 GB + +## Example + + +```js +getPrice("FISG"); +``` + diff --git a/markdown/bitburner.tix.getpurchasecost.md b/markdown/bitburner.tix.getpurchasecost.md new file mode 100644 index 000000000..6b55b2cc7 --- /dev/null +++ b/markdown/bitburner.tix.getpurchasecost.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getPurchaseCost](./bitburner.tix.getpurchasecost.md) + +## TIX.getPurchaseCost() method + +Calculates and returns how much it would cost to buy a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees. + +Signature: + +```typescript +getPurchaseCost(sym: StockSymbol, shares: number, posType: OrderPos): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| shares | number | Number of shares to purchase. | +| posType | [OrderPos](./bitburner.orderpos.md) | Specifies whether the order is a “Long” or “Short” position. | + +Returns: + +number + +Cost to buy a given number of shares of a stock. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.tix.getsalegain.md b/markdown/bitburner.tix.getsalegain.md new file mode 100644 index 000000000..92494e5c9 --- /dev/null +++ b/markdown/bitburner.tix.getsalegain.md @@ -0,0 +1,32 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getSaleGain](./bitburner.tix.getsalegain.md) + +## TIX.getSaleGain() method + +Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees. + +Signature: + +```typescript +getSaleGain(sym: StockSymbol, shares: number, posType: OrderPos): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| shares | number | Number of shares to sell. | +| posType | [OrderPos](./bitburner.orderpos.md) | Specifies whether the order is a “Long” or “Short” position. | + +Returns: + +number + +Gain from selling a given number of shares of a stock. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.tix.getsymbols.md b/markdown/bitburner.tix.getsymbols.md new file mode 100644 index 000000000..725b11683 --- /dev/null +++ b/markdown/bitburner.tix.getsymbols.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getSymbols](./bitburner.tix.getsymbols.md) + +## TIX.getSymbols() method + +Returns an array of the symbols of the tradable stocks + +Signature: + +```typescript +getSymbols(): StockSymbol[]; +``` +Returns: + +[StockSymbol](./bitburner.stocksymbol.md)\[\] + +Array of the symbols of the tradable stocks. + +## Remarks + +2 GB + diff --git a/markdown/bitburner.tix.getvolatility.md b/markdown/bitburner.tix.getvolatility.md new file mode 100644 index 000000000..2a983a390 --- /dev/null +++ b/markdown/bitburner.tix.getvolatility.md @@ -0,0 +1,34 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [getVolatility](./bitburner.tix.getvolatility.md) + +## TIX.getVolatility() method + +Returns the volatility of the specified stock. + +Volatility represents the maximum percentage by which a stock’s price can change every tick. The volatility is returned as a decimal value, NOT a percentage (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3). + +In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. + +Signature: + +```typescript +getVolatility(sym: StockSymbol): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | + +Returns: + +number + +Volatility of the specified stock. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.md b/markdown/bitburner.tix.md new file mode 100644 index 000000000..0eb2273b9 --- /dev/null +++ b/markdown/bitburner.tix.md @@ -0,0 +1,58 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) + +## TIX interface + + +Signature: + +```typescript +interface TIX +``` + +## Methods + +| Method | Description | +| --- | --- | +| [buy(sym, shares)](./bitburner.tix.buy.md) | Attempts to purchase shares of a stock using a Market Order.If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.If this function successfully purchases the shares, it will return the stock price at which each share was purchased. Otherwise, it will return 0. | +| [cancelOrder(sym, shares, price, type, pos)](./bitburner.tix.cancelorder.md) | Cancels an oustanding 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. | +| [getAskPrice(sym)](./bitburner.tix.getaskprice.md) | Given a stock’s symbol (NOT the company name), returns the ask price of that stock. The symbol is a sequence of two to four capital letters. | +| [getBidPrice(sym)](./bitburner.tix.getbidprice.md) | Given a stock’s symbol (NOT the company name), returns the bid price of that stock. The symbol is a sequence of two to four capital letters. | +| [getForecast(sym)](./bitburner.tix.getforecast.md) | Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.The probability is returned as a decimal value, NOT a percentage (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a 30% chance of increasing and a 70% chance of decreasing during the next tick.In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. | +| [getMaxShares(sym)](./bitburner.tix.getmaxshares.md) | Returns the maximum number of shares that the stock has. This is the maximum amount of the stock that can be purchased in both the Long and Short positions combined. | +| [getOrders()](./bitburner.tix.getorders.md) | Returns your order book for the stock market.This is an object containing information for all the Limit and Stop Orders you have in the stock market. The object has the following structure: +```js +{ + StockSymbol1: [ // Array of orders for this stock + { + shares: Order quantity + price: Order price + type: Order type + position: Either "L" or "S" for Long or Short position + }, + { + ... + }, + ... + ], + StockSymbol2: [ // Array of orders for this stock + ... + ], + ... +} +``` +The “Order type” property can have one of the following four values: \* “Limit Buy Order” \* “Limit Sell Order” \* “Stop Buy Order” \* “Stop Sell Order” Note that the order book will only contain information for stocks that you actually have orders in. | +| [getPosition(sym)](./bitburner.tix.getposition.md) | Returns an array of four elements that represents the player’s position in a stock.The first element is the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the player’s shares in the Long position.The third element in the array is the number of shares the player owns of the stock in the Short position. The fourth element in the array is the average price of the player’s Short position.All elements in the returned array are numeric. | +| [getPrice(sym)](./bitburner.tix.getprice.md) | Returns the price of a stock, given its symbol (NOT the company name). The symbol is a sequence of two to four capital letters.The stock’s price is the average of its bid and ask price | +| [getPurchaseCost(sym, shares, posType)](./bitburner.tix.getpurchasecost.md) | Calculates and returns how much it would cost to buy a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees. | +| [getSaleGain(sym, shares, posType)](./bitburner.tix.getsalegain.md) | Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees. | +| [getSymbols()](./bitburner.tix.getsymbols.md) | Returns an array of the symbols of the tradable stocks | +| [getVolatility(sym)](./bitburner.tix.getvolatility.md) | Returns the volatility of the specified stock.Volatility represents the maximum percentage by which a stock’s price can change every tick. The volatility is returned as a decimal value, NOT a percentage (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. | +| [placeOrder(sym, shares, price, type, pos)](./bitburner.tix.placeorder.md) | Places an order on the stock market. This function only works for Limit and Stop Orders.The ability to place limit and stop orders is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.Returns true if the order is successfully placed, and false otherwise. | +| [purchase4SMarketData()](./bitburner.tix.purchase4smarketdata.md) | Purchase 4S Market Data Access.Returns true if you successfully purchased it or if you already have access. Returns false otherwise. | +| [purchase4SMarketDataTixApi()](./bitburner.tix.purchase4smarketdatatixapi.md) | Purchase 4S Market Data TIX API Access.Returns true if you successfully purchased it or if you already have access. Returns false otherwise. | +| [sell(sym, shares)](./bitburner.tix.sell.md) | Attempts to sell shares of a stock using a Market Order.If the specified number of shares in the function exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.The net profit made from selling stocks with this function is reflected in the script’s statistics. This net profit is calculated as:shares \* (sell\_price - average\_price\_of\_purchased\_shares)If the sale is successful, this function will return the stock price at which each share was sold. Otherwise, it will return 0. | +| [sellShort(sym, shares)](./bitburner.tix.sellshort.md) | Attempts to sell a short position of a stock using a Market Order.The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.If the specified number of shares exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.If the sale is successful, this function will return the stock price at which each share was sold. Otherwise it will return 0. | +| [short(sym, shares)](./bitburner.tix.short.md) | Attempts to purchase a short position of a stock using a Market Order.The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game.If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.If the purchase is successful, this function will return the stock price at which each share was purchased. Otherwise, it will return 0. | + diff --git a/markdown/bitburner.tix.placeorder.md b/markdown/bitburner.tix.placeorder.md new file mode 100644 index 000000000..c9798a13c --- /dev/null +++ b/markdown/bitburner.tix.placeorder.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [placeOrder](./bitburner.tix.placeorder.md) + +## TIX.placeOrder() method + +Places an order on the stock market. This function only works for Limit and Stop Orders. + +The ability to place limit and stop orders is \*\*not\*\* immediately available to the player and must be unlocked later on in the game. + +Returns true if the order is successfully placed, and false otherwise. + +Signature: + +```typescript +placeOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| shares | number | Number of shares for order. Must be positive. Will be rounded to nearest integer. | +| price | number | Execution price for the order. | +| type | [OrderType](./bitburner.ordertype.md) | Type of order. | +| pos | [OrderPos](./bitburner.orderpos.md) | Specifies whether the order is a “Long” or “Short” position. | + +Returns: + +boolean + +True if the order is successfully placed, and false otherwise. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.purchase4smarketdata.md b/markdown/bitburner.tix.purchase4smarketdata.md new file mode 100644 index 000000000..7cb196c11 --- /dev/null +++ b/markdown/bitburner.tix.purchase4smarketdata.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [purchase4SMarketData](./bitburner.tix.purchase4smarketdata.md) + +## TIX.purchase4SMarketData() method + +Purchase 4S Market Data Access. + +Returns true if you successfully purchased it or if you already have access. Returns false otherwise. + +Signature: + +```typescript +purchase4SMarketData(): boolean; +``` +Returns: + +boolean + +True if you successfully purchased it or if you already have access, false otherwise. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.purchase4smarketdatatixapi.md b/markdown/bitburner.tix.purchase4smarketdatatixapi.md new file mode 100644 index 000000000..754b6465e --- /dev/null +++ b/markdown/bitburner.tix.purchase4smarketdatatixapi.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [purchase4SMarketDataTixApi](./bitburner.tix.purchase4smarketdatatixapi.md) + +## TIX.purchase4SMarketDataTixApi() method + +Purchase 4S Market Data TIX API Access. + +Returns true if you successfully purchased it or if you already have access. Returns false otherwise. + +Signature: + +```typescript +purchase4SMarketDataTixApi(): boolean; +``` +Returns: + +boolean + +True if you successfully purchased it or if you already have access, false otherwise. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.sell.md b/markdown/bitburner.tix.sell.md new file mode 100644 index 000000000..09017a174 --- /dev/null +++ b/markdown/bitburner.tix.sell.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [sell](./bitburner.tix.sell.md) + +## TIX.sell() method + +Attempts to sell shares of a stock using a Market Order. + +If the specified number of shares in the function exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee. + +The net profit made from selling stocks with this function is reflected in the script’s statistics. This net profit is calculated as: + +shares \* (sell\_price - average\_price\_of\_purchased\_shares) + +If the sale is successful, this function will return the stock price at which each share was sold. Otherwise, it will return 0. + +Signature: + +```typescript +sell(sym: StockSymbol, shares: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. | + +Returns: + +number + +The stock price at which each share was sold, otherwise 0 if the shares weren't sold. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.sellshort.md b/markdown/bitburner.tix.sellshort.md new file mode 100644 index 000000000..fccc46190 --- /dev/null +++ b/markdown/bitburner.tix.sellshort.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [sellShort](./bitburner.tix.sellshort.md) + +## TIX.sellShort() method + +Attempts to sell a short position of a stock using a Market Order. + +The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game. + +If the specified number of shares exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee. + +If the sale is successful, this function will return the stock price at which each share was sold. Otherwise it will return 0. + +Signature: + +```typescript +sellShort(sym: StockSymbol, shares: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| shares | number | Number of shares to sell. Must be positive. Will be rounded to nearest integer. | + +Returns: + +number + +The stock price at which each share was sold, otherwise 0 if the shares weren't sold. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.tix.short.md b/markdown/bitburner.tix.short.md new file mode 100644 index 000000000..7847106cc --- /dev/null +++ b/markdown/bitburner.tix.short.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [TIX](./bitburner.tix.md) > [short](./bitburner.tix.short.md) + +## TIX.short() method + +Attempts to purchase a short position of a stock using a Market Order. + +The ability to short a stock is \*\*not\*\* immediately available to the player and must be unlocked later on in the game. + +If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee. + +If the purchase is successful, this function will return the stock price at which each share was purchased. Otherwise, it will return 0. + +Signature: + +```typescript +short(sym: StockSymbol, shares: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sym | [StockSymbol](./bitburner.stocksymbol.md) | Stock symbol. | +| shares | number | Number of shares to short. Must be positive. Will be rounded to nearest integer. | + +Returns: + +number + +The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. + +## Remarks + +2.5 GB + diff --git a/markdown/bitburner.university.md b/markdown/bitburner.university.md new file mode 100644 index 000000000..f9d3694e8 --- /dev/null +++ b/markdown/bitburner.university.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [University](./bitburner.university.md) + +## University type + +Signature: + +```typescript +type University = "Summit University" | "Rothman University" | "ZB Institute Of Technology"; +``` diff --git a/markdown/bitburner.universitycourse.md b/markdown/bitburner.universitycourse.md new file mode 100644 index 000000000..6a35e52e5 --- /dev/null +++ b/markdown/bitburner.universitycourse.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [bitburner](./bitburner.md) > [UniversityCourse](./bitburner.universitycourse.md) + +## UniversityCourse type + +Signature: + +```typescript +type UniversityCourse = + | "Study Computer Science" + | "Data Strucures" + | "Networks" + | "Algorithms" + | "Management" + | "Leadership"; +``` diff --git a/markdown/index.md b/markdown/index.md new file mode 100644 index 000000000..b6bea5e27 --- /dev/null +++ b/markdown/index.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [bitburner](./bitburner.md) | | + diff --git a/package-lock.json b/package-lock.json index 5ef4af5f3..674a43d0c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -11,6 +11,8 @@ "dependencies": { "@emotion/react": "^11.4.1", "@emotion/styled": "^11.3.0", + "@microsoft/api-documenter": "^7.13.65", + "@microsoft/api-extractor": "^7.18.17", "@monaco-editor/react": "^4.2.2", "@mui/icons-material": "^5.0.3", "@mui/material": "^5.0.3", @@ -3033,6 +3035,155 @@ "react-dom": "^16.8.0 || ^17.0.0" } }, + "node_modules/@microsoft/api-documenter": { + "version": "7.13.65", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.13.65.tgz", + "integrity": "sha512-cajrUQaNTjzRXMzftUhTku5J4BHSqrCiPXv3tCzdWnii9FxZpqvAYZelfW0/Tz9gjM9kYEMp9Msetf41AR1u7A==", + "dependencies": { + "@microsoft/api-extractor-model": "7.13.14", + "@microsoft/tsdoc": "0.13.2", + "@rushstack/node-core-library": "3.43.0", + "@rushstack/ts-command-line": "4.10.3", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "bin": { + "api-documenter": "bin/api-documenter" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "dependencies": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + }, + "bin": { + "js-yaml": "bin/js-yaml.js" + } + }, + "node_modules/@microsoft/api-documenter/node_modules/resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@microsoft/api-extractor": { + "version": "7.18.17", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.18.17.tgz", + "integrity": "sha512-gZuJ//FAyfrOqWssY0cyU2bEo8FOIaIYVs+pU5IDyfImkye6YkT2Qnm5PAFhyYSkfUjV5SjvyuP4+VsDfS3jww==", + "dependencies": { + "@microsoft/api-extractor-model": "7.13.14", + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.43.0", + "@rushstack/rig-package": "0.3.4", + "@rushstack/ts-command-line": "4.10.3", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~4.4.2" + }, + "bin": { + "api-extractor": "bin/api-extractor" + } + }, + "node_modules/@microsoft/api-extractor-model": { + "version": "7.13.14", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.13.14.tgz", + "integrity": "sha512-mKc917+QhOuOZebSnE77i8Tavj/G5ydIFoJqDIY9LpmAfJjsVHgL2pc7vkvW58QTxH2wadIDK1tLzcteOMEt4w==", + "dependencies": { + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.43.0" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@microsoft/api-extractor/node_modules/source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==" + }, + "node_modules/@microsoft/tsdoc-config": { + "version": "0.15.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.15.2.tgz", + "integrity": "sha512-mK19b2wJHSdNf8znXSMYVShAHktVr/ib0Ck2FA3lsVBSEhSI/TfXT7DJQkAYgcztTuwazGcg58ZjYdk0hTCVrA==", + "dependencies": { + "@microsoft/tsdoc": "0.13.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + } + }, + "node_modules/@microsoft/tsdoc-config/node_modules/resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "dependencies": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, "node_modules/@monaco-editor/loader": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/@monaco-editor/loader/-/loader-1.2.0.tgz", @@ -3439,6 +3590,128 @@ "url": "https://opencollective.com/popperjs" } }, + "node_modules/@rushstack/node-core-library": { + "version": "3.43.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.43.0.tgz", + "integrity": "sha512-MFLW+6X83k6o8m8KnWkDhL/8NCJYHbFnnDokPSX1UHC3JwiEvVhHmEnxZv2YEzwnXeFYoKViub2G2t2liHbHLA==", + "dependencies": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==" + }, + "node_modules/@rushstack/node-core-library/node_modules/colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "engines": { + "node": ">=0.1.90" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "dependencies": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + }, + "engines": { + "node": ">=6 <7 || >=8" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "optionalDependencies": { + "graceful-fs": "^4.1.6" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "dependencies": { + "lru-cache": "^6.0.0" + }, + "bin": { + "semver": "bin/semver.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/@rushstack/node-core-library/node_modules/universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==", + "engines": { + "node": ">= 4.0.0" + } + }, + "node_modules/@rushstack/rig-package": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.4.tgz", + "integrity": "sha512-NsCzPxPQ8cu7lnqa/4xBQXuCJwaBrb5vEbOC8Q/bMQK7GDOxeVUN3/f+NCYjgQSl39toAm8jQJ7TJe+RYYX3yQ==", + "dependencies": { + "resolve": "~1.17.0", + "strip-json-comments": "~3.1.1" + } + }, + "node_modules/@rushstack/rig-package/node_modules/resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "dependencies": { + "path-parse": "^1.0.6" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/@rushstack/ts-command-line": { + "version": "4.10.3", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.10.3.tgz", + "integrity": "sha512-DdDfwr8CO6CP/kBZlQrrwKyA6UxOteujaIBrmoHa+J+dyLZC19YA/LK0fAHjr2qHLAJHHXVpZwPH8BpqN84oVg==", + "dependencies": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + } + }, + "node_modules/@rushstack/ts-command-line/node_modules/colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==", + "engines": { + "node": ">=0.1.90" + } + }, "node_modules/@sideway/address": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.2.tgz", @@ -3622,6 +3895,11 @@ "@types/estree": "*" } }, + "node_modules/@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==" + }, "node_modules/@types/aria-query": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-4.2.2.tgz", @@ -3894,18 +4172,6 @@ } } }, - "node_modules/@typescript-eslint/eslint-plugin/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/@typescript-eslint/eslint-plugin/node_modules/semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -3921,12 +4187,6 @@ "node": ">=10" } }, - "node_modules/@typescript-eslint/eslint-plugin/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - }, "node_modules/@typescript-eslint/experimental-utils": { "version": "4.33.0", "resolved": "https://registry.npmjs.org/@typescript-eslint/experimental-utils/-/experimental-utils-4.33.0.tgz", @@ -4035,18 +4295,6 @@ } } }, - "node_modules/@typescript-eslint/typescript-estree/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/@typescript-eslint/typescript-estree/node_modules/semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -4062,12 +4310,6 @@ "node": ">=10" } }, - "node_modules/@typescript-eslint/typescript-estree/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - }, "node_modules/@typescript-eslint/visitor-keys": { "version": "4.33.0", "resolved": "https://registry.npmjs.org/@typescript-eslint/visitor-keys/-/visitor-keys-4.33.0.tgz", @@ -4501,7 +4743,6 @@ "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, "dependencies": { "sprintf-js": "~1.0.2" } @@ -4509,8 +4750,7 @@ "node_modules/argparse/node_modules/sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", - "dev": true + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=" }, "node_modules/aria-query": { "version": "4.2.2", @@ -7427,18 +7667,6 @@ "url": "https://github.com/electron/electron-packager?sponsor=1" } }, - "node_modules/electron-packager/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/electron-packager/node_modules/semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -7454,12 +7682,6 @@ "node": ">=10" } }, - "node_modules/electron-packager/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - }, "node_modules/electron-to-chromium": { "version": "1.3.867", "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.867.tgz", @@ -7989,18 +8211,6 @@ "node": ">= 4" } }, - "node_modules/eslint/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/eslint/node_modules/optionator": { "version": "0.9.1", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", @@ -8057,12 +8267,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/eslint/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - }, "node_modules/esm": { "version": "3.2.25", "resolved": "https://registry.npmjs.org/esm/-/esm-3.2.25.tgz", @@ -9262,18 +9466,6 @@ "node": ">=8" } }, - "node_modules/fork-ts-checker-webpack-plugin/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/fork-ts-checker-webpack-plugin/node_modules/schema-utils": { "version": "2.7.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-2.7.0.tgz", @@ -9319,12 +9511,6 @@ "node": ">=8" } }, - "node_modules/fork-ts-checker-webpack-plugin/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - }, "node_modules/form-data": { "version": "2.3.3", "resolved": "https://registry.npmjs.org/form-data/-/form-data-2.3.3.tgz", @@ -9684,19 +9870,6 @@ "node": ">=10.0" } }, - "node_modules/global-agent/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/global-agent/node_modules/semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -9713,13 +9886,6 @@ "node": ">=10" } }, - "node_modules/global-agent/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true - }, "node_modules/global-dirs": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/global-dirs/-/global-dirs-3.0.0.tgz", @@ -10653,6 +10819,14 @@ "node": ">=4" } }, + "node_modules/import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==", + "engines": { + "node": ">=8" + } + }, "node_modules/import-local": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.0.3.tgz", @@ -13105,18 +13279,6 @@ "node": ">=8" } }, - "node_modules/jest-snapshot/node_modules/lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "dependencies": { - "yallist": "^4.0.0" - }, - "engines": { - "node": ">=10" - } - }, "node_modules/jest-snapshot/node_modules/semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -13144,12 +13306,6 @@ "node": ">=8" } }, - "node_modules/jest-snapshot/node_modules/yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true - }, "node_modules/jest-util": { "version": "27.2.5", "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-27.2.5.tgz", @@ -13462,6 +13618,11 @@ "url": "https://github.com/chalk/supports-color?sponsor=1" } }, + "node_modules/jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=" + }, "node_modules/joi": { "version": "17.4.2", "resolved": "https://registry.npmjs.org/joi/-/joi-17.4.2.tgz", @@ -13970,8 +14131,7 @@ "node_modules/lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "dev": true + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" }, "node_modules/lodash.clonedeep": { "version": "4.5.0", @@ -13988,8 +14148,12 @@ "node_modules/lodash.get": { "version": "4.4.2", "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", - "dev": true + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=" + }, + "node_modules/lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=" }, "node_modules/lodash.merge": { "version": "4.6.2", @@ -14222,6 +14386,17 @@ "node": ">=0.10.0" } }, + "node_modules/lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "dependencies": { + "yallist": "^4.0.0" + }, + "engines": { + "node": ">=10" + } + }, "node_modules/lz-string": { "version": "1.4.4", "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.4.4.tgz", @@ -18236,6 +18411,14 @@ "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=" }, + "node_modules/string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==", + "engines": { + "node": ">=0.6.19" + } + }, "node_modules/string-length": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", @@ -18332,7 +18515,6 @@ "version": "3.1.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true, "engines": { "node": ">=8" }, @@ -18942,6 +19124,11 @@ "node": ">=0.6.0" } }, + "node_modules/timsort": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz", + "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=" + }, "node_modules/tiny-warning": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", @@ -19216,7 +19403,6 @@ "version": "4.4.4", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", - "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" @@ -19600,6 +19786,14 @@ "spdx-expression-parse": "^3.0.0" } }, + "node_modules/validator": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-8.2.0.tgz", + "integrity": "sha512-Yw5wW34fSv5spzTXNkokD6S6/Oq92d8q/t14TqsS3fAiA1RYnxSFSIZ+CY3n6PGGRCq5HhJTSepQvFUS2QUDxA==", + "engines": { + "node": ">= 0.10" + } + }, "node_modules/vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -21525,6 +21719,11 @@ "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==" }, + "node_modules/yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" + }, "node_modules/yaml": { "version": "1.10.2", "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", @@ -21590,6 +21789,28 @@ "funding": { "url": "https://github.com/sponsors/sindresorhus" } + }, + "node_modules/z-schema": { + "version": "3.18.4", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.18.4.tgz", + "integrity": "sha512-DUOKC/IhbkdLKKiV89gw9DUauTV8U/8yJl1sjf6MtDmzevLKOF2duNJ495S3MFVjqZarr+qNGCPbkg4mu4PpLw==", + "dependencies": { + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + }, + "bin": { + "z-schema": "bin/z-schema" + }, + "optionalDependencies": { + "commander": "^2.7.1" + } + }, + "node_modules/z-schema/node_modules/commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "optional": true } }, "dependencies": { @@ -23699,6 +23920,128 @@ "react-is": "^16.8.0 || ^17.0.0" } }, + "@microsoft/api-documenter": { + "version": "7.13.65", + "resolved": "https://registry.npmjs.org/@microsoft/api-documenter/-/api-documenter-7.13.65.tgz", + "integrity": "sha512-cajrUQaNTjzRXMzftUhTku5J4BHSqrCiPXv3tCzdWnii9FxZpqvAYZelfW0/Tz9gjM9kYEMp9Msetf41AR1u7A==", + "requires": { + "@microsoft/api-extractor-model": "7.13.14", + "@microsoft/tsdoc": "0.13.2", + "@rushstack/node-core-library": "3.43.0", + "@rushstack/ts-command-line": "4.10.3", + "colors": "~1.2.1", + "js-yaml": "~3.13.1", + "resolve": "~1.17.0" + }, + "dependencies": { + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==" + }, + "js-yaml": { + "version": "3.13.1", + "resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.13.1.tgz", + "integrity": "sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw==", + "requires": { + "argparse": "^1.0.7", + "esprima": "^4.0.0" + } + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "requires": { + "path-parse": "^1.0.6" + } + } + } + }, + "@microsoft/api-extractor": { + "version": "7.18.17", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor/-/api-extractor-7.18.17.tgz", + "integrity": "sha512-gZuJ//FAyfrOqWssY0cyU2bEo8FOIaIYVs+pU5IDyfImkye6YkT2Qnm5PAFhyYSkfUjV5SjvyuP4+VsDfS3jww==", + "requires": { + "@microsoft/api-extractor-model": "7.13.14", + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.43.0", + "@rushstack/rig-package": "0.3.4", + "@rushstack/ts-command-line": "4.10.3", + "colors": "~1.2.1", + "lodash": "~4.17.15", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "source-map": "~0.6.1", + "typescript": "~4.4.2" + }, + "dependencies": { + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==" + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "requires": { + "path-parse": "^1.0.6" + } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "requires": { + "lru-cache": "^6.0.0" + } + }, + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==" + } + } + }, + "@microsoft/api-extractor-model": { + "version": "7.13.14", + "resolved": "https://registry.npmjs.org/@microsoft/api-extractor-model/-/api-extractor-model-7.13.14.tgz", + "integrity": "sha512-mKc917+QhOuOZebSnE77i8Tavj/G5ydIFoJqDIY9LpmAfJjsVHgL2pc7vkvW58QTxH2wadIDK1tLzcteOMEt4w==", + "requires": { + "@microsoft/tsdoc": "0.13.2", + "@microsoft/tsdoc-config": "~0.15.2", + "@rushstack/node-core-library": "3.43.0" + } + }, + "@microsoft/tsdoc": { + "version": "0.13.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz", + "integrity": "sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg==" + }, + "@microsoft/tsdoc-config": { + "version": "0.15.2", + "resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.15.2.tgz", + "integrity": "sha512-mK19b2wJHSdNf8znXSMYVShAHktVr/ib0Ck2FA3lsVBSEhSI/TfXT7DJQkAYgcztTuwazGcg58ZjYdk0hTCVrA==", + "requires": { + "@microsoft/tsdoc": "0.13.2", + "ajv": "~6.12.6", + "jju": "~1.4.0", + "resolve": "~1.19.0" + }, + "dependencies": { + "resolve": { + "version": "1.19.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", + "integrity": "sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg==", + "requires": { + "is-core-module": "^2.1.0", + "path-parse": "^1.0.6" + } + } + } + }, "@monaco-editor/loader": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/@monaco-editor/loader/-/loader-1.2.0.tgz", @@ -23904,6 +24247,110 @@ "resolved": "https://registry.npmjs.org/@popperjs/core/-/core-2.10.2.tgz", "integrity": "sha512-IXf3XA7+XyN7CP9gGh/XB0UxVMlvARGEgGXLubFICsUMGz6Q+DU+i4gGlpOxTjKvXjkJDJC8YdqdKkDj9qZHEQ==" }, + "@rushstack/node-core-library": { + "version": "3.43.0", + "resolved": "https://registry.npmjs.org/@rushstack/node-core-library/-/node-core-library-3.43.0.tgz", + "integrity": "sha512-MFLW+6X83k6o8m8KnWkDhL/8NCJYHbFnnDokPSX1UHC3JwiEvVhHmEnxZv2YEzwnXeFYoKViub2G2t2liHbHLA==", + "requires": { + "@types/node": "12.20.24", + "colors": "~1.2.1", + "fs-extra": "~7.0.1", + "import-lazy": "~4.0.0", + "jju": "~1.4.0", + "resolve": "~1.17.0", + "semver": "~7.3.0", + "timsort": "~0.3.0", + "z-schema": "~3.18.3" + }, + "dependencies": { + "@types/node": { + "version": "12.20.24", + "resolved": "https://registry.npmjs.org/@types/node/-/node-12.20.24.tgz", + "integrity": "sha512-yxDeaQIAJlMav7fH5AQqPH1u8YIuhYJXYBzxaQ4PifsU0GDO38MSdmEDeRlIxrKbC6NbEaaEHDanWb+y30U8SQ==" + }, + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==" + }, + "fs-extra": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-7.0.1.tgz", + "integrity": "sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw==", + "requires": { + "graceful-fs": "^4.1.2", + "jsonfile": "^4.0.0", + "universalify": "^0.1.0" + } + }, + "jsonfile": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz", + "integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=", + "requires": { + "graceful-fs": "^4.1.6" + } + }, + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "requires": { + "path-parse": "^1.0.6" + } + }, + "semver": { + "version": "7.3.5", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", + "integrity": "sha512-PoeGJYh8HK4BTO/a9Tf6ZG3veo/A7ZVsYrSA6J8ny9nb3B1VrpkuN+z9OE5wfE5p6H4LchYZsegiQgbJD94ZFQ==", + "requires": { + "lru-cache": "^6.0.0" + } + }, + "universalify": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz", + "integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==" + } + } + }, + "@rushstack/rig-package": { + "version": "0.3.4", + "resolved": "https://registry.npmjs.org/@rushstack/rig-package/-/rig-package-0.3.4.tgz", + "integrity": "sha512-NsCzPxPQ8cu7lnqa/4xBQXuCJwaBrb5vEbOC8Q/bMQK7GDOxeVUN3/f+NCYjgQSl39toAm8jQJ7TJe+RYYX3yQ==", + "requires": { + "resolve": "~1.17.0", + "strip-json-comments": "~3.1.1" + }, + "dependencies": { + "resolve": { + "version": "1.17.0", + "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.17.0.tgz", + "integrity": "sha512-ic+7JYiV8Vi2yzQGFWOkiZD5Z9z7O2Zhm9XMaTxdJExKasieFCr+yXZ/WmXsckHiKl12ar0y6XiXDx3m4RHn1w==", + "requires": { + "path-parse": "^1.0.6" + } + } + } + }, + "@rushstack/ts-command-line": { + "version": "4.10.3", + "resolved": "https://registry.npmjs.org/@rushstack/ts-command-line/-/ts-command-line-4.10.3.tgz", + "integrity": "sha512-DdDfwr8CO6CP/kBZlQrrwKyA6UxOteujaIBrmoHa+J+dyLZC19YA/LK0fAHjr2qHLAJHHXVpZwPH8BpqN84oVg==", + "requires": { + "@types/argparse": "1.0.38", + "argparse": "~1.0.9", + "colors": "~1.2.1", + "string-argv": "~0.3.1" + }, + "dependencies": { + "colors": { + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/colors/-/colors-1.2.5.tgz", + "integrity": "sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg==" + } + } + }, "@sideway/address": { "version": "4.1.2", "resolved": "https://registry.npmjs.org/@sideway/address/-/address-4.1.2.tgz", @@ -24049,6 +24496,11 @@ "@types/estree": "*" } }, + "@types/argparse": { + "version": "1.0.38", + "resolved": "https://registry.npmjs.org/@types/argparse/-/argparse-1.0.38.tgz", + "integrity": "sha512-ebDJ9b0e702Yr7pWgB0jzm+CX4Srzz8RcXtLJDJB+BSccqMa36uyH/zUsSYao5+BD1ytv3k3rPYCq4mAE1hsXA==" + }, "@types/aria-query": { "version": "4.2.2", "resolved": "https://registry.npmjs.org/@types/aria-query/-/aria-query-4.2.2.tgz", @@ -24305,15 +24757,6 @@ "tsutils": "^3.21.0" }, "dependencies": { - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - }, "semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -24322,12 +24765,6 @@ "requires": { "lru-cache": "^6.0.0" } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true } } }, @@ -24388,15 +24825,6 @@ "tsutils": "^3.21.0" }, "dependencies": { - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - }, "semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -24405,12 +24833,6 @@ "requires": { "lru-cache": "^6.0.0" } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true } } }, @@ -24761,7 +25183,6 @@ "version": "1.0.10", "resolved": "https://registry.npmjs.org/argparse/-/argparse-1.0.10.tgz", "integrity": "sha512-o5Roy6tNG4SL/FOkCAN6RzjiakZS25RLYFrcMttJqbdd8BWrnA+fGz57iN5Pb06pvBGvl5gQ0B48dJlslXvoTg==", - "dev": true, "requires": { "sprintf-js": "~1.0.2" }, @@ -24769,8 +25190,7 @@ "sprintf-js": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/sprintf-js/-/sprintf-js-1.0.3.tgz", - "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=", - "dev": true + "integrity": "sha1-BOaSb2YolTVPPdAVIDYzuFcpfiw=" } } }, @@ -27183,15 +27603,6 @@ "yargs-parser": "^20.0.0" }, "dependencies": { - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - }, "semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -27200,12 +27611,6 @@ "requires": { "lru-cache": "^6.0.0" } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true } } }, @@ -27565,15 +27970,6 @@ "integrity": "sha512-cyFDKrqc/YdcWFniJhzI42+AzS+gNwmUzOSFcRCQYwySuBBBy/KjuxWLZ/FHEH6Moq1NizMOBWyTcv8O4OZIMg==", "dev": true }, - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - }, "optionator": { "version": "0.9.1", "resolved": "https://registry.npmjs.org/optionator/-/optionator-0.9.1.tgz", @@ -27611,12 +28007,6 @@ "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.20.2.tgz", "integrity": "sha512-Ne+eE4r0/iWnpAxD852z3A+N0Bt5RN//NjJwRd2VFHEmrywxf5vsZlh4R6lixl6B+wz/8d+maTSAkN1FIkI3LQ==", "dev": true - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true } } }, @@ -28594,15 +28984,6 @@ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true }, - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - }, "schema-utils": { "version": "2.7.0", "resolved": "https://registry.npmjs.org/schema-utils/-/schema-utils-2.7.0.tgz", @@ -28631,12 +29012,6 @@ "requires": { "has-flag": "^4.0.0" } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true } } }, @@ -28946,16 +29321,6 @@ "serialize-error": "^7.0.1" }, "dependencies": { - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "optional": true, - "requires": { - "yallist": "^4.0.0" - } - }, "semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -28965,13 +29330,6 @@ "requires": { "lru-cache": "^6.0.0" } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true, - "optional": true } } }, @@ -29724,6 +30082,11 @@ } } }, + "import-lazy": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/import-lazy/-/import-lazy-4.0.0.tgz", + "integrity": "sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw==" + }, "import-local": { "version": "3.0.3", "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.0.3.tgz", @@ -31529,15 +31892,6 @@ "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true }, - "lru-cache": { - "version": "6.0.0", - "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", - "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", - "dev": true, - "requires": { - "yallist": "^4.0.0" - } - }, "semver": { "version": "7.3.5", "resolved": "https://registry.npmjs.org/semver/-/semver-7.3.5.tgz", @@ -31555,12 +31909,6 @@ "requires": { "has-flag": "^4.0.0" } - }, - "yallist": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", - "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==", - "dev": true } } }, @@ -31794,6 +32142,11 @@ } } }, + "jju": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz", + "integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=" + }, "joi": { "version": "17.4.2", "resolved": "https://registry.npmjs.org/joi/-/joi-17.4.2.tgz", @@ -32222,8 +32575,7 @@ "lodash": { "version": "4.17.21", "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.21.tgz", - "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", - "dev": true + "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==" }, "lodash.clonedeep": { "version": "4.5.0", @@ -32240,8 +32592,12 @@ "lodash.get": { "version": "4.4.2", "resolved": "https://registry.npmjs.org/lodash.get/-/lodash.get-4.4.2.tgz", - "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=", - "dev": true + "integrity": "sha1-LRd/ZS+jHpObRDjVNBSZ36OCXpk=" + }, + "lodash.isequal": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.isequal/-/lodash.isequal-4.5.0.tgz", + "integrity": "sha1-QVxEePK8wwEgwizhDtMib30+GOA=" }, "lodash.merge": { "version": "4.6.2", @@ -32414,6 +32770,14 @@ "integrity": "sha512-G2Lj61tXDnVFFOi8VZds+SoQjtQC3dgokKdDG2mTm1tx4m50NUHBOZSBwQQHyy0V12A0JTG4icfZQH+xPyh8VA==", "dev": true }, + "lru-cache": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/lru-cache/-/lru-cache-6.0.0.tgz", + "integrity": "sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==", + "requires": { + "yallist": "^4.0.0" + } + }, "lz-string": { "version": "1.4.4", "resolved": "https://registry.npmjs.org/lz-string/-/lz-string-1.4.4.tgz", @@ -35620,6 +35984,11 @@ "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-0.10.31.tgz", "integrity": "sha1-YuIDvEF2bGwoyfyEMB2rHFMQ+pQ=" }, + "string-argv": { + "version": "0.3.1", + "resolved": "https://registry.npmjs.org/string-argv/-/string-argv-0.3.1.tgz", + "integrity": "sha512-a1uQGz7IyVy9YwhqjZIZu1c8JO8dNIe20xBmSS6qu9kv++k3JGzCVmprbNN5Kn+BgzD5E7YYwg1CcjuJMRNsvg==" + }, "string-length": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/string-length/-/string-length-4.0.2.tgz", @@ -35691,8 +36060,7 @@ "strip-json-comments": { "version": "3.1.1", "resolved": "https://registry.npmjs.org/strip-json-comments/-/strip-json-comments-3.1.1.tgz", - "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==", - "dev": true + "integrity": "sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==" }, "strip-outer": { "version": "1.0.1", @@ -36177,6 +36545,11 @@ "setimmediate": "^1.0.4" } }, + "timsort": { + "version": "0.3.0", + "resolved": "https://registry.npmjs.org/timsort/-/timsort-0.3.0.tgz", + "integrity": "sha1-QFQRqOfmM5/mTbmiNN4R3DHgK9Q=" + }, "tiny-warning": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/tiny-warning/-/tiny-warning-1.0.3.tgz", @@ -36394,8 +36767,7 @@ "typescript": { "version": "4.4.4", "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.4.4.tgz", - "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==", - "dev": true + "integrity": "sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==" }, "uglify-js": { "version": "3.4.10", @@ -36709,6 +37081,11 @@ "spdx-expression-parse": "^3.0.0" } }, + "validator": { + "version": "8.2.0", + "resolved": "https://registry.npmjs.org/validator/-/validator-8.2.0.tgz", + "integrity": "sha512-Yw5wW34fSv5spzTXNkokD6S6/Oq92d8q/t14TqsS3fAiA1RYnxSFSIZ+CY3n6PGGRCq5HhJTSepQvFUS2QUDxA==" + }, "vary": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/vary/-/vary-1.1.2.tgz", @@ -38265,6 +38642,11 @@ "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==" }, + "yallist": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/yallist/-/yallist-4.0.0.tgz", + "integrity": "sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==" + }, "yaml": { "version": "1.10.2", "resolved": "https://registry.npmjs.org/yaml/-/yaml-1.10.2.tgz", @@ -38314,6 +38696,25 @@ "resolved": "https://registry.npmjs.org/yocto-queue/-/yocto-queue-0.1.0.tgz", "integrity": "sha512-rVksvsnNCdJ/ohGc6xgPwyN8eheCxsiLM8mxuE/t/mOVqJewPuO1miLpTHQiRgTKCLexL4MeAFVagts7HmNZ2Q==", "dev": true + }, + "z-schema": { + "version": "3.18.4", + "resolved": "https://registry.npmjs.org/z-schema/-/z-schema-3.18.4.tgz", + "integrity": "sha512-DUOKC/IhbkdLKKiV89gw9DUauTV8U/8yJl1sjf6MtDmzevLKOF2duNJ495S3MFVjqZarr+qNGCPbkg4mu4PpLw==", + "requires": { + "commander": "^2.7.1", + "lodash.get": "^4.0.0", + "lodash.isequal": "^4.0.0", + "validator": "^8.0.0" + }, + "dependencies": { + "commander": { + "version": "2.20.3", + "resolved": "https://registry.npmjs.org/commander/-/commander-2.20.3.tgz", + "integrity": "sha512-GpVkmM8vF2vQUkj2LvZmD35JxeJOLCwJ9cUkugyk2nuhbv3+mJvpLYYt+0+USMxE+oj+ey/lJEnhZw75x/OMcQ==", + "optional": true + } + } } } } diff --git a/package.json b/package.json index 18aff3a2e..b92085710 100644 --- a/package.json +++ b/package.json @@ -12,6 +12,8 @@ "dependencies": { "@emotion/react": "^11.4.1", "@emotion/styled": "^11.3.0", + "@microsoft/api-documenter": "^7.13.65", + "@microsoft/api-extractor": "^7.18.17", "@monaco-editor/react": "^4.2.2", "@mui/icons-material": "^5.0.3", "@mui/material": "^5.0.3", diff --git a/src/ScriptEditor/NetscriptDefinitions.ts b/src/ScriptEditor/NetscriptDefinitions.d.ts similarity index 72% rename from src/ScriptEditor/NetscriptDefinitions.ts rename to src/ScriptEditor/NetscriptDefinitions.d.ts index 3e60291b9..978579aac 100644 --- a/src/ScriptEditor/NetscriptDefinitions.ts +++ b/src/ScriptEditor/NetscriptDefinitions.d.ts @@ -1,5 +1,16 @@ +/** + * @public + */ type Host = string; + +/** + * @public + */ type Script = string; + +/** + * @public + */ type StockSymbol = | "ECP" | "MGCP" @@ -34,9 +45,25 @@ type StockSymbol = | "CTYS" | "MDYN" | "TITN"; + +/** + * @public + */ type OrderType = "limitbuy" | "limitsell" | "stopbuy" | "stopsell"; + +/** + * @public + */ type OrderPos = "long" | "short"; + +/** + * @public + */ type University = "Summit University" | "Rothman University" | "ZB Institute Of Technology"; + +/** + * @public + */ type UniversityCourse = | "Study Computer Science" | "Data Strucures" @@ -44,9 +71,25 @@ type UniversityCourse = | "Algorithms" | "Management" | "Leadership"; + +/** + * @public + */ type Gym = "Crush Fitness Gym" | "Snap Fitness Gym" | "Iron Gym" | "Powerhouse Gym" | "Millenium Fitness Gym"; + +/** + * @public + */ type GymStat = "str" | "def" | "dex" | "agi"; + +/** + * @public + */ type City = "Aevum" | "Chongqing" | "Sector-12" | "New Tokyo" | "Ishima" | "Volhaven"; + +/** + * @public + */ type PurchaseableProgram = | "brutessh.exe" | "ftpcrack.exe" @@ -56,7 +99,15 @@ type PurchaseableProgram = | "deepscanv1.exe" | "deepscanv2.exe" | "autolink.exe"; + +/** + * @public + */ type CreatableProgram = PurchaseableProgram | "serverprofiler.exe"; + +/** + * @public + */ type CompanyName = // Sector-12 | "MegaCorp" @@ -107,6 +158,10 @@ type CompanyName = | "VitaLife" | "GlobalPharmaceuticals" | "NoodleBar"; + +/** + * @public + */ type CompanyField = | "software" | "software consultant" @@ -121,6 +176,10 @@ type CompanyField = | "part-time employee" | "waiter" | "part-time waiter"; + +/** + * @public + */ type FactionName = | "Illuminati" | "Daedalus" @@ -155,6 +214,9 @@ type FactionName = | "CyberSec" | "Bladeburners"; +/** + * @public + */ type GangName = | "Slum Snakes" | "Tetrads" @@ -163,7 +225,15 @@ type GangName = | "Speakers for the Dead" | "NiteSec" | "The Black Hand"; + +/** + * @public + */ type FactionWork = "hacking" | "field" | "security"; + +/** + * @public + */ type Crime = | "shoplift" | "rob store" @@ -177,6 +247,10 @@ type Crime = | "kidnap" | "assassinate" | "heist"; + +/** + * @public + */ type AugmentName = | "Augmented Targeting I" | "Augmented Targeting II" @@ -284,6 +358,9 @@ type AugmentName = | "BLADE-51b Tesla Armor: IPU Upgrade" | "The Blade's Simulacrum"; +/** + * @public + */ interface CrimeStats { /** Number representing the difficulty of the crime. Used for success chance calculations */ difficulty: number; @@ -327,6 +404,9 @@ interface CrimeStats { intelligence_exp: number; } +/** + * @public + */ interface AugmentationStats { /** Multipler to hacking skill */ hacking_mult?: number; @@ -358,7 +438,7 @@ interface AugmentationStats { hacking_speed_mult?: number; /** Multipler to amount of money the player gains from hacking */ hacking_money_mult?: number; - /** Multipler to amount of money injected into servers using {@link grow()} */ + /** Multipler to amount of money injected into servers using grow */ hacking_grow_mult?: number; /** Multipler to amount of reputation gained when working */ company_rep_mult?: number; @@ -389,16 +469,26 @@ interface AugmentationStats { /** Multipler to success chance in Bladeburner contracts/operations */ bladeburner_success_chance_mult?: number; } + +/** + * @public + */ 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. */ threads: number; } +/** + * @public + */ interface CodingAttemptOptions { /** If truthy, then the function will return a string that states the contract’s reward when it is successfully solved. */ returnReward: boolean; } +/** + * @public + */ interface AugmentPair { /** augmentation name */ name: AugmentName; @@ -406,6 +496,9 @@ interface AugmentPair { cost: number; } +/** + * @public + */ interface StockOrderObject { /** Number of shares */ shares: number; @@ -416,11 +509,18 @@ interface StockOrderObject { /** Order position */ position: "S" | "L"; } + +/** + * @public + */ type StockOrder = { /** Stock Symbol */ [key in StockSymbol]?: StockOrderObject[]; }; +/** + * @public + */ interface ProcessInfo { /** Script name. */ filename: Script; @@ -430,6 +530,9 @@ interface ProcessInfo { args: string[]; } +/** + * @public + */ interface HackingMultipliers { /** Player's hacking chance multiplier. */ chance: number; @@ -441,6 +544,9 @@ interface HackingMultipliers { growth: number; } +/** + * @public + */ interface HacknetMultipliers { /** Player's hacknet production multiplier */ production: number; @@ -454,6 +560,9 @@ interface HacknetMultipliers { levelCost: number; } +/** + * @public + */ interface Server { // How many CPU cores this server has. Maximum of 8. // Currently, this only affects hacking missions @@ -497,6 +606,9 @@ interface Server { sshPortOpen: boolean; } +/** + * @public + */ interface BitNodeMultipliers { /** Influences how quickly the player's agility level (not exp) scales */ AgilityLevelMultiplier: number; @@ -585,10 +697,18 @@ interface BitNodeMultipliers { * IMPORTANT: The data inside ports are not saved! * This means if you close and re-open the game, or reload the page * then you will lose all of the data in the ports! + * @public */ type Port = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20; + +/** + * @public + */ type Handle = string | Port; +/** + * @public + */ interface NodeStats { /** Node's name ("hacknet-node-5") */ name: string; @@ -610,6 +730,9 @@ interface NodeStats { totalProduction: number; } +/** + * @public + */ type HashUpgrades = | "Sell for Money" | "Sell for Corporation Funds" @@ -622,6 +745,9 @@ type HashUpgrades = | "Exchange for Bladeburner SP" | "Generate Coding Contract"; +/** + * @public + */ interface PlayerStats { /** Hacking level */ hacking: number; @@ -639,6 +765,9 @@ interface PlayerStats { intelligence: number; } +/** + * @public + */ interface CharacterMult { /** Agility stat */ agility: number; @@ -671,6 +800,10 @@ interface CharacterMult { /** Money earned from jobs */ workMoney: number; } + +/** + * @public + */ interface CharacterInfo { /** Current BitNode number */ bitnode: number; @@ -710,6 +843,9 @@ interface CharacterInfo { workMoneyGain: number; } +/** + * @public + */ interface SleeveWorkGains { /** hacking exp gained from work */ workHackExpGain: number; @@ -727,6 +863,9 @@ interface SleeveWorkGains { workMoneyGain: number; } +/** + * @public + */ interface SourceFileLvl { /** The number of the source file */ n: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12; @@ -734,8 +873,14 @@ interface SourceFileLvl { lvl: number; } +/** + * @public + */ type BladeburnerContracts = "Tracking" | "Bounty Hunter" | "Retirement"; +/** + * @public + */ type BladeburnerOperations = | "Investigation" | "Undercover Operation" @@ -744,6 +889,9 @@ type BladeburnerOperations = | "Stealth Retirement Operation" | "Assassination"; +/** + * @public + */ type BladeburnerBlackOps = | "Operation Typhoon" | "Operation Zero" @@ -767,6 +915,9 @@ type BladeburnerBlackOps = | "Operation Vindictus" | "Operation Daedalus"; +/** + * @public + */ type BladeburnerGenActions = | "Training" | "Field Analysis" @@ -774,6 +925,9 @@ type BladeburnerGenActions = | "Diplomacy" | "Hyperbolic Regeneration Chamber"; +/** + * @public + */ type BladeburnerSkills = | "Blade's Intuition" | "Cloak" @@ -790,8 +944,14 @@ type BladeburnerSkills = | "Hands of Midas" | "Hyperdrive"; +/** + * @public + */ type BladeburnerActTypes = "contracts" | "operations" | "black ops" | "general"; +/** + * @public + */ interface BladeburnerCurAction { /** Type of Action */ type: BladeburnerActTypes | "Idle"; @@ -799,6 +959,9 @@ interface BladeburnerCurAction { name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps; } +/** + * @public + */ type CodingContractTypes = | "Find Largest Prime Factor" | "Subarray with Maximum Sum" @@ -817,6 +980,9 @@ type CodingContractTypes = | "Sanitize Parentheses in Expression" | "Find All Valid Math Expressions"; +/** + * @public + */ interface GangGenInfo { /** Name of faction that the gang belongs to ("Slum Snakes", etc.) */ faction: GangName; @@ -840,17 +1006,27 @@ interface GangGenInfo { wantedLevelGainRate: number; } +/** + * @public + */ interface GangOtherInfoObject { /** Gang power */ power: number; /** Gang territory, in decimal form */ territory: number; } + +/** + * @public + */ type GangOtherInfo = { /** Stock Symbol */ [key in GangName]: GangOtherInfoObject[]; }; +/** + * @public + */ type GangEquipment = | "Baseball Bat" | "Katana" @@ -874,8 +1050,14 @@ type GangEquipment = | "Hmap Node" | "Jack the Ripper"; +/** + * @public + */ type GangEquipmentType = "Weapon" | "Armor" | "Vehicle" | "Rootkit" | "Augmentation"; +/** + * @public + */ type GangAugmentations = | "Bionic Arms" | "Bionic Legs" @@ -889,6 +1071,9 @@ type GangAugmentations = | "DataJack" | "Graphene Bone Lacings"; +/** + * @public + */ type GangTasks = | "Unassigned" | "Ransomware" @@ -915,6 +1100,9 @@ type GangTasks = | "Train Charisma" | "Territory Warfare"; +/** + * @public + */ interface GangTasksStats { /** Task name */ name: GangTasks; @@ -948,6 +1136,9 @@ interface GangTasksStats { territory: GangTasksTerritory; } +/** + * @public + */ interface GangEquipmentStats { /** Strength multiplier */ str: number; @@ -963,6 +1154,9 @@ interface GangEquipmentStats { hack: number; } +/** + * @public + */ interface GangTasksTerritory { /** Money gain impact on task scaling */ money: number; @@ -972,6 +1166,9 @@ interface GangTasksTerritory { wanted: number; } +/** + * @public + */ interface GangMemberInfo { /** Agility stat */ agility: number; @@ -1017,6 +1214,9 @@ interface GangMemberInfo { task: GangTasks; } +/** + * @public + */ interface GangMemberAscension { /** Amount of respect lost from ascending */ respect: number; @@ -1034,6 +1234,9 @@ interface GangMemberAscension { cha: number; } +/** + * @public + */ interface SleeveStats { /** current shock of the sleeve [0-100] */ shock: @@ -1255,6 +1458,9 @@ interface SleeveStats { charisma: number; } +/** + * @public + */ interface SleeveInformation { /** location of the sleeve */ city: City; @@ -1282,6 +1488,9 @@ interface SleeveInformation { workRepGain: number; } +/** + * @public + */ interface SleeveTask { /** task type */ task: string; @@ -1295,12 +1504,15 @@ interface SleeveTask { factionWorkType: FactionWork | ""; } +/** + * @public + */ interface TIX { /** * Returns an array of the symbols of the tradable stocks * - * @ramCost 2 GB - * @returns {string[]} Array of the symbols of the tradable stocks. + * @remarks 2 GB + * @returns Array of the symbols of the tradable stocks. */ getSymbols(): StockSymbol[]; @@ -1311,12 +1523,12 @@ interface TIX { * The stock’s price is the average of its bid and ask price * * @example - * \`\`\`js + * ```js * getPrice("FISG"); - * \`\`\` - * @ramCost 2 GB - * @param {string} sym Stock symbol. - * @returns {number} The price of a stock. + * ``` + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns The price of a stock. */ getPrice(sym: StockSymbol): number; @@ -1324,9 +1536,9 @@ interface TIX { * Given a stock’s symbol (NOT the company name), returns the ask price of that stock. * The symbol is a sequence of two to four capital letters. * - * @ramCost 2 GB - * @param {string} sym Stock symbol. - * @returns {number} The ask price of a stock. + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns The ask price of a stock. */ getAskPrice(sym: StockSymbol): number; @@ -1334,9 +1546,9 @@ interface TIX { * Given a stock’s symbol (NOT the company name), returns the bid price of that stock. * The symbol is a sequence of two to four capital letters. * - * @ramCost 2 GB - * @param {string} sym Stock symbol. - * @returns {number} The bid price of a stock. + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns The bid price of a stock. */ getBidPrice(sym: StockSymbol): number; @@ -1354,16 +1566,16 @@ interface TIX { * All elements in the returned array are numeric. * * @example - * \`\`\`js + * ```js * pos = getPosition("ECP"); * shares = pos[0]; * avgPx = pos[1]; * sharesShort = pos[2]; * avgPxShort = pos[3]; - * \`\`\` - * @ramCost 2 GB - * @param {string} sym Stock symbol. - * @returns {[number,number,number,number]} Array of four elements that represents the player’s position in a stock. + * ``` + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns Array of four elements that represents the player’s position in a stock. */ getPosition(sym: StockSymbol): [number, number, number, number]; @@ -1372,9 +1584,9 @@ interface TIX { * This is the maximum amount of the stock that can be purchased * in both the Long and Short positions combined. * - * @ramCost 2 GB - * @param {string} sym Stock symbol. - * @returns {number} Maximum number of shares that the stock has. + * @remarks 2 GB + * @param sym - Stock symbol. + * @returns Maximum number of shares that the stock has. */ getMaxShares(sym: StockSymbol): number; @@ -1382,11 +1594,11 @@ interface TIX { * Calculates and returns how much it would cost to buy a given number of shares of a stock. * This takes into account spread, large transactions influencing the price of the stock and commission fees. * - * @ramCost 2 GB - * @param {string} sym Stock symbol. - * @param {number} shares Number of shares to purchase. - * @param {string} posType Specifies whether the order is a “Long” or “Short” position. - * @returns {number} Cost to buy a given number of shares of a stock. + * @remarks 2 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to purchase. + * @param posType - Specifies whether the order is a “Long” or “Short” position. + * @returns Cost to buy a given number of shares of a stock. */ getPurchaseCost(sym: StockSymbol, shares: number, posType: OrderPos): number; @@ -1394,11 +1606,11 @@ interface TIX { * Calculates and returns how much you would gain from selling a given number of shares of a stock. * This takes into account spread, large transactions influencing the price of the stock and commission fees. * - * @ramCost 2 GB - * @param {string} sym Stock symbol. - * @param {number} shares Number of shares to sell. - * @param {string} posType Specifies whether the order is a “Long” or “Short” position. - * @returns {number} Gain from selling a given number of shares of a stock. + * @remarks 2 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to sell. + * @param posType - Specifies whether the order is a “Long” or “Short” position. + * @returns Gain from selling a given number of shares of a stock. */ getSaleGain(sym: StockSymbol, shares: number, posType: OrderPos): number; @@ -1412,10 +1624,10 @@ interface TIX { * If this function successfully purchases the shares, it will return the stock price at which * each share was purchased. Otherwise, it will return 0. * - * @ramCost 2.5 GB - * @param {string} sym Stock symbol. - * @param {number} shares Number of shares to purchased. Must be positive. Will be rounded to nearest integer. - * @returns {number} The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to purchased. Must be positive. Will be rounded to nearest integer. + * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. */ buy(sym: StockSymbol, shares: number): number; @@ -1434,10 +1646,10 @@ interface TIX { * If the sale is successful, this function will return the stock price at * which each share was sold. Otherwise, it will return 0. * - * @ramCost 2.5 GB - * @param {string} sym Stock symbol. - * @param {number} shares Number of shares to sell. Must be positive. Will be rounded to nearest integer. - * @returns {number} The stock price at which each share was sold, otherwise 0 if the shares weren't sold. + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer. + * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold. */ sell(sym: StockSymbol, shares: number): number; @@ -1454,10 +1666,10 @@ interface TIX { * If the purchase is successful, this function will return the stock price at which each * share was purchased. Otherwise, it will return 0. * - * @ramCost 2.5 GB - * @param {string} sym Stock symbol. - * @param {number} shares Number of shares to short. Must be positive. Will be rounded to nearest integer. - * @returns {number} The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to short. Must be positive. Will be rounded to nearest integer. + * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased. */ short(sym: StockSymbol, shares: number): number; @@ -1474,10 +1686,10 @@ interface TIX { * If the sale is successful, this function will return the stock price at which each * share was sold. Otherwise it will return 0. * - * @ramCost 2.5 GB - * @param {string} sym Stock symbol. - * @param {number} shares Number of shares to sell. Must be positive. Will be rounded to nearest integer. - * @returns {number} The stock price at which each share was sold, otherwise 0 if the shares weren't sold. + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer. + * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold. */ sellShort(sym: StockSymbol, shares: number): number; @@ -1489,13 +1701,13 @@ interface TIX { * * Returns true if the order is successfully placed, and false otherwise. * - * @ramCost 2.5 GB - * @param {string} sym Stock symbol. - * @param {number} shares Number of shares for order. Must be positive. Will be rounded to nearest integer. - * @param {number} price Execution price for the order. - * @param {string} type Type of order. - * @param {string} pos Specifies whether the order is a “Long” or “Short” position. - * @returns {boolean} True if the order is successfully placed, and false otherwise. + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer. + * @param price - Execution price for the order. + * @param type - Type of order. + * @param pos - Specifies whether the order is a “Long” or “Short” position. + * @returns True if the order is successfully placed, and false otherwise. */ placeOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): boolean; @@ -1505,12 +1717,12 @@ interface TIX { * The ability to use limit and stop orders is **not** immediately available to the player and * must be unlocked later on in the game. * - * @ramCost 2.5 GB - * @param {string} sym Stock symbol. - * @param {number} shares Number of shares for order. Must be positive. Will be rounded to nearest integer. - * @param {number} price Execution price for the order. - * @param {string} type Type of order. - * @param {string} pos Specifies whether the order is a “Long” or “Short” position. + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer. + * @param price - Execution price for the order. + * @param type - Type of order. + * @param pos - Specifies whether the order is a “Long” or “Short” position. */ cancelOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): void; @@ -1520,7 +1732,7 @@ interface TIX { * This is an object containing information for all the Limit and Stop Orders you have in the stock market. * The object has the following structure: * - * \`\`\`js + * ```js * { * StockSymbol1: [ // Array of orders for this stock * { @@ -1539,7 +1751,7 @@ interface TIX { * ], * ... * } - * \`\`\` + * ``` * The “Order type” property can have one of the following four values: * * “Limit Buy Order” * * “Limit Sell Order” @@ -1548,7 +1760,7 @@ interface TIX { * Note that the order book will only contain information for stocks that you actually have orders in. * * @example - * \`\`\`js + * ```js * "If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property." * { * ECP: [ @@ -1574,9 +1786,9 @@ interface TIX { * }, * ], * } - * \`\`\` - * @ramCost 2.5 GB - * @returns {object} Object containing information for all the Limit and Stop Orders you have in the stock market. + * ``` + * @remarks 2.5 GB + * @returns Object containing information for all the Limit and Stop Orders you have in the stock market. */ getOrders(): StockOrder; @@ -1589,9 +1801,9 @@ interface TIX { * * In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. * - * @ramCost 2.5 GB - * @param {string} sym Stock symbol. - * @returns {number} Volatility of the specified stock. + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @returns Volatility of the specified stock. */ getVolatility(sym: StockSymbol): number; @@ -1606,9 +1818,9 @@ interface TIX { * * In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API. * - * @ramCost 2.5 GB - * @param {string} sym Stock symbol. - * @returns {number} Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. + * @remarks 2.5 GB + * @param sym - Stock symbol. + * @returns Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick. */ getForecast(sym: StockSymbol): number; @@ -1617,8 +1829,8 @@ interface TIX { * * Returns true if you successfully purchased it or if you already have access. Returns false otherwise. * - * @ramCost 2.5 GB - * @returns {boolean} True if you successfully purchased it or if you already have access, false otherwise. + * @remarks 2.5 GB + * @returns True if you successfully purchased it or if you already have access, false otherwise. */ purchase4SMarketData(): boolean; @@ -1627,12 +1839,15 @@ interface TIX { * * Returns true if you successfully purchased it or if you already have access. Returns false otherwise. * - * @ramCost 2.5 GB - * @returns {boolean} True if you successfully purchased it or if you already have access, false otherwise. + * @remarks 2.5 GB + * @returns True if you successfully purchased it or if you already have access, false otherwise. */ purchase4SMarketDataTixApi(): boolean; } +/** + * @public + */ interface Singularity { /** * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled. @@ -1645,11 +1860,11 @@ interface Singularity { * The cost and experience gains for all of these universities and classes are the same as * if you were to manually visit and take these classes. * - * @ramCost 2 GB - * @singularity Level 1 - * @param {string} universityName Name of university. You must be in the correct city for whatever university you specify. - * @param {string} courseName Name of course. - * @returns {boolean} True if actions is successfully started, false otherwise. + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @param universityName - Name of university. You must be in the correct city for whatever university you specify. + * @param courseName - Name of course. + * @returns True if actions is successfully started, false otherwise. */ universityCourse(universityName: University, courseName: UniversityCourse): boolean; @@ -1664,11 +1879,11 @@ interface Singularity { * The cost and experience gains for all of these gyms are the same as if you were * to manually visit these gyms and train * - * @ramCost 2 GB - * @singularity Level 1 - * @param {string} gymName Name of gym. You must be in the correct city for whatever gym you specify. - * @param {string} stat The stat you want to train. - * @returns {boolean} True if actions is successfully started, false otherwise. + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify. + * @param stat - The stat you want to train. + * @returns True if actions is successfully started, false otherwise. */ gymWorkout(gymName: Gym, stat: GymStat): boolean; @@ -1678,10 +1893,10 @@ interface Singularity { * This function allows the player to travel to any city. The cost for using this * function is the same as the cost for traveling through the Travel Agency. * - * @ramCost 2 GB - * @singularity Level 1 - * @param {string} city City to travel to. - * @returns {boolean} True if actions is successful, false otherwise. + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @param city - City to travel to. + * @returns True if actions is successful, false otherwise. */ travelToCity(city: City): boolean; @@ -1692,9 +1907,9 @@ interface Singularity { * purchasing a TOR router using this function is the same as if you were to * manually purchase one. * - * @ramCost 2 GB - * @singularity Level 1 - * @returns {boolean} True if actions is successful, false otherwise. + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @returns True if actions is successful, false otherwise. */ purchaseTor(): boolean; @@ -1707,13 +1922,13 @@ interface Singularity { * Web using the Terminal buy command. * * @example - * \`\`\`js + * ```js * purchaseProgram("brutessh.exe"); - * \`\`\` - * @ramCost 2 GB - * @singularity Level 1 - * @param {string} programName Name of program to purchase. - * @returns {boolean} True if the specified program is purchased, and false otherwise. + * ``` + * @remarks 2 GB + * @remarks Singularity - Level 1 + * @param programName - Name of program to purchase. + * @returns True if the specified program is purchased, and false otherwise. */ purchaseProgram(programName: PurchaseableProgram): boolean; @@ -1723,13 +1938,13 @@ interface Singularity { * Returns an object with the Player’s stats. * * @example - * \`\`\`js + * ```js * res = getStats(); * print('My charisma level is: ' + res.charisma); - * \`\`\` - * @ramCost 0.5 GB - * @singularity Level 1 - * @returns {object} Object with the Player’s stats. + * ``` + * @remarks 0.5 GB + * @remarks Singularity - Level 1 + * @returns Object with the Player’s stats. */ getStats(): PlayerStats; @@ -1738,9 +1953,9 @@ interface Singularity { * * Returns an object with various information about your character. * - * @ramCost 0.5 GB - * @singularity Level 1 - * @returns {object} Object with various information about your character. + * @remarks 0.5 GB + * @remarks Singularity - Level 1 + * @returns Object with various information about your character. */ getCharacterInformation(): CharacterInfo; @@ -1751,9 +1966,9 @@ interface Singularity { * ‘action’. These actions include working for a company/faction, studying at a univeristy, * working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission. * - * @ramCost 0.5 GB - * @singularity Level 1 - * @returns {boolean} True if the player is currently performing an ‘action’, false otherwise. + * @remarks 0.5 GB + * @remarks Singularity - Level 1 + * @returns True if the player is currently performing an ‘action’, false otherwise. */ isBusy(): boolean; @@ -1773,9 +1988,9 @@ interface Singularity { * This function will return true if the player’s action was ended. * It will return false if the player was not performing an action when this function was called. * - * @ramCost 1 GB - * @singularity Level 1 - * @returns {boolean} True if the player’s action was ended, false if the player was not performing an action. + * @remarks 1 GB + * @remarks Singularity - Level 1 + * @returns True if the player’s action was ended, false if the player was not performing an action. */ stopAction(): boolean; @@ -1787,9 +2002,9 @@ interface Singularity { * * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise. * - * @ramCost 3 GB - * @singularity Level 2 - * @returns {boolean} True if the player’s home computer RAM is successfully upgraded, and false otherwise. + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise. */ upgradeHomeRam(): boolean; @@ -1798,9 +2013,9 @@ interface Singularity { * * Returns the cost of upgrading the player’s home computer RAM. * - * @ramCost 1.5 GB - * @singularity Level 2 - * @returns {number} Cost of upgrading the player’s home computer RAM. + * @remarks 1.5 GB + * @remarks Singularity - Level 2 + * @returns Cost of upgrading the player’s home computer RAM. */ getUpgradeHomeRamCost(): number; @@ -1818,18 +2033,18 @@ interface Singularity { * Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action. * * @example - * \`\`\`js + * ```js * //If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings: * while (getCompanyRep(COMPANY HERE) < VALUE) { * workForCompany(); * sleep(60000); * } * //This way, your company reputation will be updated every minute. - * \`\`\` - * @ramCost 3 GB - * @singularity Level 2 - * @param {string} [companyName] Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked - * @returns {boolean} True if the player starts working, and false otherwise. + * ``` + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked + * @returns True if the player starts working, and false otherwise. */ workForCompany(companyName?: CompanyName): boolean; @@ -1845,11 +2060,11 @@ interface Singularity { * and false otherwise. Note that if you are trying to use this function to * apply for a promotion and you don’t get one, it will return false. * - * @ramCost 3 GB - * @singularity Level 2 - * @param {string} companyName Name of company to apply to. - * @param {string} field Field to which you want to apply. - * @returns {boolean} True if the player successfully get a job/promotion, and false otherwise. + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of company to apply to. + * @param field - Field to which you want to apply. + * @returns True if the player successfully get a job/promotion, and false otherwise. */ applyToCompany(companyName: CompanyName, field: CompanyField): boolean; @@ -1859,10 +2074,10 @@ interface Singularity { * This function will return the amount of reputation you have at the specified company. * If the company passed in as an argument is invalid, -1 will be returned. * - * @ramCost 1 GB - * @singularity Level 2 - * @param {string} companyName Name of the company. - * @returns {number} Amount of reputation you have at the specified company. + * @remarks 1 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of the company. + * @returns Amount of reputation you have at the specified company. */ getCompanyRep(companyName: CompanyName): number; @@ -1872,10 +2087,10 @@ interface Singularity { * This function will return the amount of favor you have at the specified company. * If the company passed in as an argument is invalid, -1 will be returned. * - * @ramCost 1 GB - * @singularity Level 2 - * @param {string} companyName Name of the company. - * @returns {number} Amount of favor you have at the specified company. + * @remarks 1 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of the company. + * @returns Amount of favor you have at the specified company. */ getCompanyFavor(companyName: CompanyName): number; @@ -1885,10 +2100,10 @@ interface Singularity { * This function will return the amount of favor you will gain for the specified * company when you reset by installing Augmentations. * - * @ramCost 0.75 GB - * @singularity Level 2 - * @param {string} companyName Name of the company. - * @returns {number} Amount of favor you gain at the specified company when you reset by installing Augmentations. + * @remarks 0.75 GB + * @remarks Singularity - Level 2 + * @param companyName - Name of the company. + * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations. */ getCompanyFavorGain(companyName: CompanyName): number; @@ -1897,9 +2112,9 @@ interface Singularity { * * Returns an array with the name of all Factions you currently have oustanding invitations from. * - * @ramCost 3 GB - * @singularity Level 2 - * @returns {string[]} Array with the name of all Factions you currently have oustanding invitations from. + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @returns Array with the name of all Factions you currently have oustanding invitations from. */ checkFactionInvitations(): FactionName[]; @@ -1908,10 +2123,10 @@ interface Singularity { * * This function will automatically accept an invitation from a faction and join it. * - * @ramCost 3 GB - * @singularity Level 2 - * @param {string} faction Name of faction to join. - * @returns {boolean} True if player joined the faction, and false otherwise. + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction to join. + * @returns True if player joined the faction, and false otherwise. */ joinFaction(faction: FactionName): boolean; @@ -1929,19 +2144,19 @@ interface Singularity { * Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action. * * @example - * \`\`\`js + * ```js * //If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings: * while (getFactionRep(FACTION NAME) < VALUE) { * workForFaction(FACNAME, WORKTYPE); * sleep(60000); * } * //This way, your faction reputation will be updated every minute. - * \`\`\` - * @ramCost 3 GB - * @singularity Level 2 - * @param {string} faction Name of faction to work for. - * @param {string} workType Type of work to perform for the faction. - * @returns {boolean} True if the player starts working, and false otherwise. + * ``` + * @remarks 3 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction to work for. + * @param workType - Type of work to perform for the faction. + * @returns True if the player starts working, and false otherwise. */ workForFaction(faction: FactionName, workType: FactionWork): boolean; @@ -1950,10 +2165,10 @@ interface Singularity { * * This function returns the amount of reputation you have for the specified faction. * - * @ramCost 1 GB - * @singularity Level 2 - * @param {string} faction Name of faction to work for. - * @returns {number} Amount of reputation you have for the specified faction. + * @remarks 1 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction to work for. + * @returns Amount of reputation you have for the specified faction. */ getFactionRep(faction: FactionName): number; @@ -1962,10 +2177,10 @@ interface Singularity { * * This function returns the amount of favor you have for the specified faction. * - * @ramCost 1 GB - * @singularity Level 2 - * @param {string} faction Name of faction. - * @returns {number} Amount of favor you have for the specified faction. + * @remarks 1 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction. + * @returns Amount of favor you have for the specified faction. */ getFactionFavor(faction: FactionName): number; @@ -1975,10 +2190,10 @@ interface Singularity { * This function returns the amount of favor you will gain for the specified * faction when you reset by installing Augmentations. * - * @ramCost 0.75 GB - * @singularity Level 2 - * @param {string} faction Name of faction. - * @returns {number} Amount of favor you will gain for the specified faction when you reset by installing Augmentations. + * @remarks 0.75 GB + * @remarks Singularity - Level 2 + * @param faction - Name of faction. + * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations. */ getFactionFavorGain(faction: FactionName): number; @@ -1988,11 +2203,11 @@ interface Singularity { * Attempts to donate money to the specified faction in exchange for reputation. * Returns true if you successfully donate the money, and false otherwise. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} faction Name of faction to donate to. - * @param {string} amount Amount of money to donate. - * @returns {boolean} True if the money was donated, and false otherwise. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param faction - Name of faction to donate to. + * @param amount - Amount of money to donate. + * @returns True if the money was donated, and false otherwise. */ donateToFaction(faction: FactionName, amount: number): boolean; @@ -2019,13 +2234,13 @@ interface Singularity { * * AutoLink.exe: 25 * * @example - * \`\`\`js + * ```js * createProgram(“relaysmtp.exe”); - * \`\`\` - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} program Name of program to create. - * @returns {boolean} True if you successfully start working on the specified program, and false otherwise. + * ``` + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param program - Name of program to create. + * @returns True if you successfully start working on the specified program, and false otherwise. */ createProgram(program: CreatableProgram): boolean; @@ -2043,15 +2258,15 @@ interface Singularity { * \`commitCrime('rob store')\` will return 60). * * Warning: I do not recommend using the time returned from this function to try - * and schedule your crime attempts. Instead, I would use the {@link isBusy} Singularity + * and schedule your crime attempts. Instead, I would use the isBusy Singularity * function to check whether you have finished attempting a crime. This is because * although the game sets a certain crime to be X amount of seconds, there is no * guarantee that your browser will follow that time limit. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} crime Name of crime to attempt. - * @returns {number} True if you successfully start working on the specified program, and false otherwise. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param crime - Name of crime to attempt. + * @returns True if you successfully start working on the specified program, and false otherwise. */ commitCrime(crime: Crime): number; @@ -2061,10 +2276,10 @@ interface Singularity { * This function returns your chance of success at commiting the specified crime. * The chance is returned as a decimal (i.e. 60% would be returned as 0.6). * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} crime Name of crime. - * @returns {number} Chance of success at commiting the specified crime as a decimal. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param crime - Name of crime. + * @returns Chance of success at commiting the specified crime as a decimal. */ getCrimeChance(crime: Crime): number; @@ -2073,10 +2288,10 @@ interface Singularity { * * Returns the stats of the crime. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} crime Name of crime. Not case-sensitive - * @returns {number} The stats of the crime. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param crime - Name of crime. Not case-sensitive + * @returns The stats of the crime. */ getCrimeStats(crime: Crime): CrimeStats; @@ -2085,10 +2300,10 @@ interface Singularity { * * This function returns an array containing the names (as strings) of all Augmentations you have. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {boolean} [purchased] Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations. - * @returns {string[]} Array containing the names (as strings) of all Augmentations you have. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations. + * @returns Array containing the names (as strings) of all Augmentations you have. */ getOwnedAugmentations(purchased?: boolean): AugmentName[]; @@ -2097,9 +2312,9 @@ interface Singularity { * * Returns an array of source files * - * @ramCost 5 GB - * @singularity Level 3 - * @returns {object[]} Array containing an object with number and level of the source file. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @returns Array containing an object with number and level of the source file. */ getOwnedSourceFiles(): SourceFileLvl[]; @@ -2109,10 +2324,10 @@ interface Singularity { * Returns an array containing the names (as strings) of all Augmentations * that are available from the specified faction. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} faction Name of faction. - * @returns {string[]} Array containing the names of all Augmentations. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param faction - Name of faction. + * @returns Array containing the names of all Augmentations. */ getAugmentationsFromFaction(faction: FactionName): AugmentName[]; @@ -2122,10 +2337,10 @@ interface Singularity { * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. * If there are no prerequisites, a blank array is returned. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} augName Name of Augmentation. - * @returns {string[]} Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param augName - Name of Augmentation. + * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation. */ getAugmentationPrereq(augName: AugmentName): AugmentName[]; @@ -2140,10 +2355,10 @@ interface Singularity { * If an invalid Augmentation name is passed in for the augName argument, this * function will return the array [-1, -1]. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} augName Name of Augmentation. - * @returns {[number, number]} Array with first element as a reputation requirement and second element as the money cost. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param augName - Name of Augmentation. + * @returns Array with first element as a reputation requirement and second element as the money cost. */ getAugmentationCost(augName: AugmentName): [number, number]; @@ -2154,11 +2369,11 @@ interface Singularity { * * This function will return true if the Augmentation is successfully purchased, and false otherwise. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} faction Name of faction to purchase Augmentation from. - * @param {string} augmnet Name of Augmentation to purchase. - * @returns {boolean} True if the Augmentation is successfully purchased, and false otherwise. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param faction - Name of faction to purchase Augmentation from. + * @param augmnet - Name of Augmentation to purchase. + * @returns True if the Augmentation is successfully purchased, and false otherwise. */ purchaseAugmentation(faction: FactionName, augmnet: AugmentName): boolean; @@ -2167,10 +2382,10 @@ interface Singularity { * * This function returns augmentation stats. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} name Name of Augmentation. CASE-SENSITIVE. - * @returns {object} Augmentation stats. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param name - Name of Augmentation. CASE-SENSITIVE. + * @returns Augmentation stats. */ getAugmentationStats(name: AugmentName): AugmentationStats; @@ -2179,9 +2394,9 @@ interface Singularity { * * This function will automatically install your Augmentations, resetting the game as usual. * - * @ramCost 5 GB - * @singularity Level 3 - * @param {string} cbScript Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. + * @remarks 5 GB + * @remarks Singularity - Level 3 + * @param cbScript - Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer. */ installAugmentations(cbScript?: Script): void; @@ -2190,18 +2405,21 @@ interface Singularity { * * This function will perform a reset even if you don’t have any augmentation installed. * - * @ramCost 5 GB - * @singularity Level 3 + * @remarks 5 GB + * @remarks Singularity - Level 3 */ softReset(): void; } +/** + * @public + */ interface HackNet { /** * Returns the number of Hacknet Nodes you own. * - * @ramCost 0 GB - * @returns {number} number of hacknet nodes. + * @remarks 0 GB + * @returns number of hacknet nodes. */ numNodes(): number; @@ -2213,16 +2431,16 @@ interface HackNet { * * If the player cannot afford to purchase a new Hacknet Node then the function will return -1. * - * @ramCost 0 GB - * @returns {number} The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1. + * @remarks 0 GB + * @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1. */ purchaseNode(): number; /** * Returns the cost of purchasing a new Hacknet Node. * - * @ramCost 0 GB - * @returns {number} Cost of purchasing a new Hacknet Node. + * @remarks 0 GB + * @returns Cost of purchasing a new Hacknet Node. */ getPurchaseNodeCost(): number; @@ -2233,9 +2451,9 @@ interface HackNet { * For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the * amount of hashes the node generates. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node - * @returns {object} Object containing a variety of stats about the specified Hacknet Node. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node + * @returns Object containing a variety of stats about the specified Hacknet Node. */ getNodeStats(index: number): NodeStats; @@ -2247,10 +2465,10 @@ interface HackNet { * * Returns false otherwise. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node. - * @param {number} n Number of levels to purchase. Must be positive. Rounded to nearest integer. - * @returns {boolean} True if the Hacknet Node’s level is successfully upgraded, false otherwise. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer. + * @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise. */ upgradeLevel(index: number, n: number): boolean; @@ -2264,10 +2482,10 @@ interface HackNet { * * Returns false otherwise. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node. - * @param {number} n Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. - * @returns {boolean} True if the Hacknet Node’s ram is successfully upgraded, false otherwise. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. + * @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise. */ upgradeRam(index: number, n: number): boolean; @@ -2279,10 +2497,10 @@ interface HackNet { * * Returns false otherwise. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node. - * @param {number} n Number of cores to purchase. Must be positive. Rounded to nearest integer. - * @returns {boolean} True if the Hacknet Node’s cores are successfully purchased, false otherwise. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer. + * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise. */ upgradeCore(index: number, n: number): boolean; @@ -2296,10 +2514,10 @@ interface HackNet { * * Returns false otherwise. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node. - * @param {number} n Number of cache levels to purchase. Must be positive. Rounded to nearest integer. - * @returns {boolean} True if the Hacknet Node’s cores are successfully purchased, false otherwise. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer. + * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise. */ upgradeCache(index: number, n: number): boolean; @@ -2309,10 +2527,10 @@ interface HackNet { * If an invalid value for n is provided, then this function returns 0. * If the specified Hacknet Node is already at max level, then Infinity is returned. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node. - * @param {number} n Number of levels to upgrade. Must be positive. Rounded to nearest integer. - * @returns {number} Cost of upgrading the specified Hacknet Node. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer. + * @returns Cost of upgrading the specified Hacknet Node. */ getLevelUpgradeCost(index: number, n: number): number; @@ -2322,10 +2540,10 @@ interface HackNet { * If an invalid value for n is provided, then this function returns 0. * If the specified Hacknet Node is already at max level, then Infinity is returned. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node. - * @param {number} n Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. - * @returns {number} Cost of upgrading the specified Hacknet Node's ram. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. + * @returns Cost of upgrading the specified Hacknet Node's ram. */ getRamUpgradeCost(index: number, n: number): number; @@ -2335,10 +2553,10 @@ interface HackNet { * If an invalid value for n is provided, then this function returns 0. * If the specified Hacknet Node is already at max level, then Infinity is returned. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node. - * @param {number} n Number of times to upgrade cores. Must be positive. Rounded to nearest integer. - * @returns {number} Cost of upgrading the specified Hacknet Node's number of cores. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer. + * @returns Cost of upgrading the specified Hacknet Node's number of cores. */ getCoreUpgradeCost(index: number, n: number): number; @@ -2350,10 +2568,10 @@ interface HackNet { * If an invalid value for n is provided, then this function returns 0. * If the specified Hacknet Node is already at max level, then Infinity is returned. * - * @ramCost 0 GB - * @param {number} index Index/Identifier of Hacknet Node. - * @param {number} n Number of times to upgrade cache. Must be positive. Rounded to nearest integer. - * @returns {number} Cost of upgrading the specified Hacknet Node's cache. + * @remarks 0 GB + * @param index - Index/Identifier of Hacknet Node. + * @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer. + * @returns Cost of upgrading the specified Hacknet Node's cache. */ getCacheUpgradeCost(index: number, n: number): number; @@ -2362,8 +2580,8 @@ interface HackNet { * * Returns the number of hashes you have. * - * @ramCost 0 GB - * @returns {number} Number of hashes you have. + * @remarks 0 GB + * @returns Number of hashes you have. */ numHashes(): number; @@ -2373,15 +2591,15 @@ interface HackNet { * Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match. * * @example - * \`\`\`js + * ```js * var upgradeName = "Sell for Corporation Funds"; * if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) { * hacknet.spendHashes(upgName); * } - * \`\`\` - * @ramCost 0 GB - * @param {string} upgName Name of the upgrade of Hacknet Node. - * @returns {number} Number of hashes required for the specified upgrade. + * ``` + * @remarks 0 GB + * @param upgName - Name of the upgrade of Hacknet Node. + * @returns Number of hashes required for the specified upgrade. */ hashCost(upgName: HashUpgrades): number; @@ -2396,18 +2614,21 @@ interface HackNet { * In this case, the \`upgTarget\` argument must be the hostname of the server. * * @example - * \`\`\`js + * ```js * hacknet.spendHashes("Sell for Corporation Funds"); * hacknet.spendHashes("Increase Maximum Money", "foodnstuff"); - * \`\`\` - * @ramCost 0 GB - * @param {string} upgName Name of the upgrade of Hacknet Node. - * @param {string} [upgTarget] Object to which upgrade applies. Required for certain upgrades. - * @returns {boolean} True if the upgrade is successfully purchased, and false otherwise.. + * ``` + * @remarks 0 GB + * @param upgName - Name of the upgrade of Hacknet Node. + * @param upgTarget - Object to which upgrade applies. Required for certain upgrades. + * @returns True if the upgrade is successfully purchased, and false otherwise.. */ spendHashes(upgName: HashUpgrades, upgTarget?: Host): boolean; } +/** + * @public + */ export interface Bladeburner { /** * You have to be employed in the Bladeburner division and be in BitNode-7 @@ -2415,8 +2636,8 @@ export interface Bladeburner { * * Returns an array of strings containing the names of all Bladeburner contracts. * - * @ramCost 0.4 GB - * @returns {string[]} Array of strings containing the names of all Bladeburner contracts. + * @remarks 0.4 GB + * @returns Array of strings containing the names of all Bladeburner contracts. */ getContractNames(): BladeburnerContracts[]; @@ -2426,8 +2647,8 @@ export interface Bladeburner { * * Returns an array of strings containing the names of all Bladeburner operations. * - * @ramCost 0.4 GB - * @returns {string[]} Array of strings containing the names of all Bladeburner operations. + * @remarks 0.4 GB + * @returns Array of strings containing the names of all Bladeburner operations. */ getOperationNames(): BladeburnerOperations[]; @@ -2437,8 +2658,8 @@ export interface Bladeburner { * * Returns an array of strings containing the names of all Bladeburner Black Ops. * - * @ramCost 0.4 GB - * @returns {string[]} Array of strings containing the names of all Bladeburner Black Ops. + * @remarks 0.4 GB + * @returns Array of strings containing the names of all Bladeburner Black Ops. */ getBlackOpNames(): BladeburnerBlackOps[]; @@ -2448,8 +2669,8 @@ export interface Bladeburner { * * Returns an array of strings containing the names of all general Bladeburner actions. * - * @ramCost 0.4 GB - * @returns {string[]} Array of strings containing the names of all general Bladeburner actions. + * @remarks 0.4 GB + * @returns Array of strings containing the names of all general Bladeburner actions. */ getGeneralActionNames(): BladeburnerGenActions[]; @@ -2459,8 +2680,8 @@ export interface Bladeburner { * * Returns an array of strings containing the names of all general Bladeburner skills. * - * @ramCost 0.4 GB - * @returns {string[]} Array of strings containing the names of all general Bladeburner skills. + * @remarks 0.4 GB + * @returns Array of strings containing the names of all general Bladeburner skills. */ getSkillNames(): BladeburnerSkills[]; @@ -2471,10 +2692,10 @@ export interface Bladeburner { * Attempts to start the specified Bladeburner action. * Returns true if the action was started successfully, and false otherwise. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match - * @returns {boolean} True if the action was started successfully, and false otherwise. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match + * @returns True if the action was started successfully, and false otherwise. */ startAction( type: BladeburnerActTypes, @@ -2487,7 +2708,7 @@ export interface Bladeburner { * * Stops the current Bladeburner action. * - * @ramCost 2 GB + * @remarks 2 GB */ stopBladeburnerAction(): void; @@ -2498,8 +2719,8 @@ export interface Bladeburner { * Returns an object that represents the player’s current Bladeburner action. * If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”. * - * @ramCost 1 GB - * @returns {object} Object that represents the player’s current Bladeburner action. + * @remarks 1 GB + * @returns Object that represents the player’s current Bladeburner action. */ getCurrentAction(): BladeburnerCurAction; @@ -2509,10 +2730,10 @@ export interface Bladeburner { * * Returns the number of seconds it takes to complete the specified action * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @returns {number} Number of seconds it takes to complete the specified action. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Number of seconds it takes to complete the specified action. */ getActionTime( type: BladeburnerActTypes, @@ -2527,10 +2748,10 @@ export interface Bladeburner { * This chance is returned as a decimal value, NOT a percentage * (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80). * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @returns {number} Estimated success chance for the specified action. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Estimated success chance for the specified action. */ getActionEstimatedSuccessChance( type: BladeburnerActTypes, @@ -2545,11 +2766,11 @@ export interface Bladeburner { * completing the specified action. * Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @param {number} [level] Optional action level at which to calculate the gain - * @returns {number} Average Bladeburner reputation gain for successfully completing the specified action. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @param level - Optional action level at which to calculate the gain + * @returns Average Bladeburner reputation gain for successfully completing the specified action. */ getActionRepGain( type: BladeburnerActTypes, @@ -2568,10 +2789,10 @@ export interface Bladeburner { * This function will return 1 for BlackOps not yet completed regardless of wether * the player has the required rank to attempt the mission or not. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @returns {number} Remaining count of the specified action. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Remaining count of the specified action. */ getActionCountRemaining( type: BladeburnerActTypes, @@ -2586,10 +2807,10 @@ export interface Bladeburner { * * Returns -1 if an invalid action is specified. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @returns {number} Maximum level of the specified action. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Maximum level of the specified action. */ getActionMaxLevel( type: BladeburnerActTypes, @@ -2604,10 +2825,10 @@ export interface Bladeburner { * * Returns -1 if an invalid action is specified. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @returns {number} Current level of the specified action. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Current level of the specified action. */ getActionCurrentLevel( type: BladeburnerActTypes, @@ -2622,10 +2843,10 @@ export interface Bladeburner { * * Returns false if an invalid action is specified. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @returns {boolean} True if the action is set to autolevel, and false otherwise. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns True if the action is set to autolevel, and false otherwise. */ getActionAutolevel( type: BladeburnerActTypes, @@ -2638,10 +2859,10 @@ export interface Bladeburner { * * Enable/disable autoleveling for the specified action. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @param {boolean} autoLevel Whether or not to autolevel this action + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @param autoLevel - Whether or not to autolevel this action */ setActionAutolevel( type: BladeburnerActTypes, @@ -2655,10 +2876,10 @@ export interface Bladeburner { * * Set the level for the specified action. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @param {number} level Level to set this action to. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @param level - Level to set this action to. */ setActionLevel( type: BladeburnerActTypes, @@ -2672,8 +2893,8 @@ export interface Bladeburner { * * Returns the player’s Bladeburner Rank. * - * @ramCost 4 GB - * @returns {number} Player’s Bladeburner Rank. + * @remarks 4 GB + * @returns Player’s Bladeburner Rank. */ getRank(): number; @@ -2685,9 +2906,9 @@ export interface Bladeburner { * * Returns -1 if an invalid action is specified. * - * @ramCost 2 GB - * @param {string} name Name of BlackOp. Must be an exact match. - * @returns {number} Rank required to complete this BlackOp. + * @remarks 2 GB + * @param name - Name of BlackOp. Must be an exact match. + * @returns Rank required to complete this BlackOp. */ getBlackOpRank(name: BladeburnerBlackOps): number; @@ -2697,8 +2918,8 @@ export interface Bladeburner { * * Returns the number of Bladeburner skill points you have. * - * @ramCost 4 GB - * @returns {number} Number of Bladeburner skill points you have. + * @remarks 4 GB + * @returns Number of Bladeburner skill points you have. */ getSkillPoints(): number; @@ -2710,9 +2931,9 @@ export interface Bladeburner { * * The function returns -1 if an invalid skill name is passed in. * - * @ramCost 4 GB - * @param {string} skillName Name of skill. Case-sensitive and must be an exact match - * @returns {number} Level in the specified skill. + * @remarks 4 GB + * @param skillName - Name of skill. Case-sensitive and must be an exact match + * @returns Level in the specified skill. */ getSkillLevel(name: BladeburnerSkills): number; @@ -2724,9 +2945,9 @@ export interface Bladeburner { * * The function returns -1 if an invalid skill name is passed in. * - * @ramCost 4 GB - * @param {string} skillName Name of skill. Case-sensitive and must be an exact match - * @returns {number} Number of skill points needed to upgrade the specified skill. + * @remarks 4 GB + * @param skillName - Name of skill. Case-sensitive and must be an exact match + * @returns Number of skill points needed to upgrade the specified skill. */ getSkillUpgradeCost(name: BladeburnerSkills): number; @@ -2738,9 +2959,9 @@ export interface Bladeburner { * * Returns true if the skill is successfully upgraded, and false otherwise. * - * @ramCost 4 GB - * @param {string} skillName Name of skill to be upgraded. Case-sensitive and must be an exact match - * @returns {boolean} true if the skill is successfully upgraded, and false otherwise. + * @remarks 4 GB + * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match + * @returns true if the skill is successfully upgraded, and false otherwise. */ upgradeSkill(name: BladeburnerSkills): boolean; @@ -2752,10 +2973,10 @@ export interface Bladeburner { * * Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @returns {number} Number of Bladeburner team members that were assigned to the specified action. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @returns Number of Bladeburner team members that were assigned to the specified action. */ getTeamSize( type: BladeburnerActTypes, @@ -2770,11 +2991,11 @@ export interface Bladeburner { * * Returns the team size that was set, or -1 if the function failed. * - * @ramCost 4 GB - * @param {string} type Type of action. - * @param {string} name Name of action. Must be an exact match. - * @param {number} size Number of team members to set. Will be converted using Math.round(). - * @returns {number} Number of Bladeburner team members you assigned to the specified action. + * @remarks 4 GB + * @param type - Type of action. + * @param name - Name of action. Must be an exact match. + * @param size - Number of team members to set. Will be converted using Math.round(). + * @returns Number of Bladeburner team members you assigned to the specified action. */ setTeamSize( type: BladeburnerActTypes, @@ -2789,9 +3010,9 @@ export interface Bladeburner { * Returns the estimated number of Synthoids in the specified city, * or -1 if an invalid city was specified. * - * @ramCost 4 GB - * @param {string} cityName Name of city. Case-sensitive - * @returns {number} Estimated number of Synthoids in the specified city. + * @remarks 4 GB + * @param cityName - Name of city. Case-sensitive + * @returns Estimated number of Synthoids in the specified city. */ getCityEstimatedPopulation(name: City): number; @@ -2802,9 +3023,9 @@ export interface Bladeburner { * Returns the estimated number of Synthoid communities in the specified city, * or -1 if an invalid city was specified. * - * @ramCost 4 GB - * @param {string} cityName Name of city. Case-sensitive - * @returns {number} Number of Synthoids communities in the specified city. + * @remarks 4 GB + * @param cityName - Name of city. Case-sensitive + * @returns Number of Synthoids communities in the specified city. */ getCityCommunities(name: City): number; @@ -2815,9 +3036,9 @@ export interface Bladeburner { * Returns the chaos in the specified city, * or -1 if an invalid city was specified. * - * @ramCost 4 GB - * @param {string} cityName Name of city. Case-sensitive - * @returns {number} Chaos in the specified city. + * @remarks 4 GB + * @param cityName - Name of city. Case-sensitive + * @returns Chaos in the specified city. */ getCityChaos(name: City): number; @@ -2827,8 +3048,8 @@ export interface Bladeburner { * * Returns the city that the player is currently in (for Bladeburner). * - * @ramCost 4 GB - * @returns {string} City that the player is currently in (for Bladeburner). + * @remarks 4 GB + * @returns City that the player is currently in (for Bladeburner). */ getCity(): City; @@ -2840,9 +3061,9 @@ export interface Bladeburner { * * Returns true if successful, and false otherwise * - * @ramCost 4 GB - * @param {string} cityName Name of city. Case-sensitive - * @returns {boolean} true if successful, and false otherwise + * @remarks 4 GB + * @param cityName - Name of city. Case-sensitive + * @returns true if successful, and false otherwise */ switchCity(name: City): boolean; @@ -2853,14 +3074,14 @@ export interface Bladeburner { * Returns an array with two elements: * * [Current stamina, Max stamina] * @example - * \`\`\`js + * ```js * function getStaminaPercentage() { * let res = bladeburner.getStamina(); * return res[0] / res[1]; * } - * \`\`\` - * @ramCost 4 GB - * @returns {[number, number]} Array containing current stamina and max stamina. + * ``` + * @remarks 4 GB + * @returns Array containing current stamina and max stamina. */ getStamina(): [number, number]; @@ -2874,8 +3095,8 @@ export interface Bladeburner { * * Returns false otherwise. * - * @ramCost 4 GB - * @returns {boolean} True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise. + * @remarks 4 GB + * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise. */ joinBladeburnerFaction(): boolean; @@ -2889,8 +3110,8 @@ export interface Bladeburner { * * Returns false otherwise. * - * @ramCost 4 GB - * @returns {boolean} True if you successfully join the Bladeburner division, or if you are already a member, false otherwise. + * @remarks 4 GB + * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise. */ joinBladeburnerDivision(): boolean; @@ -2906,33 +3127,36 @@ export interface Bladeburner { * For example, if an action takes 30 seconds to complete but you’ve accumulated over * 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete. * - * @ramCost 0 GB - * @returns {number} Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. + * @remarks 0 GB + * @returns Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic. */ getBonusTime(): number; } +/** + * @public + */ interface CodingContract { /** * Attempts to solve the Coding Contract with the provided solution. * - * @ramCost 10 GB - * @param {string|string[]|number}answer Solution for the contract. - * @param {string} fn Filename of the contract. - * @param {string} [host] Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. - * @returns {boolean} True if the solution was correct, false otherwise. + * @remarks 10 GB + * @param answer - Solution for the contract. + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns True if the solution was correct, false otherwise. */ attempt(answer: string | string[] | number, fn: string, host?: Host): boolean; /** * Attempts to solve the Coding Contract with the provided solution. * - * @ramCost 10 GB - * @param {string|string[]|number}answer Solution for the contract. - * @param {string} fn Filename of the contract. - * @param {string} [host] Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. - * @param {object} [opts] Optional parameters for configuring function behavior. - * @returns {boolean} True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string. + * @remarks 10 GB + * @param answer - Solution for the contract. + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @param opts - Optional parameters for configuring function behavior. + * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string. */ attempt(answer: string | string[] | number, fn: string, host?: Host, opts?: CodingAttemptOptions): boolean | string; @@ -2940,20 +3164,20 @@ interface CodingContract { * Returns a name describing the type of problem posed by the Coding Contract. * (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.) * - * @ramCost 5 GB - * @param {string} fn Filename of the contract. - * @param {string} [host] Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. - * @returns {string} Name describing the type of problem posed by the Coding Contract. + * @remarks 5 GB + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns Name describing the type of problem posed by the Coding Contract. */ getContractType(fn: string, host?: Host): CodingContractTypes; /** * Get the full text description for the problem posed by the Coding Contract. * - * @ramCost 5 GB - * @param {string} fn Filename of the contract. - * @param {string} [host] Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. - * @returns {string} Contract’s text description. + * @remarks 5 GB + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns Contract’s text description. */ getDescription(fn: string, host?: Host): string; @@ -2962,32 +3186,35 @@ interface CodingContract { * Note that this is not the same as the contract’s description. * This is just the data that the contract wants you to act on in order to solve * - * @ramCost 5 GB - * @param {string} fn Filename of the contract. - * @param {string} [host] Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. - * @returns {string} The specified contract’s data; + * @remarks 5 GB + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns The specified contract’s data; */ getData(fn: string, host?: Host): string; /** * Get the number of tries remaining on the contract before it self-destructs. * - * @ramCost 2 GB - * @param {string} fn Filename of the contract. - * @param {string} [host] Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. - * @returns {number} How many attempts are remaining for the contract; + * @remarks 2 GB + * @param fn - Filename of the contract. + * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. + * @returns How many attempts are remaining for the contract; */ getNumTriesRemaining(fn: string, host?: Host): number; } +/** + * @public + */ interface Gang { /** * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function. * * Get the names of all Gang members * - * @ramCost 1 GB - * @returns {string[]} Names of all Gang members. + * @remarks 1 GB + * @returns Names of all Gang members. */ getMemberNames(): string[]; @@ -2996,8 +3223,8 @@ interface Gang { * * Get general information about the gang. * - * @ramCost 2 GB - * @returns {object} Object containing general information about the gang. + * @remarks 2 GB + * @returns Object containing general information about the gang. */ getGangInformation(): GangGenInfo; @@ -3006,8 +3233,8 @@ interface Gang { * * Get territory and power information about all gangs. * - * @ramCost 2 GB - * @returns {object} Object containing territory and power information about all gangs. + * @remarks 2 GB + * @returns Object containing territory and power information about all gangs. */ getOtherGangInformation(): GangOtherInfo; @@ -3016,9 +3243,9 @@ interface Gang { * * Get stat and equipment-related information about a Gang Member * - * @ramCost 2 GB - * @param {string} name Name of member. - * @returns {object} Object containing stat and equipment-related information about a Gang Member. + * @remarks 2 GB + * @param name - Name of member. + * @returns Object containing stat and equipment-related information about a Gang Member. */ getMemberInformation(name: string): GangMemberInfo; @@ -3027,8 +3254,8 @@ interface Gang { * * Returns boolean indicating whether a member can currently be recruited * - * @ramCost 1 GB - * @returns {boolean} True if a member can currently be recruited, false otherwise. + * @remarks 1 GB + * @returns True if a member can currently be recruited, false otherwise. */ canRecruitMember(): boolean; @@ -3041,9 +3268,9 @@ interface Gang { * * Cannot currently recruit a new member * * There already exists a member with the specified name * - * @ramCost 2 GB - * @param {string} name Name of member to recruit. - * @returns {boolean} True if the member was successfully recruited, false otherwise. + * @remarks 2 GB + * @param name - Name of member to recruit. + * @returns True if the member was successfully recruited, false otherwise. */ recruitMember(name: string): boolean; @@ -3052,8 +3279,8 @@ interface Gang { * * Get the name of all valid tasks that Gang members can be assigned to. * - * @ramCost 1 GB - * @returns {string[]} All valid tasks that Gang members can be assigned to. + * @remarks 1 GB + * @returns All valid tasks that Gang members can be assigned to. */ getTaskNames(): GangTasks[]; @@ -3063,10 +3290,10 @@ interface Gang { * Attempts to assign the specified Gang Member to the specified task. * If an invalid task is specified, the Gang member will be set to idle (“Unassigned”). * - * @ramCost 2 GB - * @param {string} memberName Name of Gang member to assign. - * @param {string} taskName Task to assign. - * @returns {boolean} True if the Gang Member was successfully assigned to the task, false otherwise. + * @remarks 2 GB + * @param memberName - Name of Gang member to assign. + * @param taskName - Task to assign. + * @returns True if the Gang Member was successfully assigned to the task, false otherwise. */ setMemberTask(memberName: string, taskName: GangTasks): boolean; @@ -3075,9 +3302,9 @@ interface Gang { * * Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next. * - * @ramCost 1 GB - * @param {string} name Name of the task. - * @returns {boolean} Detailed stats of a task. + * @remarks 1 GB + * @param name - Name of the task. + * @returns Detailed stats of a task. */ getTaskStats(name: GangTasks): GangTasksStats; @@ -3087,8 +3314,8 @@ interface Gang { * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. * This includes Augmentations. * - * @ramCost 1 GB - * @returns {string[]} Names of all Equpiment/Augmentations. + * @remarks 1 GB + * @returns Names of all Equpiment/Augmentations. */ getEquipmentNames(): (GangEquipment | GangAugmentations)[]; @@ -3098,9 +3325,9 @@ interface Gang { * Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. * If an invalid Equipment/Augmentation is specified, this function will return Infinity. * - * @ramCost 2 GB - * @param {string} equipName Name of equipment. - * @returns {number} Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments + * @remarks 2 GB + * @param equipName - Name of equipment. + * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments */ getEquipmentCost(equipName: GangEquipment | GangAugmentations): number; @@ -3109,9 +3336,9 @@ interface Gang { * * Get the specified equipment type. * - * @ramCost 2 GB - * @param {string} equipName Name of equipment. - * @returns {number} Type of the equipment. + * @remarks 2 GB + * @param equipName - Name of equipment. + * @returns Type of the equipment. */ getEquipmentType(equipName: GangEquipment | GangAugmentations): GangEquipmentType; @@ -3120,9 +3347,9 @@ interface Gang { * * Get the specified equipment stats. * - * @ramCost 2 GB - * @param {string} equipName Name of equipment. - * @returns {object} A dictionary containing the stats of the equipment. + * @remarks 2 GB + * @param equipName - Name of equipment. + * @returns A dictionary containing the stats of the equipment. */ getEquipmentStats(equipName: GangEquipment | GangAugmentations): GangEquipmentStats; @@ -3131,10 +3358,10 @@ interface Gang { * * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member. * - * @ramCost 4 GB - * @param {string} memberName Name of Gang member to purchase the equipment for. - * @param {string} equipName Name of Equipment/Augmentation to purchase. - * @returns {boolean} True if the equipment was successfully purchased. False otherwise + * @remarks 4 GB + * @param memberName - Name of Gang member to purchase the equipment for. + * @param equipName - Name of Equipment/Augmentation to purchase. + * @returns True if the equipment was successfully purchased. False otherwise */ purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentations): boolean; @@ -3143,9 +3370,9 @@ interface Gang { * * Ascend the specified Gang Member. * - * @ramCost 4 GB - * @param {string} memberName Name of member to ascend. - * @returns {object} Object with info about the ascension results. + * @remarks 4 GB + * @param memberName - Name of member to ascend. + * @returns Object with info about the ascension results. */ ascendMember(memberName: string): GangMemberAscension; @@ -3154,8 +3381,8 @@ interface Gang { * * Set whether or not the gang should engage in territory warfare * - * @ramCost 2 GB - * @param {boolean} engage Whether or not to engage in territory warfare. + * @remarks 2 GB + * @param engage - Whether or not to engage in territory warfare. */ setTerritoryWarfare(engage: boolean): void; @@ -3164,9 +3391,9 @@ interface Gang { * * Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage * - * @ramCost 4 GB - * @param {string} gangName Target gang - * @returns {number} Chance you have to win a clash with the specified gang. + * @remarks 4 GB + * @param gangName - Target gang + * @returns Chance you have to win a clash with the specified gang. */ getChanceToWinClash(gangName: GangName): number; @@ -3179,20 +3406,23 @@ interface Gang { * * “Bonus time” makes the game progress faster, up to 10x the normal speed. * - * @ramCost 0 GB - * @returns {number} Bonus time for the Gang mechanic in seconds. + * @remarks 0 GB + * @returns Bonus time for the Gang mechanic in seconds. */ getBonusTime(): number; } +/** + * @public + */ interface Sleeve { /** * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function. * * Return the number of duplicate sleeves the player has. * - * @ramCost 4 GB - * @returns {number} number of duplicate sleeves the player has. + * @remarks 4 GB + * @returns number of duplicate sleeves the player has. */ getNumSleeves(): number; @@ -3201,9 +3431,9 @@ interface Sleeve { * * Return a structure containing the stats of the sleeve. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to get stats of. - * @returns {object} Object containing the stats of the sleeve. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to get stats of. + * @returns Object containing the stats of the sleeve. */ getSleeveStats(sleeveNumber: number): SleeveStats; @@ -3212,9 +3442,9 @@ interface Sleeve { * * Return a struct containing tons of information about this sleeve * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to retrieve information. - * @returns {object} Object containing tons of information about this sleeve. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to retrieve information. + * @returns Object containing tons of information about this sleeve. */ getInformation(sleeveNumber: number): SleeveInformation; @@ -3223,9 +3453,9 @@ interface Sleeve { * * Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to retrieve task from. - * @returns {object} Object containing information the current task that the sleeve is performing. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to retrieve task from. + * @returns Object containing information the current task that the sleeve is performing. */ getTask(sleeveNumber: number): SleeveTask; @@ -3234,9 +3464,9 @@ interface Sleeve { * * Return a boolean indicating whether or not this action was set successfully. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to start recovery. - * @returns {boolean} True if this action was set successfully, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to start recovery. + * @returns True if this action was set successfully, false otherwise. */ setToShockRecovery(sleeveNumber: number): boolean; @@ -3245,9 +3475,9 @@ interface Sleeve { * * Return a boolean indicating whether or not this action was set successfully. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to start synchronizing. - * @returns {boolean} True if this action was set successfully, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to start synchronizing. + * @returns True if this action was set successfully, false otherwise. */ setToSynchronize(sleeveNumber: number): boolean; @@ -3258,10 +3488,10 @@ interface Sleeve { * * Returns false if an invalid action is specified. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to start commiting crime. - * @param {string} name Name of the crime. Must be an exact match. - * @returns {boolean} True if this action was set successfully, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to start commiting crime. + * @param name - Name of the crime. Must be an exact match. + * @returns True if this action was set successfully, false otherwise. */ setToCommitCrime(sleeveNumber: number, name: Crime): boolean; @@ -3270,11 +3500,11 @@ interface Sleeve { * * Return a boolean indicating whether or not the sleeve started working or this faction. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to work for the faction. - * @param {string} factionName Name of the faction to work for. - * @param {string} factionWorkType Name of the action to perform for this faction. - * @returns {boolean} True if the sleeve started working on this faction, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to work for the faction. + * @param factionName - Name of the faction to work for. + * @param factionWorkType - Name of the action to perform for this faction. + * @returns True if the sleeve started working on this faction, false otherwise. */ setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType: FactionWork): boolean; @@ -3283,10 +3513,10 @@ interface Sleeve { * * Return a boolean indicating whether or not the sleeve started working or this company. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to work for the company. - * @param {string} companyName Name of the company to work for. - * @returns {boolean} True if the sleeve started working on this company, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to work for the company. + * @param companyName - Name of the company to work for. + * @returns True if the sleeve started working on this company, false otherwise. */ setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; @@ -3295,11 +3525,11 @@ interface Sleeve { * * Return a boolean indicating whether or not this action was set successfully. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to start taking class. - * @param {string} university Name of the university to attend. - * @param {string} className Name of the class to follow. - * @returns {boolean} True if this action was set successfully, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to start taking class. + * @param university - Name of the university to attend. + * @param className - Name of the class to follow. + * @returns True if this action was set successfully, false otherwise. */ setToUniversityCourse(sleeveNumber: number, university: University, className: UniversityCourse): boolean; @@ -3308,11 +3538,11 @@ interface Sleeve { * * Return a boolean indicating whether or not the sleeve started working out. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to workout at the gym. - * @param {string} gymName Name of the gym. - * @param {string} stat Name of the stat to train. - * @returns {boolean} True if the sleeve started working out, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to workout at the gym. + * @param gymName - Name of the gym. + * @param stat - Name of the stat to train. + * @returns True if the sleeve started working out, false otherwise. */ setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean; @@ -3321,10 +3551,10 @@ interface Sleeve { * * Return a boolean indicating whether or not the sleeve reached destination. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to travel. - * @param {string} cityName Name of the destination city. - * @returns {boolean} True if the sleeve reached destination, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to travel. + * @param cityName - Name of the destination city. + * @returns True if the sleeve reached destination, false otherwise. */ travel(sleeveNumber: number, cityName: City): boolean; @@ -3333,9 +3563,9 @@ interface Sleeve { * * Return a list of augmentation names that this sleeve has installed. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to retrieve augmentations from. - * @returns {string[]} List of augmentation names that this sleeve has installed. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to retrieve augmentations from. + * @returns List of augmentation names that this sleeve has installed. */ getSleeveAugmentations(sleeveNumber: number): AugmentName[]; @@ -3344,9 +3574,9 @@ interface Sleeve { * * Return a list of augmentations that the player can buy for this sleeve. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to retrieve purchasable augmentations from. - * @returns {string[]} List of augmentations that the player can buy for this sleeve. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from. + * @returns List of augmentations that the player can buy for this sleeve. */ getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; @@ -3355,14 +3585,17 @@ interface Sleeve { * * Return true if the aug was purchased and installed on the sleeve. * - * @ramCost 4 GB - * @param {number} sleeveNumber Index of the sleeve to buy an aug for. - * @param {string} augName Name of the aug to buy. Must be an exact match. - * @returns {boolean} True if the aug was purchased and installed on the sleeve, false otherwise. + * @remarks 4 GB + * @param sleeveNumber - Index of the sleeve to buy an aug for. + * @param augName - Name of the aug to buy. Must be an exact match. + * @returns True if the aug was purchased and installed on the sleeve, false otherwise. */ purchaseSleeveAug(sleeveNumber: number, augName: AugmentName): boolean; } +/** + * @public + */ export interface NS extends Singularity { /** * Not all functions in the Hacknet Node API are immediately available. @@ -3371,27 +3604,27 @@ export interface NS extends Singularity { * * If you want to see what your script is doing you will have to print to the logs yourself. * - * @ramCost 4 GB + * @remarks 4 GB */ readonly hacknet: HackNet; /** - * @ramCost 0 GB + * @remarks 0 GB */ readonly bladeburner: Bladeburner; /** - * @ramCost 0 GB + * @remarks 0 GB */ readonly codingcontract: CodingContract; /** - * @ramCost 0 GB + * @remarks 0 GB */ readonly gang: Gang; /** - * @ramCost 0 GB + * @remarks 0 GB */ readonly sleeve: Sleeve; /** - * @ramCost 0 GB + * @remarks 0 GB */ readonly stock: TIX; @@ -3400,12 +3633,12 @@ export interface NS extends Singularity { * array using the [] operator (args[0], args[1], etc…). * * It is also possible to get the number of arguments that was passed into a script using: - * \`\`\`js + * ```js * args.length - * \`\`\` + * ``` * WARNING: Do not try to modify the args array. This will break the game. * - * @ramCost 0 GB + * @remarks 0 GB */ readonly args: any[]; @@ -3422,15 +3655,15 @@ export interface NS extends Singularity { * A successful \`hack()\` on a server will raise that server’s security level by 0.002. * * @example - * \`\`\`js + * ```js * hack("foodnstuff"); * hack("10.1.2.3"); * hack("foodnstuff", { threads: 5 }); // Only use 5 threads to hack - * \`\`\` - * @ramCost 0.1 GB - * @param {string} host Hostname or IP of the target server to hack. - * @param {object} [opts] Optional parameters for configuring function behavior. - * @returns {Promise} The amount of money stolen if the hack is successful, and zero otherwise. + * ``` + * @remarks 0.1 GB + * @param host - Hostname or IP of the target server to hack. + * @param opts - Optional parameters for configuring function behavior. + * @returns The amount of money stolen if the hack is successful, and zero otherwise. */ hack(host: Host, opts?: BasicHGWOptions): Promise; @@ -3443,19 +3676,19 @@ export interface NS extends Singularity { * higher-level servers have higher growth rates. The getServerGrowth() function can be used * to obtain a server’s growth rate. * - * Like {@link hack}, \`grow\` can be called on any server, regardless of where the script is running. + * Like hack, \`grow\` can be called on any server, regardless of where the script is running. * The grow() command requires root access to the target server, but there is no required hacking * level to run the command. It also raises the security level of the target server by 0.004. * * @example - * \`\`\`js + * ```js * grow("foodnstuff"); * grow("foodnstuff", { threads: 5 }); // Only use 5 threads to grow - * \`\`\` - * @ramCost 0.15 GB - * @param {string} host Hostname or IP of the target server to grow. - * @param {object} [opts] Optional parameters for configuring function behavior. - * @returns {Promise} The number by which the money on the server was multiplied for the growth. + * ``` + * @remarks 0.15 GB + * @param host - Hostname or IP of the target server to grow. + * @param opts - Optional parameters for configuring function behavior. + * @returns The number by which the money on the server was multiplied for the growth. */ grow(host: Host, opts?: BasicHGWOptions): Promise; @@ -3464,34 +3697,34 @@ export interface NS extends Singularity { * The runtime for this command depends on your hacking level and the target server’s security * level. This function lowers the security level of the target server by 0.05. * - * Like {@link hack} and {@link grow}, \`weaken\` can be called on any server, regardless of + * Like hack and grow, \`weaken\` can be called on any server, regardless of * where the script is running. This command requires root access to the target server, but * there is no required hacking level to run the command. * * @example - * \`\`\`js + * ```js * weaken("foodnstuff"); * weaken("foodnstuff", { threads: 5 }); // Only use 5 threads to weaken - * \`\`\` - * @ramCost 0.15 GB - * @param {string} host Hostname or IP of the target server to weaken. - * @param {object} [opts] Optional parameters for configuring function behavior. - * @returns {Promise} The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads. + * ``` + * @remarks 0.15 GB + * @param host - Hostname or IP of the target server to weaken. + * @param opts - Optional parameters for configuring function behavior. + * @returns The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads. */ weaken(host: Host, opts?: BasicHGWOptions): Promise; /** * Returns the security decrease that would occur if a weaken with this many threads happened. * - * @ramCost 1 GB - * @param {number} threads Amount of threads that will be used. - * @param {number} cores Optional. The number of cores of the server that would run weaken. - * @returns {number} The security decrease. + * @remarks 1 GB + * @param threads - Amount of threads that will be used. + * @param cores - Optional. The number of cores of the server that would run weaken. + * @returns The security decrease. */ weakenAnalyze(threads: number, cores?: number): number; /** - * This function returns the number of script threads you need when running the {@link hack} command + * This function returns the number of script threads you need when running the hack command * to steal the specified amount of money from the target server. * If hackAmount is less than zero or greater than the amount of money available on the server, * then this function returns -1. @@ -3499,15 +3732,15 @@ export interface NS extends Singularity { * Warning: The value returned by this function isn’t necessarily a whole number. * * @example - * \`\`\`js + * ```js * //For example, let’s say the foodnstuff server has $10m and you run: * hackAnalyzeThreads("foodnstuff", 1e6); - * //If this function returns 50, this means that if your next {@link hack} call is run on a script with 50 threads, it will steal $1m from the foodnstuff server. - * \`\`\` - * @ramCost 1 GB - * @param {string} host Hostname or IP of the target server to analyze. - * @param {number} hackAmount Amount of money you want to hack from the server. - * @returns {number} The number of threads needed to {@link hack} the server for hackAmount money. + * //If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server. + * ``` + * @remarks 1 GB + * @param host - Hostname or IP of the target server to analyze. + * @param hackAmount - Amount of money you want to hack from the server. + * @returns The number of threads needed to hack the server for hackAmount money. */ hackAnalyzeThreads(host: Host, hackAmount: number): number; @@ -3517,23 +3750,23 @@ export interface NS extends Singularity { * (Netscript functions typically return in decimal form, but not this one). * * @example - * \`\`\`js + * ```js * //For example, assume the following returns 1: * hackAnalyzePercent("foodnstuff"); - * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you {@link hack} using N threads, then you will steal N% of its total money. - * \`\`\` - * @ramCost 1 GB - * @param {string} host Hostname or IP of the target server. - * @returns {number} The percentage of money you will steal from the target server with a single hack. + * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N% of its total money. + * ``` + * @remarks 1 GB + * @param host - Hostname or IP of the target server. + * @returns The percentage of money you will steal from the target server with a single hack. */ hackAnalyzePercent(host: Host): number; /** * Returns the security increase that would occur if a hack with this many threads happened. * - * @ramCost 1 GB - * @param {number} threads Amount of threads that will be used. - * @returns {number} The security increase. + * @remarks 1 GB + * @param threads - Amount of threads that will be used. + * @returns The security increase. */ hackAnalyzeSecurity(threads: number): number; @@ -3542,9 +3775,9 @@ export interface NS extends Singularity { * * This returned value is in decimal form, not percentage. * - * @ramCost 1 GB - * @param {string} host Hostname or IP of the target server. - * @returns {number} The chance you have of successfully hacking the target server. + * @remarks 1 GB + * @param host - Hostname or IP of the target server. + * @returns The chance you have of successfully hacking the target server. */ hackChance(host: Host): number; @@ -3556,56 +3789,56 @@ export interface NS extends Singularity { * Warning: The value returned by this function isn’t necessarily a whole number. * * @example - * \`\`\`js - * //For example, if you want to determine how many {@link grow} calls you need to double the amount of money on foodnstuff, you would use: + * ```js + * //For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use: * growthAnalyze("foodnstuff", 2); - * //If this returns 100, then this means you need to call {@link grow} 100 times in order to double the money (or once with 100 threads). - * \`\`\` - * @ramCost 1 GB - * @param {string} host Hostname or IP of the target server. - * @param {number} growthAmount Multiplicative factor by which the server is grown. Decimal form.. - * @returns {number} The amount of {@link grow} calls needed to grow the specified server by the specified amount + * //If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads). + * ``` + * @remarks 1 GB + * @param host - Hostname or IP of the target server. + * @param growthAmount - Multiplicative factor by which the server is grown. Decimal form.. + * @returns The amount of grow calls needed to grow the specified server by the specified amount */ growthAnalyze(host: Host, growthAmount: number): number; /** * Returns the security increase that would occur if a grow with this many threads happened. * - * @ramCost 1 GB - * @param {number} threads Amount of threads that will be used. - * @returns {number} The security increase. + * @remarks 1 GB + * @param threads - Amount of threads that will be used. + * @returns The security increase. */ growthAnalyzeSecurity(threads: number): number; /** * Suspends the script for n milliseconds. * - * @ramCost 0 GB - * @param {number} millis Number of milliseconds to sleep. - * @returns {Promise} + * @remarks 0 GB + * @param millis - Number of milliseconds to sleep. + * @returns */ sleep(millis: number): Promise; /** * Prints a value or a variable to the script’s logs. * - * @ramCost 0 GB - * @param {string} msg Value to be printed. + * @remarks 0 GB + * @param msg - Value to be printed. */ print(msg: string | number | string[] | number[]): void; /** * Prints a value or a variable to the Terminal. * - * @ramCost 0 GB - * @param {string} msg Value to be printed. + * @remarks 0 GB + * @param msg - Value to be printed. */ tprint(msg: string | number | string[] | number[]): void; /** * Clears the script’s logs. * - * @ramCost 0 GB + * @remarks 0 GB */ clearLog(): void; @@ -3617,11 +3850,11 @@ export interface NS extends Singularity { * This only stops a function from logging when the function is successful. * If the function fails, it will still log the reason for failure. * - * Notable functions that cannot have their logs disabled: {@link run}, - * {@link exec}, {@link exit}. + * Notable functions that cannot have their logs disabled: run, + * exec, exit. * - * @ramCost 0 GB - * @param {string} fn Name of function for which to disable logging. + * @remarks 0 GB + * @param fn - Name of function for which to disable logging. */ disableLog(fn: string): void; @@ -3629,17 +3862,17 @@ export interface NS extends Singularity { * Re-enables logging for the given function. If \`ALL\` is passed into this * function as an argument, then it will revert the effects of disableLog(\`ALL\`). * - * @ramCost 0 GB - * @param {string} fn Name of function for which to enable logging. + * @remarks 0 GB + * @param fn - Name of function for which to enable logging. */ enableLog(fn: string): void; /** * Checks the status of the logging for the given function. * - * @ramCost 0 GB - * @param {string} fn Name of function to check. - * @returns {boolean} Returns a boolean indicating whether or not logging is enabled for that function (or \`ALL\`) + * @remarks 0 GB + * @param fn - Name of function to check. + * @returns Returns a boolean indicating whether or not logging is enabled for that function (or \`ALL\`) */ isLogEnabled(fn: string): boolean; @@ -3653,25 +3886,25 @@ export interface NS extends Singularity { * Remember that scripts are uniquely identified by both their names and arguments. * * @example - * \`\`\`js + * ```js * //Get logs from foo.script on the current server that was run with no args * getScriptLogs("foo.script"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //Open logs from foo.script on the foodnstuff server that was run with no args * getScriptLogs("foo.script", "foodnstuff"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //Open logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] * getScriptLogs("foo.script", "foodnstuff", 1, "test"); - * \`\`\` - * @ramCost 0 GB - * @param {string} [fn] Optional. Filename of script to get logs from. - * @param {string} [host] Optional. Hostname or IP of the server that the script is on. - * @param {...string} [args] Arguments to identify which scripts to get logs for. - * @returns {string[]} Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array. + * ``` + * @remarks 0 GB + * @param fn - Optional. Filename of script to get logs from. + * @param host - Optional. Hostname or IP of the server that the script is on. + * @param args - Arguments to identify which scripts to get logs for. + * @returns Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array. */ getScriptLogs(fn?: Script, host?: Host, ...args: any[]): string[]; @@ -3684,24 +3917,24 @@ export interface NS extends Singularity { * Remember that scripts are uniquely identified by both their names and arguments. * * @example - * \`\`\`js + * ```js * //Open logs from foo.script on the current server that was run with no args * tail("foo.script"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //Get logs from foo.script on the foodnstuff server that was run with no args * tail("foo.script", "foodnstuff"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, "test"] * tail("foo.script", "foodnstuff", 1, "test"); - * \`\`\` - * @ramCost 0 GB - * @param {string} [fn] Optional. Filename of the script being tailed. If omitted, the current script is tailed. - * @param {string} [host] Optional. Hostname or IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. - * @param {any[]} ...args Arguments for the script being tailed. + * ``` + * @remarks 0 GB + * @param fn - Optional. Filename of the script being tailed. If omitted, the current script is tailed. + * @param host - Optional. Hostname or IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional. + * @param args - Arguments for the script being tailed. */ tail(fn?: Script, host?: Host, ...args: any[]): void; @@ -3710,10 +3943,10 @@ export interface NS extends Singularity { * node way from the specified target server. The hostnames/IPs in the returned * array are strings. * - * @ramCost 0.2 GB - * @param {string} host Hostname or IP of the server to scan. - * @param {boolean} hostnames Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false). - * @returns {string[]} Returns an string of hostnames or IP. + * @remarks 0.2 GB + * @param host - Hostname or IP of the server to scan. + * @param hostnames - Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false). + * @returns Returns an string of hostnames or IP. */ scan(host: Host, hostnames?: boolean): Host[]; @@ -3721,11 +3954,11 @@ export interface NS extends Singularity { * Runs the NUKE.exe program on the target server. NUKE.exe must exist on your home computer. * * @example - * \`\`\`js + * ```js * nuke("foodnstuff"); - * \`\`\` - * @ramCost 0.05 GB - * @param {string} host Hostname or IP of the target server. + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. */ nuke(host: Host): void; @@ -3733,11 +3966,11 @@ export interface NS extends Singularity { * Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer. * * @example - * \`\`\`js + * ```js * brutessh("foodnstuff"); - * \`\`\` - * @ramCost 0.05 GB - * @param {string} host Hostname or IP of the target server. + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. */ brutessh(host: Host): void; @@ -3745,11 +3978,11 @@ export interface NS extends Singularity { * Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer. * * @example - * \`\`\`js + * ```js * ftpcrack("foodnstuff"); - * \`\`\` - * @ramCost 0.05 GB - * @param {string} host Hostname or IP of the target server. + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. */ ftpcrack(host: Host): void; @@ -3757,11 +3990,11 @@ export interface NS extends Singularity { * Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer. * * @example - * \`\`\`js + * ```js * relaysmtp("foodnstuff"); - * \`\`\` - * @ramCost 0.05 GB - * @param {string} host Hostname or IP of the target server. + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. */ relaysmtp(host: Host): void; @@ -3769,11 +4002,11 @@ export interface NS extends Singularity { * Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer. * * @example - * \`\`\`js + * ```js * httpworm("foodnstuff"); - * \`\`\` - * @ramCost 0.05 GB - * @param {string} host Hostname or IP of the target server. + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. */ httpworm(host: Host): void; @@ -3781,11 +4014,11 @@ export interface NS extends Singularity { * Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer. * * @example - * \`\`\`js + * ```js * sqlinject("foodnstuff"); - * \`\`\` - * @ramCost 0.05 GB - * @param {string} host Hostname or IP of the target server. + * ``` + * @remarks 0.05 GB + * @param host - Hostname or IP of the target server. */ sqlinject(host: Host): void; @@ -3804,25 +4037,25 @@ export interface NS extends Singularity { * However, running this function with a negative numThreads argument will cause a runtime error. * * @example - * \`\`\`js + * ```js * //The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.script’ single-threaded with no arguments: * run("foo.script"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //The following example will run ‘foo.script’ but with 5 threads instead of single-threaded: * run("foo.script", 5); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument: * run("foo.script", 1, 'foodnstuff'); - * \`\`\` - * @ramCost 1 GB - * @param {string} script Filename of script to run. - * @param {number} [numThreads] Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. - * @param {...string} [args] Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value. - * @returns {number} Returns the PID of a successfully started script, and 0 otherwise. + * ``` + * @remarks 1 GB + * @param script - Filename of script to run. + * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to 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 second argument numThreads must be filled in with a value. + * @returns Returns the PID of a successfully started script, and 0 otherwise. */ run(script: Script, numThreads?: number, ...args: string[]): number; @@ -3840,26 +4073,26 @@ export interface NS extends Singularity { * However, running this function with a negative numThreads argument will cause a runtime error. * * @example - * \`\`\`js + * ```js * //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"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //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); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //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"); - * \`\`\` - * @ramCost 1.3 GB - * @param {string} script Filename of script to execute. - * @param {string} host Hostname or IP of the \`target server\` on which to execute the script. - * @param {number} [numThreads] Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer. - * @param {...string} [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 {number} Returns the PID of a successfully started script, and 0 otherwise. + * ``` + * @remarks 1.3 GB + * @param script - Filename of script to execute. + * @param host - Hostname or IP 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 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. */ exec(script: Script, host: Host, numThreads?: number, ...args: string[]): number; @@ -3872,14 +4105,14 @@ export interface NS extends Singularity { * Because this function immediately terminates the script, it does not have a return value. * * @example - * \`\`\`js + * ```js * //The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90: * spawn('foo.script', 10, 'foodnstuff', 90); - * \`\`\` - * @ramCost 2 GB - * @param {string} script Filename of script to execute. - * @param {string} numThreads Number of threads to spawn new script with. Will be rounded to nearest integer. - * @param {...string} [args] Additional arguments to pass into the new script that is being run. + * ``` + * @remarks 2 GB + * @param script - Filename of script to execute. + * @param numThreads - Number of threads to spawn new script with. Will be rounded to nearest integer. + * @param args - Additional arguments to pass into the new script that is being run. */ spawn(script: Script, numThreads?: number, ...args: string[]): void; @@ -3890,25 +4123,25 @@ export interface NS extends Singularity { * \`foo.script\` run with the argument 2, even though they have the same code. * * @example - * \`\`\`js + * ```js * //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments: * kill("foo.script", "foodnstuff"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //The following will try to kill a script named foo.script on the current server that was ran with no arguments: * kill("foo.script", getHostname()); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”: * kill("foo.script", getHostname(), 1, "foodnstuff"); - * \`\`\` - * @ramCost 0.5 GB - * @param {string} script Filename of the script to kill - * @param {string} host Hostname or IP of the server on which to kill the script. - * @param {...string} [args] Arguments to identify which script to kill. - * @returns {boolean} True if the script is successfully killed, and false otherwise. + * ``` + * @remarks 0.5 GB + * @param script - Filename of the script to kill + * @param host - Hostname or IP of the server on which to kill the script. + * @param args - Arguments to identify which script to kill. + * @returns True if the script is successfully killed, and false otherwise. */ kill(script: Script, host: Host, ...args: string[]): boolean; @@ -3920,14 +4153,14 @@ export interface NS extends Singularity { * Otherwise, it will return false. * * @example - * \`\`\`js + * ```js * if (kill(10)) { * print("Killed script with PID 10!"); * } - * \`\`\` - * @ramCost 0.5 GB - * @param {number} scriptPid PID of the script to kill - * @returns {boolean} True if the script is successfully killed, and false otherwise. + * ``` + * @remarks 0.5 GB + * @param scriptPid - PID of the script to kill + * @returns True if the script is successfully killed, and false otherwise. */ kill(scriptPid: number): boolean; @@ -3936,16 +4169,16 @@ export interface NS extends Singularity { * if any scripts were killed, and false otherwise. In other words, it will return * true if there are any scripts running on the target server. * - * @ramCost 0.5 GB - * @param host {string} IP or hostname of the server on which to kill all scripts. - * @returns {boolean} True if any scripts were killed, and false otherwise. + * @remarks 0.5 GB + * @param host - IP or hostname of the server on which to kill all scripts. + * @returns True if any scripts were killed, and false otherwise. */ killall(host: Host): boolean; /** * Terminates the current script immediately. * - * @ramCost 0 GB + * @remarks 0 GB */ exit(): void; @@ -3954,14 +4187,14 @@ export interface NS extends Singularity { * specifying a single file to copy, or an array of strings specifying multiple files to copy. * * @example - * \`\`\`js + * ```js * //Copies hack-template.script from the current server to foodnstuff: * scp("hack-template.script", "foodnstuff"); - * \`\`\` - * @ramCost 0.6 GB - * @param {(string|string[])} files Filename or an array of filenames of script/literature files to copy. - * @param {(string|number)} destination Host or IP of the destination server, which is the server to which the file will be copied. - * @returns {boolean} True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. + * ``` + * @remarks 0.6 GB + * @param files - Filename or an array of filenames of script/literature files to copy. + * @param destination - Host or IP of the destination server, which is the server to which the file will be copied. + * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. */ scp(files: string | ReadonlyArray, destination: Host): boolean; @@ -3970,21 +4203,21 @@ export interface NS extends Singularity { * specifying a single file to copy, or an array of strings specifying multiple files to copy. * * @example - * \`\`\`js + * ```js * //Copies foo.lit from the helios server to the home computer: * scp("foo.lit", "helios", "home"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //Tries to copy three files from rothman-uni to home computer: * files = ["foo1.lit", "foo2.script", "foo3.script"]; * scp(files, "rothman-uni", "home"); - * \`\`\` - * @ramCost 0.6 GB - * @param {(string|string[])} files Filename or an array of filenames of script/literature files to copy. - * @param {(string|number)} source Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. - * @param {(string|number)} destination Host or IP of the destination server, which is the server to which the file will be copied. - * @returns {boolean} True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. + * ``` + * @remarks 0.6 GB + * @param files - Filename or an array of filenames of script/literature files to copy. + * @param source - Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server. + * @param destination - Host or IP of the destination server, which is the server to which the file will be copied. + * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied. */ scp( files: string | ReadonlyArray, @@ -3997,10 +4230,10 @@ export interface NS extends Singularity { * Returns an array with the filenames of all files on the specified server * (as strings). The returned array is sorted in alphabetic order. * - * @ramCost 0.2 GB - * @param {string} host Host or IP of the target server. - * @param {string} grep A substring to search for in the filename. - * @returns {string[]} Array with the filenames of all files on the specified server. + * @remarks 0.2 GB + * @param host - Host or IP of the target server. + * @param grep - A substring to search for in the filename. + * @returns Array with the filenames of all files on the specified server. */ ls(host: Host, grep?: string): string[]; @@ -4008,7 +4241,7 @@ export interface NS extends Singularity { * Returns an array with general information about all scripts running on the specified target server. * * @example - * \`\`\`js + * ```js * //(using NetscriptJS (Netscript 2.0)) * export async function main(ns) { * const ps = ns.ps("home"); @@ -4017,10 +4250,10 @@ export interface NS extends Singularity { * ns.tprint(ps[i].args); * } * } - * \`\`\` - * @ramCost 0.2 GB - * @param {string} host Host or IP address of the target server. If not specified, it will be the current server’s IP by default. - * @returns {object} Array with general information about all scripts running on the specified target server. + * ``` + * @remarks 0.2 GB + * @param host - Host or IP address of the target server. If not specified, it will be the current server’s IP by default. + * @returns Array with general information about all scripts running on the specified target server. */ ps(host?: Host): ProcessInfo[]; @@ -4028,30 +4261,30 @@ export interface NS extends Singularity { * Returns a boolean indicating whether or not the player has root access to the specified target server. * * @example - * \`\`\`js + * ```js * if (hasRootAccess("foodnstuff") == false) { * nuke("foodnstuff"); * } - * \`\`\` - * @ramCost 0.05 GB - * @param {string} host Host or IP of the target server - * @returns {boolean} True if player has root access to the specified target server, and false otherwise. + * ``` + * @remarks 0.05 GB + * @param host - Host or IP of the target server + * @returns True if player has root access to the specified target server, and false otherwise. */ hasRootAccess(host: Host): boolean; /** * Returns a string with the hostname of the server that the script is running on. * - * @ramCost 0.05 GB - * @returns {string} Hostname of the server that the script is on. + * @remarks 0.05 GB + * @returns Hostname of the server that the script is on. */ getHostname(): Host; /** * Returns the player’s current hacking level. * - * @ramCost 0.05 GB - * @returns {number} Player’s current hacking level + * @remarks 0.05 GB + * @returns Player’s current hacking level */ getHackingLevel(): number; @@ -4061,14 +4294,14 @@ export interface NS extends Singularity { * (e.g. 1.5 instead of 150%). * * @example - * \`\`\`js + * ```js * //Example of how this can be used: * mults = getHackingMultipliers(); * print(mults.chance); * print(mults.growth); - * \`\`\` - * @ramCost 4 GB - * @returns {object} Object containing the Player’s hacking related multipliers. + * ``` + * @remarks 4 GB + * @returns Object containing the Player’s hacking related multipliers. */ getHackingMultipliers(): HackingMultipliers; @@ -4078,23 +4311,23 @@ export interface NS extends Singularity { * (e.g. 1.5 instead of 150%). * * @example - * \`\`\`js + * ```js * //Example of how this can be used: * mults = getHacknetMultipliers(); * print(mults.production); * print(mults.purchaseCost); - * \`\`\` - * @ramCost 4 GB - * @returns {object} Object containing the Player’s hacknet related multipliers. + * ``` + * @remarks 4 GB + * @returns Object containing the Player’s hacknet related multipliers. */ getHacknetMultipliers(): HacknetMultipliers; /** * Returns a server object for the given server. Defaults to the running script's server if host is not specified. * - * @ramCost 2 GB - * @param {string} [host] Optional. Hostname or IP for the requested server object. - * @returns {Server} The requested server object. + * @remarks 2 GB + * @param host - Optional. Hostname or IP for the requested server object. + * @returns The requested server object. */ getServer(host?: Host): Server; @@ -4103,22 +4336,22 @@ export interface NS extends Singularity { * Running this function on the home computer will return the player’s money. * * @example - * \`\`\`js + * ```js * getServerMoneyAvailable("foodnstuff"); * getServerMoneyAvailable("home"); //Returns player's money - * \`\`\` - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server - * @returns {number} Amount of money available on the server. + * ``` + * @remarks 0.1 GB + * @param host - Host or IP of target server + * @returns Amount of money available on the server. */ getServerMoneyAvailable(host: Host): number; /** * Returns the maximum amount of money that can be available on a server. * - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {number} Maximum amount of money available on the server. + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Maximum amount of money available on the server. */ getServerMaxMoney(host: Host): number; @@ -4127,12 +4360,12 @@ export interface NS extends Singularity { * parameter is a number between 1 and 100 that represents how * quickly the server’s money grows. This parameter affects the * percentage by which the server’s money is increased when using the - * {@link grow} function. A higher growth parameter will result in a - * higher percentage increase from {@link grow}. + * grow function. A higher growth parameter will result in a + * higher percentage increase from grow. * - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {number} Parameter that affects the percentage by which the server’s money is increased when using the {@link grow} function. + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Parameter that affects the percentage by which the server’s money is increased when using the grow function. */ getServerGrowth(host: Host): number; @@ -4141,51 +4374,51 @@ export interface NS extends Singularity { * level is denoted by a number, typically between 1 and 100 * (but it can go above 100). * - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {number} Security level of the target server. + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Security level of the target server. */ getServerSecurityLevel(host: Host): number; /** * Returns the base security level of the target server. This is the security * level that the server starts out with. This is different than - * {@link getServerSecurityLevel} because {@link getServerSecurityLevel} returns + * getServerSecurityLevel because getServerSecurityLevel returns * the current security level of a server, which can constantly change due to - * {@link hack}, {@link grow}, and {@link weaken}, calls on that server. + * hack, grow, and weaken, calls on that server. * The base security level will stay the same until you reset by * installing an Augmentation(s). * - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {number} Base security level of the target server. + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Base security level of the target server. */ getServerBaseSecurityLevel(host: Host): number; /** * Returns the minimum security level of the target server. * - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {number} Minimum security level of the target server. + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Minimum security level of the target server. */ getServerMinSecurityLevel(host: Host): number; /** * Returns the required hacking level of the target server. * - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {number} The required hacking level of the target server. + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns The required hacking level of the target server. */ getServerRequiredHackingLevel(host: Host): number; /** * Returns the number of open ports required to successfully run NUKE.exe on the specified server. * - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {number} The number of open ports required to successfully run NUKE.exe on the specified server. + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns The number of open ports required to successfully run NUKE.exe on the specified server. */ getServerNumPortsRequired(host: Host): number; @@ -4196,23 +4429,23 @@ export interface NS extends Singularity { * the server (in GB). * * @example - * \`\`\`js + * ```js * res = getServerRam("helios"); * totalRam = res[0]; * ramUsed = res[1]; - * \`\`\` - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {[number,number]} Array with total and used memory on the specified server. + * ``` + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns Array with total and used memory on the specified server. */ getServerRam(host: Host): [number, number]; /** * Returns a boolean denoting whether or not the specified server exists. * - * @ramCost 0.1 GB - * @param {string} host Host or IP of target server. - * @returns {boolean} True if specified server exists, and false otherwise. + * @remarks 0.1 GB + * @param host - Host or IP of target server. + * @returns True if specified server exists, and false otherwise. */ serverExists(host: Host): boolean; @@ -4226,19 +4459,19 @@ export interface NS extends Singularity { * server (the server running the script that calls this function) for the file. * * @example - * \`\`\`js + * ```js * //The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise. * fileExists("foo.script", "foodnstuff"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise. * fileExists("ftpcrack.exe"); - * \`\`\` - * @ramCost 0.1 GB - * @param {string} filename Filename of file to check. - * @param {(string|number)} [host] Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server. - * @returns {boolean} True if specified file exists, and false otherwise. + * ``` + * @remarks 0.1 GB + * @param filename - Filename of file to check. + * @param host - Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server. + * @returns True if specified file exists, and false otherwise. */ fileExists(filename: string, host?: Host): boolean; @@ -4247,25 +4480,25 @@ export interface NS extends Singularity { * Remember that a script is uniquely identified by both its name and its arguments. * * @example - * \`\`\`js + * ```js * //The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise: * isRunning("foo.script", "foodnstuff"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise: * isRunning("foo.script", getHostname()); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise: * isRunning("foo.script", "joesguns", 1, 5, "test"); - * \`\`\` - * @ramCost 0.1 GB - * @param {string} script Filename of script to check. This is case-sensitive. - * @param {string} host Host or IP of target server. - * @param {...string} [args] Arguments to specify/identify which scripts to search for. - * @returns {boolean} True if specified script is running on the target server, and false otherwise. + * ``` + * @remarks 0.1 GB + * @param script - Filename of script to check. This is case-sensitive. + * @param host - Host or IP of target server. + * @param args - Arguments to specify/identify which scripts to search for. + * @returns True if specified script is running on the target server, and false otherwise. */ isRunning(script: Script, host: Host, ...args: string[]): boolean; @@ -4273,14 +4506,14 @@ export interface NS extends Singularity { * Returns the cost to purchase a server with the specified amount of ram. * * @example - * \`\`\`js + * ```js * for (i = 1; i <= 20; i++) { * tprint(i + " -- " + getPurchasedServerCost(Math.pow(2, i))); * } - * \`\`\` - * @ramCost 0.25 GB - * @param {number} ram Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). - * @returns {number} The cost to purchase a server with the specified amount of ram. + * ``` + * @remarks 0.25 GB + * @param ram - Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + * @returns The cost to purchase a server with the specified amount of ram. */ getPurchasedServerCost(ram: number): number; @@ -4305,17 +4538,17 @@ export interface NS extends Singularity { * amount of servers. * * @example - * \`\`\`js + * ```js * ram = 64; * hn = "pserv-"; * for (i = 0; i < 5; ++i) { * purchaseServer(hn + i, ram); * } - * \`\`\` - * @ramCost 2.25 GB - * @param {string} hostname Host of the purchased server. - * @param {number} ram Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). - * @returns {string} The hostname of the newly purchased server. + * ``` + * @remarks 2.25 GB + * @param hostname - Host of the purchased server. + * @param ram - Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20). + * @returns The hostname of the newly purchased server. */ purchaseServer(hostname: Host, ram: number): Host | ""; @@ -4326,34 +4559,34 @@ export interface NS extends Singularity { * Whitespace is automatically removed from the string. This function will not delete a * server that still has scripts running on it. * - * @ramCost 2.25 GB - * @param {string} host Host of the server to delete. - * @returns {boolean} True if successful, and false otherwise. + * @remarks 2.25 GB + * @param host - Host of the server to delete. + * @returns True if successful, and false otherwise. */ deleteServer(host: Host): boolean; /** * Returns an array with either the hostnames or IPs of all of the servers you have purchased. * - * @ramCost 2.25 GB - * @param {boolean} [hostnameMode]. Optional. Defaults to true. Returns hostnames if true, and IPs if false. - * @returns {string[]} Returns an array with either the hostnames or IPs of all of the servers you have purchased. + * @remarks 2.25 GB + * @param hostnameMode -] Optional. Defaults to true. Returns hostnames if true, and IPs if false. + * @returns Returns an array with either the hostnames or IPs of all of the servers you have purchased. */ getPurchasedServers(hostnameMode?: boolean): Host[]; /** * Returns the maximum number of servers you can purchase. * - * @ramCost 0.05 GB - * @returns {number} Returns the maximum number of servers you can purchase. + * @remarks 0.05 GB + * @returns Returns the maximum number of servers you can purchase. */ getPurchasedServerLimit(): number; /** * Returns the maximum RAM that a purchased server can have. * - * @ramCost 0.05 GB - * @returns {number} Returns the maximum RAM that a purchased server can have. + * @remarks 0.05 GB + * @returns Returns the maximum RAM that a purchased server can have. */ getPurchasedServerMaxRam(): number; @@ -4372,10 +4605,10 @@ export interface NS extends Singularity { * then the data will be written in “append” mode which means that the data will be added at the * end of the text file. * - * @ramCost 1 GB - * @param {(string|number)} handle Port or text file that will be written to. - * @param {string} data Data to write. - * @param {string} mode Defines the write mode. Only valid when writing to text files. + * @remarks 1 GB + * @param handle - Port or text file that will be written to. + * @param data - Data to write. + * @param mode - Defines the write mode. Only valid when writing to text files. */ write(handle: Handle, data?: string | string[] | number, mode?: "w" | "a"): void; @@ -4384,10 +4617,10 @@ export interface NS extends Singularity { * If the port is full, the data will not be written. * Otherwise, the data will be written normally. * - * @ramCost 1 GB - * @param {number} port Port or text file that will be written to. - * @param {string} data Data to write. - * @returns {boolean} True if the data is successfully written to the port, and false otherwise. + * @remarks 1 GB + * @param port - Port or text file that will be written to. + * @param data - Data to write. + * @returns True if the data is successfully written to the port, and false otherwise. */ tryWrite(port: Handle, data: string | string[] | number): boolean; @@ -4403,9 +4636,9 @@ export interface NS extends Singularity { * file (.txt) and this function will return the data in the specified text * file. If the text file does not exist, an empty string will be returned. * - * @ramCost 1 GB - * @param {(string|number)} handle Port or text file to read from. - * @returns {(string|number|object)} Data in the specified text file or port. + * @remarks 1 GB + * @param handle - Port or text file to read from. + * @returns Data in the specified text file or port. */ read(handle: Handle): string | number | object; @@ -4414,9 +4647,9 @@ export interface NS extends Singularity { * first element in the specified port without removing that element. If * the port is empty, the string “NULL PORT DATA” will be returned. * - * @ramCost 1 GB - * @param {number} port Port to peek. Must be an integer between 1 and 20. - * @returns {(string|number|object)} Data in the specified port. + * @remarks 1 GB + * @param port - Port to peek. Must be an integer between 1 and 20. + * @returns Data in the specified port. */ peek(port: Port): string | number | object; @@ -4429,8 +4662,8 @@ export interface NS extends Singularity { * If the port/fn argument is a string, then it specifies the name of a * text file (.txt) and will delete all data from that text file. * - * @ramCost 1 GB - * @param {(string|number)} handle Port or text file to clear. + * @remarks 1 GB + * @param handle - Port or text file to clear. */ clear(handle: Handle): void; @@ -4440,9 +4673,9 @@ export interface NS extends Singularity { * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0. * * @see https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports - * @ramCost 10 GB - * @param {number} port Port number. Must be an integer between 1 and 20. - * @returns {Array} Data in the specified port. + * @remarks 10 GB + * @param port - Port number. Must be an integer between 1 and 20. + * @returns Data in the specified port. */ getPortHandle(port: Port): any[]; @@ -4450,10 +4683,10 @@ export interface NS extends Singularity { * Removes the specified file from the current server. This function works for every file * type except message (.msg) files. * - * @ramCost 1 GB - * @param {string} name Filename of file to remove. Must include the extension. - * @param {string} [host] Host or IP Address of the server on which to delete the file. Optional. Defaults to current server. - * @returns {boolean} True if it successfully deletes the file, and false otherwise. + * @remarks 1 GB + * @param name - Filename of file to remove. Must include the extension. + * @param host - Host or IP Address of the server on which to delete the file. Optional. Defaults to current server. + * @returns True if it successfully deletes the file, and false otherwise. */ rm(name: string, host?: Host): boolean; @@ -4461,23 +4694,23 @@ export interface NS extends Singularity { * Returns a boolean indicating whether any instance of the specified script is running * on the target server, regardless of its arguments. * - * This is different than the {@link isRunning} function because it does not try to + * This is different than the isRunning function because it does not try to * identify a specific instance of a running script by its arguments. * * @example - * \`\`\`js + * ```js * //The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise: * scriptRunning("foo.script", "foodnstuff"); - * \`\`\` + * ``` * @example - * \`\`\`js + * ```js * //The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise: * scriptRunning("foo.script", getHostname()); - * \`\`\` - * @ramCost 1 GB - * @param {string} script Filename of script to check. This is case-sensitive. - * @param {string} host Host or IP of target server. - * @returns {boolean} True if the specified script is running, and false otherwise. + * ``` + * @remarks 1 GB + * @param script - Filename of script to check. This is case-sensitive. + * @param host - Host or IP of target server. + * @returns True if the specified script is running, and false otherwise. */ scriptRunning(script: Script, host: Host): boolean; @@ -4485,18 +4718,18 @@ export interface NS extends Singularity { * Kills all scripts with the specified filename on the target server specified by hostname/ip, * regardless of arguments. * - * @ramCost 1 GB - * @param {string} script Filename of script to kill. This is case-sensitive. - * @param {string} host Host or IP of target server. - * @returns {boolean} true if one or more scripts were successfully killed, and false if none were. + * @remarks 1 GB + * @param script - Filename of script to kill. This is case-sensitive. + * @param host - Host or IP of target server. + * @returns true if one or more scripts were successfully killed, and false if none were. */ scriptKill(script: Script, host: Host): boolean; /** * Returns the current script name. * - * @ramCost 0 GB - * @returns {string} Current script name. + * @remarks 0 GB + * @returns Current script name. */ getScriptName(): string; @@ -4504,34 +4737,34 @@ export interface NS extends Singularity { * Returns the amount of RAM required to run the specified script on the target server. * Returns 0 if the script does not exist. * - * @ramCost 0.1 GB - * @param {string} script Filename of script. This is case-sensitive. - * @param {string} [host] Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. - * @returns {string} Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist. + * @remarks 0.1 GB + * @param script - Filename of script. This is case-sensitive. + * @param host - Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server. + * @returns Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist. */ getScriptRam(script: Script, host?: Host): number; /** - * Returns the amount of time in seconds it takes to execute the {@link hack} Netscript function on the target server. + * Returns the amount of time in seconds it takes to execute the hack Netscript function on the target server. * The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels. * - * @ramCost 0.05 GB - * @param {string} host Host or IP of target server. - * @param {number} [hackLvl] Optional hacking level for the calculation. Defaults to player’s current hacking level. - * @param {number} [intLvl] Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). - * @returns {number} Returns the amount of time in seconds it takes to execute the {@link hack} Netscript function. Returns Infinity if called on a Hacknet Server. + * @remarks 0.05 GB + * @param host - Host or IP of target server. + * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. + * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). + * @returns Returns the amount of time in seconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server. */ getHackTime(host: Host, hackLvl?: number, intLvl?: number): number; /** - * Returns the amount of time in seconds it takes to execute the {@link grow} Netscript function on the target server. + * Returns the amount of time in seconds it takes to execute the grow Netscript function on the target server. * The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels. * - * @ramCost 0.05 GB - * @param {string} host Host or IP of target server. - * @param {number} [hackLvl] Optional hacking level for the calculation. Defaults to player’s current hacking level. - * @param {number} [intLvl] Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). - * @returns {number} Returns the amount of time in seconds it takes to execute the {@link grow} Netscript function. Returns Infinity if called on a Hacknet Server. + * @remarks 0.05 GB + * @param host - Host or IP of target server. + * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. + * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). + * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. */ getGrowTime(host: Host, hackLvl?: number, intLvl?: number): number; @@ -4539,11 +4772,11 @@ export interface NS extends Singularity { * Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. * The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels. * - * @ramCost 0.05 GB - * @param {string} host Host or IP of target server. - * @param {number} [hackLvl] Optional hacking level for the calculation. Defaults to player’s current hacking level. - * @param {number} [intLvl] Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). - * @returns {number} Returns the amount of time in seconds it takes to execute the {@link grow} Netscript function. Returns Infinity if called on a Hacknet Server. + * @remarks 0.05 GB + * @param host - Host or IP of target server. + * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level. + * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5). + * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server. */ getWeakenTime(host: Host, hackLvl?: number, intLvl?: number): number; @@ -4562,11 +4795,11 @@ export interface NS extends Singularity { * The second value is the total income ($ / second) that you’ve earned from scripts * since you last installed Augmentations. * - * @ramCost 0.1 GB - * @param {string} script Filename of script. - * @param {string} host Server on which script is running. - * @param {string} [args] Arguments that the script is running with. - * @returns {(number|[number,number])} Amount of income the specified script generates while online. + * @remarks 0.1 GB + * @param script - Filename of script. + * @param host - Server on which script is running. + * @param args - Arguments that the script is running with. + * @returns Amount of income the specified script generates while online. */ getScriptIncome(script: Script, host: Host, ...args: string[]): number | [number, number]; @@ -4578,19 +4811,19 @@ export interface NS extends Singularity { * This function can also return the total experience gain rate of all of your active * scripts by running the function with no arguments. * - * @ramCost 0.1 GB - * @param {string} script Filename of script. - * @param {string} host Server on which script is running. - * @param {...string[]} [args] Arguments that the script is running with. - * @returns {number} Amount of hacking experience the specified script generates while online. + * @remarks 0.1 GB + * @param script - Filename of script. + * @param host - Server on which script is running. + * @param args - Arguments that the script is running with. + * @returns Amount of hacking experience the specified script generates while online. */ getScriptExpGain(script: Script, host: Host, ...args: string[]): number; /** * Returns the amount of time in milliseconds that have passed since you last installed Augmentations. * - * @ramCost 0.05 GB - * @returns {number} Time in milliseconds that have passed since you last installed Augmentations. + * @remarks 0.05 GB + * @returns Time in milliseconds that have passed since you last installed Augmentations. */ getTimeSinceLastAug(): number; @@ -4598,10 +4831,10 @@ export interface NS extends Singularity { * Complete open source JavaScript sprintf implementation * * @see https://github.com/alexei/sprintf.js - * @ramCost 0 GB - * @param {string} format String to format. - * @param {...string} args Formating arguments. - * @returns {string} Formated text. + * @remarks 0 GB + * @param format - String to format. + * @param args - Formating arguments. + * @returns Formated text. */ sprintf(format: string, ...args: string[]): string; @@ -4609,10 +4842,10 @@ export interface NS extends Singularity { * Complete open source JavaScript sprintf implementation * * @see https://github.com/alexei/sprintf.js - * @ramCost 0 GB - * @param {string} format String to format. - * @param {string[]} args Formating arguments. - * @returns {string} Formated text. + * @remarks 0 GB + * @param format - String to format. + * @param args - Formating arguments. + * @returns Formated text. */ vsprintf(format: string, args: string[]): string; @@ -4622,10 +4855,10 @@ export interface NS extends Singularity { * This is the same function that the game itself uses to display numbers. * * @see http://numeraljs.com/ - * @ramCost 0 GB - * @param {number} n Number to format. - * @param {string} format Formatter. - * @returns {string} Formated number. + * @remarks 0 GB + * @param n - Number to format. + * @param format - Formatter. + * @returns Formated number. */ nFormat(n: number, format: string): number; @@ -4635,9 +4868,9 @@ export interface NS extends Singularity { * the player clicks “No”. The script’s execution is halted until the player * selects one of the options. * - * @ramCost 0 GB - * @param {string} txt Text to appear in the prompt dialog box. - * @returns {Promise} True if the player click “Yes” and false if the player clicks “No”. + * @remarks 0 GB + * @param txt - Text to appear in the prompt dialog box. + * @returns True if the player click “Yes” and false if the player clicks “No”. */ prompt(txt: string): Promise; @@ -4660,22 +4893,22 @@ export interface NS extends Singularity { * you will not be able to process the returned value of wget in Netscript 1.0. * * @example - * \`\`\`js + * ```js * wget("https://raw.githubusercontent.com/danielyxie/bitburner/master/README.md", "game_readme.txt"); - * \`\`\` - * @ramCost 0 GB - * @param {string} url URL to pull data from. - * @param {string} target Filename to write data to. Must be script or text file. - * @param {string} [host] Optional hostname/ip of server for target file. - * @returns {Promise} True if the data was successfully retrieved from the URL, false otherwise. + * ``` + * @remarks 0 GB + * @param url - URL to pull data from. + * @param target - Filename to write data to. Must be script or text file. + * @param host - Optional hostname/ip of server for target file. + * @returns True if the data was successfully retrieved from the URL, false otherwise. */ wget(url: string, target: string, host?: string): Promise; /** * Returns the amount of Faction favor required to be able to donate to a faction. * - * @ramCost 0.1 GB - * @returns {number} Amount of Faction favor required to be able to donate to a faction. + * @remarks 0.1 GB + * @returns Amount of Faction favor required to be able to donate to a faction. */ getFavorToDonate(): number; @@ -4691,13 +4924,13 @@ export interface NS extends Singularity { * you would have received in BitNode-1. * * @example - * \`\`\`js + * ```js * mults = getBitNodeMultipliers(); * print(mults.ServerMaxMoney); * print(mults.HackExpGain); - * \`\`\` - * @ramCost 4 GB - * @returns {object} Object containing the current BitNode multipliers. + * ``` + * @remarks 4 GB + * @returns Object containing the current BitNode multipliers. */ getBitNodeMultipliers(url: string, target: string, host: string): BitNodeMultipliers; } diff --git a/src/ScriptEditor/ui/ScriptEditorRoot.tsx b/src/ScriptEditor/ui/ScriptEditorRoot.tsx index b9aa0cad4..4eed1293d 100644 --- a/src/ScriptEditor/ui/ScriptEditorRoot.tsx +++ b/src/ScriptEditor/ui/ScriptEditorRoot.tsx @@ -32,7 +32,7 @@ import TextField from "@mui/material/TextField"; import IconButton from "@mui/material/IconButton"; import SettingsIcon from "@mui/icons-material/Settings"; -import libSource from "!!raw-loader!../NetscriptDefinitions"; +import libSource from "!!raw-loader!../NetscriptDefinitions.d.ts"; let symbolsLoaded = false; let symbols: string[] = []; diff --git a/temp/bitburner.api.json b/temp/bitburner.api.json new file mode 100644 index 000000000..786ff350f --- /dev/null +++ b/temp/bitburner.api.json @@ -0,0 +1,20752 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.18.17", + "schemaVersion": 1004, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + } + } + }, + "kind": "Package", + "canonicalReference": "bitburner!", + "docComment": "", + "name": "bitburner", + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "bitburner!", + "name": "", + "members": [ + { + "kind": "Interface", + "canonicalReference": "bitburner!AugmentationStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface AugmentationStats " + } + ], + "releaseTag": "Public", + "name": "AugmentationStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#agility_exp_mult:member", + "docComment": "/**\n * Multipler to agility experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "agility_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#agility_mult:member", + "docComment": "/**\n * Multipler to agility skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "agility_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#bladeburner_analysis_mult:member", + "docComment": "/**\n * Multipler to effectiveness in Bladeburner Field Analysis\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bladeburner_analysis_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "bladeburner_analysis_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#bladeburner_max_stamina_mult:member", + "docComment": "/**\n * Multipler to Bladeburner max stamina\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bladeburner_max_stamina_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "bladeburner_max_stamina_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#bladeburner_stamina_gain_mult:member", + "docComment": "/**\n * Multipler to Bladeburner stamina gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bladeburner_stamina_gain_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "bladeburner_stamina_gain_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#bladeburner_success_chance_mult:member", + "docComment": "/**\n * Multipler to success chance in Bladeburner contracts/operations\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bladeburner_success_chance_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "bladeburner_success_chance_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#charisma_exp_mult:member", + "docComment": "/**\n * Multipler to charisma experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "charisma_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#charisma_mult:member", + "docComment": "/**\n * Multipler to charisma skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "charisma_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#company_rep_mult:member", + "docComment": "/**\n * Multipler to amount of reputation gained when working\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "company_rep_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "company_rep_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#crime_money_mult:member", + "docComment": "/**\n * Multipler to amount of money gained from crimes\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crime_money_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "crime_money_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#crime_success_mult:member", + "docComment": "/**\n * Multipler to crime success rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crime_success_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "crime_success_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#defense_exp_mult:member", + "docComment": "/**\n * Multipler to defense experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "defense_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#defense_mult:member", + "docComment": "/**\n * Multipler to defense skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "defense_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#dexterity_exp_mult:member", + "docComment": "/**\n * Multipler to dexterity experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "dexterity_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#dexterity_mult:member", + "docComment": "/**\n * Multipler to dexterity skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "dexterity_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#faction_rep_mult:member", + "docComment": "/**\n * Multipler to amount of reputation gained when working\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "faction_rep_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "faction_rep_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_chance_mult:member", + "docComment": "/**\n * Multipler to chance of successfully performing a hack\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_chance_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_chance_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_exp_mult:member", + "docComment": "/**\n * Multipler to hacking experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_grow_mult:member", + "docComment": "/**\n * Multipler to amount of money injected into servers using grow\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_grow_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_grow_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_money_mult:member", + "docComment": "/**\n * Multipler to amount of money the player gains from hacking\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_money_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_money_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_mult:member", + "docComment": "/**\n * Multipler to hacking skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacking_speed_mult:member", + "docComment": "/**\n * Multipler to hacking speed\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_speed_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacking_speed_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_core_cost_mult:member", + "docComment": "/**\n * Multipler to cost of core for a Hacknet Node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_core_cost_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_core_cost_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_level_cost_mult:member", + "docComment": "/**\n * Multipler to cost of leveling up a Hacknet Node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_level_cost_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_level_cost_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_money_mult:member", + "docComment": "/**\n * Multipler to amount of money produced by Hacknet Nodes\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_money_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_money_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_purchase_cost_mult:member", + "docComment": "/**\n * Multipler to cost of purchasing a Hacknet Node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_purchase_cost_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_purchase_cost_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#hacknet_node_ram_cost_mult:member", + "docComment": "/**\n * Multipler to cost of ram for a Hacknet Node\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacknet_node_ram_cost_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "hacknet_node_ram_cost_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#strength_exp_mult:member", + "docComment": "/**\n * Multipler to strength experience gain rate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength_exp_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "strength_exp_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#strength_mult:member", + "docComment": "/**\n * Multipler to strength skill\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "strength_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentationStats#work_money_mult:member", + "docComment": "/**\n * Multipler to amount of money gained from working\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "work_money_mult?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": true, + "releaseTag": "Public", + "name": "work_money_mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!AugmentName:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type AugmentName =\n " + }, + { + "kind": "Content", + "text": "| \"Augmented Targeting I\"\n | \"Augmented Targeting II\"\n | \"Augmented Targeting III\"\n | \"Synthetic Heart\"\n | \"Synfibril Muscle\"\n | \"Combat Rib I\"\n | \"Combat Rib II\"\n | \"Combat Rib III\"\n | \"Nanofiber Weave\"\n | \"NEMEAN Subdermal Weave\"\n | \"Wired Reflexes\"\n | \"Graphene Bone Lacings\"\n | \"Bionic Spine\"\n | \"Graphene Bionic Spine Upgrade\"\n | \"Bionic Legs\"\n | \"Graphene Bionic Legs Upgrade\"\n | \"Speech Processor Implant\"\n | \"TITN-41 Gene-Modification Injection\"\n | \"Enhanced Social Interaction Implant\"\n | \"BitWire\"\n | \"Artificial Bio-neural Network Implant\"\n | \"Artificial Synaptic Potentiation\"\n | \"Enhanced Myelin Sheathing\"\n | \"Synaptic Enhancement Implant\"\n | \"Neural-Retention Enhancement\"\n | \"DataJack\"\n | \"Embedded Netburner Module\"\n | \"Embedded Netburner Module Core Implant\"\n | \"Embedded Netburner Module Core V2 Upgrade\"\n | \"Embedded Netburner Module Core V3 Upgrade\"\n | \"Embedded Netburner Module Analyze Engine\"\n | \"Embedded Netburner Module Direct Memory Access Upgrade\"\n | \"Neuralstimulator\"\n | \"Neural Accelerator\"\n | \"Cranial Signal Processors - Gen I\"\n | \"Cranial Signal Processors - Gen II\"\n | \"Cranial Signal Processors - Gen III\"\n | \"Cranial Signal Processors - Gen IV\"\n | \"Cranial Signal Processors - Gen V\"\n | \"Neuronal Densification\"\n | \"Nuoptimal Nootropic Injector Implant\"\n | \"Speech Enhancement\"\n | \"FocusWire\"\n | \"PC Direct-Neural Interface\"\n | \"PC Direct-Neural Interface Optimization Submodule\"\n | \"PC Direct-Neural Interface NeuroNet Injector\"\n | \"ADR-V1 Pheromone Gene\"\n | \"ADR-V2 Pheromone Gene\"\n | \"The Shadow's Simulacrum\"\n | \"Hacknet Node CPU Architecture Neural-Upload\"\n | \"Hacknet Node Cache Architecture Neural-Upload\"\n | \"Hacknet Node NIC Architecture Neural-Upload\"\n | \"Hacknet Node Kernel Direct-Neural Interface\"\n | \"Hacknet Node Core Direct-Neural Interface\"\n | \"NeuroFlux Governor\"\n | \"Neurotrainer I\"\n | \"Neurotrainer II\"\n | \"Neurotrainer III\"\n | \"HyperSight Corneal Implant\"\n | \"LuminCloaking-V1 Skin Implant\"\n | \"LuminCloaking-V2 Skin Implant\"\n | \"HemoRecirculator\"\n | \"SmartSonar Implant\"\n | \"Power Recirculation Core\"\n | \"QLink\"\n | \"The Red Pill\"\n | \"SPTN-97 Gene Modification\"\n | \"ECorp HVMind Implant\"\n | \"CordiARC Fusion Reactor\"\n | \"SmartJaw\"\n | \"Neotra\"\n | \"Xanipher\"\n | \"nextSENS Gene Modification\"\n | \"OmniTek InfoLoad\"\n | \"Photosynthetic Cells\"\n | \"BitRunners Neurolink\"\n | \"The Black Hand\"\n | \"CRTX42-AA Gene Modification\"\n | \"Neuregen Gene Modification\"\n | \"CashRoot Starter Kit\"\n | \"NutriGen Implant\"\n | \"INFRARET Enhancement\"\n | \"DermaForce Particle Barrier\"\n | \"Graphene BranchiBlades Upgrade\"\n | \"Graphene Bionic Arms Upgrade\"\n | \"BrachiBlades\"\n | \"Bionic Arms\"\n | \"Social Negotiation Assistant (S.N.A)\"\n | \"EsperTech Bladeburner Eyewear\"\n | \"EMS-4 Recombination\"\n | \"ORION-MKIV Shoulder\"\n | \"Hyperion Plasma Cannon V1\"\n | \"Hyperion Plasma Cannon V2\"\n | \"GOLEM Serum\"\n | \"Vangelis Virus\"\n | \"Vangelis Virus 3.0\"\n | \"I.N.T.E.R.L.I.N.K.E.D\"\n | \"Blade's Runners\"\n | \"BLADE-51b Tesla Armor\"\n | \"BLADE-51b Tesla Armor: Power Cells Upgrade\"\n | \"BLADE-51b Tesla Armor: Energy Shielding Upgrade\"\n | \"BLADE-51b Tesla Armor: Unibeam Upgrade\"\n | \"BLADE-51b Tesla Armor: Omnibeam Upgrade\"\n | \"BLADE-51b Tesla Armor: IPU Upgrade\"\n | \"The Blade's Simulacrum\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "AugmentName", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!AugmentPair:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface AugmentPair " + } + ], + "releaseTag": "Public", + "name": "AugmentPair", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentPair#cost:member", + "docComment": "/**\n * augmentation cost\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!AugmentPair#name:member", + "docComment": "/**\n * augmentation name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!BasicHGWOptions:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BasicHGWOptions " + } + ], + "releaseTag": "Public", + "name": "BasicHGWOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BasicHGWOptions#threads:member", + "docComment": "/**\n * Number of threads to use for this function. Must be less than or equal to the number of threads the script is running with.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "threads", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!BitNodeMultipliers:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BitNodeMultipliers " + } + ], + "releaseTag": "Public", + "name": "BitNodeMultipliers", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#AgilityLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's agility level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "AgilityLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "AgilityLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#AugmentationMoneyCost:member", + "docComment": "/**\n * Influences the base cost to purchase an augmentation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "AugmentationMoneyCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "AugmentationMoneyCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#AugmentationRepCost:member", + "docComment": "/**\n * Influences the base rep the player must have with a faction to purchase an augmentation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "AugmentationRepCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "AugmentationRepCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#BladeburnerRank:member", + "docComment": "/**\n * Influences how quickly the player can gain rank within Bladeburner.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BladeburnerRank: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "BladeburnerRank", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#BladeburnerSkillCost:member", + "docComment": "/**\n * Influences the cost of skill levels from Bladeburner.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BladeburnerSkillCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "BladeburnerSkillCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CharismaLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's charisma level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CharismaLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CharismaLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ClassGymExpGain:member", + "docComment": "/**\n * Influences the experience gained for each ability when a player completes a class.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ClassGymExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ClassGymExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CodingContractMoney:member", + "docComment": "/**\n * Influences the amount of money gained from completing Coding Contracts\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CodingContractMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CodingContractMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CompanyWorkExpGain:member", + "docComment": "/**\n * Influences the experience gained for each ability when the player completes working their job.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CompanyWorkExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CompanyWorkExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CompanyWorkMoney:member", + "docComment": "/**\n * Influences how much money the player earns when completing working their job.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CompanyWorkMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CompanyWorkMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CorporationValuation:member", + "docComment": "/**\n * Influences the valuation of corporations created by the player.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CorporationValuation: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CorporationValuation", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CrimeExpGain:member", + "docComment": "/**\n * Influences the base experience gained for each ability when the player commits a crime.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CrimeExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CrimeExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#CrimeMoney:member", + "docComment": "/**\n * Influences the base money gained when the player commits a crime.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "CrimeMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "CrimeMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#DaedalusAugsRequirement:member", + "docComment": "/**\n * Influences how many Augmentations you need in order to get invited to the Daedalus faction\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DaedalusAugsRequirement: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "DaedalusAugsRequirement", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#DefenseLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's defense level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DefenseLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "DefenseLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#DexterityLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's dexterity level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DexterityLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "DexterityLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FactionPassiveRepGain:member", + "docComment": "/**\n * Influences how much rep the player gains in each faction simply by being a member.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FactionPassiveRepGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FactionPassiveRepGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FactionWorkExpGain:member", + "docComment": "/**\n * Influences the experience gained for each ability when the player completes work for a Faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FactionWorkExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FactionWorkExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FactionWorkRepGain:member", + "docComment": "/**\n * Influences how much rep the player gains when performing work for a faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FactionWorkRepGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FactionWorkRepGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FourSigmaMarketDataApiCost:member", + "docComment": "/**\n * Influences how much it costs to unlock the stock market's 4S Market Data API\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FourSigmaMarketDataApiCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FourSigmaMarketDataApiCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#FourSigmaMarketDataCost:member", + "docComment": "/**\n * Influences how much it costs to unlock the stock market's 4S Market Data (NOT API)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FourSigmaMarketDataCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "FourSigmaMarketDataCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#HackExpGain:member", + "docComment": "/**\n * Influences the experienced gained when hacking a server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HackExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HackExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#HackingLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's hacking level (not experience) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HackingLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HackingLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#HacknetNodeMoney:member", + "docComment": "/**\n * Influences how much money is produced by Hacknet Nodes and the hash rate of Hacknet Servers (unlocked in BitNode-9)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HacknetNodeMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HacknetNodeMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#HomeComputerRamCost:member", + "docComment": "/**\n * Influences how much money it costs to upgrade your home computer's RAM\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "HomeComputerRamCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "HomeComputerRamCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#InfiltrationMoney:member", + "docComment": "/**\n * Influences how much money is gained when the player infiltrates a company.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "InfiltrationMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "InfiltrationMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#InfiltrationRep:member", + "docComment": "/**\n * Influences how much rep the player can gain from factions when selling stolen documents and secrets\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "InfiltrationRep: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "InfiltrationRep", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ManualHackMoney:member", + "docComment": "/**\n * Influences how much money can be stolen from a server when the player performs a hack against it through the Terminal.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ManualHackMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ManualHackMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#PurchasedServerCost:member", + "docComment": "/**\n * Influence how much it costs to purchase a server\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchasedServerCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchasedServerCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#PurchasedServerLimit:member", + "docComment": "/**\n * Influences the maximum number of purchased servers you can have\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchasedServerLimit: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchasedServerLimit", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#PurchasedServerMaxRam:member", + "docComment": "/**\n * Influences the maximum allowed RAM for a purchased server\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PurchasedServerMaxRam: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "PurchasedServerMaxRam", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#RepToDonateToFaction:member", + "docComment": "/**\n * Influences the minimum favor the player must have with a faction before they can donate to gain rep.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "RepToDonateToFaction: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "RepToDonateToFaction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ScriptHackMoney:member", + "docComment": "/**\n * Influences how much money can be stolen from a server when a script performs a hack against it.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ScriptHackMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ScriptHackMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerGrowthRate:member", + "docComment": "/**\n * Influences the growth percentage per cycle against a server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerGrowthRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerGrowthRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerMaxMoney:member", + "docComment": "/**\n * Influences the maxmimum money that a server can grow to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerMaxMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerMaxMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerStartingMoney:member", + "docComment": "/**\n * Influences the initial money that a server starts with.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerStartingMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerStartingMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerStartingSecurity:member", + "docComment": "/**\n * Influences the initial security level (hackDifficulty) of a server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerStartingSecurity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerStartingSecurity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#ServerWeakenRate:member", + "docComment": "/**\n * Influences the weaken amount per invocation against a server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ServerWeakenRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ServerWeakenRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BitNodeMultipliers#StrengthLevelMultiplier:member", + "docComment": "/**\n * Influences how quickly the player's strength level (not exp) scales\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "StrengthLevelMultiplier: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "StrengthLevelMultiplier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Bladeburner:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface Bladeburner " + } + ], + "releaseTag": "Public", + "name": "Bladeburner", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionAutolevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Return a boolean indicating whether or not this action is currently set to autolevel.\n *\n * Returns false if an invalid action is specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns True if the action is set to autolevel, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionAutolevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionAutolevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionCountRemaining:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the remaining count of the specified action.\n *\n * Note that this is meant to be used for Contracts and Operations. This function will return ‘Infinity’ for actions such as Training and Field Analysis. This function will return 1 for BlackOps not yet completed regardless of wether the player has the required rank to attempt the mission or not.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Remaining count of the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionCountRemaining(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionCountRemaining" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionCurrentLevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the current level of this action.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Current level of the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionCurrentLevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionCurrentLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionEstimatedSuccessChance:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated success chance for the specified action. This chance is returned as a decimal value, NOT a percentage (e.g. if you have an estimated success chance of 80%, then this function will return 0.80, NOT 80).\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Estimated success chance for the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionEstimatedSuccessChance(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionEstimatedSuccessChance" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionMaxLevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the maximum level for this action.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Maximum level of the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionMaxLevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionMaxLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionRepGain:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the average Bladeburner reputation gain for successfully completing the specified action. Note that this value is an ‘average’ and the real reputation gain may vary slightly from this value.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param level - Optional action level at which to calculate the gain\n *\n * @returns Average Bladeburner reputation gain for successfully completing the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionRepGain(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n level: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + }, + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ], + "name": "getActionRepGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getActionTime:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of seconds it takes to complete the specified action\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Number of seconds it takes to complete the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getActionTime(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getActionTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getBlackOpNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner Black Ops.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner Black Ops.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBlackOpNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getBlackOpNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getBlackOpRank:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the rank required to complete this BlackOp.\n *\n * Returns -1 if an invalid action is specified.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param name - Name of BlackOp. Must be an exact match.\n *\n * @returns Rank required to complete this BlackOp.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBlackOpRank(name: " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getBlackOpRank" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getBonusTime:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.\n *\n * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.\n *\n * “Bonus time” makes the game progress faster, up to 5x the normal speed. For example, if an action takes 30 seconds to complete but you’ve accumulated over 30 seconds in bonus time, then the action will only take 6 seconds in real life to complete.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Amount of accumulated “bonus time” (seconds) for the Bladeburner mechanic.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBonusTime(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getBonusTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCity:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the city that the player is currently in (for Bladeburner).\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns City that the player is currently in (for Bladeburner).\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCity(): " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getCity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCityChaos:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the chaos in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Chaos in the specified city.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCityChaos(name: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCityChaos" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCityCommunities:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated number of Synthoid communities in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Number of Synthoids communities in the specified city.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCityCommunities(name: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCityCommunities" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCityEstimatedPopulation:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the estimated number of Synthoids in the specified city, or -1 if an invalid city was specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns Estimated number of Synthoids in the specified city.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCityEstimatedPopulation(name: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCityEstimatedPopulation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getContractNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner contracts.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner contracts.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getContractNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getContractNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getCurrentAction:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an object that represents the player’s current Bladeburner action. If the player is not performing an action, the function will return an object with the ‘type’ property set to “Idle”.\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns Object that represents the player’s current Bladeburner action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCurrentAction(): " + }, + { + "kind": "Reference", + "text": "BladeburnerCurAction", + "canonicalReference": "bitburner!BladeburnerCurAction:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getCurrentAction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getGeneralActionNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all general Bladeburner actions.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all general Bladeburner actions.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGeneralActionNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getGeneralActionNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getOperationNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all Bladeburner operations.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all Bladeburner operations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOperationNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getOperationNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getRank:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the player’s Bladeburner Rank.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Player’s Bladeburner Rank.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getRank(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getRank" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getSkillLevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * This function returns your level in the specified skill.\n *\n * The function returns -1 if an invalid skill name is passed in.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param skillName - Name of skill. Case-sensitive and must be an exact match\n *\n * @returns Level in the specified skill.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSkillLevel(name: " + }, + { + "kind": "Reference", + "text": "BladeburnerSkills", + "canonicalReference": "bitburner!BladeburnerSkills:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSkillLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getSkillNames:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array of strings containing the names of all general Bladeburner skills.\n *\n * @remarks\n *\n * 0.4 GB\n *\n * @returns Array of strings containing the names of all general Bladeburner skills.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSkillNames(): " + }, + { + "kind": "Reference", + "text": "BladeburnerSkills", + "canonicalReference": "bitburner!BladeburnerSkills:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getSkillNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getSkillPoints:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of Bladeburner skill points you have.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Number of Bladeburner skill points you have.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSkillPoints(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getSkillPoints" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getSkillUpgradeCost:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * This function returns the number of skill points needed to upgrade the specified skill.\n *\n * The function returns -1 if an invalid skill name is passed in.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param skillName - Name of skill. Case-sensitive and must be an exact match\n *\n * @returns Number of skill points needed to upgrade the specified skill.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSkillUpgradeCost(name: " + }, + { + "kind": "Reference", + "text": "BladeburnerSkills", + "canonicalReference": "bitburner!BladeburnerSkills:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSkillUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getStamina:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns an array with two elements: * [Current stamina, Max stamina]\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Array containing current stamina and max stamina.\n *\n * @example\n * ```js\n * function getStaminaPercentage() {\n * let res = bladeburner.getStamina();\n * return res[0] / res[1];\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getStamina(): " + }, + { + "kind": "Content", + "text": "[number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getStamina" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#getTeamSize:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Returns the number of Bladeburner team members you have assigned to the specified action.\n *\n * Setting a team is only applicable for Operations and BlackOps. This function will return 0 for other action types.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @returns Number of Bladeburner team members that were assigned to the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTeamSize(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "getTeamSize" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#joinBladeburnerDivision:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to join the Bladeburner division.\n *\n * Returns true if you successfully join the Bladeburner division, or if you are already a member.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns True if you successfully join the Bladeburner division, or if you are already a member, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "joinBladeburnerDivision(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "joinBladeburnerDivision" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#joinBladeburnerFaction:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to join the Bladeburner faction.\n *\n * Returns true if you successfully join the Bladeburner faction, or if you are already a member.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns True if you successfully join the Bladeburner faction, or if you are already a member, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "joinBladeburnerFaction(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "joinBladeburnerFaction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#setActionAutolevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Enable/disable autoleveling for the specified action.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param autoLevel - Whether or not to autolevel this action\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setActionAutolevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n autoLevel: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + }, + { + "parameterName": "autoLevel", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ], + "name": "setActionAutolevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#setActionLevel:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Set the level for the specified action.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param level - Level to set this action to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setActionLevel(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n level: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + }, + { + "parameterName": "level", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ], + "name": "setActionLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#setTeamSize:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Set the team size for the specified Bladeburner action.\n *\n * Returns the team size that was set, or -1 if the function failed.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match.\n *\n * @param size - Number of team members to set. Will be converted using Math.round().\n *\n * @returns Number of Bladeburner team members you assigned to the specified action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTeamSize(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n size: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 13, + "endIndex": 14 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + }, + { + "parameterName": "size", + "parameterTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + } + } + ], + "name": "setTeamSize" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#startAction:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to start the specified Bladeburner action. Returns true if the action was started successfully, and false otherwise.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param type - Type of action.\n *\n * @param name - Name of action. Must be an exact match\n *\n * @returns True if the action was started successfully, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "startAction(\n type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": ",\n name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 10 + } + } + ], + "name": "startAction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#stopBladeburnerAction:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Stops the current Bladeburner action.\n *\n * @remarks\n *\n * 2 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopBladeburnerAction(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "stopBladeburnerAction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#switchCity:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to switch to the specified city (for Bladeburner only).\n *\n * Returns true if successful, and false otherwise\n *\n * @remarks\n *\n * 4 GB\n *\n * @param cityName - Name of city. Case-sensitive\n *\n * @returns true if successful, and false otherwise\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "switchCity(name: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "switchCity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Bladeburner#upgradeSkill:member(1)", + "docComment": "/**\n * You have to be employed in the Bladeburner division and be in BitNode-7 or have Source-File 7 in order to use this function.\n *\n * Attempts to upgrade the specified Bladeburner skill.\n *\n * Returns true if the skill is successfully upgraded, and false otherwise.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param skillName - Name of skill to be upgraded. Case-sensitive and must be an exact match\n *\n * @returns true if the skill is successfully upgraded, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeSkill(name: " + }, + { + "kind": "Reference", + "text": "BladeburnerSkills", + "canonicalReference": "bitburner!BladeburnerSkills:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "upgradeSkill" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerActTypes:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerActTypes = " + }, + { + "kind": "Content", + "text": "\"contracts\" | \"operations\" | \"black ops\" | \"general\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerActTypes", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerBlackOps:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerBlackOps =\n " + }, + { + "kind": "Content", + "text": "| \"Operation Typhoon\"\n | \"Operation Zero\"\n | \"Operation X\"\n | \"Operation Titan\"\n | \"Operation Ares\"\n | \"Operation Archangel\"\n | \"Operation Juggernaut\"\n | \"Operation Red Dragon\"\n | \"Operation K\"\n | \"Operation Deckard\"\n | \"Operation Tyrell\"\n | \"Operation Wallace\"\n | \"Operation Shoulder of Orion\"\n | \"Operation Hyron\"\n | \"Operation Morpheus\"\n | \"Operation Ion Storm\"\n | \"Operation Annihilus\"\n | \"Operation Ultron\"\n | \"Operation Centurion\"\n | \"Operation Vindictus\"\n | \"Operation Daedalus\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerBlackOps", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerContracts:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerContracts = " + }, + { + "kind": "Content", + "text": "\"Tracking\" | \"Bounty Hunter\" | \"Retirement\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerContracts", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!BladeburnerCurAction:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BladeburnerCurAction " + } + ], + "releaseTag": "Public", + "name": "BladeburnerCurAction", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BladeburnerCurAction#name:member", + "docComment": "/**\n * Name of Action\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Reference", + "text": "BladeburnerGenActions", + "canonicalReference": "bitburner!BladeburnerGenActions:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerContracts", + "canonicalReference": "bitburner!BladeburnerContracts:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerOperations", + "canonicalReference": "bitburner!BladeburnerOperations:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "BladeburnerBlackOps", + "canonicalReference": "bitburner!BladeburnerBlackOps:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!BladeburnerCurAction#type:member", + "docComment": "/**\n * Type of Action\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "BladeburnerActTypes", + "canonicalReference": "bitburner!BladeburnerActTypes:type" + }, + { + "kind": "Content", + "text": " | \"Idle\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerGenActions:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerGenActions =\n " + }, + { + "kind": "Content", + "text": "| \"Training\"\n | \"Field Analysis\"\n | \"Recruitment\"\n | \"Diplomacy\"\n | \"Hyperbolic Regeneration Chamber\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerGenActions", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerOperations:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerOperations =\n " + }, + { + "kind": "Content", + "text": "| \"Investigation\"\n | \"Undercover Operation\"\n | \"Sting Operation\"\n | \"Raid\"\n | \"Stealth Retirement Operation\"\n | \"Assassination\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerOperations", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!BladeburnerSkills:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type BladeburnerSkills =\n " + }, + { + "kind": "Content", + "text": "| \"Blade's Intuition\"\n | \"Cloak\"\n | \"Marksman\"\n | \"Weapon Proficiency\"\n | \"Short-Circuit\"\n | \"Digital Observer\"\n | \"Tracer\"\n | \"Overclock\"\n | \"Reaper\"\n | \"Evasive System\"\n | \"Datamancer\"\n | \"Cyber's Edge\"\n | \"Hands of Midas\"\n | \"Hyperdrive\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "BladeburnerSkills", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CharacterInfo:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CharacterInfo " + } + ], + "releaseTag": "Public", + "name": "CharacterInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#bitnode:member", + "docComment": "/**\n * Current BitNode number\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "bitnode: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "bitnode", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#city:member", + "docComment": "/**\n * Name of city you are currently in\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "city: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "city", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#company:member", + "docComment": "/**\n * Array of all companies at which you have jobs\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "company: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "company", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#factions:member", + "docComment": "/**\n * Array of factions you are currently a member of\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "factions: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "factions", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#hp:member", + "docComment": "/**\n * Current health points\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#jobTitle:member", + "docComment": "/**\n * Array of job positions for all companies you are employed at. Same order as 'jobs'\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "jobTitle: " + }, + { + "kind": "Reference", + "text": "CompanyField", + "canonicalReference": "bitburner!CompanyField:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "jobTitle", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#maxHp:member", + "docComment": "/**\n * Maximum health points\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxHp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "maxHp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#mult:member", + "docComment": "/**\n * Object with many of the player's multipliers from Augmentations/Source Files\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mult: " + }, + { + "kind": "Reference", + "text": "CharacterMult", + "canonicalReference": "bitburner!CharacterMult:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#timeWorked:member", + "docComment": "/**\n * Timed worked in ms\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeWorked: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "timeWorked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#tor:member", + "docComment": "/**\n * Boolean indicating whether or not you have a tor router\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tor: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "tor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workAgiExpGain:member", + "docComment": "/**\n * Agi experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workAgiExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workAgiExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workChaExpGain:member", + "docComment": "/**\n * Cha experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workChaExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workChaExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workDefExpGain:member", + "docComment": "/**\n * Def experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workDefExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workDefExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workDexExpGain:member", + "docComment": "/**\n * Dex experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workDexExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workDexExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workHackExpGain:member", + "docComment": "/**\n * Hacking experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workHackExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workHackExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workMoneyGain:member", + "docComment": "/**\n * Money earned so far from work, if applicable\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workMoneyGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workMoneyGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workRepGain:member", + "docComment": "/**\n * Reputation earned so far from work, if applicable\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workRepGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workRepGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterInfo#workStrExpGain:member", + "docComment": "/**\n * Str experience earned so far from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workStrExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workStrExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CharacterMult:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CharacterMult " + } + ], + "releaseTag": "Public", + "name": "CharacterMult", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#agility:member", + "docComment": "/**\n * Agility stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#agilityExp:member", + "docComment": "/**\n * Agility exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agilityExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agilityExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#companyRep:member", + "docComment": "/**\n * Company reputation\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "companyRep: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "companyRep", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#crimeMoney:member", + "docComment": "/**\n * Money earned from crimes\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crimeMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "crimeMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#crimeSuccess:member", + "docComment": "/**\n * Crime success chance\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crimeSuccess: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "crimeSuccess", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#defense:member", + "docComment": "/**\n * Defense stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#defenseExp:member", + "docComment": "/**\n * Defense exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defenseExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defenseExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#dexterity:member", + "docComment": "/**\n * Dexterity stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#dexterityExp:member", + "docComment": "/**\n * Dexterity exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterityExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterityExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#factionRep:member", + "docComment": "/**\n * Faction reputation\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "factionRep: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "factionRep", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#hacking:member", + "docComment": "/**\n * Hacking stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#hackingExp:member", + "docComment": "/**\n * Hacking exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackingExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackingExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#strength:member", + "docComment": "/**\n * Strength stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#strengthExp:member", + "docComment": "/**\n * Strength exp\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strengthExp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strengthExp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CharacterMult#workMoney:member", + "docComment": "/**\n * Money earned from jobs\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!City:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type City = " + }, + { + "kind": "Content", + "text": "\"Aevum\" | \"Chongqing\" | \"Sector-12\" | \"New Tokyo\" | \"Ishima\" | \"Volhaven\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "City", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CodingAttemptOptions:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CodingAttemptOptions " + } + ], + "releaseTag": "Public", + "name": "CodingAttemptOptions", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CodingAttemptOptions#returnReward:member", + "docComment": "/**\n * If truthy, then the function will return a string that states the contract’s reward when it is successfully solved.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "returnReward: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "returnReward", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CodingContract:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CodingContract " + } + ], + "releaseTag": "Public", + "name": "CodingContract", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#attempt:member(1)", + "docComment": "/**\n * Attempts to solve the Coding Contract with the provided solution.\n *\n * @remarks\n *\n * 10 GB\n *\n * @param answer - Solution for the contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns True if the solution was correct, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "attempt(answer: " + }, + { + "kind": "Content", + "text": "string | string[] | number" + }, + { + "kind": "Content", + "text": ", fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "answer", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "attempt" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#attempt:member(2)", + "docComment": "/**\n * Attempts to solve the Coding Contract with the provided solution.\n *\n * @remarks\n *\n * 10 GB\n *\n * @param answer - Solution for the contract.\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns True if the solution was correct, false otherwise. If the returnReward option is configured, then the function will instead return a string. If the contract is successfully solved, the string will contain a description of the contract’s reward. Otherwise, it will be an empty string.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "attempt(answer: " + }, + { + "kind": "Content", + "text": "string | string[] | number" + }, + { + "kind": "Content", + "text": ", fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", opts?: " + }, + { + "kind": "Reference", + "text": "CodingAttemptOptions", + "canonicalReference": "bitburner!CodingAttemptOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean | string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "answer", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ], + "name": "attempt" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#getContractType:member(1)", + "docComment": "/**\n * Returns a name describing the type of problem posed by the Coding Contract. (e.g. Find Largest Prime Factor, Total Ways to Sum, etc.)\n *\n * @remarks\n *\n * 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns Name describing the type of problem posed by the Coding Contract.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getContractType(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CodingContractTypes", + "canonicalReference": "bitburner!CodingContractTypes:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getContractType" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#getData:member(1)", + "docComment": "/**\n * Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve\n *\n * @remarks\n *\n * 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns The specified contract’s data;\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getData(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getData" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#getDescription:member(1)", + "docComment": "/**\n * Get the full text description for the problem posed by the Coding Contract.\n *\n * @remarks\n *\n * 5 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns Contract’s text description.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getDescription(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getDescription" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!CodingContract#getNumTriesRemaining:member(1)", + "docComment": "/**\n * Get the number of tries remaining on the contract before it self-destructs.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param fn - Filename of the contract.\n *\n * @param host - Host or IP of the server containing the contract. Optional. Defaults to current server if not provided.\n *\n * @returns How many attempts are remaining for the contract;\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getNumTriesRemaining(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getNumTriesRemaining" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!CodingContractTypes:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CodingContractTypes =\n " + }, + { + "kind": "Content", + "text": "| \"Find Largest Prime Factor\"\n | \"Subarray with Maximum Sum\"\n | \"Total Ways to Sum\"\n | \"Spiralize Matrix\"\n | \"Array Jumping Game\"\n | \"Merge Overlapping Intervals\"\n | \"Generate IP Addresses\"\n | \"Algorithmic Stock Trader I\"\n | \"Algorithmic Stock Trader II\"\n | \"Algorithmic Stock Trader III\"\n | \"Algorithmic Stock Trader IV\"\n | \"Minimum Path Sum in a Triangle\"\n | \"Unique Paths in a Grid I\"\n | \"Unique Paths in a Grid II\"\n | \"Sanitize Parentheses in Expression\"\n | \"Find All Valid Math Expressions\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CodingContractTypes", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!CompanyField:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CompanyField =\n " + }, + { + "kind": "Content", + "text": "| \"software\"\n | \"software consultant\"\n | \"it\"\n | \"security engineer\"\n | \"network engineer\"\n | \"business\"\n | \"business consultant\"\n | \"security\"\n | \"agent\"\n | \"employee\"\n | \"part-time employee\"\n | \"waiter\"\n | \"part-time waiter\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CompanyField", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!CompanyName:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CompanyName =\n // Sector-12\n " + }, + { + "kind": "Content", + "text": "| \"MegaCorp\"\n | \"BladeIndustries\"\n | \"FourSigma\"\n | \"IcarusMicrosystems\"\n | \"UniversalEnergy\"\n | \"DeltaOne\"\n | \"CIA\"\n | \"NSA\"\n | \"AlphaEnterprises\"\n | \"CarmichaelSecurity\"\n | \"FoodNStuff\"\n | \"JoesGuns\"\n\n // Aevum\n | \"ECorp\"\n | \"BachmanAndAssociates\"\n | \"ClarkeIncorporated\"\n | \"OmniTekIncorporated\"\n | \"FulcrumTechnologies\"\n | \"GalacticCybersystems\"\n | \"AeroCorp\"\n | \"WatchdogSecurity\"\n | \"RhoConstruction\"\n | \"AevumPolice\"\n | \"NetLinkTechnologies\"\n\n // Volhaven\n | \"NWO\"\n | \"HeliosLabs\"\n | \"OmniaCybersystems\"\n | \"LexoCorp\"\n | \"SysCoreSecurities\"\n | \"CompuTek\"\n\n // Chongqing\n | \"KuaiGongInternational\"\n | \"SolarisSpaceSystems\"\n\n // Ishima\n | \"StormTechnologies\"\n | \"NovaMedical\"\n | \"OmegaSoftware\"\n\n // New Tokyo\n | \"DefComm\"\n | \"VitaLife\"\n | \"GlobalPharmaceuticals\"\n | \"NoodleBar\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CompanyName", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!CreatableProgram:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CreatableProgram = " + }, + { + "kind": "Reference", + "text": "PurchaseableProgram", + "canonicalReference": "bitburner!PurchaseableProgram:type" + }, + { + "kind": "Content", + "text": " | \"serverprofiler.exe\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "CreatableProgram", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Crime:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Crime =\n " + }, + { + "kind": "Content", + "text": "| \"shoplift\"\n | \"rob store\"\n | \"mug\"\n | \"larceny\"\n | \"deal drugs\"\n | \"bond forgery\"\n | \"traffick arms\"\n | \"homicide\"\n | \"grand theft auto\"\n | \"kidnap\"\n | \"assassinate\"\n | \"heist\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Crime", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!CrimeStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface CrimeStats " + } + ], + "releaseTag": "Public", + "name": "CrimeStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#agility_exp:member", + "docComment": "/**\n * agility exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#agility_success_weight:member", + "docComment": "/**\n * agility level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#charisma_exp:member", + "docComment": "/**\n * charisma exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#charisma_success_weight:member", + "docComment": "/**\n * charisma level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#defense_exp:member", + "docComment": "/**\n * defense exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#defense_success_weight:member", + "docComment": "/**\n * defense level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#dexterity_exp:member", + "docComment": "/**\n * dexterity exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#dexterity_success_weight:member", + "docComment": "/**\n * dexterity level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#difficulty:member", + "docComment": "/**\n * Number representing the difficulty of the crime. Used for success chance calculations\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "difficulty: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "difficulty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#hacking_exp:member", + "docComment": "/**\n * hacking exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#hacking_success_weight:member", + "docComment": "/**\n * hacking level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#intelligence_exp:member", + "docComment": "/**\n * intelligence exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "intelligence_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "intelligence_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#karma:member", + "docComment": "/**\n * Amount of karma lost for SUCCESSFULLY committing this crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "karma: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "karma", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#kills:member", + "docComment": "/**\n * How many people die as a result of this crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "kills: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "kills", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#money:member", + "docComment": "/**\n * How much money is given\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "money: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "money", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#name:member", + "docComment": "/**\n * Name of crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#strength_exp:member", + "docComment": "/**\n * strength exp gained from crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength_exp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength_exp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#strength_success_weight:member", + "docComment": "/**\n * strength level impact on success change of the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength_success_weight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength_success_weight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#time:member", + "docComment": "/**\n * Milliseconds it takes to attempt the crime\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "time: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "time", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!CrimeStats#type:member", + "docComment": "/**\n * Description of the crime activity\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!FactionName:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type FactionName =\n " + }, + { + "kind": "Content", + "text": "| \"Illuminati\"\n | \"Daedalus\"\n | \"The Covenant\"\n | \"ECorp\"\n | \"MegaCorp\"\n | \"Bachman & Associates\"\n | \"Blade Industries\"\n | \"NWO\"\n | \"Clarke Incorporated\"\n | \"OmniTek Incorporated\"\n | \"Four Sigma\"\n | \"KuaiGong International\"\n | \"Fulcrum Secret Technologies\"\n | \"BitRunners\"\n | \"The Black Hand\"\n | \"NiteSec\"\n | \"Aevum\"\n | \"Chongqing\"\n | \"Ishima\"\n | \"New Tokyo\"\n | \"Sector-12\"\n | \"Volhaven\"\n | \"Speakers for the Dead\"\n | \"The Dark Army\"\n | \"The Syndicate\"\n | \"Silhouette\"\n | \"Tetrads\"\n | \"Slum Snakes\"\n | \"Netburners\"\n | \"Tian Di Hui\"\n | \"CyberSec\"\n | \"Bladeburners\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FactionName", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!FactionWork:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type FactionWork = " + }, + { + "kind": "Content", + "text": "\"hacking\" | \"field\" | \"security\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "FactionWork", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Gang:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Gang " + } + ], + "releaseTag": "Public", + "name": "Gang", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#ascendMember:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Ascend the specified Gang Member.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param memberName - Name of member to ascend.\n *\n * @returns Object with info about the ascension results.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ascendMember(memberName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangMemberAscension", + "canonicalReference": "bitburner!GangMemberAscension:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "memberName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "ascendMember" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#canRecruitMember:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns boolean indicating whether a member can currently be recruited\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns True if a member can currently be recruited, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "canRecruitMember(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "canRecruitMember" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getBonusTime:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns the amount of accumulated “bonus time” (seconds) for the Gang mechanic.\n *\n * “Bonus time” is accumulated when the game is offline or if the game is inactive in the browser.\n *\n * “Bonus time” makes the game progress faster, up to 10x the normal speed.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Bonus time for the Gang mechanic in seconds.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBonusTime(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getBonusTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getChanceToWinClash:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Returns the chance you have to win a clash with the specified gang. The chance is returned in decimal form, not percentage\n *\n * @remarks\n *\n * 4 GB\n *\n * @param gangName - Target gang\n *\n * @returns Chance you have to win a clash with the specified gang.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getChanceToWinClash(gangName: " + }, + { + "kind": "Reference", + "text": "GangName", + "canonicalReference": "bitburner!GangName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "gangName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getChanceToWinClash" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getEquipmentCost:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the amount of money it takes to purchase a piece of Equipment or an Augmentation. If an invalid Equipment/Augmentation is specified, this function will return Infinity.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns Cost to purchase the specified Equipment/Augmentation (number). Infinity for invalid arguments\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getEquipmentCost(equipName: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "equipName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "name": "getEquipmentCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getEquipmentNames:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the name of all possible equipment/upgrades you can purchase for your Gang Members. This includes Augmentations.\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns Names of all Equpiment/Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getEquipmentNames(): " + }, + { + "kind": "Content", + "text": "(" + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": ")[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getEquipmentNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getEquipmentStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the specified equipment stats.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns A dictionary containing the stats of the equipment.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getEquipmentStats(equipName: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangEquipmentStats", + "canonicalReference": "bitburner!GangEquipmentStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "equipName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "name": "getEquipmentStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getEquipmentType:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the specified equipment type.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param equipName - Name of equipment.\n *\n * @returns Type of the equipment.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getEquipmentType(equipName: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangEquipmentType", + "canonicalReference": "bitburner!GangEquipmentType:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "equipName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + } + ], + "name": "getEquipmentType" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getGangInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get general information about the gang.\n *\n * @remarks\n *\n * 2 GB\n *\n * @returns Object containing general information about the gang.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGangInformation(): " + }, + { + "kind": "Reference", + "text": "GangGenInfo", + "canonicalReference": "bitburner!GangGenInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getGangInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getMemberInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get stat and equipment-related information about a Gang Member\n *\n * @remarks\n *\n * 2 GB\n *\n * @param name - Name of member.\n *\n * @returns Object containing stat and equipment-related information about a Gang Member.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getMemberInformation(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangMemberInfo", + "canonicalReference": "bitburner!GangMemberInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getMemberInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getMemberNames:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the names of all Gang members\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns Names of all Gang members.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getMemberNames(): " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getMemberNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getOtherGangInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get territory and power information about all gangs.\n *\n * @remarks\n *\n * 2 GB\n *\n * @returns Object containing territory and power information about all gangs.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOtherGangInformation(): " + }, + { + "kind": "Reference", + "text": "GangOtherInfo", + "canonicalReference": "bitburner!GangOtherInfo:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getOtherGangInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getTaskNames:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the name of all valid tasks that Gang members can be assigned to.\n *\n * @remarks\n *\n * 1 GB\n *\n * @returns All valid tasks that Gang members can be assigned to.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTaskNames(): " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getTaskNames" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#getTaskStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Get the stats of a gang task stats. This is typically used to evaluate which action should be executed next.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param name - Name of the task.\n *\n * @returns Detailed stats of a task.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTaskStats(name: " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "GangTasksStats", + "canonicalReference": "bitburner!GangTasksStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getTaskStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#purchaseEquipment:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempt to purchase the specified Equipment/Augmentation for the specified Gang member.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param memberName - Name of Gang member to purchase the equipment for.\n *\n * @param equipName - Name of Equipment/Augmentation to purchase.\n *\n * @returns True if the equipment was successfully purchased. False otherwise\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseEquipment(memberName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", equipName: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "memberName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "equipName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + } + } + ], + "name": "purchaseEquipment" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#recruitMember:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempt to recruit a new gang member.\n *\n * Possible reasons for failure: * Cannot currently recruit a new member * There already exists a member with the specified name\n *\n * @remarks\n *\n * 2 GB\n *\n * @param name - Name of member to recruit.\n *\n * @returns True if the member was successfully recruited, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "recruitMember(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "recruitMember" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#setMemberTask:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Attempts to assign the specified Gang Member to the specified task. If an invalid task is specified, the Gang member will be set to idle (“Unassigned”).\n *\n * @remarks\n *\n * 2 GB\n *\n * @param memberName - Name of Gang member to assign.\n *\n * @param taskName - Task to assign.\n *\n * @returns True if the Gang Member was successfully assigned to the task, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setMemberTask(memberName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", taskName: " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "memberName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "taskName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "setMemberTask" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Gang#setTerritoryWarfare:member(1)", + "docComment": "/**\n * If you are not in BitNode-2, then you must have Source-File 2 in order to use this function.\n *\n * Set whether or not the gang should engage in territory warfare\n *\n * @remarks\n *\n * 2 GB\n *\n * @param engage - Whether or not to engage in territory warfare.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setTerritoryWarfare(engage: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "engage", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setTerritoryWarfare" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangAugmentations:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangAugmentations =\n " + }, + { + "kind": "Content", + "text": "| \"Bionic Arms\"\n | \"Bionic Legs\"\n | \"Bionic Spine\"\n | \"BrachiBlades\"\n | \"Nanofiber Weave\"\n | \"Synthetic Heart\"\n | \"Synfibril Muscle\"\n | \"BitWire\"\n | \"Neuralstimulator\"\n | \"DataJack\"\n | \"Graphene Bone Lacings\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangAugmentations", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangEquipment:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangEquipment =\n " + }, + { + "kind": "Content", + "text": "| \"Baseball Bat\"\n | \"Katana\"\n | \"Glock 18C\"\n | \"P90C\"\n | \"Steyr AUG\"\n | \"AK-47\"\n | \"M15A10 Assault Rifle\"\n | \"AWM Sniper Rifle\"\n | \"Bulletproof Vest\"\n | \"Full Body Armor\"\n | \"Liquid Body Armor\"\n | \"Graphene Plating Armor\"\n | \"Ford Flex V20\"\n | \"ATX1070 Superbike\"\n | \"Mercedes-Benz S9001\"\n | \"White Ferrari\"\n | \"NUKE Rootkit\"\n | \"Soulstealer Rootkit\"\n | \"Demon Rootkit\"\n | \"Hmap Node\"\n | \"Jack the Ripper\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangEquipment", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangEquipmentStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangEquipmentStats " + } + ], + "releaseTag": "Public", + "name": "GangEquipmentStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#agi:member", + "docComment": "/**\n * Agility multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agi: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agi", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#cha:member", + "docComment": "/**\n * Charisma multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cha: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cha", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#def:member", + "docComment": "/**\n * Defense multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "def: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "def", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#dex:member", + "docComment": "/**\n * Dexterity multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dex: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dex", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#hack:member", + "docComment": "/**\n * Hacking multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hack: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangEquipmentStats#str:member", + "docComment": "/**\n * Strength multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "str: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "str", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangEquipmentType:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangEquipmentType = " + }, + { + "kind": "Content", + "text": "\"Weapon\" | \"Armor\" | \"Vehicle\" | \"Rootkit\" | \"Augmentation\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangEquipmentType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangGenInfo:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangGenInfo " + } + ], + "releaseTag": "Public", + "name": "GangGenInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#faction:member", + "docComment": "/**\n * Name of faction that the gang belongs to (\"Slum Snakes\", etc.)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "faction: " + }, + { + "kind": "Reference", + "text": "GangName", + "canonicalReference": "bitburner!GangName:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "faction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#isHacking:member", + "docComment": "/**\n * Boolean indicating whether or not its a hacking gang\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isHacking: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isHacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#moneyGainRate:member", + "docComment": "/**\n * Money earned per second\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "moneyGainRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "moneyGainRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#power:member", + "docComment": "/**\n * Gang's power for territory warfare\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "power: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "power", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#respect:member", + "docComment": "/**\n * Gang's respect\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#respectGainRate:member", + "docComment": "/**\n * Respect earned per second\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respectGainRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respectGainRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#territory:member", + "docComment": "/**\n * Amount of territory held. Returned in decimal form, not percentage\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territory: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#territoryClashChance:member", + "docComment": "/**\n * Clash chance. Returned in decimal form, not percentage\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territoryClashChance: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territoryClashChance", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#wantedLevel:member", + "docComment": "/**\n * Gang's wanted level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wantedLevel: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "wantedLevel", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangGenInfo#wantedLevelGainRate:member", + "docComment": "/**\n * Wanted level gained/lost per second (negative for losses)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wantedLevelGainRate: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "wantedLevelGainRate", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangMemberAscension:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangMemberAscension " + } + ], + "releaseTag": "Public", + "name": "GangMemberAscension", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#agi:member", + "docComment": "/**\n * Agility multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agi: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agi", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#cha:member", + "docComment": "/**\n * Charisma multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cha: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cha", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#def:member", + "docComment": "/**\n * Defense multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "def: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "def", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#dex:member", + "docComment": "/**\n * Dexterity multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dex: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dex", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#hack:member", + "docComment": "/**\n * Hacking multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hack: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hack", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#respect:member", + "docComment": "/**\n * Amount of respect lost from ascending\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberAscension#str:member", + "docComment": "/**\n * Strength multiplier gained from ascending. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "str: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "str", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangMemberInfo:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangMemberInfo " + } + ], + "releaseTag": "Public", + "name": "GangMemberInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#agility:member", + "docComment": "/**\n * Agility stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#agilityAscensionMult:member", + "docComment": "/**\n * Agility multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agilityAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agilityAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#agilityEquipMult:member", + "docComment": "/**\n * Agility multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agilityEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agilityEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#augmentations:member", + "docComment": "/**\n * Array of names of all owned Augmentations\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "augmentations: " + }, + { + "kind": "Reference", + "text": "GangAugmentations", + "canonicalReference": "bitburner!GangAugmentations:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "augmentations", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#charisma:member", + "docComment": "/**\n * Charisma stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#charismaAscensionMult:member", + "docComment": "/**\n * Charisma multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charismaAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charismaAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#charismaEquipMult:member", + "docComment": "/**\n * Charisma multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charismaEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charismaEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#defense:member", + "docComment": "/**\n * Defense stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#defenseAscensionMult:member", + "docComment": "/**\n * Defense multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defenseAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defenseAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#defenseEquipMult:member", + "docComment": "/**\n * Defense multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defenseEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defenseEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#dexterity:member", + "docComment": "/**\n * Dexterity stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#dexterityAscensionMult:member", + "docComment": "/**\n * Dexterity multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterityAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterityAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#dexterityEquipMult:member", + "docComment": "/**\n * Dexterity multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterityEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterityEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#equipment:member", + "docComment": "/**\n * Array of names of all owned Non-Augmentation Equipment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "equipment: " + }, + { + "kind": "Reference", + "text": "GangEquipment", + "canonicalReference": "bitburner!GangEquipment:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "equipment", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#hacking:member", + "docComment": "/**\n * Hacking stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#hackingAscensionMult:member", + "docComment": "/**\n * Hacking multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackingAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackingAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#hackingEquipMult:member", + "docComment": "/**\n * Hacking multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackingEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackingEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#strength:member", + "docComment": "/**\n * Strength stat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#strengthAscensionMult:member", + "docComment": "/**\n * Strength multiplier from ascension. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strengthAscensionMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strengthAscensionMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#strengthEquipMult:member", + "docComment": "/**\n * Strength multiplier from equipment. Decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strengthEquipMult: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strengthEquipMult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangMemberInfo#task:member", + "docComment": "/**\n * Name of currently assigned task\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "task: " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "task", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangName:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangName =\n " + }, + { + "kind": "Content", + "text": "| \"Slum Snakes\"\n | \"Tetrads\"\n | \"The Syndicate\"\n | \"The Dark Army\"\n | \"Speakers for the Dead\"\n | \"NiteSec\"\n | \"The Black Hand\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangName", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangOtherInfo:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangOtherInfo = " + }, + { + "kind": "Content", + "text": "{\n /** Stock Symbol */\n [key in " + }, + { + "kind": "Reference", + "text": "GangName", + "canonicalReference": "bitburner!GangName:type" + }, + { + "kind": "Content", + "text": "]: " + }, + { + "kind": "Reference", + "text": "GangOtherInfoObject", + "canonicalReference": "bitburner!GangOtherInfoObject:interface" + }, + { + "kind": "Content", + "text": "[];\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangOtherInfo", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangOtherInfoObject:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangOtherInfoObject " + } + ], + "releaseTag": "Public", + "name": "GangOtherInfoObject", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangOtherInfoObject#power:member", + "docComment": "/**\n * Gang power\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "power: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "power", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangOtherInfoObject#territory:member", + "docComment": "/**\n * Gang territory, in decimal form\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territory: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GangTasks:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GangTasks =\n " + }, + { + "kind": "Content", + "text": "| \"Unassigned\"\n | \"Ransomware\"\n | \"Phishing\"\n | \"Identity Theft\"\n | \"DDoS Attacks\"\n | \"Plant Virus\"\n | \"Fraud & Counterfeiting\"\n | \"Money Laundering\"\n | \"Cyberterrorism\"\n | \"Ethical Hacking\"\n | \"Mug People\"\n | \"Deal Drugs\"\n | \"Strongarm Civilians\"\n | \"Run a Con\"\n | \"Armed Robbery\"\n | \"Traffick Illegal Arms\"\n | \"Threaten & Blackmail\"\n | \"Human Trafficking\"\n | \"Terrorism\"\n | \"Vigilante Justice\"\n | \"Train Combat\"\n | \"Train Hacking\"\n | \"Train Charisma\"\n | \"Territory Warfare\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GangTasks", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangTasksStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangTasksStats " + } + ], + "releaseTag": "Public", + "name": "GangTasksStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#agiWeight:member", + "docComment": "/**\n * Agility skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agiWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agiWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#baseMoney:member", + "docComment": "/**\n * Base money earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseMoney: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseMoney", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#baseRespect:member", + "docComment": "/**\n * Base respect earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseRespect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseRespect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#baseWanted:member", + "docComment": "/**\n * Base wanted earned\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "baseWanted: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "baseWanted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#chaWeight:member", + "docComment": "/**\n * Charisma skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "chaWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "chaWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#defWeight:member", + "docComment": "/**\n * Defense skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#desc:member", + "docComment": "/**\n * Task Description\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "desc: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "desc", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#dexWeight:member", + "docComment": "/**\n * Dexterity skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#difficulty:member", + "docComment": "/**\n * Number representing the difficulty of the task\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "difficulty: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "difficulty", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#hackWeight:member", + "docComment": "/**\n * Hacking skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hackWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#isCombat:member", + "docComment": "/**\n * Is a task of a combat gang\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isCombat: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isCombat", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#isHacking:member", + "docComment": "/**\n * Is a task of a hacking gang\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isHacking: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isHacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#name:member", + "docComment": "/**\n * Task name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Reference", + "text": "GangTasks", + "canonicalReference": "bitburner!GangTasks:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#strWeight:member", + "docComment": "/**\n * Stength skill impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strWeight: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strWeight", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksStats#territory:member", + "docComment": "/**\n * Territory impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "territory: " + }, + { + "kind": "Reference", + "text": "GangTasksTerritory", + "canonicalReference": "bitburner!GangTasksTerritory:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "territory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!GangTasksTerritory:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GangTasksTerritory " + } + ], + "releaseTag": "Public", + "name": "GangTasksTerritory", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksTerritory#money:member", + "docComment": "/**\n * Money gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "money: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "money", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksTerritory#respect:member", + "docComment": "/**\n * Respect gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "respect: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "respect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!GangTasksTerritory#wanted:member", + "docComment": "/**\n * Wanted gain impact on task scaling\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wanted: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "wanted", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Gym:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Gym = " + }, + { + "kind": "Content", + "text": "\"Crush Fitness Gym\" | \"Snap Fitness Gym\" | \"Iron Gym\" | \"Powerhouse Gym\" | \"Millenium Fitness Gym\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Gym", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!GymStat:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type GymStat = " + }, + { + "kind": "Content", + "text": "\"str\" | \"def\" | \"dex\" | \"agi\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "GymStat", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!HackingMultipliers:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface HackingMultipliers " + } + ], + "releaseTag": "Public", + "name": "HackingMultipliers", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HackingMultipliers#chance:member", + "docComment": "/**\n * Player's hacking chance multiplier.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "chance: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "chance", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HackingMultipliers#growth:member", + "docComment": "/**\n * Player's hacking growth multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "growth: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "growth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HackingMultipliers#money:member", + "docComment": "/**\n * Player's hacking money stolen multiplier.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "money: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "money", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HackingMultipliers#speed:member", + "docComment": "/**\n * Player's hacking speed multiplier.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "speed: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "speed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!HackNet:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface HackNet " + } + ], + "releaseTag": "Public", + "name": "HackNet", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getCacheUpgradeCost:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the cost of upgrading the cache level of the specified Hacknet Server by n.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade cache. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's cache.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCacheUpgradeCost(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getCacheUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getCoreUpgradeCost:member(1)", + "docComment": "/**\n * Returns the cost of upgrading the number of cores of the specified Hacknet Node by n.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade cores. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's number of cores.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCoreUpgradeCost(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getCoreUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getLevelUpgradeCost:member(1)", + "docComment": "/**\n * Returns the cost of upgrading the specified Hacknet Node by n levels.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of levels to upgrade. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getLevelUpgradeCost(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getLevelUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getNodeStats:member(1)", + "docComment": "/**\n * Returns an object containing a variety of stats about the specified Hacknet Node.\n *\n * Note that for Hacknet Nodes, production refers to the amount of money the node generates. For Hacknet Servers (the upgraded version of Hacknet Nodes), production refers to the amount of hashes the node generates.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node\n *\n * @returns Object containing a variety of stats about the specified Hacknet Node.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getNodeStats(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "NodeStats", + "canonicalReference": "bitburner!NodeStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getNodeStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getPurchaseNodeCost:member(1)", + "docComment": "/**\n * Returns the cost of purchasing a new Hacknet Node.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Cost of purchasing a new Hacknet Node.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchaseNodeCost(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPurchaseNodeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#getRamUpgradeCost:member(1)", + "docComment": "/**\n * Returns the cost of upgrading the RAM of the specified Hacknet Node n times.\n *\n * If an invalid value for n is provided, then this function returns 0. If the specified Hacknet Node is already at max level, then Infinity is returned.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.\n *\n * @returns Cost of upgrading the specified Hacknet Node's ram.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getRamUpgradeCost(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getRamUpgradeCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#hashCost:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the number of hashes required for the specified upgrade. The name of the upgrade must be an exact match.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param upgName - Name of the upgrade of Hacknet Node.\n *\n * @returns Number of hashes required for the specified upgrade.\n *\n * @example\n * ```js\n * var upgradeName = \"Sell for Corporation Funds\";\n * if (hacknet.numHashes() > hacknet.hashCost(upgradeName)) {\n * hacknet.spendHashes(upgName);\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hashCost(upgName: " + }, + { + "kind": "Reference", + "text": "HashUpgrades", + "canonicalReference": "bitburner!HashUpgrades:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "upgName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hashCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#numHashes:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Returns the number of hashes you have.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Number of hashes you have.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "numHashes(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "numHashes" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#numNodes:member(1)", + "docComment": "/**\n * Returns the number of Hacknet Nodes you own.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns number of hacknet nodes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "numNodes(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "numNodes" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#purchaseNode:member(1)", + "docComment": "/**\n * Purchases a new Hacknet Node. Returns a number with the index of the Hacknet Node. This index is equivalent to the number at the end of the Hacknet Node’s name (e.g The Hacknet Node named \\`hacknet-node-4\\` will have an index of 4).\n *\n * If the player cannot afford to purchase a new Hacknet Node then the function will return -1.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns The index of the Hacknet Node or if the player cannot afford to purchase a new Hacknet Node the function will return -1.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseNode(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "purchaseNode" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#spendHashes:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Spend the hashes generated by your Hacknet Servers on an upgrade. Returns a boolean value - true if the upgrade is successfully purchased, and false otherwise.\n *\n * The name of the upgrade must be an exact match. The \\`upgTarget\\` argument is used for upgrades such as \\`Reduce Minimum Security\\`, which applies to a specific server. In this case, the \\`upgTarget\\` argument must be the hostname of the server.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param upgName - Name of the upgrade of Hacknet Node.\n *\n * @param upgTarget - Object to which upgrade applies. Required for certain upgrades.\n *\n * @returns True if the upgrade is successfully purchased, and false otherwise..\n *\n * @example\n * ```js\n * hacknet.spendHashes(\"Sell for Corporation Funds\");\n * hacknet.spendHashes(\"Increase Maximum Money\", \"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "spendHashes(upgName: " + }, + { + "kind": "Reference", + "text": "HashUpgrades", + "canonicalReference": "bitburner!HashUpgrades:type" + }, + { + "kind": "Content", + "text": ", upgTarget?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "upgName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "upgTarget", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "spendHashes" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#upgradeCache:member(1)", + "docComment": "/**\n * This function is only applicable for Hacknet Servers (the upgraded version of a Hacknet Node).\n *\n * Tries to upgrade the specified Hacknet Server’s cache n times.\n *\n * Returns true if it successfully upgrades the Server’s cache n times, or if it purchases some positive amount and the Server reaches its max cache level.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of cache levels to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeCache(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "upgradeCache" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#upgradeCore:member(1)", + "docComment": "/**\n * Tries to purchase n cores for the specified Hacknet Node.\n *\n * Returns true if it successfully purchases n cores for the Hacknet Node or if it purchases some positive amount and the Node reaches its max number of cores.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of cores to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s cores are successfully purchased, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeCore(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "upgradeCore" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#upgradeLevel:member(1)", + "docComment": "/**\n * Tries to upgrade the level of the specified Hacknet Node by n.\n *\n * Returns true if the Hacknet Node’s level is successfully upgraded by n or if it is upgraded by some positive amount and the Node reaches its max level.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of levels to purchase. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s level is successfully upgraded, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeLevel(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "upgradeLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!HackNet#upgradeRam:member(1)", + "docComment": "/**\n * Tries to upgrade the specified Hacknet Node’s RAM n times. Note that each upgrade doubles the Node’s RAM. So this is equivalent to multiplying the Node’s RAM by 2 n.\n *\n * Returns true if the Hacknet Node’s RAM is successfully upgraded n times or if it is upgraded some positive number of times and the Node reaches it max RAM.\n *\n * Returns false otherwise.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param index - Index/Identifier of Hacknet Node.\n *\n * @param n - Number of times to upgrade RAM. Must be positive. Rounded to nearest integer.\n *\n * @returns True if the Hacknet Node’s ram is successfully upgraded, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeRam(index: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "index", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "upgradeRam" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!HacknetMultipliers:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface HacknetMultipliers " + } + ], + "releaseTag": "Public", + "name": "HacknetMultipliers", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#coreCost:member", + "docComment": "/**\n * Player's hacknet core cost multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "coreCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "coreCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#levelCost:member", + "docComment": "/**\n * Player's hacknet level cost multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "levelCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "levelCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#production:member", + "docComment": "/**\n * Player's hacknet production multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "production: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "production", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#purchaseCost:member", + "docComment": "/**\n * Player's hacknet purchase cost multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "purchaseCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!HacknetMultipliers#ramCost:member", + "docComment": "/**\n * Player's hacknet ram cost multiplier\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ramCost: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ramCost", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Handle:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Handle = " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "Port", + "canonicalReference": "bitburner!Port:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Handle", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!HashUpgrades:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type HashUpgrades =\n " + }, + { + "kind": "Content", + "text": "| \"Sell for Money\"\n | \"Sell for Corporation Funds\"\n | \"Reduce Minimum Security\"\n | \"Increase Maximum Money\"\n | \"Improve Studying\"\n | \"Improve Gym Training\"\n | \"Exchange for Corporation Research\"\n | \"Exchange for Bladeburner Rank\"\n | \"Exchange for Bladeburner SP\"\n | \"Generate Coding Contract\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "HashUpgrades", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Host:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Host = " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Host", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!NodeStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface NodeStats " + } + ], + "releaseTag": "Public", + "name": "NodeStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#cache:member", + "docComment": "/**\n * Cache level. Only applicable for Hacknet Servers\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cache: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cache", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#cores:member", + "docComment": "/**\n * Node's number of cores\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cores: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cores", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#hashCapacity:member", + "docComment": "/**\n * Hash Capacity provided by this Node. Only applicable for Hacknet Servers\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hashCapacity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hashCapacity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#level:member", + "docComment": "/**\n * Node's level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "level: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "level", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#name:member", + "docComment": "/**\n * Node's name (\"hacknet-node-5\")\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#production:member", + "docComment": "/**\n * Node's production per second\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "production: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "production", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#ram:member", + "docComment": "/**\n * Node's RAM\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ram: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ram", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#timeOnline:member", + "docComment": "/**\n * Number of seconds since Node has been purchased\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeOnline: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "timeOnline", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NodeStats#totalProduction:member", + "docComment": "/**\n * Total number of money Node has produced\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "totalProduction: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "totalProduction", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!NS:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "export interface NS extends " + }, + { + "kind": "Reference", + "text": "Singularity", + "canonicalReference": "bitburner!Singularity:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "releaseTag": "Public", + "name": "NS", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#args:member", + "docComment": "/**\n * Arguments passed into a script can be accessed using a normal array using the [] operator (args[0], args[1], etc…).\n *\n * It is also possible to get the number of arguments that was passed into a script using:\n * ```js\n * args.length\n * ```\n *\n * WARNING: Do not try to modify the args array. This will break the game.\n *\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "args", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#bladeburner:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly bladeburner: " + }, + { + "kind": "Reference", + "text": "Bladeburner", + "canonicalReference": "bitburner!Bladeburner:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "bladeburner", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#brutessh:member(1)", + "docComment": "/**\n * Runs the BruteSSH.exe program on the target server. BruteSSH.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * brutessh(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "brutessh(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "brutessh" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#clear:member(1)", + "docComment": "/**\n * This function is used to clear data in a Netscript Ports or a text file.\n *\n * If the port/fn argument is a number between 1 and 20, then it specifies a port and will clear it (deleting all data from the underlying queue).\n *\n * If the port/fn argument is a string, then it specifies the name of a text file (.txt) and will delete all data from that text file.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param handle - Port or text file to clear.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clear(handle: " + }, + { + "kind": "Reference", + "text": "Handle", + "canonicalReference": "bitburner!Handle:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handle", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "clear" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#clearLog:member(1)", + "docComment": "/**\n * Clears the script’s logs.\n *\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "clearLog(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "clearLog" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#codingcontract:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly codingcontract: " + }, + { + "kind": "Reference", + "text": "CodingContract", + "canonicalReference": "bitburner!CodingContract:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "codingcontract", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#deleteServer:member(1)", + "docComment": "/**\n * Deletes one of your purchased servers, which is specified by its hostname.\n *\n * The hostname argument can be any data type, but it will be converted to a string. Whitespace is automatically removed from the string. This function will not delete a server that still has scripts running on it.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * @param host - Host of the server to delete.\n *\n * @returns True if successful, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deleteServer(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "deleteServer" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#disableLog:member(1)", + "docComment": "/**\n * Disables logging for the given function. Logging can be disabled for all functions by passing \\`ALL\\` as the argument.\n *\n * Note that this does not completely remove all logging functionality. This only stops a function from logging when the function is successful. If the function fails, it will still log the reason for failure.\n *\n * Notable functions that cannot have their logs disabled: run, exec, exit.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Name of function for which to disable logging.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "disableLog(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "disableLog" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#enableLog:member(1)", + "docComment": "/**\n * Re-enables logging for the given function. If \\`ALL\\` is passed into this function as an argument, then it will revert the effects of disableLog(\\`ALL\\`).\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Name of function for which to enable logging.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "enableLog(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "enableLog" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#exec:member(1)", + "docComment": "/**\n * 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.\n *\n * If the script was successfully started, then this functions returns the PID of that script. Otherwise, it returns 0.\n *\n * PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer.\n *\n * Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error.\n *\n * @remarks\n *\n * 1.3 GB\n *\n * @param script - Filename of script to execute.\n *\n * @param host - Hostname or IP of the \\`target server\\` on which to execute the script.\n *\n * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer.\n *\n * @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.\n *\n * @returns Returns the PID of a successfully started script, and 0 otherwise.\n *\n * @example\n * ```js\n * //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:\n * exec(\"generic-hack.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The following example will try to run the script generic-hack.script on the joesguns server with 10 threads:\n * exec(\"generic-hack.script\", \"joesguns\", 10);\n * ```\n *\n * @example\n * ```js\n * //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:\n * exec(\"foo.script\", \"foodnstuff\", 5, 1, \"test\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "exec(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", numThreads?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "numThreads", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ], + "name": "exec" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#exit:member(1)", + "docComment": "/**\n * Terminates the current script immediately.\n *\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "exit(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "exit" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#fileExists:member(1)", + "docComment": "/**\n * Returns a boolean indicating whether the specified file exists on the target server. The filename for scripts is case-sensitive, but for other types of files it is not. For example, fileExists(“brutessh.exe”) will work fine, even though the actual program is named 'BruteSSH.exe'.\n *\n * If the hostname/ip argument is omitted, then the function will search through the current server (the server running the script that calls this function) for the file.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param filename - Filename of file to check.\n *\n * @param host - Host or IP of target server. This is optional. If it is not specified then the function will use the current server as the target server.\n *\n * @returns True if specified file exists, and false otherwise.\n *\n * @example\n * ```js\n * //The function call will return true if the script named foo.script exists on the foodnstuff server, and false otherwise.\n * fileExists(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The function call will return true if the current server contains the FTPCrack.exe program, and false otherwise.\n * fileExists(\"ftpcrack.exe\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "fileExists(filename: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "filename", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "fileExists" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#ftpcrack:member(1)", + "docComment": "/**\n * Runs the FTPCrack.exe program on the target server. FTPCrack.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * ftpcrack(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ftpcrack(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "ftpcrack" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#gang:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly gang: " + }, + { + "kind": "Reference", + "text": "Gang", + "canonicalReference": "bitburner!Gang:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "gang", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getBitNodeMultipliers:member(1)", + "docComment": "/**\n * Returns an object containing the current BitNode multipliers. This function requires Source-File 5 in order to run. The multipliers are returned in decimal forms (e.g. 1.5 instead of 150%). The multipliers represent the difference between the current BitNode and the original BitNode (BitNode-1).\n *\n * For example, if the CrimeMoney multiplier has a value of 0.1, then that means that committing crimes in the current BitNode will only give 10% of the money you would have received in BitNode-1.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Object containing the current BitNode multipliers.\n *\n * @example\n * ```js\n * mults = getBitNodeMultipliers();\n * print(mults.ServerMaxMoney);\n * print(mults.HackExpGain);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBitNodeMultipliers(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", target: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "BitNodeMultipliers", + "canonicalReference": "bitburner!BitNodeMultipliers:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getBitNodeMultipliers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getFavorToDonate:member(1)", + "docComment": "/**\n * Returns the amount of Faction favor required to be able to donate to a faction.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @returns Amount of Faction favor required to be able to donate to a faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getFavorToDonate(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getFavorToDonate" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getGrowTime:member(1)", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the grow Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the grow time would be at different hacking levels.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getGrowTime(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hackLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", intLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hackLvl", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "intLvl", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getGrowTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHackingLevel:member(1)", + "docComment": "/**\n * Returns the player’s current hacking level.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Player’s current hacking level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHackingLevel(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getHackingLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHackingMultipliers:member(1)", + "docComment": "/**\n * Returns an object containing the Player’s hacking related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%).\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Object containing the Player’s hacking related multipliers.\n *\n * @example\n * ```js\n * //Example of how this can be used:\n * mults = getHackingMultipliers();\n * print(mults.chance);\n * print(mults.growth);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHackingMultipliers(): " + }, + { + "kind": "Reference", + "text": "HackingMultipliers", + "canonicalReference": "bitburner!HackingMultipliers:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getHackingMultipliers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHacknetMultipliers:member(1)", + "docComment": "/**\n * Returns an object containing the Player’s hacknet related multipliers. These multipliers are returned in fractional forms, not percentages (e.g. 1.5 instead of 150%).\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns Object containing the Player’s hacknet related multipliers.\n *\n * @example\n * ```js\n * //Example of how this can be used:\n * mults = getHacknetMultipliers();\n * print(mults.production);\n * print(mults.purchaseCost);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHacknetMultipliers(): " + }, + { + "kind": "Reference", + "text": "HacknetMultipliers", + "canonicalReference": "bitburner!HacknetMultipliers:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getHacknetMultipliers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHackTime:member(1)", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the hack Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the hack time would be at different hacking levels.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the hack Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHackTime(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hackLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", intLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hackLvl", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "intLvl", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getHackTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getHostname:member(1)", + "docComment": "/**\n * Returns a string with the hostname of the server that the script is running on.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Hostname of the server that the script is on.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getHostname(): " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getHostname" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPortHandle:member(1)", + "docComment": "/**\n * Get a handle to a Netscript Port.\n *\n * WARNING: Port Handles only work in NetscriptJS (Netscript 2.0). They will not work in Netscript 1.0.\n *\n * @remarks\n *\n * 10 GB\n *\n * @param port - Port number. Must be an integer between 1 and 20.\n *\n * @returns Data in the specified port.\n *\n * @see\n *\n * https://bitburner.readthedocs.io/en/latest/netscript/netscriptmisc.html#netscript-ports\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPortHandle(port: " + }, + { + "kind": "Reference", + "text": "Port", + "canonicalReference": "bitburner!Port:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "port", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPortHandle" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPurchasedServerCost:member(1)", + "docComment": "/**\n * Returns the cost to purchase a server with the specified amount of ram.\n *\n * @remarks\n *\n * 0.25 GB\n *\n * @param ram - Amount of RAM of a potential purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).\n *\n * @returns The cost to purchase a server with the specified amount of ram.\n *\n * @example\n * ```js\n * for (i = 1; i <= 20; i++) {\n * tprint(i + \" -- \" + getPurchasedServerCost(Math.pow(2, i)));\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchasedServerCost(ram: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "ram", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPurchasedServerCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPurchasedServerLimit:member(1)", + "docComment": "/**\n * Returns the maximum number of servers you can purchase.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Returns the maximum number of servers you can purchase.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchasedServerLimit(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPurchasedServerLimit" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPurchasedServerMaxRam:member(1)", + "docComment": "/**\n * Returns the maximum RAM that a purchased server can have.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Returns the maximum RAM that a purchased server can have.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchasedServerMaxRam(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getPurchasedServerMaxRam" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getPurchasedServers:member(1)", + "docComment": "/**\n * Returns an array with either the hostnames or IPs of all of the servers you have purchased.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * @param hostnameMode - ] Optional. Defaults to true. Returns hostnames if true, and IPs if false.\n *\n * @returns Returns an array with either the hostnames or IPs of all of the servers you have purchased.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchasedServers(hostnameMode?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "hostnameMode", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPurchasedServers" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptExpGain:member(1)", + "docComment": "/**\n * Returns the amount of hacking experience the specified script generates while online (when the game is open, does not apply for offline experience gains). Remember that a script is uniquely identified by both its name and its arguments.\n *\n * This function can also return the total experience gain rate of all of your active scripts by running the function with no arguments.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param script - Filename of script.\n *\n * @param host - Server on which script is running.\n *\n * @param args - Arguments that the script is running with.\n *\n * @returns Amount of hacking experience the specified script generates while online.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptExpGain(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getScriptExpGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptIncome:member(1)", + "docComment": "/**\n * Returns the amount of income the specified script generates while online (when the game is open, does not apply for offline income). Remember that a script is uniquely identified by both its name and its arguments. So for example if you ran a script with the arguments “foodnstuff” and “5” then in order to use this function to get that script’s income you must specify those same arguments in the same order in this function call.\n *\n * This function can also be called with no arguments. If called with no arguments, then this function will return an array of two values. The first value is the total income ($ / second) of all of your active scripts (scripts that are currently running on any server). The second value is the total income ($ / second) that you’ve earned from scripts since you last installed Augmentations.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param script - Filename of script.\n *\n * @param host - Server on which script is running.\n *\n * @param args - Arguments that the script is running with.\n *\n * @returns Amount of income the specified script generates while online.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptIncome(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number | [number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getScriptIncome" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptLogs:member(1)", + "docComment": "/**\n * Returns a script’s logs. The logs are returned as an array, where each line is an element in the array. The most recently logged line is at the end of the array. Note that there is a maximum number of lines that a script stores in its logs. This is configurable in the game’s options. If the function is called with no arguments, it will return the current script’s logs.\n *\n * Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Optional. Filename of script to get logs from.\n *\n * @param host - Optional. Hostname or IP of the server that the script is on.\n *\n * @param args - Arguments to identify which scripts to get logs for.\n *\n * @returns Returns an string array, where each line is an element in the array. The most recently logged line is at the end of the array.\n *\n * @example\n * ```js\n * //Get logs from foo.script on the current server that was run with no args\n * getScriptLogs(\"foo.script\");\n * ```\n *\n * @example\n * ```js\n * //Open logs from foo.script on the foodnstuff server that was run with no args\n * getScriptLogs(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //Open logs from foo.script on the foodnstuff server that was run with the arguments [1, \"test\"]\n * getScriptLogs(\"foo.script\", \"foodnstuff\", 1, \"test\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptLogs(fn?: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getScriptLogs" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptName:member(1)", + "docComment": "/**\n * Returns the current script name.\n *\n * @remarks\n *\n * 0 GB\n *\n * @returns Current script name.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptName(): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getScriptName" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getScriptRam:member(1)", + "docComment": "/**\n * Returns the amount of RAM required to run the specified script on the target server. Returns 0 if the script does not exist.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param script - Filename of script. This is case-sensitive.\n *\n * @param host - Host or IP of target server the script is located on. This is optional, If it is not specified then the function will se the current server as the target server.\n *\n * @returns Amount of RAM required to run the specified script on the target server, and 0 if the script does not exist.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getScriptRam(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "getScriptRam" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServer:member(1)", + "docComment": "/**\n * Returns a server object for the given server. Defaults to the running script's server if host is not specified.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param host - Optional. Hostname or IP for the requested server object.\n *\n * @returns The requested server object.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServer(host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Server", + "canonicalReference": "bitburner!Server:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServer" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerBaseSecurityLevel:member(1)", + "docComment": "/**\n * Returns the base security level of the target server. This is the security level that the server starts out with. This is different than getServerSecurityLevel because getServerSecurityLevel returns the current security level of a server, which can constantly change due to hack, grow, and weaken, calls on that server. The base security level will stay the same until you reset by installing an Augmentation(s).\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Base security level of the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerBaseSecurityLevel(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerBaseSecurityLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerGrowth:member(1)", + "docComment": "/**\n * Returns the server’s instrinsic “growth parameter”. This growth parameter is a number between 1 and 100 that represents how quickly the server’s money grows. This parameter affects the percentage by which the server’s money is increased when using the grow function. A higher growth parameter will result in a higher percentage increase from grow.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Parameter that affects the percentage by which the server’s money is increased when using the grow function.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerGrowth(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerGrowth" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerMaxMoney:member(1)", + "docComment": "/**\n * Returns the maximum amount of money that can be available on a server.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Maximum amount of money available on the server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerMaxMoney(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerMaxMoney" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerMinSecurityLevel:member(1)", + "docComment": "/**\n * Returns the minimum security level of the target server.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Minimum security level of the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerMinSecurityLevel(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerMinSecurityLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerMoneyAvailable:member(1)", + "docComment": "/**\n * Returns the amount of money available on a server. Running this function on the home computer will return the player’s money.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server\n *\n * @returns Amount of money available on the server.\n *\n * @example\n * ```js\n * getServerMoneyAvailable(\"foodnstuff\");\n * getServerMoneyAvailable(\"home\"); //Returns player's money\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerMoneyAvailable(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerMoneyAvailable" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerNumPortsRequired:member(1)", + "docComment": "/**\n * Returns the number of open ports required to successfully run NUKE.exe on the specified server.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns The number of open ports required to successfully run NUKE.exe on the specified server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerNumPortsRequired(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerNumPortsRequired" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerRam:member(1)", + "docComment": "/**\n * Returns an array with two elements that gives information about a server’s memory (RAM). The first element in the array is the amount of RAM that the server has total (in GB). The second element in the array is the amount of RAM that is currently being used on the server (in GB).\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Array with total and used memory on the specified server.\n *\n * @example\n * ```js\n * res = getServerRam(\"helios\");\n * totalRam = res[0];\n * ramUsed = res[1];\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerRam(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "[number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerRam" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerRequiredHackingLevel:member(1)", + "docComment": "/**\n * Returns the required hacking level of the target server.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns The required hacking level of the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerRequiredHackingLevel(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerRequiredHackingLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getServerSecurityLevel:member(1)", + "docComment": "/**\n * Returns the security level of the target server. A server’s security level is denoted by a number, typically between 1 and 100 (but it can go above 100).\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns Security level of the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getServerSecurityLevel(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getServerSecurityLevel" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getTimeSinceLastAug:member(1)", + "docComment": "/**\n * Returns the amount of time in milliseconds that have passed since you last installed Augmentations.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @returns Time in milliseconds that have passed since you last installed Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTimeSinceLastAug(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getTimeSinceLastAug" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#getWeakenTime:member(1)", + "docComment": "/**\n * Returns the amount of time in seconds it takes to execute the weaken() Netscript function on the target server. The function takes in an optional hackLvl parameter that can be specified to see what the weaken time would be at different hacking levels.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Host or IP of target server.\n *\n * @param hackLvl - Optional hacking level for the calculation. Defaults to player’s current hacking level.\n *\n * @param intLvl - Optional intelligence level for the calculation. Defaults to player’s current intelligence level. (Intelligence is unlocked after obtaining Source-File 5).\n *\n * @returns Returns the amount of time in seconds it takes to execute the grow Netscript function. Returns Infinity if called on a Hacknet Server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getWeakenTime(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hackLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", intLvl?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hackLvl", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "intLvl", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getWeakenTime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#grow:member(1)", + "docComment": "/**\n * Use your hacking skills to increase the amount of money available on a server. The runtime for this command depends on your hacking level and the target server’s security level. When \\`grow\\` completes, the money available on a target server will be increased by a certain, fixed percentage. This percentage is determined by the target server’s growth rate (which varies between servers) and security level. Generally, higher-level servers have higher growth rates. The getServerGrowth() function can be used to obtain a server’s growth rate.\n *\n * Like hack, \\`grow\\` can be called on any server, regardless of where the script is running. The grow() command requires root access to the target server, but there is no required hacking level to run the command. It also raises the security level of the target server by 0.004.\n *\n * @remarks\n *\n * 0.15 GB\n *\n * @param host - Hostname or IP of the target server to grow.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The number by which the money on the server was multiplied for the growth.\n *\n * @example\n * ```js\n * grow(\"foodnstuff\");\n * grow(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to grow\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "grow(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", opts?: " + }, + { + "kind": "Reference", + "text": "BasicHGWOptions", + "canonicalReference": "bitburner!BasicHGWOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "grow" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#growthAnalyze:member(1)", + "docComment": "/**\n * This function returns the number of “growths” needed in order to increase the amount of money available on the specified server by the specified amount. The specified amount is multiplicative and is in decimal form, not percentage.\n *\n * Warning: The value returned by this function isn’t necessarily a whole number.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @param growthAmount - Multiplicative factor by which the server is grown. Decimal form..\n *\n * @returns The amount of grow calls needed to grow the specified server by the specified amount\n *\n * @example\n * ```js\n * //For example, if you want to determine how many grow calls you need to double the amount of money on foodnstuff, you would use:\n * growthAnalyze(\"foodnstuff\", 2);\n * //If this returns 100, then this means you need to call grow 100 times in order to double the money (or once with 100 threads).\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "growthAnalyze(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", growthAmount: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "growthAmount", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "growthAnalyze" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#growthAnalyzeSecurity:member(1)", + "docComment": "/**\n * Returns the security increase that would occur if a grow with this many threads happened.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param threads - Amount of threads that will be used.\n *\n * @returns The security increase.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "growthAnalyzeSecurity(threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "threads", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "growthAnalyzeSecurity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hack:member(1)", + "docComment": "/**\n * Function that is used to try and hack servers to steal money and gain hacking experience. The runtime for this command depends on your hacking level and the target server’s security level. In order to hack a server you must first gain root access to that server and also have the required hacking level.\n *\n * A script can hack a server from anywhere. It does not need to be running on the same server to hack that server. For example, you can create a script that hacks the \\`foodnstuff\\` server and run that script on any server in the game.\n *\n * A successful \\`hack()\\` on a server will raise that server’s security level by 0.002.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Hostname or IP of the target server to hack.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The amount of money stolen if the hack is successful, and zero otherwise.\n *\n * @example\n * ```js\n * hack(\"foodnstuff\");\n * hack(\"10.1.2.3\");\n * hack(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to hack\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hack(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", opts?: " + }, + { + "kind": "Reference", + "text": "BasicHGWOptions", + "canonicalReference": "bitburner!BasicHGWOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "hack" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hackAnalyzePercent:member(1)", + "docComment": "/**\n * Returns the percentage of the specified server’s money you will steal with a single hack. This value is returned in percentage form, not decimal (Netscript functions typically return in decimal form, but not this one).\n *\n * @remarks\n *\n * 1 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @returns The percentage of money you will steal from the target server with a single hack.\n *\n * @example\n * ```js\n * //For example, assume the following returns 1:\n * hackAnalyzePercent(\"foodnstuff\");\n * //This means that if hack the foodnstuff server, then you will steal 1% of its total money. If you hack using N threads, then you will steal N% of its total money.\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackAnalyzePercent(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hackAnalyzePercent" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hackAnalyzeSecurity:member(1)", + "docComment": "/**\n * Returns the security increase that would occur if a hack with this many threads happened.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param threads - Amount of threads that will be used.\n *\n * @returns The security increase.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackAnalyzeSecurity(threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "threads", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hackAnalyzeSecurity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hackAnalyzeThreads:member(1)", + "docComment": "/**\n * This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1.\n *\n * Warning: The value returned by this function isn’t necessarily a whole number.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param host - Hostname or IP of the target server to analyze.\n *\n * @param hackAmount - Amount of money you want to hack from the server.\n *\n * @returns The number of threads needed to hack the server for hackAmount money.\n *\n * @example\n * ```js\n * //For example, let’s say the foodnstuff server has $10m and you run:\n * hackAnalyzeThreads(\"foodnstuff\", 1e6);\n * //If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server.\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackAnalyzeThreads(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hackAmount: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hackAmount", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "hackAnalyzeThreads" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hackChance:member(1)", + "docComment": "/**\n * Returns the chance you have of successfully hacking the specified server.\n *\n * This returned value is in decimal form, not percentage.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @returns The chance you have of successfully hacking the target server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hackChance(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hackChance" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#hacknet:member", + "docComment": "/**\n * Not all functions in the Hacknet Node API are immediately available.\n *\n * Note that none of these functions will write to the script’s logs.\n *\n * If you want to see what your script is doing you will have to print to the logs yourself.\n *\n * @remarks\n *\n * 4 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly hacknet: " + }, + { + "kind": "Reference", + "text": "HackNet", + "canonicalReference": "bitburner!HackNet:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacknet", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#hasRootAccess:member(1)", + "docComment": "/**\n * Returns a boolean indicating whether or not the player has root access to the specified target server.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Host or IP of the target server\n *\n * @returns True if player has root access to the specified target server, and false otherwise.\n *\n * @example\n * ```js\n * if (hasRootAccess(\"foodnstuff\") == false) {\n * nuke(\"foodnstuff\");\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasRootAccess(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "hasRootAccess" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#httpworm:member(1)", + "docComment": "/**\n * Runs the HTTPWorm.exe program on the target server. HTTPWorm.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * httpworm(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "httpworm(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "httpworm" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#isLogEnabled:member(1)", + "docComment": "/**\n * Checks the status of the logging for the given function.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Name of function to check.\n *\n * @returns Returns a boolean indicating whether or not logging is enabled for that function (or \\`ALL\\`)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isLogEnabled(fn: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "isLogEnabled" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#isRunning:member(1)", + "docComment": "/**\n * Returns a boolean indicating whether the specified script is running on the target server. Remember that a script is uniquely identified by both its name and its arguments.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param script - Filename of script to check. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @param args - Arguments to specify/identify which scripts to search for.\n *\n * @returns True if specified script is running on the target server, and false otherwise.\n *\n * @example\n * ```js\n * //The function call will return true if there is a script named foo.script with no arguments running on the foodnstuff server, and false otherwise:\n * isRunning(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The function call will return true if there is a script named foo.script with no arguments running on the current server, and false otherwise:\n * isRunning(\"foo.script\", getHostname());\n * ```\n *\n * @example\n * ```js\n * //The function call will return true if there is a script named foo.script running with the arguments 1, 5, and “test” (in that order) on the joesguns server, and false otherwise:\n * isRunning(\"foo.script\", \"joesguns\", 1, 5, \"test\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isRunning(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "isRunning" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#kill:member(1)", + "docComment": "/**\n * Kills the script on the target server specified by the script’s name and arguments. Remember that scripts are uniquely identified by both their name and arguments. For example, if \\`foo.script\\` is run with the argument 1, then this is not the same as \\`foo.script\\` run with the argument 2, even though they have the same code.\n *\n * @remarks\n *\n * 0.5 GB\n *\n * @param script - Filename of the script to kill\n *\n * @param host - Hostname or IP of the server on which to kill the script.\n *\n * @param args - Arguments to identify which script to kill.\n *\n * @returns True if the script is successfully killed, and false otherwise.\n *\n * @example\n * ```js\n * //The following example will try to kill a script named foo.script on the foodnstuff server that was ran with no arguments:\n * kill(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The following will try to kill a script named foo.script on the current server that was ran with no arguments:\n * kill(\"foo.script\", getHostname());\n * ```\n *\n * @example\n * ```js\n * //The following will try to kill a script named foo.script on the current server that was ran with the arguments 1 and “foodnstuff”:\n * kill(\"foo.script\", getHostname(), 1, \"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "kill(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "kill" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#kill:member(2)", + "docComment": "/**\n * Kills the script with the specified PID. Killing a script by its PID will typically have better performance, especially if you have many scripts running. If this function successfully kills the specified script, then it will return true. Otherwise, it will return false.\n *\n * @remarks\n *\n * 0.5 GB\n *\n * @param scriptPid - PID of the script to kill\n *\n * @returns True if the script is successfully killed, and false otherwise.\n *\n * @example\n * ```js\n * if (kill(10)) {\n * print(\"Killed script with PID 10!\");\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "kill(scriptPid: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "scriptPid", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "kill" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#killall:member(1)", + "docComment": "/**\n * Kills all running scripts on the specified server. This function returns true if any scripts were killed, and false otherwise. In other words, it will return true if there are any scripts running on the target server.\n *\n * @remarks\n *\n * 0.5 GB\n *\n * @param host - IP or hostname of the server on which to kill all scripts.\n *\n * @returns True if any scripts were killed, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "killall(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "killall" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#ls:member(1)", + "docComment": "/**\n * Returns an array with the filenames of all files on the specified server (as strings). The returned array is sorted in alphabetic order.\n *\n * @remarks\n *\n * 0.2 GB\n *\n * @param host - Host or IP of the target server.\n *\n * @param grep - A substring to search for in the filename.\n *\n * @returns Array with the filenames of all files on the specified server.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ls(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", grep?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "grep", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "ls" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#nFormat:member(1)", + "docComment": "/**\n * 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.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param n - Number to format.\n *\n * @param format - Formatter.\n *\n * @returns Formated number.\n *\n * @see\n *\n * http://numeraljs.com/\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "nFormat(n: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", format: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "n", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "format", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "nFormat" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#nuke:member(1)", + "docComment": "/**\n * Runs the NUKE.exe program on the target server. NUKE.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * nuke(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "nuke(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "nuke" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#peek:member(1)", + "docComment": "/**\n * This function is used to peek at the data from a port. It returns the first element in the specified port without removing that element. If the port is empty, the string “NULL PORT DATA” will be returned.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param port - Port to peek. Must be an integer between 1 and 20.\n *\n * @returns Data in the specified port.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "peek(port: " + }, + { + "kind": "Reference", + "text": "Port", + "canonicalReference": "bitburner!Port:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string | number | object" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "port", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "peek" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#print:member(1)", + "docComment": "/**\n * Prints a value or a variable to the script’s logs.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param msg - Value to be printed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "print(msg: " + }, + { + "kind": "Content", + "text": "string | number | string[] | number[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "msg", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "print" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#prompt:member(1)", + "docComment": "/**\n * Prompts the player with a dialog box with two options: “Yes” and “No”. This function will return true if the player click “Yes” and false if the player clicks “No”. The script’s execution is halted until the player selects one of the options.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param txt - Text to appear in the prompt dialog box.\n *\n * @returns True if the player click “Yes” and false if the player clicks “No”.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "prompt(txt: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "txt", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "prompt" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#ps:member(1)", + "docComment": "/**\n * Returns an array with general information about all scripts running on the specified target server.\n *\n * @remarks\n *\n * 0.2 GB\n *\n * @param host - Host or IP address of the target server. If not specified, it will be the current server’s IP by default.\n *\n * @returns Array with general information about all scripts running on the specified target server.\n *\n * @example\n * ```js\n * //(using NetscriptJS (Netscript 2.0))\n * export async function main(ns) {\n * const ps = ns.ps(\"home\");\n * for (let i = 0; i < ps.length; ++i) {\n * ns.tprint(ps[i].filename + ' ' + ps[i].threads);\n * ns.tprint(ps[i].args);\n * }\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ps(host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ProcessInfo", + "canonicalReference": "bitburner!ProcessInfo:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "ps" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#purchaseServer:member(1)", + "docComment": "/**\n * Purchased a server with the specified hostname and amount of RAM.\n *\n * The hostname argument can be any data type, but it will be converted to a string and have whitespace removed. Anything that resolves to an empty string will cause the function to fail. If there is already a server with the specified hostname, then the function will automatically append a number at the end of the hostname argument value until it finds a unique hostname. For example, if the script calls \\`purchaseServer(“foo”, 4)\\` but a server named “foo” already exists, the it will automatically change the hostname to \\`foo-0\\`. If there is already a server with the hostname \\`foo-0\\`, then it will change the hostname to \\`foo-1\\`, and so on.\n *\n * Note that there is a maximum limit to the amount of servers you can purchase.\n *\n * Returns the hostname of the newly purchased server as a string. If the function fails to purchase a server, then it will return an empty string. The function will fail if the arguments passed in are invalid, if the player does not have enough money to purchase the specified server, or if the player has exceeded the maximum amount of servers.\n *\n * @remarks\n *\n * 2.25 GB\n *\n * @param hostname - Host of the purchased server.\n *\n * @param ram - Amount of RAM of the purchased server. Must be a power of 2 (2, 4, 8, 16, etc.). Maximum value of 1048576 (2^20).\n *\n * @returns The hostname of the newly purchased server.\n *\n * @example\n * ```js\n * ram = 64;\n * hn = \"pserv-\";\n * for (i = 0; i < 5; ++i) {\n * purchaseServer(hn + i, ram);\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseServer(hostname: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ram: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "hostname", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "ram", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "purchaseServer" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#read:member(1)", + "docComment": "/**\n * This function is used to read data from a port or from a text file (.txt).\n *\n * If the argument port/fn is a number between 1 and 20, then it specifies a port and it will read data from that port. A port is a serialized queue. This function will remove the first element from that queue and return it. If the queue is empty, then the string “NULL PORT DATA” will be returned.\n *\n * If the argument port/fn is a string, then it specifies the name of a text file (.txt) and this function will return the data in the specified text file. If the text file does not exist, an empty string will be returned.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param handle - Port or text file to read from.\n *\n * @returns Data in the specified text file or port.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "read(handle: " + }, + { + "kind": "Reference", + "text": "Handle", + "canonicalReference": "bitburner!Handle:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string | number | object" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handle", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "read" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#relaysmtp:member(1)", + "docComment": "/**\n * Runs the relaySMTP.exe program on the target server. relaySMTP.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * relaysmtp(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "relaysmtp(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "relaysmtp" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#rm:member(1)", + "docComment": "/**\n * Removes the specified file from the current server. This function works for every file type except message (.msg) files.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param name - Filename of file to remove. Must include the extension.\n *\n * @param host - Host or IP Address of the server on which to delete the file. Optional. Defaults to current server.\n *\n * @returns True if it successfully deletes the file, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "rm(name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "rm" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#run:member(1)", + "docComment": "/**\n * Run a script as a separate process. This function can only be used to run scripts located on the current server (the server running the script that calls this function). Requires a significant amount of RAM to run this command.\n *\n * If the script was successfully started, then this functions returns the PID of that script. Otherwise, it returns 0.\n *\n * PID stands for Process ID. The PID is a unique identifier for each script. The PID will always be a positive integer.\n *\n * Running this function with a numThreads argument of 0 will return 0 without running the script. However, running this function with a negative numThreads argument will cause a runtime error.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param script - Filename of script to run.\n *\n * @param numThreads - Optional thread count for new script. Set to 1 by default. Will be rounded to nearest integer.\n *\n * @param args - Additional arguments to pass into the new script that is being run. Note that if any arguments are being passed into the new script, then the second argument numThreads must be filled in with a value.\n *\n * @returns Returns the PID of a successfully started script, and 0 otherwise.\n *\n * @example\n * ```js\n * //The simplest way to use the run command is to call it with just the script name. The following example will run ‘foo.script’ single-threaded with no arguments:\n * run(\"foo.script\");\n * ```\n *\n * @example\n * ```js\n * //The following example will run ‘foo.script’ but with 5 threads instead of single-threaded:\n * run(\"foo.script\", 5);\n * ```\n *\n * @example\n * ```js\n * //This next example will run ‘foo.script’ single-threaded, and will pass the string ‘foodnstuff’ into the script as an argument:\n * run(\"foo.script\", 1, 'foodnstuff');\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "run(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", numThreads?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "numThreads", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "run" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scan:member(1)", + "docComment": "/**\n * Returns an array containing the hostnames or IPs of all servers that are one node way from the specified target server. The hostnames/IPs in the returned array are strings.\n *\n * @remarks\n *\n * 0.2 GB\n *\n * @param host - Hostname or IP of the server to scan.\n *\n * @param hostnames - Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false).\n *\n * @returns Returns an string of hostnames or IP.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scan(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", hostnames?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "hostnames", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "scan" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scp:member(1)", + "docComment": "/**\n * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.\n *\n * @remarks\n *\n * 0.6 GB\n *\n * @param files - Filename or an array of filenames of script/literature files to copy.\n *\n * @param destination - Host or IP of the destination server, which is the server to which the file will be copied.\n *\n * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.\n *\n * @example\n * ```js\n * //Copies hack-template.script from the current server to foodnstuff:\n * scp(\"hack-template.script\", \"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scp(files: " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", destination: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "files", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "parameterName": "destination", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "scp" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scp:member(2)", + "docComment": "/**\n * Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.\n *\n * @remarks\n *\n * 0.6 GB\n *\n * @param files - Filename or an array of filenames of script/literature files to copy.\n *\n * @param source - Host or IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.\n *\n * @param destination - Host or IP of the destination server, which is the server to which the file will be copied.\n *\n * @returns True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.\n *\n * @example\n * ```js\n * //Copies foo.lit from the helios server to the home computer:\n * scp(\"foo.lit\", \"helios\", \"home\");\n * ```\n *\n * @example\n * ```js\n * //Tries to copy three files from rothman-uni to home computer:\n * files = [\"foo1.lit\", \"foo2.script\", \"foo3.script\"];\n * scp(files, \"rothman-uni\", \"home\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scp(\n files: " + }, + { + "kind": "Content", + "text": "string | " + }, + { + "kind": "Reference", + "text": "ReadonlyArray", + "canonicalReference": "!ReadonlyArray:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ",\n source: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ",\n // tslint:disable-next-line:unified-signatures\n destination: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ",\n ): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "releaseTag": "Public", + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "files", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "parameterName": "source", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "destination", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + } + ], + "name": "scp" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scriptKill:member(1)", + "docComment": "/**\n * Kills all scripts with the specified filename on the target server specified by hostname/ip, regardless of arguments.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param script - Filename of script to kill. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @returns true if one or more scripts were successfully killed, and false if none were.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scriptKill(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "scriptKill" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#scriptRunning:member(1)", + "docComment": "/**\n * Returns a boolean indicating whether any instance of the specified script is running on the target server, regardless of its arguments.\n *\n * This is different than the isRunning function because it does not try to identify a specific instance of a running script by its arguments.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param script - Filename of script to check. This is case-sensitive.\n *\n * @param host - Host or IP of target server.\n *\n * @returns True if the specified script is running, and false otherwise.\n *\n * @example\n * ```js\n * //The function call will return true if there is any script named foo.script running on the foodnstuff server, and false otherwise:\n * scriptRunning(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //The function call will return true if there is any script named “foo.script” running on the current server, and false otherwise:\n * scriptRunning(\"foo.script\", getHostname());\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "scriptRunning(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "scriptRunning" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#serverExists:member(1)", + "docComment": "/**\n * Returns a boolean denoting whether or not the specified server exists.\n *\n * @remarks\n *\n * 0.1 GB\n *\n * @param host - Host or IP of target server.\n *\n * @returns True if specified server exists, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "serverExists(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "serverExists" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#sleep:member(1)", + "docComment": "/**\n * Suspends the script for n milliseconds.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param millis - Number of milliseconds to sleep.\n *\n * @returns \n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sleep(millis: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "millis", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "sleep" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#sleeve:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly sleeve: " + }, + { + "kind": "Reference", + "text": "Sleeve", + "canonicalReference": "bitburner!Sleeve:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sleeve", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#spawn:member(1)", + "docComment": "/**\n * Terminates the current script, and then after a delay of about 10 seconds it will execute the newly-specified script. The purpose of this function is to execute a new script without being constrained by the RAM usage of the current one. This function can only be used to run scripts on the local server.\n *\n * Because this function immediately terminates the script, it does not have a return value.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param script - Filename of script to execute.\n *\n * @param numThreads - Number of threads to spawn new script with. Will be rounded to nearest integer.\n *\n * @param args - Additional arguments to pass into the new script that is being run.\n *\n * @example\n * ```js\n * //The following example will execute the script ‘foo.script’ with 10 threads and the arguments ‘foodnstuff’ and 90:\n * spawn('foo.script', 10, 'foodnstuff', 90);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "spawn(script: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", numThreads?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "script", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "numThreads", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "spawn" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#sprintf:member(1)", + "docComment": "/**\n * Complete open source JavaScript sprintf implementation\n *\n * @remarks\n *\n * 0 GB\n *\n * @param format - String to format.\n *\n * @param args - Formating arguments.\n *\n * @returns Formated text.\n *\n * @see\n *\n * https://github.com/alexei/sprintf.js\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sprintf(format: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "format", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "sprintf" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#sqlinject:member(1)", + "docComment": "/**\n * Runs the SQLInject.exe program on the target server. SQLInject.exe must exist on your home computer.\n *\n * @remarks\n *\n * 0.05 GB\n *\n * @param host - Hostname or IP of the target server.\n *\n * @example\n * ```js\n * sqlinject(\"foodnstuff\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sqlinject(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "sqlinject" + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!NS#stock:member", + "docComment": "/**\n * @remarks\n *\n * 0 GB\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly stock: " + }, + { + "kind": "Reference", + "text": "TIX", + "canonicalReference": "bitburner!TIX:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "stock", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#tail:member(1)", + "docComment": "/**\n * Opens a script’s logs. This is functionally the same as the tail Terminal command.\n *\n * If the function is called with no arguments, it will open the current script’s logs.\n *\n * Otherwise, the fn, hostname/ip, and args… arguments can be used to get the logs from another script. Remember that scripts are uniquely identified by both their names and arguments.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param fn - Optional. Filename of the script being tailed. If omitted, the current script is tailed.\n *\n * @param host - Optional. Hostname or IP of the script being tailed. Defaults to the server this script is running on. If args are specified, this is not optional.\n *\n * @param args - Arguments for the script being tailed.\n *\n * @example\n * ```js\n * //Open logs from foo.script on the current server that was run with no args\n * tail(\"foo.script\");\n * ```\n *\n * @example\n * ```js\n * //Get logs from foo.script on the foodnstuff server that was run with no args\n * tail(\"foo.script\", \"foodnstuff\");\n * ```\n *\n * @example\n * ```js\n * //Get logs from foo.script on the foodnstuff server that was run with the arguments [1, \"test\"]\n * tail(\"foo.script\", \"foodnstuff\", 1, \"test\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tail(fn?: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", ...args: " + }, + { + "kind": "Content", + "text": "any[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "fn", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "tail" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#tprint:member(1)", + "docComment": "/**\n * Prints a value or a variable to the Terminal.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param msg - Value to be printed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tprint(msg: " + }, + { + "kind": "Content", + "text": "string | number | string[] | number[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "msg", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "tprint" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#tryWrite:member(1)", + "docComment": "/**\n * Attempts to write data to the specified Netscript Port. If the port is full, the data will not be written. Otherwise, the data will be written normally.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param port - Port or text file that will be written to.\n *\n * @param data - Data to write.\n *\n * @returns True if the data is successfully written to the port, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tryWrite(port: " + }, + { + "kind": "Reference", + "text": "Handle", + "canonicalReference": "bitburner!Handle:type" + }, + { + "kind": "Content", + "text": ", data: " + }, + { + "kind": "Content", + "text": "string | string[] | number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "port", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "tryWrite" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#vsprintf:member(1)", + "docComment": "/**\n * Complete open source JavaScript sprintf implementation\n *\n * @remarks\n *\n * 0 GB\n *\n * @param format - String to format.\n *\n * @param args - Formating arguments.\n *\n * @returns Formated text.\n *\n * @see\n *\n * https://github.com/alexei/sprintf.js\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "vsprintf(format: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "format", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "args", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "vsprintf" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#weaken:member(1)", + "docComment": "/**\n * Use your hacking skills to attack a server’s security, lowering the server’s security level. The runtime for this command depends on your hacking level and the target server’s security level. This function lowers the security level of the target server by 0.05.\n *\n * Like hack and grow, \\`weaken\\` can be called on any server, regardless of where the script is running. This command requires root access to the target server, but there is no required hacking level to run the command.\n *\n * @remarks\n *\n * 0.15 GB\n *\n * @param host - Hostname or IP of the target server to weaken.\n *\n * @param opts - Optional parameters for configuring function behavior.\n *\n * @returns The amount by which the target server’s security level was decreased. This is equivalent to 0.05 multiplied by the number of script threads.\n *\n * @example\n * ```js\n * weaken(\"foodnstuff\");\n * weaken(\"foodnstuff\", { threads: 5 }); // Only use 5 threads to weaken\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "weaken(host: " + }, + { + "kind": "Reference", + "text": "Host", + "canonicalReference": "bitburner!Host:type" + }, + { + "kind": "Content", + "text": ", opts?: " + }, + { + "kind": "Reference", + "text": "BasicHGWOptions", + "canonicalReference": "bitburner!BasicHGWOptions:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 7 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "opts", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "weaken" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#weakenAnalyze:member(1)", + "docComment": "/**\n * Returns the security decrease that would occur if a weaken with this many threads happened.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param threads - Amount of threads that will be used.\n *\n * @param cores - Optional. The number of cores of the server that would run weaken.\n *\n * @returns The security decrease.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "weakenAnalyze(threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", cores?: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "threads", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "cores", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "weakenAnalyze" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#wget:member(1)", + "docComment": "/**\n * Retrieves data from a URL and downloads it to a file on the specified server. The data can only be downloaded to a script (.script, .ns, .js) or a text file (.txt). If the file already exists, it will be overwritten by this command. Note that it will not be possible to download data from many websites because they do not allow cross-origin resource sharing (CORS).\n *\n * IMPORTANT: This is an asynchronous function that returns a Promise. The Promise’s resolved value will be a boolean indicating whether or not the data was successfully retrieved from the URL. Because the function is async and returns a Promise, it is recommended you use wget in NetscriptJS (Netscript 2.0).\n *\n * In NetscriptJS, you must preface any call to wget with the await keyword (like you would hack or sleep). wget will still work in Netscript 1.0, but the functions execution will not be synchronous (i.e. it may not execute when you expect/want it to). Furthermore, since Promises are not supported in ES5, you will not be able to process the returned value of wget in Netscript 1.0.\n *\n * @remarks\n *\n * 0 GB\n *\n * @param url - URL to pull data from.\n *\n * @param target - Filename to write data to. Must be script or text file.\n *\n * @param host - Optional hostname/ip of server for target file.\n *\n * @returns True if the data was successfully retrieved from the URL, false otherwise.\n *\n * @example\n * ```js\n * wget(\"https://raw.githubusercontent.com/danielyxie/bitburner/master/README.md\", \"game_readme.txt\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "wget(url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", target: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", host?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 9 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "url", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "target", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "host", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "wget" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!NS#write:member(1)", + "docComment": "/**\n * This function can be used to either write data to a port or to a text file (.txt).\n *\n * If the first argument is a number between 1 and 20, then it specifies a port and this function will write data to that port. The third argument, mode, is not used when writing to a port.\n *\n * If the first argument is a string, then it specifies the name of a text file (.txt) and this function will write data to that text file. If the specified text file does not exist, then it will be created. The third argument mode, defines how the data will be written to the text file. If *mode is set to “w”, then the data is written in “write” mode which means that it will overwrite all existing data on the text file. If mode is set to any other value then the data will be written in “append” mode which means that the data will be added at the end of the text file.\n *\n * @remarks\n *\n * 1 GB\n *\n * @param handle - Port or text file that will be written to.\n *\n * @param data - Data to write.\n *\n * @param mode - Defines the write mode. Only valid when writing to text files.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "write(handle: " + }, + { + "kind": "Reference", + "text": "Handle", + "canonicalReference": "bitburner!Handle:type" + }, + { + "kind": "Content", + "text": ", data?: " + }, + { + "kind": "Content", + "text": "string | string[] | number" + }, + { + "kind": "Content", + "text": ", mode?: " + }, + { + "kind": "Content", + "text": "\"w\" | \"a\"" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "handle", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "mode", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "write" + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 3 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!OrderPos:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type OrderPos = " + }, + { + "kind": "Content", + "text": "\"long\" | \"short\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "OrderPos", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!OrderType:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type OrderType = " + }, + { + "kind": "Content", + "text": "\"limitbuy\" | \"limitsell\" | \"stopbuy\" | \"stopsell\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "OrderType", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!PlayerStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface PlayerStats " + } + ], + "releaseTag": "Public", + "name": "PlayerStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#agility:member", + "docComment": "/**\n * Agility level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#charisma:member", + "docComment": "/**\n * Chraisma level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#defense:member", + "docComment": "/**\n * Defense level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#dexterity:member", + "docComment": "/**\n * Dexterity level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#hacking:member", + "docComment": "/**\n * Hacking level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#intelligence:member", + "docComment": "/**\n * Intelligence level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "intelligence: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "intelligence", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!PlayerStats#strength:member", + "docComment": "/**\n * Strength level\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Port:type", + "docComment": "/**\n * A port is implemented as a sort of serialized queue, where you can only write and read one element at a time from the port. When you read data from a port, the element that is read is removed from the port.\n *\n * IMPORTANT: The data inside ports are not saved! This means if you close and re-open the game, or reload the page then you will lose all of the data in the ports!\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Port = " + }, + { + "kind": "Content", + "text": "1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Port", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!ProcessInfo:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface ProcessInfo " + } + ], + "releaseTag": "Public", + "name": "ProcessInfo", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!ProcessInfo#args:member", + "docComment": "/**\n * Script's arguments\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "args: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "args", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!ProcessInfo#filename:member", + "docComment": "/**\n * Script name.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "filename: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "filename", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!ProcessInfo#threads:member", + "docComment": "/**\n * Number of threads script is running with\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "threads: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "threads", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!PurchaseableProgram:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type PurchaseableProgram =\n " + }, + { + "kind": "Content", + "text": "| \"brutessh.exe\"\n | \"ftpcrack.exe\"\n | \"relaysmtp.exe\"\n | \"httpworm.exe\"\n | \"sqlinject.exe\"\n | \"deepscanv1.exe\"\n | \"deepscanv2.exe\"\n | \"autolink.exe\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "PurchaseableProgram", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!Script:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Script = " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "Script", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Server:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Server " + } + ], + "releaseTag": "Public", + "name": "Server", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#cpuCores:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "cpuCores: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "cpuCores", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#ftpPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ftpPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ftpPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#hasAdminRights:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hasAdminRights: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hasAdminRights", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#hostname:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "hostname: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hostname", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#httpPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "httpPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "httpPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#ip:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ip: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ip", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#isConnectedTo:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "isConnectedTo: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "isConnectedTo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#maxRam:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxRam: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "maxRam", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#organizationName:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "organizationName: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "organizationName", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#ramUsed:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ramUsed: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "ramUsed", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#smtpPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "smtpPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "smtpPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#sqlPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "sqlPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sqlPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!Server#sshPortOpen:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "sshPortOpen: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sshPortOpen", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Singularity:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Singularity " + } + ], + "releaseTag": "Public", + "name": "Singularity", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#applyToCompany:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically try to apply to the specified company for a position in the specified field. This function can also be used to apply for promotions by specifying the company and field you are already employed at.\n *\n * This function will return true if you successfully get a job/promotion, and false otherwise. Note that if you are trying to use this function to apply for a promotion and you don’t get one, it will return false.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of company to apply to.\n *\n * @param field - Field to which you want to apply.\n *\n * @returns True if the player successfully get a job/promotion, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "applyToCompany(companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": ", field: " + }, + { + "kind": "Reference", + "text": "CompanyField", + "canonicalReference": "bitburner!CompanyField:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "field", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "applyToCompany" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#checkFactionInvitations:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array with the name of all Factions you currently have oustanding invitations from.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @returns Array with the name of all Factions you currently have oustanding invitations from.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "checkFactionInvitations(): " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "checkFactionInvitations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#commitCrime:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function is used to automatically attempt to commit crimes. If you are already in the middle of some ‘working’ action (such as working for a company or training at a gym), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns the number of seconds it takes to attempt the specified crime (e.g It takes 60 seconds to attempt the ‘Rob Store’ crime, so running \\`commitCrime('rob store')\\` will return 60).\n *\n * Warning: I do not recommend using the time returned from this function to try and schedule your crime attempts. Instead, I would use the isBusy Singularity function to check whether you have finished attempting a crime. This is because although the game sets a certain crime to be X amount of seconds, there is no guarantee that your browser will follow that time limit.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param crime - Name of crime to attempt.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "commitCrime(crime: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "crime", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "commitCrime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#createProgram:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working on creating the specified program. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or taking a course), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function returns true if you successfully start working on the specified program, and false otherwise.\n *\n * Note that creating a program using this function has the same hacking level requirements as it normally would. These level requirements are: * BruteSSH.exe: 50 * FTPCrack.exe: 100 * relaySMTP.exe: 250 * HTTPWorm.exe: 500 * SQLInject.exe: 750 * DeepscanV1.exe: 75 * DeepscanV2.exe: 400 * ServerProfiler.exe: 75 * AutoLink.exe: 25\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param program - Name of program to create.\n *\n * @returns True if you successfully start working on the specified program, and false otherwise.\n *\n * @example\n * ```js\n * createProgram(“relaysmtp.exe”);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "createProgram(program: " + }, + { + "kind": "Reference", + "text": "CreatableProgram", + "canonicalReference": "bitburner!CreatableProgram:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "program", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "createProgram" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#donateToFaction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Attempts to donate money to the specified faction in exchange for reputation. Returns true if you successfully donate the money, and false otherwise.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param faction - Name of faction to donate to.\n *\n * @param amount - Amount of money to donate.\n *\n * @returns True if the money was donated, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "donateToFaction(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": ", amount: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "amount", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "donateToFaction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getAugmentationCost:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array with two elements that gives the cost for the specified Augmentation. The first element in the returned array is the reputation requirement of the Augmentation, and the second element is the money cost.\n *\n * If an invalid Augmentation name is passed in for the augName argument, this function will return the array [-1, -1].\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with first element as a reputation requirement and second element as the money cost.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAugmentationCost(augName: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "[number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "augName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAugmentationCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getAugmentationPrereq:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array with the names of the prerequisite Augmentation(s) for the specified Augmentation. If there are no prerequisites, a blank array is returned.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param augName - Name of Augmentation.\n *\n * @returns Array with the names of the prerequisite Augmentation(s) for the specified Augmentation.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAugmentationPrereq(augName: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "augName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAugmentationPrereq" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getAugmentationsFromFaction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array containing the names (as strings) of all Augmentations that are available from the specified faction.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param faction - Name of faction.\n *\n * @returns Array containing the names of all Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAugmentationsFromFaction(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAugmentationsFromFaction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getAugmentationStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns augmentation stats.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param name - Name of Augmentation. CASE-SENSITIVE.\n *\n * @returns Augmentation stats.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAugmentationStats(name: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentationStats", + "canonicalReference": "bitburner!AugmentationStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAugmentationStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCharacterInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an object with various information about your character.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns Object with various information about your character.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCharacterInformation(): " + }, + { + "kind": "Reference", + "text": "CharacterInfo", + "canonicalReference": "bitburner!CharacterInfo:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getCharacterInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCompanyFavor:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of favor you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you have at the specified company.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCompanyFavor(companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCompanyFavor" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCompanyFavorGain:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of favor you will gain for the specified company when you reset by installing Augmentations.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of favor you gain at the specified company when you reset by installing Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCompanyFavorGain(companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCompanyFavorGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCompanyRep:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will return the amount of reputation you have at the specified company. If the company passed in as an argument is invalid, -1 will be returned.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of the company.\n *\n * @returns Amount of reputation you have at the specified company.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCompanyRep(companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCompanyRep" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCrimeChance:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns your chance of success at commiting the specified crime. The chance is returned as a decimal (i.e. 60% would be returned as 0.6).\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param crime - Name of crime.\n *\n * @returns Chance of success at commiting the specified crime as a decimal.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCrimeChance(crime: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "crime", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCrimeChance" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getCrimeStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns the stats of the crime.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param crime - Name of crime. Not case-sensitive\n *\n * @returns The stats of the crime.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getCrimeStats(crime: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "CrimeStats", + "canonicalReference": "bitburner!CrimeStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "crime", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getCrimeStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getFactionFavor:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of favor you have for the specified faction.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you have for the specified faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getFactionFavor(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getFactionFavor" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getFactionFavorGain:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction.\n *\n * @returns Amount of favor you will gain for the specified faction when you reset by installing Augmentations.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getFactionFavorGain(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getFactionFavorGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getFactionRep:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns the amount of reputation you have for the specified faction.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction to work for.\n *\n * @returns Amount of reputation you have for the specified faction.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getFactionRep(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getFactionRep" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getOwnedAugmentations:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function returns an array containing the names (as strings) of all Augmentations you have.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param purchased - Specifies whether the returned array should include Augmentations you have purchased but not yet installed. By default, this argument is false which means that the return value will NOT have the purchased Augmentations.\n *\n * @returns Array containing the names (as strings) of all Augmentations you have.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOwnedAugmentations(purchased?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "purchased", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getOwnedAugmentations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getOwnedSourceFiles:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an array of source files\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @returns Array containing an object with number and level of the source file.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOwnedSourceFiles(): " + }, + { + "kind": "Reference", + "text": "SourceFileLvl", + "canonicalReference": "bitburner!SourceFileLvl:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getOwnedSourceFiles" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns an object with the Player’s stats.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns Object with the Player’s stats.\n *\n * @example\n * ```js\n * res = getStats();\n * print('My charisma level is: ' + res.charisma);\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getStats(): " + }, + { + "kind": "Reference", + "text": "PlayerStats", + "canonicalReference": "bitburner!PlayerStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#getUpgradeHomeRamCost:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns the cost of upgrading the player’s home computer RAM.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @returns Cost of upgrading the player’s home computer RAM.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getUpgradeHomeRamCost(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getUpgradeHomeRamCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#gymWorkout:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working out at a gym to train a particular stat. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these gyms are the same as if you were to manually visit these gyms and train\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @param gymName - Name of gym. You must be in the correct city for whatever gym you specify.\n *\n * @param stat - The stat you want to train.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "gymWorkout(gymName: " + }, + { + "kind": "Reference", + "text": "Gym", + "canonicalReference": "bitburner!Gym:type" + }, + { + "kind": "Content", + "text": ", stat: " + }, + { + "kind": "Reference", + "text": "GymStat", + "canonicalReference": "bitburner!GymStat:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "gymName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "stat", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "gymWorkout" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#installAugmentations:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically install your Augmentations, resetting the game as usual.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param cbScript - Optional callback script. This is a script that will automatically be run after Augmentations are installed (after the reset). This script will be run with no arguments and 1 thread. It must be located on your home computer.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "installAugmentations(cbScript?: " + }, + { + "kind": "Reference", + "text": "Script", + "canonicalReference": "bitburner!Script:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "cbScript", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "installAugmentations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#isBusy:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * Returns a boolean indicating whether or not the player is currently performing an ‘action’. These actions include working for a company/faction, studying at a univeristy, working out at a gym, creating a program, committing a crime, or carrying out a Hacking Mission.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns True if the player is currently performing an ‘action’, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "isBusy(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "isBusy" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#joinFaction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically accept an invitation from a faction and join it.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction to join.\n *\n * @returns True if player joined the faction, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "joinFaction(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "joinFaction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#purchaseAugmentation:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will try to purchase the specified Augmentation through the given Faction.\n *\n * This function will return true if the Augmentation is successfully purchased, and false otherwise.\n *\n * @remarks\n *\n * Singularity - Level 3\n *\n * @param faction - Name of faction to purchase Augmentation from.\n *\n * @param augmnet - Name of Augmentation to purchase.\n *\n * @returns True if the Augmentation is successfully purchased, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseAugmentation(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": ", augmnet: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "augmnet", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "purchaseAugmentation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#purchaseProgram:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows you to automatically purchase programs. You MUST have a TOR router in order to use this function. The cost of purchasing programs using this function is the same as if you were purchasing them through the Dark Web using the Terminal buy command.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @param programName - Name of program to purchase.\n *\n * @returns True if the specified program is purchased, and false otherwise.\n *\n * @example\n * ```js\n * purchaseProgram(\"brutessh.exe\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseProgram(programName: " + }, + { + "kind": "Reference", + "text": "PurchaseableProgram", + "canonicalReference": "bitburner!PurchaseableProgram:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "programName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "purchaseProgram" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#purchaseTor:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows you to automatically purchase a TOR router. The cost for purchasing a TOR router using this function is the same as if you were to manually purchase one.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns True if actions is successful, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseTor(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "purchaseTor" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#softReset:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 3 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will perform a reset even if you don’t have any augmentation installed.\n *\n * @remarks\n *\n * Singularity - Level 3\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "softReset(): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "softReset" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#stopAction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function is used to end whatever ‘action’ the player is currently performing. The player will receive whatever money/experience/etc. he has earned from that action.\n *\n * The actions that can be stopped with this function are:\n *\n * * Studying at a university * Working for a company/faction * Creating a program * Committing a Crime\n *\n * This function will return true if the player’s action was ended. It will return false if the player was not performing an action when this function was called.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @returns True if the player’s action was ended, false if the player was not performing an action.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "stopAction(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "stopAction" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#travelToCity:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function allows the player to travel to any city. The cost for using this function is the same as the cost for traveling through the Travel Agency.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @param city - City to travel to.\n *\n * @returns True if actions is successful, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "travelToCity(city: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "city", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "travelToCity" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#universityCourse:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 1 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start taking a course at a university. If you are already in the middle of some “working” action (such as working at a company, for a faction, or on a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * The cost and experience gains for all of these universities and classes are the same as if you were to manually visit and take these classes.\n *\n * @remarks\n *\n * Singularity - Level 1\n *\n * @param universityName - Name of university. You must be in the correct city for whatever university you specify.\n *\n * @param courseName - Name of course.\n *\n * @returns True if actions is successfully started, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "universityCourse(universityName: " + }, + { + "kind": "Reference", + "text": "University", + "canonicalReference": "bitburner!University:type" + }, + { + "kind": "Content", + "text": ", courseName: " + }, + { + "kind": "Reference", + "text": "UniversityCourse", + "canonicalReference": "bitburner!UniversityCourse:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "universityName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "courseName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "universityCourse" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#upgradeHomeRam:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will upgrade amount of RAM on the player’s home computer. The cost is the same as if you were to do it manually.\n *\n * This function will return true if the player’s home computer RAM is successfully upgraded, and false otherwise.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @returns True if the player’s home computer RAM is successfully upgraded, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "upgradeHomeRam(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "upgradeHomeRam" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#workForCompany:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working at the company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if the player starts working, and false otherwise.\n *\n * Note that when you are working for a company, you will not actually receive your earnings (reputation, money, experience) until you FINISH the action.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param companyName - Name of company to work for. Must be an exact match. Optional. If not specified, this argument defaults to the last job that you worked\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```js\n * //If you only want to work until you get 100,000 company reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getCompanyRep(COMPANY HERE) < VALUE) {\n * workForCompany();\n * sleep(60000);\n * }\n * //This way, your company reputation will be updated every minute.\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workForCompany(companyName?: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "workForCompany" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Singularity#workForFaction:member(1)", + "docComment": "/**\n * If you are not in BitNode-4, then you must have Level 2 of Source-File 4 in order to use this function and the RAM cost is doubled.\n *\n * This function will automatically set you to start working for the specified faction. Obviously, you must be a member of the faction or else this function will fail. If you are already in the middle of some “working” action (such as working for a company, training at a gym, or creating a program), then running this function will automatically cancel that action and give you your earnings.\n *\n * This function will return true if you successfully start working for the specified faction, and false otherwise.\n *\n * Note that when you are working for a faction, you will not actually receive your earnings (reputation, experience) until you FINISH the action.\n *\n * @remarks\n *\n * Singularity - Level 2\n *\n * @param faction - Name of faction to work for.\n *\n * @param workType - Type of work to perform for the faction.\n *\n * @returns True if the player starts working, and false otherwise.\n *\n * @example\n * ```js\n * //If you only want to work until you get 100,000 faction reputation. One small hack to get around this is to continuously restart the action to receive your earnings:\n * while (getFactionRep(FACTION NAME) < VALUE) {\n * workForFaction(FACNAME, WORKTYPE);\n * sleep(60000);\n * }\n * //This way, your faction reputation will be updated every minute.\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workForFaction(faction: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": ", workType: " + }, + { + "kind": "Reference", + "text": "FactionWork", + "canonicalReference": "bitburner!FactionWork:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "faction", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "workType", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "workForFaction" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!Sleeve:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Sleeve " + } + ], + "releaseTag": "Public", + "name": "Sleeve", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getInformation:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a struct containing tons of information about this sleeve\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve information.\n *\n * @returns Object containing tons of information about this sleeve.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getInformation(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SleeveInformation", + "canonicalReference": "bitburner!SleeveInformation:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getInformation" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getNumSleeves:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return the number of duplicate sleeves the player has.\n *\n * @remarks\n *\n * 4 GB\n *\n * @returns number of duplicate sleeves the player has.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getNumSleeves(): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getNumSleeves" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getSleeveAugmentations:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a list of augmentation names that this sleeve has installed.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve augmentations from.\n *\n * @returns List of augmentation names that this sleeve has installed.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSleeveAugmentations(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSleeveAugmentations" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getSleevePurchasableAugs:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a list of augmentations that the player can buy for this sleeve.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve purchasable augmentations from.\n *\n * @returns List of augmentations that the player can buy for this sleeve.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSleevePurchasableAugs(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "AugmentPair", + "canonicalReference": "bitburner!AugmentPair:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSleevePurchasableAugs" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getSleeveStats:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a structure containing the stats of the sleeve.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to get stats of.\n *\n * @returns Object containing the stats of the sleeve.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSleeveStats(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SleeveStats", + "canonicalReference": "bitburner!SleeveStats:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getSleeveStats" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#getTask:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return the current task that the sleeve is performing. type is set to “Idle” if the sleeve isn’t doing anything.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to retrieve task from.\n *\n * @returns Object containing information the current task that the sleeve is performing.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getTask(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "SleeveTask", + "canonicalReference": "bitburner!SleeveTask:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getTask" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#purchaseSleeveAug:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return true if the aug was purchased and installed on the sleeve.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to buy an aug for.\n *\n * @param augName - Name of the aug to buy. Must be an exact match.\n *\n * @returns True if the aug was purchased and installed on the sleeve, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchaseSleeveAug(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", augName: " + }, + { + "kind": "Reference", + "text": "AugmentName", + "canonicalReference": "bitburner!AugmentName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "augName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "purchaseSleeveAug" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToCommitCrime:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * Returns false if an invalid action is specified.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start commiting crime.\n *\n * @param name - Name of the crime. Must be an exact match.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToCommitCrime(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", name: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "name", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "setToCommitCrime" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToCompanyWork:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working or this company.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to work for the company.\n *\n * @param companyName - Name of the company to work for.\n *\n * @returns True if the sleeve started working on this company, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToCompanyWork(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", companyName: " + }, + { + "kind": "Reference", + "text": "CompanyName", + "canonicalReference": "bitburner!CompanyName:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "companyName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "setToCompanyWork" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToFactionWork:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working or this faction.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to work for the faction.\n *\n * @param factionName - Name of the faction to work for.\n *\n * @param factionWorkType - Name of the action to perform for this faction.\n *\n * @returns True if the sleeve started working on this faction, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToFactionWork(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", factionName: " + }, + { + "kind": "Reference", + "text": "FactionName", + "canonicalReference": "bitburner!FactionName:type" + }, + { + "kind": "Content", + "text": ", factionWorkType: " + }, + { + "kind": "Reference", + "text": "FactionWork", + "canonicalReference": "bitburner!FactionWork:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "factionName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "factionWorkType", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "setToFactionWork" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToGymWorkout:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve started working out.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to workout at the gym.\n *\n * @param gymName - Name of the gym.\n *\n * @param stat - Name of the stat to train.\n *\n * @returns True if the sleeve started working out, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToGymWorkout(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", gymName: " + }, + { + "kind": "Reference", + "text": "Gym", + "canonicalReference": "bitburner!Gym:type" + }, + { + "kind": "Content", + "text": ", stat: " + }, + { + "kind": "Reference", + "text": "GymStat", + "canonicalReference": "bitburner!GymStat:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "gymName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "stat", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "setToGymWorkout" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToShockRecovery:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start recovery.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToShockRecovery(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setToShockRecovery" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToSynchronize:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start synchronizing.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToSynchronize(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "setToSynchronize" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#setToUniversityCourse:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not this action was set successfully.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to start taking class.\n *\n * @param university - Name of the university to attend.\n *\n * @param className - Name of the class to follow.\n *\n * @returns True if this action was set successfully, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "setToUniversityCourse(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", university: " + }, + { + "kind": "Reference", + "text": "University", + "canonicalReference": "bitburner!University:type" + }, + { + "kind": "Content", + "text": ", className: " + }, + { + "kind": "Reference", + "text": "UniversityCourse", + "canonicalReference": "bitburner!UniversityCourse:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "university", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "className", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "setToUniversityCourse" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!Sleeve#travel:member(1)", + "docComment": "/**\n * If you are not in BitNode-10, then you must have Source-File 10 in order to use this function.\n *\n * Return a boolean indicating whether or not the sleeve reached destination.\n *\n * @remarks\n *\n * 4 GB\n *\n * @param sleeveNumber - Index of the sleeve to travel.\n *\n * @param cityName - Name of the destination city.\n *\n * @returns True if the sleeve reached destination, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "travel(sleeveNumber: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", cityName: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sleeveNumber", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "cityName", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "travel" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SleeveInformation:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SleeveInformation " + } + ], + "releaseTag": "Public", + "name": "SleeveInformation", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#city:member", + "docComment": "/**\n * location of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "city: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "city", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#earningsForPlayer:member", + "docComment": "/**\n * earnings synchronized to the player\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "earningsForPlayer: " + }, + { + "kind": "Reference", + "text": "SleeveWorkGains", + "canonicalReference": "bitburner!SleeveWorkGains:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "earningsForPlayer", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#earningsForSleeves:member", + "docComment": "/**\n * earnings synchronized to other sleeves\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "earningsForSleeves: " + }, + { + "kind": "Reference", + "text": "SleeveWorkGains", + "canonicalReference": "bitburner!SleeveWorkGains:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "earningsForSleeves", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#earningsForTask:member", + "docComment": "/**\n * earnings for this sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "earningsForTask: " + }, + { + "kind": "Reference", + "text": "SleeveWorkGains", + "canonicalReference": "bitburner!SleeveWorkGains:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "earningsForTask", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#hp:member", + "docComment": "/**\n * current hp of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#jobs:member", + "docComment": "/**\n * jobs available to the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "jobs: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "jobs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#jobTitle:member", + "docComment": "/**\n * job titles available to the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "jobTitle: " + }, + { + "kind": "Reference", + "text": "CompanyField", + "canonicalReference": "bitburner!CompanyField:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "jobTitle", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#maxHp:member", + "docComment": "/**\n * max hp of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "maxHp: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "maxHp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#mult:member", + "docComment": "/**\n * sleeve multipliers\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mult: " + }, + { + "kind": "Reference", + "text": "CharacterMult", + "canonicalReference": "bitburner!CharacterMult:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "mult", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#timeWorked:member", + "docComment": "/**\n * time spent on the current task in milliseconds\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timeWorked: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "timeWorked", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#tor:member", + "docComment": "/**\n * does this sleeve have access to the tor router\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tor: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "tor", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveInformation#workRepGain:member", + "docComment": "/**\n * faction or company reputation gained for the current task\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workRepGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workRepGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SleeveStats:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SleeveStats " + } + ], + "releaseTag": "Public", + "name": "SleeveStats", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#agility:member", + "docComment": "/**\n * current agility of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "agility: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "agility", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#charisma:member", + "docComment": "/**\n * current charisma of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "charisma: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "charisma", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#defense:member", + "docComment": "/**\n * current defense of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "defense: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "defense", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#dexterity:member", + "docComment": "/**\n * current dexterity of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "dexterity: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "dexterity", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#hacking_skill:member", + "docComment": "/**\n * current hacking skill of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hacking_skill: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "hacking_skill", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#shock:member", + "docComment": "/**\n * current shock of the sleeve [0-100]\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "shock:\n " + }, + { + "kind": "Content", + "text": "| 0\n | 1\n | 2\n | 3\n | 4\n | 5\n | 6\n | 7\n | 8\n | 9\n | 10\n | 11\n | 12\n | 13\n | 14\n | 15\n | 16\n | 17\n | 18\n | 19\n | 20\n | 21\n | 22\n | 23\n | 24\n | 25\n | 26\n | 27\n | 28\n | 29\n | 30\n | 31\n | 32\n | 33\n | 34\n | 35\n | 36\n | 37\n | 38\n | 39\n | 40\n | 41\n | 42\n | 43\n | 44\n | 45\n | 46\n | 47\n | 48\n | 49\n | 50\n | 51\n | 52\n | 53\n | 54\n | 55\n | 56\n | 57\n | 58\n | 59\n | 60\n | 61\n | 62\n | 63\n | 64\n | 65\n | 66\n | 67\n | 68\n | 69\n | 70\n | 71\n | 72\n | 73\n | 74\n | 75\n | 76\n | 77\n | 78\n | 79\n | 80\n | 81\n | 82\n | 83\n | 84\n | 85\n | 86\n | 87\n | 88\n | 89\n | 90\n | 91\n | 92\n | 93\n | 94\n | 95\n | 96\n | 97\n | 98\n | 99\n | 100" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "shock", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#strength:member", + "docComment": "/**\n * current strength of the sleeve\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "strength: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "strength", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveStats#sync:member", + "docComment": "/**\n * current sync of the sleeve [0-100]\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sync:\n " + }, + { + "kind": "Content", + "text": "| 0\n | 1\n | 2\n | 3\n | 4\n | 5\n | 6\n | 7\n | 8\n | 9\n | 10\n | 11\n | 12\n | 13\n | 14\n | 15\n | 16\n | 17\n | 18\n | 19\n | 20\n | 21\n | 22\n | 23\n | 24\n | 25\n | 26\n | 27\n | 28\n | 29\n | 30\n | 31\n | 32\n | 33\n | 34\n | 35\n | 36\n | 37\n | 38\n | 39\n | 40\n | 41\n | 42\n | 43\n | 44\n | 45\n | 46\n | 47\n | 48\n | 49\n | 50\n | 51\n | 52\n | 53\n | 54\n | 55\n | 56\n | 57\n | 58\n | 59\n | 60\n | 61\n | 62\n | 63\n | 64\n | 65\n | 66\n | 67\n | 68\n | 69\n | 70\n | 71\n | 72\n | 73\n | 74\n | 75\n | 76\n | 77\n | 78\n | 79\n | 80\n | 81\n | 82\n | 83\n | 84\n | 85\n | 86\n | 87\n | 88\n | 89\n | 90\n | 91\n | 92\n | 93\n | 94\n | 95\n | 96\n | 97\n | 98\n | 99\n | 100" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "sync", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SleeveTask:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SleeveTask " + } + ], + "releaseTag": "Public", + "name": "SleeveTask", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#crime:member", + "docComment": "/**\n * crime currently attempting, if any\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "crime: " + }, + { + "kind": "Reference", + "text": "Crime", + "canonicalReference": "bitburner!Crime:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "crime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#factionWorkType:member", + "docComment": "/**\n * faction work type being performed, if any\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "factionWorkType: " + }, + { + "kind": "Reference", + "text": "FactionWork", + "canonicalReference": "bitburner!FactionWork:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "factionWorkType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#gymStatType:member", + "docComment": "/**\n * stat being trained at the gym, if any\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "gymStatType: " + }, + { + "kind": "Reference", + "text": "GymStat", + "canonicalReference": "bitburner!GymStat:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "gymStatType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#location:member", + "docComment": "/**\n * location of the task, if any\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "location: " + }, + { + "kind": "Reference", + "text": "City", + "canonicalReference": "bitburner!City:type" + }, + { + "kind": "Content", + "text": " | \"\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "location", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveTask#task:member", + "docComment": "/**\n * task type\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "task: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "task", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SleeveWorkGains:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SleeveWorkGains " + } + ], + "releaseTag": "Public", + "name": "SleeveWorkGains", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workAgiExpGain:member", + "docComment": "/**\n * agility exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workAgiExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workAgiExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workChaExpGain:member", + "docComment": "/**\n * charisma exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workChaExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workChaExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workDefExpGain:member", + "docComment": "/**\n * defense exp gained from work,\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workDefExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workDefExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workDexExpGain:member", + "docComment": "/**\n * dexterity exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workDexExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workDexExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workHackExpGain:member", + "docComment": "/**\n * hacking exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workHackExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workHackExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workMoneyGain:member", + "docComment": "/**\n * money gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workMoneyGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workMoneyGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SleeveWorkGains#workStrExpGain:member", + "docComment": "/**\n * strength exp gained from work\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "workStrExpGain: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "workStrExpGain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!SourceFileLvl:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SourceFileLvl " + } + ], + "releaseTag": "Public", + "name": "SourceFileLvl", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SourceFileLvl#lvl:member", + "docComment": "/**\n * The level of the source file\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "lvl: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "lvl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!SourceFileLvl#n:member", + "docComment": "/**\n * The number of the source file\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "n: " + }, + { + "kind": "Content", + "text": "1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "n", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!StockOrder:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type StockOrder = " + }, + { + "kind": "Content", + "text": "{\n /** Stock Symbol */\n [key in " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "]?: " + }, + { + "kind": "Reference", + "text": "StockOrderObject", + "canonicalReference": "bitburner!StockOrderObject:interface" + }, + { + "kind": "Content", + "text": "[];\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "StockOrder", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!StockOrderObject:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface StockOrderObject " + } + ], + "releaseTag": "Public", + "name": "StockOrderObject", + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!StockOrderObject#position:member", + "docComment": "/**\n * Order position\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "position: " + }, + { + "kind": "Content", + "text": "\"S\" | \"L\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "position", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!StockOrderObject#price:member", + "docComment": "/**\n * Price per share\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "price: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "price", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!StockOrderObject#shares:member", + "docComment": "/**\n * Number of shares\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "shares", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "bitburner!StockOrderObject#type:member", + "docComment": "/**\n * Order type\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Content", + "text": "\"Limit Buy Order\" | \"Limit Sell Order\" | \"Stop Buy Order\" | \"Stop Buy Order\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!StockSymbol:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type StockSymbol =\n " + }, + { + "kind": "Content", + "text": "| \"ECP\"\n | \"MGCP\"\n | \"BLD\"\n | \"CLRK\"\n | \"OMTK\"\n | \"FSIG\"\n | \"KGI\"\n | \"FLCM\"\n | \"STM\"\n | \"DCOMM\"\n | \"HLS\"\n | \"VITA\"\n | \"ICRS\"\n | \"UNV\"\n | \"AERO\"\n | \"OMN\"\n | \"SLRS\"\n | \"GPH\"\n | \"NVMD\"\n | \"WDS\"\n | \"LXO\"\n | \"RHOC\"\n | \"APHE\"\n | \"SYSC\"\n | \"CTK\"\n | \"NTLK\"\n | \"OMGA\"\n | \"FNS\"\n | \"SGC\"\n | \"JGN\"\n | \"CTYS\"\n | \"MDYN\"\n | \"TITN\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "StockSymbol", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "bitburner!TIX:interface", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface TIX " + } + ], + "releaseTag": "Public", + "name": "TIX", + "members": [ + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#buy:member(1)", + "docComment": "/**\n * Attempts to purchase shares of a stock using a Market Order.\n *\n * If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.\n *\n * If this function successfully purchases the shares, it will return the stock price at which each share was purchased. Otherwise, it will return 0.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to purchased. Must be positive. Will be rounded to nearest integer.\n *\n * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "buy(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "buy" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#cancelOrder:member(1)", + "docComment": "/**\n * Cancels an oustanding Limit or Stop order on the stock market.\n *\n * The ability to use limit and stop orders is **not** immediately available to the player and must be unlocked later on in the game.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer.\n *\n * @param price - Execution price for the order.\n *\n * @param type - Type of order.\n *\n * @param pos - Specifies whether the order is a “Long” or “Short” position.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cancelOrder(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", price: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", type: " + }, + { + "kind": "Reference", + "text": "OrderType", + "canonicalReference": "bitburner!OrderType:type" + }, + { + "kind": "Content", + "text": ", pos: " + }, + { + "kind": "Reference", + "text": "OrderPos", + "canonicalReference": "bitburner!OrderPos:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "price", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "parameterName": "pos", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "cancelOrder" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getAskPrice:member(1)", + "docComment": "/**\n * Given a stock’s symbol (NOT the company name), returns the ask price of that stock. The symbol is a sequence of two to four capital letters.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns The ask price of a stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getAskPrice(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getAskPrice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getBidPrice:member(1)", + "docComment": "/**\n * Given a stock’s symbol (NOT the company name), returns the bid price of that stock. The symbol is a sequence of two to four capital letters.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns The bid price of a stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getBidPrice(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getBidPrice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getForecast:member(1)", + "docComment": "/**\n * Returns the probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.\n *\n * The probability is returned as a decimal value, NOT a percentage (e.g. if a stock has a 60% chance of increasing, then this function will return 0.6, NOT 60).\n *\n * In other words, if this function returned 0.30 for a stock, then this means that the stock’s price has a 30% chance of increasing and a 70% chance of decreasing during the next tick.\n *\n * In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns Probability that the specified stock’s price will increase (as opposed to decrease) during the next tick.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getForecast(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getForecast" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getMaxShares:member(1)", + "docComment": "/**\n * Returns the maximum number of shares that the stock has. This is the maximum amount of the stock that can be purchased in both the Long and Short positions combined.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns Maximum number of shares that the stock has.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getMaxShares(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getMaxShares" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getOrders:member(1)", + "docComment": "/**\n * Returns your order book for the stock market.\n *\n * This is an object containing information for all the Limit and Stop Orders you have in the stock market. The object has the following structure:\n * ```js\n * {\n * StockSymbol1: [ // Array of orders for this stock\n * {\n * shares: Order quantity\n * price: Order price\n * type: Order type\n * position: Either \"L\" or \"S\" for Long or Short position\n * },\n * {\n * ...\n * },\n * ...\n * ],\n * StockSymbol2: [ // Array of orders for this stock\n * ...\n * ],\n * ...\n * }\n * ```\n *\n * The “Order type” property can have one of the following four values: * “Limit Buy Order” * “Limit Sell Order” * “Stop Buy Order” * “Stop Sell Order” Note that the order book will only contain information for stocks that you actually have orders in.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @returns Object containing information for all the Limit and Stop Orders you have in the stock market.\n *\n * @example\n * ```js\n * \"If you do not have orders in Nova Medical (NVMD), then the returned object will not have a “NVMD” property.\"\n * {\n * ECP: [\n * {\n * shares: 5,\n * price: 100,000\n * type: \"Stop Buy Order\",\n * position: \"S\",\n * },\n * {\n * shares: 25,\n * price: 125,000\n * type: \"Limit Sell Order\",\n * position: \"L\",\n * },\n * ],\n * SYSC: [\n * {\n * shares: 100,\n * price: 10,000\n * type: \"Limit Buy Order\",\n * position: \"L\",\n * },\n * ],\n * }\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getOrders(): " + }, + { + "kind": "Reference", + "text": "StockOrder", + "canonicalReference": "bitburner!StockOrder:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getOrders" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getPosition:member(1)", + "docComment": "/**\n * Returns an array of four elements that represents the player’s position in a stock.\n *\n * The first element is the returned array is the number of shares the player owns of the stock in the Long position. The second element in the array is the average price of the player’s shares in the Long position.\n *\n * The third element in the array is the number of shares the player owns of the stock in the Short position. The fourth element in the array is the average price of the player’s Short position.\n *\n * All elements in the returned array are numeric.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns Array of four elements that represents the player’s position in a stock.\n *\n * @example\n * ```js\n * pos = getPosition(\"ECP\");\n * shares = pos[0];\n * avgPx = pos[1];\n * sharesShort = pos[2];\n * avgPxShort = pos[3];\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPosition(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "[number, number, number, number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPosition" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getPrice:member(1)", + "docComment": "/**\n * Returns the price of a stock, given its symbol (NOT the company name). The symbol is a sequence of two to four capital letters.\n *\n * The stock’s price is the average of its bid and ask price\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns The price of a stock.\n *\n * @example\n * ```js\n * getPrice(\"FISG\");\n * ```\n *\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPrice(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getPrice" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getPurchaseCost:member(1)", + "docComment": "/**\n * Calculates and returns how much it would cost to buy a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to purchase.\n *\n * @param posType - Specifies whether the order is a “Long” or “Short” position.\n *\n * @returns Cost to buy a given number of shares of a stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getPurchaseCost(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", posType: " + }, + { + "kind": "Reference", + "text": "OrderPos", + "canonicalReference": "bitburner!OrderPos:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "posType", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getPurchaseCost" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getSaleGain:member(1)", + "docComment": "/**\n * Calculates and returns how much you would gain from selling a given number of shares of a stock. This takes into account spread, large transactions influencing the price of the stock and commission fees.\n *\n * @remarks\n *\n * 2 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to sell.\n *\n * @param posType - Specifies whether the order is a “Long” or “Short” position.\n *\n * @returns Gain from selling a given number of shares of a stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSaleGain(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", posType: " + }, + { + "kind": "Reference", + "text": "OrderPos", + "canonicalReference": "bitburner!OrderPos:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "posType", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "name": "getSaleGain" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getSymbols:member(1)", + "docComment": "/**\n * Returns an array of the symbols of the tradable stocks\n *\n * @remarks\n *\n * 2 GB\n *\n * @returns Array of the symbols of the tradable stocks.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getSymbols(): " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "getSymbols" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#getVolatility:member(1)", + "docComment": "/**\n * Returns the volatility of the specified stock.\n *\n * Volatility represents the maximum percentage by which a stock’s price can change every tick. The volatility is returned as a decimal value, NOT a percentage (e.g. if a stock has a volatility of 3%, then this function will return 0.03, NOT 3).\n *\n * In order to use this function, you must first purchase access to the Four Sigma (4S) Market Data TIX API.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @returns Volatility of the specified stock.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "getVolatility(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "name": "getVolatility" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#placeOrder:member(1)", + "docComment": "/**\n * Places an order on the stock market. This function only works for Limit and Stop Orders.\n *\n * The ability to place limit and stop orders is **not** immediately available to the player and must be unlocked later on in the game.\n *\n * Returns true if the order is successfully placed, and false otherwise.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares for order. Must be positive. Will be rounded to nearest integer.\n *\n * @param price - Execution price for the order.\n *\n * @param type - Type of order.\n *\n * @param pos - Specifies whether the order is a “Long” or “Short” position.\n *\n * @returns True if the order is successfully placed, and false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "placeOrder(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", price: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", type: " + }, + { + "kind": "Reference", + "text": "OrderType", + "canonicalReference": "bitburner!OrderType:type" + }, + { + "kind": "Content", + "text": ", pos: " + }, + { + "kind": "Reference", + "text": "OrderPos", + "canonicalReference": "bitburner!OrderPos:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 12 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "parameterName": "price", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + }, + { + "parameterName": "type", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "parameterName": "pos", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + } + } + ], + "name": "placeOrder" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#purchase4SMarketData:member(1)", + "docComment": "/**\n * Purchase 4S Market Data Access.\n *\n * Returns true if you successfully purchased it or if you already have access. Returns false otherwise.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @returns True if you successfully purchased it or if you already have access, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchase4SMarketData(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "purchase4SMarketData" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#purchase4SMarketDataTixApi:member(1)", + "docComment": "/**\n * Purchase 4S Market Data TIX API Access.\n *\n * Returns true if you successfully purchased it or if you already have access. Returns false otherwise.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @returns True if you successfully purchased it or if you already have access, false otherwise.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "purchase4SMarketDataTixApi(): " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [], + "name": "purchase4SMarketDataTixApi" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#sell:member(1)", + "docComment": "/**\n * Attempts to sell shares of a stock using a Market Order.\n *\n * If the specified number of shares in the function exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.\n *\n * The net profit made from selling stocks with this function is reflected in the script’s statistics. This net profit is calculated as:\n *\n * shares * (sell_price - average_price_of_purchased_shares)\n *\n * If the sale is successful, this function will return the stock price at which each share was sold. Otherwise, it will return 0.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer.\n *\n * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sell(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "sell" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#sellShort:member(1)", + "docComment": "/**\n * Attempts to sell a short position of a stock using a Market Order.\n *\n * The ability to short a stock is **not** immediately available to the player and must be unlocked later on in the game.\n *\n * If the specified number of shares exceeds the amount that the player actually owns, then this function will sell all owned shares. Remember that every transaction on the stock exchange costs a certain commission fee.\n *\n * If the sale is successful, this function will return the stock price at which each share was sold. Otherwise it will return 0.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to sell. Must be positive. Will be rounded to nearest integer.\n *\n * @returns The stock price at which each share was sold, otherwise 0 if the shares weren't sold.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "sellShort(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "sellShort" + }, + { + "kind": "MethodSignature", + "canonicalReference": "bitburner!TIX#short:member(1)", + "docComment": "/**\n * Attempts to purchase a short position of a stock using a Market Order.\n *\n * The ability to short a stock is **not** immediately available to the player and must be unlocked later on in the game.\n *\n * If the player does not have enough money to purchase the specified number of shares, then no shares will be purchased. Remember that every transaction on the stock exchange costs a certain commission fee.\n *\n * If the purchase is successful, this function will return the stock price at which each share was purchased. Otherwise, it will return 0.\n *\n * @remarks\n *\n * 2.5 GB\n *\n * @param sym - Stock symbol.\n *\n * @param shares - Number of shares to short. Must be positive. Will be rounded to nearest integer.\n *\n * @returns The stock price at which each share was purchased, otherwise 0 if the shares weren't purchased.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "short(sym: " + }, + { + "kind": "Reference", + "text": "StockSymbol", + "canonicalReference": "bitburner!StockSymbol:type" + }, + { + "kind": "Content", + "text": ", shares: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isOptional": false, + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "sym", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "parameterName": "shares", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "short" + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!University:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type University = " + }, + { + "kind": "Content", + "text": "\"Summit University\" | \"Rothman University\" | \"ZB Institute Of Technology\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "University", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "bitburner!UniversityCourse:type", + "docComment": "/**\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type UniversityCourse =\n " + }, + { + "kind": "Content", + "text": "| \"Study Computer Science\"\n | \"Data Strucures\"\n | \"Networks\"\n | \"Algorithms\"\n | \"Management\"\n | \"Leadership\"" + }, + { + "kind": "Content", + "text": ";" + } + ], + "releaseTag": "Public", + "name": "UniversityCourse", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ] + } + ] +} diff --git a/temp/bitburner.api.md b/temp/bitburner.api.md new file mode 100644 index 000000000..56a448d03 --- /dev/null +++ b/temp/bitburner.api.md @@ -0,0 +1,1590 @@ +## API Report File for "bitburner" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +// @public (undocumented) +export interface AugmentationStats { + agility_exp_mult?: number; + agility_mult?: number; + bladeburner_analysis_mult?: number; + bladeburner_max_stamina_mult?: number; + bladeburner_stamina_gain_mult?: number; + bladeburner_success_chance_mult?: number; + charisma_exp_mult?: number; + charisma_mult?: number; + company_rep_mult?: number; + crime_money_mult?: number; + crime_success_mult?: number; + defense_exp_mult?: number; + defense_mult?: number; + dexterity_exp_mult?: number; + dexterity_mult?: number; + faction_rep_mult?: number; + hacking_chance_mult?: number; + hacking_exp_mult?: number; + hacking_grow_mult?: number; + hacking_money_mult?: number; + hacking_mult?: number; + hacking_speed_mult?: number; + hacknet_node_core_cost_mult?: number; + hacknet_node_level_cost_mult?: number; + hacknet_node_money_mult?: number; + hacknet_node_purchase_cost_mult?: number; + hacknet_node_ram_cost_mult?: number; + strength_exp_mult?: number; + strength_mult?: number; + work_money_mult?: number; +} + +// @public (undocumented) +export type AugmentName = +| "Augmented Targeting I" +| "Augmented Targeting II" +| "Augmented Targeting III" +| "Synthetic Heart" +| "Synfibril Muscle" +| "Combat Rib I" +| "Combat Rib II" +| "Combat Rib III" +| "Nanofiber Weave" +| "NEMEAN Subdermal Weave" +| "Wired Reflexes" +| "Graphene Bone Lacings" +| "Bionic Spine" +| "Graphene Bionic Spine Upgrade" +| "Bionic Legs" +| "Graphene Bionic Legs Upgrade" +| "Speech Processor Implant" +| "TITN-41 Gene-Modification Injection" +| "Enhanced Social Interaction Implant" +| "BitWire" +| "Artificial Bio-neural Network Implant" +| "Artificial Synaptic Potentiation" +| "Enhanced Myelin Sheathing" +| "Synaptic Enhancement Implant" +| "Neural-Retention Enhancement" +| "DataJack" +| "Embedded Netburner Module" +| "Embedded Netburner Module Core Implant" +| "Embedded Netburner Module Core V2 Upgrade" +| "Embedded Netburner Module Core V3 Upgrade" +| "Embedded Netburner Module Analyze Engine" +| "Embedded Netburner Module Direct Memory Access Upgrade" +| "Neuralstimulator" +| "Neural Accelerator" +| "Cranial Signal Processors - Gen I" +| "Cranial Signal Processors - Gen II" +| "Cranial Signal Processors - Gen III" +| "Cranial Signal Processors - Gen IV" +| "Cranial Signal Processors - Gen V" +| "Neuronal Densification" +| "Nuoptimal Nootropic Injector Implant" +| "Speech Enhancement" +| "FocusWire" +| "PC Direct-Neural Interface" +| "PC Direct-Neural Interface Optimization Submodule" +| "PC Direct-Neural Interface NeuroNet Injector" +| "ADR-V1 Pheromone Gene" +| "ADR-V2 Pheromone Gene" +| "The Shadow's Simulacrum" +| "Hacknet Node CPU Architecture Neural-Upload" +| "Hacknet Node Cache Architecture Neural-Upload" +| "Hacknet Node NIC Architecture Neural-Upload" +| "Hacknet Node Kernel Direct-Neural Interface" +| "Hacknet Node Core Direct-Neural Interface" +| "NeuroFlux Governor" +| "Neurotrainer I" +| "Neurotrainer II" +| "Neurotrainer III" +| "HyperSight Corneal Implant" +| "LuminCloaking-V1 Skin Implant" +| "LuminCloaking-V2 Skin Implant" +| "HemoRecirculator" +| "SmartSonar Implant" +| "Power Recirculation Core" +| "QLink" +| "The Red Pill" +| "SPTN-97 Gene Modification" +| "ECorp HVMind Implant" +| "CordiARC Fusion Reactor" +| "SmartJaw" +| "Neotra" +| "Xanipher" +| "nextSENS Gene Modification" +| "OmniTek InfoLoad" +| "Photosynthetic Cells" +| "BitRunners Neurolink" +| "The Black Hand" +| "CRTX42-AA Gene Modification" +| "Neuregen Gene Modification" +| "CashRoot Starter Kit" +| "NutriGen Implant" +| "INFRARET Enhancement" +| "DermaForce Particle Barrier" +| "Graphene BranchiBlades Upgrade" +| "Graphene Bionic Arms Upgrade" +| "BrachiBlades" +| "Bionic Arms" +| "Social Negotiation Assistant (S.N.A)" +| "EsperTech Bladeburner Eyewear" +| "EMS-4 Recombination" +| "ORION-MKIV Shoulder" +| "Hyperion Plasma Cannon V1" +| "Hyperion Plasma Cannon V2" +| "GOLEM Serum" +| "Vangelis Virus" +| "Vangelis Virus 3.0" +| "I.N.T.E.R.L.I.N.K.E.D" +| "Blade's Runners" +| "BLADE-51b Tesla Armor" +| "BLADE-51b Tesla Armor: Power Cells Upgrade" +| "BLADE-51b Tesla Armor: Energy Shielding Upgrade" +| "BLADE-51b Tesla Armor: Unibeam Upgrade" +| "BLADE-51b Tesla Armor: Omnibeam Upgrade" +| "BLADE-51b Tesla Armor: IPU Upgrade" +| "The Blade's Simulacrum"; + +// @public (undocumented) +export interface AugmentPair { + cost: number; + name: AugmentName; +} + +// @public (undocumented) +export interface BasicHGWOptions { + threads: number; +} + +// @public (undocumented) +export interface BitNodeMultipliers { + AgilityLevelMultiplier: number; + AugmentationMoneyCost: number; + AugmentationRepCost: number; + BladeburnerRank: number; + BladeburnerSkillCost: number; + CharismaLevelMultiplier: number; + ClassGymExpGain: number; + CodingContractMoney: number; + CompanyWorkExpGain: number; + CompanyWorkMoney: number; + CorporationValuation: number; + CrimeExpGain: number; + CrimeMoney: number; + DaedalusAugsRequirement: number; + DefenseLevelMultiplier: number; + DexterityLevelMultiplier: number; + FactionPassiveRepGain: number; + FactionWorkExpGain: number; + FactionWorkRepGain: number; + FourSigmaMarketDataApiCost: number; + FourSigmaMarketDataCost: number; + HackExpGain: number; + HackingLevelMultiplier: number; + HacknetNodeMoney: number; + HomeComputerRamCost: number; + InfiltrationMoney: number; + InfiltrationRep: number; + ManualHackMoney: number; + PurchasedServerCost: number; + PurchasedServerLimit: number; + PurchasedServerMaxRam: number; + RepToDonateToFaction: number; + ScriptHackMoney: number; + ServerGrowthRate: number; + ServerMaxMoney: number; + ServerStartingMoney: number; + ServerStartingSecurity: number; + ServerWeakenRate: number; + StrengthLevelMultiplier: number; +} + +// @public (undocumented) +export interface Bladeburner { + getActionAutolevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): boolean; + + getActionCountRemaining( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + getActionCurrentLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + getActionEstimatedSuccessChance( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + getActionMaxLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + getActionRepGain( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + level: number, + ): number; + + getActionTime( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + getBlackOpNames(): BladeburnerBlackOps[]; + + getBlackOpRank(name: BladeburnerBlackOps): number; + + getBonusTime(): number; + + getCity(): City; + + getCityChaos(name: City): number; + + getCityCommunities(name: City): number; + + getCityEstimatedPopulation(name: City): number; + + getContractNames(): BladeburnerContracts[]; + + getCurrentAction(): BladeburnerCurAction; + + getGeneralActionNames(): BladeburnerGenActions[]; + + getOperationNames(): BladeburnerOperations[]; + + getRank(): number; + + getSkillLevel(name: BladeburnerSkills): number; + + getSkillNames(): BladeburnerSkills[]; + + getSkillPoints(): number; + + getSkillUpgradeCost(name: BladeburnerSkills): number; + + getStamina(): [number, number]; + + getTeamSize( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): number; + + joinBladeburnerDivision(): boolean; + + joinBladeburnerFaction(): boolean; + + setActionAutolevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + autoLevel: boolean, + ): void; + + setActionLevel( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + level: number, + ): void; + + setTeamSize( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + size: number, + ): number; + + startAction( + type: BladeburnerActTypes, + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps, + ): boolean; + + stopBladeburnerAction(): void; + + switchCity(name: City): boolean; + + upgradeSkill(name: BladeburnerSkills): boolean; +} + +// @public (undocumented) +export type BladeburnerActTypes = "contracts" | "operations" | "black ops" | "general"; + +// @public (undocumented) +export type BladeburnerBlackOps = +| "Operation Typhoon" +| "Operation Zero" +| "Operation X" +| "Operation Titan" +| "Operation Ares" +| "Operation Archangel" +| "Operation Juggernaut" +| "Operation Red Dragon" +| "Operation K" +| "Operation Deckard" +| "Operation Tyrell" +| "Operation Wallace" +| "Operation Shoulder of Orion" +| "Operation Hyron" +| "Operation Morpheus" +| "Operation Ion Storm" +| "Operation Annihilus" +| "Operation Ultron" +| "Operation Centurion" +| "Operation Vindictus" +| "Operation Daedalus"; + +// @public (undocumented) +export type BladeburnerContracts = "Tracking" | "Bounty Hunter" | "Retirement"; + +// @public (undocumented) +export interface BladeburnerCurAction { + name: BladeburnerGenActions | BladeburnerContracts | BladeburnerOperations | BladeburnerBlackOps; + type: BladeburnerActTypes | "Idle"; +} + +// @public (undocumented) +export type BladeburnerGenActions = +| "Training" +| "Field Analysis" +| "Recruitment" +| "Diplomacy" +| "Hyperbolic Regeneration Chamber"; + +// @public (undocumented) +export type BladeburnerOperations = +| "Investigation" +| "Undercover Operation" +| "Sting Operation" +| "Raid" +| "Stealth Retirement Operation" +| "Assassination"; + +// @public (undocumented) +export type BladeburnerSkills = +| "Blade's Intuition" +| "Cloak" +| "Marksman" +| "Weapon Proficiency" +| "Short-Circuit" +| "Digital Observer" +| "Tracer" +| "Overclock" +| "Reaper" +| "Evasive System" +| "Datamancer" +| "Cyber's Edge" +| "Hands of Midas" +| "Hyperdrive"; + +// @public (undocumented) +export interface CharacterInfo { + bitnode: number; + city: City; + company: CompanyName[]; + factions: FactionName[]; + hp: number; + jobTitle: CompanyField[]; + maxHp: number; + mult: CharacterMult; + timeWorked: number; + tor: boolean; + workAgiExpGain: number; + workChaExpGain: number; + workDefExpGain: number; + workDexExpGain: number; + workHackExpGain: number; + workMoneyGain: number; + workRepGain: number; + workStrExpGain: number; +} + +// @public (undocumented) +export interface CharacterMult { + agility: number; + agilityExp: number; + companyRep: number; + crimeMoney: number; + crimeSuccess: number; + defense: number; + defenseExp: number; + dexterity: number; + dexterityExp: number; + factionRep: number; + hacking: number; + hackingExp: number; + strength: number; + strengthExp: number; + workMoney: number; +} + +// @public (undocumented) +export type City = "Aevum" | "Chongqing" | "Sector-12" | "New Tokyo" | "Ishima" | "Volhaven"; + +// @public (undocumented) +export interface CodingAttemptOptions { + returnReward: boolean; +} + +// @public (undocumented) +export interface CodingContract { + attempt(answer: string | string[] | number, fn: string, host?: Host): boolean; + + attempt(answer: string | string[] | number, fn: string, host?: Host, opts?: CodingAttemptOptions): boolean | string; + + getContractType(fn: string, host?: Host): CodingContractTypes; + + getData(fn: string, host?: Host): string; + + getDescription(fn: string, host?: Host): string; + + getNumTriesRemaining(fn: string, host?: Host): number; +} + +// @public (undocumented) +export type CodingContractTypes = +| "Find Largest Prime Factor" +| "Subarray with Maximum Sum" +| "Total Ways to Sum" +| "Spiralize Matrix" +| "Array Jumping Game" +| "Merge Overlapping Intervals" +| "Generate IP Addresses" +| "Algorithmic Stock Trader I" +| "Algorithmic Stock Trader II" +| "Algorithmic Stock Trader III" +| "Algorithmic Stock Trader IV" +| "Minimum Path Sum in a Triangle" +| "Unique Paths in a Grid I" +| "Unique Paths in a Grid II" +| "Sanitize Parentheses in Expression" +| "Find All Valid Math Expressions"; + +// @public (undocumented) +export type CompanyField = +| "software" +| "software consultant" +| "it" +| "security engineer" +| "network engineer" +| "business" +| "business consultant" +| "security" +| "agent" +| "employee" +| "part-time employee" +| "waiter" +| "part-time waiter"; + +// @public (undocumented) +export type CompanyName = +// Sector-12 +| "MegaCorp" +| "BladeIndustries" +| "FourSigma" +| "IcarusMicrosystems" +| "UniversalEnergy" +| "DeltaOne" +| "CIA" +| "NSA" +| "AlphaEnterprises" +| "CarmichaelSecurity" +| "FoodNStuff" +| "JoesGuns" + +// Aevum +| "ECorp" +| "BachmanAndAssociates" +| "ClarkeIncorporated" +| "OmniTekIncorporated" +| "FulcrumTechnologies" +| "GalacticCybersystems" +| "AeroCorp" +| "WatchdogSecurity" +| "RhoConstruction" +| "AevumPolice" +| "NetLinkTechnologies" + +// Volhaven +| "NWO" +| "HeliosLabs" +| "OmniaCybersystems" +| "LexoCorp" +| "SysCoreSecurities" +| "CompuTek" + +// Chongqing +| "KuaiGongInternational" +| "SolarisSpaceSystems" + +// Ishima +| "StormTechnologies" +| "NovaMedical" +| "OmegaSoftware" + +// New Tokyo +| "DefComm" +| "VitaLife" +| "GlobalPharmaceuticals" +| "NoodleBar"; + +// @public (undocumented) +export type CreatableProgram = PurchaseableProgram | "serverprofiler.exe"; + +// @public (undocumented) +export type Crime = +| "shoplift" +| "rob store" +| "mug" +| "larceny" +| "deal drugs" +| "bond forgery" +| "traffick arms" +| "homicide" +| "grand theft auto" +| "kidnap" +| "assassinate" +| "heist"; + +// @public (undocumented) +export interface CrimeStats { + agility_exp: number; + agility_success_weight: number; + charisma_exp: number; + charisma_success_weight: number; + defense_exp: number; + defense_success_weight: number; + dexterity_exp: number; + dexterity_success_weight: number; + difficulty: number; + hacking_exp: number; + hacking_success_weight: number; + intelligence_exp: number; + karma: number; + kills: number; + money: number; + name: number; + strength_exp: number; + strength_success_weight: number; + time: number; + type: string; +} + +// @public (undocumented) +export type FactionName = +| "Illuminati" +| "Daedalus" +| "The Covenant" +| "ECorp" +| "MegaCorp" +| "Bachman & Associates" +| "Blade Industries" +| "NWO" +| "Clarke Incorporated" +| "OmniTek Incorporated" +| "Four Sigma" +| "KuaiGong International" +| "Fulcrum Secret Technologies" +| "BitRunners" +| "The Black Hand" +| "NiteSec" +| "Aevum" +| "Chongqing" +| "Ishima" +| "New Tokyo" +| "Sector-12" +| "Volhaven" +| "Speakers for the Dead" +| "The Dark Army" +| "The Syndicate" +| "Silhouette" +| "Tetrads" +| "Slum Snakes" +| "Netburners" +| "Tian Di Hui" +| "CyberSec" +| "Bladeburners"; + +// @public (undocumented) +export type FactionWork = "hacking" | "field" | "security"; + +// @public (undocumented) +export interface Gang { + ascendMember(memberName: string): GangMemberAscension; + + canRecruitMember(): boolean; + + getBonusTime(): number; + + getChanceToWinClash(gangName: GangName): number; + + getEquipmentCost(equipName: GangEquipment | GangAugmentations): number; + + getEquipmentNames(): (GangEquipment | GangAugmentations)[]; + + getEquipmentStats(equipName: GangEquipment | GangAugmentations): GangEquipmentStats; + + getEquipmentType(equipName: GangEquipment | GangAugmentations): GangEquipmentType; + + getGangInformation(): GangGenInfo; + + getMemberInformation(name: string): GangMemberInfo; + + getMemberNames(): string[]; + + getOtherGangInformation(): GangOtherInfo; + + getTaskNames(): GangTasks[]; + + getTaskStats(name: GangTasks): GangTasksStats; + + purchaseEquipment(memberName: string, equipName: GangEquipment | GangAugmentations): boolean; + + recruitMember(name: string): boolean; + + setMemberTask(memberName: string, taskName: GangTasks): boolean; + + setTerritoryWarfare(engage: boolean): void; +} + +// @public (undocumented) +export type GangAugmentations = +| "Bionic Arms" +| "Bionic Legs" +| "Bionic Spine" +| "BrachiBlades" +| "Nanofiber Weave" +| "Synthetic Heart" +| "Synfibril Muscle" +| "BitWire" +| "Neuralstimulator" +| "DataJack" +| "Graphene Bone Lacings"; + +// @public (undocumented) +export type GangEquipment = +| "Baseball Bat" +| "Katana" +| "Glock 18C" +| "P90C" +| "Steyr AUG" +| "AK-47" +| "M15A10 Assault Rifle" +| "AWM Sniper Rifle" +| "Bulletproof Vest" +| "Full Body Armor" +| "Liquid Body Armor" +| "Graphene Plating Armor" +| "Ford Flex V20" +| "ATX1070 Superbike" +| "Mercedes-Benz S9001" +| "White Ferrari" +| "NUKE Rootkit" +| "Soulstealer Rootkit" +| "Demon Rootkit" +| "Hmap Node" +| "Jack the Ripper"; + +// @public (undocumented) +export interface GangEquipmentStats { + agi: number; + cha: number; + def: number; + dex: number; + hack: number; + str: number; +} + +// @public (undocumented) +export type GangEquipmentType = "Weapon" | "Armor" | "Vehicle" | "Rootkit" | "Augmentation"; + +// @public (undocumented) +export interface GangGenInfo { + faction: GangName; + isHacking: boolean; + moneyGainRate: number; + power: number; + respect: number; + respectGainRate: number; + territory: number; + territoryClashChance: number; + wantedLevel: number; + wantedLevelGainRate: number; +} + +// @public (undocumented) +export interface GangMemberAscension { + agi: number; + cha: number; + def: number; + dex: number; + hack: number; + respect: number; + str: number; +} + +// @public (undocumented) +export interface GangMemberInfo { + agility: number; + agilityAscensionMult: number; + agilityEquipMult: number; + augmentations: GangAugmentations[]; + charisma: number; + charismaAscensionMult: number; + charismaEquipMult: number; + defense: number; + defenseAscensionMult: number; + defenseEquipMult: number; + dexterity: number; + dexterityAscensionMult: number; + dexterityEquipMult: number; + equipment: GangEquipment[]; + hacking: number; + hackingAscensionMult: number; + hackingEquipMult: number; + strength: number; + strengthAscensionMult: number; + strengthEquipMult: number; + task: GangTasks; +} + +// @public (undocumented) +export type GangName = +| "Slum Snakes" +| "Tetrads" +| "The Syndicate" +| "The Dark Army" +| "Speakers for the Dead" +| "NiteSec" +| "The Black Hand"; + +// @public (undocumented) +export type GangOtherInfo = { + /** Stock Symbol */ + [key in GangName]: GangOtherInfoObject[]; +}; + +// @public (undocumented) +export interface GangOtherInfoObject { + power: number; + territory: number; +} + +// @public (undocumented) +export type GangTasks = +| "Unassigned" +| "Ransomware" +| "Phishing" +| "Identity Theft" +| "DDoS Attacks" +| "Plant Virus" +| "Fraud & Counterfeiting" +| "Money Laundering" +| "Cyberterrorism" +| "Ethical Hacking" +| "Mug People" +| "Deal Drugs" +| "Strongarm Civilians" +| "Run a Con" +| "Armed Robbery" +| "Traffick Illegal Arms" +| "Threaten & Blackmail" +| "Human Trafficking" +| "Terrorism" +| "Vigilante Justice" +| "Train Combat" +| "Train Hacking" +| "Train Charisma" +| "Territory Warfare"; + +// @public (undocumented) +export interface GangTasksStats { + agiWeight: number; + baseMoney: number; + baseRespect: number; + baseWanted: number; + chaWeight: number; + defWeight: number; + desc: string; + dexWeight: number; + difficulty: number; + hackWeight: number; + isCombat: boolean; + isHacking: boolean; + name: GangTasks; + strWeight: number; + territory: GangTasksTerritory; +} + +// @public (undocumented) +export interface GangTasksTerritory { + money: number; + respect: number; + wanted: number; +} + +// @public (undocumented) +export type Gym = "Crush Fitness Gym" | "Snap Fitness Gym" | "Iron Gym" | "Powerhouse Gym" | "Millenium Fitness Gym"; + +// @public (undocumented) +export type GymStat = "str" | "def" | "dex" | "agi"; + +// @public (undocumented) +export interface HackingMultipliers { + chance: number; + growth: number; + money: number; + speed: number; +} + +// @public (undocumented) +export interface HackNet { + getCacheUpgradeCost(index: number, n: number): number; + + getCoreUpgradeCost(index: number, n: number): number; + + getLevelUpgradeCost(index: number, n: number): number; + + getNodeStats(index: number): NodeStats; + + getPurchaseNodeCost(): number; + + getRamUpgradeCost(index: number, n: number): number; + + hashCost(upgName: HashUpgrades): number; + + numHashes(): number; + + numNodes(): number; + + purchaseNode(): number; + + spendHashes(upgName: HashUpgrades, upgTarget?: Host): boolean; + + upgradeCache(index: number, n: number): boolean; + + upgradeCore(index: number, n: number): boolean; + + upgradeLevel(index: number, n: number): boolean; + + upgradeRam(index: number, n: number): boolean; +} + +// @public (undocumented) +export interface HacknetMultipliers { + coreCost: number; + levelCost: number; + production: number; + purchaseCost: number; + ramCost: number; +} + +// @public (undocumented) +export type Handle = string | Port; + +// @public (undocumented) +export type HashUpgrades = +| "Sell for Money" +| "Sell for Corporation Funds" +| "Reduce Minimum Security" +| "Increase Maximum Money" +| "Improve Studying" +| "Improve Gym Training" +| "Exchange for Corporation Research" +| "Exchange for Bladeburner Rank" +| "Exchange for Bladeburner SP" +| "Generate Coding Contract"; + +// @public (undocumented) +export type Host = string; + +// @public (undocumented) +export interface NodeStats { + cache: number; + cores: number; + hashCapacity: number; + level: number; + name: string; + production: number; + ram: number; + timeOnline: number; + totalProduction: number; +} + +// @public (undocumented) +export interface NS extends Singularity { + readonly args: any[]; + // (undocumented) + readonly bladeburner: Bladeburner; + brutessh(host: Host): void; + clear(handle: Handle): void; + clearLog(): void; + // (undocumented) + readonly codingcontract: CodingContract; + deleteServer(host: Host): boolean; + disableLog(fn: string): void; + enableLog(fn: string): void; + exec(script: Script, host: Host, numThreads?: number, ...args: string[]): number; + exit(): void; + fileExists(filename: string, host?: Host): boolean; + ftpcrack(host: Host): void; + // (undocumented) + readonly gang: Gang; + getBitNodeMultipliers(url: string, target: string, host: string): BitNodeMultipliers; + getFavorToDonate(): number; + getGrowTime(host: Host, hackLvl?: number, intLvl?: number): number; + getHackingLevel(): number; + getHackingMultipliers(): HackingMultipliers; + getHacknetMultipliers(): HacknetMultipliers; + getHackTime(host: Host, hackLvl?: number, intLvl?: number): number; + getHostname(): Host; + getPortHandle(port: Port): any[]; + getPurchasedServerCost(ram: number): number; + getPurchasedServerLimit(): number; + getPurchasedServerMaxRam(): number; + getPurchasedServers(hostnameMode?: boolean): Host[]; + getScriptExpGain(script: Script, host: Host, ...args: string[]): number; + getScriptIncome(script: Script, host: Host, ...args: string[]): number | [number, number]; + getScriptLogs(fn?: Script, host?: Host, ...args: any[]): string[]; + getScriptName(): string; + getScriptRam(script: Script, host?: Host): number; + getServer(host?: Host): Server; + getServerBaseSecurityLevel(host: Host): number; + getServerGrowth(host: Host): number; + getServerMaxMoney(host: Host): number; + getServerMinSecurityLevel(host: Host): number; + getServerMoneyAvailable(host: Host): number; + getServerNumPortsRequired(host: Host): number; + getServerRam(host: Host): [number, number]; + getServerRequiredHackingLevel(host: Host): number; + getServerSecurityLevel(host: Host): number; + getTimeSinceLastAug(): number; + getWeakenTime(host: Host, hackLvl?: number, intLvl?: number): number; + grow(host: Host, opts?: BasicHGWOptions): Promise; + growthAnalyze(host: Host, growthAmount: number): number; + growthAnalyzeSecurity(threads: number): number; + hack(host: Host, opts?: BasicHGWOptions): Promise; + hackAnalyzePercent(host: Host): number; + hackAnalyzeSecurity(threads: number): number; + hackAnalyzeThreads(host: Host, hackAmount: number): number; + hackChance(host: Host): number; + readonly hacknet: HackNet; + hasRootAccess(host: Host): boolean; + httpworm(host: Host): void; + isLogEnabled(fn: string): boolean; + isRunning(script: Script, host: Host, ...args: string[]): boolean; + kill(script: Script, host: Host, ...args: string[]): boolean; + kill(scriptPid: number): boolean; + killall(host: Host): boolean; + ls(host: Host, grep?: string): string[]; + nFormat(n: number, format: string): number; + nuke(host: Host): void; + peek(port: Port): string | number | object; + print(msg: string | number | string[] | number[]): void; + prompt(txt: string): Promise; + ps(host?: Host): ProcessInfo[]; + purchaseServer(hostname: Host, ram: number): Host | ""; + read(handle: Handle): string | number | object; + relaysmtp(host: Host): void; + rm(name: string, host?: Host): boolean; + run(script: Script, numThreads?: number, ...args: string[]): number; + scan(host: Host, hostnames?: boolean): Host[]; + scp(files: string | ReadonlyArray, destination: Host): boolean; + scp( + files: string | ReadonlyArray, + source: Host, + // tslint:disable-next-line:unified-signatures + destination: Host, + ): boolean; + scriptKill(script: Script, host: Host): boolean; + scriptRunning(script: Script, host: Host): boolean; + serverExists(host: Host): boolean; + sleep(millis: number): Promise; + // (undocumented) + readonly sleeve: Sleeve; + spawn(script: Script, numThreads?: number, ...args: string[]): void; + sprintf(format: string, ...args: string[]): string; + sqlinject(host: Host): void; + // (undocumented) + readonly stock: TIX; + tail(fn?: Script, host?: Host, ...args: any[]): void; + tprint(msg: string | number | string[] | number[]): void; + tryWrite(port: Handle, data: string | string[] | number): boolean; + vsprintf(format: string, args: string[]): string; + weaken(host: Host, opts?: BasicHGWOptions): Promise; + weakenAnalyze(threads: number, cores?: number): number; + wget(url: string, target: string, host?: string): Promise; + write(handle: Handle, data?: string | string[] | number, mode?: "w" | "a"): void; +} + +// @public (undocumented) +export type OrderPos = "long" | "short"; + +// @public (undocumented) +export type OrderType = "limitbuy" | "limitsell" | "stopbuy" | "stopsell"; + +// @public (undocumented) +export interface PlayerStats { + agility: number; + charisma: number; + defense: number; + dexterity: number; + hacking: number; + intelligence: number; + strength: number; +} + +// @public +export type Port = 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20; + +// @public (undocumented) +export interface ProcessInfo { + args: string[]; + filename: Script; + threads: number; +} + +// @public (undocumented) +export type PurchaseableProgram = +| "brutessh.exe" +| "ftpcrack.exe" +| "relaysmtp.exe" +| "httpworm.exe" +| "sqlinject.exe" +| "deepscanv1.exe" +| "deepscanv2.exe" +| "autolink.exe"; + +// @public (undocumented) +export type Script = string; + +// @public (undocumented) +export interface Server { + // How many CPU cores this server has. Maximum of 8. + // Currently, this only affects hacking missions + // (undocumented) + cpuCores: number; + + // Flag indicating whether the FTP port is open + // (undocumented) + ftpPortOpen: boolean; + + // Flag indicating whether the FTP port is open + // (undocumented) + hasAdminRights: boolean; + + // Flag indicating whether the FTP port is open + // (undocumented) + hostname: string; + + // Flag indicating whether the FTP port is open + // (undocumented) + httpPortOpen: boolean; + + // Flag indicating whether the FTP port is open + // (undocumented) + ip: string; + + // Flag indicating whether the FTP port is open + // (undocumented) + isConnectedTo: boolean; + + // Flag indicating whether the FTP port is open + // (undocumented) + maxRam: number; + + // Flag indicating whether the FTP port is open + // (undocumented) + organizationName: string; + + // Flag indicating whether the FTP port is open + // (undocumented) + ramUsed: number; + + // Flag indicating whether the FTP port is open + // (undocumented) + smtpPortOpen: boolean; + + // Flag indicating whether the FTP port is open + // (undocumented) + sqlPortOpen: boolean; + + // Flag indicating whether the FTP port is open + // (undocumented) + sshPortOpen: boolean; +} + +// @public (undocumented) +export interface Singularity { + applyToCompany(companyName: CompanyName, field: CompanyField): boolean; + + checkFactionInvitations(): FactionName[]; + + commitCrime(crime: Crime): number; + + createProgram(program: CreatableProgram): boolean; + + donateToFaction(faction: FactionName, amount: number): boolean; + + getAugmentationCost(augName: AugmentName): [number, number]; + + getAugmentationPrereq(augName: AugmentName): AugmentName[]; + + getAugmentationsFromFaction(faction: FactionName): AugmentName[]; + + getAugmentationStats(name: AugmentName): AugmentationStats; + + getCharacterInformation(): CharacterInfo; + + getCompanyFavor(companyName: CompanyName): number; + + getCompanyFavorGain(companyName: CompanyName): number; + + getCompanyRep(companyName: CompanyName): number; + + getCrimeChance(crime: Crime): number; + + getCrimeStats(crime: Crime): CrimeStats; + + getFactionFavor(faction: FactionName): number; + + getFactionFavorGain(faction: FactionName): number; + + getFactionRep(faction: FactionName): number; + + getOwnedAugmentations(purchased?: boolean): AugmentName[]; + + getOwnedSourceFiles(): SourceFileLvl[]; + + getStats(): PlayerStats; + + getUpgradeHomeRamCost(): number; + + gymWorkout(gymName: Gym, stat: GymStat): boolean; + + installAugmentations(cbScript?: Script): void; + + isBusy(): boolean; + + joinFaction(faction: FactionName): boolean; + + purchaseAugmentation(faction: FactionName, augmnet: AugmentName): boolean; + + purchaseProgram(programName: PurchaseableProgram): boolean; + + purchaseTor(): boolean; + + softReset(): void; + + stopAction(): boolean; + + travelToCity(city: City): boolean; + + universityCourse(universityName: University, courseName: UniversityCourse): boolean; + + upgradeHomeRam(): boolean; + + workForCompany(companyName?: CompanyName): boolean; + + workForFaction(faction: FactionName, workType: FactionWork): boolean; +} + +// @public (undocumented) +export interface Sleeve { + getInformation(sleeveNumber: number): SleeveInformation; + + getNumSleeves(): number; + + getSleeveAugmentations(sleeveNumber: number): AugmentName[]; + + getSleevePurchasableAugs(sleeveNumber: number): AugmentPair[]; + + getSleeveStats(sleeveNumber: number): SleeveStats; + + getTask(sleeveNumber: number): SleeveTask; + + purchaseSleeveAug(sleeveNumber: number, augName: AugmentName): boolean; + + setToCommitCrime(sleeveNumber: number, name: Crime): boolean; + + setToCompanyWork(sleeveNumber: number, companyName: CompanyName): boolean; + + setToFactionWork(sleeveNumber: number, factionName: FactionName, factionWorkType: FactionWork): boolean; + + setToGymWorkout(sleeveNumber: number, gymName: Gym, stat: GymStat): boolean; + + setToShockRecovery(sleeveNumber: number): boolean; + + setToSynchronize(sleeveNumber: number): boolean; + + setToUniversityCourse(sleeveNumber: number, university: University, className: UniversityCourse): boolean; + + travel(sleeveNumber: number, cityName: City): boolean; +} + +// @public (undocumented) +export interface SleeveInformation { + city: City; + earningsForPlayer: SleeveWorkGains; + earningsForSleeves: SleeveWorkGains; + earningsForTask: SleeveWorkGains; + hp: number; + jobs: string[]; + jobTitle: CompanyField[]; + maxHp: number; + mult: CharacterMult; + timeWorked: number; + tor: boolean; + workRepGain: number; +} + +// @public (undocumented) +export interface SleeveStats { + agility: number; + charisma: number; + defense: number; + dexterity: number; + hacking_skill: number; + shock: + | 0 + | 1 + | 2 + | 3 + | 4 + | 5 + | 6 + | 7 + | 8 + | 9 + | 10 + | 11 + | 12 + | 13 + | 14 + | 15 + | 16 + | 17 + | 18 + | 19 + | 20 + | 21 + | 22 + | 23 + | 24 + | 25 + | 26 + | 27 + | 28 + | 29 + | 30 + | 31 + | 32 + | 33 + | 34 + | 35 + | 36 + | 37 + | 38 + | 39 + | 40 + | 41 + | 42 + | 43 + | 44 + | 45 + | 46 + | 47 + | 48 + | 49 + | 50 + | 51 + | 52 + | 53 + | 54 + | 55 + | 56 + | 57 + | 58 + | 59 + | 60 + | 61 + | 62 + | 63 + | 64 + | 65 + | 66 + | 67 + | 68 + | 69 + | 70 + | 71 + | 72 + | 73 + | 74 + | 75 + | 76 + | 77 + | 78 + | 79 + | 80 + | 81 + | 82 + | 83 + | 84 + | 85 + | 86 + | 87 + | 88 + | 89 + | 90 + | 91 + | 92 + | 93 + | 94 + | 95 + | 96 + | 97 + | 98 + | 99 + | 100; + strength: number; + sync: + | 0 + | 1 + | 2 + | 3 + | 4 + | 5 + | 6 + | 7 + | 8 + | 9 + | 10 + | 11 + | 12 + | 13 + | 14 + | 15 + | 16 + | 17 + | 18 + | 19 + | 20 + | 21 + | 22 + | 23 + | 24 + | 25 + | 26 + | 27 + | 28 + | 29 + | 30 + | 31 + | 32 + | 33 + | 34 + | 35 + | 36 + | 37 + | 38 + | 39 + | 40 + | 41 + | 42 + | 43 + | 44 + | 45 + | 46 + | 47 + | 48 + | 49 + | 50 + | 51 + | 52 + | 53 + | 54 + | 55 + | 56 + | 57 + | 58 + | 59 + | 60 + | 61 + | 62 + | 63 + | 64 + | 65 + | 66 + | 67 + | 68 + | 69 + | 70 + | 71 + | 72 + | 73 + | 74 + | 75 + | 76 + | 77 + | 78 + | 79 + | 80 + | 81 + | 82 + | 83 + | 84 + | 85 + | 86 + | 87 + | 88 + | 89 + | 90 + | 91 + | 92 + | 93 + | 94 + | 95 + | 96 + | 97 + | 98 + | 99 + | 100; +} + +// @public (undocumented) +export interface SleeveTask { + crime: Crime | ""; + factionWorkType: FactionWork | ""; + gymStatType: GymStat | ""; + location: City | ""; + task: string; +} + +// @public (undocumented) +export interface SleeveWorkGains { + workAgiExpGain: number; + workChaExpGain: number; + workDefExpGain: number; + workDexExpGain: number; + workHackExpGain: number; + workMoneyGain: number; + workStrExpGain: number; +} + +// @public (undocumented) +export interface SourceFileLvl { + lvl: number; + n: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12; +} + +// @public (undocumented) +export type StockOrder = { + /** Stock Symbol */ + [key in StockSymbol]?: StockOrderObject[]; +}; + +// @public (undocumented) +export interface StockOrderObject { + position: "S" | "L"; + price: number; + shares: number; + type: "Limit Buy Order" | "Limit Sell Order" | "Stop Buy Order" | "Stop Buy Order"; +} + +// @public (undocumented) +export type StockSymbol = +| "ECP" +| "MGCP" +| "BLD" +| "CLRK" +| "OMTK" +| "FSIG" +| "KGI" +| "FLCM" +| "STM" +| "DCOMM" +| "HLS" +| "VITA" +| "ICRS" +| "UNV" +| "AERO" +| "OMN" +| "SLRS" +| "GPH" +| "NVMD" +| "WDS" +| "LXO" +| "RHOC" +| "APHE" +| "SYSC" +| "CTK" +| "NTLK" +| "OMGA" +| "FNS" +| "SGC" +| "JGN" +| "CTYS" +| "MDYN" +| "TITN"; + +// @public (undocumented) +export interface TIX { + buy(sym: StockSymbol, shares: number): number; + + cancelOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): void; + + getAskPrice(sym: StockSymbol): number; + + getBidPrice(sym: StockSymbol): number; + + getForecast(sym: StockSymbol): number; + + getMaxShares(sym: StockSymbol): number; + + getOrders(): StockOrder; + + getPosition(sym: StockSymbol): [number, number, number, number]; + + getPrice(sym: StockSymbol): number; + + getPurchaseCost(sym: StockSymbol, shares: number, posType: OrderPos): number; + + getSaleGain(sym: StockSymbol, shares: number, posType: OrderPos): number; + + getSymbols(): StockSymbol[]; + + getVolatility(sym: StockSymbol): number; + + placeOrder(sym: StockSymbol, shares: number, price: number, type: OrderType, pos: OrderPos): boolean; + + purchase4SMarketData(): boolean; + + purchase4SMarketDataTixApi(): boolean; + + sell(sym: StockSymbol, shares: number): number; + + sellShort(sym: StockSymbol, shares: number): number; + + short(sym: StockSymbol, shares: number): number; +} + +// @public (undocumented) +export type University = "Summit University" | "Rothman University" | "ZB Institute Of Technology"; + +// @public (undocumented) +export type UniversityCourse = +| "Study Computer Science" +| "Data Strucures" +| "Networks" +| "Algorithms" +| "Management" +| "Leadership"; + +// (No @packageDocumentation comment for this package) + +``` diff --git a/tsdoc-metadata.json b/tsdoc-metadata.json new file mode 100644 index 000000000..1946c4e79 --- /dev/null +++ b/tsdoc-metadata.json @@ -0,0 +1,11 @@ +// This file is read by tools that parse documentation comments conforming to the TSDoc standard. +// It should be published with your NPM package. It should not be tracked by Git. +{ + "tsdocVersion": "0.12", + "toolPackages": [ + { + "packageName": "@microsoft/api-extractor", + "packageVersion": "7.18.17" + } + ] +}